Extensible full node using the Bitcore build of Bitcoin

Go to file

Chris Kleeschulte 678cb83d61 Fixed tests for altered getAddressHistory and getAddressSummary calls.		2017-08-24 09:50:29 -04:00
bin	bitcoind: bitcoind service using rpc and zmq with address index	2016-04-08 11:59:26 -04:00
contrib	stream test	2017-01-26 18:18:57 -05:00
docs	Removed the link about upgrading from previous versions of bitcore node.	2017-08-21 13:21:24 -04:00
lib	Fixed tests for altered getAddressHistory and getAddressSummary calls.	2017-08-24 09:50:29 -04:00
test	Fixed tests for altered getAddressHistory and getAddressSummary calls.	2017-08-24 09:50:29 -04:00
.coveralls.yml	build: run coveralls for unit test coverage	2016-05-24 15:02:49 -04:00
.gitignore	Removed symlink.	2017-08-18 15:23:36 -04:00
.jshintrc	refactor: downlevel, use strict	2017-08-09 12:51:18 -04:00
.travis.yml	ci(Travis): Fix build, fix (or ignore) jshint issues	2017-07-31 15:04:25 -04:00
bitcore-node.json.sample	wip	2017-07-21 13:02:35 -04:00
index.js	wip	2017-06-22 14:10:23 -04:00
LICENSE
package-lock.json	chore(release): 5.0.0-beta.2	2017-08-18 19:42:19 -04:00
package.json	chore(release): 5.0.0-beta.2	2017-08-18 19:42:19 -04:00
README.md	Removed global install directions.	2017-08-21 16:21:55 -04:00

README.md

Bitcore Node

A Bitcoin blockchain indexing and query service. Intended to be used with as a Bitcoin full node or in conjunction with a Bitcoin full node.

Upgrading from previous versions of Bitcore Node

There is no upgrade path from previous versions of Bitcore Node due to the removal of the included Bitcoin Core software. By installing this version, you must resynchronize the indexes from scratch.

Install

npm install
./bin/bitcore-node start

Note: A default configuration file is placed in the bitcore user's home directory (~/.bitcore/bitcore-node.json). Or, alternatively, you can copy the provided "bitcore-node.json.sample" file to the project's root directory as bitcore-node.json and edit it for your preferences. If you don't have a preferred block source (trusted peer), Bcoin will be started automatically and synchronized with the mainnet chain.

Prerequisites

Node.js v8.2.0+
~500GB of disk storage
~4GB of RAM

Configuration

The main configuration file is called "bitcore-node.json". This file instructs bitcore-node for the following options:

location of database files (datadir)
tcp port for web services, if configured (port)
bitcoin network type (e.g. mainnet, testnet3, regtest), (network)
what services to include (services)
the services' configuration (servicesConfig)

Add-on Services

There are several add-on services available to extend the functionality of Bitcore:

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.

Contributing

Please send pull requests for bug fixes, code optimization, and ideas for improvement. For more information on how to contribute, please refer to our CONTRIBUTING file.

License

Code released under the MIT license.