This repository has been archived by the owner on Nov 15, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2.6k
Sub-commands for benchmark
#11164
Merged
Merged
Sub-commands for benchmark
#11164
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
012be2a
Restructure benchmark commands
ggwpez 1c9468c
Add benchmark block test
ggwpez 9652f07
Fixup imports
ggwpez 3dd9429
CI
ggwpez 4e7c202
Review fixes
ggwpez 7b14cb5
Extend error message
ggwpez e4e0246
Apply suggestions from code review
ggwpez 6466c4e
Review fixes
ggwpez 0bba6a3
Merge remote-tracking branch 'origin/master' into oty-restructure-bench
ggwpez e2201af
Add commands to node-template
ggwpez f390166
Merge branch 'master' into oty-restructure-bench
ggwpez File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,131 @@ | ||
// This file is part of Substrate. | ||
|
||
// Copyright (C) 2022 Parity Technologies (UK) Ltd. | ||
// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0 | ||
|
||
// This program is free software: you can redistribute it and/or modify | ||
// it under the terms of the GNU General Public License as published by | ||
// the Free Software Foundation, either version 3 of the License, or | ||
// (at your option) any later version. | ||
|
||
// This program is distributed in the hope that it will be useful, | ||
// but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
// GNU General Public License for more details. | ||
|
||
// You should have received a copy of the GNU General Public License | ||
// along with this program. If not, see <https://www.gnu.org/licenses/>. | ||
|
||
//! Contains code to setup the command invocations in [`super::command`] which would | ||
//! otherwise bloat that module. | ||
|
||
use crate::service::FullClient; | ||
|
||
use node_template_runtime as runtime; | ||
use runtime::SystemCall; | ||
use sc_cli::Result; | ||
use sc_client_api::BlockBackend; | ||
use sp_core::{Encode, Pair}; | ||
use sp_inherents::{InherentData, InherentDataProvider}; | ||
use sp_keyring::Sr25519Keyring; | ||
use sp_runtime::{OpaqueExtrinsic, SaturatedConversion}; | ||
|
||
use std::{sync::Arc, time::Duration}; | ||
|
||
/// Generates extrinsics for the `benchmark overhead` command. | ||
/// | ||
/// Note: Should only be used for benchmarking. | ||
pub struct BenchmarkExtrinsicBuilder { | ||
client: Arc<FullClient>, | ||
} | ||
|
||
impl BenchmarkExtrinsicBuilder { | ||
/// Creates a new [`Self`] from the given client. | ||
pub fn new(client: Arc<FullClient>) -> Self { | ||
Self { client } | ||
} | ||
} | ||
|
||
impl frame_benchmarking_cli::ExtrinsicBuilder for BenchmarkExtrinsicBuilder { | ||
fn remark(&self, nonce: u32) -> std::result::Result<OpaqueExtrinsic, &'static str> { | ||
let acc = Sr25519Keyring::Bob.pair(); | ||
let extrinsic: OpaqueExtrinsic = create_benchmark_extrinsic( | ||
self.client.as_ref(), | ||
acc, | ||
SystemCall::remark { remark: vec![] }.into(), | ||
nonce, | ||
) | ||
.into(); | ||
|
||
Ok(extrinsic) | ||
} | ||
} | ||
|
||
/// Create a transaction using the given `call`. | ||
/// | ||
/// Note: Should only be used for benchmarking. | ||
pub fn create_benchmark_extrinsic( | ||
client: &FullClient, | ||
sender: sp_core::sr25519::Pair, | ||
call: runtime::Call, | ||
nonce: u32, | ||
) -> runtime::UncheckedExtrinsic { | ||
let genesis_hash = client.block_hash(0).ok().flatten().expect("Genesis block exists; qed"); | ||
let best_hash = client.chain_info().best_hash; | ||
let best_block = client.chain_info().best_number; | ||
|
||
let period = runtime::BlockHashCount::get() | ||
.checked_next_power_of_two() | ||
.map(|c| c / 2) | ||
.unwrap_or(2) as u64; | ||
let extra: runtime::SignedExtra = ( | ||
frame_system::CheckNonZeroSender::<runtime::Runtime>::new(), | ||
frame_system::CheckSpecVersion::<runtime::Runtime>::new(), | ||
frame_system::CheckTxVersion::<runtime::Runtime>::new(), | ||
frame_system::CheckGenesis::<runtime::Runtime>::new(), | ||
frame_system::CheckEra::<runtime::Runtime>::from(sp_runtime::generic::Era::mortal( | ||
period, | ||
best_block.saturated_into(), | ||
)), | ||
frame_system::CheckNonce::<runtime::Runtime>::from(nonce), | ||
frame_system::CheckWeight::<runtime::Runtime>::new(), | ||
pallet_transaction_payment::ChargeTransactionPayment::<runtime::Runtime>::from(0), | ||
); | ||
|
||
let raw_payload = runtime::SignedPayload::from_raw( | ||
call.clone(), | ||
extra.clone(), | ||
( | ||
(), | ||
runtime::VERSION.spec_version, | ||
runtime::VERSION.transaction_version, | ||
genesis_hash, | ||
best_hash, | ||
(), | ||
(), | ||
(), | ||
), | ||
); | ||
let signature = raw_payload.using_encoded(|e| sender.sign(e)); | ||
|
||
runtime::UncheckedExtrinsic::new_signed( | ||
call.clone(), | ||
sp_runtime::AccountId32::from(sender.public()).into(), | ||
runtime::Signature::Sr25519(signature.clone()), | ||
extra.clone(), | ||
) | ||
} | ||
|
||
/// Generates inherent data for the `benchmark overhead` command. | ||
/// | ||
/// Note: Should only be used for benchmarking. | ||
pub fn inherent_benchmark_data() -> Result<InherentData> { | ||
let mut inherent_data = InherentData::new(); | ||
let d = Duration::from_millis(0); | ||
let timestamp = sp_timestamp::InherentDataProvider::new(d.into()); | ||
|
||
timestamp | ||
.provide_inherent_data(&mut inherent_data) | ||
.map_err(|e| format!("creating inherent data: {:?}", e))?; | ||
Ok(inherent_data) | ||
} |
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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why not add the other sub commands to the node template? Seems like they would be helpful if someone is basing a new project off the template
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yea that's a good follow-up, I'll put it in an issue. Just wanted to get it done faster 😄
The node-template currently uses the weights from
frame_support
, so even when you run the benchmarks yourself, it would require some updating to actually use them in the node-template.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Okay I added it now in the last commit since @shawntabrizi also wanted it.
There is infrastructure missing in the node-template, therefore the copy&paste from the substrate node.