bitcoin-rpc

A client library to connect to Bitcoin Core RPC in Node.js.

This library forked from bitpay/bitcoind-rpc, fixed and updated.

Supported promises and callbacks.

Supported Bitcoin Core versions:

• v0.20.1.

Get Started

Installing

bitcoin-rpc runs on Node.js, and can be installed via yarn or npm:

# installed via yarn as git repo
yarn add https://github.com/an-ivannikov-dev/bitcoin-rpc-js.git
# installed via yarn
yarn add bitcoin-rpc
# installed via npm
npm install bitcoin-rpc

Usage

// Last version
const RpcClient = require('bitcoin-rpc');
// or specific version
// const RpcClient = require('bitcoin-rpc/v0.20.1');


const config = {
  protocol: 'http',
  user: 'rpcuser',
  pass: 'rpcpassword',
  host: '127.0.0.1',
  port: '18443', // default: 8333, testnet: 18333, regtest: 18443)
  pathname: '/', // /wallet/<walletname>
};

const rpc = new RpcClient(config);

Examples

callback(response.error, response.result, response);
resolve(response.result, response);
reject(response.error || error, response);
// batch -> response;
const { error, result, id, } = response;

const bitcore = require('bitcore');
// const RpcClient = require('bitcoin-rpc/v0.20.1');
const RpcClient = require('bitcoin-rpc');


const config = {
  protocol: 'http',
  user: 'rpcuser',
  pass: 'rpcpassword',
  host: '127.0.0.1',
  port: '18443', // default: 8333, testnet: 18333, regtest: 18443)
  pathname: '/', // /wallet/<walletname>
};

const rpc = new RpcClient(config);

async function getBlockCount() {
  let count = -1;
  try {
    count = await rpc.getBlockCount();
  } catch (error) { }
  return count;
}

const run = async function () {
  const blockCount = await getBlockCount();
  console.log('getBlockCount =', blockCount);

  rpc.getBlockCount()
    .then((count) => rpc.getBlockHash(count))
    .then((hash) => rpc.getBlockHeader(hash))
    .then((result) => console.log('Chained calls 1. last block header:', result))
    .catch((error) => console.error('Chained calls 1. error:', error));

  rpc.getBlockCount()
    .then((count) => rpc.getBlockHash(count))
    .then((hash) => rpc.getBlock(hash))
    .then((block) => {
      function batchCall() {
        block.tx.forEach((txid) => {
          const verbose = true;
          rpc.getRawTransaction(txid, verbose, block.hash);
        });
      }
      return rpc.batch(batchCall);
    })
    .then((result) => console.log('chained calls 2. result:', JSON.stringify(result, null, 2)))
    .catch((error) => console.log('chained calls 2. error:', error));

  rpc.createBatch()
    .getBlockCount()
    .getBlockchainInfo()
    .getZmqNotifications()
    .call((error, response) => console.log('Batch call 1:', error, response));

  rpc.createBatch()
    .getBlockCount()
    .getBlockchainInfo()
    .getZmqNotifications()
    .call()
    .then((response) => console.log('Batch call 2. response:', JSON.stringify(response, null, 2)))
    .catch((error) => console.error('Batch call 2. error:', error));


  let txids = [];

  function showNewTransactions() {
    rpc.getRawMemPool((err, ret) => {
      if (err) {
        console.error(err);
        return setTimeout(showNewTransactions, 10000);
      }

      function batchCall() {
        ret.forEach((txid) => {
          if (txids.indexOf(txid) === -1) {
            rpc.getRawTransaction(txid);
          }
        });
      }

      rpc.batch(batchCall, (err, rawtxs) => {
        if (err) {
          console.error(err);
          return setTimeout(showNewTransactions, 10000);
        }

        rawtxs.map((rawtx) => {
          const tx = new bitcore.Transaction(rawtx);
          console.log('\n\n\n' + tx.id + ':', tx.toObject());
        });

        txids = ret;
        setTimeout(showNewTransactions, 2500);
      });
    });
  }

  showNewTransactions();
};

run();