forked from paritytech/substrate
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Preimage registrar and Scheduler integration (paritytech#10356)
* initial idea * more * fix compile * add clear and request logic * improve some docs * Add and implement trait * continuing to improve * refcount type * infallible system preimage upload * fmt * fix requests * Make it simple * Make it simple * Formatting * Initial draft * request when scheduled * Docs * Scheduler good * Scheduler good * Scheduler tests working * Add new files * Missing stuff * Repotting, add weights. * Add some tests to preimage pallet * More tests * Fix benchmarks * preimage benchmarks * All preimage benchmarks * Tidy cargo * Update weights.rs * Allow hash provision in benchmarks * Initial work on new benchmarks for Scheduler * Tests working, refactor looks good * Tests for new Scheduler functionality * Use real weight, make tests work with runtimes without Preimage * Rename * Update benchmarks * Formatting * Formatting * Fix weird formatting * Update frame/preimage/src/lib.rs * Fix try-runtime build * Fixes * Fixes * Update frame/support/src/traits/tokens/currency.rs Co-authored-by: Kian Paimani <[email protected]> * Update frame/support/src/traits/tokens/currency/reservable.rs Co-authored-by: Kian Paimani <[email protected]> * Update frame/support/src/traits/tokens/imbalance.rs Co-authored-by: Kian Paimani <[email protected]> * Update frame/preimage/src/mock.rs Co-authored-by: Guillaume Thiolliere <[email protected]> * Update frame/scheduler/src/lib.rs Co-authored-by: Guillaume Thiolliere <[email protected]> * Update frame/preimage/src/lib.rs * Fixes * Fixes * Formatting * Fixes * Fixes * cargo run --quiet --release --features=runtime-benchmarks --manifest-path=bin/node/cli/Cargo.toml -- benchmark --chain=dev --steps=50 --repeat=20 --pallet=pallet_scheduler --extrinsic=* --execution=wasm --wasm-execution=compiled --heap-pages=4096 --output=./frame/scheduler/src/weights.rs --template=./.maintain/frame-weight-template.hbs * cargo run --quiet --release --features=runtime-benchmarks --manifest-path=bin/node/cli/Cargo.toml -- benchmark --chain=dev --steps=50 --repeat=20 --pallet=pallet_preimage --extrinsic=* --execution=wasm --wasm-execution=compiled --heap-pages=4096 --output=./frame/preimage/src/weights.rs --template=./.maintain/frame-weight-template.hbs Co-authored-by: Shawn Tabrizi <[email protected]> Co-authored-by: Kian Paimani <[email protected]> Co-authored-by: Guillaume Thiolliere <[email protected]> Co-authored-by: Parity Bot <[email protected]>
- Loading branch information
Showing
24 changed files
with
3,593 additions
and
1,288 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
[package] | ||
name = "pallet-preimage" | ||
version = "4.0.0-dev" | ||
authors = ["Parity Technologies <[email protected]>"] | ||
edition = "2021" | ||
license = "Apache-2.0" | ||
homepage = "https://substrate.io" | ||
repository = "https://github.com/paritytech/substrate/" | ||
description = "FRAME pallet for storing preimages of hashes" | ||
readme = "README.md" | ||
|
||
[dependencies] | ||
codec = { package = "parity-scale-codec", version = "2.0.0", default-features = false, features = ["derive"] } | ||
scale-info = { version = "1.0", default-features = false, features = ["derive"] } | ||
|
||
sp-std = { version = "4.0.0", default-features = false, path = "../../primitives/std" } | ||
sp-io = { version = "4.0.0-dev", default-features = false, path = "../../primitives/io" } | ||
sp-core = { version = "4.1.0-dev", default-features = false, optional = true, path = "../../primitives/core" } | ||
sp-runtime = { version = "4.0.0-dev", default-features = false, path = "../../primitives/runtime" } | ||
frame-system = { version = "4.0.0-dev", default-features = false, path = "../system" } | ||
frame-support = { version = "4.0.0-dev", default-features = false, path = "../support" } | ||
frame-benchmarking = { version = "4.0.0-dev", default-features = false, path = "../benchmarking", optional = true } | ||
|
||
[dev-dependencies] | ||
sp-core = { version = "4.1.0-dev", path = "../../primitives/core", default-features = false } | ||
pallet-balances = { version = "4.0.0-dev", path = "../balances" } | ||
|
||
[features] | ||
default = ["std"] | ||
runtime-benchmarks = [ | ||
"frame-benchmarking", | ||
"frame-support/runtime-benchmarks", | ||
"frame-system/runtime-benchmarks", | ||
] | ||
std = [ | ||
"codec/std", | ||
"scale-info/std", | ||
"sp-std/std", | ||
"sp-io/std", | ||
"sp-core/std", | ||
"sp-runtime/std", | ||
"frame-system/std", | ||
"frame-support/std", | ||
"frame-benchmarking/std", | ||
] | ||
try-runtime = ["frame-support/try-runtime"] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,161 @@ | ||
// 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. | ||
|
||
//! Preimage pallet benchmarking. | ||
use super::*; | ||
use frame_benchmarking::{account, benchmarks, whitelist_account}; | ||
use frame_support::assert_ok; | ||
use frame_system::RawOrigin; | ||
use sp_runtime::traits::Bounded; | ||
use sp_std::{prelude::*, vec}; | ||
|
||
use crate::Pallet as Preimage; | ||
|
||
const SEED: u32 = 0; | ||
|
||
fn funded_account<T: Config>(name: &'static str, index: u32) -> T::AccountId { | ||
let caller: T::AccountId = account(name, index, SEED); | ||
T::Currency::make_free_balance_be(&caller, BalanceOf::<T>::max_value()); | ||
caller | ||
} | ||
|
||
fn preimage_and_hash<T: Config>() -> (Vec<u8>, T::Hash) { | ||
sized_preimage_and_hash::<T>(T::MaxSize::get()) | ||
} | ||
|
||
fn sized_preimage_and_hash<T: Config>(size: u32) -> (Vec<u8>, T::Hash) { | ||
let mut preimage = vec![]; | ||
preimage.resize(size as usize, 0); | ||
let hash = <T as frame_system::Config>::Hashing::hash(&preimage[..]); | ||
(preimage, hash) | ||
} | ||
|
||
benchmarks! { | ||
// Expensive note - will reserve. | ||
note_preimage { | ||
let s in 0 .. T::MaxSize::get(); | ||
let caller = funded_account::<T>("caller", 0); | ||
whitelist_account!(caller); | ||
let (preimage, hash) = sized_preimage_and_hash::<T>(s); | ||
}: _(RawOrigin::Signed(caller), preimage) | ||
verify { | ||
assert!(Preimage::<T>::have_preimage(&hash)); | ||
} | ||
// Cheap note - will not reserve since it was requested. | ||
note_requested_preimage { | ||
let s in 0 .. T::MaxSize::get(); | ||
let caller = funded_account::<T>("caller", 0); | ||
whitelist_account!(caller); | ||
let (preimage, hash) = sized_preimage_and_hash::<T>(s); | ||
assert_ok!(Preimage::<T>::request_preimage(T::ManagerOrigin::successful_origin(), hash.clone())); | ||
}: note_preimage(RawOrigin::Signed(caller), preimage) | ||
verify { | ||
assert!(Preimage::<T>::have_preimage(&hash)); | ||
} | ||
// Cheap note - will not reserve since it's the manager. | ||
note_no_deposit_preimage { | ||
let s in 0 .. T::MaxSize::get(); | ||
let (preimage, hash) = sized_preimage_and_hash::<T>(s); | ||
assert_ok!(Preimage::<T>::request_preimage(T::ManagerOrigin::successful_origin(), hash.clone())); | ||
}: note_preimage<T::Origin>(T::ManagerOrigin::successful_origin(), preimage) | ||
verify { | ||
assert!(Preimage::<T>::have_preimage(&hash)); | ||
} | ||
|
||
// Expensive unnote - will unreserve. | ||
unnote_preimage { | ||
let caller = funded_account::<T>("caller", 0); | ||
whitelist_account!(caller); | ||
let (preimage, hash) = preimage_and_hash::<T>(); | ||
assert_ok!(Preimage::<T>::note_preimage(RawOrigin::Signed(caller.clone()).into(), preimage)); | ||
}: _(RawOrigin::Signed(caller), hash.clone()) | ||
verify { | ||
assert!(!Preimage::<T>::have_preimage(&hash)); | ||
} | ||
// Cheap unnote - will not unreserve since there's no deposit held. | ||
unnote_no_deposit_preimage { | ||
let (preimage, hash) = preimage_and_hash::<T>(); | ||
assert_ok!(Preimage::<T>::note_preimage(T::ManagerOrigin::successful_origin(), preimage)); | ||
}: unnote_preimage<T::Origin>(T::ManagerOrigin::successful_origin(), hash.clone()) | ||
verify { | ||
assert!(!Preimage::<T>::have_preimage(&hash)); | ||
} | ||
|
||
// Expensive request - will unreserve the noter's deposit. | ||
request_preimage { | ||
let (preimage, hash) = preimage_and_hash::<T>(); | ||
let noter = funded_account::<T>("noter", 0); | ||
whitelist_account!(noter); | ||
assert_ok!(Preimage::<T>::note_preimage(RawOrigin::Signed(noter).into(), preimage)); | ||
}: _<T::Origin>(T::ManagerOrigin::successful_origin(), hash) | ||
verify { | ||
assert_eq!(StatusFor::<T>::get(&hash), Some(RequestStatus::Requested(1))); | ||
} | ||
// Cheap request - would unreserve the deposit but none was held. | ||
request_no_deposit_preimage { | ||
let (preimage, hash) = preimage_and_hash::<T>(); | ||
assert_ok!(Preimage::<T>::note_preimage(T::ManagerOrigin::successful_origin(), preimage)); | ||
}: request_preimage<T::Origin>(T::ManagerOrigin::successful_origin(), hash) | ||
verify { | ||
assert_eq!(StatusFor::<T>::get(&hash), Some(RequestStatus::Requested(1))); | ||
} | ||
// Cheap request - the preimage is not yet noted, so deposit to unreserve. | ||
request_unnoted_preimage { | ||
let (_, hash) = preimage_and_hash::<T>(); | ||
}: request_preimage<T::Origin>(T::ManagerOrigin::successful_origin(), hash) | ||
verify { | ||
assert_eq!(StatusFor::<T>::get(&hash), Some(RequestStatus::Requested(1))); | ||
} | ||
// Cheap request - the preimage is already requested, so just a counter bump. | ||
request_requested_preimage { | ||
let (_, hash) = preimage_and_hash::<T>(); | ||
assert_ok!(Preimage::<T>::request_preimage(T::ManagerOrigin::successful_origin(), hash.clone())); | ||
}: request_preimage<T::Origin>(T::ManagerOrigin::successful_origin(), hash) | ||
verify { | ||
assert_eq!(StatusFor::<T>::get(&hash), Some(RequestStatus::Requested(2))); | ||
} | ||
|
||
// Expensive unrequest - last reference and it's noted, so will destroy the preimage. | ||
unrequest_preimage { | ||
let (preimage, hash) = preimage_and_hash::<T>(); | ||
assert_ok!(Preimage::<T>::request_preimage(T::ManagerOrigin::successful_origin(), hash.clone())); | ||
assert_ok!(Preimage::<T>::note_preimage(T::ManagerOrigin::successful_origin(), preimage)); | ||
}: _<T::Origin>(T::ManagerOrigin::successful_origin(), hash.clone()) | ||
verify { | ||
assert_eq!(StatusFor::<T>::get(&hash), None); | ||
} | ||
// Cheap unrequest - last reference, but it's not noted. | ||
unrequest_unnoted_preimage { | ||
let (_, hash) = preimage_and_hash::<T>(); | ||
assert_ok!(Preimage::<T>::request_preimage(T::ManagerOrigin::successful_origin(), hash.clone())); | ||
}: unrequest_preimage<T::Origin>(T::ManagerOrigin::successful_origin(), hash.clone()) | ||
verify { | ||
assert_eq!(StatusFor::<T>::get(&hash), None); | ||
} | ||
// Cheap unrequest - not the last reference. | ||
unrequest_multi_referenced_preimage { | ||
let (_, hash) = preimage_and_hash::<T>(); | ||
assert_ok!(Preimage::<T>::request_preimage(T::ManagerOrigin::successful_origin(), hash.clone())); | ||
assert_ok!(Preimage::<T>::request_preimage(T::ManagerOrigin::successful_origin(), hash.clone())); | ||
}: unrequest_preimage<T::Origin>(T::ManagerOrigin::successful_origin(), hash.clone()) | ||
verify { | ||
assert_eq!(StatusFor::<T>::get(&hash), Some(RequestStatus::Requested(1))); | ||
} | ||
|
||
impl_benchmark_test_suite!(Preimage, crate::mock::new_test_ext(), crate::mock::Test); | ||
} |
Oops, something went wrong.