Improve README

This commit is contained in:
Rucknium 2022-03-10 17:51:31 +00:00
parent 4db39185ba
commit b433a17c8c
3 changed files with 9 additions and 3 deletions

View file

@ -22,6 +22,8 @@ install.packages("stringr")
You must have a Bitcoin Cash (BCH) full node synced with the transaction index enabled with the `-txindex` flag. As of now, the analysis has been tested with the [Bitcoin Unlimited](https://www.bitcoinunlimited.info/) node implementation. You must have a Bitcoin Cash (BCH) full node synced with the transaction index enabled with the `-txindex` flag. As of now, the analysis has been tested with the [Bitcoin Unlimited](https://www.bitcoinunlimited.info/) node implementation.
It is best to run the following script files successively in separate R sessions for better RAM management.
## `extract-tx-graphs.R` ## `extract-tx-graphs.R`
The [R/extract-tx-graphs.R](R/extract-tx-graphs.R) script file issues JSON-RPC queries to `bitcoind`, the Bitcoin Cash node daemon. Make sure `bitcoind` is running before initiating this script. The [R/extract-tx-graphs.R](R/extract-tx-graphs.R) script file issues JSON-RPC queries to `bitcoind`, the Bitcoin Cash node daemon. Make sure `bitcoind` is running before initiating this script.
@ -52,6 +54,10 @@ The [R/construct-edgelist.R](R/construct-edgelist.R) script file produces a SQL
The script assigns an integer index to every output. Converting the transaction ID + output position to integer indixes is necessary so that the transaction graph can be stored in RAM. This script is single-threaded so as to avoid conflicts when writing to the database. It should take a few hours to complete. The script assigns an integer index to every output. Converting the transaction ID + output position to integer indixes is necessary so that the transaction graph can be stored in RAM. This script is single-threaded so as to avoid conflicts when writing to the database. It should take a few hours to complete.
## `get-coinbases.R`
The [R/get-coinbases.R](R/get-coinbases.R) script file produces a `.rds` file that contains the coinbase outputs. Coinbases are special vertices in the transaction graph since they have no inputs. Set `data.dir` to the same directory same as you used in `extract-tx-graphs.R`.
## `determine-descendants.R` ## `determine-descendants.R`
The [R/determine-descendants.R](R/determine-descendants.R) script file uses the `igraph` package to determine which outputs in the unspent transaction output (UTXO) set can be traced back to an earlier CashFusion transaction. The dataset produced by the [CashFusionStats](https://github.com/Rucknium/CashFusionStats) repository is used to identify the CashFusion transactions. The [R/determine-descendants.R](R/determine-descendants.R) script file uses the `igraph` package to determine which outputs in the unspent transaction output (UTXO) set can be traced back to an earlier CashFusion transaction. The dataset produced by the [CashFusionStats](https://github.com/Rucknium/CashFusionStats) repository is used to identify the CashFusion transactions.

View file

@ -34,8 +34,8 @@ plot(illustrative.graph,
legend("topleft", legend("topleft",
legend = c("CashFusion", legend = c("CashFusion",
"Spent Cashfusion Descendant", "Spent Non-Cashfusion Descendant", "Spent CashFusion Descendant", "Spent Non-CashFusion Descendant",
"Unspent Cashfusion Descendant", "Unspent non-Cashfusion Descendant"), "Unspent CashFusion Descendant", "Unspent Non-CashFusion Descendant"),
fill = c("red", "purple", "blue", "orange", "green"), fill = c("red", "purple", "blue", "orange", "green"),
cex = 1.8, bty = "n") cex = 1.8, bty = "n")

Binary file not shown.

Before

Width:  |  Height:  |  Size: 42 KiB

After

Width:  |  Height:  |  Size: 42 KiB