Struct iota_client::client::Client

pub struct Client { /* private fields */ }

An instance of the client using HORNET or Bee URI

Implementations

impl Client

pub async fn finish_block_builder( &self, parents: Option<Parents>, payload: Option<Payload> ) -> Result<Block>

Finishes the block with local PoW if needed. Without local PoW, it will finish the block with a 0 nonce.

pub async fn finish_pow( &self, parents: Option<Parents>, payload: Option<Payload> ) -> Result<Block>

Calls the appropriate PoW function depending whether the compilation is for wasm or not.

impl Client

pub async fn consolidate_funds( &self, secret_manager: &SecretManager, address_builder_options: GetAddressesBuilderOptions ) -> Result<String>

Function to consolidate all funds and native tokens 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

impl Client

pub async fn inputs_from_transaction_id( &self, transaction_id: &TransactionId ) -> Result<Vec<OutputWithMetadataResponse>>

Get the inputs of a transaction for the given transaction id.

pub fn block(&self) -> ClientBlockBuilder<'_>

A generic send function for easily sending transaction or tagged data blocks.

pub fn get_addresses<'a>( &'a self, secret_manager: &'a SecretManager ) -> GetAddressesBuilder<'a>

Return a list of addresses from a secret manager regardless of their validity.

pub async fn find_blocks(&self, block_ids: &[BlockId]) -> Result<Vec<Block>>

Find all blocks by provided block IDs.

pub async fn retry(&self, block_id: &BlockId) -> Result<(BlockId, Block)>

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

pub async fn retry_until_included( &self, block_id: &BlockId, interval: Option<u64>, max_attempts: Option<u64> ) -> Result<Vec<(BlockId, Block)>>

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

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), ignoring outputs with additional unlock conditions

pub async fn find_outputs( &self, output_ids: &[OutputId], addresses: &[String] ) -> Result<Vec<OutputWithMetadataResponse>>

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 async fn reattach(&self, block_id: &BlockId) -> Result<(BlockId, Block)>

Reattaches blocks for provided block id. Blocks can be reattached only if they are valid and haven’t been confirmed for a while.

pub async fn reattach_unchecked( &self, block_id: &BlockId ) -> Result<(BlockId, Block)>

Reattach a block without checking if it should be reattached

pub async fn promote(&self, block_id: &BlockId) -> Result<(BlockId, Block)>

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

pub async fn promote_unchecked( &self, block_id: &BlockId ) -> Result<(BlockId, Block)>

Promote a block without checking if it should be promoted

pub async fn get_time_checked(&self) -> Result<u32>

Returns the local time checked with the timestamp of the latest milestone, if the difference is larger than 5 minutes an error is returned to prevent locking outputs by accident for a wrong time.

impl Client

pub fn builder() -> ClientBuilder

Create the builder to instantiate the IOTA Client.

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 and set the NetworkInfo.

pub async fn get_protocol_parameters(&self) -> Result<ProtocolParameters>

Gets the protocol parameters of the node we’re connecting to.

pub async fn get_protocol_version(&self) -> Result<u8>

Gets the protocol version of the node we’re connecting to.

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

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

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

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

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

Gets the bech32 HRP of the node we’re connecting to.

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

Gets the minimum pow score of the node we’re connecting to.

pub async fn get_below_max_depth(&self) -> Result<u8>

Gets the below maximum depth of the node we’re connecting to.

pub async fn get_rent_structure(&self) -> Result<RentStructure>

Gets the rent structure of the node we’re connecting to.

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

Gets the token supply of the node we’re connecting to.

pub fn get_tips_interval(&self) -> u64

returns the tips interval

pub fn get_local_pow(&self) -> bool

returns if local pow should be used or not

pub fn get_fallback_to_local_pow(&self) -> bool

returns the fallback_to_local_pow

impl Client

pub async fn get_health(&self, url: &str) -> Result<bool>

Returns the health of the node. GET /health

pub async fn get_routes(&self) -> Result<RoutesResponse>

Returns the available API route groups of the node. GET /api/routes

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

Returns general information about the node. GET /api/core/v2/info

pub async fn get_node_info( url: &str, auth: Option<NodeAuth> ) -> Result<InfoResponse>

GET /api/core/v2/info endpoint

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

Returns tips that are ideal for attaching a block. GET /api/core/v2/tips

pub async fn post_block(&self, block: &Block) -> Result<BlockId>

Returns the BlockId of the submitted block. POST JSON to /api/core/v2/blocks

pub async fn post_block_raw(&self, block: &Block) -> Result<BlockId>

Returns the BlockId of the submitted block. POST /api/core/v2/blocks

pub async fn get_block(&self, block_id: &BlockId) -> Result<Block>

Finds a block by its BlockId. This method returns the given block object. GET /api/core/v2/blocks/{BlockId}

pub async fn get_block_raw(&self, block_id: &BlockId) -> Result<Vec<u8>>

Finds a block by its BlockId. This method returns the given block raw data. GET /api/core/v2/blocks/{BlockId}

