Extensible full node using the Bitcore build of Bitcoin

Go to file

Jason Dreyzehner 30bcddd34d refactor: downlevel, use strict		2017-08-09 12:51:18 -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	Adding documentation for queryMempool(Only)	2016-10-04 19:18:17 +02:00
lib	refactor: downlevel, use strict	2017-08-09 12:51:18 -04:00
test	Fixed off by one error when gathering blocks.	2017-08-08 17:53:07 -04:00
.coveralls.yml	build: run coveralls for unit test coverage	2016-05-24 15:02:49 -04:00
.gitignore	wip	2017-07-18 09:54:00 -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.connect	wip	2017-06-20 15:05:46 -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	Update Documentation to reflect Service Architecture	2015-08-31 12:11:20 -04:00
package-lock.json	ci(Travis): Fix build, fix (or ignore) jshint issues	2017-07-31 15:04:25 -04:00
package.json	feat(config): detect and move outdated config, replace with new default	2017-08-09 12:51:18 -04:00
README.md	Update links to bitcoin bitcore branch	2016-07-05 10:12:44 -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

GNU/Linux x86_32/x86_64, or OSX 64bit (for bitcoind distributed binaries)
Node.js v0.10, v0.12 or v4
ZeroMQ (libzmq3-dev for Ubuntu/Debian or zeromq on OSX)
~200GB of disk storage
~8GB 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

Upgrade Notes
Services
- Bitcoind - Interface to Bitcoin Core
- 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.