Struct Client

pub struct Client<Env: Environment> { /* private fields */ }

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

Implementations

impl<Env: Environment> Client<Env>

pub fn new( environment: Env, admin_id: ChainId, long_lived_services: bool, tracked_chains: impl IntoIterator<Item = ChainId>, name: impl Into<String>, max_loaded_chains: NonZeroUsize, options: ChainClientOptions, ) -> Self

Creates a new Client with a new cache and notifiers.

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 local_node(&self) -> &LocalNodeClient<Env::Storage>

Returns a reference to the LocalNodeClient of the client.

pub fn signer(&self) -> &impl Signer

Returns a reference to the Signer of the client.

pub fn track_chain(&self, chain_id: ChainId)

Adds a chain to the set of chains 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>, ) -> 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 ensure_has_chain_description( &self, chain_id: ChainId, ) -> Result<Blob, ChainClientError>

Ensures that the client has the ChainDescription blob corresponding to this client’s ChainId.

pub async fn preprocess_certificate( &self, certificate: Box<ConfirmedBlockCertificate>, ) -> Result<(), LocalNodeError>