pub async fn get_block_metadata( &self, block_id: &BlockId ) -> Result<BlockMetadataResponse>

Returns the metadata of a block. GET /api/core/v2/blocks/{BlockId}/metadata

pub async fn get_output( &self, output_id: &OutputId ) -> Result<OutputWithMetadataResponse>

Finds an output, as JSON, by its OutputId (TransactionId + output_index). GET /api/core/v2/outputs/{outputId}

pub async fn get_output_raw(&self, output_id: &OutputId) -> Result<Vec<u8>>

Finds an output, as raw bytes, by its OutputId (TransactionId + output_index). GET /api/core/v2/outputs/{outputId}

pub async fn get_output_metadata( &self, output_id: &OutputId ) -> Result<OutputMetadataDto>

Get the metadata for a given OutputId (TransactionId + output_index). GET /api/core/v2/outputs/{outputId}/metadata

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

Gets all stored receipts. GET /api/core/v2/receipts

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

Gets the receipts by the given milestone index. GET /api/core/v2/receipts/{migratedAt}

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

Gets the current treasury output. The treasury output contains all tokens from the legacy network that have not yet been migrated. GET /api/core/v2/treasury

pub async fn get_included_block( &self, transaction_id: &TransactionId ) -> Result<Block>

Returns the block, as object, that was included in the ledger for a given TransactionId. GET /api/core/v2/transactions/{transactionId}/included-block

pub async fn get_included_block_raw( &self, transaction_id: &TransactionId ) -> Result<Vec<u8>>

Returns the block, as raw bytes, that was included in the ledger for a given TransactionId. GET /api/core/v2/transactions/{transactionId}/included-block

pub async fn get_included_block_metadata( &self, transaction_id: &TransactionId ) -> Result<BlockMetadataResponse>

Returns the metadata of the block that was included in the ledger for a given TransactionId. GET /api/core/v2/transactions/{transactionId}/included-block/metadata

pub async fn get_milestone_by_id( &self, milestone_id: &MilestoneId ) -> Result<MilestonePayload>

Gets the milestone by the given milestone id. GET /api/core/v2/milestones/{milestoneId}

pub async fn get_milestone_by_id_raw( &self, milestone_id: &MilestoneId ) -> Result<Vec<u8>>

Gets the milestone by the given milestone id. GET /api/core/v2/milestones/{milestoneId}

pub async fn get_utxo_changes_by_id( &self, milestone_id: &MilestoneId ) -> Result<UtxoChangesResponse>

Gets all UTXO changes of a milestone by its milestone id. GET /api/core/v2/milestones/{milestoneId}/utxo-changes

pub async fn get_milestone_by_index( &self, index: u32 ) -> Result<MilestonePayload>

Gets the milestone by the given milestone index. GET /api/core/v2/milestones/{index}

pub async fn get_milestone_by_index_raw(&self, index: u32) -> Result<Vec<u8>>

Gets the milestone by the given milestone index. GET /api/core/v2/milestones/{index}

pub async fn get_utxo_changes_by_index( &self, index: u32 ) -> Result<UtxoChangesResponse>

Gets all UTXO changes of a milestone by its milestone index. GET /api/core/v2/milestones/by-index/{index}/utxo-changes

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

GET /api/core/v2/peers

impl Client

pub async fn get_outputs( &self, output_ids: Vec<OutputId> ) -> Result<Vec<OutputWithMetadataResponse>>

Request outputs by their output ID in parallel

pub async fn try_get_outputs( &self, output_ids: Vec<OutputId> ) -> Result<Vec<OutputWithMetadataResponse>>

Request outputs by their output ID in parallel, ignoring failed requests Useful to get data about spent outputs, that might not be pruned yet

pub async fn try_get_outputs_metadata( &self, output_ids: Vec<OutputId> ) -> Result<Vec<OutputMetadataDto>>

Requests metadata for outputs by their output ID in parallel, ignoring failed requests

impl Client

pub async fn basic_output_ids( &self, query_parameters: Vec<QueryParameter> ) -> Result<Vec<OutputId>>

Get basic outputs filtered by the given parameters. GET with query parameter returns all outputIDs that fit these filter criteria. Query parameters: “address”, “hasStorageDepositReturn”, “storageDepositReturnAddress”, “hasExpiration”, “expiresBefore”, “expiresAfter”, “hasTimelock”, “timelockedBefore”, “timelockedAfter”, “sender”, “tag”, “createdBefore” and “createdAfter”. Returns an empty Vec if no results are found. api/indexer/v1/outputs/basic

pub async fn alias_output_ids( &self, query_parameters: Vec<QueryParameter> ) -> Result<Vec<OutputId>>

Get alias outputs filtered by the given parameters. GET with query parameter returns all outputIDs that fit these filter criteria. Query parameters: “stateController”, “governor”, “issuer”, “sender”, “createdBefore”, “createdAfter” Returns an empty list if no results are found. api/indexer/v1/outputs/alias

