Struct Client 

pub struct Client<Env: Environment> {
    pub local_node: LocalNodeClient<Env::Storage>,
    /* private fields */
}

A builder that creates ChainClients which share the cache and notifiers.

Fields

local_node: LocalNodeClient<Env::Storage>

Local node to manage the execution state and the local storage of the chains that we are tracking.

Implementations

impl<Env: Environment> Client<Env>

pub fn new( environment: Env, admin_chain_id: ChainId, long_lived_services: bool, chain_modes: impl IntoIterator<Item = (ChainId, ListeningMode)>, name: impl Into<String>, chain_worker_ttl: Duration, sender_chain_worker_ttl: Duration, options: ChainClientOptions, requests_scheduler_config: RequestsSchedulerConfig, ) -> Self

Creates a new Client with a new cache and notifiers.

pub fn admin_chain_id(&self) -> ChainId

Returns the chain ID of the admin chain.

pub fn storage_client(&self) -> &Env::Storage

Returns the storage client used by this client’s local node.

pub fn validator_node_provider(&self) -> &Env::Network

pub fn signer(&self) -> &Env::Signer

Returns a reference to the client’s Signer.

pub async fn has_key_for( &self, owner: &AccountOwner, ) -> Result<bool, ChainClientError>

Returns whether the signer has a key for the given owner.

pub fn wallet(&self) -> &Env::Wallet

Returns a reference to the client’s Wallet.

pub fn extend_chain_mode( &self, chain_id: ChainId, mode: ListeningMode, ) -> ListeningMode

Extends the listening mode for a chain, combining with the existing mode if present. Returns the resulting mode.

pub fn chain_mode(&self, chain_id: ChainId) -> Option<ListeningMode>

Returns the listening mode for a chain, if it is tracked.

pub fn is_tracked(&self, chain_id: ChainId) -> bool

Returns whether a chain is fully tracked by the local node.

pub fn create_chain_client( self: &Arc<Self>, chain_id: ChainId, block_hash: Option<CryptoHash>, next_block_height: BlockHeight, pending_proposal: Option<PendingProposal>, preferred_owner: Option<AccountOwner>, timing_sender: Option<UnboundedSender<(u64, TimingType)>>, ) -> ChainClient<Env>

Creates a new ChainClient.

pub async fn admin_committee( &self, ) -> Result<(Epoch, Committee), LocalNodeError>

Obtains the committee for the latest epoch on the admin chain.

pub async fn get_chain_description_blob( &self, chain_id: ChainId, ) -> Result<Blob, ChainClientError>

Ensures that the client has the ChainDescription blob corresponding to this client’s ChainId, and returns the chain description blob.

pub async fn get_chain_description( &self, chain_id: ChainId, ) -> Result<ChainDescription, ChainClientError>

Ensures that the client has the ChainDescription blob corresponding to this client’s ChainId, and returns the chain description.

pub async fn synchronize_chain_state_from_committee( &self, chain_id: ChainId, committee: Committee, ) -> Result<Box<ChainInfo>, ChainClientError>

Downloads certificates for the given chain from the given committee.

If the chain is not in follow-only mode, also fetches and processes manager values (timeout certificates, proposals, locking blocks) for consensus participation.