Skip to content
Extensible full node using the Bitcore build of Bitcoin
Branch: master
Clone or download
Pull request Compare This branch is 9 commits behind bitpay:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin bitcoind: bitcoind service using rpc and zmq with address index Apr 8, 2016
contrib
docs Removed the link about upgrading from previous versions of bitcore node. Aug 21, 2017
lib
test change order to 'desc' Feb 11, 2018
.coveralls.yml
.gitignore Removed symlink. Aug 18, 2017
.jshintrc refactor: downlevel, use strict Aug 9, 2017
.npmignore Bumped the version. Aug 30, 2017
.travis.yml Cleanup on aisle package.json. Aug 29, 2017
LICENSE Update Documentation to reflect Service Architecture Aug 31, 2015
README.md Removed global install directions. Aug 21, 2017
addresses.txt
bitcore-node.json.sample Fixed tests and repaired reorg logic. Oct 26, 2017
index.js wip Jun 22, 2017
package-lock.json
package.json Bumped version. Nov 22, 2017

README.md

Bitcore Node

A Bitcoin blockchain indexing and query service. Intended to be used with as a Bitcoin full node or in conjunction with a Bitcoin full node.

Upgrading from previous versions of Bitcore Node

There is no upgrade path from previous versions of Bitcore Node due to the removal of the included Bitcoin Core software. By installing this version, you must resynchronize the indexes from scratch.

Install

npm install
./bin/bitcore-node start

Note: A default configuration file is placed in the bitcore user's home directory (~/.bitcore/bitcore-node.json). Or, alternatively, you can copy the provided "bitcore-node.json.sample" file to the project's root directory as bitcore-node.json and edit it for your preferences. If you don't have a preferred block source (trusted peer), Bcoin will be started automatically and synchronized with the mainnet chain.

Prerequisites

  • Node.js v8.2.0+
  • ~500GB of disk storage
  • ~4GB of RAM

Configuration

The main configuration file is called "bitcore-node.json". This file instructs bitcore-node for the following options:

  • location of database files (datadir)
  • tcp port for web services, if configured (port)
  • bitcoin network type (e.g. mainnet, testnet3, regtest), (network)
  • what services to include (services)
  • the services' configuration (servicesConfig)

Add-on Services

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

Documentation

  • Services
    • Fee - Creates a service to handle fee queries
    • Header - Creates a service to handle block headers
    • Block - Creates a service to handle blocks
    • Transaction - Creates a service to handle transactions
    • Address - Creates a service to handle addresses
    • Mempool - Creates a service to handle mempool
    • Timestamp - Creates a service to handle timestamp
    • Db - Creates a service to handle the database
    • p2p - Creates a service to handle the peer-to-peer network
    • 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.

Copyright 2013-2017 BitPay, Inc.

  • bitcoin: Copyright (c) 2009-2015 Bitcoin Core Developers (MIT License)
You can’t perform that action at this time.