Struct RestClient

pub struct RestClient<'a> {
    pub node_url: Vec<&'a str>,
    pub request_time_out: u64,
    pub poll_attemps: u64,
    pub poll_attemp_interval_time: u64,
}

A REST client for interacting with Postchain blockchain nodes.

This client handles communication with blockchain nodes, including:

• Transaction submission and status checking
• Node discovery and management
• Query execution
• Error handling

Fields

node_url: Vec<&'a str>

List of node URLs to connect to

request_time_out: u64

Request timeout in seconds

poll_attemps: u64

Number of attempts to poll for transaction status

poll_attemp_interval_time: u64

Interval between poll attempts in seconds

Implementations

impl<'a> RestClient<'a>

pub async fn get_nodes_from_directory( &self, brid: &str, ) -> Result<Vec<String>, RestError>

Retrieves a list of node URLs from the blockchain directory.

Arguments

• brid - Blockchain RID (Resource Identifier)

Returns

• Result<Vec<String>, RestError> - List of node URLs on success, or error on failure

Example

let client = RestClient::default();
let nodes = client.get_nodes_from_directory("blockchain_rid").await?;

pub async fn get_blockchain_rid( &self, blockchain_iid: u8, ) -> Result<String, RestError>

Retrieves the blockchain RID for a given blockchain IID.

Arguments

• blockchain_iid - Blockchain Instance Identifier

Returns

• Result<String, RestError> - Blockchain RID on success, or error on failure

pub fn print_error(&self, error: &RestError, ignore_all_errors: bool) -> bool

Prints error information and determines if the error should be ignored.

Arguments

• error - The REST error to print
• ignore_all_errors - Whether to ignore all errors

Returns

• bool - Whether the error should stop execution

pub async fn detect_merkle_hash_version(&self, brid: &str) -> u8

Detects the Merkle hash version used by a blockchain.

This function queries the blockchain’s configuration to determine which version of the Merkle hash algorithm is being used. If the query fails or the version information is not available, it defaults to version 1.

Arguments

• brid - The blockchain RID (Resource Identifier) as a hex-encoded string

Returns

• u8 - The Merkle hash version number (defaults to 1 if not specified)

Example

let client = RestClient::default();
let brid = "DCE5D72ED7E1675291AFE7F9D649D898C8D3E7411E52882D03D1B3D240BDD91B";
let hash_version = client.detect_merkle_hash_version(brid).await;
println!("Blockchain uses Merkle hash version {}", hash_version);

pub fn update_node_urls(&mut self, node_urls: &'a Vec<String>)

Updates the list of node URLs used by the client.

Arguments

• node_urls - New list of node URLs to use

pub async fn get_transaction_status( &self, blockchain_rid: &str, tx_rid: &str, ) -> Result<TransactionStatus, RestError>

Gets the status of a transaction without polling.

Arguments

• blockchain_rid - Blockchain RID
• tx_rid - Transaction RID

Returns

• Result<TransactionStatus, RestError> - Transaction status or error

pub async fn get_transaction_status_with_poll( &self, blockchain_rid: &str, tx_rid: &str, attempts: u64, ) -> Result<TransactionStatus, RestError>

Gets the status of a transaction with polling for confirmation.

Arguments

• blockchain_rid - Blockchain RID
• tx_rid - Transaction RID
• attempts - Number of polling attempts made so far

Returns

• Result<TransactionStatus, RestError> - Transaction status or error

pub async fn send_transaction( &self, tx: &Transaction<'a>, ) -> Result<RestResponse, RestError>

Sends a transaction to the blockchain.

Arguments

• tx - Transaction to send

Returns

• Result<RestResponse, RestError> - Response from the blockchain or error

pub async fn query<T: AsRef<str>>( &self, brid: &str, query_prefix: Option<&str>, query_type: &'a str, query_params: Option<&'a mut Vec<(&'a str, &'a str)>>, query_args: Option<&'a mut Vec<(T, Params)>>, ) -> Result<RestResponse, RestError>

Executes a query on the blockchain.

Arguments

• brid - Blockchain RID
• query_prefix - Optional prefix for the query endpoint
• query_type - Type of query to execute
• query_params - Optional query parameters
• query_args - Optional query arguments

Returns

• Result<RestResponse, RestError> - Query response or error

Trait Implementations

impl<'a> Debug for RestClient<'a>

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

Formats the value using the given formatter.

impl<'a> Default for RestClient<'a>

fn default() -> Self

Returns the “default value” for a type.