pallet_transaction_storage/
benchmarking.rs

1// This file is part of Substrate.
2
3// Copyright (C) Parity Technologies (UK) Ltd.
4// SPDX-License-Identifier: Apache-2.0
5
6// Licensed under the Apache License, Version 2.0 (the "License");
7// you may not use this file except in compliance with the License.
8// You may obtain a copy of the License at
9//
10// 	http://www.apache.org/licenses/LICENSE-2.0
11//
12// Unless required by applicable law or agreed to in writing, software
13// distributed under the License is distributed on an "AS IS" BASIS,
14// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15// See the License for the specific language governing permissions and
16// limitations under the License.
17
18//! Benchmarks for transaction-storage Pallet
19
20#![cfg(feature = "runtime-benchmarks")]
21
22use crate::*;
23use alloc::{vec, vec::Vec};
24use frame_benchmarking::v2::*;
25use frame_support::traits::{Get, OnFinalize, OnInitialize};
26use frame_system::{pallet_prelude::BlockNumberFor, EventRecord, Pallet as System, RawOrigin};
27use sp_runtime::traits::{Bounded, CheckedDiv, One, Zero};
28use sp_transaction_storage_proof::TransactionStorageProof;
29
30// Proof generated from max size storage:
31// ```
32// let mut transactions = Vec::new();
33// let tx_size = DEFAULT_MAX_TRANSACTION_SIZE;
34// for _ in 0..DEFAULT_MAX_BLOCK_TRANSACTIONS {
35//   transactions.push(vec![0; tx_size]);
36// }
37// let hash = vec![0; 32];
38// build_proof(hash.as_slice(), transactions).unwrap().encode()
39// ```
40// while hardforcing target chunk key in `build_proof` to [22, 21, 1, 0].
41const PROOF: &str = "\
42	0104000000000000000000000000000000000000000000000000000000000000000000000000\
43	0000000000000000000000000000000000000000000000000000000000000000000000000000\
44	0000000000000000000000000000000000000000000000000000000000000000000000000000\
45	0000000000000000000000000000000000000000000000000000000000000000000000000000\
46	0000000000000000000000000000000000000000000000000000000000000000000000000000\
47	0000000000000000000000000000000000000000000000000000000000000000000000000000\
48	00000000000000000000000000000000000000000000000000000000000014cd0780ffff8030\
49	2eb0a6d2f63b834d15f1e729d1c1004657e3048cf206d697eeb153f61a30ba0080302eb0a6d2\
50	f63b834d15f1e729d1c1004657e3048cf206d697eeb153f61a30ba80302eb0a6d2f63b834d15\
51	f1e729d1c1004657e3048cf206d697eeb153f61a30ba80302eb0a6d2f63b834d15f1e729d1c1\
52	004657e3048cf206d697eeb153f61a30ba80302eb0a6d2f63b834d15f1e729d1c1004657e304\
53	8cf206d697eeb153f61a30ba80302eb0a6d2f63b834d15f1e729d1c1004657e3048cf206d697\
54	eeb153f61a30ba80302eb0a6d2f63b834d15f1e729d1c1004657e3048cf206d697eeb153f61a\
55	30ba80302eb0a6d2f63b834d15f1e729d1c1004657e3048cf206d697eeb153f61a30ba80302e\
56	b0a6d2f63b834d15f1e729d1c1004657e3048cf206d697eeb153f61a30ba80302eb0a6d2f63b\
57	834d15f1e729d1c1004657e3048cf206d697eeb153f61a30ba80302eb0a6d2f63b834d15f1e7\
58	29d1c1004657e3048cf206d697eeb153f61a30ba80302eb0a6d2f63b834d15f1e729d1c10046\
59	57e3048cf206d697eeb153f61a30ba80302eb0a6d2f63b834d15f1e729d1c1004657e3048cf2\
60	06d697eeb153f61a30ba80302eb0a6d2f63b834d15f1e729d1c1004657e3048cf206d697eeb1\
61	53f61a30ba80302eb0a6d2f63b834d15f1e729d1c1004657e3048cf206d697eeb153f61a30ba\
62	bd058077778010fd81bc1359802f0b871aeb95e4410a8ec92b93af10ea767a2027cf4734e8de\
63	808da338e6b722f7bf2051901bd5bccee5e71d5cf6b1faff338ad7120b0256c28380221ce17f\
64	19117affa96e077905fe48a99723a065969c638593b7d9ab57b538438010fd81bc1359802f0b\
65	871aeb95e4410a8ec92b93af10ea767a2027cf4734e8de808da338e6b722f7bf2051901bd5bc\
66	cee5e71d5cf6b1faff338ad7120b0256c283008010fd81bc1359802f0b871aeb95e4410a8ec9\
67	2b93af10ea767a2027cf4734e8de808da338e6b722f7bf2051901bd5bccee5e71d5cf6b1faff\
68	338ad7120b0256c28380221ce17f19117affa96e077905fe48a99723a065969c638593b7d9ab\
69	57b538438010fd81bc1359802f0b871aeb95e4410a8ec92b93af10ea767a2027cf4734e8de80\
70	8da338e6b722f7bf2051901bd5bccee5e71d5cf6b1faff338ad7120b0256c28380221ce17f19\
71	117affa96e077905fe48a99723a065969c638593b7d9ab57b53843cd0780ffff804509f59593\
72	fd47b1a97189127ba65a5649cfb0346637f9836e155eaf891a939c00804509f59593fd47b1a9\
73	7189127ba65a5649cfb0346637f9836e155eaf891a939c804509f59593fd47b1a97189127ba6\
74	5a5649cfb0346637f9836e155eaf891a939c804509f59593fd47b1a97189127ba65a5649cfb0\
75	346637f9836e155eaf891a939c804509f59593fd47b1a97189127ba65a5649cfb0346637f983\
76	6e155eaf891a939c804509f59593fd47b1a97189127ba65a5649cfb0346637f9836e155eaf89\
77	1a939c804509f59593fd47b1a97189127ba65a5649cfb0346637f9836e155eaf891a939c8045\
78	09f59593fd47b1a97189127ba65a5649cfb0346637f9836e155eaf891a939c804509f59593fd\
79	47b1a97189127ba65a5649cfb0346637f9836e155eaf891a939c804509f59593fd47b1a97189\
80	127ba65a5649cfb0346637f9836e155eaf891a939c804509f59593fd47b1a97189127ba65a56\
81	49cfb0346637f9836e155eaf891a939c804509f59593fd47b1a97189127ba65a5649cfb03466\
82	37f9836e155eaf891a939c804509f59593fd47b1a97189127ba65a5649cfb0346637f9836e15\
83	5eaf891a939c804509f59593fd47b1a97189127ba65a5649cfb0346637f9836e155eaf891a93\
84	9c804509f59593fd47b1a97189127ba65a5649cfb0346637f9836e155eaf891a939ccd0780ff\
85	ff8078916e776c64ccea05e958559f015c082d9d06feafa3610fc44a5b2ef543cb818078916e\
86	776c64ccea05e958559f015c082d9d06feafa3610fc44a5b2ef543cb818078916e776c64ccea\
87	05e958559f015c082d9d06feafa3610fc44a5b2ef543cb818078916e776c64ccea05e958559f\
88	015c082d9d06feafa3610fc44a5b2ef543cb818078916e776c64ccea05e958559f015c082d9d\
89	06feafa3610fc44a5b2ef543cb81008078916e776c64ccea05e958559f015c082d9d06feafa3\
90	610fc44a5b2ef543cb818078916e776c64ccea05e958559f015c082d9d06feafa3610fc44a5b\
91	2ef543cb818078916e776c64ccea05e958559f015c082d9d06feafa3610fc44a5b2ef543cb81\
92	8078916e776c64ccea05e958559f015c082d9d06feafa3610fc44a5b2ef543cb818078916e77\
93	6c64ccea05e958559f015c082d9d06feafa3610fc44a5b2ef543cb818078916e776c64ccea05\
94	e958559f015c082d9d06feafa3610fc44a5b2ef543cb818078916e776c64ccea05e958559f01\
95	5c082d9d06feafa3610fc44a5b2ef543cb818078916e776c64ccea05e958559f015c082d9d06\
96	feafa3610fc44a5b2ef543cb818078916e776c64ccea05e958559f015c082d9d06feafa3610f\
97	c44a5b2ef543cb818078916e776c64ccea05e958559f015c082d9d06feafa3610fc44a5b2ef5\
98	43cb811044010000\
99";
100fn proof() -> Vec<u8> {
101	array_bytes::hex2bytes_unchecked(PROOF)
102}
103
104fn assert_last_event<T: Config>(generic_event: <T as Config>::RuntimeEvent) {
105	let events = System::<T>::events();
106	let system_event: <T as frame_system::Config>::RuntimeEvent = generic_event.into();
107	let EventRecord { event, .. } = &events[events.len() - 1];
108	assert_eq!(event, &system_event);
109}
110
111pub fn run_to_block<T: Config>(n: frame_system::pallet_prelude::BlockNumberFor<T>) {
112	while frame_system::Pallet::<T>::block_number() < n {
113		crate::Pallet::<T>::on_finalize(frame_system::Pallet::<T>::block_number());
114		frame_system::Pallet::<T>::on_finalize(frame_system::Pallet::<T>::block_number());
115		frame_system::Pallet::<T>::set_block_number(
116			frame_system::Pallet::<T>::block_number() + One::one(),
117		);
118		frame_system::Pallet::<T>::on_initialize(frame_system::Pallet::<T>::block_number());
119		crate::Pallet::<T>::on_initialize(frame_system::Pallet::<T>::block_number());
120	}
121}
122
123#[benchmarks]
124mod benchmarks {
125	use super::*;
126
127	#[benchmark]
128	fn store(l: Linear<1, { T::MaxTransactionSize::get() }>) {
129		let caller: T::AccountId = whitelisted_caller();
130		let initial_balance = BalanceOf::<T>::max_value().checked_div(&2u32.into()).unwrap();
131		T::Currency::set_balance(&caller, initial_balance);
132
133		#[extrinsic_call]
134		_(RawOrigin::Signed(caller.clone()), vec![0u8; l as usize]);
135
136		assert!(!BlockTransactions::<T>::get().is_empty());
137		assert_last_event::<T>(Event::Stored { index: 0 }.into());
138	}
139
140	#[benchmark]
141	fn renew() -> Result<(), BenchmarkError> {
142		let caller: T::AccountId = whitelisted_caller();
143		let initial_balance = BalanceOf::<T>::max_value().checked_div(&2u32.into()).unwrap();
144		T::Currency::set_balance(&caller, initial_balance);
145		Pallet::<T>::store(
146			RawOrigin::Signed(caller.clone()).into(),
147			vec![0u8; T::MaxTransactionSize::get() as usize],
148		)?;
149		run_to_block::<T>(1u32.into());
150
151		#[extrinsic_call]
152		_(RawOrigin::Signed(caller.clone()), BlockNumberFor::<T>::zero(), 0);
153
154		assert_last_event::<T>(Event::Renewed { index: 0 }.into());
155
156		Ok(())
157	}
158
159	#[benchmark]
160	fn check_proof_max() -> Result<(), BenchmarkError> {
161		run_to_block::<T>(1u32.into());
162		let caller: T::AccountId = whitelisted_caller();
163		let initial_balance = BalanceOf::<T>::max_value().checked_div(&2u32.into()).unwrap();
164		T::Currency::set_balance(&caller, initial_balance);
165		for _ in 0..T::MaxBlockTransactions::get() {
166			Pallet::<T>::store(
167				RawOrigin::Signed(caller.clone()).into(),
168				vec![0u8; T::MaxTransactionSize::get() as usize],
169			)?;
170		}
171		run_to_block::<T>(StoragePeriod::<T>::get() + BlockNumberFor::<T>::one());
172		let encoded_proof = proof();
173		let proof = TransactionStorageProof::decode(&mut &*encoded_proof).unwrap();
174
175		#[extrinsic_call]
176		check_proof(RawOrigin::None, proof);
177
178		assert_last_event::<T>(Event::ProofChecked.into());
179
180		Ok(())
181	}
182
183	impl_benchmark_test_suite!(Pallet, mock::new_test_ext(), mock::Test);
184}
pallet_transaction_storage/benchmarking.rs

pallet_transaction_storage/
benchmarking.rs
