// This file is part of Substrate. // Copyright (C) 2019-2020 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. #![recursion_limit="128"] use codec::{Codec, EncodeLike, Encode, Decode}; use sp_runtime::{generic, BuildStorage, traits::{BlakeTwo256, Block as _, Verify}}; use frame_support::{ Parameter, traits::Get, parameter_types, metadata::{ DecodeDifferent, StorageMetadata, StorageEntryModifier, StorageEntryType, DefaultByteGetter, StorageEntryMetadata, StorageHasher, }, StorageValue, StorageMap, StorageDoubleMap, }; use sp_inherents::{ProvideInherent, InherentData, InherentIdentifier, MakeFatalError}; use sp_core::{H256, sr25519}; mod system; pub trait Currency {} // Test for: // * No default instance // * Custom InstantiableTrait // * Origin, Inherent, Event mod module1 { use super::*; pub trait Trait: system::Trait where ::BlockNumber: From { type Event: From> + Into<::Event>; type Origin: From>; type SomeParameter: Get; type GenericType: Default + Clone + Codec + EncodeLike; } frame_support::decl_module! { pub struct Module, I: InstantiableThing> for enum Call where origin: ::Origin, system = system, T::BlockNumber: From { fn offchain_worker() {} fn deposit_event() = default; #[weight = 0] fn one(origin) { system::ensure_root(origin)?; Self::deposit_event(RawEvent::AnotherVariant(3)); } } } frame_support::decl_storage! { trait Store for Module, I: InstantiableThing> as Module1 where T::BlockNumber: From + std::fmt::Display { pub Value config(value): T::GenericType; pub Map: map hasher(identity) u32 => u64; } add_extra_genesis { config(test) : T::BlockNumber; build(|config: &Self| { println!("{}", config.test); }); } } frame_support::decl_event! { pub enum Event where Phantom = std::marker::PhantomData { _Phantom(Phantom), AnotherVariant(u32), } } #[derive(PartialEq, Eq, Clone, sp_runtime::RuntimeDebug, Encode, Decode)] pub enum Origin, I> where T::BlockNumber: From { Members(u32), _Phantom(std::marker::PhantomData<(T, I)>), } pub const INHERENT_IDENTIFIER: InherentIdentifier = *b"12345678"; impl, I: InstantiableThing> ProvideInherent for Module where T::BlockNumber: From { type Call = Call; type Error = MakeFatalError; const INHERENT_IDENTIFIER: InherentIdentifier = INHERENT_IDENTIFIER; fn create_inherent(_data: &InherentData) -> Option { unimplemented!(); } fn check_inherent(_: &Self::Call, _: &InherentData) -> std::result::Result<(), Self::Error> { unimplemented!(); } } } // Test for: // * default instance // * use of no_genesis_config_phantom_data mod module2 { use super::*; pub trait Trait: system::Trait { type Amount: Parameter + Default; type Event: From> + Into<::Event>; type Origin: From>; } impl, I: Instance> Currency for Module {} frame_support::decl_module! { pub struct Module, I: Instance=DefaultInstance> for enum Call where origin: ::Origin, system = system { fn deposit_event() = default; } } frame_support::decl_storage! { trait Store for Module, I: Instance=DefaultInstance> as Module2 { pub Value config(value): T::Amount; pub Map config(map): map hasher(identity) u64 => u64; pub DoubleMap config(double_map): double_map hasher(identity) u64, hasher(identity) u64 => u64; } } frame_support::decl_event! { pub enum Event where Amount = >::Amount { Variant(Amount), } } #[derive(PartialEq, Eq, Clone, sp_runtime::RuntimeDebug, Encode, Decode)] pub enum Origin, I=DefaultInstance> { Members(u32), _Phantom(std::marker::PhantomData<(T, I)>), } pub const INHERENT_IDENTIFIER: InherentIdentifier = *b"12345678"; impl, I: Instance> ProvideInherent for Module { type Call = Call; type Error = MakeFatalError; const INHERENT_IDENTIFIER: InherentIdentifier = INHERENT_IDENTIFIER; fn create_inherent(_data: &InherentData) -> Option { unimplemented!(); } fn check_inherent(_call: &Self::Call, _data: &InherentData) -> std::result::Result<(), Self::Error> { unimplemented!(); } } } // Test for: // * Depends on multiple instances of a module with instances mod module3 { use super::*; pub trait Trait: module2::Trait + module2::Trait + system::Trait { type Currency: Currency; type Currency2: Currency; } frame_support::decl_module! { pub struct Module for enum Call where origin: ::Origin {} } } parameter_types! { pub const SomeValue: u32 = 100; } impl module1::Trait for Runtime { type Event = Event; type Origin = Origin; type SomeParameter = SomeValue; type GenericType = u32; } impl module1::Trait for Runtime { type Event = Event; type Origin = Origin; type SomeParameter = SomeValue; type GenericType = u32; } impl module2::Trait for Runtime { type Amount = u16; type Event = Event; type Origin = Origin; } impl module2::Trait for Runtime { type Amount = u32; type Event = Event; type Origin = Origin; } impl module2::Trait for Runtime { type Amount = u32; type Event = Event; type Origin = Origin; } impl module2::Trait for Runtime { type Amount = u64; type Event = Event; type Origin = Origin; } impl module3::Trait for Runtime { type Currency = Module2_2; type Currency2 = Module2_3; } pub type Signature = sr25519::Signature; pub type AccountId = ::Signer; pub type BlockNumber = u64; pub type Index = u64; impl system::Trait for Runtime { type BaseCallFilter= (); type Hash = H256; type Origin = Origin; type BlockNumber = BlockNumber; type AccountId = AccountId; type Event = Event; type ModuleToIndex = (); type Call = Call; } frame_support::construct_runtime!( pub enum Runtime where Block = Block, NodeBlock = Block, UncheckedExtrinsic = UncheckedExtrinsic { System: system::{Module, Call, Event}, Module1_1: module1::::{ Module, Call, Storage, Event, Config, Origin, Inherent }, Module1_2: module1::::{ Module, Call, Storage, Event, Config, Origin, Inherent }, Module2: module2::{Module, Call, Storage, Event, Config, Origin, Inherent}, Module2_1: module2::::{ Module, Call, Storage, Event, Config, Origin, Inherent }, Module2_2: module2::::{ Module, Call, Storage, Event, Config, Origin, Inherent }, Module2_3: module2::::{ Module, Call, Storage, Event, Config, Origin, Inherent }, Module3: module3::{Module, Call}, } ); pub type Header = generic::Header; pub type Block = generic::Block; pub type UncheckedExtrinsic = generic::UncheckedExtrinsic; fn new_test_ext() -> sp_io::TestExternalities { GenesisConfig{ module1_Instance1: Some(module1::GenesisConfig { value: 3, test: 2, }), module1_Instance2: Some(module1::GenesisConfig { value: 4, test: 5, }), module2: Some(module2::GenesisConfig { value: 4, map: vec![(0, 0)], double_map: vec![(0, 0, 0)], }), module2_Instance1: Some(module2::GenesisConfig { value: 4, map: vec![(0, 0)], double_map: vec![(0, 0, 0)], }), module2_Instance2: None, module2_Instance3: None, }.build_storage().unwrap().into() } #[test] fn storage_instance_independence() { let mut storage = sp_core::storage::Storage { top: std::collections::BTreeMap::new(), children_default: std::collections::HashMap::new() }; sp_state_machine::BasicExternalities::execute_with_storage(&mut storage, || { module2::Value::::put(0); module2::Value::::put(0); module2::Value::::put(0); module2::Value::::put(0); module2::Map::::insert(0, 0); module2::Map::::insert(0, 0); module2::Map::::insert(0, 0); module2::Map::::insert(0, 0); module2::DoubleMap::::insert(&0, &0, &0); module2::DoubleMap::::insert(&0, &0, &0); module2::DoubleMap::::insert(&0, &0, &0); module2::DoubleMap::::insert(&0, &0, &0); }); // 12 storage values. assert_eq!(storage.top.len(), 12); } #[test] fn storage_with_instance_basic_operation() { new_test_ext().execute_with(|| { type Value = module2::Value; type Map = module2::Map; type DoubleMap = module2::DoubleMap; assert_eq!(Value::exists(), true); assert_eq!(Value::get(), 4); Value::put(1); assert_eq!(Value::get(), 1); assert_eq!(Value::take(), 1); assert_eq!(Value::get(), 0); Value::mutate(|a| *a=2); assert_eq!(Value::get(), 2); Value::kill(); assert_eq!(Value::exists(), false); assert_eq!(Value::get(), 0); let key = 1; assert_eq!(Map::contains_key(0), true); assert_eq!(Map::contains_key(key), false); Map::insert(key, 1); assert_eq!(Map::get(key), 1); assert_eq!(Map::take(key), 1); assert_eq!(Map::get(key), 0); Map::mutate(key, |a| *a=2); assert_eq!(Map::get(key), 2); Map::remove(key); assert_eq!(Map::contains_key(key), false); assert_eq!(Map::get(key), 0); let key1 = 1; let key2 = 1; assert_eq!(DoubleMap::contains_key(&0, &0), true); assert_eq!(DoubleMap::contains_key(&key1, &key2), false); DoubleMap::insert(&key1, &key2, &1); assert_eq!(DoubleMap::get(&key1, &key2), 1); assert_eq!(DoubleMap::take(&key1, &key2), 1); assert_eq!(DoubleMap::get(&key1, &key2), 0); DoubleMap::mutate(&key1, &key2, |a| *a=2); assert_eq!(DoubleMap::get(&key1, &key2), 2); DoubleMap::remove(&key1, &key2); assert_eq!(DoubleMap::get(&key1, &key2), 0); }); } const EXPECTED_METADATA: StorageMetadata = StorageMetadata { prefix: DecodeDifferent::Encode("Instance2Module2"), entries: DecodeDifferent::Encode( &[ StorageEntryMetadata { name: DecodeDifferent::Encode("Value"), modifier: StorageEntryModifier::Default, ty: StorageEntryType::Plain(DecodeDifferent::Encode("T::Amount")), default: DecodeDifferent::Encode( DefaultByteGetter( &module2::__GetByteStructValue( std::marker::PhantomData::<(Runtime, module2::Instance2)> ) ) ), documentation: DecodeDifferent::Encode(&[]), }, StorageEntryMetadata { name: DecodeDifferent::Encode("Map"), modifier: StorageEntryModifier::Default, ty: StorageEntryType::Map { hasher: StorageHasher::Identity, key: DecodeDifferent::Encode("u64"), value: DecodeDifferent::Encode("u64"), unused: false, }, default: DecodeDifferent::Encode( DefaultByteGetter( &module2::__GetByteStructMap( std::marker::PhantomData::<(Runtime, module2::Instance2)> ) ) ), documentation: DecodeDifferent::Encode(&[]), }, StorageEntryMetadata { name: DecodeDifferent::Encode("DoubleMap"), modifier: StorageEntryModifier::Default, ty: StorageEntryType::DoubleMap { hasher: StorageHasher::Identity, key2_hasher: StorageHasher::Identity, key1: DecodeDifferent::Encode("u64"), key2: DecodeDifferent::Encode("u64"), value: DecodeDifferent::Encode("u64"), }, default: DecodeDifferent::Encode( DefaultByteGetter( &module2::__GetByteStructDoubleMap( std::marker::PhantomData::<(Runtime, module2::Instance2)> ) ) ), documentation: DecodeDifferent::Encode(&[]), } ] ) }; #[test] fn test_instance_storage_metadata() { let metadata = Module2_2::storage_metadata(); pretty_assertions::assert_eq!(EXPECTED_METADATA, metadata); }