# bitiodine

**Repository Path**: ShizeChen/bitiodine

## Basic Information

- **Project Name**: bitiodine
- **Description**: A Rust Bitcoin blockchain parser with clustering capabilities, allowing to group together addresses in ownership clusters. Please contact @mikispag if interested in using BitIodine for any real-world use case.
- **Primary Language**: Rust
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2019-01-04
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Bitiodine
A Rust Bitcoin blockchain parser with clustering capabilities, allowing to group together addresses in ownership clusters.

The parser is compatible with SegWit, correctly parses bech32 native outputs and witness programs, and deals with chain splits gracefully.

## Building

```
cargo update
cargo build --release
```

## Usage

Enable the desired *visitor* (by default, the Clusterizer is on) in `src/main.rs`, rebuild, and run the executable:

```
target/release/bitiodine-rust
```

```
$ ./bitiodine-rust --help
BitIodine 0.0.2
Michele Spagnuolo <mikispag@gmail.com>
A Rust Bitcoin blockchain parser with clustering capabilities, allowing to group together addresses in ownership
clusters.

USAGE:
    bitiodine-rust [FLAGS] [OPTIONS]

FLAGS:
    -h, --help       Prints help information
    -v               Sets the level of verbosity
    -V, --version    Prints version information

OPTIONS:
    -b, --blocks-dir <BLOCKS_DIRECTORY_PATH>    Sets the path to the bitcoind blocks directory [default:
                                                /home/$USER/.bitcoin/blocks]
    -o, --output <OUTPUT_FILE>                  Sets the path to the output clusters.csv file [default: clusters.csv]
```

## Credits

The blockchain parser is based on Mathias Svensson's code ([GitHub](https://github.com/Idolf)).