Struct iota_client::client::Client

pub struct Client { /* fields omitted */ }

An instance of the client using HORNET or Bee URI

Implementations

impl Client

pub fn builder() -> ClientBuilder

Create the builder to instntiate the IOTA Client.

pub async fn get_node(&self) -> Result<Node>

Get a node candidate from the synced node pool.

pub async fn get_network_id(&self) -> Result<u64>

Gets the network id of the node we’re connecting to.

pub async fn get_pow_provider(&self) -> ClientMiner

Gets the miner to use based on the PoW setting

pub async fn get_network_info(&self) -> Result<NetworkInfo>

Gets the network related information such as network_id and min_pow_score and if it’s the default one, sync it first.

pub async fn get_bech32_hrp(&self) -> Result<String>

returns the bech32_hrp

pub async fn get_min_pow_score(&self) -> Result<f64>

returns the min pow score

pub async fn get_tips_interval(&self) -> u64

returns the tips interval

pub async fn get_local_pow(&self) -> bool

returns the local pow

pub async fn unsynced_nodes(&self) -> HashSet<&Node>

returns the unsynced nodes.

pub fn generate_mnemonic() -> Result<String>

Generates a new mnemonic.

pub fn mnemonic_to_hex_seed(mnemonic: &str) -> Result<String>

Returns a hex encoded seed for a mnemonic.

pub async fn find_inputs(
    &self,
    addresses: Vec<String>,
    amount: u64
) -> Result<Vec<UtxoInput>>

Function to find inputs from addresses for a provided amount (useful for offline signing)

pub async fn get_node_health(url: &str) -> Result<bool>

GET /health endpoint

pub async fn get_health(&self) -> Result<bool>

GET /health endpoint

pub async fn get_node_info(
    url: &str,
    jwt: Option<String>,
    auth_name_pwd: Option<(&str, &str)>
) -> Result<NodeInfo>

GET /api/v1/info endpoint

pub async fn get_info(&self) -> Result<NodeInfoWrapper>

GET /api/v1/info endpoint

pub async fn get_peers(&self) -> Result<Vec<PeerDto>>

GET /api/v1/peers endpoint

pub async fn get_tips(&self) -> Result<Vec<MessageId>>

GET /api/v1/tips endpoint

pub async fn post_message(&self, message: &Message) -> Result<MessageId>

POST /api/v1/messages endpoint

pub async fn post_message_json(&self, message: &Message) -> Result<MessageId>

POST JSON to /api/v1/messages endpoint

pub fn get_message(&self) -> GetMessageBuilder<'_>

GET /api/v1/messages/{messageId} endpoint

pub async fn get_output(&self, output_id: &UtxoInput) -> Result<OutputResponse>

GET /api/v1/outputs/{outputId} endpoint Find an output by its transaction_id and corresponding output_index.

pub async fn find_outputs(
    &self,
    outputs: &[UtxoInput],
    addresses: &[String]
) -> Result<Vec<OutputResponse>>

Find all outputs based on the requests criteria. This method will try to query multiple nodes if the request amount exceeds individual node limit.

pub fn get_address(&self) -> GetAddressBuilder<'_>

GET /api/v1/addresses/{address} endpoint

pub async fn get_milestone(&self, index: u32) -> Result<MilestoneResponse>

GET /api/v1/milestones/{index} endpoint Get the milestone by the given index.

pub async fn get_milestone_utxo_changes(
    &self,
    index: u32
) -> Result<MilestoneUTXOChanges>

GET /api/v1/milestones/{index}/utxo-changes endpoint Get the milestone by the given index.

pub async fn get_receipts(&self) -> Result<Vec<ReceiptDto>>

GET /api/v1/receipts endpoint Get all receipts.

pub async fn get_receipts_migrated_at(
    &self,
    milestone_index: u32
) -> Result<Vec<ReceiptDto>>

GET /api/v1/receipts/{migratedAt} endpoint Get the receipts by the given milestone index.

