Struct sc_client::Client

pub struct Client<B, E, Block, RA> where
    Block: BlockT,  { /* fields omitted */ }

Substrate Client

Methods

impl<B, E, Block, RA> Client<B, E, Block, RA> where
    B: Backend<Block>,
    E: CallExecutor<Block>,
    Block: BlockT, 

pub fn new<S: BuildStorage>(
    backend: Arc<B>,
    executor: E,
    build_genesis_storage: &S,
    fork_blocks: ForkBlocks<Block>,
    bad_blocks: BadBlocks<Block>,
    execution_extensions: ExecutionExtensions<Block>
) -> Result<Self>

Creates new Substrate Client with given blockchain and code executor.

pub fn execution_extensions(&self) -> &ExecutionExtensions<Block>

Get a reference to the execution extensions.

pub fn state_at(&self, block: &BlockId<Block>) -> Result<B::State>

Get a reference to the state at a given block.

pub fn storage_keys(
    &self,
    id: &BlockId<Block>,
    key_prefix: &StorageKey
) -> Result<Vec<StorageKey>>

Given a BlockId and a key prefix, return the matching storage keys in that block.

pub fn storage_pairs(
    &self,
    id: &BlockId<Block>,
    key_prefix: &StorageKey
) -> Result<Vec<(StorageKey, StorageData)>>

Given a BlockId and a key prefix, return the matching child storage keys and values in that block.

pub fn storage_keys_iter<'a>(
    &self,
    id: &BlockId<Block>,
    prefix: Option<&'a StorageKey>,
    start_key: Option<&StorageKey>
) -> Result<KeyIterator<'a, B::State, Block>>

Given a BlockId and a key prefix, return a KeyIterator iterates matching storage keys in that block.

pub fn storage(
    &self,
    id: &BlockId<Block>,
    key: &StorageKey
) -> Result<Option<StorageData>>

Given a BlockId and a key, return the value under the key in that block.

pub fn storage_hash(
    &self,
    id: &BlockId<Block>,
    key: &StorageKey
) -> Result<Option<Block::Hash>>

Given a BlockId and a key, return the value under the hash in that block.

pub fn child_storage_keys(
    &self,
    id: &BlockId<Block>,
    child_storage_key: &StorageKey,
    child_info: ChildInfo,
    key_prefix: &StorageKey
) -> Result<Vec<StorageKey>>

Given a BlockId, a key prefix, and a child storage key, return the matching child storage keys.

pub fn child_storage(
    &self,
    id: &BlockId<Block>,
    storage_key: &StorageKey,
    child_info: ChildInfo,
    key: &StorageKey
) -> Result<Option<StorageData>>

Given a BlockId, a key and a child storage key, return the value under the key in that block.

pub fn child_storage_hash(
    &self,
    id: &BlockId<Block>,
    storage_key: &StorageKey,
    child_info: ChildInfo,
    key: &StorageKey
) -> Result<Option<Block::Hash>>

Given a BlockId, a key and a child storage key, return the hash under the key in that block.

pub fn code_at(&self, id: &BlockId<Block>) -> Result<Vec<u8>>

Get the code at a given block.

pub fn runtime_version_at(&self, id: &BlockId<Block>) -> Result<RuntimeVersion>

Get the RuntimeVersion at a given block.

pub fn executor(&self) -> &E

Get call executor reference.

pub fn read_proof<I>(
    &self,
    id: &BlockId<Block>,
    keys: I
) -> Result<StorageProof> where
    I: IntoIterator,
    I::Item: AsRef<[u8]>, 

Reads storage value at a given block + key, returning read proof.

pub fn read_child_proof<I>(
    &self,
    id: &BlockId<Block>,
    storage_key: &[u8],
    child_info: ChildInfo,
    keys: I
) -> Result<StorageProof> where
    I: IntoIterator,
    I::Item: AsRef<[u8]>, 

Reads child storage value at a given block + storage_key + key, returning read proof.

