e046f7294e
- Adds parameter to cli methods to be able to specify the location of services modules. This is useful for packages that wrap bitcore-node to be able to pass along a node_modules directory with services. - Adds another parameter for including additional services in the default settings. - Will use the `process.env.HOME + '/.bitcore` as the default configuration location. - There are now two `getDefaultConfig`, one that will instatiate a `~/.bitcore` directory with a default if it doesn't exist, and `getBaseDefaultConfig` that will return a basic configuration without additional services enabled. - Changes logic to use the global install if a local node_modules version is not available, this would previously assume that it was a local install because of the existence of a configuration file. |
||
|---|---|---|
| benchmarks | ||
| bin | ||
| cache | ||
| docs | ||
| etc | ||
| example | ||
| integration | ||
| lib | ||
| src | ||
| test | ||
| .gitignore | ||
| .jshintrc | ||
| .travis.yml | ||
| LICENSE | ||
| PATCH_VERSION | ||
| README.md | ||
| binding.gyp | ||
| index.js | ||
| package.json | ||
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
- ~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 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
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.
Copyright 2013-2015 BitPay, Inc.
- bitcoin: Copyright (c) 2009-2015 Bitcoin Core Developers (MIT License)