Struct sc_rpc::state::State

pub struct State<Block, Client> { /* private fields */ }

State API with subscriptions support.

Trait Implementations

impl<Block, Client> StateApiServer<<Block as Block>::Hash> for State<Block, Client>

where Block: BlockT + 'static, Client: Send + Sync + 'static,

fn trace_block( &self, ext: &Extensions, block: Block::Hash, targets: Option<String>, storage_keys: Option<String>, methods: Option<String>, ) -> Result<TraceBlockResponse, Error>

Re-execute the given block with the tracing targets given in targets and capture all state changes.

Note: requires the node to run with --rpc-methods=Unsafe. Note: requires runtimes compiled with wasm tracing support, --features with-tracing.

fn call( &self, method: String, data: Bytes, block: Option<Block::Hash>, ) -> Result<Bytes, Error>

Call a method from the runtime API at a block’s state.

fn storage_keys( &self, key_prefix: StorageKey, block: Option<Block::Hash>, ) -> Result<Vec<StorageKey>, Error>

Returns the keys with prefix, leave empty to get all the keys.

fn storage_pairs( &self, ext: &Extensions, key_prefix: StorageKey, block: Option<Block::Hash>, ) -> Result<Vec<(StorageKey, StorageData)>, Error>

Returns the keys with prefix, leave empty to get all the keys

fn storage_keys_paged( &self, prefix: Option<StorageKey>, count: u32, start_key: Option<StorageKey>, block: Option<Block::Hash>, ) -> Result<Vec<StorageKey>, Error>

Returns the keys with prefix with pagination support. Up to count keys will be returned. If start_key is passed, return next keys in storage in lexicographic order.

fn storage( &self, key: StorageKey, block: Option<Block::Hash>, ) -> Result<Option<StorageData>, Error>

Returns a storage entry at a specific block’s state.

fn storage_hash( &self, key: StorageKey, block: Option<Block::Hash>, ) -> Result<Option<Block::Hash>, Error>

Returns the hash of a storage entry at a block’s state.

fn storage_size<'life0, 'life1, 'async_trait>( &'life0 self, ext: &'life1 Extensions, key: StorageKey, block: Option<Block::Hash>, ) -> Pin<Box<dyn Future<Output = Result<Option<u64>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Returns the size of a storage entry at a block’s state.

fn metadata(&self, block: Option<Block::Hash>) -> Result<Bytes, Error>

Returns the runtime metadata as an opaque blob.

fn runtime_version( &self, at: Option<Block::Hash>, ) -> Result<RuntimeVersion, Error>

Get the runtime version.

fn query_storage( &self, ext: &Extensions, keys: Vec<StorageKey>, from: Block::Hash, to: Option<Block::Hash>, ) -> Result<Vec<StorageChangeSet<Block::Hash>>, Error>

Query historical storage entries (by key) starting from a block given as the second parameter.

fn query_storage_at( &self, keys: Vec<StorageKey>, at: Option<Block::Hash>, ) -> Result<Vec<StorageChangeSet<Block::Hash>>, Error>

Query storage entries (by key) at a block hash given as the second parameter. NOTE: Each StorageChangeSet in the result corresponds to exactly one element – the storage value under an input key at the input block hash.

fn read_proof( &self, keys: Vec<StorageKey>, block: Option<Block::Hash>, ) -> Result<ReadProof<Block::Hash>, Error>

Returns proof of storage entries at a specific block’s state.

fn subscribe_runtime_version(&self, pending: PendingSubscriptionSink)

New runtime version subscription

fn subscribe_storage( &self, pending: PendingSubscriptionSink, ext: &Extensions, keys: Option<Vec<StorageKey>>, )

New storage subscription

fn into_rpc(self) -> RpcModule<Self>

where Hash: Send + Sync + 'static + DeserializeOwned + Clone + Serialize,

Collects all the methods and subscriptions defined in the trait and adds them into a single RpcModule.