pub fn execution_proof(
    &self,
    id: &BlockId<Block>,
    method: &str,
    call_data: &[u8]
) -> Result<(Vec<u8>, StorageProof)>

Execute a call to a contract on top of state in a block of given hash AND returning execution proof.

No changes are made.

pub fn header_proof(
    &self,
    id: &BlockId<Block>
) -> Result<(Block::Header, StorageProof)>

Reads given header and generates CHT-based header proof.

pub fn block_hash(
    &self,
    block_number: <<Block as BlockT>::Header as HeaderT>::Number
) -> Result<Option<Block::Hash>>

Get block hash by number.

pub fn header_proof_with_cht_size(
    &self,
    id: &BlockId<Block>,
    cht_size: NumberFor<Block>
) -> Result<(Block::Header, StorageProof)>

Reads given header and generates CHT-based header proof for CHT of given size.

pub fn max_key_changes_range(
    &self,
    first: NumberFor<Block>,
    last: BlockId<Block>
) -> Result<Option<(NumberFor<Block>, BlockId<Block>)>>

Get longest range within [first; last] that is possible to use in key_changes and key_changes_proof calls. Range could be shortened from the beginning if some changes tries have been pruned. Returns Ok(None) if changes tries are not supported.

pub fn key_changes(
    &self,
    first: NumberFor<Block>,
    last: BlockId<Block>,
    storage_key: Option<&StorageKey>,
    key: &StorageKey
) -> Result<Vec<(NumberFor<Block>, u32)>>

Get pairs of (block, extrinsic) where key has been changed at given blocks range. Works only for runtimes that are supporting changes tries.

Changes are returned in descending order (i.e. last block comes first).

pub fn key_changes_proof(
    &self,
    first: Block::Hash,
    last: Block::Hash,
    min: Block::Hash,
    max: Block::Hash,
    storage_key: Option<&StorageKey>,
    key: &StorageKey
) -> Result<ChangesProof<Block::Header>>

Get proof for computation of (block, extrinsic) pairs where key has been changed at given blocks range. min is the hash of the first block, which changes trie root is known to the requester - when we're using changes tries from ascendants of this block, we should provide proofs for changes tries roots max is the hash of the last block known to the requester - we can't use changes tries from descendants of this block. Works only for runtimes that are supporting changes tries.

pub fn key_changes_proof_with_cht_size(
    &self,
    first: Block::Hash,
    last: Block::Hash,
    min: Block::Hash,
    max: Block::Hash,
    storage_key: Option<&StorageKey>,
    key: &StorageKey,
    cht_size: NumberFor<Block>
) -> Result<ChangesProof<Block::Header>>

Does the same work as key_changes_proof, but assumes that CHTs are of passed size.

pub fn new_block(
    &self,
    inherent_digests: DigestFor<Block>
) -> Result<BlockBuilder<Block, Self, B>> where
    E: Clone + Send + Sync,
    RA: Send + Sync,
    Self: ProvideRuntimeApi<Block>,
    Self::Api: BlockBuilderApi<Block, Error = Error> + ApiExt<Block, StateBackend = StateBackendFor<B, Block>>, 

Create a new block, built on the head of the chain.

pub fn new_block_at<R: Into<RecordProof>>(
    &self,
    parent: &BlockId<Block>,
    inherent_digests: DigestFor<Block>,
    record_proof: R
) -> Result<BlockBuilder<Block, Self, B>> where
    E: Clone + Send + Sync,
    RA: Send + Sync,
    Self: ProvideRuntimeApi<Block>,
    Self::Api: BlockBuilderApi<Block, Error = Error> + ApiExt<Block, StateBackend = StateBackendFor<B, Block>>, 

Create a new block, built on top of parent.

When proof recording is enabled, all accessed trie nodes are saved. These recorded trie nodes can be used by a third party to proof the output of this block builder without having access to the full storage.

pub fn lock_import_and_run<R, Err, F>(&self, f: F) -> Result<R, Err> where
    F: FnOnce(&mut ClientImportOperation<Block, B>) -> Result<R, Err>,
    Err: From<Error>, 

