mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-04-27 06:57:58 +00:00
Vivek Pandya
bc53b9a03a
* Change copyright year to 2023 from 2022 * Fix incorrect update of copyright year * Remove years from copy right header * Fix remaining files * Fix typo in a header and remove update-copyright.sh
98 lines
3.4 KiB
Rust
98 lines
3.4 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/>.
|
|
|
|
//! Substrate child state API
|
|
use crate::state::ReadProof;
|
|
use jsonrpsee::{core::RpcResult, proc_macros::rpc};
|
|
use sp_core::storage::{PrefixedStorageKey, StorageData, StorageKey};
|
|
|
|
/// Substrate child state API
|
|
///
|
|
/// Note that all `PrefixedStorageKey` are deserialized
|
|
/// from json and not guaranteed valid.
|
|
#[rpc(client, server)]
|
|
pub trait ChildStateApi<Hash> {
|
|
/// Returns the keys with prefix from a child storage, leave empty to get all the keys
|
|
#[method(name = "childstate_getKeys", blocking)]
|
|
#[deprecated(since = "2.0.0", note = "Please use `getKeysPaged` with proper paging support")]
|
|
fn storage_keys(
|
|
&self,
|
|
child_storage_key: PrefixedStorageKey,
|
|
prefix: StorageKey,
|
|
hash: Option<Hash>,
|
|
) -> RpcResult<Vec<StorageKey>>;
|
|
|
|
/// Returns the keys with prefix from a child storage with pagination support.
|
|
/// Up to `count` keys will be returned.
|
|
/// If `start_key` is passed, return next keys in storage in lexicographic order.
|
|
#[method(name = "childstate_getKeysPaged", aliases = ["childstate_getKeysPagedAt"], blocking)]
|
|
fn storage_keys_paged(
|
|
&self,
|
|
child_storage_key: PrefixedStorageKey,
|
|
prefix: Option<StorageKey>,
|
|
count: u32,
|
|
start_key: Option<StorageKey>,
|
|
hash: Option<Hash>,
|
|
) -> RpcResult<Vec<StorageKey>>;
|
|
|
|
/// Returns a child storage entry at a specific block's state.
|
|
#[method(name = "childstate_getStorage", blocking)]
|
|
fn storage(
|
|
&self,
|
|
child_storage_key: PrefixedStorageKey,
|
|
key: StorageKey,
|
|
hash: Option<Hash>,
|
|
) -> RpcResult<Option<StorageData>>;
|
|
|
|
/// Returns child storage entries for multiple keys at a specific block's state.
|
|
#[method(name = "childstate_getStorageEntries", blocking)]
|
|
fn storage_entries(
|
|
&self,
|
|
child_storage_key: PrefixedStorageKey,
|
|
keys: Vec<StorageKey>,
|
|
hash: Option<Hash>,
|
|
) -> RpcResult<Vec<Option<StorageData>>>;
|
|
|
|
/// Returns the hash of a child storage entry at a block's state.
|
|
#[method(name = "childstate_getStorageHash", blocking)]
|
|
fn storage_hash(
|
|
&self,
|
|
child_storage_key: PrefixedStorageKey,
|
|
key: StorageKey,
|
|
hash: Option<Hash>,
|
|
) -> RpcResult<Option<Hash>>;
|
|
|
|
/// Returns the size of a child storage entry at a block's state.
|
|
#[method(name = "childstate_getStorageSize", blocking)]
|
|
fn storage_size(
|
|
&self,
|
|
child_storage_key: PrefixedStorageKey,
|
|
key: StorageKey,
|
|
hash: Option<Hash>,
|
|
) -> RpcResult<Option<u64>>;
|
|
|
|
/// Returns proof of storage for child key entries at a specific block's state.
|
|
#[method(name = "state_getChildReadProof", blocking)]
|
|
fn read_child_proof(
|
|
&self,
|
|
child_storage_key: PrefixedStorageKey,
|
|
keys: Vec<StorageKey>,
|
|
hash: Option<Hash>,
|
|
) -> RpcResult<ReadProof<Hash>>;
|
|
}
|