Run a node
In this section, we will take a look at how you can run your own BitDB node.
Note that you DO NOT have to run a node to use BitDB. Just like how not everyone needs to run a Bitcoin full node, you do not need to have to run BitDB full node. For most casual developers, it is recommended that you start by using the public API.
Prerequisite
First you need the following:
- Bitcoin: You must have a Bitcoin running on your computer.
- MongoDB: You must have set up a MongoDB database on your computer.
1. Bitcoin
BitDB sits on top of Bitcoin, therefore you need to have a Bitcoin node running.
Also, you need to configure your bitcoin node for BitDB to work, such as:
- Higher RPC limit
- Zeromq broadcast setting
- RPC username and password setting
Here's an example bitcoin.conf file to get your Bitcoin node to work with BitDB:
# location to store blockchain and other data.
datadir=/data/Bitcoin
dbcache=4000
# Must set txindex=1 so Bitcoin keeps the full index
txindex=1
# [rpc]
# Accept command line and JSON-RPC commands.
server=1
# Default Username and Password for JSON-RPC connections
# BitDB uses these values by default, but if you can change the settings
# By setting the config.json file in BitDB folder
rpcuser=root
rpcpassword=bitcoin
# If you want to allow remote JSON-RPC access
rpcallowip=0.0.0.0/0
# [wallet]
disablewallet=1
# [ZeroMQ]
# ZeroMQ messages power the realtime BitDB crawler
# so it's important to set the endpoint
zmqpubhashtx=tcp://127.0.0.1:28332
zmqpubhashblock=tcp://127.0.0.1:28332
# BitDB makes heavy use of JSON-RPC so it's set to a higher number
# But you can tweak this number as you want
rpcworkqueue=512
2. MongoDB
BitDB is powered by MongoDB, so you need to have installed MongoDB already.
Install BitDB
Once you've configured all of the above, you can install BitDB.
First, clone the repository:
$ git clone https://github.com/fountainhead-cash/bitd.git
Install dependencies:
npm install
Then run:
npm start
Configuration
You can also change the configuration by tweaking the config.json file.