Lock the import lock, and run operations inside.

pub fn revert(&self, n: NumberFor<Block>) -> Result<NumberFor<Block>>

Attempts to revert the chain by n blocks guaranteeing that no block is reverted past the last finalized block. Returns the number of blocks that were successfully reverted.

pub fn unsafe_revert(&self, n: NumberFor<Block>) -> Result<NumberFor<Block>>

Attempts to revert the chain by n blocks disregarding finality. This method will revert any finalized blocks as requested and can potentially leave the node in an inconsistent state. Other modules in the system that persist data and that rely on finality (e.g. consensus parts) will be unaffected by the revert. Use this method with caution and making sure that no other data needs to be reverted for consistency aside from the block data.

Returns the number of blocks that were successfully reverted.

pub fn usage_info(&self) -> ClientInfo<Block>

Get usage info about current client.

pub fn chain_info(&self) -> Info<Block>

Get blockchain info.

pub fn block_status(&self, id: &BlockId<Block>) -> Result<BlockStatus>

Get block status.

pub fn header(
    &self,
    id: &BlockId<Block>
) -> Result<Option<<Block as BlockT>::Header>>

Get block header by id.

pub fn body(
    &self,
    id: &BlockId<Block>
) -> Result<Option<Vec<<Block as BlockT>::Extrinsic>>>

Get block body by id.

pub fn justification(
    &self,
    id: &BlockId<Block>
) -> Result<Option<Justification>>

Get block justification set by id.

pub fn block(&self, id: &BlockId<Block>) -> Result<Option<SignedBlock<Block>>>

Get full block by id.

pub fn uncles(
    &self,
    target_hash: Block::Hash,
    max_generation: NumberFor<Block>
) -> Result<Vec<Block::Hash>>

Gets the uncles of the block with target_hash going back max_generation ancestors.

Trait Implementations

impl<B, E, Block, RA> AuxStore for Client<B, E, Block, RA> where
    B: Backend<Block>,
    E: CallExecutor<Block>,
    Block: BlockT,
    Self: ProvideRuntimeApi<Block>,
    Self::Api: CoreApi<Block, Error = Error>, 

fn insert_aux<'a, 'b: 'a, 'c: 'a, I: IntoIterator<Item = &'a (&'c [u8], &'c [u8])>, D: IntoIterator<Item = &'a &'b [u8]>>(
    &self,
    insert: I,
    delete: D
) -> Result<()>

Insert auxiliary data into key-value store.

fn get_aux(&self, key: &[u8]) -> Result<Option<Vec<u8>>>

Query auxiliary data from key-value store.

impl<'_, B, E, Block, RA> AuxStore for &'_ Client<B, E, Block, RA> where
    B: Backend<Block>,
    E: CallExecutor<Block>,
    Block: BlockT,
    Client<B, E, Block, RA>: ProvideRuntimeApi<Block>,
    <Client<B, E, Block, RA> as ProvideRuntimeApi<Block>>::Api: CoreApi<Block, Error = Error>, 

fn insert_aux<'a, 'b: 'a, 'c: 'a, I: IntoIterator<Item = &'a (&'c [u8], &'c [u8])>, D: IntoIterator<Item = &'a &'b [u8]>>(
    &self,
    insert: I,
    delete: D
) -> Result<()>

Insert auxiliary data into key-value store.

fn get_aux(&self, key: &[u8]) -> Result<Option<Vec<u8>>>

Query auxiliary data from key-value store.

impl<B, E, Block, RA> BlockBody<Block> for Client<B, E, Block, RA> where
    B: Backend<Block>,
    E: CallExecutor<Block>,
    Block: BlockT, 

fn block_body(
    &self,
    id: &BlockId<Block>
) -> Result<Option<Vec<<Block as BlockT>::Extrinsic>>>

Get block body by ID. Returns None if the body is not stored.

impl<B, E, Block, RA> BlockIdTo<Block> for Client<B, E, Block, RA> where
    B: Backend<Block>,
    E: CallExecutor<Block> + Send + Sync,
    Block: BlockT,
    RA: Send + Sync, 

