Struct gsdk::Api

source ·
pub struct Api {
    pub retry: u16,
    /* private fields */
}
Expand description

Gear api wrapper.

Fields§

§retry: u16

How many times we’ll retry when rpc requests failed.

Implementations§

source§

impl Api

source

pub fn gas_limit(&self) -> Result<u64>

pallet gas constants

Get gas limit.

source

pub fn expected_block_time(&self) -> Result<u64>

pallet babe constant

Get expected block time.

source§

impl Api

source

pub async fn capture_dispatch_info( &self, tx: &TxInBlock<GearConfig, OnlineClient<GearConfig>> ) -> Result<TxEvents<GearConfig>>

Capture the dispatch info of any extrinsic and display the weight spent

source

pub fn capture_weight_info(details: &EventDetails) -> Result<()>

Parse transaction fee from InBlockEvents

source§

impl Api

source

pub async fn calculate_create_gas( &self, origin: H256, code_id: CodeId, payload: Vec<u8>, value: u128, allow_other_panics: bool, at: Option<H256> ) -> Result<GasInfo>

gear_calculateInitCreateGas

source

pub async fn calculate_upload_gas( &self, origin: H256, code: Vec<u8>, payload: Vec<u8>, value: u128, allow_other_panics: bool, at: Option<H256> ) -> Result<GasInfo>

gear_calculateInitUploadGas

source

pub async fn calculate_handle_gas( &self, origin: H256, destination: ProgramId, payload: Vec<u8>, value: u128, allow_other_panics: bool, at: Option<H256> ) -> Result<GasInfo>

gear_calculateHandleGas

source

pub async fn calculate_reply_gas( &self, origin: H256, message_id: MessageId, exit_code: i32, payload: Vec<u8>, value: u128, allow_other_panics: bool, at: Option<H256> ) -> Result<GasInfo>

gear_calculateReplyGas

source

pub async fn read_meta_hash(&self, pid: H256, at: Option<H256>) -> Result<H256>

gear_meta_hash

source

pub async fn read_state(&self, pid: H256, at: Option<H256>) -> Result<String>

gear_readState

source

pub async fn read_state_using_wasm( &self, pid: H256, method: &str, wasm: Vec<u8>, args: Option<Vec<u8>>, at: Option<H256> ) -> Result<String>

gear_readStateUsingWasm

source§

impl Api

source

pub async fn fetch_storage_at<'a, Address, Value>( &self, address: &'a Address, block_hash: impl Into<Option<H256>> ) -> Result<Value>where Address: StorageAddress<IsFetchable = Yes, IsDefaultable = Yes, Target = DecodedValueThunk> + 'a, Value: Decode,

Shortcut for fetching storage at specified block.

source

pub async fn fetch_storage<'a, Address, Value>( &self, address: &'a Address ) -> Result<Value>where Address: StorageAddress<IsFetchable = Yes, IsDefaultable = Yes, Target = DecodedValueThunk> + 'a, Value: Decode,

Shortcut for fetching storage.

source

pub async fn program_pages(&self, pid: ProgramId) -> Result<GearPages>

Get program pages from program id.

source§

impl Api

source

pub async fn info_at( &self, address: &str, block_hash: impl Into<Option<H256>> ) -> Result<AccountInfo<u32, AccountData<u128>>>

Get account info by address at specified block.

source

pub async fn info( &self, address: &str ) -> Result<AccountInfo<u32, AccountData<u128>>>

Get account info by address.

source

pub async fn number(&self) -> Result<u32>

Get block number.

source

pub async fn get_balance(&self, address: &str) -> Result<u128>

Get balance by account address.

source

pub async fn get_events_at( &self, block_hash: impl Into<Option<H256>> ) -> Result<Vec<RuntimeEvent>>

Get events at specified block.

source

pub async fn get_events(&self) -> Result<Vec<RuntimeEvent>>

Get events.

source§

impl Api

source

pub async fn block_timestamp(&self, block_hash: Option<H256>) -> Result<u64>

Return a timestamp of the block.

source§

impl Api

source

pub async fn validators(&self) -> Result<Vec<AccountId32>>

Get all validators from pallet_session.

source§

impl Api

source

pub async fn total_issuance_at( &self, block_hash: impl Into<Option<H256>> ) -> Result<u64>

Get value of gas total issuance at specified block.

source

pub async fn total_issuance(&self) -> Result<u64>

Get value of gas total issuance.

source

