Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

denariicore-node

carsenk9MIT3.1.7

Full node with extended capabilities using Bitcore and Denarius Core

readme

Bitcore Node Denarius

A Denarius 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 Denarius Core v2.5.x.x 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 denariicore-node

Prerequisites

  • Denarius Core (v2.5.0.x) with support for additional indexing (see above)
  • Node.js v0.10, v0.12, v4 or v5
  • ZeroMQ (libzmq3-dev for Ubuntu/Debian or zeromq on OSX)
  • ~20GB of disk storage
  • ~1GB of RAM

Configuration

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

denariicore-node create -d <denarius-data-dir> mynode
cd mynode
denariicore-node install <service>
denariicore-node install https://github.com/yourname/helloworld
denariicore-node start

This will create a directory with configuration files for your node and install the necessary dependencies.

Please note that Denarius Core v2.5.0.x will be downloaded automatically. Once completed the denariusd binary should be placed into the <denarius-data-dir> folder specified during node creation.

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.

Copyright 2013-2015 BitPay, Inc.

  • bitcoin: Copyright (c) 2009-2015 Bitcoin Core Developers (MIT License)

changelog

Release Process

Binaries for bitcoind are distributed for convenience and built deterministically with Gitian, signatures for bitcoind are located at the gitian.sigs respository.

How to Release

When publishing to npm, the .gitignore file is used to exclude files from the npm publishing process. Be sure that the denariicore-node directory has only the directories and files that you would like to publish to npm. You might need to run the commands below on each platform that you intend to publish (e.g. Mac and Linux).

To make a release, bump the version of the package.json:

git checkout master
git pull upstream master
npm install
npm run test
npm run regtest
npm run jshint
git commit -a -m "Bump package version to <version>"
git push upstream master
npm publish

Create a release tag and push it to the BitPay Github repo:

git tag -s v<version> -m 'v<version>'
git push upstream v<version>