1
// Copyright 2019-2025 PureStake Inc.
2
// This file is part of Moonbeam.
3

            
4
// Moonbeam is free software: you can redistribute it and/or modify
5
// it under the terms of the GNU General Public License as published by
6
// the Free Software Foundation, either version 3 of the License, or
7
// (at your option) any later version.
8

            
9
// Moonbeam is distributed in the hope that it will be useful,
10
// but WITHOUT ANY WARRANTY; without even the implied warranty of
11
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12
// GNU General Public License for more details.
13

            
14
// You should have received a copy of the GNU General Public License
15
// along with Moonbeam.  If not, see <http://www.gnu.org/licenses/>.
16

            
17
#![allow(dead_code)]
18

            
19
use cumulus_primitives_parachain_inherent::ParachainInherentData;
20
use fp_evm::GenesisAccount;
21
use frame_support::{
22
	assert_ok,
23
	traits::{OnFinalize, OnInitialize},
24
};
25
pub use moonbase_runtime::{
26
	currency::UNIT, AccountId, AsyncBacking, AuthorInherent, Balance, Ethereum, EvmForeignAssets,
27
	InflationInfo, ParachainStaking, Range, Runtime, RuntimeCall, RuntimeEvent, System,
28
	TransactionConverter, UncheckedExtrinsic, HOURS,
29
};
30
use nimbus_primitives::{NimbusId, NIMBUS_ENGINE_ID};
31
use polkadot_parachain::primitives::HeadData;
32
use sp_consensus_slots::Slot;
33
use sp_core::{Encode, H160};
34
use sp_runtime::{traits::Dispatchable, BuildStorage, Digest, DigestItem, Perbill, Percent};
35

            
36
use std::collections::BTreeMap;
37

            
38
use fp_rpc::ConvertTransaction;
39
use moonbase_runtime::XcmWeightTrader;
40
use pallet_transaction_payment::Multiplier;
41
use xcm::prelude::{InteriorLocation, Location};
42

            
43
11
pub fn existential_deposit() -> u128 {
44
11
	<Runtime as pallet_balances::Config>::ExistentialDeposit::get()
45
11
}
46

            
47
// A valid signed Alice transfer.
48
pub const VALID_ETH_TX: &str =
49
	"02f86d8205018085174876e80085e8d4a5100082520894f24ff3a9cf04c71dbc94d0b566f7a27b9456\
50
	6cac8080c001a0e1094e1a52520a75c0255db96132076dd0f1263089f838bea548cbdbfc64a4d19f031c\
51
	92a8cb04e2d68d20a6158d542a07ac440cc8d07b6e36af02db046d92df";
52

            
53
// An invalid signed Alice transfer with a gas limit artifically set to 0.
54
pub const INVALID_ETH_TX: &str =
55
	"f86180843b9aca00809412cb274aad8251c875c0bf6872b67d9983e53fdd01801ca00e28ba2dd3c5a\
56
	3fd467d4afd7aefb4a34b373314fff470bb9db743a84d674a0aa06e5994f2d07eafe1c37b4ce5471ca\
57
	ecec29011f6f5bf0b1a552c55ea348df35f";
