Struct sc_rpc::state::State

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

State API with subscriptions support.

Trait Implementations

impl<Block, Client> StateApi<<Block as Block>::Hash> for State<Block, Client> where
    Block: BlockT + 'static,
    Client: Send + Sync + 'static, 

fn trace_block(
    &self,
    block: Block::Hash,
    targets: Option<String>,
    storage_keys: Option<String>
) -> FutureResult<TraceBlockResponse>

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.

type Metadata = Metadata

RPC Metadata

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

Call a contract at a block’s state.

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

DEPRECATED: Please use state_getKeysPaged with proper paging support. Returns the keys with prefix, leave empty to get all the keys.

fn storage_pairs(
    &self,
    key_prefix: StorageKey,
    block: Option<Block::Hash>
) -> FutureResult<Vec<(StorageKey, StorageData)>>

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>
) -> FutureResult<Vec<StorageKey>>

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>
) -> FutureResult<Option<StorageData>>

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

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

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

fn storage_size(
    &self,
    key: StorageKey,
    block: Option<Block::Hash>
) -> FutureResult<Option<u64>>

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

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

Returns the runtime metadata as an opaque blob.

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

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>
) -> FutureResult<Vec<StorageChangeSet<Block::Hash>>>

Query storage entries (by key) starting at block hash given as the second parameter.

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

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

fn subscribe_storage(
    &self,
    meta: Self::Metadata,
    subscriber: Subscriber<StorageChangeSet<Block::Hash>>,
    keys: Option<Vec<StorageKey>>
)

New storage subscription

fn unsubscribe_storage(
    &self,
    meta: Option<Self::Metadata>,
    id: SubscriptionId
) -> RpcResult<bool>

Unsubscribe from storage subscription

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

Get the runtime version.

fn subscribe_runtime_version(
    &self,
    meta: Self::Metadata,
    subscriber: Subscriber<RuntimeVersion>
)

New runtime version subscription

fn unsubscribe_runtime_version(
    &self,
    meta: Option<Self::Metadata>,
    id: SubscriptionId
) -> RpcResult<bool>

Unsubscribe from runtime version subscription

fn to_delegate(self) -> IoDelegate<Self, Self::Metadata> where
    Hash: Send + Sync + 'static + Serialize + DeserializeOwned, 

Create an IoDelegate, wiring rpc calls to the trait methods.