GrpcClient

Struct GrpcClient 

Source
pub struct GrpcClient { /* private fields */ }
Expand description

gRPC client for the Celestia network

Under the hood, this struct wraps tonic and does type conversion

Implementations§

Source§

impl GrpcClient

Source

pub fn builder() -> GrpcClientBuilder

Create a builder for GrpcClient connected to url

Source

pub fn get_auth_params(&self) -> AsyncGrpcCall<AuthParams>

Get auth params

Source

pub fn get_account(&self, account: &AccAddress) -> AsyncGrpcCall<Account>

Get account

Source

pub fn get_accounts(&self) -> AsyncGrpcCall<Vec<Account>>

Get accounts

Source

pub fn get_verified_balance( &self, address: &Address, header: &ExtendedHeader, ) -> AsyncGrpcCall<Coin>

Retrieves the verified Celestia coin balance for the address.

§Notes

This returns the verified balance which is the one that was reported by the previous network block. In other words, if you transfer some coins, you need to wait 1 more block in order to see the new balance. If you want something more immediate then use GrpcClient::get_balance.

Source

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

Retrieves the Celestia coin balance for the given address.

Source

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

Get balance of all coins

Source

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

Get balance of all spendable coins

Source

pub fn get_total_supply(&self) -> AsyncGrpcCall<Vec<Coin>>

Get total supply

Source

pub fn get_node_config(&self) -> AsyncGrpcCall<ConfigResponse>

Get node configuration

Source

pub fn get_latest_block(&self) -> AsyncGrpcCall<Block>

Get latest block

Source

pub fn get_block_by_height(&self, height: i64) -> AsyncGrpcCall<Block>

Get block by height

Source

pub fn abci_query( &self, data: impl AsRef<[u8]>, path: impl Into<String>, height: u64, prove: bool, ) -> AsyncGrpcCall<AbciQueryResponse>

Issue a direct ABCI query to the application

Source

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

Broadcast prepared and serialised transaction

Source

pub fn get_tx(&self, hash: Hash) -> AsyncGrpcCall<GetTxResponse>

Get Tx

Source

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

Broadcast prepared and serialised transaction

Source

pub fn query_delegation( &self, delegator_address: &AccAddress, validator_address: &ValAddress, ) -> AsyncGrpcCall<QueryDelegationResponse>

Retrieves the delegation information between a delegator and a validator

Source

pub fn query_unbonding( &self, delegator_address: &AccAddress, validator_address: &ValAddress, ) -> AsyncGrpcCall<QueryUnbondingDelegationResponse>

Retrieves the unbonding status between a delegator and a validator

Source

pub fn query_redelegations( &self, delegator_address: &AccAddress, src_validator_address: &ValAddress, dest_validator_address: &ValAddress, pagination: Option<PageRequest>, ) -> AsyncGrpcCall<QueryRedelegationsResponse>

Retrieves the status of the redelegations between a delegator and a validator

Source

pub fn get_blob_params(&self) -> AsyncGrpcCall<BlobParams>

Get blob params

Source

pub fn tx_status(&self, hash: Hash) -> AsyncGrpcCall<TxStatusResponse>

Get status of the transaction

Source

pub fn estimate_gas_price(&self, priority: TxPriority) -> AsyncGrpcCall<f64>

Estimate gas price for given transaction priority based on the gas prices of the transactions in the last five blocks.

If no transaction is found in the last five blocks, return the network min gas price.

Source

pub fn estimate_gas_price_and_usage( &self, priority: TxPriority, tx_bytes: Vec<u8>, ) -> AsyncGrpcCall<GasEstimate>

Estimate gas price for transaction with given priority and estimate gas usage for the provided serialised transaction.

The gas price estimation is based on the gas prices of the transactions in the last five blocks. If no transaction is found in the last five blocks, return the network min gas price.

The gas used is estimated using the state machine simulation.

Source

pub fn submit_message<M>( &self, message: M, cfg: TxConfig, ) -> AsyncGrpcCall<TxInfo>
where M: IntoProtobufAny + Send + 'static,

Submit given message to celestia network.

§Example
use celestia_grpc::{GrpcClient, TxConfig};
use celestia_proto::cosmos::bank::v1beta1::MsgSend;
use celestia_types::state::{Address, Coin};
use tendermint::crypto::default::ecdsa_secp256k1::SigningKey;

let signing_key = SigningKey::random(&mut rand::rngs::OsRng);
let address = Address::from_account_verifying_key(*signing_key.verifying_key());
let grpc_url = "public-celestia-mocha4-consensus.numia.xyz:9090";

let tx_client = GrpcClient::builder()
    .url(grpc_url)
    .signer_keypair(signing_key)
    .build()
    .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();
Source

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

Submit given blobs to celestia network.

§Example
use celestia_grpc::{GrpcClient, TxConfig};
use celestia_types::state::{Address, 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::rngs::OsRng);
let address = Address::from_account_verifying_key(*signing_key.verifying_key());
let grpc_url = "public-celestia-mocha4-consensus.numia.xyz:9090";

let tx_client = GrpcClient::builder()
    .url(grpc_url)
    .signer_keypair(signing_key)
    .build()
    .unwrap();

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

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

pub fn app_version(&self) -> AsyncGrpcCall<AppVersion>

Get client’s app version

Source

pub fn chain_id(&self) -> AsyncGrpcCall<Id>

Get client’s chain id

Source

pub fn get_account_pubkey(&self) -> Option<VerifyingKey>

Get client’s account public key if the signer is set

Source

pub fn get_account_address(&self) -> Option<AccAddress>

Get client’s account address if the signer is set

Trait Implementations§

Source§

impl Clone for GrpcClient

Source§

fn clone(&self) -> GrpcClient

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for GrpcClient

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> FmtForward for T

Source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
Source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
Source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
Source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
Source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
Source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
Source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
Source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
Source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

impl<T> Pipe for T
where T: ?Sized,

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<S> CondSend for S
where S: Send,

Source§

impl<S> CondSync for S
where S: Send + Sync,