difftreelog
refactor(preimage-execution) remove preimage length bound + fix benchmarks
in: master
7 files changed
Makefilediffbeforeafterboth--- a/Makefile
+++ b/Makefile
@@ -137,9 +137,13 @@
bench-app-promotion:
make _bench PALLET=app-promotion PALLET_DIR=app-promotion
+.PHONY: bench-maintenance
+bench-maintenance:
+ make _bench PALLET=maintenance
+
.PHONY: bench
# Disabled: bench-scheduler, bench-collator-selection, bench-identity
-bench: bench-common bench-evm-migration bench-unique bench-structure bench-fungible bench-refungible bench-nonfungible bench-configuration bench-foreign-assets
+bench: bench-common bench-evm-migration bench-unique bench-structure bench-fungible bench-refungible bench-nonfungible bench-configuration bench-foreign-assets bench-maintenance
.PHONY: check
check:
pallets/maintenance/src/benchmarking.rsdiffbeforeafterboth--- a/pallets/maintenance/src/benchmarking.rs
+++ b/pallets/maintenance/src/benchmarking.rs
@@ -17,11 +17,10 @@
use super::*;
use crate::{Pallet as Maintenance, Config};
+use codec::Encode;
use frame_benchmarking::benchmarks;
-use frame_system::{Call as RuntimeCall, RawOrigin};
+use frame_system::RawOrigin;
use frame_support::{ensure, pallet_prelude::Weight, traits::StorePreimage};
-use codec::Encode;
-use sp_std::vec;
benchmarks! {
enable {
@@ -38,9 +37,9 @@
}
execute_preimage {
- let call_hash = RuntimeCall::<T>::set_storage { items: vec![] }.encode();
- let hash = T::Preimages::note(call_hash.into())?;
- }: _(RawOrigin::Root, hash, None, Weight::from_parts(100000000000, 100000000000))
+ let call = <T as Config>::RuntimeCall::from(frame_system::Call::<T>::remark { remark: 1u32.encode() });
+ let hash = T::Preimages::note(call.encode().into())?;
+ }: _(RawOrigin::Root, hash, Weight::from_parts(100000000000, 100000000000))
verify {
}
}
pallets/maintenance/src/lib.rsdiffbeforeafterboth1// 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}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 /// Execute a runtime call stored as a preimage.106 ///107 /// `weight_bound` is the maximum weight that the caller is willing108 /// to allow the extrinsic to be executed with.109 #[pallet::call_index(2)]110 #[pallet::weight(<T as Config>::WeightInfo::execute_preimage())]111 pub fn execute_preimage(112 origin: OriginFor<T>,113 hash: H256,114 weight_bound: Weight,115 ) -> DispatchResultWithPostInfo {116 use codec::Decode;117118 ensure_root(origin)?;119120 let data = T::Preimages::fetch(&hash, None)?;121 weight_bound.set_proof_size(122 weight_bound123 .proof_size()124 .checked_sub(125 data.len()126 .try_into()127 .map_err(|_| DispatchError::Corruption)?,128 )129 .ok_or(DispatchError::Exhausted)?,130 );131132 let call = <T as Config>::RuntimeCall::decode(&mut &data[..])133 .map_err(|_| DispatchError::Corruption)?;134135 ensure!(136 call.get_dispatch_info().weight.all_lte(weight_bound),137 DispatchError::Exhausted138 );139140 match call.dispatch(frame_system::RawOrigin::Root.into()) {141 Ok(_) => Ok(Pays::No.into()),142 Err(error_and_info) => Err(DispatchErrorWithPostInfo {143 post_info: Pays::No.into(),144 error: error_and_info.error,145 }),146 }147 }148 }149}pallets/maintenance/src/weights.rsdiffbeforeafterboth--- a/pallets/maintenance/src/weights.rs
+++ b/pallets/maintenance/src/weights.rs
@@ -3,7 +3,7 @@
//! Autogenerated weights for pallet_maintenance
//!
//! THIS FILE WAS AUTO-GENERATED USING THE SUBSTRATE BENCHMARK CLI VERSION 4.0.0-dev
-//! DATE: 2022-11-01, STEPS: `50`, REPEAT: 80, LOW RANGE: `[]`, HIGH RANGE: `[]`
+//! DATE: 2023-02-22, STEPS: `50`, REPEAT: 80, LOW RANGE: `[]`, HIGH RANGE: `[]`
//! EXECUTION: None, WASM-EXECUTION: Compiled, CHAIN: None, DB CACHE: 1024
// Executed Command:
@@ -26,6 +26,7 @@
#![cfg_attr(rustfmt, rustfmt_skip)]
#![allow(unused_parens)]
#![allow(unused_imports)]
+#![allow(missing_docs)]
#![allow(clippy::unnecessary_cast)]
use frame_support::{traits::Get, weights::{Weight, constants::RocksDbWeight}};
@@ -43,19 +44,19 @@
impl<T: frame_system::Config> WeightInfo for SubstrateWeight<T> {
// Storage: Maintenance Enabled (r:0 w:1)
fn enable() -> Weight {
- Weight::from_ref_time(7_367_000)
- .saturating_add(T::DbWeight::get().writes(1))
+ Weight::from_ref_time(10_860_000 as u64)
+ .saturating_add(T::DbWeight::get().writes(1 as u64))
}
// Storage: Maintenance Enabled (r:0 w:1)
fn disable() -> Weight {
- Weight::from_ref_time(7_273_000)
- .saturating_add(T::DbWeight::get().writes(1))
+ Weight::from_ref_time(10_871_000 as u64)
+ .saturating_add(T::DbWeight::get().writes(1 as u64))
}
- // Storage:
+ // Storage: Preimage StatusFor (r:1 w:0)
+ // Storage: Preimage PreimageFor (r:1 w:0)
fn execute_preimage() -> Weight {
- Weight::from_ref_time(7_273_000)
- .saturating_add(T::DbWeight::get().reads(2))
- .saturating_add(T::DbWeight::get().writes(1))
+ Weight::from_ref_time(10_068_000 as u64)
+ .saturating_add(T::DbWeight::get().reads(2 as u64))
}
}
@@ -63,18 +64,18 @@
impl WeightInfo for () {
// Storage: Maintenance Enabled (r:0 w:1)
fn enable() -> Weight {
- Weight::from_ref_time(7_367_000)
- .saturating_add(RocksDbWeight::get().writes(1))
+ Weight::from_ref_time(10_860_000 as u64)
+ .saturating_add(RocksDbWeight::get().writes(1 as u64))
}
// Storage: Maintenance Enabled (r:0 w:1)
fn disable() -> Weight {
- Weight::from_ref_time(7_273_000)
- .saturating_add(RocksDbWeight::get().writes(1))
+ Weight::from_ref_time(10_871_000 as u64)
+ .saturating_add(RocksDbWeight::get().writes(1 as u64))
}
- // Storage:
+ // Storage: Preimage StatusFor (r:1 w:0)
+ // Storage: Preimage PreimageFor (r:1 w:0)
fn execute_preimage() -> Weight {
- Weight::from_ref_time(7_273_000)
- .saturating_add(RocksDbWeight::get().reads(2))
- .saturating_add(RocksDbWeight::get().writes(1))
+ Weight::from_ref_time(10_068_000 as u64)
+ .saturating_add(RocksDbWeight::get().reads(2 as u64))
}
}
runtime/common/maintenance.rsdiffbeforeafterboth--- a/runtime/common/maintenance.rs
+++ b/runtime/common/maintenance.rs
@@ -86,9 +86,6 @@
| RuntimeCall::Session(_)
| RuntimeCall::Identity(_) => Err(TransactionValidityError::Invalid(InvalidTransaction::Call)),
- #[cfg(feature = "preimage")]
- RuntimeCall::Preimage(_) => Err(TransactionValidityError::Invalid(InvalidTransaction::Call)),
-
#[cfg(feature = "pallet-test-utils")]
RuntimeCall::TestUtils(_) => Err(TransactionValidityError::Invalid(InvalidTransaction::Call)),
runtime/common/runtime_apis.rsdiffbeforeafterboth--- a/runtime/common/runtime_apis.rs
+++ b/runtime/common/runtime_apis.rs
@@ -568,6 +568,7 @@
#[cfg(feature = "foreign-assets")]
list_benchmark!(list, extra, pallet_foreign_assets, ForeignAssets);
+ list_benchmark!(list, extra, pallet_maintenance, Maintenance);
// list_benchmark!(list, extra, pallet_evm_coder_substrate, EvmCoderSubstrate);
@@ -632,6 +633,8 @@
#[cfg(feature = "foreign-assets")]
add_benchmark!(params, batches, pallet_foreign_assets, ForeignAssets);
+ add_benchmark!(params, batches, pallet_maintenance, Maintenance);
+
// add_benchmark!(params, batches, pallet_evm_coder_substrate, EvmCoderSubstrate);
if batches.is_empty() { return Err("Benchmark not found for this pallet.".into()) }
tests/src/maintenance.seqtest.tsdiffbeforeafterboth--- a/tests/src/maintenance.seqtest.ts
+++ b/tests/src/maintenance.seqtest.ts
@@ -279,7 +279,7 @@
});
describe('Preimage Execution', () => {
- let preimageHash: string;
+ const preimageHashes: string[] = [];
async function notePreimage(helper: UniqueHelper, preimage: any): Promise<string> {
const result = await helper.preimage.notePreimage(bob, preimage);
@@ -306,13 +306,13 @@
},
]);
const preimage = helper.constructApiCall('api.tx.identity.forceInsertIdentities', [randomIdentities]).method.toHex();
- preimageHash = await notePreimage(helper, preimage);
+ preimageHashes.push(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, null, {refTime: 10000000000, proofSize: 10000000000},
+ preimageHashes[0], {refTime: 10000000000, proofSize: 10000000000},
])).to.be.fulfilled;
// preimage is executed, and an appropriate event is present
@@ -320,7 +320,7 @@
expect(events.length).to.be.equal(1);
// the preimage goes back to being unrequested
- expect(await helper.preimage.getPreimageInfo(preimageHash)).to.have.property('unrequested');
+ expect(await helper.preimage.getPreimageInfo(preimageHashes[0])).to.have.property('unrequested');
});
itSub('Does not allow execution of a preimage that would fail', async ({helper}) => {
@@ -330,27 +330,28 @@
{Id: zeroAccount.address}, {Id: superuser.address}, 1000n,
]).method.toHex();
const preimageHash = await notePreimage(helper, preimage);
+ preimageHashes.push(preimageHash);
await expect(helper.getSudo().executeExtrinsic(superuser, 'api.tx.maintenance.executePreimage', [
- preimageHash, null, {refTime: 100000000000, proofSize: 100000000000},
+ preimageHash, {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, null, {refTime: 100000000000, proofSize: 100000000000},
+ preimageHashes[0], {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', null, {refTime: 100000000000, proofSize: 100000000000},
+ '0x1010101010101010101010101010101010101010101010101010101010101010', {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},
+ preimageHashes[0], {refTime: 1000, proofSize: 1000},
])).to.be.rejectedWith(/Exhausted/);
});
@@ -358,7 +359,9 @@
await usingPlaygrounds(async (helper) => {
if (helper.fetchMissingPalletNames([Pallets.Preimage, Pallets.Maintenance]).length != 0) return;
- await helper.preimage.unnotePreimage(bob, preimageHash);
+ for (const hash of preimageHashes) {
+ await helper.preimage.unnotePreimage(bob, hash);
+ }
});
});
});