pub async fn get_treasury(&self) -> Result<TreasuryResponse>

GET /api/v1/treasury endpoint Get the treasury output.

pub async fn get_included_message(
    &self,
    transaction_id: &TransactionId
) -> Result<Message>

GET /api/v1/transactions/{transactionId}/included-message Returns the included message of the transaction.

pub async fn reattach(
    &self,
    message_id: &MessageId
) -> Result<(MessageId, Message)>

Reattaches messages for provided message id. Messages can be reattached only if they are valid and haven’t been confirmed for a while.

pub async fn reattach_unchecked(
    &self,
    message_id: &MessageId
) -> Result<(MessageId, Message)>

Reattach a message without checking if it should be reattached

pub async fn promote(
    &self,
    message_id: &MessageId
) -> Result<(MessageId, Message)>

Promotes a message. The method should validate if a promotion is necessary through get_message. If not, the method should error out and should not allow unnecessary promotions.

pub async fn promote_unchecked(
    &self,
    message_id: &MessageId
) -> Result<(MessageId, Message)>

Promote a message without checking if it should be promoted

pub fn message(&self) -> ClientMessageBuilder<'_>

A generic send function for easily sending transaction or indexation messages.

pub fn get_unspent_address<'a>(
    &'a self,
    seed: &'a Seed
) -> GetUnspentAddressBuilder<'a>

Return a valid unspent address.

pub fn get_addresses<'a>(&'a self, seed: &'a Seed) -> GetAddressesBuilder<'a>

Return a list of addresses from the seed regardless of their validity.

pub async fn find_messages<I: AsRef<[u8]>>(
    &self,
    indexation_keys: &[I],
    message_ids: &[MessageId]
) -> Result<Vec<Message>>

Find all messages by provided message IDs and/or indexation_keys.

pub fn get_balance<'a>(&'a self, seed: &'a Seed) -> GetBalanceBuilder<'a>

Return the balance for a provided seed and its wallet chain account index. Addresses with balance must be consecutive, so this method will return once it encounters a zero balance address.

pub async fn get_address_balances(
    &self,
    addresses: &[String]
) -> Result<Vec<BalanceAddressResponse>>

Return the balance in iota for the given addresses; No seed needed to do this since we are only checking and already know the addresses.

pub fn bech32_to_hex(bech32: &str) -> Result<String>

Transforms bech32 to hex

pub async fn hex_to_bech32(
    &self,
    hex: &str,
    bech32_hrp: Option<&str>
) -> Result<String>

Transforms a hex encoded address to a bech32 encoded address

pub async fn hex_public_key_to_bech32_address(
    &self,
    hex: &str,
    bech32_hrp: Option<&str>
) -> Result<String>

Transforms a hex encoded public key to a bech32 encoded address

pub fn parse_bech32_address(address: &str) -> Result<Address>

Returns a valid Address parsed from a String.

pub fn is_address_valid(address: &str) -> bool

Checks if a String is a valid bech32 encoded address.

pub async fn retry(
    &self,
    message_id: &MessageId
) -> Result<(MessageId, Message)>

Retries (promotes or reattaches) a message for provided message id. Message should only be retried only if they are valid and haven’t been confirmed for a while.

pub async fn retry_until_included(
    &self,
    message_id: &MessageId,
    interval: Option<u64>,
    max_attempts: Option<u64>
) -> Result<Vec<(MessageId, Message)>>

Retries (promotes or reattaches) a message for provided message id until it’s included (referenced by a milestone). Default interval is 5 seconds and max attempts is 40. Returns the included message at first position and additional reattached messages

pub async fn consolidate_funds(
    &self,
    seed: &Seed,
    account_index: usize,
    address_range: Range<usize>
) -> Result<String>

Function to consolidate all funds from a range of addresses to the address with the lowest index in that range Returns the address to which the funds got consolidated, if any were available

Trait Implementations

impl Debug for Client

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

Formats the value using the given formatter.

impl Drop for Client

fn drop(&mut self)

Gracefully shutdown the Client