mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-11-18 08:36:08 +00:00
This PR implements the `archive_unstable_storage` method that offers support for: - fetching values - fetching hashes - iterating over keys and values - iterating over keys and hashes - fetching merkle values from the trie-db A common component dedicated to RPC-V2 storage queries is created to bridge the gap between `chainHead/storage` and `archive/storage`. Query pagination is supported by `paginationStartKey`, similar to the old APIs. Similarly to the `chainHead/storage`, the `archive/storage` method accepts a maximum number of queried items. The design builds upon: https://github.com/paritytech/json-rpc-interface-spec/pull/94. Closes https://github.com/paritytech/polkadot-sdk/issues/1512. cc @paritytech/subxt-team --------- Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> Co-authored-by: Niklas Adolfsson <niklasadolfsson1@gmail.com>
108 lines
3.5 KiB
Rust
108 lines
3.5 KiB
Rust
// This file is part of Substrate.
|
|
|
|
// Copyright (C) Parity Technologies (UK) Ltd.
|
|
// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0
|
|
|
|
// This program is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
|
|
// This program is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
|
|
//! API trait of the archive methods.
|
|
|
|
use crate::{
|
|
common::events::{ArchiveStorageResult, PaginatedStorageQuery},
|
|
MethodResult,
|
|
};
|
|
use jsonrpsee::{core::RpcResult, proc_macros::rpc};
|
|
|
|
#[rpc(client, server)]
|
|
pub trait ArchiveApi<Hash> {
|
|
/// Retrieves the body (list of transactions) of a given block hash.
|
|
///
|
|
/// Returns an array of strings containing the hexadecimal-encoded SCALE-codec-encoded
|
|
/// transactions in that block. If no block with that hash is found, null.
|
|
///
|
|
/// # Unstable
|
|
///
|
|
/// This method is unstable and subject to change in the future.
|
|
#[method(name = "archive_unstable_body")]
|
|
fn archive_unstable_body(&self, hash: Hash) -> RpcResult<Option<Vec<String>>>;
|
|
|
|
/// Get the chain's genesis hash.
|
|
///
|
|
/// Returns a string containing the hexadecimal-encoded hash of the genesis block of the chain.
|
|
///
|
|
/// # Unstable
|
|
///
|
|
/// This method is unstable and subject to change in the future.
|
|
#[method(name = "archive_unstable_genesisHash")]
|
|
fn archive_unstable_genesis_hash(&self) -> RpcResult<String>;
|
|
|
|
/// Get the block's header.
|
|
///
|
|
/// Returns a string containing the hexadecimal-encoded SCALE-codec encoding header of the
|
|
/// block.
|
|
///
|
|
/// # Unstable
|
|
///
|
|
/// This method is unstable and subject to change in the future.
|
|
#[method(name = "archive_unstable_header")]
|
|
fn archive_unstable_header(&self, hash: Hash) -> RpcResult<Option<String>>;
|
|
|
|
/// Get the height of the current finalized block.
|
|
///
|
|
/// Returns an integer height of the current finalized block of the chain.
|
|
///
|
|
/// # Unstable
|
|
///
|
|
/// This method is unstable and subject to change in the future.
|
|
#[method(name = "archive_unstable_finalizedHeight")]
|
|
fn archive_unstable_finalized_height(&self) -> RpcResult<u64>;
|
|
|
|
/// Get the hashes of blocks from the given height.
|
|
///
|
|
/// Returns an array (possibly empty) of strings containing an hexadecimal-encoded hash of a
|
|
/// block header.
|
|
///
|
|
/// # Unstable
|
|
///
|
|
/// This method is unstable and subject to change in the future.
|
|
#[method(name = "archive_unstable_hashByHeight")]
|
|
fn archive_unstable_hash_by_height(&self, height: u64) -> RpcResult<Vec<String>>;
|
|
|
|
/// Call into the Runtime API at a specified block's state.
|
|
///
|
|
/// # Unstable
|
|
///
|
|
/// This method is unstable and subject to change in the future.
|
|
#[method(name = "archive_unstable_call")]
|
|
fn archive_unstable_call(
|
|
&self,
|
|
hash: Hash,
|
|
function: String,
|
|
call_parameters: String,
|
|
) -> RpcResult<MethodResult>;
|
|
|
|
/// Returns storage entries at a specific block's state.
|
|
///
|
|
/// # Unstable
|
|
///
|
|
/// This method is unstable and subject to change in the future.
|
|
#[method(name = "archive_unstable_storage", blocking)]
|
|
fn archive_unstable_storage(
|
|
&self,
|
|
hash: Hash,
|
|
items: Vec<PaginatedStorageQuery<String>>,
|
|
child_trie: Option<String>,
|
|
) -> RpcResult<ArchiveStorageResult>;
|
|
}
|