Files
pezkuwi-subxt/substrate/frame/support/test/tests/pallet_compatibility_instance.rs
T
Keith Yeung 033d8289f0 Implement StorageNMap (#8635)
* Implement StorageNMap

* Change copyright date to 2021

* Rewrite keys to use impl_for_tuples instead of recursion

* Implement prefix iteration on StorageNMap

* Implement EncodeLike for key arguments

* Rename KeyGenerator::Arg to KeyGenerator::KArg

* Support StorageNMap in decl_storage and #[pallet::storage] macros

* Use StorageNMap in assets pallet

* Support migrate_keys in StorageNMap

* Reduce line characters on select files

* Refactor crate imports in decl_storage macros

* Some more line char reductions and doc comment update

* Update UI test expectations

* Revert whitespace changes to untouched files

* Generate Key struct instead of a 1-tuple when only 1 pair of key and hasher is provided

* Revert formatting changes to unrelated files

* Introduce KeyGeneratorInner

* Add tests for StorageNMap in FRAMEv2 pallet macro

* Small fixes to unit tests for StorageNMap

* Bump runtime metadata version

* Remove unused import

* Update tests to use runtime metadata v13

* Introduce and use EncodeLikeTuple as a trait bound for KArg

* Add some rustdocs

* Revert usage of StorageNMap in assets pallet

* Make use of ext::PunctuatedTrailing

* Add rustdoc for final_hash

* Fix StorageNMap proc macro expansions for single key cases

* Create associated const in KeyGenerator for hasher metadata

* Refactor code according to comments from Basti

* Add module docs for generator/nmap.rs

* Re-export storage::Key as NMapKey in pallet prelude

* Seal the EncodeLikeTuple trait

* Extract sealing code out of key.rs

Co-authored-by: Shawn Tabrizi <shawntabrizi@gmail.com>
2021-05-14 09:44:29 +00:00

316 lines
9.0 KiB
Rust

// This file is part of Substrate.
// Copyright (C) 2020-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.
mod pallet_old {
use frame_support::{
decl_storage, decl_error, decl_event, decl_module, weights::Weight, traits::Get, Parameter
};
use frame_system::ensure_root;
pub trait Config<I: Instance = DefaultInstance>: frame_system::Config {
type SomeConst: Get<Self::Balance>;
type Balance: Parameter + codec::HasCompact + From<u32> + Into<Weight> + Default;
type Event: From<Event<Self, I>> + Into<<Self as frame_system::Config>::Event>;
}
decl_storage! {
trait Store for Module<T: Config<I>, I: Instance = DefaultInstance> as Example {
/// Some documentation
Dummy get(fn dummy) config(): Option<T::Balance>;
Bar get(fn bar) config(): map hasher(blake2_128_concat) T::AccountId => T::Balance;
Foo get(fn foo) config(): T::Balance = 3.into();
Double get(fn double):
double_map hasher(blake2_128_concat) u32, hasher(twox_64_concat) u64 => u16;
}
}
decl_event!(
pub enum Event<T, I = DefaultInstance> where Balance = <T as Config<I>>::Balance {
/// Dummy event, just here so there's a generic type that's used.
Dummy(Balance),
}
);
decl_module! {
pub struct Module<T: Config<I>, I: Instance = DefaultInstance> for enum Call
where origin: T::Origin
{
type Error = Error<T, I>;
fn deposit_event() = default;
const SomeConst: T::Balance = T::SomeConst::get();
#[weight = <T::Balance as Into<Weight>>::into(new_value.clone())]
fn set_dummy(origin, #[compact] new_value: T::Balance) {
ensure_root(origin)?;
<Dummy<T, I>>::put(&new_value);
Self::deposit_event(RawEvent::Dummy(new_value));
}
fn on_initialize(_n: T::BlockNumber) -> Weight {
<Dummy<T, I>>::put(T::Balance::from(10));
10
}
fn on_finalize(_n: T::BlockNumber) {
<Dummy<T, I>>::put(T::Balance::from(11));
}
}
}
decl_error! {
pub enum Error for Module<T: Config<I>, I: Instance> {
/// Some wrong behavior
Wrong,
}
}
}
#[frame_support::pallet]
pub mod pallet {
use frame_support::pallet_prelude::*;
use frame_system::pallet_prelude::*;
use frame_system::ensure_root;
#[pallet::config]
pub trait Config<I: 'static = ()>: frame_system::Config {
type Balance: Parameter + codec::HasCompact + From<u32> + Into<Weight> + Default
+ MaybeSerializeDeserialize;
#[pallet::constant]
type SomeConst: Get<Self::Balance>;
type Event: From<Event<Self, I>> + IsType<<Self as frame_system::Config>::Event>;
}
#[pallet::pallet]
pub struct Pallet<T, I = ()>(PhantomData<(T, I)>);
#[pallet::hooks]
impl<T: Config<I>, I: 'static> Hooks<T::BlockNumber> for Pallet<T, I> {
fn on_initialize(_n: T::BlockNumber) -> Weight {
<Dummy<T, I>>::put(T::Balance::from(10));
10
}
fn on_finalize(_n: T::BlockNumber) {
<Dummy<T, I>>::put(T::Balance::from(11));
}
}
#[pallet::call]
impl<T: Config<I>, I: 'static> Pallet<T, I> {
#[pallet::weight(<T::Balance as Into<Weight>>::into(new_value.clone()))]
fn set_dummy(
origin: OriginFor<T>,
#[pallet::compact] new_value: T::Balance
) -> DispatchResultWithPostInfo {
ensure_root(origin)?;
<Dummy<T, I>>::put(&new_value);
Self::deposit_event(Event::Dummy(new_value));
Ok(().into())
}
}
#[pallet::error]
pub enum Error<T, I = ()> {
/// Some wrong behavior
Wrong,
}
#[pallet::event]
#[pallet::generate_deposit(fn deposit_event)]
#[pallet::metadata(T::Balance = "Balance")]
pub enum Event<T: Config<I>, I: 'static = ()> {
/// Dummy event, just here so there's a generic type that's used.
Dummy(T::Balance),
}
#[pallet::storage]
/// Some documentation
type Dummy<T: Config<I>, I: 'static = ()> = StorageValue<_, T::Balance, OptionQuery>;
#[pallet::storage]
type Bar<T: Config<I>, I: 'static = ()> =
StorageMap<_, Blake2_128Concat, T::AccountId, T::Balance, ValueQuery>;
#[pallet::storage]
type Foo<T: Config<I>, I: 'static = ()> =
StorageValue<_, T::Balance, ValueQuery, OnFooEmpty<T, I>>;
#[pallet::type_value] pub fn OnFooEmpty<T: Config<I>, I: 'static>() -> T::Balance { 3.into() }
#[pallet::storage]
type Double<T, I = ()> = StorageDoubleMap<
_, Blake2_128Concat, u32, Twox64Concat, u64, u16, ValueQuery
>;
#[pallet::genesis_config]
pub struct GenesisConfig<T: Config<I>, I: 'static = ()> {
dummy: Option<T::Balance>,
bar: Vec<(T::AccountId, T::Balance)>,
foo: T::Balance,
}
impl<T: Config<I>, I: 'static> Default for GenesisConfig<T, I> {
fn default() -> Self {
GenesisConfig {
dummy: Default::default(),
bar: Default::default(),
foo: OnFooEmpty::<T, I>::get(),
}
}
}
#[pallet::genesis_build]
impl<T: Config<I>, I: 'static> GenesisBuild<T, I> for GenesisConfig<T, I> {
fn build(&self) {
if let Some(dummy) = self.dummy.as_ref() {
<Dummy<T, I>>::put(dummy);
}
for (k, v) in &self.bar {
<Bar<T, I>>::insert(k, v);
}
<Foo<T, I>>::put(&self.foo);
}
}
}
frame_support::parameter_types!(
pub const SomeConst: u64 = 10;
pub const BlockHashCount: u32 = 250;
);
impl frame_system::Config for Runtime {
type BlockWeights = ();
type BlockLength = ();
type DbWeight = ();
type BaseCallFilter = ();
type Origin = Origin;
type Index = u64;
type BlockNumber = u32;
type Call = Call;
type Hash = sp_runtime::testing::H256;
type Hashing = sp_runtime::traits::BlakeTwo256;
type AccountId = u64;
type Lookup = sp_runtime::traits::IdentityLookup<Self::AccountId>;
type Header = Header;
type Event = Event;
type BlockHashCount = BlockHashCount;
type Version = ();
type PalletInfo = PalletInfo;
type AccountData = ();
type OnNewAccount = ();
type OnKilledAccount = ();
type SystemWeightInfo = ();
type SS58Prefix = ();
type OnSetCode = ();
}
impl pallet::Config for Runtime {
type Event = Event;
type SomeConst = SomeConst;
type Balance = u64;
}
impl pallet::Config<pallet::Instance2> for Runtime {
type Event = Event;
type SomeConst = SomeConst;
type Balance = u64;
}
impl pallet::Config<pallet::Instance3> for Runtime {
type Event = Event;
type SomeConst = SomeConst;
type Balance = u64;
}
impl pallet_old::Config for Runtime {
type Event = Event;
type SomeConst = SomeConst;
type Balance = u64;
}
impl pallet_old::Config<pallet_old::Instance2> for Runtime {
type Event = Event;
type SomeConst = SomeConst;
type Balance = u64;
}
impl pallet_old::Config<pallet_old::Instance3> for Runtime {
type Event = Event;
type SomeConst = SomeConst;
type Balance = u64;
}
pub type Header = sp_runtime::generic::Header<u32, sp_runtime::traits::BlakeTwo256>;
pub type Block = sp_runtime::generic::Block<Header, UncheckedExtrinsic>;
pub type UncheckedExtrinsic = sp_runtime::generic::UncheckedExtrinsic<u32, Call, (), ()>;
frame_support::construct_runtime!(
pub enum Runtime where
Block = Block,
NodeBlock = Block,
UncheckedExtrinsic = UncheckedExtrinsic
{
System: frame_system::{Pallet, Call, Event<T>},
Example: pallet::{Pallet, Call, Event<T>, Config<T>, Storage},
PalletOld: pallet_old::{Pallet, Call, Event<T>, Config<T>, Storage},
Instance2Example: pallet::<Instance2>::{Pallet, Call, Event<T>, Config<T>, Storage},
PalletOld2: pallet_old::<Instance2>::{Pallet, Call, Event<T>, Config<T>, Storage},
Instance3Example: pallet::<Instance3>::{Pallet, Call, Event<T>, Config<T>, Storage},
PalletOld3: pallet_old::<Instance3>::{Pallet, Call, Event<T>, Config<T>, Storage},
}
);
#[cfg(test)]
mod test {
use super::Runtime;
use super::pallet;
use super::pallet_old;
use codec::{Decode, Encode};
#[test]
fn metadata() {
let metadata = Runtime::metadata();
let modules = match metadata.1 {
frame_metadata::RuntimeMetadata::V13(frame_metadata::RuntimeMetadataV13 {
modules: frame_metadata::DecodeDifferent::Encode(m),
..
}) => m,
_ => unreachable!(),
};
for i in vec![1, 3, 5].into_iter() {
pretty_assertions::assert_eq!(modules[i].storage, modules[i+1].storage);
pretty_assertions::assert_eq!(modules[i].calls, modules[i+1].calls);
pretty_assertions::assert_eq!(modules[i].event, modules[i+1].event);
pretty_assertions::assert_eq!(modules[i].constants, modules[i+1].constants);
pretty_assertions::assert_eq!(modules[i].errors, modules[i+1].errors);
}
}
#[test]
fn types() {
assert_eq!(
pallet_old::Event::<Runtime>::decode(
&mut &pallet::Event::<Runtime>::Dummy(10).encode()[..]
).unwrap(),
pallet_old::Event::<Runtime>::Dummy(10),
);
assert_eq!(
pallet_old::Call::<Runtime>::decode(
&mut &pallet::Call::<Runtime>::set_dummy(10).encode()[..]
).unwrap(),
pallet_old::Call::<Runtime>::set_dummy(10),
);
}
}