Go to file

Braydon Fuller dab49aef39 docs: various updates - remove build and update bitcoind - remove outdated error documentation - update bus docs		2016-04-15 16:55:59 -04:00
benchmarks	bitcoind: bitcoind service using rpc and zmq with address index	2016-04-08 11:59:26 -04:00
bin	bitcoind: bitcoind service using rpc and zmq with address index	2016-04-08 11:59:26 -04:00
docs	docs: various updates	2016-04-15 16:55:59 -04:00
lib	web: option to enable/disable socket rpc handling	2016-04-15 11:20:38 -04:00
regtest	bitcoind: rename exported events to rawtransaction and hashblock	2016-04-15 11:20:38 -04:00
scripts	test: update unit tests, refactoring and cleanup	2016-04-15 11:20:33 -04:00
test	test: bitcoind getaddressbalance unit test	2016-04-15 16:35:31 -04:00
.gitignore	test: add regtest for multiple bitcoind connections	2016-04-08 22:17:45 -04:00
.jshintrc	Cleanup configuration options	2015-07-21 11:16:12 -04:00
.travis.yml	test: update unit tests, refactoring and cleanup	2016-04-15 11:20:33 -04:00
LICENSE	Update Documentation to reflect Service Architecture	2015-08-31 12:11:20 -04:00
README.md	docs: various updates	2016-04-15 16:55:59 -04:00
index.js	bitcoind: bitcoind service using rpc and zmq with address index	2016-04-08 11:59:26 -04:00
package.json	test: update unit tests, refactoring and cleanup	2016-04-15 11:20:33 -04:00

README.md

Bitcore Node

A Bitcoin full node for building applications and services with Node.js. A node is extensible and can be configured to run additional services. At the minimum a node has an interface to Bitcoin Core with additional indexing for more advanced address queries. Additional services can be enabled to make a node more useful such as exposing new APIs, running a block explorer and wallet service.

Install

npm install -g bitcore-node
bitcore-node start

Note: For your convenience, we distribute bitcoind binaries for x86_64 Linux and x86_64 Mac OS X. Upon npm install, the binaries for your platform will be downloaded. For more detailed installation instructions, or if you want to compile the project yourself, then please see the Bitcore branch of Bitcoin Core with additional indexing.

Prerequisites

Node.js v0.12 or v4.2
~150GB of disk storage
~4GB of RAM

Configuration

Bitcore includes a Command Line Interface (CLI) for managing, configuring and interfacing with your Bitcore Node.

bitcore-node create -d <bitcoin-data-dir> mynode
cd mynode
bitcore-node install <service>
bitcore-node install https://github.com/yourname/helloworld

This will create a directory with configuration files for your node and install the necessary dependencies. For more information about (and developing) services, please see the Service Documentation.

Add-on Services

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

Documentation

Services
- Bitcoind - Interface to Bitcoin Core
- Web - Creates an express application over which services can expose their web/API content
Testing & Development - Developer guide for testing
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.