type Error = Error

The error type that will be returned by the functions.

fn to_hash(&self, block_id: &BlockId<Block>) -> Result<Option<Block::Hash>>

Convert the given block_id to the corresponding block hash.

fn to_number(
    &self,
    block_id: &BlockId<Block>
) -> Result<Option<NumberFor<Block>>>

Convert the given block_id to the corresponding block number.

impl<'_, B, E, Block, RA> BlockImport<Block> for &'_ Client<B, E, Block, RA> where
    B: Backend<Block>,
    E: CallExecutor<Block> + Send + Sync,
    Block: BlockT,
    Client<B, E, Block, RA>: ProvideRuntimeApi<Block>,
    <Client<B, E, Block, RA> as ProvideRuntimeApi<Block>>::Api: CoreApi<Block, Error = Error> + ApiExt<Block, StateBackend = B::State>, 

NOTE: only use this implementation when you are sure there are NO consensus-level BlockImport objects. Otherwise, importing blocks directly into the client would be bypassing important verification work.

type Error = ConsensusError

The error type.

type Transaction = TransactionFor<B, Block>

The transaction type used by the backend.

fn import_block(
    &mut self,
    import_block: BlockImportParams<Block, TransactionFor<B, Block>>,
    new_cache: HashMap<CacheKeyId, Vec<u8>>
) -> Result<ImportResult, Self::Error>

Import a checked and validated block. If a justification is provided in BlockImportParams then finalized must be true.

NOTE: only use this implementation when there are NO consensus-level BlockImport objects. Otherwise, importing blocks directly into the client would be bypassing important verification work.

If you are not sure that there are no BlockImport objects provided by the consensus algorithm, don't use this function.

fn check_block(
    &mut self,
    block: BlockCheckParams<Block>
) -> Result<ImportResult, Self::Error>

Check block preconditions.

impl<B, E, Block, RA> BlockImport<Block> for Client<B, E, Block, RA> where
    B: Backend<Block>,
    E: CallExecutor<Block> + Send + Sync,
    Block: BlockT,
    Self: ProvideRuntimeApi<Block>,
    Self::Api: CoreApi<Block, Error = Error> + ApiExt<Block, StateBackend = B::State>, 

type Error = ConsensusError

The error type.

type Transaction = TransactionFor<B, Block>

The transaction type used by the backend.

fn import_block(
    &mut self,
    import_block: BlockImportParams<Block, Self::Transaction>,
    new_cache: HashMap<CacheKeyId, Vec<u8>>
) -> Result<ImportResult, Self::Error>

Import a block.

fn check_block(
    &mut self,
    block: BlockCheckParams<Block>
) -> Result<ImportResult, Self::Error>

Check block preconditions.

impl<B, E, Block, RA> BlockOf for Client<B, E, Block, RA> where
    B: Backend<Block>,
    E: CallExecutor<Block>,
    Block: BlockT, 

type Type = Block

The type of the block.

impl<B, E, Block, RA> BlockchainEvents<Block> for Client<B, E, Block, RA> where
    E: CallExecutor<Block>,
    Block: BlockT, 

fn import_notification_stream(&self) -> ImportNotifications<Block>

Get block import event stream.

fn finality_notification_stream(&self) -> FinalityNotifications<Block>

Get a stream of finality notifications. Not guaranteed to be fired for every finalized block.

fn storage_changes_notification_stream(
    &self,
    filter_keys: Option<&[StorageKey]>,
    child_filter_keys: Option<&[(StorageKey, Option<Vec<StorageKey>>)]>
) -> Result<StorageEventStream<Block::Hash>>

Get storage changes event stream.

impl<B, E, Block, RA> CallApiAt<Block> for Client<B, E, Block, RA> where
    B: Backend<Block>,
    E: CallExecutor<Block, Backend = B> + Send + Sync,
    Block: BlockT, 

type Error = Error

Error type used by the implementation.

type StateBackend = B::State

