Extensible full node using the Bitcore build of Bitcoin

Go to file

Braydon Fuller 0b2d5f4891 Merge pull request #220 from kleetus/script_helpers gitignore, integration test, env		2015-09-15 10:20:57 -04:00
benchmarks	Fix getBlock and getTransaction benchmarks.	2015-08-31 17:24:58 -04:00
bin	gitignore, integration test, env	2015-09-11 10:58:52 -04:00
cache
cli	Daemon	2015-09-04 17:36:53 -04:00
docs	document the web service	2015-09-10 11:59:20 -04:00
etc
example	Improve test coverage and cleanup.	2015-08-31 16:32:25 -04:00
integration	gitignore, integration test, env	2015-09-11 10:58:52 -04:00
lib	Switched to using a flag instead of using a replacement.	2015-09-14 13:15:55 -04:00
src	Performed lexical cast on the reject code instead of using a sprintf.	2015-09-10 13:20:06 -04:00
test	Merge pull request #220 from kleetus/script_helpers	2015-09-15 10:20:57 -04:00
.gitignore	more changes for services	2015-09-03 16:07:35 -04:00
.jshintrc
.travis.yml
binding.gyp
index.js	Rename modules to services.	2015-08-31 11:31:28 -04:00
LICENSE	Update Documentation to reflect Service Architecture	2015-08-31 12:11:20 -04:00
package.json	Bump development version to v0.2.0-dev	2015-09-09 13:39:26 -04:00
PATCH_VERSION
README.md	document the web service	2015-09-10 11:59:20 -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 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@0.2.0-beta.6
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.

Configuration

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

bitcore-node create -d <bitcoin-data-dir> mynode "My Node"
cd mynode
bitcore-node add <service>
bitcore-node add 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

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.