Skip to content

Latest commit

 

History

History
69 lines (48 loc) · 3.06 KB

README.md

File metadata and controls

69 lines (48 loc) · 3.06 KB
Raw

Bitmark Auditor bitmark-audit

An auditing suite for the Bitmark blockchain and mempool

Setup

Bitmark Configuration

The Bitmark configuration file must be set to allow JSON-RPC connections. By default, Bitmark (or bitmarkd) will look for a file name bitmark.conf in the bitmark data directory, but both the data directory and the configuration file path may be changed using the -datadir and -conf command-line arguments.

Operating System Default bitmark datadir Typical path to configuration file
Windows %APPDATA%\Bitmark\ C:\Users\username\AppData\Roaming\Bitmark\bitmark.conf
Linux $HOME/.bitmark/ /home/username/.bitmark/bitmark.conf
Mac OSX $HOME/Library/Application Support/Bitmark/ /Users/username/Library/Application Support/Bitmark/bitmark.conf

Specifically, the server flag must be set to 1 and both rpcuser and rpcpassword should be set to long unique strings. For example:

##
## bitmark.conf configuration file. Lines beginning with # are comments.
##

#
# JSON-RPC options (for controlling a running Bitmark/bitmarkd process)
#

# server=1 tells Bitmark-Qt and bitmarkd to accept JSON-RPC commands
server=1

# rpcuser and rpcpassword set the credentials necessary to access the JSON-RPC api.
rpcuser=Abscond
rpcpassword=You_Will_Get_Robbed_If_You_Use_This

Edit rpcAuth.js to reflect the values set in bitmark.conf.

Node.js

If not already done, install Node.JS

For Debian / Ubuntu

sudo apt-get install npm
sudo apt-get install nodejs-legacy

Finally, run npm install in the ~/bitmark-audit directory to install the required packages from package.json

   ~/bitmark-audit $ npm install

Usage

Two tools are included in this repository: monitor and audit.

monitor.js logs all valid blocks as they are broadcast. It will detect if multiple valid blocks are broadcast for a given block height, ie. it will detect orphaned blocks, forks, wipeouts, etc. It should run constantly, as if it is not running during such an event it will have no way of detecting it in retrospect.

audit.js scans the database built by monitor.js (bitmark.json) and audits it for any anomalies like those mentioned above (eg. multiple valid blocks for any block height.)

Notes

Monitoring began on 2017/07/07 at block height 286441. bitmark.json.bootstrap is a log file created up to height 287571. I (sneurlax) will work on uploading a canonical version of bitmark.json somewhere accessible "soon."

To ignore your username/password changes to rpcAuth.js, use the following command (instead of adding it to .gitignore:)

git update-index --assume-unchanged rpcAuth.js

Contributing

PR the latest stable pre-release code at #dev.