Struct Client

pub struct Client { /* private fields */ }

Client that implements exponential retrying and caching of access key nonces.

Implementations

impl Client

pub fn call<'a>( &self, signer: &'a dyn SignerExt, contract_id: &AccountId, function: &str, ) -> FunctionCallTransaction<'a>

Start calling into a contract on a specific function. Returns a FunctionCallTransaction object where we can use to add more parameters such as the arguments, deposit, and gas.

pub fn batch<'a>( &self, signer: &'a dyn SignerExt, receiver_id: &AccountId, ) -> Transaction<'a>

Start a batch transaction. Returns a Transaction object that we can use to add Actions to the batched transaction. Call transact to send the batched transaction to the network.

impl Client

pub fn view( &self, contract_id: &AccountId, function: &str, ) -> Query<'_, ViewFunction>

Call into a contract’s view function. Returns a Query which allows us to specify further details like the arguments of the view call, or at what point in the chain we want to view.

pub fn view_code(&self, contract_id: &AccountId) -> Query<'_, ViewCode>

View the WASM code bytes of a contract on the network.

pub fn view_state(&self, contract_id: &AccountId) -> Query<'_, ViewState>

View the state of a account/contract on the network. This will return the internal state of the account in the form of a map of key-value pairs; where STATE contains info on a contract’s internal data.

pub fn view_block(&self) -> Query<'_, ViewBlock>

View the block from the network. Supply additional parameters such as block_height or block_hash to get the block.

pub fn view_chunk(&self) -> QueryChunk<'_>

View the chunk from the network once awaited. Supply additional parameters such as block_hash_and_shard, block_height_and_shard or chunk_hash to get the chunk at a specific reference point. If none of those are supplied, the default reference point will be used, which will be the latest block_hash with a shard_id of 0.

pub fn view_access_key( &self, id: &AccountId, pk: &PublicKey, ) -> Query<'_, ViewAccessKey>

Views the AccessKey of the account specified by AccountId associated with the PublicKey

pub fn view_access_keys(&self, id: &AccountId) -> Query<'_, ViewAccessKeyList>

Views all the AccessKeys of the account specified by AccountId. This will return a list of AccessKeys along with the associated PublicKey.

pub fn view_account(&self, account_id: &AccountId) -> Query<'_, ViewAccount>

View account details of a specific account on the network.

pub fn gas_price(&self) -> Query<'_, GasPrice>

Fetches the latest gas price on the network.

impl Client

pub fn new(rpc_addr: &str) -> Self

Construct a new Client with the given RPC address.

pub fn from_client(client: JsonRpcClient) -> Self

Construct a Client from an existing JsonRpcClient.

pub fn inner(&self) -> &JsonRpcClient

Internal reference to the JsonRpcClient that is utilized for all RPC calls.

pub fn inner_mut(&mut self) -> &mut JsonRpcClient

Internal mutable reference to the JsonRpcClient that is utilized for all RPC calls.

pub fn rpc_addr(&self) -> String

The RPC address the client is connected to.

pub fn send_tx<'a>( &self, signer: &'a dyn SignerExt, receiver_id: &AccountId, actions: Vec<Action>, ) -> RetryableTransaction<'a>

Send a series of Actions as a SignedTransaction to the network. This gives us a transaction is that retryable. To retry, simply add in a .retry_* method call to the end of the chain before an .await gets invoked.

pub async fn send_tx_async( &self, signer: &dyn SignerExt, receiver_id: &AccountId, actions: Vec<Action>, ) -> Result<CryptoHash>

Send a series of Actions as a SignedTransaction to the network. This is an async operation, where a hash is returned to reference the transaction in the future and check its status.

pub async fn fetch_nonce( &self, account_id: &AccountId, public_key: &PublicKey, ) -> Result<(Nonce, CryptoHash, BlockHeight)>

Fetches the nonce associated to the account id and public key, which essentially is the access key for the given account ID and public key. Utilize caching underneath to prevent querying for the same access key multiple times.

pub async fn access_key( &self, account_id: &AccountId, public_key: &PublicKey, ) -> Result<(AccessKeyView, CryptoHash, BlockHeight)>

Fetches the access key for the given account ID and public key.

pub async fn check_and_invalidate_cache( &self, cache_key: &CacheKey, result: &Result<RpcTransactionResponse, JsonRpcError<RpcTransactionError>>, )

pub async fn invalidate_cache(&self, cache_key: &CacheKey)

pub async fn status_tx_async( &self, sender_id: &AccountId, tx_hash: CryptoHash, wait_until: TxExecutionStatus, ) -> Result<FinalExecutionOutcomeView, Error>

Fetches the status of a transaction given the transaction hash.

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 From<Client> for JsonRpcClient

fn from(client: Client) -> Self

Converts to this type from the input type.