pub struct Client { /* private fields */ }
client
only.Expand description
An IOTA node client.
Implementations§
source§impl Client
impl Client
sourcepub async fn consolidate_funds(
&self,
secret_manager: &SecretManager,
options: GetAddressesOptions
) -> Result<Bech32Address>
pub async fn consolidate_funds( &self, secret_manager: &SecretManager, options: GetAddressesOptions ) -> Result<Bech32Address>
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
source§impl Client
impl Client
sourcepub async fn inputs_from_transaction_id(
&self,
transaction_id: &TransactionId
) -> Result<Vec<OutputWithMetadata>>
pub async fn inputs_from_transaction_id( &self, transaction_id: &TransactionId ) -> Result<Vec<OutputWithMetadata>>
Get the inputs of a transaction for the given transaction id.
sourcepub fn build_block(&self) -> ClientBlockBuilder<'_>
pub fn build_block(&self) -> ClientBlockBuilder<'_>
Get a builder that can be used to construct a block in parts.
sourcepub async fn find_blocks(&self, block_ids: &[BlockId]) -> Result<Vec<Block>>
pub async fn find_blocks(&self, block_ids: &[BlockId]) -> Result<Vec<Block>>
Find all blocks by provided block IDs.
sourcepub async fn retry(&self, block_id: &BlockId) -> Result<(BlockId, Block)>
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.
sourcepub async fn retry_until_included(
&self,
block_id: &BlockId,
interval: Option<u64>,
max_attempts: Option<u64>
) -> Result<Vec<(BlockId, Block)>>
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
sourcepub async fn find_inputs(
&self,
addresses: Vec<Bech32Address>,
amount: u64
) -> Result<Vec<UtxoInput>>
pub async fn find_inputs( &self, addresses: Vec<Bech32Address>, 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
sourcepub async fn reattach(&self, block_id: &BlockId) -> Result<(BlockId, Block)>
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.
sourcepub async fn reattach_unchecked(
&self,
block_id: &BlockId
) -> Result<(BlockId, Block)>
pub async fn reattach_unchecked( &self, block_id: &BlockId ) -> Result<(BlockId, Block)>
Reattach a block without checking if it should be reattached
sourcepub async fn promote(&self, block_id: &BlockId) -> Result<(BlockId, Block)>
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.
sourcepub async fn promote_unchecked(
&self,
block_id: &BlockId
) -> Result<(BlockId, Block)>
pub async fn promote_unchecked( &self, block_id: &BlockId ) -> Result<(BlockId, Block)>
Promote a block without checking if it should be promoted
sourcepub async fn get_time_checked(&self) -> Result<u32>
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.
source§impl Client
impl Client
sourcepub fn builder() -> ClientBuilder
pub fn builder() -> ClientBuilder
Create the builder to instantiate the IOTA Client.
source§impl Client
impl Client
sourcepub async fn get_node_info(
url: &str,
auth: Option<NodeAuth>
) -> Result<InfoResponse>
pub async fn get_node_info( url: &str, auth: Option<NodeAuth> ) -> Result<InfoResponse>
GET /api/core/v2/info endpoint
source§impl Client
impl Client
sourcepub async fn get_outputs(
&self,
output_ids: &[OutputId]
) -> Result<Vec<OutputWithMetadata>>
pub async fn get_outputs( &self, output_ids: &[OutputId] ) -> Result<Vec<OutputWithMetadata>>
Request outputs by their output ID in parallel
sourcepub async fn get_outputs_ignore_errors(
&self,
output_ids: &[OutputId]
) -> Result<Vec<OutputWithMetadata>>
pub async fn get_outputs_ignore_errors( &self, output_ids: &[OutputId] ) -> Result<Vec<OutputWithMetadata>>
Request outputs by their output ID in parallel, ignoring failed requests Useful to get data about spent outputs, that might not be pruned yet
sourcepub async fn get_outputs_metadata_ignore_errors(
&self,
output_ids: &[OutputId]
) -> Result<Vec<OutputMetadata>>
pub async fn get_outputs_metadata_ignore_errors( &self, output_ids: &[OutputId] ) -> Result<Vec<OutputMetadata>>
Requests metadata for outputs by their output ID in parallel, ignoring failed requests
source§impl Client
impl Client
sourcepub fn subscriber(&self) -> MqttManager<'_>
Available on crate feature mqtt
only.
pub fn subscriber(&self) -> MqttManager<'_>
mqtt
only.Returns a handle to the MQTT topics manager.
sourcepub async fn subscribe<C: Fn(&TopicEvent) + Send + Sync + 'static>(
&self,
topics: impl IntoIterator<Item = Topic> + Send,
callback: C
) -> Result<(), Error>
Available on crate feature mqtt
only.
pub async fn subscribe<C: Fn(&TopicEvent) + Send + Sync + 'static>( &self, topics: impl IntoIterator<Item = Topic> + Send, callback: C ) -> Result<(), Error>
mqtt
only.Subscribe to MQTT events with a callback.
sourcepub async fn unsubscribe(
&self,
topics: impl IntoIterator<Item = Topic> + Send
) -> Result<(), Error>
Available on crate feature mqtt
only.
pub async fn unsubscribe( &self, topics: impl IntoIterator<Item = Topic> + Send ) -> Result<(), Error>
mqtt
only.Unsubscribe from MQTT events.
source§impl Client
impl Client
pub async fn update_node_manager(&self, node_manager: NodeManager) -> Result<()>
source§impl Client
impl Client
sourcepub fn bech32_to_hex(bech32: impl ConvertTo<Bech32Address>) -> Result<String>
pub fn bech32_to_hex(bech32: impl ConvertTo<Bech32Address>) -> Result<String>
Transforms bech32 to hex
sourcepub fn generate_mnemonic() -> Result<Mnemonic>
pub fn generate_mnemonic() -> Result<Mnemonic>
Generates a new mnemonic.
sourcepub fn mnemonic_to_seed(mnemonic: impl Borrow<MnemonicRef>) -> Result<Seed>
pub fn mnemonic_to_seed(mnemonic: impl Borrow<MnemonicRef>) -> Result<Seed>
Returns a seed for a mnemonic.
sourcepub fn mnemonic_to_hex_seed(
mnemonic: impl Borrow<MnemonicRef>
) -> Result<String>
pub fn mnemonic_to_hex_seed( mnemonic: impl Borrow<MnemonicRef> ) -> Result<String>
Returns a hex encoded seed for a mnemonic.
sourcepub fn tag_to_utf8(payload: &TaggedDataPayload) -> Result<String>
pub fn tag_to_utf8(payload: &TaggedDataPayload) -> Result<String>
UTF-8 encodes the tag
of a given TaggedDataPayload.
sourcepub fn data_to_utf8(payload: &TaggedDataPayload) -> Result<String>
pub fn data_to_utf8(payload: &TaggedDataPayload) -> Result<String>
UTF-8 encodes the data
of a given TaggedDataPayload.
sourcepub fn tagged_data_to_utf8(
payload: &TaggedDataPayload
) -> Result<(String, String)>
pub fn tagged_data_to_utf8( payload: &TaggedDataPayload ) -> Result<(String, String)>
UTF-8 encodes both the tag
and data
of a given TaggedDataPayload.
Methods from Deref<Target = ClientInner>§
sourcepub async fn finish_block_builder(
&self,
parents: Option<Parents>,
payload: Option<Payload>
) -> Result<Block>
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.
sourcepub async fn finish_pow(
&self,
parents: Option<Parents>,
payload: Option<Payload>
) -> Result<Block>
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.
sourcepub async fn get_network_info(&self) -> Result<NetworkInfo>
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.
sourcepub async fn get_protocol_parameters(&self) -> Result<ProtocolParameters>
pub async fn get_protocol_parameters(&self) -> Result<ProtocolParameters>
Gets the protocol parameters of the node we’re connecting to.
sourcepub async fn get_protocol_version(&self) -> Result<u8>
pub async fn get_protocol_version(&self) -> Result<u8>
Gets the protocol version of the node we’re connecting to.
sourcepub async fn get_network_name(&self) -> Result<String>
pub async fn get_network_name(&self) -> Result<String>
Gets the network name of the node we’re connecting to.
sourcepub async fn get_network_id(&self) -> Result<u64>
pub async fn get_network_id(&self) -> Result<u64>
Gets the network id of the node we’re connecting to.
sourcepub async fn get_bech32_hrp(&self) -> Result<Hrp>
pub async fn get_bech32_hrp(&self) -> Result<Hrp>
Gets the bech32 HRP of the node we’re connecting to.
sourcepub async fn get_min_pow_score(&self) -> Result<u32>
pub async fn get_min_pow_score(&self) -> Result<u32>
Gets the minimum pow score of the node we’re connecting to.
sourcepub async fn get_below_max_depth(&self) -> Result<u8>
pub async fn get_below_max_depth(&self) -> Result<u8>
Gets the below maximum depth of the node we’re connecting to.
sourcepub async fn get_rent_structure(&self) -> Result<RentStructure>
pub async fn get_rent_structure(&self) -> Result<RentStructure>
Gets the rent structure of the node we’re connecting to.
sourcepub async fn get_token_supply(&self) -> Result<u64>
pub async fn get_token_supply(&self) -> Result<u64>
Gets the token supply of the node we’re connecting to.
sourcepub async fn get_tips_interval(&self) -> u64
pub async fn get_tips_interval(&self) -> u64
returns the tips interval
sourcepub async fn get_local_pow(&self) -> bool
pub async fn get_local_pow(&self) -> bool
returns if local pow should be used or not
sourcepub async fn get_fallback_to_local_pow(&self) -> bool
pub async fn get_fallback_to_local_pow(&self) -> bool
returns the fallback_to_local_pow
sourcepub async fn bech32_hrp_matches(&self, bech32_hrp: &Hrp) -> Result<()>
pub async fn bech32_hrp_matches(&self, bech32_hrp: &Hrp) -> Result<()>
Validates if a bech32 HRP matches the one from the connected network.
sourcepub async fn resize_request_pool(&self, new_size: usize)
pub async fn resize_request_pool(&self, new_size: usize)
Resize the client’s request pool
sourcepub async fn get_health(&self, url: &str) -> Result<bool>
pub async fn get_health(&self, url: &str) -> Result<bool>
Returns the health of the node. GET /health
sourcepub async fn get_routes(&self) -> Result<RoutesResponse>
pub async fn get_routes(&self) -> Result<RoutesResponse>
Returns the available API route groups of the node. GET /api/routes
sourcepub async fn get_info(&self) -> Result<NodeInfoWrapper>
pub async fn get_info(&self) -> Result<NodeInfoWrapper>
Returns general information about the node. GET /api/core/v2/info
sourcepub async fn get_tips(&self) -> Result<Vec<BlockId>>
pub async fn get_tips(&self) -> Result<Vec<BlockId>>
Returns tips that are ideal for attaching a block. GET /api/core/v2/tips
sourcepub async fn post_block(&self, block: &Block) -> Result<BlockId>
pub async fn post_block(&self, block: &Block) -> Result<BlockId>
Returns the BlockId of the submitted block. POST JSON to /api/core/v2/blocks
sourcepub async fn post_block_raw(&self, block: &Block) -> Result<BlockId>
pub async fn post_block_raw(&self, block: &Block) -> Result<BlockId>
Returns the BlockId of the submitted block. POST /api/core/v2/blocks
sourcepub async fn get_block(&self, block_id: &BlockId) -> Result<Block>
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}
sourcepub async fn get_block_raw(&self, block_id: &BlockId) -> Result<Vec<u8>>
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}
sourcepub async fn get_block_metadata(
&self,
block_id: &BlockId
) -> Result<BlockMetadataResponse>
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
sourcepub async fn get_output(
&self,
output_id: &OutputId
) -> Result<OutputWithMetadata>
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}
sourcepub async fn get_output_raw(&self, output_id: &OutputId) -> Result<Vec<u8>>
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}
sourcepub async fn get_output_metadata(
&self,
output_id: &OutputId
) -> Result<OutputMetadata>
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
sourcepub async fn get_receipts(&self) -> Result<Vec<ReceiptResponse>>
pub async fn get_receipts(&self) -> Result<Vec<ReceiptResponse>>
Gets all stored receipts. GET /api/core/v2/receipts
sourcepub async fn get_receipts_migrated_at(
&self,
milestone_index: u32
) -> Result<Vec<ReceiptResponse>>
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}
sourcepub async fn get_treasury(&self) -> Result<TreasuryResponse>
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
sourcepub async fn get_included_block(
&self,
transaction_id: &TransactionId
) -> Result<Block>
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
sourcepub async fn get_included_block_raw(
&self,
transaction_id: &TransactionId
) -> Result<Vec<u8>>
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
sourcepub async fn get_included_block_metadata(
&self,
transaction_id: &TransactionId
) -> Result<BlockMetadataResponse>
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
sourcepub async fn get_milestone_by_id(
&self,
milestone_id: &MilestoneId
) -> Result<MilestonePayload>
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}
sourcepub async fn get_milestone_by_id_raw(
&self,
milestone_id: &MilestoneId
) -> Result<Vec<u8>>
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}
sourcepub async fn get_utxo_changes_by_id(
&self,
milestone_id: &MilestoneId
) -> Result<UtxoChangesResponse>
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
sourcepub async fn get_milestone_by_index(
&self,
index: u32
) -> Result<MilestonePayload>
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}
sourcepub async fn get_milestone_by_index_raw(&self, index: u32) -> Result<Vec<u8>>
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}
sourcepub async fn get_utxo_changes_by_index(
&self,
index: u32
) -> Result<UtxoChangesResponse>
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
sourcepub async fn get_peers(&self) -> Result<Vec<PeerResponse>>
pub async fn get_peers(&self) -> Result<Vec<PeerResponse>>
GET /api/core/v2/peers
sourcepub async fn output_ids(
&self,
query_parameters: impl Into<Vec<QueryParameter>> + Send
) -> Result<OutputIdsResponse>
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
sourcepub async fn basic_output_ids(
&self,
query_parameters: impl Into<Vec<QueryParameter>> + Send
) -> Result<OutputIdsResponse>
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
sourcepub async fn alias_output_ids(
&self,
query_parameters: impl Into<Vec<QueryParameter>> + Send
) -> Result<OutputIdsResponse>
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
sourcepub async fn alias_output_id(&self, alias_id: AliasId) -> Result<OutputId>
pub async fn alias_output_id(&self, alias_id: AliasId) -> Result<OutputId>
Get alias output by its aliasID. api/indexer/v1/outputs/alias/:{AliasId}
sourcepub async fn foundry_output_ids(
&self,
query_parameters: impl Into<Vec<QueryParameter>> + Send
) -> Result<OutputIdsResponse>
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
sourcepub async fn foundry_output_id(&self, foundry_id: FoundryId) -> Result<OutputId>
pub async fn foundry_output_id(&self, foundry_id: FoundryId) -> Result<OutputId>
Get foundry output by its foundryID. api/indexer/v1/outputs/foundry/:{FoundryID}
sourcepub async fn nft_output_ids(
&self,
query_parameters: impl Into<Vec<QueryParameter>> + Send
) -> Result<OutputIdsResponse>
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
sourcepub async fn nft_output_id(&self, nft_id: NftId) -> Result<OutputId>
pub async fn nft_output_id(&self, nft_id: NftId) -> Result<OutputId>
Get NFT output by its nftID. api/indexer/v1/outputs/nft/:{NftId}
sourcepub async fn get_output_ids(
&self,
route: &str,
query_parameters: QueryParameters,
need_quorum: bool,
prefer_permanode: bool
) -> Result<OutputIdsResponse>
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.
sourcepub async fn mqtt_event_receiver(&self) -> WatchReceiver<MqttEvent>
Available on crate feature mqtt
only.
pub async fn mqtt_event_receiver(&self) -> WatchReceiver<MqttEvent>
mqtt
only.Returns the mqtt event receiver.
sourcepub async fn events(
&self,
event_type: Option<ParticipationEventType>
) -> Result<EventsResponse>
Available on crate feature participation
only.
pub async fn events( &self, event_type: Option<ParticipationEventType> ) -> Result<EventsResponse>
participation
only.RouteParticipationEvents is the route to list all events, returning their ID, the event name and status.
sourcepub async fn event(
&self,
event_id: &ParticipationEventId
) -> Result<ParticipationEventData>
Available on crate feature participation
only.
pub async fn event( &self, event_id: &ParticipationEventId ) -> Result<ParticipationEventData>
participation
only.RouteParticipationEvent is the route to access a single participation by its ID.
sourcepub async fn event_status(
&self,
event_id: &ParticipationEventId,
milestone_index: Option<u32>
) -> Result<ParticipationEventStatus>
Available on crate feature participation
only.
pub async fn event_status( &self, event_id: &ParticipationEventId, milestone_index: Option<u32> ) -> Result<ParticipationEventStatus>
participation
only.RouteParticipationEventStatus is the route to access the status of a single participation by its ID.
sourcepub async fn output_status(
&self,
output_id: &OutputId
) -> Result<OutputStatusResponse>
Available on crate feature participation
only.
pub async fn output_status( &self, output_id: &OutputId ) -> Result<OutputStatusResponse>
participation
only.RouteOutputStatus is the route to get the vote status for a given output ID.
sourcepub async fn address_staking_status(
&self,
bech32_address: impl ConvertTo<Bech32Address>
) -> Result<AddressStakingStatus>
Available on crate feature participation
only.
pub async fn address_staking_status( &self, bech32_address: impl ConvertTo<Bech32Address> ) -> Result<AddressStakingStatus>
participation
only.RouteAddressBech32Status is the route to get the staking rewards for the given bech32 address.
sourcepub async fn address_participation_output_ids(
&self,
bech32_address: impl ConvertTo<Bech32Address>
) -> Result<AddressOutputsResponse>
Available on crate feature participation
only.
pub async fn address_participation_output_ids( &self, bech32_address: impl ConvertTo<Bech32Address> ) -> Result<AddressOutputsResponse>
participation
only.RouteAddressBech32Outputs is the route to get the outputs for the given bech32 address.
sourcepub 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>
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>
Extension method which provides request methods for plugins.
sourcepub async fn unhealthy_nodes(&self) -> HashSet<Node>
pub async fn unhealthy_nodes(&self) -> HashSet<Node>
returns the unhealthy nodes.
sourcepub async fn hex_to_bech32(
&self,
hex: &str,
bech32_hrp: Option<impl ConvertTo<Hrp>>
) -> Result<Bech32Address>
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
sourcepub async fn alias_id_to_bech32(
&self,
alias_id: AliasId,
bech32_hrp: Option<impl ConvertTo<Hrp>>
) -> Result<Bech32Address>
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
sourcepub async fn nft_id_to_bech32(
&self,
nft_id: NftId,
bech32_hrp: Option<impl ConvertTo<Hrp>>
) -> Result<Bech32Address>
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
sourcepub async fn hex_public_key_to_bech32_address(
&self,
hex: &str,
bech32_hrp: Option<impl ConvertTo<Hrp>>
) -> Result<Bech32Address>
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
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more