The state backend that is used to store the block states.

fn call_api_at<'a, R: Encode + Decode + PartialEq, NC: FnOnce() -> Result<R, String> + UnwindSafe, C: CoreApi<Block, Error = Error>>(
    &self,
    params: CallApiAtParams<'a, Block, C, NC, B::State>
) -> Result<NativeOrEncoded<R>>

Calls the given api function with the given encoded arguments at the given block and returns the encoded result.

fn runtime_version_at(&self, at: &BlockId<Block>) -> Result<RuntimeVersion>

Returns the runtime version at the given block.

impl<BE, E, B, RA> Chain<B> for Client<BE, E, B, RA> where
    BE: Backend<B>,
    E: CallExecutor<B>,
    B: BlockT, 

fn block_status(
    &self,
    id: &BlockId<B>
) -> Result<BlockStatus, Box<dyn Error + Send>>

Retrieve the status of the block denoted by the given [BlockId].

impl<B, E, Block, RA> Finalizer<Block, B> for Client<B, E, Block, RA> where
    B: Backend<Block>,
    E: CallExecutor<Block>,
    Block: BlockT, 

fn apply_finality(
    &self,
    operation: &mut ClientImportOperation<Block, B>,
    id: BlockId<Block>,
    justification: Option<Justification>,
    notify: bool
) -> Result<()>

Mark all blocks up to given as finalized in operation.

fn finalize_block(
    &self,
    id: BlockId<Block>,
    justification: Option<Justification>,
    notify: bool
) -> Result<()>

Finalize a block.

impl<'_, B, E, Block, RA> Finalizer<Block, B> for &'_ Client<B, E, Block, RA> where
    B: Backend<Block>,
    E: CallExecutor<Block>,
    Block: BlockT, 

fn apply_finality(
    &self,
    operation: &mut ClientImportOperation<Block, B>,
    id: BlockId<Block>,
    justification: Option<Justification>,
    notify: bool
) -> Result<()>

Mark all blocks up to given as finalized in operation.

fn finalize_block(
    &self,
    id: BlockId<Block>,
    justification: Option<Justification>,
    notify: bool
) -> Result<()>

Finalize a block.

impl<B, E, Block, RA> HeaderBackend<Block> for Client<B, E, Block, RA> where
    B: Backend<Block>,
    E: CallExecutor<Block> + Send + Sync,
    Block: BlockT,
    RA: Send + Sync, 

fn header(&self, id: BlockId<Block>) -> Result<Option<Block::Header>>

Get block header. Returns None if block is not found.

fn info(&self) -> Info<Block>

Get blockchain info.

fn status(&self, id: BlockId<Block>) -> Result<BlockStatus>

Get block status.

fn number(
    &self,
    hash: Block::Hash
) -> Result<Option<<<Block as BlockT>::Header as HeaderT>::Number>>

Get block number by hash. Returns None if the header is not in the chain.

fn hash(&self, number: NumberFor<Block>) -> Result<Option<Block::Hash>>

Get block hash by number. Returns None if the header is not in the chain.

fn block_hash_from_id(
    &self,
    id: &BlockId<Block>
) -> Result<Option<<Block as Block>::Hash>, Error>

Convert an arbitrary block ID into a block hash.

fn block_number_from_id(
    &self,
    id: &BlockId<Block>
) -> Result<Option<<<Block as Block>::Header as Header>::Number>, Error>

Convert an arbitrary block ID into a block hash.

fn expect_header(
    &self,
    id: BlockId<Block>
) -> Result<<Block as Block>::Header, Error>

Get block header. Returns UnknownBlock error if block is not found.

fn expect_block_number_from_id(
    &self,
    id: &BlockId<Block>
) -> Result<<<Block as Block>::Header as Header>::Number, Error>

Convert an arbitrary block ID into a block number. Returns UnknownBlock error if block is not found.

fn expect_block_hash_from_id(
    &self,
    id: &BlockId<Block>
) -> Result<<Block as Block>::Hash, Error>

