Feat(test_utils): platform agnostic transfer_tx + mock_tx (#52)

* feat(test_utils): platform agnostic transfer_tx

* feat(test_utils): platform agnostic transfer_tx

Author: julio4

examples/checkpoints-eth.rs

@@ -3,12 +3,17 @@
 //! In this example are creating a new [`BlockContext`] instance using the
 //! test-utils provided helpers for creating mock instances.
 
-use {
-	alloy::{consensus::Transaction, primitives::U256},
-	rblib::{
-		alloy,
-		prelude::*,
-		test_utils::{BlockContextMocked, FundedAccounts, transfer_tx},
+use rblib::{
+	alloy::{
+		consensus::{Transaction, transaction::Recovered},
+		primitives::U256,
+		signers::local::PrivateKeySigner,
+	},
+	prelude::*,
+	test_utils::{
+		BlockContextMocked,
+		FundedAccounts,
+		transfer_tx as test_transfer_tx,
 	},
 };
 
@@ -58,3 +63,11 @@ fn main() -> eyre::Result<()> {
 
 	Ok(())
 }
+
+fn transfer_tx(
+	signer: &PrivateKeySigner,
+	nonce: u64,
+	value: U256,
+) -> Recovered<types::Transaction<Ethereum>> {
+	test_transfer_tx::<Ethereum>(signer, nonce, value)
+}

examples/checkpoints-op.rs

@@ -3,24 +3,17 @@
 //! In this example are creating a new [`BlockContext`] instance using the
 //! test-utils provided helpers for creating mock instances.
 
-use {
+use rblib::{
 	alloy::{
-		consensus::Transaction,
-		network::{TransactionBuilder, TxSignerSync},
-		optimism::{consensus::OpTxEnvelope, rpc_types::OpTransactionRequest},
-		primitives::{Address, U256},
+		consensus::{Transaction, transaction::Recovered},
+		primitives::U256,
 		signers::local::PrivateKeySigner,
 	},
-	rblib::{
-		alloy,
-		prelude::*,
-		reth,
-		test_utils::{BlockContextMocked, FundedAccounts},
-	},
-	reth::{
-		ethereum::primitives::SignedTransaction,
-		optimism::primitives::OpTransactionSigned,
-		primitives::Recovered,
+	prelude::*,
+	test_utils::{
+		BlockContextMocked,
+		FundedAccounts,
+		transfer_tx as test_transfer_tx,
 	},
 };
 
@@ -76,22 +69,6 @@ fn transfer_tx(
 	signer: &PrivateKeySigner,
 	nonce: u64,
 	value: U256,
-) -> Recovered<OpTxEnvelope> {
-	let mut tx = OpTransactionRequest::default()
-		.with_nonce(nonce)
-		.with_to(Address::random())
-		.value(value)
-		.with_gas_price(1_000_000_000)
-		.with_gas_limit(21_000)
-		.with_max_priority_fee_per_gas(1_000_000)
-		.with_max_fee_per_gas(2_000_000)
-		.build_unsigned()
-		.expect("valid transaction request");
-
-	let sig = signer
-		.sign_transaction_sync(&mut tx)
-		.expect("signing should succeed");
-
-	OpTransactionSigned::new_unhashed(tx, sig) //
-		.with_signer(signer.address())
+) -> Recovered<types::Transaction<Optimism>> {
+	test_transfer_tx::<Optimism>(signer, nonce, value)
 }

src/payload/checkpoint.rs

@@ -608,7 +608,8 @@ mod tests {
 		let checkpoint2 = checkpoint.barrier();
 		let checkpoint3 = checkpoint2.barrier();
 
-		let tx = transfer_tx(&FundedAccounts::signer(0), 0, U256::from(10u64));
+		let tx =
+			transfer_tx::<Ethereum>(&FundedAccounts::signer(0), 0, U256::from(10u64));
 		let checkpoint4 = checkpoint3.apply(tx).unwrap();
 
 		let history: Vec<_> = checkpoint4.into_iter().collect();

src/payload/ext/checkpoint.rs

@@ -404,7 +404,11 @@ mod tests {
 		let block = BlockContext::<Ethereum>::mocked();
 		let cp1 = Checkpoint::new_at_block(block);
 
-		let tx1 = transfer_tx(&FundedAccounts::signer(0), 0, U256::from(50_000u64));
+		let tx1 = transfer_tx::<Ethereum>(
+			&FundedAccounts::signer(0),
+			0,
+			U256::from(50_000u64),
+		);
 		let tx1_hash = *tx1.hash();
 		assert!(!cp1.contains(tx1_hash));
 		let cp2 = cp1.apply(tx1).unwrap();
@@ -456,10 +460,12 @@ mod tests {
 		let base = Checkpoint::new_at_block(block);
 
 		// base -> x -> y
-		let tx_x = transfer_tx(&FundedAccounts::signer(0), 0, U256::from(10u64));
+		let tx_x =
+			transfer_tx::<Ethereum>(&FundedAccounts::signer(0), 0, U256::from(10u64));
 		let x = base.apply(tx_x).unwrap();
 
-		let tx_y = transfer_tx(&FundedAccounts::signer(1), 0, U256::from(20u64));
+		let tx_y =
+			transfer_tx::<Ethereum>(&FundedAccounts::signer(1), 0, U256::from(20u64));
 		let y = x.apply(tx_y).unwrap();
 
 		let x_barrier = x.barrier();
@@ -487,7 +493,8 @@ mod tests {
 		let root1 = Checkpoint::new_at_block(block1);
 		let root2 = Checkpoint::new_at_block(block2);
 
-		let tx = transfer_tx(&FundedAccounts::signer(0), 0, U256::from(5u64));
+		let tx =
+			transfer_tx::<Ethereum>(&FundedAccounts::signer(0), 0, U256::from(5u64));
 		let root1_child = root1.apply(tx).unwrap();
 
 		assert!(root1_child.to(&root2).is_err());
@@ -504,7 +511,11 @@ mod tests {
 			"Empty checkpoint should have zero tip"
 		);
 
-		let tx = transfer_tx(&FundedAccounts::signer(0), 0, U256::from(100u64));
+		let tx = transfer_tx::<Ethereum>(
+			&FundedAccounts::signer(0),
+			0,
+			U256::from(100u64),
+		);
 		let cp2 = cp.apply(tx.clone()).unwrap();
 
 		let tip = cp2.effective_tip_per_gas();
@@ -516,10 +527,12 @@ mod tests {
 		let block = BlockContext::<Ethereum>::mocked();
 		let base = Checkpoint::new_at_block(block);
 
-		let tx1 = transfer_tx(&FundedAccounts::signer(0), 0, U256::from(50u64));
+		let tx1 =
+			transfer_tx::<Ethereum>(&FundedAccounts::signer(0), 0, U256::from(50u64));
 		let cp1 = base.apply(tx1).unwrap();
 
-		let tx2 = transfer_tx(&FundedAccounts::signer(1), 0, U256::from(75u64));
+		let tx2 =
+			transfer_tx::<Ethereum>(&FundedAccounts::signer(1), 0, U256::from(75u64));
 		let cp2 = cp1.apply(tx2).unwrap();
 
 		let staging = cp2.history_staging();
@@ -537,12 +550,14 @@ mod tests {
 		let block = BlockContext::<Ethereum>::mocked();
 		let base = Checkpoint::new_at_block(block);
 
-		let tx1 = transfer_tx(&FundedAccounts::signer(0), 0, U256::from(50u64));
+		let tx1 =
+			transfer_tx::<Ethereum>(&FundedAccounts::signer(0), 0, U256::from(50u64));
 		let cp1 = base.apply(tx1).unwrap();
 
 		let barrier = cp1.barrier();
 
-		let tx2 = transfer_tx(&FundedAccounts::signer(1), 0, U256::from(75u64));
+		let tx2 =
+			transfer_tx::<Ethereum>(&FundedAccounts::signer(1), 0, U256::from(75u64));
 		let cp2 = barrier.apply(tx2).unwrap();
 
 		let staging = cp2.history_staging();

src/test_utils/accounts.rs

@@ -15,7 +15,7 @@ use {
 	std::sync::Arc,
 };
 
-/// Those accounts are defined in the gensis block of the test local node,
+/// Those accounts are defined in the genesis block of the test local node,
 /// each prefunded with 100 ETH and nonces starting from 0.
 pub struct FundedAccounts;
 

src/test_utils/mod.rs

@@ -33,7 +33,7 @@ pub use {
 	platform::{TestNodeFactory, TestablePlatform},
 	rblib_tests_macros::{assert_is_dyn_safe, if_platform, rblib_test},
 	step::{AlwaysBreakStep, AlwaysFailStep, AlwaysOkStep, OneStep},
-	transactions::transfer_tx,
+	transactions::{mock_tx, transfer_tx},
 };
 
 #[cfg(feature = "optimism")]

src/test_utils/transactions.rs

@@ -1,28 +1,35 @@
 use {
-	crate::{alloy, reth},
+	crate::{alloy, prelude, reth, test_utils},
 	alloy::{
-		consensus::{EthereumTxEnvelope, TxEip4844},
+		consensus::SignableTransaction,
 		network::{TransactionBuilder, TxSignerSync},
 		primitives::{Address, U256},
 		signers::local::PrivateKeySigner,
 	},
-	reth::{
-		ethereum::{TransactionSigned, primitives::SignedTransaction},
-		primitives::Recovered,
-		rpc::types::TransactionRequest,
-	},
+	prelude::*,
+	reth::{ethereum::primitives::SignedTransaction, primitives::Recovered},
+	test_utils::FundedAccounts,
 };
 
+/// A mock tx to easily get a valid tx from `FundedAccounts` with `key` and
+/// `nonce`
+pub fn mock_tx<P: PlatformWithRpcTypes>(
+	key: u32,
+	nonce: u64,
+) -> Recovered<types::Transaction<P>> {
+	transfer_tx::<P>(&FundedAccounts::signer(key), nonce, U256::from(10u64))
+}
+
 #[allow(clippy::missing_panics_doc)]
-pub fn transfer_tx(
+pub fn transfer_tx<P: PlatformWithRpcTypes>(
 	signer: &PrivateKeySigner,
 	nonce: u64,
 	value: U256,
-) -> Recovered<EthereumTxEnvelope<TxEip4844>> {
-	let mut tx = TransactionRequest::default()
+) -> Recovered<types::Transaction<P>> {
+	let mut tx = types::TransactionRequest::<P>::default()
 		.with_nonce(nonce)
 		.with_to(Address::random())
-		.value(value)
+		.with_value(value)
 		.with_gas_price(1_000_000_000)
 		.with_gas_limit(21_000)
 		.with_max_priority_fee_per_gas(1_000_000)
@@ -34,6 +41,7 @@ pub fn transfer_tx(
 		.sign_transaction_sync(&mut tx)
 		.expect("signing should succeed");
 
-	TransactionSigned::new_unhashed(tx.into(), sig) //
-		.with_signer(signer.address())
+	let signed_tx: types::TxEnvelope<P> = tx.into_signed(sig).into();
+	let signed_tx: types::Transaction<P> = signed_tx.into();
+	signed_tx.with_signer(signer.address())
 }