Wondering what’s next for npm?Check out our public roadmap! »

grpc-bchrpc-node
TypeScript icon, indicating that this package has built-in type declarations

0.12.0 • Public • Published

A BCHD gRPC client for node.js

This package provides a gRPC client for connecting to BCHD. SLP support is provided when the full node has SLP index enabled, which is currently under development here.

Install

$ npm i grpc-bchrpc-node (for web-browser based projects see this version)

Run Unit Tests

$ git clone https://github.com/simpleledgerinc/grpc-bchrpc-node $ npm i $ npm test

Optional: Rebuild gRPC generated js & d.ts from source (from ./bchrpc.proto)

  1. Install Protobuf Compiler from: https://github.com/protocolbuffers/protobuf
  2. $ npm i
  3. $ npm run build

Example usage

In this simple example we create a new client that connects to bchd.greyh.at:8335 and calls the getRawTransaction rpc endpoint and prints the result to the console. We use reversedHashOrder: true to automatically reverse the txid endianness because BCHD expects to receive transaction hashes without endianness reversed.

let grpc = new GrpcClient();
let txid = "11556da6ee3cb1d14727b3a8f4b37093b6fecd2bc7d577a02b4e98b7be58a7e8";
let res = await grpc.getRawTransaction({ hash: txid, reversedHashOrder: true });
console.log(Buffer.from(res.getTransaction_asU8()).toString('hex'));

See also the test directory for more examples of how to use.

Tests

Some integration tests have been added. Extensive test coverage is not planned currently planned since this library is just a wrapper for BCHD's gRPC interface.

$ npm test

Known Public Instances

Connecting to local BCHD

To connect to a local BCHD server you will need to utilize a self-signed certificate. Simply start BCHD using rpccert= and rpckey= flags pointing to a location where to save new certificate and private key files.

Then you can connect using the following GrpcClient constructor:

const grpc = new GrpcClient({ url: "localhost:8335", rootCertPath: "<path to cert>"});

Install

npm i grpc-bchrpc-node

DownloadsWeekly Downloads

99

Version

0.12.0

License

MIT

Unpacked Size

901 kB

Total Files

11

Last publish

Collaborators

  • avatar