pub async fn gas_nodes_at( &self, gas_node_ids: &impl AsRef<[GearGasNodeId]>, block_hash: impl Into<Option<H256>> ) -> Result<Vec<(GearGasNodeId, GearGasNode)>>

Get Gear gas nodes by their ids at specified block.

source

pub async fn gas_nodes( &self, gas_node_ids: &impl AsRef<[GearGasNodeId]> ) -> Result<Vec<(GearGasNodeId, GearGasNode)>>

Get Gear gas nodes by their ids.

source§

impl Api

source

pub async fn execute_inherent(&self) -> Result<bool>

Check whether the message queue processing is stopped or not.

source

pub async fn gear_block_number( &self, block_hash: Option<H256> ) -> Result<BlockNumber>

Get gear block number.

source§

impl Api

source

pub async fn code_storage_at( &self, code_id: CodeId, block_hash: impl Into<Option<H256>> ) -> Result<InstrumentedCode>

Get InstrumentedCode by its CodeId at specified block.

source

pub async fn code_storage(&self, code_id: CodeId) -> Result<InstrumentedCode>

Get InstrumentedCode by its CodeId.

source

pub async fn code_len_storage_at( &self, code_id: CodeId, block_hash: impl Into<Option<H256>> ) -> Result<u32>

Get InstrumentedCode length by its CodeId at specified block.

source

pub async fn code_len_storage(&self, code_id: CodeId) -> Result<u32>

Get InstrumentedCode length by its CodeId.

source

pub async fn gprog_at( &self, program_id: ProgramId, block_hash: impl Into<Option<H256>> ) -> Result<ActiveProgram<BlockNumber>>

Get active program from program id at specified block.

source

pub async fn gprog( &self, program_id: ProgramId ) -> Result<ActiveProgram<BlockNumber>>

Get active program from program id.

source

pub async fn gpages_at( &self, program_id: ProgramId, program: &ActiveProgram<BlockNumber>, block_hash: impl Into<Option<H256>> ) -> Result<GearPages>

Get pages of active program at specified block.

source

pub async fn gpages( &self, program_id: ProgramId, program: &ActiveProgram<BlockNumber> ) -> Result<GearPages>

Get pages of active program.

source§

impl Api

source

pub async fn get_mailbox_account_message( &self, account_id: AccountId32, message_id: impl AsRef<[u8]> ) -> Result<Option<(StoredMessage, Interval<u32>)>>

Get a message identified by message_id from the account_id’s mailbox.

source

pub async fn mailbox( &self, account_id: Option<AccountId32>, count: u32 ) -> Result<Vec<(StoredMessage, Interval<u32>)>>

Get all mailbox messages or from the provided address.

source§

impl Api

source

pub fn cmp_gas_limit(&self, gas: u64) -> Result<u64>

compare gas limit

source

pub fn decode_error(&self, dispatch_error: DispatchError) -> Error

Decode DispatchError to subxt::error::Error.

source§

impl Api

source

pub async fn new(url: Option<&str>) -> Result<Self>

Create new API client.

source

pub async fn new_with_timeout( url: Option<&str>, timeout: Option<u64> ) -> Result<Self>

Create new API client with timeout.

source

pub fn with_retry(self, retry: u16) -> Self

Setup retry times and return the API instance.

source

pub async fn blocks(&self) -> Result<Blocks>

Subscribe all blocks

source

pub async fn finalized_blocks(&self) -> Result<Blocks>

Subscribe finalized blocks

source

pub fn signer(self, suri: &str, passwd: Option<&str>) -> Result<Signer>

New signer from api

Methods from Deref<Target = OnlineClient<GearConfig>>§

pub fn updater(&self) -> ClientRuntimeUpdater<T>

Create an object which can be used to keep the runtime up to date in a separate thread.

Example
use subxt::{ OnlineClient, PolkadotConfig };

let client = OnlineClient::<PolkadotConfig>::new().await.unwrap();

// high level API.

let update_task = client.updater();
tokio::spawn(async move {
    update_task.perform_runtime_updates().await;
});


// low level API.

let updater = client.updater();
tokio::spawn(async move {
    let mut update_stream = updater.runtime_updates().await.unwrap();

    while let Some(Ok(update)) = update_stream.next().await {
        let version = update.runtime_version().spec_version;

        match updater.apply_update(update) {
            Ok(()) => {
                println!("Upgrade to version: {} successful", version)
            }
            Err(e) => {
               println!("Upgrade to version {} failed {:?}", version, e);
            }
       };
    }
});

pub fn metadata(&self) -> Metadata

