Go to file

Braydon Fuller 854f98fe43 Update Documentation to reflect Service Architecture		2015-08-31 12:11:20 -04:00
benchmarks	Merge pull request #101 from braydonf/blkbench	2015-08-04 16:42:59 -04:00
bin	Rename modules to services.	2015-08-31 11:31:28 -04:00
cache	Cache strategy changes	2015-08-05 16:29:54 -04:00
cli	Added CLI commands "remove" and "call"	2015-08-28 17:13:02 -04:00
docs	Update Documentation to reflect Service Architecture	2015-08-31 12:11:20 -04:00
etc	Removed signal handlers from bitcoind.	2015-08-24 13:29:42 -04:00
example	changes for BWS integration	2015-08-14 11:15:07 -04:00
integration	Rename modules to services.	2015-08-31 11:31:28 -04:00
lib	Rename modules to services.	2015-08-31 11:31:28 -04:00
src	Removed signal handlers from bitcoind.	2015-08-24 13:29:42 -04:00
test	Rename modules to services.	2015-08-31 11:31:28 -04:00
.gitignore	Added files to gitignore for libbitcoind and also using this for npm.	2015-08-10 15:30:33 -04:00
.jshintrc	Cleanup configuration options	2015-07-21 11:16:12 -04:00
.travis.yml	Added node reorg integration regtest	2015-08-24 13:59:33 -04:00
LICENSE	Update Documentation to reflect Service Architecture	2015-08-31 12:11:20 -04:00
PATCH_VERSION	1. Updated patch for v0.11.0	2015-07-13 16:34:29 -04:00
README.md	Update Documentation to reflect Service Architecture	2015-08-31 12:11:20 -04:00
binding.gyp	Added CFLAGS for the bindings so that they know that the wallet is compiled in.	2015-08-19 16:33:01 -04:00
index.js	Rename modules to services.	2015-08-31 11:31:28 -04:00
package.json	Combine chain with db module.	2015-08-31 11:25:30 -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.5
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.

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.
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.