mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-07-07 22:27:21 +00:00
Guillaume Thiolliere
9bf62ef65d
* implement max_values + storages info * some formatting + doc * rename StoragesInfo -> PalletStorageInfo * merge both StorageInfoTrait and PalletStorageInfo I think it is more future proof. In the future some storage could make use of multiple prefix. Like one to store how much value has been inserted, etc... * Update frame/support/procedural/src/storage/parse.rs Co-authored-by: Peter Goodspeed-Niklaus <coriolinus@users.noreply.github.com> * Update frame/support/procedural/src/storage/storage_struct.rs Co-authored-by: Peter Goodspeed-Niklaus <coriolinus@users.noreply.github.com> * Fix max_size using hasher information hasher now expose `max_len` which allows to computes their maximum len. For hasher without concatenation, it is the size of the hash part, for hasher with concatenation, it is the size of the hash part + max encoded len of the key. * fix tests * fix ui tests Co-authored-by: Peter Goodspeed-Niklaus <coriolinus@users.noreply.github.com>
77 lines
2.8 KiB
Rust
77 lines
2.8 KiB
Rust
// This file is part of Substrate.
|
|
|
|
// Copyright (C) 2019-2021 Parity Technologies (UK) Ltd.
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
//! Traits for encoding data related to pallet's storage items.
|
|
|
|
use sp_std::prelude::*;
|
|
|
|
/// An instance of a pallet in the storage.
|
|
///
|
|
/// It is required that these instances are unique, to support multiple instances per pallet in the same runtime!
|
|
///
|
|
/// E.g. for module MyModule default instance will have prefix "MyModule" and other instances
|
|
/// "InstanceNMyModule".
|
|
pub trait Instance: 'static {
|
|
/// Unique module prefix. E.g. "InstanceNMyModule" or "MyModule"
|
|
const PREFIX: &'static str;
|
|
/// Unique numerical identifier for an instance.
|
|
const INDEX: u8;
|
|
}
|
|
|
|
/// An instance of a storage in a pallet.
|
|
///
|
|
/// Define an instance for an individual storage inside a pallet.
|
|
/// The pallet prefix is used to isolate the storage between pallets, and the storage prefix is
|
|
/// used to isolate storages inside a pallet.
|
|
///
|
|
/// NOTE: These information can be used to define storages in pallet such as a `StorageMap` which
|
|
/// can use keys after `twox_128(pallet_prefix())++twox_128(STORAGE_PREFIX)`
|
|
pub trait StorageInstance {
|
|
/// Prefix of a pallet to isolate it from other pallets.
|
|
fn pallet_prefix() -> &'static str;
|
|
|
|
/// Prefix given to a storage to isolate from other storages in the pallet.
|
|
const STORAGE_PREFIX: &'static str;
|
|
}
|
|
|
|
/// Some info about an individual storage in a pallet.
|
|
#[derive(codec::Encode, codec::Decode, crate::RuntimeDebug, Eq, PartialEq, Clone)]
|
|
pub struct StorageInfo {
|
|
/// The prefix of the storage. All keys after the prefix are considered part of the storage
|
|
pub prefix: [u8; 32],
|
|
/// The maximum number of values in the storage, or none if no maximum specified.
|
|
pub max_values: Option<u32>,
|
|
/// The maximum size of key/values in the storage, or none if no maximum specified.
|
|
pub max_size: Option<u32>,
|
|
}
|
|
|
|
/// A trait to give information about storage.
|
|
///
|
|
/// It can be used to calculate PoV worst case size.
|
|
pub trait StorageInfoTrait {
|
|
fn storage_info() -> Vec<StorageInfo>;
|
|
}
|
|
|
|
#[impl_trait_for_tuples::impl_for_tuples(30)]
|
|
impl StorageInfoTrait for Tuple {
|
|
fn storage_info() -> Vec<StorageInfo> {
|
|
let mut res = vec![];
|
|
for_tuples!( #( res.extend_from_slice(&Tuple::storage_info()); )* );
|
|
res
|
|
}
|
|
}
|