Commit 953f0043 authored by LaurentMT's avatar LaurentMT
Browse files

Updated README.md

(description, utilisation, etc)
parent 70ddb64e
# whirlpool_stats
A set of python scripts allowing to compute statistics about Whirlpool.
Whirlpool Stats Tools (WST for short) is a command line tool allowing to compute privacy-oriented statistics related to Whirlpool.
Main features:
- download of snapshots of the transaction graph for all the pools in a given denomination (downloads from OXT - snapshots refreshed daily)
- support of downloads through SOCKS5
- computation of metrics for a downloaded snapshot
- export (CSV format) of statistics computed for the active snapshot
- generation of dynamic charts for the active snapshot
- display of computed metrics for a mix transaction stored in the active snapshot
## Python versions
......@@ -10,7 +18,8 @@ Python >= 3.4.4
## Dependencies
TODO
requests
plotly >= 4.1.0
## Installation
......@@ -25,7 +34,107 @@ python setup.py install
## Usage
TODO
Start a WST session
```
> python wst.py
Starting Whirlpool Stats Tool...
Type "help" for a list of available commands.
wst#/tmp>
```
Show help
```
wst#/tmp> help
Documented commands (type help <topic>):
========================================
download export help load plot quit score socks5 workdir
wst#/tmp>
```
Set Socks5 proxy before downloading data from OXT
```
wst#/tmp> socks5 127.0.0.1:9150
wst#/tmp>
```
Change the working directory for this WST session
```
wst#/tmp> workdir /home/laurent/whirlpool
wst#/home/laurent/whirlpool>
```
Download in the working directory a snaphot for the 0.5BTC pools
```
wst#/home/laurent/whirlpool> download 05
Start download of snapshot for 05 denomination
whirlpool_mix_txs_05.csv downloaded
whirlpool_tx0s_05.csv downloaded
whirlpool_links_05.csv downloaded
Download complete
wst#/home/laurent/whirlpool>
```
Load and compute the statistcs for the snaphot
```
wst#/home/laurent/whirlpool> load 05
Start loading snapshot for 05 denomination
Mix txs loaded
Tx0s loaded
Tx links loaded
Done!
Start computing metrics (forward-looking)
Computed metrics for round 0
Computed metrics for round 1
Computed metrics for round 2
Computed metrics for round 3
Computed metrics for round 4
...
Done!
wst#/home/laurent/whirlpool>
```
Plot a chart for a given metrics of the active snapshot (e.g.: forward-looking anonset)
```
wst#/home/laurent/whirlpool> plot fwd anonset
Preparing the chart...
wst#/home/laurent/whirlpool>
```
Display the metrics computed for a transaction stored in the active snapshot
```
wst#/home/laurent/whirlpool> score 4e72519d391ce83e0659c9022a00344bedbb253de1747cf290162b3d3ea51479
Backward-looking metrics for the outputs of this mix:
anonset = 92
spread = 89%
Forward-looking metrics for the outputs of Tx0s having this transaction as their first mix:
anonset = 127
spread = 76%
wst#/home/laurent/whirlpool>
```
Quit WST
```
wst#/home/laurent/whirlpool> quit
Good bye!
>
```
## Troubleshooting
......@@ -51,6 +160,8 @@ where `denom` is a code identifying the pool denomination (valid codes = 05, 005
## Contributing
WST is still a very basic tool. All contributions are welcome!
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment