Struct zaino_fetch::jsonrpc::connector::JsonRpcConnector

pub struct JsonRpcConnector { /* private fields */ }

JsonRPC Client config data.

Implementations

impl JsonRpcConnector

pub async fn new( uri: Uri, user: Option<String>, password: Option<String>, ) -> Result<Self, JsonRpcConnectorError>

Returns a new JsonRpcConnector instance, tests uri and returns error if connection is not established.

pub fn uri(&self) -> Result<Uri, JsonRpcConnectorError>

Returns the http::uri the JsonRpcConnector is configured to send requests to.

pub fn url(&self) -> Url

Returns the reqwest::url the JsonRpcConnector is configured to send requests to.

pub async fn get_info(&self) -> Result<GetInfoResponse, JsonRpcConnectorError>

Returns software information from the RPC server, as a [GetInfo] JSON struct.

zcashd reference: getinfo method: post tags: control

pub async fn get_blockchain_info( &self, ) -> Result<GetBlockchainInfoResponse, JsonRpcConnectorError>

Returns blockchain state information, as a [GetBlockChainInfo] JSON struct.

zcashd reference: getblockchaininfo method: post tags: blockchain

pub async fn get_address_balance( &self, addresses: Vec<String>, ) -> Result<GetBalanceResponse, JsonRpcConnectorError>

Returns the total balance of a provided addresses in an [AddressBalance] instance.

zcashd reference: getaddressbalance method: post tags: address

Parameters

• address_strings: (object, example={“addresses”: [“tmYXBYJj1K7vhejSec5osXK2QsGa5MTisUQ”]}) A JSON map with a single entry
  • addresses: (array of strings) A list of base-58 encoded addresses.

pub async fn send_raw_transaction( &self, raw_transaction_hex: String, ) -> Result<SendTransactionResponse, JsonRpcConnectorError>

Sends the raw bytes of a signed transaction to the local node’s mempool, if the transaction is valid. Returns the [SentTransactionHash] for the transaction, as a JSON string.

zcashd reference: sendrawtransaction method: post tags: transaction

Parameters

• raw_transaction_hex: (string, required, example=“signedhex”) The hex-encoded raw transaction bytes.

pub async fn get_block( &self, hash_or_height: String, verbosity: Option<u8>, ) -> Result<GetBlockResponse, JsonRpcConnectorError>

Returns the requested block by hash or height, as a [GetBlock] JSON string. If the block is not in Zebra’s state, returns error code -8.

zcashd reference: getblock method: post tags: blockchain

Parameters

• hash_or_height: (string, required, example=“1”) The hash or height for the block to be returned.
• verbosity: (number, optional, default=1, example=1) 0 for hex encoded data, 1 for a json object, and 2 for json object with transaction data.

pub async fn get_raw_mempool( &self, ) -> Result<TxidsResponse, JsonRpcConnectorError>

Returns all transaction ids in the memory pool, as a JSON array.

zcashd reference: getrawmempool method: post tags: blockchain

pub async fn get_treestate( &self, hash_or_height: String, ) -> Result<GetTreestateResponse, JsonRpcConnectorError>

Returns information about the given block’s Sapling & Orchard tree state.

zcashd reference: z_gettreestate method: post tags: blockchain

Parameters

• hash | height: (string, required, example=“00000000febc373a1da2bd9f887b105ad79ddc26ac26c2b28652d64e5207c5b5”) The block hash or height.

pub async fn get_subtrees_by_index( &self, pool: String, start_index: u16, limit: Option<u16>, ) -> Result<GetSubtreesResponse, JsonRpcConnectorError>

Returns information about a range of Sapling or Orchard subtrees.

zcashd reference: z_getsubtreesbyindex - TODO: fix link method: post tags: blockchain

Parameters

• pool: (string, required) The pool from which subtrees should be returned. Either “sapling” or “orchard”.
• start_index: (number, required) The index of the first 2^16-leaf subtree to return.
• limit: (number, optional) The maximum number of subtree values to return.

pub async fn get_raw_transaction( &self, txid_hex: String, verbose: Option<u8>, ) -> Result<GetTransactionResponse, JsonRpcConnectorError>

Returns the raw transaction data, as a [GetRawTransaction] JSON string or structure.

zcashd reference: getrawtransaction method: post tags: transaction

Parameters

• txid: (string, required, example=“mytxid”) The transaction ID of the transaction to be returned.
• verbose: (number, optional, default=0, example=1) If 0, return a string of hex-encoded data, otherwise return a JSON object.

pub async fn get_address_txids( &self, addresses: Vec<String>, start: u32, end: u32, ) -> Result<TxidsResponse, JsonRpcConnectorError>

Returns the transaction ids made by the provided transparent addresses.

zcashd reference: getaddresstxids method: post tags: address

Parameters

• request: (object, required, example={"addresses": ["tmYXBYJj1K7vhejSec5osXK2QsGa5MTisUQ"], "start": 1000, "end": 2000}) A struct with the following named fields:
  • addresses: (json array of string, required) The addresses to get transactions from.
  • start: (numeric, required) The lower height to start looking for transactions (inclusive).
  • end: (numeric, required) The top height to stop looking for transactions (inclusive).

pub async fn get_address_utxos( &self, addresses: Vec<String>, ) -> Result<Vec<GetUtxosResponse>, JsonRpcConnectorError>

Returns all unspent outputs for a list of addresses.

zcashd reference: getaddressutxos method: post tags: address

Parameters

• addresses: (array, required, example={"addresses": ["tmYXBYJj1K7vhejSec5osXK2QsGa5MTisUQ"]}) The addresses to get outputs from.

Trait Implementations

impl Debug for JsonRpcConnector

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.