pub async fn alias_output_id(&self, alias_id: AliasId) -> Result<OutputId>

Get alias output by its aliasID. api/indexer/v1/outputs/alias/:{AliasId}

pub async fn foundry_output_ids( &self, query_parameters: Vec<QueryParameter> ) -> Result<Vec<OutputId>>

Get foundry outputs filtered by the given parameters. GET with query parameter returns all outputIDs that fit these filter criteria. Query parameters: “address”, “createdBefore”, “createdAfter” Returns an empty list if no results are found. api/indexer/v1/outputs/foundry

pub async fn foundry_output_id(&self, foundry_id: FoundryId) -> Result<OutputId>

Get foundry output by its foundryID. api/indexer/v1/outputs/foundry/:{FoundryID}

pub async fn nft_output_ids( &self, query_parameters: Vec<QueryParameter> ) -> Result<Vec<OutputId>>

Get NFT outputs filtered by the given parameters. Query parameters: “address”, “hasStorageDepositReturn”, “storageDepositReturnAddress”, “hasExpiration”, “expiresBefore”, “expiresAfter”, “hasTimelock”, “timelockedBefore”, “timelockedAfter”, “issuer”, “sender”, “tag”, “createdBefore”, “createdAfter” Returns an empty list if no results are found. api/indexer/v1/outputs/nft

pub async fn nft_output_id(&self, nft_id: NftId) -> Result<OutputId>

Get NFT output by its nftID. api/indexer/v1/outputs/nft/:{NftId}

impl Client

pub async fn get_output_ids_with_pagination( &self, route: &str, query_parameters: Vec<QueryParameter>, need_quorum: bool, prefer_permanode: bool ) -> Result<Vec<OutputId>>

Get all output ids for a provided URL route and query parameters.

impl Client

pub fn subscriber(&self) -> MqttManager<'_>

Available on crate feature mqtt only.

Returns a handle to the MQTT topics manager.

pub async fn subscribe<C: Fn(&TopicEvent) + Send + Sync + 'static>( &self, topics: Vec<Topic>, callback: C ) -> Result<()>

Available on crate feature mqtt only.

Subscribe to MQTT events with a callback.

pub async fn unsubscribe(&self, topics: Vec<Topic>) -> Result<()>

Available on crate feature mqtt only.

Unsubscribe from MQTT events.

pub fn mqtt_event_receiver(&self) -> WatchReceiver<MqttEvent>

Available on crate feature mqtt only.

Returns the mqtt event receiver.

impl Client

pub async fn events( &self, event_type: Option<ParticipationEventType> ) -> Result<EventsResponse>

Available on crate feature participation only.

RouteParticipationEvents is the route to list all events, returning their ID, the event name and status.

pub async fn event( &self, event_id: &ParticipationEventId ) -> Result<ParticipationEventData>

Available on crate feature participation only.

RouteParticipationEvent is the route to access a single participation by its ID.

pub async fn event_status( &self, event_id: &ParticipationEventId, milestone_index: Option<u32> ) -> Result<ParticipationEventStatus>

Available on crate feature participation only.

RouteParticipationEventStatus is the route to access the status of a single participation by its ID.

pub async fn output_status( &self, output_id: &OutputId ) -> Result<OutputStatusResponse>

Available on crate feature participation only.

RouteOutputStatus is the route to get the vote status for a given output ID.

pub async fn address_staking_status( &self, bech32_address: &str ) -> Result<AddressStakingStatus>

Available on crate feature participation only.

RouteAddressBech32Status is the route to get the staking rewards for the given bech32 address.

pub async fn address_participation_output_ids( &self, bech32_address: &str ) -> Result<AddressOutputsResponse>

Available on crate feature participation only.

RouteAddressBech32Outputs is the route to get the outputs for the given bech32 address.

impl Client

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

Get a node candidate from the healthy node pool.

pub fn unhealthy_nodes(&self) -> HashSet<&Node>

returns the unhealthy nodes.

impl Client

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 alias_id_to_bech32( &self, alias_id: AliasId, bech32_hrp: Option<&str> ) -> Result<String>

Transforms an alias id to a bech32 encoded address

pub async fn nft_id_to_bech32( &self, nft_id: NftId, bech32_hrp: Option<&str> ) -> Result<String>

Transforms an nft id 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 fn generate_mnemonic() -> Result<String>

Generates a new mnemonic.

pub fn mnemonic_to_seed(mnemonic: &str) -> Result<Seed>

Returns a seed for a mnemonic.

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

Returns a hex encoded seed for a mnemonic.

pub fn tag_to_utf8(payload: &TaggedDataPayload) -> Result<String>

UTF-8 encodes the tag of a given TaggedDataPayload.

pub fn data_to_utf8(payload: &TaggedDataPayload) -> Result<String>

UTF-8 encodes the data of a given TaggedDataPayload.

pub fn tagged_data_to_utf8( payload: &TaggedDataPayload ) -> Result<(String, String)>

UTF-8 encodes both the tag and data of a given TaggedDataPayload.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

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