Struct iota_sdk::client::core::ClientInner

pub struct ClientInner { /* private fields */ }

Available on crate feature client only.

Implementations

impl ClientInner

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 ClientInner

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<Hrp>

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 async fn get_tips_interval(&self) -> u64

returns the tips interval

pub async fn get_local_pow(&self) -> bool

returns if local pow should be used or not

pub async fn get_fallback_to_local_pow(&self) -> bool

returns the fallback_to_local_pow

pub async fn bech32_hrp_matches(&self, bech32_hrp: &Hrp) -> Result<()>

Validates if a bech32 HRP matches the one from the connected network.

pub async fn resize_request_pool(&self, new_size: usize)

Resize the client’s request pool

impl ClientInner

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_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<OutputWithMetadata>

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<OutputMetadata>

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<ReceiptResponse>>

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

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

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<PeerResponse>>

GET /api/core/v2/peers

impl ClientInner

pub async fn output_ids( &self, query_parameters: impl Into<Vec<QueryParameter>> + Send ) -> Result<OutputIdsResponse>

Get basic, alias, nft and foundry outputs filtered by the given parameters. GET with query parameter returns all outputIDs that fit these filter criteria. Query parameters: “hasNativeTokens”, “minNativeTokenCount”, “maxNativeTokenCount”, “unlockableByAddress”, “createdBefore”, “createdAfter”, “cursor”, “pageSize”. Returns Err(Node(NotFound) if no results are found. api/indexer/v1/outputs

pub async fn basic_output_ids( &self, query_parameters: impl Into<Vec<QueryParameter>> + Send ) -> Result<OutputIdsResponse>

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 Err(Node(NotFound) if no results are found. api/indexer/v1/outputs/basic

pub async fn alias_output_ids( &self, query_parameters: impl Into<Vec<QueryParameter>> + Send ) -> Result<OutputIdsResponse>

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 Err(Node(NotFound) 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: impl Into<Vec<QueryParameter>> + Send ) -> Result<OutputIdsResponse>

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 Err(Node(NotFound) 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: impl Into<Vec<QueryParameter>> + Send ) -> Result<OutputIdsResponse>

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 Err(Node(NotFound) 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 ClientInner

pub async fn get_output_ids( &self, route: &str, query_parameters: QueryParameters, need_quorum: bool, prefer_permanode: bool ) -> Result<OutputIdsResponse>

Get all output ids for a provided URL route and query parameters. If a QueryParameter::Cursor(_) is provided, only a single page will be queried.

impl ClientInner

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

Available on crate feature mqtt only.

Returns the mqtt event receiver.

impl ClientInner

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: impl ConvertTo<Bech32Address> ) -> 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: impl ConvertTo<Bech32Address> ) -> Result<AddressOutputsResponse>

Available on crate feature participation only.

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

impl ClientInner

pub async fn call_plugin_route<T>( &self, base_plugin_path: &str, method: &str, endpoint: &str, query_params: Vec<String>, request_object: Option<String> ) -> Result<T>

where T: DeserializeOwned + Debug + Serialize,

Extension method which provides request methods for plugins.

impl ClientInner

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

Get a node candidate from the healthy node pool.

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

returns the unhealthy nodes.

impl ClientInner

pub async fn hex_to_bech32( &self, hex: &str, bech32_hrp: Option<impl ConvertTo<Hrp>> ) -> Result<Bech32Address>

Transforms a hex encoded address to a bech32 encoded address

pub async fn alias_id_to_bech32( &self, alias_id: AliasId, bech32_hrp: Option<impl ConvertTo<Hrp>> ) -> Result<Bech32Address>

Transforms an alias id to a bech32 encoded address

pub async fn nft_id_to_bech32( &self, nft_id: NftId, bech32_hrp: Option<impl ConvertTo<Hrp>> ) -> Result<Bech32Address>

Transforms an nft id to a bech32 encoded address

pub async fn hex_public_key_to_bech32_address( &self, hex: &str, bech32_hrp: Option<impl ConvertTo<Hrp>> ) -> Result<Bech32Address>

Transforms a hex encoded public key to a bech32 encoded address