Trait sc_rpc::chain::ChainApiServer

pub trait ChainApiServer<Number, Hash, Header, SignedBlock>: 'static + Sized + Send + Sync {
    fn header(&self, hash: Option<Hash>) -> Result<Option<Header>, Error>;
    fn block(&self, hash: Option<Hash>) -> Result<Option<SignedBlock>, Error>;
    fn block_hash(
        &self,
        hash: Option<ListOrValue<NumberOrHex>>
    ) -> Result<ListOrValue<Option<Hash>>, Error>;
    fn finalized_head(&self) -> Result<Hash, Error>;
    fn subscribe_all_heads(
        &self,
        subscription_sink: SubscriptionSink
    ) -> Result<(), SubscriptionEmptyError>;
    fn subscribe_new_heads(
        &self,
        subscription_sink: SubscriptionSink
    ) -> Result<(), SubscriptionEmptyError>;
    fn subscribe_finalized_heads(
        &self,
        subscription_sink: SubscriptionSink
    ) -> Result<(), SubscriptionEmptyError>;

    fn into_rpc(self) -> RpcModule<Self>
    where
        Number: 'static + Send + Sync,
        Hash: 'static + Send + Sync + DeserializeOwned + Serialize,
        Header: 'static + Send + Sync + Serialize,
        SignedBlock: 'static + Send + Sync + Serialize,
    { ... }
}

Server trait implementation for the ChainApi RPC API.

Required Methods

fn header(&self, hash: Option<Hash>) -> Result<Option<Header>, Error>

Get header.

fn block(&self, hash: Option<Hash>) -> Result<Option<SignedBlock>, Error>

Get header and body of a relay chain block.

fn block_hash(
    &self,
    hash: Option<ListOrValue<NumberOrHex>>
) -> Result<ListOrValue<Option<Hash>>, Error>

Get hash of the n-th block in the canon chain.

By default returns latest block hash.

fn finalized_head(&self) -> Result<Hash, Error>

Get hash of the last finalized block in the canon chain.

fn subscribe_all_heads(
    &self,
    subscription_sink: SubscriptionSink
) -> Result<(), SubscriptionEmptyError>

All head subscription.

fn subscribe_new_heads(
    &self,
    subscription_sink: SubscriptionSink
) -> Result<(), SubscriptionEmptyError>

New head subscription.

fn subscribe_finalized_heads(
    &self,
    subscription_sink: SubscriptionSink
) -> Result<(), SubscriptionEmptyError>

Finalized head subscription.

Provided Methods

fn into_rpc(self) -> RpcModule<Self>where
    Number: 'static + Send + Sync,
    Hash: 'static + Send + Sync + DeserializeOwned + Serialize,
    Header: 'static + Send + Sync + Serialize,
    SignedBlock: 'static + Send + Sync + Serialize,

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

Implementors

impl<Block, Client> ChainApiServer<<<Block as Block>::Header as Header>::Number, <Block as Block>::Hash, <Block as Block>::Header, SignedBlock<Block>> for Chain<Block, Client>where
    Block: BlockT + 'static,
    Block::Header: Unpin,
    Client: HeaderBackend<Block> + BlockchainEvents<Block> + 'static,