Go to file

Chris Kleeschulte 0311d137ae Bump development version to v2.0.1		2016-02-01 14:41:30 -05:00
benchmarks	bitcore -> bitcore-lib	2015-10-17 00:56:29 -04:00
bin	Added arm support.	2016-01-29 13:40:45 -05:00
cache	Cache strategy changes	2015-08-05 16:29:54 -04:00
docs	DB: Include docs on how to recreate the database	2016-01-28 13:47:26 -05:00
etc	Bindings: Adjust patch to bitcoin for the 0.11.2 release	2015-11-13 11:35:47 -05:00
example	Improve test coverage and cleanup.	2015-08-31 16:32:25 -04:00
integration	Address Service: Fixed many bugs from tests	2016-01-13 17:15:14 -05:00
lib	DB: Include docs on how to recreate the database	2016-01-28 13:47:26 -05:00
src	Added bindings to be able to listen to tx leaving mempool.	2015-10-29 16:15:00 -04:00
test	DB Service: Include a version number for upgrading purposes	2016-01-28 12:08:05 -05:00
.gitignore	Address History: Include count in response results.	2015-09-15 13:17:15 -04:00
.jshintrc	Cleanup configuration options	2015-07-21 11:16:12 -04:00
.travis.yml	Fix #380 . Add missing git config properties if required before committing bitcoin core patch.	2015-12-23 18:03:44 -08:00
LICENSE	Update Documentation to reflect Service Architecture	2015-08-31 12:11:20 -04:00
PATCH_VERSION	Bindings: Adjust patch to bitcoin for the 0.11.2 release	2015-11-13 11:35:47 -05:00
README.md	Docs: Update prerequisites to include Node.js v4.2	2015-10-28 16:21:14 -04:00
binding.gyp	Use Nan::CopyBuffer to avoid invalid pointer errors during garbage collection.	2015-10-27 12:28:12 -04:00
index.js	Return node version check and include additional v4 engine.	2015-10-27 12:55:38 -04:00
package.json	Bump development version to v2.0.1	2016-02-01 14:41:30 -05: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 native bindings to Bitcoin Core with the Bitcoin Service. Additional services can be enabled to make a node more useful such as exposing new APIs, adding new indexes for addresses with the Address Service, running a block explorer, wallet service, and other customizations.

Install

npm install -g bitcore-node
bitcore-node start

Note: For your convenience, we distribute 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 Build & Install documentation to build the project from source.

Prerequisites

Node.js v0.12 or v4.2
~100GB of disk storage
~4GB of RAM
Mac OS X >= 10.9, Ubuntu >= 12.04 (libc >= 2.15 and libstdc++ >= 6.0.16)

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.

To start bitcore-node as a daemon:

bitcore-node start --daemon

Add-on Services

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

Documentation

Services
- Bitcoind - Native bindings to Bitcoin Core
- Database - The foundation API methods for getting information about blocks and transactions.
- Address - Adds additional API methods for querying and subscribing to events with bitcoin addresses.
- Web - Creates an express application over which services can expose their web/API content
Build & Install - How to build and install from source
Testing & Development - Developer guide for testing
Node - Details on the node constructor
Bus - Overview of the event bus constructor
Errors - Reference for error handling and types
Patch - Information about the patch applied to Bitcoin Core
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.