Convert an arbitrary block ID into a block hash. Returns UnknownBlock error if block is not found.

impl<'_, B, E, Block, RA> HeaderBackend<Block> for &'_ Client<B, E, Block, RA> where
    B: Backend<Block>,
    E: CallExecutor<Block> + Send + Sync,
    Block: BlockT,
    RA: Send + Sync, 

fn header(&self, id: BlockId<Block>) -> Result<Option<Block::Header>>

Get block header. Returns None if block is not found.

fn info(&self) -> Info<Block>

Get blockchain info.

fn status(&self, id: BlockId<Block>) -> Result<BlockStatus>

Get block status.

fn number(
    &self,
    hash: Block::Hash
) -> Result<Option<<<Block as BlockT>::Header as HeaderT>::Number>>

Get block number by hash. Returns None if the header is not in the chain.

fn hash(&self, number: NumberFor<Block>) -> Result<Option<Block::Hash>>

Get block hash by number. Returns None if the header is not in the chain.

fn block_hash_from_id(
    &self,
    id: &BlockId<Block>
) -> Result<Option<<Block as Block>::Hash>, Error>

Convert an arbitrary block ID into a block hash.

fn block_number_from_id(
    &self,
    id: &BlockId<Block>
) -> Result<Option<<<Block as Block>::Header as Header>::Number>, Error>

Convert an arbitrary block ID into a block hash.

fn expect_header(
    &self,
    id: BlockId<Block>
) -> Result<<Block as Block>::Header, Error>

Get block header. Returns UnknownBlock error if block is not found.

fn expect_block_number_from_id(
    &self,
    id: &BlockId<Block>
) -> Result<<<Block as Block>::Header as Header>::Number, Error>

Convert an arbitrary block ID into a block number. Returns UnknownBlock error if block is not found.

fn expect_block_hash_from_id(
    &self,
    id: &BlockId<Block>
) -> Result<<Block as Block>::Hash, Error>

Convert an arbitrary block ID into a block hash. Returns UnknownBlock error if block is not found.

impl<B, E, Block, RA> HeaderMetadata<Block> for Client<B, E, Block, RA> where
    B: Backend<Block>,
    E: CallExecutor<Block>,
    Block: BlockT, 

type Error = Error

Error used in case the header metadata is not found.

fn header_metadata(
    &self,
    hash: Block::Hash
) -> Result<CachedHeaderMetadata<Block>, Self::Error>

fn insert_header_metadata(
    &self,
    hash: Block::Hash,
    metadata: CachedHeaderMetadata<Block>
)

fn remove_header_metadata(&self, hash: Block::Hash)

impl<B, E, Block, RA> ProvideCache<Block> for Client<B, E, Block, RA> where
    B: Backend<Block>,
    Block: BlockT, 

fn cache(&self) -> Option<Arc<dyn Cache<Block>>>

Returns data cache reference, if it is enabled on this backend.

impl<B, E, Block, RA> ProvideRuntimeApi<Block> for Client<B, E, Block, RA> where
    B: Backend<Block>,
    E: CallExecutor<Block, Backend = B> + Send + Sync,
    Block: BlockT,
    RA: ConstructRuntimeApi<Block, Self>, 

type Api = <RA as ConstructRuntimeApi<Block, Self>>::RuntimeApi

The concrete type that provides the api.

fn runtime_api<'a>(&'a self) -> ApiRef<'a, Self::Api>

Returns the runtime api. The returned instance will keep track of modifications to the storage. Any successful call to an api function, will commit its changes to an internal buffer. Otherwise, the modifications will be discarded. The modifications will not be applied to the storage, even on a commit.

impl<B, E, Block, RA> ProvideUncles<Block> for Client<B, E, Block, RA> where
    B: Backend<Block>,
    E: CallExecutor<Block>,
    Block: BlockT, 

fn uncles(
    &self,
    target_hash: Block::Hash,
    max_generation: NumberFor<Block>
) -> Result<Vec<Block::Header>>

Gets the uncles of the block with target_hash going back max_generation ancestors.