Storage Layer for All FRAME Extrinsics (#11431)

* add new trait * implement DispatchableWithStorageLayer * at least one transactional * all dispatch is at least transactional * storage_layer api * add test * storage layer tests * deprecate transactional tag * i guess no reason to deprecate * remove transactional from batch_all * update tests * extend trait * cargo run --quiet --profile=production --features runtime-benchmarks --manifest-path bin/node/cli/Cargo.toml -- benchmark pallet --chain=dev --steps=50 --repeat=20 --pallet=pallet_balances --extrinsic=* --execution=wasm --wasm-execution=compiled --output=./frame/balances/src/weights.rs --template=./.maintain/frame-weight-template.hbs * cargo run --quiet --profile=production --features runtime-benchmarks --manifest-path bin/node/cli/Cargo.toml -- benchmark pallet --chain=dev --steps=50 --repeat=20 --pallet=pallet_balances --extrinsic=* --execution=wasm --wasm-execution=compiled --output=./frame/balances/src/weights.rs --template=./.maintain/frame-weight-template.hbs * cargo run --quiet --profile=production --features runtime-benchmarks --manifest-path bin/node/cli/Cargo.toml -- benchmark pallet --chain=dev --steps=50 --repeat=20 --pallet=pallet_staking --extrinsic=* --execution=wasm --wasm-execution=compiled --output=./frame/staking/src/weights.rs --template=./.maintain/frame-weight-template.hbs * fix copy paste name * cargo run --quiet --profile=production --features runtime-benchmarks --manifest-path bin/node/cli/Cargo.toml -- benchmark pallet --chain=dev --steps=50 --repeat=20 --pallet=pallet_utility --extrinsic=* --execution=wasm --wasm-execution=compiled --output=./frame/utility/src/weights.rs --template=./.maintain/frame-weight-template.hbs * Create run_all_benchmarks.sh * uncomment build * update number of steps and repeats * add skip build * Update run_all_benchmarks.sh * Update run_all_benchmarks.sh * new benchmarks * Update frame/support/src/traits/dispatch.rs Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com> * Update frame/support/src/traits/dispatch.rs Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com> * Update frame/support/test/tests/storage_layers.rs Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com> * Update frame/support/test/tests/storage_layers.rs * weights * Update dispatch.rs * doc link * decl_macro support Co-authored-by: Parity Bot <admin@parity.io> Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com>
2026-04-26 23:57:56 +00:00 · 2022-05-26 15:28:32 -04:00
parent ea469886f8
commit 8e7adaf283
52 changed files with 1741 additions and 1355 deletions
@@ -205,8 +205,7 @@ pub mod pallet {

 		/// Doc comment put in metadata
 		#[pallet::weight(1)]
-		#[frame_support::transactional]
-		pub fn foo_transactional(
+		pub fn foo_storage_layer(
 			_origin: OriginFor<T>,
 			#[pallet::compact] foo: u32,
 		) -> DispatchResultWithPostInfo {
@@ -373,7 +372,7 @@ pub mod pallet {
 		fn validate_unsigned(_source: TransactionSource, call: &Self::Call) -> TransactionValidity {
 			let _ = T::AccountId::from(SomeType1); // Test for where clause
 			let _ = T::AccountId::from(SomeType5); // Test for where clause
-			if matches!(call, Call::foo_transactional { .. }) {
+			if matches!(call, Call::foo_storage_layer { .. }) {
 				return Ok(ValidTransaction::default())
 			}
 			Err(TransactionValidityError::Invalid(InvalidTransaction::Call))
@@ -611,13 +610,13 @@ fn transactional_works() {
 	TestExternalities::default().execute_with(|| {
 		frame_system::Pallet::<Runtime>::set_block_number(1);

-		pallet::Call::<Runtime>::foo_transactional { foo: 0 }
+		pallet::Call::<Runtime>::foo_storage_layer { foo: 0 }
 			.dispatch_bypass_filter(None.into())
 			.err()
 			.unwrap();
 		assert!(frame_system::Pallet::<Runtime>::events().is_empty());

-		pallet::Call::<Runtime>::foo_transactional { foo: 1 }
+		pallet::Call::<Runtime>::foo_storage_layer { foo: 1 }
 			.dispatch_bypass_filter(None.into())
 			.unwrap();
 		assert_eq!(
@@ -640,7 +639,7 @@ fn call_expand() {
 	assert_eq!(call_foo.get_call_name(), "foo");
 	assert_eq!(
 		pallet::Call::<Runtime>::get_call_names(),
-		&["foo", "foo_transactional", "foo_no_post_info"],
+		&["foo", "foo_storage_layer", "foo_no_post_info"],
 	);
 }

@@ -744,7 +743,7 @@ fn inherent_expand() {
 			Digest::default(),
 		),
 		vec![UncheckedExtrinsic {
-			function: Call::Example(pallet::Call::foo_transactional { foo: 0 }),
+			function: Call::Example(pallet::Call::foo_storage_layer { foo: 0 }),
 			signature: None,
 		}],
 	);
@@ -785,7 +784,7 @@ fn inherent_expand() {
 				signature: None,
 			},
 			UncheckedExtrinsic {
-				function: Call::Example(pallet::Call::foo_transactional { foo: 0 }),
+				function: Call::Example(pallet::Call::foo_storage_layer { foo: 0 }),
 				signature: None,
 			},
 		],
@@ -807,7 +806,7 @@ fn inherent_expand() {
 				signature: None,
 			},
 			UncheckedExtrinsic {
-				function: Call::Example(pallet::Call::foo_transactional { foo: 0 }),
+				function: Call::Example(pallet::Call::foo_storage_layer { foo: 0 }),
 				signature: None,
 			},
 			UncheckedExtrinsic {
@@ -857,7 +856,7 @@ fn validate_unsigned_expand() {
 	let validity = pallet::Pallet::validate_unsigned(TransactionSource::Local, &call).unwrap_err();
 	assert_eq!(validity, TransactionValidityError::Invalid(InvalidTransaction::Call));

-	let call = pallet::Call::<Runtime>::foo_transactional { foo: 0 };
+	let call = pallet::Call::<Runtime>::foo_storage_layer { foo: 0 };

 	let validity = pallet::Pallet::validate_unsigned(TransactionSource::External, &call).unwrap();
 	assert_eq!(validity, ValidTransaction::default());
@@ -93,8 +93,7 @@ pub mod pallet {

 		/// Doc comment put in metadata
 		#[pallet::weight(1)]
-		#[frame_support::transactional]
-		pub fn foo_transactional(
+		pub fn foo_storage_layer(
 			origin: OriginFor<T>,
 			#[pallet::compact] _foo: u32,
 		) -> DispatchResultWithPostInfo {
@@ -316,7 +315,7 @@ fn call_expand() {
 		DispatchInfo { weight: 3, class: DispatchClass::Normal, pays_fee: Pays::Yes }
 	);
 	assert_eq!(call_foo.get_call_name(), "foo");
-	assert_eq!(pallet::Call::<Runtime>::get_call_names(), &["foo", "foo_transactional"]);
+	assert_eq!(pallet::Call::<Runtime>::get_call_names(), &["foo", "foo_storage_layer"]);

 	let call_foo = pallet::Call::<Runtime, pallet::Instance1>::foo { foo: 3 };
 	assert_eq!(
@@ -326,7 +325,7 @@ fn call_expand() {
 	assert_eq!(call_foo.get_call_name(), "foo");
 	assert_eq!(
 		pallet::Call::<Runtime, pallet::Instance1>::get_call_names(),
-		&["foo", "foo_transactional"],
+		&["foo", "foo_storage_layer"],
 	);
 }

@@ -0,0 +1,280 @@
+// This file is part of Substrate.
+
+// Copyright (C) 2022 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.
+
+use frame_support::{
+	assert_noop, assert_ok, dispatch::DispatchResult, pallet_prelude::ConstU32,
+	storage::with_storage_layer,
+};
+use pallet::*;
+use sp_io::TestExternalities;
+
+#[frame_support::pallet]
+pub mod pallet {
+	use frame_support::{ensure, pallet_prelude::*};
+	use frame_system::pallet_prelude::*;
+
+	#[pallet::pallet]
+	pub struct Pallet<T>(_);
+
+	#[pallet::config]
+	pub trait Config: frame_system::Config {}
+
+	#[pallet::storage]
+	pub type Value<T> = StorageValue<_, u32, ValueQuery>;
+
+	#[pallet::storage]
+	pub type Map<T> = StorageMap<_, Blake2_128Concat, u32, u32, ValueQuery>;
+
+	#[pallet::error]
+	pub enum Error<T> {
+		Revert,
+	}
+
+	#[pallet::call]
+	impl<T: Config> Pallet<T> {
+		#[pallet::weight(1)]
+		pub fn set_value(_origin: OriginFor<T>, value: u32) -> DispatchResult {
+			Value::<T>::put(value);
+			ensure!(value != 1, Error::<T>::Revert);
+			Ok(())
+		}
+	}
+}
+
+pub mod decl_pallet {
+	pub trait Config: frame_system::Config {}
+
+	frame_support::decl_module! {
+		pub struct Module<T: Config> for enum Call where origin: T::Origin {
+			#[weight = 0]
+			pub fn set_value(_origin, value: u32) {
+				DeclValue::put(value);
+				frame_support::ensure!(value != 1, "Revert!");
+			}
+		}
+	}
+
+	frame_support::decl_storage! {
+		trait Store for Module<T: Config> as StorageTransactions {
+			pub DeclValue: u32;
+		}
+	}
+}
+
+pub type BlockNumber = u64;
+pub type Index = 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, (), ()>;
+
+impl frame_system::Config for Runtime {
+	type BlockWeights = ();
+	type BlockLength = ();
+	type DbWeight = ();
+	type BaseCallFilter = frame_support::traits::Everything;
+	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 = ConstU32<250>;
+	type Version = ();
+	type PalletInfo = PalletInfo;
+	type AccountData = ();
+	type OnNewAccount = ();
+	type OnKilledAccount = ();
+	type SystemWeightInfo = ();
+	type SS58Prefix = ();
+	type OnSetCode = ();
+	type MaxConsumers = ConstU32<16>;
+}
+
+impl pallet::Config for Runtime {}
+
+impl decl_pallet::Config for Runtime {}
+
+frame_support::construct_runtime!(
+	pub enum Runtime where
+		Block = Block,
+		NodeBlock = Block,
+		UncheckedExtrinsic = UncheckedExtrinsic
+	{
+		System: frame_system,
+		MyPallet: pallet,
+		DeclPallet: decl_pallet::{Call, Storage},
+	}
+);
+
+#[test]
+fn storage_layer_basic_commit() {
+	TestExternalities::default().execute_with(|| {
+		assert_eq!(Value::<Runtime>::get(), 0);
+		assert!(!Map::<Runtime>::contains_key(0));
+
+		assert_ok!(with_storage_layer(|| -> DispatchResult {
+			Value::<Runtime>::set(99);
+			Map::<Runtime>::insert(0, 99);
+			assert_eq!(Value::<Runtime>::get(), 99);
+			assert_eq!(Map::<Runtime>::get(0), 99);
+			Ok(())
+		}));
+
+		assert_eq!(Value::<Runtime>::get(), 99);
+		assert_eq!(Map::<Runtime>::get(0), 99);
+	});
+}
+
+#[test]
+fn storage_layer_basic_rollback() {
+	TestExternalities::default().execute_with(|| {
+		assert_eq!(Value::<Runtime>::get(), 0);
+		assert_eq!(Map::<Runtime>::get(0), 0);
+
+		assert_noop!(
+			with_storage_layer(|| -> DispatchResult {
+				Value::<Runtime>::set(99);
+				Map::<Runtime>::insert(0, 99);
+				assert_eq!(Value::<Runtime>::get(), 99);
+				assert_eq!(Map::<Runtime>::get(0), 99);
+				Err("revert".into())
+			}),
+			"revert"
+		);
+
+		assert_eq!(Value::<Runtime>::get(), 0);
+		assert_eq!(Map::<Runtime>::get(0), 0);
+	});
+}
+
+#[test]
+fn storage_layer_rollback_then_commit() {
+	TestExternalities::default().execute_with(|| {
+		Value::<Runtime>::set(1);
+		Map::<Runtime>::insert(1, 1);
+
+		assert_ok!(with_storage_layer(|| -> DispatchResult {
+			Value::<Runtime>::set(2);
+			Map::<Runtime>::insert(1, 2);
+			Map::<Runtime>::insert(2, 2);
+
+			assert_noop!(
+				with_storage_layer(|| -> DispatchResult {
+					Value::<Runtime>::set(3);
+					Map::<Runtime>::insert(1, 3);
+					Map::<Runtime>::insert(2, 3);
+					Map::<Runtime>::insert(3, 3);
+
+					assert_eq!(Value::<Runtime>::get(), 3);
+					assert_eq!(Map::<Runtime>::get(1), 3);
+					assert_eq!(Map::<Runtime>::get(2), 3);
+					assert_eq!(Map::<Runtime>::get(3), 3);
+
+					Err("revert".into())
+				}),
+				"revert"
+			);
+
+			assert_eq!(Value::<Runtime>::get(), 2);
+			assert_eq!(Map::<Runtime>::get(1), 2);
+			assert_eq!(Map::<Runtime>::get(2), 2);
+			assert_eq!(Map::<Runtime>::get(3), 0);
+
+			Ok(())
+		}));
+
+		assert_eq!(Value::<Runtime>::get(), 2);
+		assert_eq!(Map::<Runtime>::get(1), 2);
+		assert_eq!(Map::<Runtime>::get(2), 2);
+		assert_eq!(Map::<Runtime>::get(3), 0);
+	});
+}
+
+#[test]
+fn storage_layer_commit_then_rollback() {
+	TestExternalities::default().execute_with(|| {
+		Value::<Runtime>::set(1);
+		Map::<Runtime>::insert(1, 1);
+
+		assert_noop!(
+			with_storage_layer(|| -> DispatchResult {
+				Value::<Runtime>::set(2);
+				Map::<Runtime>::insert(1, 2);
+				Map::<Runtime>::insert(2, 2);
+
+				assert_ok!(with_storage_layer(|| -> DispatchResult {
+					Value::<Runtime>::set(3);
+					Map::<Runtime>::insert(1, 3);
+					Map::<Runtime>::insert(2, 3);
+					Map::<Runtime>::insert(3, 3);
+
+					assert_eq!(Value::<Runtime>::get(), 3);
+					assert_eq!(Map::<Runtime>::get(1), 3);
+					assert_eq!(Map::<Runtime>::get(2), 3);
+					assert_eq!(Map::<Runtime>::get(3), 3);
+
+					Ok(())
+				}));
+
+				assert_eq!(Value::<Runtime>::get(), 3);
+				assert_eq!(Map::<Runtime>::get(1), 3);
+				assert_eq!(Map::<Runtime>::get(2), 3);
+				assert_eq!(Map::<Runtime>::get(3), 3);
+
+				Err("revert".into())
+			}),
+			"revert"
+		);
+
+		assert_eq!(Value::<Runtime>::get(), 1);
+		assert_eq!(Map::<Runtime>::get(1), 1);
+		assert_eq!(Map::<Runtime>::get(2), 0);
+		assert_eq!(Map::<Runtime>::get(3), 0);
+	});
+}
+
+#[test]
+fn storage_layer_in_pallet_call() {
+	TestExternalities::default().execute_with(|| {
+		use sp_runtime::traits::Dispatchable;
+		let call1 = Call::MyPallet(pallet::Call::set_value { value: 2 });
+		assert_ok!(call1.dispatch(Origin::signed(0)));
+		assert_eq!(Value::<Runtime>::get(), 2);
+
+		let call2 = Call::MyPallet(pallet::Call::set_value { value: 1 });
+		assert_noop!(call2.dispatch(Origin::signed(0)), Error::<Runtime>::Revert);
+	});
+}
+
+#[test]
+fn storage_layer_in_decl_pallet_call() {
+	TestExternalities::default().execute_with(|| {
+		use frame_support::StorageValue;
+		use sp_runtime::traits::Dispatchable;
+
+		let call1 = Call::DeclPallet(decl_pallet::Call::set_value { value: 2 });
+		assert_ok!(call1.dispatch(Origin::signed(0)));
+		assert_eq!(decl_pallet::DeclValue::get(), 2);
+
+		let call2 = Call::DeclPallet(decl_pallet::Call::set_value { value: 1 });
+		assert_noop!(call2.dispatch(Origin::signed(0)), "Revert!");
+	});
+}