Struct RestClient

Source

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,
}

Expand description

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§

Source §

impl<'a> RestClient<'a>

Source

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?;

Source

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

Source

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

Source

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);

Source

pub fn update_node_urls(&mut self, node_urls: &'a [String])

Updates the list of node URLs used by the client.

§Arguments

node_urls - New list of node URLs to use

Source

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

Source

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

Retrieves the confirmation proof for a given transaction.

This function makes a GET request to the /tx/{blockchain_rid}/{tx_rid}/confirmationProof endpoint of the Postchain node to fetch the cryptographic proof that a transaction has been confirmed on the blockchain.

§Arguments

blockchain_rid - A string slice representing the Blockchain RID (Resource Identifier)
tx_rid - A string slice representing the Transaction RID (Resource Identifier)

§Returns

Result<TransactionConfirmationProofData, RestError> - Returns Ok(TransactionConfirmationProofData) on successful retrieval and parsing of the proof, or Err(RestError) if the request fails, the response is not JSON, or the ‘proof’ field is missing/invalid.

§Errors

This function can return a RestError in the following cases:

If the underlying postchain_rest_api call fails (e.g., network issues, node unreachable).
If the response from the node is not a JSON object.
If the JSON response does not contain a “proof” field, or if the “proof” field is not a string.
If the string value of the “proof” field cannot be successfully parsed into a TransactionConfirmationProofData struct.

§Example

let client = RestClient::default();
let blockchain_rid = "your_blockchain_rid_hex_string"; // Replace with actual blockchain RID
let tx_rid = "your_transaction_rid_hex_string";     // Replace with actual transaction RID

match client.get_confirmation_proof(blockchain_rid, tx_rid).await {
    Ok(proof_data) => {
        println!("Successfully retrieved confirmation proof:");
        println!("Block height: {}", proof_data.block_height);
        // Further processing of proof_data...
    },
    Err(e) => {
        eprintln!("Failed to get confirmation proof: {}", e);
    }
}

Source

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

Retrieves the raw transaction data for a given transaction.

This function makes a GET request to the /tx/{blockchain_rid}/{tx_rid} endpoint of the Postchain node to fetch the raw hexadecimal representation of a transaction.

§Arguments

blockchain_rid - A string slice representing the Blockchain RID.
tx_rid - A string slice representing the Transaction RID.

§Returns

Result<Transaction, RestError> - Returns Ok(Transaction) on successful retrieval and parsing of the raw transaction data, or Err(RestError) if the request fails, the response is not JSON, or the ‘tx’ field is missing/invalid.

§Errors

This function can return a RestError in the following cases:

If the underlying postchain_rest_api call fails (e.g., network issues, node unreachable).
If the response from the node is not a JSON object.
If the JSON response does not contain a “tx” field, or if the “tx” field is not a string.
If the string value of the “tx” field cannot be successfully parsed into a Transaction struct by Transaction::from_raw_data.

§Example

let client = RestClient::default();
let blockchain_rid = "your_blockchain_rid_hex_string"; // Replace with actual blockchain RID
let tx_rid = "your_transaction_rid_hex_string";     // Replace with actual transaction RID

match client.get_raw_transaction_data(blockchain_rid, tx_rid).await {
    Ok(transaction) => {
        println!("Successfully retrieved raw transaction data: {:?}", transaction);
        // Further processing of transaction object...
    },
    Err(e) => {
        eprintln!("Failed to get raw transaction data: {}", e);
    }
}