mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-06-23 12:01:07 +00:00
Introduce Pallet paged-list (#14120)
* Prototype StoragePagedList Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Add drain Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Remove stale docs Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Add fuzzer tests Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Update Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Review Co-authored-by: Koute <koute@users.noreply.github.com> Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * fmt Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Docs and clippy Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Sum docs Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Cleanup Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Undo WIP Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Add pallet-paged-list Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Move code to pallet Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Move fuzzer Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Cleanup Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * fmt Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * docs Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Rename Appendix -> Appender Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Rename clear -> delete Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Feature gate testing stuff Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Docs review Co-authored-by: Koute <koute@users.noreply.github.com> Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Cleanup Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * doc review Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Review renames Co-authored-by: Koute <koute@users.noreply.github.com> Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Add docs Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Fix fuzzer Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Docs + examples Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Remove hasher Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Remove empty Event and Call Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Remove MaxPages Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Fix docs Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Test eager page removal Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Cleanup Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Update frame/paged-list/src/paged_list.rs Co-authored-by: Koute <koute@users.noreply.github.com> * Fix docs Co-authored-by: Koute <koute@users.noreply.github.com> Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Remove as_*_vec Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Update versions Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Rename ValuesPerPage -> ValuesPerNewPage Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Update lockfile Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Fix mock Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> --------- Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> Co-authored-by: Koute <koute@users.noreply.github.com> Co-authored-by: parity-processbot <>
This commit is contained in:
Oliver Tale-Yazdi
committed by
GitHub
GitHub
parent
817c97d65d
commit
daa9ecf77d
@@ -0,0 +1,136 @@
|
||||
// This file is part of Substrate.
|
||||
|
||||
// Copyright (C) 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.
|
||||
|
||||
//! > Made with *Substrate*, for *DotSama*.
|
||||
//!
|
||||
//! [![github]](https://github.com/paritytech/substrate/frame/fast-unstake) -
|
||||
//! [![polkadot]](https://polkadot.network)
|
||||
//!
|
||||
//! [polkadot]: https://img.shields.io/badge/polkadot-E6007A?style=for-the-badge&logo=polkadot&logoColor=white
|
||||
//! [github]: https://img.shields.io/badge/github-8da0cb?style=for-the-badge&labelColor=555555&logo=github
|
||||
//!
|
||||
//! # Paged List Pallet
|
||||
//!
|
||||
//! A thin wrapper pallet around a [`paged_list::StoragePagedList`]. It provides an API for a single
|
||||
//! paginated list. It can be instantiated multiple times to provide multiple lists.
|
||||
//!
|
||||
//! ## Overview
|
||||
//!
|
||||
//! The pallet is quite unique since it does not expose any `Call`s, `Error`s or `Event`s. All
|
||||
//! interaction goes through the implemented [`StorageList`][frame_support::storage::StorageList]
|
||||
//! trait.
|
||||
//!
|
||||
//! A fuzzer for testing is provided in crate `pallet-paged-list-fuzzer`.
|
||||
//!
|
||||
//! ## Examples
|
||||
//!
|
||||
//! 1. **Appending** some data to the list can happen either by [`Pallet::append_one`]:
|
||||
#![doc = docify::embed!("frame/paged-list/src/tests.rs", append_one_works)]
|
||||
//! 2. or by [`Pallet::append_many`]. This should always be preferred to repeated calls to
|
||||
//! [`Pallet::append_one`]:
|
||||
#![doc = docify::embed!("frame/paged-list/src/tests.rs", append_many_works)]
|
||||
//! 3. If you want to append many values (ie. in a loop), then best use the [`Pallet::appender`]:
|
||||
#![doc = docify::embed!("frame/paged-list/src/tests.rs", appender_works)]
|
||||
//! 4. **Iterating** over the list can be done with [`Pallet::iter`]. It uses the standard
|
||||
//! `Iterator` trait:
|
||||
#![doc = docify::embed!("frame/paged-list/src/tests.rs", iter_works)]
|
||||
//! 5. **Draining** elements happens through the [`Pallet::drain`] iterator. Note that even
|
||||
//! *peeking* a value will already remove it.
|
||||
#![doc = docify::embed!("frame/paged-list/src/tests.rs", drain_works)]
|
||||
//!
|
||||
//! ## Pallet API
|
||||
//!
|
||||
//! None. Only things to consider is the [`Config`] traits.
|
||||
//!
|
||||
//! ## Low Level / Implementation Details
|
||||
//!
|
||||
//! Implementation details are documented in [`paged_list::StoragePagedList`].
|
||||
//! All storage entries are prefixed with a unique prefix that is generated by [`ListPrefix`].
|
||||
|
||||
#![cfg_attr(not(feature = "std"), no_std)]
|
||||
|
||||
pub use pallet::*;
|
||||
|
||||
pub mod mock;
|
||||
mod paged_list;
|
||||
mod tests;
|
||||
|
||||
use codec::FullCodec;
|
||||
use frame_support::{
|
||||
pallet_prelude::StorageList,
|
||||
traits::{PalletInfoAccess, StorageInstance},
|
||||
};
|
||||
pub use paged_list::StoragePagedList;
|
||||
|
||||
#[frame_support::pallet]
|
||||
pub mod pallet {
|
||||
use super::*;
|
||||
use frame_support::pallet_prelude::*;
|
||||
|
||||
#[pallet::pallet]
|
||||
pub struct Pallet<T, I = ()>(_);
|
||||
|
||||
#[pallet::config]
|
||||
pub trait Config<I: 'static = ()>: frame_system::Config {
|
||||
/// The value type that can be stored in the list.
|
||||
type Value: FullCodec;
|
||||
|
||||
/// The number of values that can be put into newly created pages.
|
||||
///
|
||||
/// Note that this does not retroactively affect already created pages. This value can be
|
||||
/// changed at any time without requiring a runtime migration.
|
||||
#[pallet::constant]
|
||||
type ValuesPerNewPage: Get<u32>;
|
||||
}
|
||||
|
||||
/// A storage paged list akin to what the FRAME macros would generate.
|
||||
// Note that FRAME does natively support paged lists in storage.
|
||||
pub type List<T, I> = StoragePagedList<
|
||||
ListPrefix<T, I>,
|
||||
<T as Config<I>>::Value,
|
||||
<T as Config<I>>::ValuesPerNewPage,
|
||||
>;
|
||||
}
|
||||
|
||||
// This exposes the list functionality to other pallets.
|
||||
impl<T: Config<I>, I: 'static> StorageList<T::Value> for Pallet<T, I> {
|
||||
type Iterator = <List<T, I> as StorageList<T::Value>>::Iterator;
|
||||
type Appender = <List<T, I> as StorageList<T::Value>>::Appender;
|
||||
|
||||
fn iter() -> Self::Iterator {
|
||||
List::<T, I>::iter()
|
||||
}
|
||||
|
||||
fn drain() -> Self::Iterator {
|
||||
List::<T, I>::drain()
|
||||
}
|
||||
|
||||
fn appender() -> Self::Appender {
|
||||
List::<T, I>::appender()
|
||||
}
|
||||
}
|
||||
|
||||
/// Generates a unique storage prefix for each instance of the pallet.
|
||||
pub struct ListPrefix<T, I>(core::marker::PhantomData<(T, I)>);
|
||||
|
||||
impl<T: Config<I>, I: 'static> StorageInstance for ListPrefix<T, I> {
|
||||
fn pallet_prefix() -> &'static str {
|
||||
crate::Pallet::<T, I>::name()
|
||||
}
|
||||
|
||||
const STORAGE_PREFIX: &'static str = "paged_list";
|
||||
}
|
||||
Reference in New Issue
Block a user