Package Exports

bitcoin-cash-rpc

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (bitcoin-cash-rpc) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Bitcoin Cash JSON-RPC library

Javascript Library to communicate with your Bitcoin Unlimited / Bitcoin ABC / Bitcoin Classic Node.

header

This is a promise-based library and async/await compatible. Includes a couple additional helpers, such as a QRcode generator as well as Bitpay's Address translator. Supports both address formats.

Installation

grab from NPM

  npm i bitcoin-cash-rpc

Usage

let BCC = require("bitcoin-cash-rpc");
let bcc = new BCC(host, username, password, port, 3000);

 let info = await bcc.getInfo();

 console.log(info)

 // results in
 //{
 //  "version": 1010101,
 //  "protocolversion": 80003,
 //  "walletversion": 60000,
 //  "balance": 0.00000000,
 //  "blocks": 478559,
 //  "timeoffset": 0,
 //  "connections": 12,
 //  "proxy": "",
 //  "difficulty": 29829733124.04042,
 //  "testnet": false,
 //  "keypoololdest": 1506057198,
 //  "keypoolsize": 100,
 //  "paytxfee": 0.00000000,
 //  "relayfee": 0.00001000,
 //  "errors": "",
 //  "fork": "Bitcoin Cash"
 //}

 p = Promise.resolve(bcc.getInfo());
 p.then(info=>{
    console.log(info);
 })

Available Methods

there is incomplete coverage at the moment. Please submit a PR if you'd like to have a method added.

getInfo getBlockCount getWalletInfo getUnconfirmedBalance getBalance getWalletInfo getBlockHash getNewAddress setTxFee validateAddress sendToAddress sendFrom getAccountAddress getBlock getTxOut listTransactions estimateSmartFee getTransaction getRawTransaction getRawMempool sendRawTransaction

Compatible Node Implementations

You must be running a Node (Pruned mode is fine)

Bitcoin ABC

Bitcoin XT

Bitcoin Unlimited (Cash)

bitcoin-cash-rpc