58

            
59
3
pub fn rpc_run_to_block(n: u32) {
60
6
	while System::block_number() < n {
61
3
		Ethereum::on_finalize(System::block_number());
62
3
		System::set_block_number(System::block_number() + 1);
63
3
		Ethereum::on_initialize(System::block_number());
64
3
	}
65
3
}
66

            
67
/// Utility function that advances the chain to the desired block number.
68
/// If an author is provided, that author information is injected to all the blocks in the meantime.
69
9
pub fn run_to_block(n: u32, author: Option<NimbusId>) {
70
9
	// Finalize the first block
71
9
	Ethereum::on_finalize(System::block_number());
72
6609
	while System::block_number() < n {
73
		// Set the new block number and author
74
6600
		match author {
75
6600
			Some(ref author) => {
76
6600
				let pre_digest = Digest {
77
6600
					logs: vec![DigestItem::PreRuntime(NIMBUS_ENGINE_ID, author.encode())],
78
6600
				};
79
6600
				System::reset_events();
80
6600
				System::initialize(
81
6600
					&(System::block_number() + 1),
82
6600
					&System::parent_hash(),
83
6600
					&pre_digest,
84
6600
				);
85
6600
			}
86
			None => {
87
				System::set_block_number(System::block_number() + 1);
88
			}
89
		}
90

            
91
6600
		increase_last_relay_slot_number(1);
92
6600

            
93
6600
		// Initialize the new block
94
6600
		AuthorInherent::on_initialize(System::block_number());
95
6600
		ParachainStaking::on_initialize(System::block_number());
96
6600
		Ethereum::on_initialize(System::block_number());
97
6600

            
98
6600
		// Finalize the block
99
6600
		Ethereum::on_finalize(System::block_number());
100
6600
		ParachainStaking::on_finalize(System::block_number());
101
	}
102
9
}
103

            
104
8
pub fn last_event() -> RuntimeEvent {
105
8
	System::events().pop().expect("Event expected").event
106
8
}
107

            
108
// Test struct with the purpose of initializing xcm assets
109
#[derive(Clone)]
110
pub struct XcmAssetInitialization {
111
	pub asset_id: u128,
112
	pub xcm_location: xcm::v5::Location,
113
	pub decimals: u8,
114
	pub name: &'static str,
115
	pub symbol: &'static str,
116
	pub balances: Vec<(AccountId, Balance)>,
117
}
118

            
119
pub struct ExtBuilder {
120
	// endowed accounts with balances
121
	balances: Vec<(AccountId, Balance)>,
122
	// [collator, amount]
123
	collators: Vec<(AccountId, Balance)>,
124
	// [delegator, collator, nomination_amount]
125
	delegations: Vec<(AccountId, AccountId, Balance, Percent)>,
126
	// per-round inflation config
127
	inflation: InflationInfo<Balance>,
128
	// AuthorId -> AccoutId mappings
129
	mappings: Vec<(NimbusId, AccountId)>,
130
	// Crowdloan fund
131
	crowdloan_fund: Balance,
132
	// Chain id
133
	chain_id: u64,
134
	// EVM genesis accounts
135
	evm_accounts: BTreeMap<H160, GenesisAccount>,
136
	// [assettype, metadata, Vec<Account, Balance>]
137
	xcm_assets: Vec<XcmAssetInitialization>,
138
	safe_xcm_version: Option<u32>,
139
	opened_bridges: Vec<(Location, InteriorLocation, Option<bp_moonbase::LaneId>)>,
140
}
141

            
142
impl Default for ExtBuilder {
143
66
	fn default() -> ExtBuilder {
144
66
		ExtBuilder {
145
66
			balances: vec![],
146
66
			delegations: vec![],
147
66
			collators: vec![],
148
66
			inflation: InflationInfo {
149
66
				expect: Range {
150
66
					min: 100_000 * UNIT,
151
66
					ideal: 200_000 * UNIT,
152
66
					max: 500_000 * UNIT,
153
66
				},
154
66
				// not used
155
66
				annual: Range {
156
66
					min: Perbill::from_percent(50),
157
66
					ideal: Perbill::from_percent(50),
158
66
					max: Perbill::from_percent(50),
159
66
				},
160
66
				// unrealistically high parameterization, only for testing
161
66
				round: Range {
162
66
					min: Perbill::from_percent(5),
163
66
					ideal: Perbill::from_percent(5),
164
66
					max: Perbill::from_percent(5),
165
66
				},
166
66
			},
167
66
			mappings: vec![],
168
66
			crowdloan_fund: 0,
169
66
			chain_id: CHAIN_ID,
170
66
			evm_accounts: BTreeMap::new(),
171
66
			xcm_assets: vec![],
172
66
			safe_xcm_version: None,
173
66
			opened_bridges: vec![],
174
66
		}
175
66
	}
176
}
177

            
178
impl ExtBuilder {
179
2
	pub fn with_evm_accounts(mut self, accounts: BTreeMap<H160, GenesisAccount>) -> Self {
180
2
		self.evm_accounts = accounts;
181
2
		self
182
2
	}
183

            
184
44
	pub fn with_balances(mut self, balances: Vec<(AccountId, Balance)>) -> Self {
185
44
		self.balances = balances;
186
44
		self
187
44
	}
188

            
189
	pub fn with_open_bridges(
190
		mut self,
191
		opened_bridges: Vec<(Location, InteriorLocation, Option<bp_moonbase::LaneId>)>,
192
	) -> Self {
193
		self.opened_bridges = opened_bridges;
194
		self
195
	}
196

            
197
14
	pub fn with_collators(mut self, collators: Vec<(AccountId, Balance)>) -> Self {
198
14
		self.collators = collators;
199
14
		self
200
14
	}
201

            
202
7
	pub fn with_delegations(mut self, delegations: Vec<(AccountId, AccountId, Balance)>) -> Self {
203
7
		self.delegations = delegations
204
7
			.into_iter()
205
8
			.map(|d| (d.0, d.1, d.2, Percent::zero()))
206
7
			.collect();
207
7
		self
208
7
	}
209

            
210
4
	pub fn with_xcm_assets(mut self, xcm_assets: Vec<XcmAssetInitialization>) -> Self {
211
4
		self.xcm_assets = xcm_assets;
212
4
		self
213
4
	}
214

            
215
6
	pub fn with_crowdloan_fund(mut self, crowdloan_fund: Balance) -> Self {
216
6
		self.crowdloan_fund = crowdloan_fund;
217
6
		self
218
6
	}
219

            
220
13
	pub fn with_mappings(mut self, mappings: Vec<(NimbusId, AccountId)>) -> Self {
221
13
		self.mappings = mappings;
222
13
		self
223
13
	}
224

            
225
6
	pub fn with_safe_xcm_version(mut self, safe_xcm_version: u32) -> Self {
226
6
		self.safe_xcm_version = Some(safe_xcm_version);
227
6
		self
228
6
	}
229

            
230
	#[allow(dead_code)]
231
	pub fn with_inflation(mut self, inflation: InflationInfo<Balance>) -> Self {
232
		self.inflation = inflation;
233
		self
234
	}
235

            
236
66
	pub fn build(self) -> sp_io::TestExternalities {
237
66
		let mut t = frame_system::GenesisConfig::<Runtime>::default()
238
66
			.build_storage()
239
66
			.unwrap();
240
66

            
241
66
		#[cfg(any(feature = "bridge-stagenet", feature = "bridge-betanet"))]
242
66
		parachain_info::GenesisConfig::<Runtime> {
243
66
			parachain_id:
244
66
				<moonbase_runtime::bridge_config::ThisChain as bp_runtime::Parachain>::PARACHAIN_ID
245
66
					.into(),
246
66
			_config: Default::default(),
247
66
		}
248
66
		.assimilate_storage(&mut t)
249
66
		.unwrap();
250
66

            
251
66
		pallet_balances::GenesisConfig::<Runtime> {
252
66
			balances: self.balances,
253
66
		}
254
66
		.assimilate_storage(&mut t)
255
66
		.unwrap();
256
66

            
257
66
		pallet_parachain_staking::GenesisConfig::<Runtime> {
258
66
			candidates: self.collators,
259
66
			delegations: self.delegations,
260
66
			inflation_config: self.inflation,
261
66
			collator_commission: Perbill::from_percent(20),
262
66
			parachain_bond_reserve_percent: Percent::from_percent(30),
263
66
			blocks_per_round: 2 * HOURS,
264
66
			num_selected_candidates: 8,
265
66
		}
266
66
		.assimilate_storage(&mut t)
267
66
		.unwrap();
268
66

            
269
66
		pallet_crowdloan_rewards::GenesisConfig::<Runtime> {
270
66
			funded_amount: self.crowdloan_fund,
271
66
		}
272
66
		.assimilate_storage(&mut t)
273
66
		.unwrap();
274
66

            
275
66
		pallet_author_mapping::GenesisConfig::<Runtime> {
276
66
			mappings: self.mappings,
277
66
		}
278
66
		.assimilate_storage(&mut t)
279
66
		.unwrap();
280
66

            
281
66
		#[cfg(any(feature = "bridge-stagenet", feature = "bridge-betanet"))]
282
66
		pallet_xcm_bridge::GenesisConfig::<
283
66
			Runtime,
284
66
			moonbase_runtime::bridge_config::XcmBridgeInstance,
285
66
		> {
286
66
			opened_bridges: self.opened_bridges,
287
66
			_phantom: Default::default(),
288
66
		}
289
66
		.assimilate_storage(&mut t)
290
66
		.unwrap();
291
66

            
292
66
		let genesis_config = pallet_evm_chain_id::GenesisConfig::<Runtime> {
293
66
			chain_id: self.chain_id,
294
66
			..Default::default()
295
66
		};
296
66
		genesis_config.assimilate_storage(&mut t).unwrap();
297
66

            
298
66
		let genesis_config = pallet_evm::GenesisConfig::<Runtime> {
299
66
			accounts: self.evm_accounts,
300
66
			..Default::default()
301
66
		};
302
66
		genesis_config.assimilate_storage(&mut t).unwrap();
303
66

            
304
66
		let genesis_config = pallet_ethereum::GenesisConfig::<Runtime> {
305
66
			..Default::default()
306
66
		};
307
66
		genesis_config.assimilate_storage(&mut t).unwrap();
308
66

            
309
66
		let genesis_config = pallet_xcm::GenesisConfig::<Runtime> {
310
66
			safe_xcm_version: self.safe_xcm_version,
311
66
			..Default::default()
312
66
		};
313
66
		genesis_config.assimilate_storage(&mut t).unwrap();
314
66

            
315
66
		let genesis_config = pallet_transaction_payment::GenesisConfig::<Runtime> {
316
66
			multiplier: Multiplier::from(8u128),
317
66
			..Default::default()
318
66
		};
319
66
		genesis_config.assimilate_storage(&mut t).unwrap();
320
66

            
321
66
		let mut ext = sp_io::TestExternalities::new(t);
322
66

            
323
66
		let xcm_assets = self.xcm_assets.clone();
324
66

            
325
66
		ext.execute_with(|| {
326
			// If any xcm assets specified, we register them here
327
70
			for xcm_asset_initialization in xcm_assets {
328
4
				let asset_id = xcm_asset_initialization.asset_id;
329
4
				EvmForeignAssets::create_foreign_asset(
330
4
					root_origin(),
331
4
					asset_id,
332
4
					xcm_asset_initialization.xcm_location.clone(),
333
4
					xcm_asset_initialization.decimals,
334
4
					xcm_asset_initialization
335
4
						.symbol
336
4
						.as_bytes()
337
4
						.to_vec()
338
4
						.try_into()
339
4
						.expect("too long"),
340
4
					xcm_asset_initialization
341
4
						.name
342
4
						.as_bytes()
343
4
						.to_vec()
344
4
						.try_into()
345
4
						.expect("too long"),
346
4
				)
347
4
				.expect("fail to create foreign asset");
348
4

            
349
4
				XcmWeightTrader::add_asset(
350
4
					root_origin(),
351
4
					xcm_asset_initialization.xcm_location,
352
4
					UNIT,
353
4
				)
354
4
				.expect("register evm native foreign asset as sufficient");
355

            
356
8
				for (account, balance) in xcm_asset_initialization.balances {
357
4
					if EvmForeignAssets::mint_into(asset_id, account, balance.into()).is_err() {
358
						panic!("fail to mint foreign asset");
359
4
					}
360
				}
361
			}
362
66
			System::set_block_number(1);
363
66
		});
364
66
		ext
365
66
	}
366
}
367

            
368
pub const CHAIN_ID: u64 = 1281;
369
pub const ALICE: [u8; 20] = [4u8; 20];
370
pub const ALICE_NIMBUS: [u8; 32] = [4u8; 32];
371
pub const BOB: [u8; 20] = [5u8; 20];
372
pub const CHARLIE: [u8; 20] = [6u8; 20];
373
pub const DAVE: [u8; 20] = [7u8; 20];
374
pub const EVM_CONTRACT: [u8; 20] = [8u8; 20];
375

            
376
23
pub fn origin_of(account_id: AccountId) -> <Runtime as frame_system::Config>::RuntimeOrigin {
377
23
	<Runtime as frame_system::Config>::RuntimeOrigin::signed(account_id)
378
23
}
379

            
380
7
pub fn inherent_origin() -> <Runtime as frame_system::Config>::RuntimeOrigin {
381
7
	<Runtime as frame_system::Config>::RuntimeOrigin::none()
382
7
}
383

            
384
32
pub fn root_origin() -> <Runtime as frame_system::Config>::RuntimeOrigin {
385
32
	<Runtime as frame_system::Config>::RuntimeOrigin::root()
386
32
}
387

            
388
7
pub fn unchecked_eth_tx(raw_hex_tx: &str) -> UncheckedExtrinsic {
389
7
	let converter = TransactionConverter;
390
7
	converter.convert_transaction(ethereum_transaction(raw_hex_tx))
391
7
}
392

            
393
9
pub fn ethereum_transaction(raw_hex_tx: &str) -> pallet_ethereum::Transaction {
394
9
	let bytes = hex::decode(raw_hex_tx).expect("Transaction bytes.");
395
9
	let transaction = ethereum::EnvelopedDecodable::decode(&bytes[..]);
396
9
	assert!(transaction.is_ok());
397
9
	transaction.unwrap()
398
9
}
399

            
400
/// Mock the inherent that sets validation data in ParachainSystem, which
401
/// contains the `relay_chain_block_number`, which is used in `author-filter` as a
402
/// source of randomness to filter valid authors at each block.
403
7
pub fn set_parachain_inherent_data() {
404
	use cumulus_primitives_core::PersistedValidationData;
405
	use cumulus_test_relay_sproof_builder::RelayStateSproofBuilder;
406

            
407
7
	let author = AccountId::from(<pallet_evm::Pallet<Runtime>>::find_author());
408
7
	pallet_author_inherent::Author::<Runtime>::put(author);
409
7

            
410
7
	let mut relay_sproof = RelayStateSproofBuilder::default();
411
7
	relay_sproof.para_id = 100u32.into();
412
7
	relay_sproof.included_para_head = Some(HeadData(vec![1, 2, 3]));
413
7

            
414
7
	let additional_key_values = vec![(
415
7
		moonbeam_core_primitives::well_known_relay_keys::TIMESTAMP_NOW.to_vec(),
416
7
		sp_timestamp::Timestamp::default().encode(),
417
7
	)];
418
7

            
419
7
	relay_sproof.additional_key_values = additional_key_values;
420
7

            
421
7
	let (relay_parent_storage_root, relay_chain_state) = relay_sproof.into_state_root_and_proof();
422
7

            
423
7
	let vfp = PersistedValidationData {
424
7
		relay_parent_number: 1u32,
425
7
		relay_parent_storage_root,
426
7
		..Default::default()
427
7
	};
428
7
	let parachain_inherent_data = ParachainInherentData {
429
7
		validation_data: vfp,
430
7
		relay_chain_state: relay_chain_state,
431
7
		downward_messages: Default::default(),
432
7
		horizontal_messages: Default::default(),
433
7
	};
434
7
	assert_ok!(RuntimeCall::ParachainSystem(
435
7
		cumulus_pallet_parachain_system::Call::<Runtime>::set_validation_data {
436
7
			data: parachain_inherent_data
437
7
		}
438
7
	)
439
7
	.dispatch(inherent_origin()));
440
7
}
441

            
442
6602
pub(crate) fn increase_last_relay_slot_number(amount: u64) {
443
6602
	let last_relay_slot = u64::from(AsyncBacking::slot_info().unwrap_or_default().0);
444
6602
	frame_support::storage::unhashed::put(
445
6602
		&frame_support::storage::storage_prefix(b"AsyncBacking", b"SlotInfo"),
446
6602
		&((Slot::from(last_relay_slot + amount), 0)),
447
6602
	);
448
6602
}