Struct TxClient

pub struct TxClient<T, S> { /* private fields */ }

A client for submitting messages and transactions to celestia.

Client handles management of the accounts sequence (nonce), thus it should be the only party submitting transactions signed with given account. Using e.g. two distinct clients with the same account will make them invalidate each others nonces.

Implementations

impl<T, S> TxClient<T, S>

where T: GrpcService<UnsyncBoxBody<Bytes, Status>> + Clone, <T as GrpcService<UnsyncBoxBody<Bytes, Status>>>::Error: Into<Box<dyn Error + Send + Sync>>, <T as GrpcService<UnsyncBoxBody<Bytes, Status>>>::ResponseBody: Body<Data = Bytes> + Send + 'static, <<T as GrpcService<UnsyncBoxBody<Bytes, Status>>>::ResponseBody as Body>::Error: Into<Box<dyn Error + Send + Sync>> + Send, S: DocSigner,

pub async fn new( transport: T, account_address: &Address, account_pubkey: VerifyingKey<Secp256k1>, signer: S, ) -> Result<TxClient<T, S>, Error>

Create a new transaction client.

pub async fn submit_message<M>( &self, message: M, cfg: TxConfig, ) -> Result<TxInfo, Error>

where M: IntoAny,

Submit given message to celestia network.

When no gas price is specified through config, it will automatically handle updating client’s gas price when consensus updates minimal gas price.

Example

use celestia_grpc::{TxClient, TxConfig};
use celestia_proto::cosmos::bank::v1beta1::MsgSend;
use celestia_types::state::{AccAddress, Coin};
use tendermint::crypto::default::ecdsa_secp256k1::SigningKey;

let signing_key = SigningKey::random(&mut rand_core::OsRng);
let public_key = *signing_key.verifying_key();
let address = AccAddress::new(public_key.into()).into();
let grpc_url = "public-celestia-mocha4-consensus.numia.xyz:9090";

let tx_client = TxClient::with_url(grpc_url, &address, public_key, signing_key)
    .await
    .unwrap();

let msg = MsgSend {
    from_address: address.to_string(),
    to_address: "celestia169s50psyj2f4la9a2235329xz7rk6c53zhw9mm".to_string(),
    amount: vec![Coin::utia(12345).into()],
};

tx_client
    .submit_message(msg.clone(), TxConfig::default())
    .await
    .unwrap();

pub async fn submit_blobs( &self, blobs: &[Blob], cfg: TxConfig, ) -> Result<TxInfo, Error>

Submit given blobs to celestia network.

When no gas price is specified through config, it will automatically handle updating client’s gas price when consensus updates minimal gas price.

Example

use celestia_grpc::{TxClient, TxConfig};
use celestia_types::state::{AccAddress, Coin};
use celestia_types::{AppVersion, Blob};
use celestia_types::nmt::Namespace;
use tendermint::crypto::default::ecdsa_secp256k1::SigningKey;

let signing_key = SigningKey::random(&mut rand_core::OsRng);
let public_key = *signing_key.verifying_key();
let address = AccAddress::new(public_key.into()).into();
let grpc_url = "public-celestia-mocha4-consensus.numia.xyz:9090";

let tx_client = TxClient::with_url(grpc_url, &address, public_key, signing_key)
    .await
    .unwrap();

let ns = Namespace::new_v0(b"abcd").unwrap();
let blob = Blob::new(ns, "some data".into(), AppVersion::V3).unwrap();

tx_client
    .submit_blobs(&[blob], TxConfig::default())
    .await
    .unwrap();

pub fn last_seen_gas_price(&self) -> f64

Get most recent minimal gas price seen by the client

pub fn chain_id(&self) -> &Id

Get client’s chain id

pub fn app_version(&self) -> AppVersion

Get client’s app version

impl<S> TxClient<Client, S>

where S: DocSigner,

pub async fn with_grpcweb_url( url: impl Into<String>, account_address: &Address, account_pubkey: VerifyingKey<Secp256k1>, signer: S, ) -> Result<TxClient<Client, S>, Error>

Create a new client connected to the given url with default settings of tonic_web_wasm_client::Client.

Methods from Deref<Target = GrpcClient<T>>

pub async fn get_auth_params(&self) -> Result<Params, Error>

Get auth params

pub async fn get_account(&self, account: &Address) -> Result<Account, Error>

Get account

pub async fn get_accounts(&self) -> Result<Vec<Account>, Error>

Get accounts

pub async fn get_balance( &self, address: &Address, denom: impl Into<String>, ) -> Result<Coin, Error>

Get balance of coins with given denom

pub async fn get_all_balances( &self, address: &Address, ) -> Result<Vec<Coin>, Error>

Get balance of all coins

pub async fn get_spendable_balances( &self, address: &Address, ) -> Result<Vec<Coin>, Error>

Get balance of all spendable coins

pub async fn get_total_supply(&self) -> Result<Vec<Coin>, Error>

Get total supply

pub async fn get_min_gas_price(&self) -> Result<f64, Error>

Get Minimum Gas price

pub async fn get_latest_block(&self) -> Result<Block, Error>

Get latest block

pub async fn get_block_by_height(&self, height: i64) -> Result<Block, Error>

Get block by height

pub async fn broadcast_tx( &self, tx_bytes: Vec<u8>, mode: BroadcastMode, ) -> Result<TxResponse, Error>

Broadcast prepared and serialised transaction

pub async fn get_tx(&self, hash: Hash) -> Result<GetTxResponse, Error>

Get Tx

pub async fn simulate(&self, tx_bytes: Vec<u8>) -> Result<GasInfo, Error>

Broadcast prepared and serialised transaction

pub async fn get_blob_params(&self) -> Result<BlobParams, Error>

Get blob params

pub async fn tx_status(&self, hash: Hash) -> Result<TxStatusResponse, Error>

Get status of the transaction

Trait Implementations

impl<T, S> Debug for TxClient<T, S>

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<T, S> Deref for TxClient<T, S>

type Target = GrpcClient<T>

The resulting type after dereferencing.

fn deref(&self) -> &<TxClient<T, S> as Deref>::Target

Dereferences the value.