pub struct ChainHeadRpcMethods<T> { /* private fields */ }Expand description
An interface to call the unstable RPC methods. This interface is instantiated with
some T: Config trait which determines some of the types that the RPC methods will
take or hand back.
Implementations§
Source§impl<T: RpcConfig> ChainHeadRpcMethods<T>
impl<T: RpcConfig> ChainHeadRpcMethods<T>
Sourcepub async fn chainhead_v1_follow(
&self,
with_runtime: bool,
) -> Result<FollowSubscription<T::Hash>, Error>
pub async fn chainhead_v1_follow( &self, with_runtime: bool, ) -> Result<FollowSubscription<T::Hash>, Error>
Subscribe to chainHead_v1_follow to obtain all reported blocks by the chain.
The subscription ID can be used to make queries for the
block’s body (chainHead_v1_body),
block’s header (chainHead_v1_header),
block’s storage (chainHead_v1_storage) and submitting
runtime API calls at this block (chainHead_v1_call).
§Note
When the user is no longer interested in a block, the user is responsible
for calling the chainHead_v1_unpin method.
Failure to do so will result in the subscription being stopped by generating the Stop event.
Sourcepub async fn chainhead_v1_continue(
&self,
follow_subscription: &str,
operation_id: &str,
) -> Result<(), Error>
pub async fn chainhead_v1_continue( &self, follow_subscription: &str, operation_id: &str, ) -> Result<(), Error>
Resumes a storage fetch started with chainHead_v1_storage after it has generated an
operationWaitingForContinue event.
Has no effect if the operationId is invalid or refers to an operation that has emitted a
{"event": "operationInaccessible" event, or if the followSubscription is invalid or stale.
Sourcepub async fn chainhead_v1_stop_operation(
&self,
follow_subscription: &str,
operation_id: &str,
) -> Result<(), Error>
pub async fn chainhead_v1_stop_operation( &self, follow_subscription: &str, operation_id: &str, ) -> Result<(), Error>
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.
Has no effect if the followSubscription is invalid or stale.
Sourcepub async fn chainhead_v1_body(
&self,
subscription_id: &str,
hash: T::Hash,
) -> Result<MethodResponse, Error>
pub async fn chainhead_v1_body( &self, subscription_id: &str, hash: T::Hash, ) -> Result<MethodResponse, Error>
Call the chainHead_v1_body method and return an operation ID to obtain the block’s body.
The response events are provided on the chainHead_follow subscription and identified by
the returned operation ID.
§Note
The subscription ID is obtained from an open subscription created by
chainHead_v1_follow.
Sourcepub async fn chainhead_v1_header(
&self,
subscription_id: &str,
hash: T::Hash,
) -> Result<Option<T::Header>, Error>
pub async fn chainhead_v1_header( &self, subscription_id: &str, hash: T::Hash, ) -> Result<Option<T::Header>, Error>
Get the block’s header using the chainHead_v1_header method.
§Note
The subscription ID is obtained from an open subscription created by
chainHead_v1_follow.
Sourcepub async fn chainhead_v1_storage(
&self,
subscription_id: &str,
hash: T::Hash,
items: impl IntoIterator<Item = StorageQuery<&[u8]>>,
child_key: Option<&[u8]>,
) -> Result<MethodResponse, Error>
pub async fn chainhead_v1_storage( &self, subscription_id: &str, hash: T::Hash, items: impl IntoIterator<Item = StorageQuery<&[u8]>>, child_key: Option<&[u8]>, ) -> Result<MethodResponse, Error>
Call the chainHead_v1_storage method and return an operation ID to obtain the block’s storage.
The response events are provided on the chainHead_follow subscription and identified by
the returned operation ID.
§Note
The subscription ID is obtained from an open subscription created by
chainHead_v1_follow.
Sourcepub async fn chainhead_v1_call(
&self,
subscription_id: &str,
hash: T::Hash,
function: &str,
call_parameters: &[u8],
) -> Result<MethodResponse, Error>
pub async fn chainhead_v1_call( &self, subscription_id: &str, hash: T::Hash, function: &str, call_parameters: &[u8], ) -> Result<MethodResponse, Error>
Call the chainHead_v1_call method and return an operation ID to obtain the runtime API result.
The response events are provided on the chainHead_follow subscription and identified by
the returned operation ID.
§Note
The subscription ID is obtained from an open subscription created by
chainHead_v1_follow.
Sourcepub async fn chainhead_v1_unpin(
&self,
subscription_id: &str,
hash: T::Hash,
) -> Result<(), Error>
pub async fn chainhead_v1_unpin( &self, subscription_id: &str, hash: T::Hash, ) -> Result<(), Error>
Unpin a block reported by the chainHead_follow subscription.
§Note
The subscription ID is obtained from an open subscription created by
chainHead_v1_follow.
Sourcepub async fn chainspec_v1_genesis_hash(&self) -> Result<T::Hash, Error>
pub async fn chainspec_v1_genesis_hash(&self) -> Result<T::Hash, Error>
Return the genesis hash.
Sourcepub async fn chainspec_v1_chain_name(&self) -> Result<String, Error>
pub async fn chainspec_v1_chain_name(&self) -> Result<String, Error>
Return a string containing the human-readable name of the chain.
Sourcepub async fn chainspec_v1_properties<Props: DeserializeOwned>(
&self,
) -> Result<Props, Error>
pub async fn chainspec_v1_properties<Props: DeserializeOwned>( &self, ) -> Result<Props, Error>
Returns the JSON payload found in the chain specification under the key properties. No guarantee is offered about the content of this object, and so it’s up to the caller to decide what to deserialize it into.
Sourcepub async fn rpc_methods(&self) -> Result<Vec<String>, Error>
pub async fn rpc_methods(&self) -> Result<Vec<String>, Error>
Returns an array of strings indicating the names of all the JSON-RPC functions supported by the JSON-RPC server.
Sourcepub async fn transactionwatch_v1_submit_and_watch(
&self,
tx: &[u8],
) -> Result<TransactionSubscription<T::Hash>, Error>
pub async fn transactionwatch_v1_submit_and_watch( &self, tx: &[u8], ) -> Result<TransactionSubscription<T::Hash>, Error>
Attempt to submit a transaction, returning events about its progress.
Sourcepub async fn transaction_v1_broadcast(
&self,
tx: &[u8],
) -> Result<Option<String>, Error>
pub async fn transaction_v1_broadcast( &self, tx: &[u8], ) -> Result<Option<String>, Error>
Broadcast the transaction on the p2p network until the
Self::transaction_v1_stop is called.
Returns an operation ID that can be used to stop the broadcasting process.
Returns None if the server cannot handle the request at the moment.
Sourcepub async fn transaction_v1_stop(&self, operation_id: &str) -> Result<(), Error>
pub async fn transaction_v1_stop(&self, operation_id: &str) -> Result<(), Error>
Stop the broadcasting process of the transaction.
The operation ID is obtained from the Self::transaction_v1_broadcast method.
Returns an error if the operation ID does not correspond to any active transaction for this connection.
Sourcepub async fn archive_v1_body(
&self,
block_hash: T::Hash,
) -> Result<Option<Vec<Bytes>>, Error>
pub async fn archive_v1_body( &self, block_hash: T::Hash, ) -> Result<Option<Vec<Bytes>>, Error>
Fetch the block body (ie the extrinsics in the block) given its hash.
Returns an array of the hexadecimal-encoded scale-encoded extrinsics found in the block,
or None if the block wasn’t found.
Sourcepub async fn archive_v1_call(
&self,
block_hash: T::Hash,
function: &str,
call_parameters: &[u8],
) -> Result<ArchiveCallResult, Error>
pub async fn archive_v1_call( &self, block_hash: T::Hash, function: &str, call_parameters: &[u8], ) -> Result<ArchiveCallResult, Error>
Call the archive_v1_call method and return the response.
Sourcepub async fn archive_v1_finalized_height(&self) -> Result<usize, Error>
pub async fn archive_v1_finalized_height(&self) -> Result<usize, Error>
Return the finalized block height of the chain.
Sourcepub async fn archive_v1_genesis_hash(&self) -> Result<T::Hash, Error>
pub async fn archive_v1_genesis_hash(&self) -> Result<T::Hash, Error>
Return the genesis hash.
Sourcepub async fn archive_v1_hash_by_height(
&self,
height: usize,
) -> Result<Vec<T::Hash>, Error>
pub async fn archive_v1_hash_by_height( &self, height: usize, ) -> Result<Vec<T::Hash>, Error>
Given a block height, return the hashes of the zero or more blocks at that height. For blocks older than the latest finalized block, only one entry will be returned. For blocks newer than the latest finalized block, it’s possible to have 0, 1 or multiple blocks at that height given that forks could occur.
Sourcepub async fn archive_v1_header(
&self,
block_hash: T::Hash,
) -> Result<Option<T::Header>, Error>
pub async fn archive_v1_header( &self, block_hash: T::Hash, ) -> Result<Option<T::Header>, Error>
Fetch the header for a block with the given hash, or None if no block with that hash exists.
Sourcepub async fn archive_v1_storage(
&self,
block_hash: T::Hash,
items: impl IntoIterator<Item = StorageQuery<&[u8]>>,
child_key: Option<&[u8]>,
) -> Result<ArchiveStorageSubscription<T::Hash>, Error>
pub async fn archive_v1_storage( &self, block_hash: T::Hash, items: impl IntoIterator<Item = StorageQuery<&[u8]>>, child_key: Option<&[u8]>, ) -> Result<ArchiveStorageSubscription<T::Hash>, Error>
Query the node storage and return a subscription which streams corresponding storage events back.
Sourcepub async fn archive_unstable_body(
&self,
block_hash: T::Hash,
) -> Result<Option<Vec<Bytes>>, Error>
pub async fn archive_unstable_body( &self, block_hash: T::Hash, ) -> Result<Option<Vec<Bytes>>, Error>
Fetch the block body (ie the extrinsics in the block) given its hash.
Returns an array of the hexadecimal-encoded scale-encoded extrinsics found in the block,
or None if the block wasn’t found.
Sourcepub async fn archive_unstable_call(
&self,
block_hash: T::Hash,
function: &str,
call_parameters: &[u8],
) -> Result<ArchiveCallResult, Error>
pub async fn archive_unstable_call( &self, block_hash: T::Hash, function: &str, call_parameters: &[u8], ) -> Result<ArchiveCallResult, Error>
Call the archive_unstable_call method and return the response.
Sourcepub async fn archive_unstable_finalized_height(&self) -> Result<usize, Error>
pub async fn archive_unstable_finalized_height(&self) -> Result<usize, Error>
Return the finalized block height of the chain.
Sourcepub async fn archive_unstable_genesis_hash(&self) -> Result<T::Hash, Error>
pub async fn archive_unstable_genesis_hash(&self) -> Result<T::Hash, Error>
Return the genesis hash.
Sourcepub async fn archive_unstable_hash_by_height(
&self,
height: usize,
) -> Result<Vec<T::Hash>, Error>
pub async fn archive_unstable_hash_by_height( &self, height: usize, ) -> Result<Vec<T::Hash>, Error>
Given a block height, return the hashes of the zero or more blocks at that height. For blocks older than the latest finalized block, only one entry will be returned. For blocks newer than the latest finalized block, it’s possible to have 0, 1 or multiple blocks at that height given that forks could occur.
Sourcepub async fn archive_unstable_header(
&self,
block_hash: T::Hash,
) -> Result<Option<T::Header>, Error>
pub async fn archive_unstable_header( &self, block_hash: T::Hash, ) -> Result<Option<T::Header>, Error>
Fetch the header for a block with the given hash, or None if no block with that hash exists.
Sourcepub async fn archive_unstable_storage(
&self,
block_hash: T::Hash,
items: impl IntoIterator<Item = StorageQuery<&[u8]>>,
child_key: Option<&[u8]>,
) -> Result<ArchiveStorageSubscription<T::Hash>, Error>
pub async fn archive_unstable_storage( &self, block_hash: T::Hash, items: impl IntoIterator<Item = StorageQuery<&[u8]>>, child_key: Option<&[u8]>, ) -> Result<ArchiveStorageSubscription<T::Hash>, Error>
Query the node storage and return a subscription which streams corresponding storage events back.