Bitcore Node (v5) (BCH)

!!THIS IS STILL IN BETA, Please use with caution and check the open issues before using!!

For a more Stable version of bitcore-node (v3.1.3) that works with BCH, please check this guide

Prerequisites

Bitcoin Cash Full node (local/remote).
- I used bitcoin-abc-0.17.2
Node.js v8.2.0+
build-essential and libzmq3-dev
- You can use sudo apt-get install build-essential libzmq3-dev
~200 GB (only for the full blockchain livenet/testnet, for regtest you don't need much)
~4GB of RAM

Install

git clone https://github.com/osagga/bitcore-node-cash.git && cd bitcore-node-cash
npm install
./bin/bitcore-node start

Configuration

This Bitcore node will "attach" to a running full node (you need to specify the ip of the full node in the main configuration file "bitcore-node.json), you need to have the Bitcoin Cash node running before starting this node. I would recommend using the same setting in bitcoin.conf.sample to setup the full Bitcoin-Cash node (at least the RPC settings since Bitcore uses the same RPC credentials by default.)

The config file instructs bitcore-node for the following options:

location of database files (datadir)
tcp port for web services, if configured (port)
bitcoin-cash network type (e.g. mainnet, testnet, regtest), (network)
what services to include (services)
the services' configuration (servicesConfig)
ip of the bitcoin cash peer, along with its RPC settings.

Documentation

Services
- Fee - Creates a service to handle fee queries
- Header - Creates a service to handle block headers
- Block - Creates a service to handle blocks
- Transaction - Creates a service to handle transactions
- Address - Creates a service to handle addresses
- Mempool - Creates a service to handle mempool
- Timestamp - Creates a service to handle timestamp
- Db - Creates a service to handle the database
- p2p - Creates a service to handle the peer-to-peer network
- Web - Creates an express application over which services can expose their web/API content
Development Environment - Guide for setting up a development environment
Node - Details on the node constructor
Bus - Overview of the event bus constructor
Release Process - Information about verifying a release and the release process.

License

Code released under the MIT license.

osagga / bitcore-node-cash

readme