rpc

Calls a Bitcoin RPC method with the given parameters via the Bitcoin Computer node.

Type

;(method: string, params: string) => Promise<any>

Parameters

method: string

Name of the Bitcoin RPC method to invoke (e.g. "getblockheader", "getrawtransaction", "sendtoaddress").

params: string

A space-separated string containing the arguments for the RPC call.

• For methods with optional trailing parameters, you may omit them.
• Use an empty string "" when calling methods that take no arguments.
• Example: "txid123 1" or just "txid123" (when the second parameter is optional).

Return Value

Returns a Promise that resolves to the response from the Bitcoin node, typically in the shape:

{
  result: any,   // The actual result returned by bitcoind
  error: any,
  id: number
}

Examples

// Call with no parameters
const mempoolInfo = await computer.rpc('getmempoolinfo', '')

// Call getblockheader with only the required hash (optional 'verbose' omitted)
const header = await computer.rpc('getblockheader', blockHash)

// Call getrawtransaction with verbosity
const tx = await computer.rpc('getrawtransaction', `${txId} 1`)

Notes

• The underlying node now supports omitting optional parameters for methods like getrawtransaction, getblock, and getblockheader.

• Only whitelisted methods (controlled by BCN_ALLOWED_RPC_METHODS on the node) can be called.

Source