Return the [Metadata] used in this client.

pub fn set_metadata(&self, metadata: Metadata)

Change the [Metadata] used in this client.

Warning

Setting custom metadata may leave Subxt unable to work with certain blocks, subscribe to latest blocks or submit valid transactions.

pub fn genesis_hash(&self) -> <T as Config>::Hash

Return the genesis hash.

pub fn set_genesis_hash(&self, genesis_hash: <T as Config>::Hash)

Change the genesis hash used in this client.

Warning

Setting a custom genesis hash may leave Subxt unable to submit valid transactions.

pub fn runtime_version(&self) -> RuntimeVersion

Return the runtime version.

pub fn set_runtime_version(&self, runtime_version: RuntimeVersion)

Change the [RuntimeVersion] used in this client.

Warning

Setting a custom runtime version may leave Subxt unable to submit valid transactions.

pub fn rpc(&self) -> &Rpc<T>

Return an RPC client to make raw requests with.

pub fn offline(&self) -> OfflineClient<T>

Return an offline client with the same configuration as this.

pub fn tx(&self) -> TxClient<T, OnlineClient<T>>

Work with transactions.

pub fn events(&self) -> EventsClient<T, OnlineClient<T>>

Work with events.

pub fn storage(&self) -> StorageClient<T, OnlineClient<T>>

Work with storage.

pub fn constants(&self) -> ConstantsClient<T, OnlineClient<T>>

Access constants.

pub fn blocks(&self) -> BlocksClient<T, OnlineClient<T>>

Work with blocks.

pub fn runtime_api(&self) -> RuntimeApiClient<T, OnlineClient<T>>

Work with runtime API.

Trait Implementations§

source§

impl Clone for Api

source§

fn clone(&self) -> Api

Returns a copy 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 Deref for Api

§

type Target = OnlineClient<GearConfig>

The resulting type after dereferencing.
source§

fn deref(&self) -> &Self::Target

Dereferences the value.
source§

impl DerefMut for Api

source§

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

Auto Trait Implementations§

§

impl !RefUnwindSafe for Api

§

impl Send for Api

§

impl Sync for Api

§

impl Unpin for Api

§

impl !UnwindSafe for Api

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
§

impl<T> CheckedConversion for T

§

fn checked_from<T>(t: T) -> Option<Self>where Self: TryFrom<T>,

Convert from a value of T into an equivalent instance of Option<Self>. Read more
§

fn checked_into<T>(self) -> Option<T>where Self: TryInto<T>,

Consume self to return Some equivalent value of Option<T>. Read more
§

impl<T> Conv for T

§

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

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

impl<T> Downcast for Twhere T: Any,

§

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSync for Twhere T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send + 'static>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
source§

impl<T> DynClone for Twhere T: Clone,

source§

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

§

impl<T> FmtForward for T

§

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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 Twhere 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.

§

impl<T, Outer> IsWrappedBy<Outer> for Twhere Outer: AsRef<T> + AsMut<T> + From<T>, T: From<Outer>,

§

fn from_ref(outer: &Outer) -> &T

Get a reference to the inner from the outer.

§

fn from_mut(outer: &mut Outer) -> &mut T

Get a mutable reference to the inner from the outer.

§

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

§

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R ) -> Rwhere 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<T> for T

§

type Output = T

Should always be Self
§

impl<T> SaturatedConversion for T

§

fn saturated_from<T>(t: T) -> Selfwhere Self: UniqueSaturatedFrom<T>,

Convert from a value of T into an equivalent instance of Self. Read more
§

fn saturated_into<T>(self) -> Twhere Self: UniqueSaturatedInto<T>,

Consume self to return an equivalent value of T. Read more
§

impl<T> Tap for T

§

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

Immutable access to a value. Read more
§

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

Mutable access to a value. Read more
§

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere 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 Twhere T: Clone,

§

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
§

impl<T> TryConv for T

§

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 Twhere U: Into<T>,

§

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 Twhere U: TryFrom<T>,

§

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.
§

impl<S, T> UncheckedInto<T> for Swhere T: UncheckedFrom<S>,

§

fn unchecked_into(self) -> T

The counterpart to unchecked_from.
§

impl<T, S> UniqueSaturatedInto<T> for Swhere T: Bounded, S: TryInto<T>,

§

fn unique_saturated_into(self) -> T

Consume self to return an equivalent value of T.
§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V

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
§

impl<T> JsonSchemaMaybe for T

§

impl<T> MaybeSend for Twhere T: Send,