@mr-zwets/bchn-api-wrapper

BCHN-API-Wrapper

This library is a Typescript wrapper for interacting with the Bitcoin Cash Node (BCHN) RPC and REST interfaces.

Features

The library is a simple wrapper for using the BCHN REST and RPC-endpoints in a type-safe way.

The library is designed to be easy to use and get started with.

The library has good documentation, automated tests and zero dependencies.

Details

The BchnRestClient uses a class with unique methods for each of the endpoints.

The BchnRpcClient uses a request function which uses generics to type arguments and responses.

The REST API is ideal for read-only access to general blockchain information such as transactions, blocks, and UTXO data. In contrast, the RPC API allows for full interaction with the Bitcoin Cash node, including managing the built-in wallet, sending transactions, performing mining operations, and issuing control commands like pruning or stopping the node. While the REST API provides 9 endpoints, the RPC API offers a much broader set of 136 commands.

Configuration

To use the RPC and REST APIs on your BCHN node, you need to enable them in your node's configuration file.

BCHN Configuration

In the BCHN '.conf' file add the following settings:

  server=1
  rest=1
  txindex=1
  rpcuser=rpcuser
  rpcpassword=rpcpassword
  rpcallowip=127.0.0.1
  rpcport=8332

To learn more about the .conf settings, see the BCHN documentation.

Note that the REST-endpoints can be made public, but the RPC-endpoints should never be made public. If you want to use the RPC-endpoints of your own node remotely, you need a secure connection using SSL/TLS to encrypt your communication and protect your credentials and data from being exposed. Additionally, ensure you have strong, unique RPC credentials (username and password) set in your node's configuration file.

Install

Install the Bchn-API-Wrapper from NPM with:

npm install @mr-zwets/bchn-api-wrapper

or using yarn

yarn add @mr-zwets/bchn-api-wrapper

REST usage

The BchnRestClient is a wrapper over the 9 BCHN REST-endpoints. For the list of the BCHN REST-endpoints see the REST documentation.

The RestClientConfig object accepts optional parameters for logger & timeoutMs

REST example

import { BchnRestClient, RestClientConfig } from 'bchn-api-wrapper'

// Create the RestClientConfig
const clientOptions: RestClientConfig = {
  url: "http://localhost:8332",
}
// Instantiate the REST client to query your BCHN node
const restClient = new BchnRestClient(clientOptions)

// Get the latest blockhash
const chainInfo = await restClient.getChainInfo()
const latestBlockHash = chainInfo.bestblockhash
console.log(`The latest blockhash is ${latestBlockHash}`)

// Get block info with includeTxDetails flag
const fullBlockInfo = await restClient.getBlock(latestBlockHash, true)
console.log(JSON.stringify(fullBlockInfo))

RPC usage

The BchnRpcClient is a thin type-wrapper over the actual RPC endpoints, with request interfaces for each endpoint. For a complete list of all BCHN RPC-endpoints see the RPC documentation.

The RpcClientConfig object accepts optional parameters for logger, timeoutMs, retryDelayMs & maxRetries

The library does not currently support making batched RPC requests.

RPC example

import { BchnRpcClient, RpcClientConfig, GetBestBlockHash, GetBlockVerbosity1 } from 'bchn-api-wrapper'

// Create the RpcClientConfig
const clientOptions: RpcClientConfig = {
  url: "http://localhost:8332",
  rpcUser: "rpcUser",
  rpcPassword: "rpcPassword"
}
// Instantiate the RPC client to query your BCHN node
const rpcClient = new BchnRpcClient(clientOptions)

// Get the latest blockhash
const latestBlockHash = await rpcClient.request<GetBestBlockHash>("getbestblockhash")
console.log(`The latest blockhash is ${latestBlockHash}`)

// Get verbosity1 info about the latest block contents
const fullBlockInfo = await rpcClient.request<GetBlockVerbosity1>("getblock", latestBlockHash, 1)
console.log(JSON.stringify(fullBlockInfo))

Run Tests

The library has automated tests using vitest, run the testing suite with:

npm run test

or using yarn:

yarn test