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 moonriver_runtime::{
26
	asset_config::AssetRegistrarMetadata, currency::MOVR, xcm_config::AssetType, AccountId,
27
	AssetId, AssetManager, AsyncBacking, AuthorInherent, Balance, Ethereum, InflationInfo,
28
	ParachainStaking, Range, Runtime, RuntimeCall, RuntimeEvent, System, TransactionConverter,
29
	UncheckedExtrinsic, HOURS,
30
};
31
use nimbus_primitives::{NimbusId, NIMBUS_ENGINE_ID};
32
use polkadot_parachain::primitives::HeadData;
33
use sp_consensus_slots::Slot;
34
use sp_core::{Encode, H160};
35
use sp_runtime::{traits::Dispatchable, BuildStorage, Digest, DigestItem, Perbill, Percent};
36

            
37
use std::collections::BTreeMap;
38

            
39
use fp_rpc::ConvertTransaction;
40
use moonriver_runtime::{Assets, EvmForeignAssets};
41
use pallet_transaction_payment::Multiplier;
42

            
43
10
pub fn existential_deposit() -> u128 {
44
10
	<Runtime as pallet_balances::Config>::ExistentialDeposit::get()
45
10
}
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
3
pub fn last_event() -> RuntimeEvent {
105
3
	System::events().pop().expect("Event expected").event
106
3
}
107

            
108
// Helper function to give a simple evm context suitable for tests.
109
// We can remove this once https://github.com/rust-blockchain/evm/pull/35
110
// is in our dependency graph.
111
pub fn evm_test_context() -> fp_evm::Context {
112
	fp_evm::Context {
113
		address: Default::default(),
114
		caller: Default::default(),
115
		apparent_value: From::from(0),
116
	}
117
}
118

            
119
// Test struct with the purpose of initializing xcm assets
120
#[derive(Clone)]
121
pub struct XcmAssetInitialization {
122
	pub asset_type: AssetType,
123
	pub metadata: AssetRegistrarMetadata,
124
	pub balances: Vec<(AccountId, Balance)>,
125
	pub is_sufficient: bool,
126
}
127

            
128
pub struct ExtBuilder {
129
	// endowed accounts with balances
130
	balances: Vec<(AccountId, Balance)>,
131
	// [collator, amount]
132
	collators: Vec<(AccountId, Balance)>,
133
	// [delegator, collator, nomination_amount]
134
	delegations: Vec<(AccountId, AccountId, Balance, Percent)>,
135
	// per-round inflation config
136
	inflation: InflationInfo<Balance>,
137
	// AuthorId -> AccoutId mappings
138
	mappings: Vec<(NimbusId, AccountId)>,
139
	// Crowdloan fund
140
	crowdloan_fund: Balance,
141
	// Chain id
142
	chain_id: u64,
143
	// EVM genesis accounts
144
	evm_accounts: BTreeMap<H160, GenesisAccount>,
145
	// [assettype, metadata, Vec<Account, Balance,>, is_sufficient]
146
	xcm_assets: Vec<XcmAssetInitialization>,
147
	evm_native_foreign_assets: bool,
148
	safe_xcm_version: Option<u32>,
149
}
150

            
151
impl Default for ExtBuilder {
152
62
	fn default() -> ExtBuilder {
153
62
		ExtBuilder {
154
62
			balances: vec![],
155
62
			delegations: vec![],
156
62
			collators: vec![],
157
62
			inflation: InflationInfo {
158
62
				expect: Range {
159
62
					min: 100_000 * MOVR,
160
62
					ideal: 200_000 * MOVR,
161
62
					max: 500_000 * MOVR,
162
62
				},
163
62
				// not used
164
62
				annual: Range {
165
62
					min: Perbill::from_percent(50),
166
62
					ideal: Perbill::from_percent(50),
167
62
					max: Perbill::from_percent(50),
168
62
				},
169
62
				// unrealistically high parameterization, only for testing
170
62
				round: Range {
171
62
					min: Perbill::from_percent(5),
172
62
					ideal: Perbill::from_percent(5),
173
62
					max: Perbill::from_percent(5),
174
62
				},
175
62
			},
176
62
			mappings: vec![],
177
62
			crowdloan_fund: 0,
178
62
			chain_id: CHAIN_ID,
179
62
			evm_accounts: BTreeMap::new(),
180
62
			xcm_assets: vec![],
181
62
			evm_native_foreign_assets: false,
182
62
			safe_xcm_version: None,
183
62
		}
184
62
	}
185
}
186

            
187
impl ExtBuilder {
188
2
	pub fn with_evm_accounts(mut self, accounts: BTreeMap<H160, GenesisAccount>) -> Self {
189
2
		self.evm_accounts = accounts;
190
2
		self
191
2
	}
192

            
193
43
	pub fn with_balances(mut self, balances: Vec<(AccountId, Balance)>) -> Self {
194
43
		self.balances = balances;
195
43
		self
196
43
	}
197

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

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

            
211
6
	pub fn with_crowdloan_fund(mut self, crowdloan_fund: Balance) -> Self {
212
6
		self.crowdloan_fund = crowdloan_fund;
213
6
		self
214
6
	}
215

            
216
14
	pub fn with_mappings(mut self, mappings: Vec<(NimbusId, AccountId)>) -> Self {
217
14
		self.mappings = mappings;
218
14
		self
219
14
	}
220

            
221
	#[allow(dead_code)]
222
	pub fn with_inflation(mut self, inflation: InflationInfo<Balance>) -> Self {
223
		self.inflation = inflation;
224
		self
225
	}
226

            
227
9
	pub fn with_xcm_assets(mut self, xcm_assets: Vec<XcmAssetInitialization>) -> Self {
228
9
		self.xcm_assets = xcm_assets;
229
9
		self
230
9
	}
231

            
232
1
	pub fn with_evm_native_foreign_assets(mut self) -> Self {
233
1
		self.evm_native_foreign_assets = true;
234
1
		self
235
1
	}
236

            
237
6
	pub fn with_safe_xcm_version(mut self, safe_xcm_version: u32) -> Self {
238
6
		self.safe_xcm_version = Some(safe_xcm_version);
239
6
		self
240
6
	}
241

            
242
62
	pub fn build(self) -> sp_io::TestExternalities {
243
62
		let mut t = frame_system::GenesisConfig::<Runtime>::default()
244
62
			.build_storage()
245
62
			.unwrap();
246
62

            
247
62
		pallet_balances::GenesisConfig::<Runtime> {
248
62
			balances: self.balances,
249
62
		}
250
62
		.assimilate_storage(&mut t)
251
62
		.unwrap();
252
62

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

            
265
62
		pallet_crowdloan_rewards::GenesisConfig::<Runtime> {
266
62
			funded_amount: self.crowdloan_fund,
267
62
		}
268
62
		.assimilate_storage(&mut t)
269
62
		.unwrap();
270
62

            
271
62
		pallet_author_mapping::GenesisConfig::<Runtime> {
272
62
			mappings: self.mappings,
273
62
		}
274
62
		.assimilate_storage(&mut t)
275
62
		.unwrap();
276
62

            
277
62
		let genesis_config = pallet_evm_chain_id::GenesisConfig::<Runtime> {
278
62
			chain_id: self.chain_id,
279
62
			..Default::default()
280
62
		};
281
62
		genesis_config.assimilate_storage(&mut t).unwrap();
282
62

            
283
62
		let genesis_config = pallet_evm::GenesisConfig::<Runtime> {
284
62
			accounts: self.evm_accounts,
285
62
			..Default::default()
286
62
		};
287
62
		genesis_config.assimilate_storage(&mut t).unwrap();
288
62

            
289
62
		let genesis_config = pallet_ethereum::GenesisConfig::<Runtime> {
290
62
			..Default::default()
291
62
		};
292
62
		genesis_config.assimilate_storage(&mut t).unwrap();
293
62

            
294
62
		let genesis_config = pallet_xcm::GenesisConfig::<Runtime> {
295
62
			safe_xcm_version: self.safe_xcm_version,
296
62
			..Default::default()
297
62
		};
298
62
		genesis_config.assimilate_storage(&mut t).unwrap();
299
62

            
300
62
		let genesis_config = pallet_transaction_payment::GenesisConfig::<Runtime> {
301
62
			multiplier: Multiplier::from(10u128),
302
62
			..Default::default()
303
62
		};
304
62
		genesis_config.assimilate_storage(&mut t).unwrap();
305
62

            
306
62
		let mut ext = sp_io::TestExternalities::new(t);
307
62
		let xcm_assets = self.xcm_assets.clone();
308
62
		ext.execute_with(|| {
309
			// If any xcm assets specified, we register them here
310
71
			for xcm_asset_initialization in xcm_assets {
311
9
				let asset_id: AssetId = xcm_asset_initialization.asset_type.clone().into();
312
9
				if self.evm_native_foreign_assets {
313
1
					let AssetType::Xcm(location) = xcm_asset_initialization.asset_type;
314
1
					let metadata = xcm_asset_initialization.metadata.clone();
315
1
					EvmForeignAssets::register_foreign_asset(
316
1
						asset_id,
317
1
						xcm::VersionedLocation::from(location).try_into().unwrap(),
318
1
						metadata.decimals,
319
1
						metadata.symbol.try_into().unwrap(),
320
1
						metadata.name.try_into().unwrap(),
321
1
					)
322
1
					.expect("register evm native foreign asset");
323

            
324
2
					for (account, balance) in xcm_asset_initialization.balances {
325
1
						EvmForeignAssets::mint_into(asset_id.into(), account, balance.into())
326
1
							.expect("mint evm native foreign asset");
327
1
					}
328
				} else {
329
8
					AssetManager::register_foreign_asset(
330
8
						root_origin(),
331
8
						xcm_asset_initialization.asset_type,
332
8
						xcm_asset_initialization.metadata,
333
8
						1,
334
8
						xcm_asset_initialization.is_sufficient,
335
8
					)
336
8
					.unwrap();
337
16
					for (account, balance) in xcm_asset_initialization.balances {
338
8
						Assets::mint(
339
8
							origin_of(AssetManager::account_id()),
340
8
							asset_id.into(),
341
8
							account,
342
8
							balance,
343
8
						)
344
8
						.unwrap();
345
8
					}
346
				}
347
			}
348
62
			System::set_block_number(1);
349
62
		});
350
62
		ext
351
62
	}
352
}
353

            
354
pub const CHAIN_ID: u64 = 1281;
355
pub const ALICE: [u8; 20] = [4u8; 20];
356
pub const ALICE_NIMBUS: [u8; 32] = [4u8; 32];
357
pub const BOB: [u8; 20] = [5u8; 20];
358
pub const CHARLIE: [u8; 20] = [6u8; 20];
359
pub const DAVE: [u8; 20] = [7u8; 20];
360
pub const EVM_CONTRACT: [u8; 20] = [8u8; 20];
361

            
362
30
pub fn origin_of(account_id: AccountId) -> <Runtime as frame_system::Config>::RuntimeOrigin {
363
30
	<Runtime as frame_system::Config>::RuntimeOrigin::signed(account_id)
364
30
}
365

            
366
14
pub fn inherent_origin() -> <Runtime as frame_system::Config>::RuntimeOrigin {
367
14
	<Runtime as frame_system::Config>::RuntimeOrigin::none()
368
14
}
369

            
370
25
pub fn root_origin() -> <Runtime as frame_system::Config>::RuntimeOrigin {
371
25
	<Runtime as frame_system::Config>::RuntimeOrigin::root()
372
25
}
373

            
374
/// Mock the inherent that sets validation data in ParachainSystem, which
375
/// contains the `relay_chain_block_number`, which is used in `author-filter` as a
376
/// source of randomness to filter valid authors at each block.
377
14
pub fn set_parachain_inherent_data() {
378
	use cumulus_primitives_core::PersistedValidationData;
379
	use cumulus_test_relay_sproof_builder::RelayStateSproofBuilder;
380

            
381
14
	let author = AccountId::from(<pallet_evm::Pallet<Runtime>>::find_author());
382
14
	pallet_author_inherent::Author::<Runtime>::put(author);
383
14

            
384
14
	let mut relay_sproof = RelayStateSproofBuilder::default();
385
14
	relay_sproof.para_id = 100u32.into();
386
14
	relay_sproof.included_para_head = Some(HeadData(vec![1, 2, 3]));
387
14

            
388
14
	let additional_key_values = vec![(
389
14
		moonbeam_core_primitives::well_known_relay_keys::TIMESTAMP_NOW.to_vec(),
390
14
		sp_timestamp::Timestamp::default().encode(),
391
14
	)];
392
14

            
393
14
	relay_sproof.additional_key_values = additional_key_values;
394
14

            
395
14
	let (relay_parent_storage_root, relay_chain_state) = relay_sproof.into_state_root_and_proof();
396
14

            
397
14
	let vfp = PersistedValidationData {
398
14
		relay_parent_number: 1u32,
399
14
		relay_parent_storage_root,
400
14
		..Default::default()
401
14
	};
402
14
	let parachain_inherent_data = ParachainInherentData {
403
14
		validation_data: vfp,
404
14
		relay_chain_state: relay_chain_state,
405
14
		downward_messages: Default::default(),
406
14
		horizontal_messages: Default::default(),
407
14
	};
408
14
	assert_ok!(RuntimeCall::ParachainSystem(
409
14
		cumulus_pallet_parachain_system::Call::<Runtime>::set_validation_data {
410
14
			data: parachain_inherent_data
411
14
		}
412
14
	)
413
14
	.dispatch(inherent_origin()));
414
14
}
415

            
416
7
pub fn unchecked_eth_tx(raw_hex_tx: &str) -> UncheckedExtrinsic {
417
7
	let converter = TransactionConverter;
418
7
	converter.convert_transaction(ethereum_transaction(raw_hex_tx))
419
7
}
420

            
421
9
pub fn ethereum_transaction(raw_hex_tx: &str) -> pallet_ethereum::Transaction {
422
9
	let bytes = hex::decode(raw_hex_tx).expect("Transaction bytes.");
423
9
	let transaction = ethereum::EnvelopedDecodable::decode(&bytes[..]);
424
9
	assert!(transaction.is_ok());
425
9
	transaction.unwrap()
426
9
}
427

            
428
6602
pub(crate) fn increase_last_relay_slot_number(amount: u64) {
429
6602
	let last_relay_slot = u64::from(AsyncBacking::slot_info().unwrap_or_default().0);
430
6602
	frame_support::storage::unhashed::put(
431
6602
		&frame_support::storage::storage_prefix(b"AsyncBacking", b"SlotInfo"),
432
6602
		&((Slot::from(last_relay_slot + amount), 0)),
433
6602
	);
434
6602
}