btc-stats is a command-line utility that interfaces with a Bitcoin Core-compatible
full node to gather and display blockchain statistics. The program can be used to
track various blockchain metrics such as hash rate, block times, and more.
To build and run btc-stats, the following dependencies are required:
This project is written in C++20, so you'll need a compiler that supports it (e.g., GCC, Clang).
CMake is required to configure and build the project.
- Install CMake using Homebrew:
brew install cmakeThis project uses the following Boost libraries:
- Boost.Asio (for networking)
- Boost.JSON (for JSON parsing)
- Boost.ProgramOptions (for command-line argument parsing)
- Boost.Beast (for handling HTTP requests)
You can install Boost via Homebrew:
brew install boostOn Raspberry Pi, you need to do the following to get boost:
sudo apt install libboost1.81-tools-dev
sudo apt install libboost1.81-all-dev
sudo apt install libboost-json1.81-devThis program requires access to a running Bitcoin Core-compatible full node. The node must have the following enabled:
- RPC enabled
- user/password for RPC access
You can run your own Bitcoin Core node or use an external provider, but make sure the RPC interface is accessible and that you have the necessary credentials.
git clone https://github.com/Fudmottin/btc-stats.git
cd btc-statsgit submodule update --initmkdir build
cd build
cmake ..
makeThis will compile the project and create an executable named btc-stats.
To run the program, you need to pass the required command-line arguments:
./btc-stats --host <bitcoin_node_host> --port <rpc_port> --user <rpc_user> --password <rpc_password> [--blockhash <block_hash>]
Arguments:
--host: The host of your Bitcoin Core node (e.g., 127.0.0.1 or an external IP).
--port: The RPC port of your Bitcoin Core node (default: 8332 for mainnet).
--user: The RPC username for authentication.
--password: The RPC password for authentication.
--blockhash (optional): The block hash to query for stats (defaults to the genesis block if not provided).
./btc-stats --host 127.0.0.1 --port 8332 --user myrpcuser --password myrpcpassword --blockhash 000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f
If the --blockhash argument is not provided, the program will default to the genesis block hash.
This project is licensed under the GPL v3 License - see the LICENSE file for details.