Spawn a Bitcoin Core node
Last updated a year ago by mappum .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install bitcoind 
SYNC missed versions from official npm registry.


Run a Bitcoin Core full node from Node.js.

On install, this package downloads a prebuilt binary from the official Bitcoin Core releases, and checks it against a known SHA256 hash.


npm install bitcoind

let bitcoind = require('bitcoind')

// start the full node
let node = bitcoind({
  // options are turned into CLI args
  testnet: true,
  rpcport: 12345

// returns handle to child process

// comes with initialized rpc client


Spawns a Bitcoin Core full node.

Returns a ChildProcess object representing the bitcoind process. It has an rpc property which is a client for the node's RPC server (from the bitcoin-core package).

opts may be an object containing options passed to bitcoind as CLI arguments (you may use any flag supported by bitcoind). To see all supported options, run npx bitcoind --help.


Installing the package also exposes a bitcoind command, so you can use this as an easy way to install bitcoin:

$ npm i -g bitcoind
$ bitcoind -version

Current Tags

  • 1.2.1                                ...           latest (a year ago)

5 Versions

  • 1.2.1                                ...           a year ago
  • 1.2.0                                ...           a year ago
  • 1.1.1                                ...           a year ago
  • 1.1.0                                ...           a year ago
  • 1.0.0                                ...           a year ago
Maintainers (1)
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 7
Dependencies (8)
Dev Dependencies (1)
Dependents (0)

Copyright 2014 - 2017 © |