@owstack/btc-node

Bitcoin Core full node with extended capabilities.

Stats

StarsIssuesVersionUpdatedCreatedSize
@owstack/btc-node
030.1.13 years ago4 years agoMinified + gzip package size for @owstack/btc-node in KB

Readme

Btc Node

NPM Package Build Status Coverage Status

A Bitcoin full node for building applications and services with Node.js. A node is extensible and can be configured to run additional services. 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 @owstack/btc-node
btcnode start

Prerequisites

  • GNU/Linux x86_32/x86_64, or OSX 64bit (for bitcoind distributed binaries)
  • Node.js v0.10, v0.12 or v4
  • ZeroMQ (libzmq3-dev for Ubuntu/Debian or zeromq on OSX)
  • ~200GB of disk storage
  • ~8GB of RAM

Configuration

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

btcnode create -d <bitcoin-data-dir> mynode
cd mynode
btcnode install <service>
btcnode 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 Btc-node:

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 2017 Open Wallet Stack

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

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.