Balances: Configurable Number of Genesis Accounts with Specified Balances for Benchmarking

bridges/modules/messages/src/tests/mock.rs

@@ -461,7 +461,7 @@ pub fn inbound_unrewarded_relayers_state(lane: TestLaneIdType) -> UnrewardedRela
 /// Return test externalities to use in tests.
 pub fn new_test_ext() -> sp_io::TestExternalities {
 	let mut t = frame_system::GenesisConfig::<TestRuntime>::default().build_storage().unwrap();
-	pallet_balances::GenesisConfig::<TestRuntime> { balances: vec![(ENDOWED_ACCOUNT, 1_000_000)] }
+	pallet_balances::GenesisConfig::<TestRuntime> { balances: vec![(ENDOWED_ACCOUNT, 1_000_000)], ..Default::default() }
 		.assimilate_storage(&mut t)
 		.unwrap();
 	sp_io::TestExternalities::new(t)

cumulus/pallets/collator-selection/src/mock.rs

@@ -188,7 +188,7 @@ pub fn new_test_ext() -> sp_io::TestExternalities {
 		invulnerables,
 	};
 	let session = pallet_session::GenesisConfig::<Test> { keys, ..Default::default() };
-	pallet_balances::GenesisConfig::<Test> { balances }
+	pallet_balances::GenesisConfig::<Test> { balances, ..Default::default() }
 		.assimilate_storage(&mut t)
 		.unwrap();
 	// collator selection must be initialized before session.

polkadot/runtime/common/src/assigned_slots/mod.rs

@@ -773,6 +773,7 @@ mod tests {
 		let mut t = frame_system::GenesisConfig::<Test>::default().build_storage().unwrap();
 		pallet_balances::GenesisConfig::<Test> {
 			balances: vec![(1, 10), (2, 20), (3, 30), (4, 40), (5, 50), (6, 60)],
+			..Default::default()
 		}
 		.assimilate_storage(&mut t)
 		.unwrap();

polkadot/runtime/common/src/auctions.rs

@@ -866,6 +866,7 @@ mod tests {
 		let mut t = frame_system::GenesisConfig::<Test>::default().build_storage().unwrap();
 		pallet_balances::GenesisConfig::<Test> {
 			balances: vec![(1, 10), (2, 20), (3, 30), (4, 40), (5, 50), (6, 60)],
+			..Default::default()
 		}
 		.assimilate_storage(&mut t)
 		.unwrap();

polkadot/runtime/common/src/crowdloan/mod.rs

@@ -1085,6 +1085,7 @@ mod tests {
 		let mut t = frame_system::GenesisConfig::<Test>::default().build_storage().unwrap();
 		pallet_balances::GenesisConfig::<Test> {
 			balances: vec![(1, 1000), (2, 2000), (3, 3000), (4, 4000)],
+			..Default::default()
 		}
 		.assimilate_storage(&mut t)
 		.unwrap();

polkadot/runtime/common/src/paras_registrar/mod.rs

@@ -869,6 +869,7 @@ mod tests {
 
 		pallet_balances::GenesisConfig::<Test> {
 			balances: vec![(1, 10_000_000), (2, 10_000_000), (3, 10_000_000)],
+			..Default::default()
 		}
 		.assimilate_storage(&mut t)
 		.unwrap();

polkadot/runtime/common/src/slots/mod.rs

@@ -578,6 +578,7 @@ mod tests {
 		let mut t = frame_system::GenesisConfig::<Test>::default().build_storage().unwrap();
 		pallet_balances::GenesisConfig::<Test> {
 			balances: vec![(1, 10), (2, 20), (3, 30), (4, 40), (5, 50), (6, 60)],
+			..Default::default()
 		}
 		.assimilate_storage(&mut t)
 		.unwrap();

polkadot/xcm/pallet-xcm/src/mock.rs

@@ -700,7 +700,7 @@ pub(crate) fn new_test_ext_with_balances_and_xcm_version(
 ) -> sp_io::TestExternalities {
 	let mut t = frame_system::GenesisConfig::<Test>::default().build_storage().unwrap();
 
-	pallet_balances::GenesisConfig::<Test> { balances }
+	pallet_balances::GenesisConfig::<Test> { balances, ..Default::default() }
 		.assimilate_storage(&mut t)
 		.unwrap();
 

polkadot/xcm/xcm-builder/src/asset_exchange/single_asset_adapter/mock.rs

@@ -339,6 +339,7 @@ pub fn new_test_ext() -> sp_io::TestExternalities {
 
 	pallet_balances::GenesisConfig::<Runtime> {
 		balances: vec![(0, INITIAL_BALANCE), (1, INITIAL_BALANCE), (2, INITIAL_BALANCE)],
+		..Default::default()
 	}
 	.assimilate_storage(&mut t)
 	.unwrap();

polkadot/xcm/xcm-builder/tests/mock/mod.rs

@@ -243,7 +243,7 @@ construct_runtime!(
 pub fn kusama_like_with_balances(balances: Vec<(AccountId, Balance)>) -> sp_io::TestExternalities {
 	let mut t = frame_system::GenesisConfig::<Runtime>::default().build_storage().unwrap();
 
-	pallet_balances::GenesisConfig::<Runtime> { balances }
+	pallet_balances::GenesisConfig::<Runtime> { balances, ..Default::default() }
 		.assimilate_storage(&mut t)
 		.unwrap();
 

polkadot/xcm/xcm-runtime-apis/tests/mock.rs

@@ -364,7 +364,7 @@ impl pallet_xcm::Config for TestRuntime {
 pub fn new_test_ext_with_balances(balances: Vec<(AccountId, Balance)>) -> sp_io::TestExternalities {
 	let mut t = frame_system::GenesisConfig::<TestRuntime>::default().build_storage().unwrap();
 
-	pallet_balances::GenesisConfig::<TestRuntime> { balances }
+	pallet_balances::GenesisConfig::<TestRuntime> { balances, ..Default::default() }
 		.assimilate_storage(&mut t)
 		.unwrap();
 
@@ -380,7 +380,7 @@ pub fn new_test_ext_with_balances_and_assets(
 ) -> sp_io::TestExternalities {
 	let mut t = frame_system::GenesisConfig::<TestRuntime>::default().build_storage().unwrap();
 
-	pallet_balances::GenesisConfig::<TestRuntime> { balances }
+	pallet_balances::GenesisConfig::<TestRuntime> { balances, ..Default::default() }
 		.assimilate_storage(&mut t)
 		.unwrap();
 

polkadot/xcm/xcm-simulator/example/src/lib.rs

@@ -101,6 +101,7 @@ pub fn para_ext(para_id: u32) -> sp_io::TestExternalities {
 
 	pallet_balances::GenesisConfig::<Runtime> {
 		balances: vec![(ALICE, INITIAL_BALANCE), (parent_account_id(), INITIAL_BALANCE)],
+		..Default::default()
 	}
 	.assimilate_storage(&mut t)
 	.unwrap();
@@ -125,6 +126,7 @@ pub fn relay_ext() -> sp_io::TestExternalities {
 			(child_account_id(1), INITIAL_BALANCE),
 			(child_account_id(2), INITIAL_BALANCE),
 		],
+		..Default::default()
 	}
 	.assimilate_storage(&mut t)
 	.unwrap();

polkadot/xcm/xcm-simulator/fuzzer/src/fuzz.rs

@@ -117,6 +117,7 @@ pub fn para_ext(para_id: u32) -> sp_io::TestExternalities {
 
 	pallet_balances::GenesisConfig::<Runtime> {
 		balances: (0..6).map(|i| ([i; 32].into(), INITIAL_BALANCE)).collect(),
+		..Default::default()
 	}
 	.assimilate_storage(&mut t)
 	.unwrap();
@@ -138,7 +139,7 @@ pub fn relay_ext() -> sp_io::TestExternalities {
 	balances.append(&mut (1..=3).map(|i| (para_account_id(i), INITIAL_BALANCE)).collect());
 	balances.append(&mut (0..6).map(|i| ([i; 32].into(), INITIAL_BALANCE)).collect());
 
-	pallet_balances::GenesisConfig::<Runtime> { balances }
+	pallet_balances::GenesisConfig::<Runtime> { balances, ..Default::default() }
 		.assimilate_storage(&mut t)
 		.unwrap();
 

prdoc/pr_6267.prdoc

@@ -0,0 +1,117 @@
+# Schema: Polkadot SDK PRDoc Schema (prdoc) v1.0.0
+# See doc at https://raw.githubusercontent.com/paritytech/polkadot-sdk/master/prdoc/schema_user.json
+
+title: Allow configurable number of genesis accounts with specified balances for benchmarking.
+
+doc:
+  - audience: Runtime Dev
+    description: |
+      This pull request adds an additional field `dev_accounts` to the `GenesisConfig`
+      of the balances pallet, feature gated by `runtime-benchmarks`.
+
+      Bringing about an abitrary number of derived dev accounts when building the genesis
+      state. Runtime developers should supply a derivation path that includes an index placeholder
+      (i.e. "//Sender/{}") to generate multiple accounts from the same root in a consistent
+      manner.
+
+crates:
+  - name: pallet-vesting
+    bump: minor
+  - name: pallet-utility
+    bump: minor
+  - name: pallet-tx-pause
+    bump: minor
+  - name: pallet-treasury
+    bump: minor
+  - name: pallet-transaction-storage
+    bump: minor
+  - name: pallet-transaction-payment
+    bump: minor
+  - name: pallet-asset-tx-payment
+    bump: minor
+  - name: pallet-asset-conversion-tx-payment
+    bump: minor
+  - name: pallet-tips
+    bump: minor
+  - name: pallet-state-trie-migration
+    bump: minor
+  - name: pallet-staking
+    bump: minor
+  - name: pallet-society
+    bump: minor
+  - name: pallet-safe-mode
+    bump: minor
+  - name: pallet-root-offences
+    bump: minor
+  - name: pallet-revive
+    bump: minor
+  - name: pallet-revive-mock-network
+    bump: minor
+  - name: pallet-referenda
+    bump: minor
+  - name: pallet-recovery
+    bump: minor
+  - name: pallet-proxy
+    bump: minor
+  - name: pallet-preimage
+    bump: minor
+  - name: pallet-nis
+    bump: minor
+  - name: pallet-multisig
+    bump: minor
+  - name: pallet-lottery
+    bump: minor
+  - name: pallet-indices
+    bump: minor
+  - name: pallet-identity
+    bump: minor
+  - name: pallet-grandpa
+    bump: minor
+  - name: pallet-fast-unstake
+    bump: minor
+  - name: pallet-elections-phragmen
+    bump: minor
+  - name: pallet-election-provider-multi-phase
+    bump: minor
+  - name: pallet-democracy
+    bump: minor
+  - name: pallet-delegated-staking
+    bump: minor
+  - name: pallet-conviction-voting
+    bump: minor
+  - name: pallet-contracts
+    bump: minor
+  - name: pallet-contracts-mock-network
+    bump: minor
+  - name: pallet-collective
+    bump: minor
+  - name: pallet-child-bounties
+    bump: minor
+  - name: pallet-bounties
+    bump: minor
+  - name: pallet-balances
+    bump: minor
+  - name: pallet-babe
+    bump: minor
+  - name: pallet-asset-conversion
+    bump: minor
+  - name: pallet-asset-conversion-ops
+    bump: minor
+  - name: pallet-alliance
+    bump: minor
+  - name: xcm-simulator-fuzzer
+    bump: minor
+  - name: xcm-simulator-example
+    bump: minor
+  - name: xcm-runtime-apis
+    bump: minor
+  - name: staging-xcm-builder
+    bump: minor
+  - name: pallet-xcm
+    bump: minor
+  - name: polkadot-runtime-common
+    bump: minor
+  - name: pallet-collator-selection
+    bump: minor
+  - name: pallet-bridge-messages
+    bump: minor

substrate/frame/alliance/src/mock.rs

@@ -283,6 +283,7 @@ pub fn new_test_ext() -> sp_io::TestExternalities {
 			(8, 1000),
 			(9, 1000),
 		],
+		..Default::default()
 	}
 	.assimilate_storage(&mut t)
 	.unwrap();

substrate/frame/asset-conversion/ops/src/mock.rs

@@ -135,6 +135,7 @@ pub(crate) fn new_test_ext() -> sp_io::TestExternalities {
 
 	pallet_balances::GenesisConfig::<Test> {
 		balances: vec![(1, 10000), (2, 20000), (3, 30000), (4, 40000)],
+		..Default::default()
 	}
 	.assimilate_storage(&mut t)
 	.unwrap();

substrate/frame/asset-conversion/src/mock.rs

@@ -162,6 +162,7 @@ pub(crate) fn new_test_ext() -> sp_io::TestExternalities {
 
 	pallet_balances::GenesisConfig::<Test> {
 		balances: vec![(1, 10000), (2, 20000), (3, 30000), (4, 40000)],
+		..Default::default()
 	}
 	.assimilate_storage(&mut t)
 	.unwrap();

substrate/frame/babe/src/mock.rs

@@ -313,7 +313,7 @@ pub fn new_test_ext_raw_authorities(authorities: Vec<AuthorityId>) -> sp_io::Tes
 
 	let balances: Vec<_> = (0..authorities.len()).map(|i| (i as u64, 10_000_000)).collect();
 
-	pallet_balances::GenesisConfig::<Test> { balances }
+	pallet_balances::GenesisConfig::<Test> { balances, ..Default::default() }
 		.assimilate_storage(&mut t)
 		.unwrap();
 

substrate/frame/balances/Cargo.toml

@@ -24,11 +24,11 @@ frame-support = { workspace = true }
 frame-system = { workspace = true }
 sp-runtime = { workspace = true }
 docify = { workspace = true }
+sp-core = { workspace = true }
 
 [dev-dependencies]
 pallet-transaction-payment = { workspace = true, default-features = true }
 frame-support = { features = ["experimental"], workspace = true, default-features = true }
-sp-core = { workspace = true, default-features = true }
 sp-io = { workspace = true, default-features = true }
 paste = { workspace = true, default-features = true }
 

substrate/frame/balances/src/lib.rs

@@ -180,6 +180,12 @@ use sp_runtime::{
 	},
 	ArithmeticError, DispatchError, FixedPointOperand, Perbill, RuntimeDebug, TokenError,
 };
+
+#[cfg(feature = "runtime-benchmarks")]
+use sp_core::{sr25519::Pair as SrPair, Pair};
+#[cfg(feature = "runtime-benchmarks")]
+use alloc::{format, string::{String, ToString}};
+
 pub use types::{
 	AccountData, AdjustmentDirection, BalanceLock, DustCleaner, ExtraFlags, Reasons, ReserveData,
 };
@@ -505,11 +511,19 @@ pub mod pallet {
 	#[pallet::genesis_config]
 	pub struct GenesisConfig<T: Config<I>, I: 'static = ()> {
 		pub balances: Vec<(T::AccountId, T::Balance)>,
+
+		#[cfg(feature = "runtime-benchmarks")]
+		pub dev_accounts: (u32, T::Balance, Option<String>),
 	}
 
 	impl<T: Config<I>, I: 'static> Default for GenesisConfig<T, I> {
 		fn default() -> Self {
-			Self { balances: Default::default() }
+			Self {
+				balances: Default::default(),
+
+				#[cfg(feature = "runtime-benchmarks")]
+				dev_accounts: (One::one(), <T as Config<I>>::ExistentialDeposit::get(), Some("//Sender/{}".to_string())),
+			}
 		}
 	}
 
@@ -540,6 +554,22 @@ pub mod pallet {
 				"duplicate balances in genesis."
 			);
 
+			// Generate additional dev accounts.
+			#[cfg(feature = "runtime-benchmarks")]
+			{
+				let (num_accounts, balance, ref derivation) = self.dev_accounts;
+
+				// Check if `derivation` is `Some` and generate key pair
+				if let Some(derivation_string) = &derivation {
+					Pallet::<T, I>::derive_dev_account(num_accounts, balance, derivation_string);
+				} else {
+					// Derivation string is missing, using default..
+					let default_derivation = "//Sender/{}".to_string();
+
+					Pallet::<T, I>::derive_dev_account(num_accounts, balance, &default_derivation);
+				}
+			}
+
 			for &(ref who, free) in self.balances.iter() {
 				frame_system::Pallet::<T>::inc_providers(who);
 				assert!(T::AccountStore::insert(who, AccountData { free, ..Default::default() })
@@ -1248,5 +1278,43 @@ pub mod pallet {
 			});
 			Ok(actual)
 		}
+
+		/// Generate dev account from derivation string.
+		#[cfg(feature = "runtime-benchmarks")]
+		pub fn derive_dev_account(num_accounts: u32, balance: T::Balance, derivation: &String) {
+			// Ensure that the number of accounts is not zero
+			assert!(num_accounts > 0, "num_accounts must be greater than zero");
+
+			assert!(
+				balance >= <T as Config<I>>::ExistentialDeposit::get(),
+				"the balance of any account should always be at least the existential deposit.",
+			);
+
+			assert!(
+				derivation.contains("{}"),
+				"Invalid derivation string"
+			);
+
+			for index in 0..num_accounts {
+				// Replace "{}" in the derivation string with the index.
+				let derivation_string = derivation.replace("{}", &index.to_string());
+
+				// Attempt to create the key pair from the derivation string with error handling.
+				let pair: SrPair = Pair::from_string(&derivation_string, None)
+					.expect(&format!("Failed to parse derivation string: {}", derivation_string));
+
+				// Convert the public key to AccountId.
+				let who = T::AccountId::decode(&mut &pair.public().encode()[..])
+					.expect(&format!("Failed to decode public key from pair: {:?}", pair.public()));
+
+				frame_system::Pallet::<T>::inc_providers(&who);
+				// Insert the account into the store and ensure it succeeds(uri).
+				assert!(T::AccountStore::insert(
+					&who,
+					AccountData { free: balance, ..Default::default() }
+				)
+				.is_ok());
+			}
+		}
 	}
 }