Struct substrate_api_client::Api

pub struct Api<P> where
    P: Pair,
    MultiSignature: From<P::Signature>,  {
    pub url: String,
    pub signer: Option<P>,
    pub genesis_hash: Hash,
    pub metadata: Metadata,
    pub runtime_version: RuntimeVersion,
}

Fields

url: String

signer: Option<P>

genesis_hash: Hash

metadata: Metadata

runtime_version: RuntimeVersion

Implementations

impl<P> Api<P> where
    P: Pair,
    MultiSignature: From<P::Signature>, 

pub fn new(url: String) -> Result<Self, ApiClientError>

pub fn set_signer(self, signer: P) -> Self

pub fn signer_account(&self) -> Option<AccountId32>

pub fn get_metadata(&self) -> Result<RuntimeMetadataPrefixed, ApiClientError>

pub fn get_spec_version(&self) -> Result<u32, ApiClientError>

pub fn get_genesis_hash(&self) -> Result<Hash, ApiClientError>

pub fn get_nonce(&self) -> Result<u32, ApiClientError>

pub fn get_account_info(
    &self,
    address: &AccountId
) -> Result<Option<AccountInfo>, ApiClientError>

pub fn get_account_data(
    &self,
    address: &AccountId
) -> Result<Option<AccountData>, ApiClientError>

pub fn get_finalized_head(&self) -> Result<Option<Hash>, ApiClientError>

pub fn get_header<H>(
    &self,
    hash: Option<Hash>
) -> Result<Option<H>, ApiClientError> where
    H: Header + DeserializeOwned, 

pub fn get_block<B>(
    &self,
    hash: Option<Hash>
) -> Result<Option<B>, ApiClientError> where
    B: Block + DeserializeOwned, 

pub fn get_signed_block<B>(
    &self,
    hash: Option<Hash>
) -> Result<Option<SignedBlock<B>>, ApiClientError> where
    B: Block + DeserializeOwned, 

A signed block is a block with Justification ,i.e., a Grandpa finality proof. The interval at which finality proofs are provided is set via the the GrandpaConfig.justification_period in a node’s service.rs. The Justification may be none.

pub fn get_request(
    &self,
    jsonreq: String
) -> Result<Option<String>, ApiClientError>

pub fn get_storage_value(
    &self,
    storage_prefix: &str,
    storage_key_name: &str,
    at_block: Option<Hash>
) -> Result<Option<StorageValue>, ApiClientError>

pub fn get_storage_map(
    &self,
    storage_prefix: &str,
    storage_key_name: &str,
    map_key: Vec<u8>,
    at_block: Option<Hash>
) -> Result<Option<StorageValue>, ApiClientError>

pub fn get_storage_map_key_prefix(
    &self,
    storage_prefix: &str,
    storage_key_name: &str
) -> Result<StorageKey, ApiClientError>

pub fn get_storage_double_map(
    &self,
    storage_prefix: &str,
    storage_key_name: &str,
    first: Vec<u8>,
    second: Vec<u8>,
    at_block: Option<Hash>
) -> Result<Option<StorageValue>, ApiClientError>

pub fn get_storage_by_key_hash(
    &self,
    key: StorageKey,
    at_block: Option<Hash>
) -> Result<Option<StorageValue>, ApiClientError>

pub fn get_opaque_storage_by_key_hash(
    &self,
    key: StorageKey,
    at_block: Option<Hash>
) -> Result<Option<Vec<u8>>, ApiClientError>

pub fn get_storage_value_proof(
    &self,
    storage_prefix: &str,
    storage_key_name: &str,
    at_block: Option<Hash>
) -> Result<Option<ReadProof<Hash>>, ApiClientError>

pub fn get_storage_map_proof(
    &self,
    storage_prefix: &str,
    storage_key_name: &str,
    map_key: Vec<u8>,
    at_block: Option<Hash>
) -> Result<Option<ReadProof<Hash>>, ApiClientError>

pub fn get_storage_double_map_proof(
    &self,
    storage_prefix: &str,
    storage_key_name: &str,
    first: Vec<u8>,
    second: Vec<u8>,
    at_block: Option<Hash>
) -> Result<Option<ReadProof<Hash>>, ApiClientError>

pub fn get_storage_proof_by_keys(
    &self,
    keys: Vec<StorageKey>,
    at_block: Option<Hash>
) -> Result<Option<ReadProof<Hash>>, ApiClientError>

pub fn get_keys(
    &self,
    key: StorageKey,
    at_block: Option<Hash>
) -> Result<Option<Vec<String>>, ApiClientError>

pub fn send_extrinsic(
    &self,
    xthex_prefixed: String,
    exit_on: XtStatus
) -> Result<Option<Hash>, ApiClientError>

pub fn subscribe_events(
    &self,
    sender: ThreadOut<String>
) -> Result<(), ApiClientError>

pub fn subscribe_finalized_heads(
    &self,
    sender: ThreadOut<String>
) -> Result<(), ApiClientError>

pub fn wait_for_event<E: Decode>(
    &self,
    module: &str,
    variant: &str,
    decoder: Option<EventsDecoder>,
    receiver: &Receiver<String>
) -> Result<E, ApiClientError>

pub fn wait_for_raw_event(
    &self,
    module: &str,
    variant: &str,
    decoder: Option<EventsDecoder>,
    receiver: &Receiver<String>
) -> Result<RawEvent, ApiClientError>

Trait Implementations

impl<P: Clone> Clone for Api<P> where
    P: Pair,
    MultiSignature: From<P::Signature>, 

fn clone(&self) -> Api<P>

Returns a copy of the value.

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

Performs copy-assignment from source.