git.delta.rocks / unique-network / refs/commits / 1ae086c66ec9

difftreelog

fix(preimage-execution) introduce weight expectation + adjust benchmarks + new tests

Fahrrader2023-02-22parent: #23641e0.patch.diff
in: master

6 files changed

modifiedpallets/maintenance/src/benchmarking.rsdiffbeforeafterboth
--- a/pallets/maintenance/src/benchmarking.rs
+++ b/pallets/maintenance/src/benchmarking.rs
@@ -19,7 +19,7 @@
 
 use frame_benchmarking::benchmarks;
 use frame_system::{Call as RuntimeCall, RawOrigin};
-use frame_support::{ensure, traits::StorePreimage};
+use frame_support::{ensure, pallet_prelude::Weight, traits::StorePreimage};
 use codec::Encode;
 use sp_std::vec;
 
@@ -40,7 +40,7 @@
 	execute_preimage {
 		let call_hash = RuntimeCall::<T>::set_storage { items: vec![] }.encode();
 		let hash = T::Preimages::note(call_hash.into())?;
-	}: _(RawOrigin::Root, hash)
+	}: _(RawOrigin::Root, hash, None, Weight::from_parts(100000000000, 100000000000))
 	verify {
 	}
 }
modifiedpallets/maintenance/src/lib.rsdiffbeforeafterboth
before · pallets/maintenance/src/lib.rs
1// Copyright 2019-2022 Unique Network (Gibraltar) Ltd.2// This file is part of Unique Network.34// Unique Network is free software: you can redistribute it and/or modify5// it under the terms of the GNU General Public License as published by6// the Free Software Foundation, either version 3 of the License, or7// (at your option) any later version.89// Unique Network is distributed in the hope that it will be useful,10// but WITHOUT ANY WARRANTY; without even the implied warranty of11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the12// GNU General Public License for more details.1314// You should have received a copy of the GNU General Public License15// along with Unique Network. If not, see <http://www.gnu.org/licenses/>.1617#![cfg_attr(not(feature = "std"), no_std)]1819pub use pallet::*;2021#[cfg(feature = "runtime-benchmarks")]22pub mod benchmarking;2324pub mod weights;2526#[frame_support::pallet]27pub mod pallet {28	use frame_support::{dispatch::*, pallet_prelude::*};29	use frame_support::{30		traits::{QueryPreimage, StorePreimage},31	};32	use frame_system::pallet_prelude::*;33	use sp_core::H256;3435	use crate::weights::WeightInfo;3637	#[pallet::config]38	pub trait Config: frame_system::Config {39		/// The overarching event type.40		type RuntimeEvent: From<Event<Self>> + IsType<<Self as frame_system::Config>::RuntimeEvent>;4142		/// The runtime origin type.43		type RuntimeOrigin: From<RawOrigin<Self::AccountId>>44			+ IsType<<Self as frame_system::Config>::RuntimeOrigin>;4546		/// The aggregated call type.47		type RuntimeCall: Parameter48			+ Dispatchable<49				RuntimeOrigin = <Self as Config>::RuntimeOrigin,50				PostInfo = PostDispatchInfo,51			> + GetDispatchInfo52			+ From<frame_system::Call<Self>>;5354		/// The preimage provider with which we look up call hashes to get the call.55		type Preimages: QueryPreimage + StorePreimage;5657		/// Weight information for extrinsics in this pallet.58		type WeightInfo: WeightInfo;59	}6061	#[pallet::event]62	#[pallet::generate_deposit(pub(super) fn deposit_event)]63	pub enum Event<T: Config> {64		MaintenanceEnabled,65		MaintenanceDisabled,66	}6768	#[pallet::pallet]69	#[pallet::generate_store(pub(super) trait Store)]70	pub struct Pallet<T>(_);7172	#[pallet::storage]73	#[pallet::getter(fn is_enabled)]74	pub type Enabled<T> = StorageValue<_, bool, ValueQuery>;7576	#[pallet::error]77	pub enum Error<T> {}7879	#[pallet::call]80	impl<T: Config> Pallet<T> {81		#[pallet::call_index(0)]82		#[pallet::weight(<T as Config>::WeightInfo::enable())]83		pub fn enable(origin: OriginFor<T>) -> DispatchResult {84			ensure_root(origin)?;8586			<Enabled<T>>::set(true);8788			Self::deposit_event(Event::MaintenanceEnabled);8990			Ok(())91		}9293		#[pallet::call_index(1)]94		#[pallet::weight(<T as Config>::WeightInfo::disable())]95		pub fn disable(origin: OriginFor<T>) -> DispatchResult {96			ensure_root(origin)?;9798			<Enabled<T>>::set(false);99100			Self::deposit_event(Event::MaintenanceDisabled);101102			Ok(())103		}104105		#[pallet::call_index(2)]106		#[pallet::weight(<T as Config>::WeightInfo::execute_preimage())]107		pub fn execute_preimage(_origin: OriginFor<T>, _hash: H256) -> DispatchResult {108			#[cfg(feature = "preimage")]109			{110				let origin = _origin;111				let hash = _hash;112113				ensure_root(origin)?;114115				let len = T::Preimages::len(&hash).ok_or(DispatchError::Unavailable)?;116				let bounded = T::Preimages::pick::<<T as Config>::RuntimeCall>(hash, len);117				let (call, _) =118					T::Preimages::realize(&bounded).map_err(|_| DispatchError::Unavailable)?;119120				let result = match call.dispatch(frame_system::RawOrigin::Root.into()) {121					Ok(_) => Ok(()),122					Err(error_and_info) => Err(error_and_info.error),123				};124125				result126			}127128			#[cfg(not(feature = "preimage"))]129			{130				Err(DispatchError::Unavailable)131			}132		}133	}134}
after · pallets/maintenance/src/lib.rs
1// Copyright 2019-2022 Unique Network (Gibraltar) Ltd.2// This file is part of Unique Network.34// Unique Network is free software: you can redistribute it and/or modify5// it under the terms of the GNU General Public License as published by6// the Free Software Foundation, either version 3 of the License, or7// (at your option) any later version.89// Unique Network is distributed in the hope that it will be useful,10// but WITHOUT ANY WARRANTY; without even the implied warranty of11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the12// GNU General Public License for more details.1314// You should have received a copy of the GNU General Public License15// along with Unique Network. If not, see <http://www.gnu.org/licenses/>.1617#![cfg_attr(not(feature = "std"), no_std)]1819pub use pallet::*;2021#[cfg(feature = "runtime-benchmarks")]22pub mod benchmarking;2324pub mod weights;2526#[frame_support::pallet]27pub mod pallet {28	use frame_support::{dispatch::*, pallet_prelude::*};29	use frame_support::{30		traits::{QueryPreimage, StorePreimage},31	};32	use frame_system::pallet_prelude::*;33	use sp_core::H256;3435	use crate::weights::WeightInfo;3637	#[pallet::config]38	pub trait Config: frame_system::Config {39		/// The overarching event type.40		type RuntimeEvent: From<Event<Self>> + IsType<<Self as frame_system::Config>::RuntimeEvent>;4142		/// The runtime origin type.43		type RuntimeOrigin: From<RawOrigin<Self::AccountId>>44			+ IsType<<Self as frame_system::Config>::RuntimeOrigin>;4546		/// The aggregated call type.47		type RuntimeCall: Parameter48			+ Dispatchable<49				RuntimeOrigin = <Self as Config>::RuntimeOrigin,50				PostInfo = PostDispatchInfo,51			> + GetDispatchInfo52			+ From<frame_system::Call<Self>>;5354		/// The preimage provider with which we look up call hashes to get the call.55		type Preimages: QueryPreimage + StorePreimage;5657		/// Weight information for extrinsics in this pallet.58		type WeightInfo: WeightInfo;59	}6061	#[pallet::event]62	#[pallet::generate_deposit(pub(super) fn deposit_event)]63	pub enum Event<T: Config> {64		MaintenanceEnabled,65		MaintenanceDisabled,66	}6768	#[pallet::pallet]69	#[pallet::generate_store(pub(super) trait Store)]70	pub struct Pallet<T>(_);7172	#[pallet::storage]73	#[pallet::getter(fn is_enabled)]74	pub type Enabled<T> = StorageValue<_, bool, ValueQuery>;7576	#[pallet::error]77	pub enum Error<T> {}7879	#[pallet::call]80	impl<T: Config> Pallet<T> {81		#[pallet::call_index(0)]82		#[pallet::weight(<T as Config>::WeightInfo::enable())]83		pub fn enable(origin: OriginFor<T>) -> DispatchResult {84			ensure_root(origin)?;8586			<Enabled<T>>::set(true);8788			Self::deposit_event(Event::MaintenanceEnabled);8990			Ok(())91		}9293		#[pallet::call_index(1)]94		#[pallet::weight(<T as Config>::WeightInfo::disable())]95		pub fn disable(origin: OriginFor<T>) -> DispatchResult {96			ensure_root(origin)?;9798			<Enabled<T>>::set(false);99100			Self::deposit_event(Event::MaintenanceDisabled);101102			Ok(())103		}104105		#[pallet::call_index(2)]106		#[pallet::weight(<T as Config>::WeightInfo::execute_preimage())]107		pub fn execute_preimage(108			origin: OriginFor<T>,109			hash: H256,110			preimage_length: Option<u32>,111			weight_bound: Weight,112		) -> DispatchResultWithPostInfo {113			use codec::Decode;114115			ensure_root(origin)?;116117			let data = T::Preimages::fetch(&hash, preimage_length)?;118			weight_bound.set_proof_size(119				weight_bound120					.proof_size()121					.checked_sub(122						data.len()123							.try_into()124							.map_err(|_| DispatchError::Corruption)?,125					)126					.ok_or(DispatchError::Exhausted)?,127			);128129			let call = <T as Config>::RuntimeCall::decode(&mut &data[..])130				.map_err(|_| DispatchError::Corruption)?;131132			ensure!(133				call.get_dispatch_info().weight.all_lte(weight_bound),134				DispatchError::Exhausted135			);136137			match call.dispatch(frame_system::RawOrigin::Root.into()) {138				Ok(post_info) => Ok(PostDispatchInfo {139					actual_weight: post_info.actual_weight,140					pays_fee: Pays::No,141				}),142				Err(error_and_info) => Err(DispatchErrorWithPostInfo {143					post_info: PostDispatchInfo {144						actual_weight: error_and_info.post_info.actual_weight,145						pays_fee: Pays::No,146					},147					error: error_and_info.error,148				}),149			}150		}151	}152}
modifiedruntime/common/config/pallets/preimage.rsdiffbeforeafterboth
--- a/runtime/common/config/pallets/preimage.rs
+++ b/runtime/common/config/pallets/preimage.rs
@@ -20,8 +20,7 @@
 use up_common::constants::*;
 
 parameter_types! {
-	pub PreimageBaseDeposit: Balance = 1000 * UNIQUE; // deposit(2, 64);
-	// pub PreimageByteDeposit: Balance = 1 * CENTIUNIQUE; // deposit(0, 1);
+	pub PreimageBaseDeposit: Balance = 1000 * UNIQUE;
 }
 
 impl pallet_preimage::Config for Runtime {
modifiedruntime/common/runtime_apis.rsdiffbeforeafterboth
--- a/runtime/common/runtime_apis.rs
+++ b/runtime/common/runtime_apis.rs
@@ -565,9 +565,6 @@
                     #[cfg(feature = "collator-selection")]
                     list_benchmark!(list, extra, pallet_identity, Identity);
 
-                    #[cfg(feature = "preimage")]
-                    list_benchmark!(list, extra, pallet_preimage, Preimage);
-
                     #[cfg(feature = "foreign-assets")]
                     list_benchmark!(list, extra, pallet_foreign_assets, ForeignAssets);
 
@@ -631,9 +628,6 @@
 
                     #[cfg(feature = "collator-selection")]
                     add_benchmark!(params, batches, pallet_identity, Identity);
-
-                    #[cfg(feature = "preimage")]
-                    add_benchmark!(params, batches, pallet_preimage, Preimage);
 
                     #[cfg(feature = "foreign-assets")]
                     add_benchmark!(params, batches, pallet_foreign_assets, ForeignAssets);
modifiedtests/src/maintenance.seqtest.tsdiffbeforeafterboth
--- a/tests/src/maintenance.seqtest.ts
+++ b/tests/src/maintenance.seqtest.ts
@@ -18,6 +18,7 @@
 import {ApiPromise} from '@polkadot/api';
 import {expect, itSched, itSub, Pallets, requirePalletsOrSkip, usingPlaygrounds} from './util';
 import {itEth} from './eth/util';
+import {UniqueHelper} from './util/playgrounds/unique';
 
 async function maintenanceEnabled(api: ApiPromise): Promise<boolean> {
   return (await api.query.maintenance.enabled()).toJSON() as boolean;
@@ -280,6 +281,13 @@
   describe('Preimage Execution', () => {
     let preimageHash: string;
 
+    async function notePreimage(helper: UniqueHelper, preimage: any): Promise<string> {
+      const result = await helper.preimage.notePreimage(bob, preimage);
+      const events = result.result.events.filter(x => x.event.method === 'Noted' && x.event.section === 'preimage');
+      const preimageHash = events[0].event.data[0].toHuman();
+      return preimageHash;
+    }
+
     before(async function() {
       await usingPlaygrounds(async (helper) => {
         requirePalletsOrSkip(this, helper, [Pallets.Preimage, Pallets.Maintenance]);
@@ -298,15 +306,14 @@
           },
         ]);
         const preimage = helper.constructApiCall('api.tx.identity.forceInsertIdentities', [randomIdentities]).method.toHex();
-        const result = await helper.preimage.notePreimage(bob, preimage);
-        const events = result.result.events.filter(x => x.event.method === 'Noted' && x.event.section === 'preimage');
-        preimageHash = events[0].event.data[0].toHuman();
+        preimageHash = await notePreimage(helper, preimage);
       });
     });
 
     itSub('Successfully executes call in a preimage', async ({helper}) => {
-      const result = await expect(helper.getSudo().executeExtrinsic(superuser, 'api.tx.maintenance.executePreimage', [preimageHash]))
-        .to.be.fulfilled;
+      const result = await expect(helper.getSudo().executeExtrinsic(superuser, 'api.tx.maintenance.executePreimage', [
+        preimageHash, null, {refTime: 10000000000, proofSize: 10000000000},
+      ])).to.be.fulfilled;
 
       // preimage is executed, and an appropriate event is present
       const events = result.result.events.filter((x: any) => x.event.method === 'IdentitiesInserted' && x.event.section === 'identity');
@@ -316,17 +323,37 @@
       expect(await helper.preimage.getPreimageInfo(preimageHash)).to.have.property('unrequested');
     });
 
+    itSub('Does not allow execution of a preimage that would fail', async ({helper}) => {
+      const [zeroAccount] = await helper.arrange.createAccounts([0n], superuser);
+
+      const preimage = helper.constructApiCall('api.tx.balances.forceTransfer', [
+        {Id: zeroAccount.address}, {Id: superuser.address}, 1000n,
+      ]).method.toHex();
+      const preimageHash = await notePreimage(helper, preimage);
+
+      await expect(helper.getSudo().executeExtrinsic(superuser, 'api.tx.maintenance.executePreimage', [
+        preimageHash, null, {refTime: 100000000000, proofSize: 100000000000},
+      ])).to.be.rejectedWith(/balances\.InsufficientBalance/);
+    });
+
     itSub('Does not allow preimage execution with non-root', async ({helper}) => {
-      await expect(helper.executeExtrinsic(bob, 'api.tx.maintenance.executePreimage', [preimageHash]))
-        .to.be.rejectedWith(/BadOrigin/);
+      await expect(helper.executeExtrinsic(bob, 'api.tx.maintenance.executePreimage', [
+        preimageHash, null, {refTime: 100000000000, proofSize: 100000000000},
+      ])).to.be.rejectedWith(/BadOrigin/);
     });
 
     itSub('Does not allow execution of non-existent preimages', async ({helper}) => {
       await expect(helper.getSudo().executeExtrinsic(superuser, 'api.tx.maintenance.executePreimage', [
-        '0x1010101010101010101010101010101010101010101010101010101010101010',
+        '0x1010101010101010101010101010101010101010101010101010101010101010', null, {refTime: 100000000000, proofSize: 100000000000},
       ])).to.be.rejectedWith(/Unavailable/);
     });
 
+    itSub('Does not allow preimage execution with less than minimum weights', async ({helper}) => {
+      await expect(helper.getSudo().executeExtrinsic(superuser, 'api.tx.maintenance.executePreimage', [
+        preimageHash, null, {refTime: 1000, proofSize: 1000},
+      ])).to.be.rejectedWith(/Exhausted/);
+    });
+
     after(async function() {
       await usingPlaygrounds(async (helper) => {
         if (helper.fetchMissingPalletNames([Pallets.Preimage, Pallets.Maintenance]).length != 0) return;
modifiedtests/src/util/identitySetter.tsdiffbeforeafterboth
--- a/tests/src/util/identitySetter.ts
+++ b/tests/src/util/identitySetter.ts
@@ -172,8 +172,6 @@
         // identitiesToRemove.push((key as any).toHuman()[0]);
       }
 
-      console.log(identitiesToAdd[0][1]);
-
       if (identitiesToRemove.length != 0)
         await uploadPreimage(
           helper,