Go to file

Braydon Fuller 24d1bc82e9 logger: added option to disable formatting - systemd journalctl includes timestamps in log messages already - updated logger to use console.error, console.warn, console.info, and etc.		2016-04-27 13:46:50 -04:00
benchmarks	bitcoind: bitcoind service using rpc and zmq with address index	2016-04-08 11:59:26 -04:00
bin	bitcoind: bitcoind service using rpc and zmq with address index	2016-04-08 11:59:26 -04:00
docs	docs: correct development environment docs	2016-04-19 14:00:22 -04:00
lib	logger: added option to disable formatting	2016-04-27 13:46:50 -04:00
regtest	test: added tests for stopSpawnedBitcoin	2016-04-26 17:29:40 -04:00
scripts	build: include environment variables for downloading bitcoin	2016-04-25 16:35:18 -04:00
test	logger: added option to disable formatting	2016-04-27 13:46:50 -04:00
.gitignore	build: verify bitcoin download	2016-04-25 16:08:19 -04:00
.jshintrc	Cleanup configuration options	2015-07-21 11:16:12 -04:00
.travis.yml	build: add jshint to scripts and ci build	2016-04-27 11:36:46 -04:00
LICENSE	Update Documentation to reflect Service Architecture	2015-08-31 12:11:20 -04:00
README.md	docs: include upgrade notes for bitcore 3 -> 4	2016-04-18 17:22:49 -04:00
index.js	bitcoind: bitcoind service using rpc and zmq with address index	2016-04-08 11:59:26 -04:00
package.json	logger: added option to disable formatting	2016-04-27 13:46:50 -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

Node.js v0.12 or v4.2
~150GB of disk storage
~4GB 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.