ChainHeadRpcMethods

avail_rust_client::ext::subxt_rpcs

Struct ChainHeadRpcMethods

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§

impl<T> ChainHeadRpcMethods<T>
where T: RpcConfig,

pub fn new(client: RpcClient) -> ChainHeadRpcMethods<T>

Instantiate the legacy RPC method interface.

pub async fn chainhead_v1_follow( &self, with_runtime: bool, ) -> Result<FollowSubscription<<T as RpcConfig>::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.

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.

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.

pub async fn chainhead_v1_body( &self, subscription_id: &str, hash: <T as RpcConfig>::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.

pub async fn chainhead_v1_header( &self, subscription_id: &str, hash: <T as RpcConfig>::Hash, ) -> Result<Option<<T as RpcConfig>::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.

pub async fn chainhead_v1_storage( &self, subscription_id: &str, hash: <T as RpcConfig>::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.

pub async fn chainhead_v1_call( &self, subscription_id: &str, hash: <T as RpcConfig>::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.

pub async fn chainhead_v1_unpin( &self, subscription_id: &str, hash: <T as RpcConfig>::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.

pub async fn chainspec_v1_genesis_hash( &self, ) -> Result<<T as RpcConfig>::Hash, Error>

Return the genesis hash.

pub async fn chainspec_v1_chain_name(&self) -> Result<String, Error>

Return a string containing the human-readable name of the chain.

pub async fn chainspec_v1_properties<Props>(&self) -> Result<Props, Error>
where Props: DeserializeOwned,

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.

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.

pub async fn transactionwatch_v1_submit_and_watch( &self, tx: &[u8], ) -> Result<TransactionSubscription<<T as RpcConfig>::Hash>, Error>

Attempt to submit a transaction, returning events about its progress.

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.

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.

pub async fn archive_unstable_body( &self, block_hash: <T as RpcConfig>::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.

pub async fn archive_unstable_call( &self, block_hash: <T as RpcConfig>::Hash, function: &str, call_parameters: &[u8], ) -> Result<ArchiveCallResult, Error>

Call the archive_unstable_call method and return the response.

pub async fn archive_unstable_finalized_height(&self) -> Result<usize, Error>

Return the finalized block height of the chain.

pub async fn archive_unstable_genesis_hash( &self, ) -> Result<<T as RpcConfig>::Hash, Error>

Return the genesis hash.

pub async fn archive_unstable_hash_by_height( &self, height: usize, ) -> Result<Vec<<T as RpcConfig>::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.

pub async fn archive_unstable_header( &self, block_hash: <T as RpcConfig>::Hash, ) -> Result<Option<<T as RpcConfig>::Header>, Error>

Fetch the header for a block with the given hash, or None if no block with that hash exists.

pub async fn archive_unstable_storage( &self, block_hash: <T as RpcConfig>::Hash, items: impl IntoIterator<Item = StorageQuery<&[u8]>>, child_key: Option<&[u8]>, ) -> Result<ArchiveStorageSubscription<<T as RpcConfig>::Hash>, Error>

Query the node storage and return a subscription which streams corresponding storage events back.

Trait Implementations§

impl<T> Clone for ChainHeadRpcMethods<T>

fn clone(&self) -> ChainHeadRpcMethods<T>

Returns a duplicate of the value. Read more

1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl<T> Debug for ChainHeadRpcMethods<T>

fn fmt(&self, __f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl<T> Freeze for ChainHeadRpcMethods<T>

impl<T> !RefUnwindSafe for ChainHeadRpcMethods<T>

impl<T> Send for ChainHeadRpcMethods<T>
where T: Send,

impl<T> Sync for ChainHeadRpcMethods<T>
where T: Sync,

impl<T> Unpin for ChainHeadRpcMethods<T>
where T: Unpin,

impl<T> !UnwindSafe for ChainHeadRpcMethods<T>

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> Conv for T

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more

impl<T> FmtForward for T

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T> Pipe for T
where T: ?Sized,

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<T> Tap for T

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> TryConv for T

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> ErasedDestructor for T
where T: 'static,

impl<T> JsonSchemaMaybe for T