Add auction benchmarks (#1040)

* add auction benchmarks

* fix

* update

* remove unused files

Author: zjb0807

auction/Cargo.toml

@@ -12,6 +12,7 @@ parity-scale-codec = { workspace = true }
 scale-info = { workspace = true }
 serde = { workspace = true, optional = true }
 
+frame-benchmarking = { workspace = true, optional = true }
 frame-support = { workspace = true }
 frame-system = { workspace = true }
 sp-runtime = { workspace = true }
@@ -26,6 +27,7 @@ sp-io = { workspace = true, features = ["std"] }
 [features]
 default = [ "std" ]
 std = [
+	"frame-benchmarking?/std",
 	"frame-support/std",
 	"frame-system/std",
 	"orml-traits/std",
@@ -35,6 +37,12 @@ std = [
 	"sp-runtime/std",
 	"sp-std/std",
 ]
+runtime-benchmarks = [
+	"frame-benchmarking/runtime-benchmarks",
+	"frame-support/runtime-benchmarks",
+	"frame-system/runtime-benchmarks",
+	"sp-runtime/runtime-benchmarks",
+]
 try-runtime = [
 	"frame-support/try-runtime",
 	"frame-system/try-runtime",

auction/src/benchmarking.rs

@@ -0,0 +1,108 @@
+pub use crate::*;
+
+use frame_benchmarking::v2::*;
+use frame_support::assert_ok;
+use frame_system::{EventRecord, RawOrigin};
+
+/// Helper trait for benchmarking.
+pub trait BenchmarkHelper<BlockNumber, AccountId, Balance> {
+	fn setup_bid() -> Option<(AccountId, Balance)>;
+	fn setup_on_finalize(rand: u32) -> Option<BlockNumber>;
+}
+
+impl<BlockNumber, AccountId, Balance> BenchmarkHelper<BlockNumber, AccountId, Balance> for () {
+	fn setup_bid() -> Option<(AccountId, Balance)> {
+		None
+	}
+	fn setup_on_finalize(_rand: u32) -> Option<BlockNumber> {
+		None
+	}
+}
+
+pub struct BaseBenchmarkHelper<T>(sp_std::marker::PhantomData<T>);
+
+impl<T: Config> BenchmarkHelper<BlockNumberFor<T>, T::AccountId, T::Balance> for BaseBenchmarkHelper<T> {
+	fn setup_bid() -> Option<(T::AccountId, T::Balance)> {
+		let end_block: BlockNumberFor<T> = frame_system::Pallet::<T>::block_number() + 10u32.into();
+		assert_ok!(Pallet::<T>::new_auction(
+			frame_system::Pallet::<T>::block_number(),
+			Some(end_block),
+		));
+
+		let auction_id: T::AuctionId = 0u32.into();
+		let pre_bidder: T::AccountId = account("pre_bidder", 0, 0);
+		let pre_bid_price: T::Balance = 10_000u32.into();
+
+		assert_ok!(Pallet::<T>::bid(
+			RawOrigin::Signed(pre_bidder).into(),
+			auction_id,
+			pre_bid_price
+		));
+
+		let bidder: T::AccountId = account("bidder", 0, 0);
+		let bid_price: T::Balance = 20_000u32.into();
+
+		Some((bidder, bid_price))
+	}
+
+	fn setup_on_finalize(rand: u32) -> Option<BlockNumberFor<T>> {
+		let end_block: BlockNumberFor<T> = frame_system::Pallet::<T>::block_number() + 10u32.into();
+
+		for _auction_id in 0..rand {
+			assert_ok!(Pallet::<T>::new_auction(
+				frame_system::Pallet::<T>::block_number(),
+				Some(end_block),
+			));
+		}
+		Some(end_block)
+	}
+}
+
+fn assert_last_event<T: Config>(generic_event: <T as frame_system::Config>::RuntimeEvent) {
+	let events = frame_system::Pallet::<T>::events();
+	let system_event: <T as frame_system::Config>::RuntimeEvent = generic_event.into();
+	// compare to the last event record
+	let EventRecord { event, .. } = &events[events.len() - 1];
+	assert_eq!(event, &system_event);
+}
+
+#[benchmarks]
+mod benchmarks {
+	use super::*;
+
+	// `bid` a collateral auction, worst cases:
+	// there's bidder before and bid price will exceed target amount
+	#[benchmark]
+	fn bid() {
+		let auction_id: T::AuctionId = 0u32.into();
+		let (bidder, bid_price) = T::BenchmarkHelper::setup_bid().unwrap();
+
+		#[extrinsic_call]
+		_(RawOrigin::Signed(bidder.clone()), auction_id, bid_price);
+
+		assert_last_event::<T>(
+			Event::Bid {
+				auction_id,
+				bidder: bidder,
+				amount: bid_price,
+			}
+			.into(),
+		);
+	}
+
+	#[benchmark]
+	fn on_finalize(c: Liner<1, 100>) {
+		let end_block = T::BenchmarkHelper::setup_on_finalize(c).unwrap();
+
+		#[block]
+		{
+			Pallet::<T>::on_finalize(end_block);
+		}
+	}
+
+	impl_benchmark_test_suite! {
+		Pallet,
+		crate::mock::ExtBuilder::default().build(),
+		crate::mock::Runtime,
+	}
+}

auction/src/lib.rs

@@ -22,10 +22,14 @@ use sp_runtime::{
 	DispatchError, DispatchResult,
 };
 
+#[cfg(feature = "runtime-benchmarks")]
+mod benchmarking;
 mod mock;
 mod tests;
 mod weights;
 
+#[cfg(feature = "runtime-benchmarks")]
+pub use benchmarking::{BaseBenchmarkHelper, BenchmarkHelper};
 pub use module::*;
 pub use weights::WeightInfo;
 
@@ -61,6 +65,9 @@ pub mod module {
 
 		/// Weight information for extrinsics in this module.
 		type WeightInfo: WeightInfo;
+
+		#[cfg(feature = "runtime-benchmarks")]
+		type BenchmarkHelper: BenchmarkHelper<BlockNumberFor<Self>, Self::AccountId, Self::Balance>;
 	}
 
 	#[pallet::error]
@@ -130,7 +137,7 @@ pub mod module {
 		/// The dispatch origin for this call must be `Signed` by the
 		/// transactor.
 		#[pallet::call_index(0)]
-		#[pallet::weight(T::WeightInfo::bid_collateral_auction())]
+		#[pallet::weight(T::WeightInfo::bid())]
 		pub fn bid(origin: OriginFor<T>, id: T::AuctionId, #[pallet::compact] value: T::Balance) -> DispatchResult {
 			let from = ensure_signed(origin)?;
 

auction/src/mock.rs

@@ -29,9 +29,9 @@ impl AuctionHandler<AccountId, Balance, BlockNumber, AuctionId> for Handler {
 		now: BlockNumber,
 		_id: AuctionId,
 		new_bid: (AccountId, Balance),
-		_last_bid: Option<(AccountId, Balance)>,
+		last_bid: Option<(AccountId, Balance)>,
 	) -> OnNewBidResult<BlockNumber> {
-		if new_bid.0 == ALICE {
+		if last_bid.is_none() || last_bid.unwrap().0 != new_bid.0 {
 			OnNewBidResult {
 				accept_bid: true,
 				auction_end_change: Change::NewValue(Some(now + BID_EXTEND_BLOCK)),
@@ -52,6 +52,8 @@ impl Config for Runtime {
 	type AuctionId = AuctionId;
 	type Handler = Handler;
 	type WeightInfo = ();
+	#[cfg(feature = "runtime-benchmarks")]
+	type BenchmarkHelper = BaseBenchmarkHelper<Runtime>;
 }
 
 type Block = frame_system::mocking::MockBlock<Runtime>;
@@ -64,7 +66,6 @@ construct_runtime!(
 );
 
 pub const ALICE: AccountId = 1;
-pub const BOB: AccountId = 2;
 pub const BID_EXTEND_BLOCK: BlockNumber = 10;
 
 pub struct ExtBuilder;

auction/src/tests.rs

@@ -93,8 +93,9 @@ fn bid_should_fail() {
 			AuctionModule::bid(RuntimeOrigin::signed(ALICE), 0, 20),
 			Error::<Runtime>::AuctionNotStarted
 		);
+		assert_ok!(AuctionModule::bid(RuntimeOrigin::signed(ALICE), 1, 20));
 		assert_noop!(
-			AuctionModule::bid(RuntimeOrigin::signed(BOB), 1, 20),
+			AuctionModule::bid(RuntimeOrigin::signed(ALICE), 1, 30),
 			Error::<Runtime>::BidNotAccepted,
 		);
 		assert_noop!(

auction/src/weights.rs

@@ -30,13 +30,13 @@ use sp_std::marker::PhantomData;
 
 /// Weight functions needed for orml_auction.
 pub trait WeightInfo {
-	fn bid_collateral_auction() -> Weight;
+	fn bid() -> Weight;
 	fn on_finalize(c: u32, ) -> Weight;
 }
 
 /// Default weights.
 impl WeightInfo for () {
-	fn bid_collateral_auction() -> Weight {
+	fn bid() -> Weight {
 		Weight::from_parts(108_000_000, 0)
 			.saturating_add(RocksDbWeight::get().reads(8 as u64))
 			.saturating_add(RocksDbWeight::get().writes(9 as u64))