Struct sc_rpc_spec_v2::chain_head::chain_head::ChainHead

pub struct ChainHead<BE: Backend<Block>, Block: BlockT, Client> { /* private fields */ }

An API for chain head RPC calls.

Implementations

impl<BE: Backend<Block>, Block: BlockT, Client> ChainHead<BE, Block, Client>

pub fn new( client: Arc<Client>, backend: Arc<BE>, executor: SubscriptionTaskExecutor, config: ChainHeadConfig, ) -> Self

Create a new ChainHead.

Trait Implementations

impl<BE, Block, Client> ChainHeadApiServer<<Block as Block>::Hash> for ChainHead<BE, Block, Client>

where Block: BlockT + 'static, Block::Header: Unpin, BE: Backend<Block> + 'static, Client: BlockBackend<Block> + ExecutorProvider<Block> + HeaderBackend<Block> + HeaderMetadata<Block, Error = Error> + BlockchainEvents<Block> + CallApiAt<Block> + StorageProvider<Block, BE> + 'static,

fn chain_head_unstable_follow( &self, pending: PendingSubscriptionSink, with_runtime: bool, )

Track the state of the head of the chain: the finalized, non-finalized, and best blocks.

fn chain_head_unstable_body<'life0, 'life1, 'async_trait>( &'life0 self, ext: &'life1 Extensions, follow_subscription: String, hash: Block::Hash, ) -> Pin<Box<dyn Future<Output = ResponsePayload<'static, MethodResponse>> + Send + 'async_trait>>

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

Retrieves the body (list of transactions) of a pinned block.

fn chain_head_unstable_header<'life0, 'life1, 'async_trait>( &'life0 self, ext: &'life1 Extensions, follow_subscription: String, hash: Block::Hash, ) -> Pin<Box<dyn Future<Output = Result<Option<String>, ChainHeadRpcError>> + Send + 'async_trait>>

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

Retrieves the header of a pinned block.

fn chain_head_unstable_storage<'life0, 'life1, 'async_trait>( &'life0 self, ext: &'life1 Extensions, follow_subscription: String, hash: Block::Hash, items: Vec<StorageQuery<String>>, child_trie: Option<String>, ) -> Pin<Box<dyn Future<Output = ResponsePayload<'static, MethodResponse>> + Send + 'async_trait>>

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

Returns storage entries at a specific block’s state.

fn chain_head_unstable_call<'life0, 'life1, 'async_trait>( &'life0 self, ext: &'life1 Extensions, follow_subscription: String, hash: Block::Hash, function: String, call_parameters: String, ) -> Pin<Box<dyn Future<Output = ResponsePayload<'static, MethodResponse>> + Send + 'async_trait>>

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

Call into the Runtime API at a specified block’s state.

fn chain_head_unstable_unpin<'life0, 'life1, 'async_trait>( &'life0 self, ext: &'life1 Extensions, follow_subscription: String, hash_or_hashes: ListOrValue<Block::Hash>, ) -> Pin<Box<dyn Future<Output = Result<(), ChainHeadRpcError>> + Send + 'async_trait>>

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

Unpin a block or multiple blocks reported by the follow method.

fn chain_head_unstable_continue<'life0, 'life1, 'async_trait>( &'life0 self, ext: &'life1 Extensions, follow_subscription: String, operation_id: String, ) -> Pin<Box<dyn Future<Output = Result<(), ChainHeadRpcError>> + Send + 'async_trait>>

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

Resumes a storage fetch started with chainHead_storage after it has generated an operationWaitingForContinue event.

fn chain_head_unstable_stop_operation<'life0, 'life1, 'async_trait>( &'life0 self, ext: &'life1 Extensions, follow_subscription: String, operation_id: String, ) -> Pin<Box<dyn Future<Output = Result<(), ChainHeadRpcError>> + Send + 'async_trait>>

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

Stops an operation started with chainHead_v1_body, chainHead_v1_call, or chainHead_v1_storage. If the operation was still in progress, this interrupts it. If the operation was already finished, this call has no effect.

fn into_rpc(self) -> RpcModule<Self>

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

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