signet-test-utils 0.16.2

Common utilities for testing Signet components
Documentation
use alloy::{
    consensus::{
        constants::{ETH_TO_WEI, GWEI_TO_WEI},
        Header, ReceiptEnvelope, TxEip1559, TxEnvelope,
    },
    primitives::{Address, U256},
    signers::{local::PrivateKeySigner, Signature},
    sol_types::SolEvent,
    uint,
};
use signet_constants::SignetSystemConstants;
use signet_evm::{
    sys::{MintNative, MintToken, MintTokenSysLog, SysBase},
    SignetDriver,
};
use signet_extract::{Extractable, ExtractedEvent, Extracts};
use signet_test_utils::{
    chain::{
        fake_block, Chain, HOST_USDC, HOST_USDT, RU_CHAIN_ID, RU_WETH, USDC_RECORD, USDT_RECORD,
    },
    evm::test_signet_evm,
    specs::{make_wallet, sign_tx_with_key_pair, simple_send},
};
use signet_types::primitives::{RecoveredBlock, SealedHeader, TransactionSigned};
use signet_zenith::MINTER_ADDRESS;
use trevm::revm::database::in_memory_db::InMemoryDB;

struct TestEnv {
    pub wallets: Vec<PrivateKeySigner>,
    pub nonces: [u64; 10],
    pub sequence: u64,
}

impl TestEnv {
    fn new() -> Self {
        let wallets = (1..=10).map(make_wallet).collect::<Vec<_>>();

        Self { wallets, nonces: [0; 10], sequence: 1 }
    }

    fn driver<'a, 'b, C: Extractable>(
        &self,
        extracts: &'a mut Extracts<'b, C>,
        txns: Vec<TransactionSigned>,
    ) -> SignetDriver<'a, 'b, C> {
        let header = Header { gas_limit: 30_000_000, ..Default::default() };
        SignetDriver::new(
            extracts,
            Default::default(),
            txns.into(),
            SealedHeader::new(header),
            SignetSystemConstants::test(),
        )
    }

    fn trevm(&self) -> signet_evm::EvmNeedsBlock<InMemoryDB> {
        let mut trevm = test_signet_evm();
        for wallet in &self.wallets {
            let address = wallet.address();
            trevm.test_set_balance(address, U256::from(ETH_TO_WEI * 100));
        }
        trevm
    }

    /// Get the next zenith header in the sequence
    fn next_block(&mut self) -> RecoveredBlock {
        let block = fake_block(self.sequence);
        self.sequence += 1;
        block
    }

    fn signed_simple_send(&mut self, from: usize, to: Address, amount: U256) -> TxEnvelope {
        let wallet = &self.wallets[from];
        let tx = simple_send(to, amount, self.nonces[from], RU_CHAIN_ID);
        let tx = sign_tx_with_key_pair(wallet, tx);
        self.nonces[from] += 1;
        tx
    }
}

#[test]
fn test_simple_send() {
    let mut context = TestEnv::new();

    // Set up a simple transfer
    let to = Address::repeat_byte(2);
    let tx = context.signed_simple_send(0, to, U256::from(100));

    // Setup the driver
    let block = context.next_block();
    let mut extracts = Extracts::<Chain>::empty(&block);
    let mut driver = context.driver(&mut extracts, vec![tx.clone().into()]);

    // Run the EVM
    let mut trevm = context.trevm().drive_block(&mut driver).unwrap();
    let (sealed_block, receipts) = driver.finish();

    // Assert that the EVM balance increased
    assert_eq!(sealed_block.senders().count(), 1);
    assert_eq!(sealed_block.transactions().len(), 1);
    let actual: &TransactionSigned = &sealed_block.transactions()[0];
    assert_eq!(actual, &TransactionSigned::from(tx.clone()));
    assert_eq!(receipts.len(), 1);

    assert_eq!(trevm.read_balance(to), U256::from(100));
}

#[test]
fn test_two_sends() {
    let mut context = TestEnv::new();

    // Set up a simple transfer
    let to = Address::repeat_byte(2);
    let tx1 = context.signed_simple_send(0, to, U256::from(100));

    let to2 = Address::repeat_byte(3);
    let tx2 = context.signed_simple_send(0, to2, U256::from(100));

    // Setup the driver
    let block = context.next_block();
    let mut extracts = Extracts::<Chain>::empty(&block);
    let mut driver = context.driver(&mut extracts, vec![tx1.clone().into(), tx2.clone().into()]);

    // Run the EVM
    let mut trevm = context.trevm().drive_block(&mut driver).unwrap();
    let (sealed_block, receipts) = driver.finish();

    // Assert that the EVM balance increased
    assert_eq!(sealed_block.senders().count(), 2);
    let txns: Vec<&TransactionSigned> = sealed_block.transactions().iter().map(|t| &**t).collect();
    assert_eq!(txns, vec![&TransactionSigned::from(tx1), &TransactionSigned::from(tx2)]);
    assert_eq!(receipts.len(), 2);

    assert_eq!(trevm.read_balance(to), U256::from(100));
    assert_eq!(trevm.read_balance(to2), U256::from(100));
}

#[test]
fn test_execute_two_blocks() {
    let mut context = TestEnv::new();
    let sender = context.wallets[0].address();

    let to = Address::repeat_byte(2);
    let tx = context.signed_simple_send(0, to, U256::from(100));

    // Setup the driver
    let block = context.next_block();
    let mut extracts = Extracts::<Chain>::empty(&block);
    let mut driver = context.driver(&mut extracts, vec![tx.clone().into()]);

    // Run the EVM
    let mut trevm = context.trevm().drive_block(&mut driver).unwrap();
    let (sealed_block, receipts) = driver.finish();

    assert_eq!(sealed_block.senders().count(), 1);
    let actual: &TransactionSigned = &sealed_block.transactions()[0];
    assert_eq!(actual, &TransactionSigned::from(tx.clone()));
    assert_eq!(receipts.len(), 1);
    assert_eq!(trevm.read_balance(to), U256::from(100));
    assert_eq!(trevm.read_nonce(sender), 1);

    // Repeat the above for the next block
    // same recipient
    let tx = context.signed_simple_send(0, to, U256::from(100));

    // Setup the driver
    let block = context.next_block();
    let mut extracts = Extracts::<Chain>::empty(&block);
    let mut driver = context.driver(&mut extracts, vec![tx.clone().into()]);

    // Run the EVM
    let mut trevm = trevm.drive_block(&mut driver).unwrap();
    let (sealed_block, receipts) = driver.finish();

    assert_eq!(sealed_block.senders().count(), 1);
    let actual: &TransactionSigned = &sealed_block.transactions()[0];
    assert_eq!(actual, &TransactionSigned::from(tx.clone()));
    assert_eq!(receipts.len(), 1);
    assert_eq!(trevm.read_balance(to), U256::from(200));
}

#[test]
fn test_an_enter() {
    let mut context = TestEnv::new();
    let user = Address::repeat_byte(2);

    // Set up a fake event
    let fake_tx = fake_tx();
    let fake_receipt = ReceiptEnvelope::Eip1559(Default::default());

    let enter = signet_zenith::Passage::Enter {
        rollupChainId: U256::from(RU_CHAIN_ID),
        rollupRecipient: user,
        amount: U256::from(100),
    };

    // Setup the driver
    let block = context.next_block();
    let mut extracts = Extracts::<Chain>::empty(&block);
    extracts.enters.push(ExtractedEvent {
        tx: &fake_tx,
        receipt: &fake_receipt,
        log_index: 0,
        event: enter,
    });
    let mut driver = context.driver(&mut extracts, vec![]);

    // Run the EVM
    let _trevm = context.trevm().drive_block(&mut driver).unwrap();
    let (sealed_block, receipts) = driver.finish();

    let expected_tx =
        MintToken::from_enter(RU_WETH, &extracts.enters[0]).with_nonce(0).produce_transaction();

    assert_eq!(sealed_block.senders().count(), 1);
    let actual: &TransactionSigned = &sealed_block.transactions()[0];
    assert_eq!(actual, &expected_tx);
    assert_eq!(receipts.len(), 1);
    dbg!(&receipts);

    let ReceiptEnvelope::Eip1559(ref receipt) = receipts[0] else {
        panic!("expected 1559 receipt")
    };
    let mint_log = receipt.receipt.logs.last().unwrap();

    let decoded = MintTokenSysLog::decode_log(mint_log).unwrap();

    assert_eq!(decoded.address, MINTER_ADDRESS);
    assert_eq!(decoded.recipient, user);
    assert_eq!(decoded.amount, U256::from(100));
    assert_eq!(decoded.hostToken, Address::repeat_byte(0xee));
}

#[test]
fn test_a_transact() {
    tracing_subscriber::fmt::init();

    let mut context = TestEnv::new();
    let sender = Address::repeat_byte(1);
    let recipient = Address::repeat_byte(2);
    let third_party = Address::repeat_byte(3);

    // Set up a couple fake events
    let fake_tx = fake_tx();
    let fake_receipt = ReceiptEnvelope::Eip1559(Default::default());

    let enter = signet_zenith::Passage::Enter {
        rollupChainId: U256::from(RU_CHAIN_ID),
        rollupRecipient: sender,
        amount: U256::from(ETH_TO_WEI),
    };

    let enter_token = signet_zenith::Passage::EnterToken {
        rollupChainId: U256::from(RU_CHAIN_ID),
        rollupRecipient: sender,
        token: HOST_USDC,
        amount: U256::from(ETH_TO_WEI),
    };

    let enter_token_2 = signet_zenith::Passage::EnterToken {
        rollupChainId: U256::from(RU_CHAIN_ID),
        rollupRecipient: third_party,
        token: HOST_USDT,
        amount: uint!(1_000_000_000_000_U256),
    };

    let enter_token_3 = signet_zenith::Passage::EnterToken {
        rollupChainId: U256::from(RU_CHAIN_ID),
        rollupRecipient: third_party,
        token: HOST_USDC,
        amount: U256::from(1_000_000),
    };

    let transact = signet_zenith::Transactor::Transact {
        rollupChainId: U256::from(RU_CHAIN_ID),
        sender,
        to: recipient,
        data: Default::default(),
        value: U256::from(100),
        gas: U256::from(21_000),
        maxFeePerGas: U256::from(GWEI_TO_WEI),
    };

    // Setup extraction outputs
    let block = context.next_block();
    let mut extracts = Extracts::<Chain>::empty(&block);
    extracts.enters.push(ExtractedEvent {
        tx: &fake_tx,
        receipt: &fake_receipt,
        log_index: 0,
        event: enter,
    });
    extracts.enter_tokens.push(ExtractedEvent {
        tx: &fake_tx,
        receipt: &fake_receipt,
        log_index: 0,
        event: enter_token,
    });
    extracts.enter_tokens.push(ExtractedEvent {
        tx: &fake_tx,
        receipt: &fake_receipt,
        log_index: 0,
        event: enter_token_2,
    });
    extracts.enter_tokens.push(ExtractedEvent {
        tx: &fake_tx,
        receipt: &fake_receipt,
        log_index: 0,
        event: enter_token_3,
    });
    extracts.transacts.push(ExtractedEvent {
        tx: &fake_tx,
        receipt: &fake_receipt,
        log_index: 0,
        event: transact,
    });

    // Setup the driver
    let mut driver = context.driver(&mut extracts, vec![]);

    // Run the EVM
    let mut trevm = context.trevm().drive_block(&mut driver).unwrap();
    let (sealed_block, receipts) = driver.finish();

    // Transactions for the block should be:
    // 1. MintToken for the enter event
    // 2. MintNative for the enter token event
    // 3. Transact for the transact event
    // 4. MintNative for the second enter token event
    // 5. MintNative for the third enter token event
    let expected_sys_0 = MintToken::from_enter(RU_WETH, &extracts.enters[0]).with_nonce(0);
    let expected_tx_0 = expected_sys_0.produce_transaction();

    let expected_sys_1 =
        MintNative::new(&extracts.enter_tokens[0], USDC_RECORD.decimals()).with_nonce(1);
    let expected_tx_1 = expected_sys_1.produce_transaction();

    let expected_sys_2 =
        MintNative::new(&extracts.enter_tokens[1], USDT_RECORD.decimals()).with_nonce(2);
    let expected_tx_2 = expected_sys_2.produce_transaction();

    let expected_sys_3 =
        MintNative::new(&extracts.enter_tokens[2], USDC_RECORD.decimals()).with_nonce(3);
    let expected_tx_3 = expected_sys_3.produce_transaction();

    let expected_tx_4 = extracts.transacts[0].make_transaction(0, false);

    assert_eq!(
        sealed_block.senders().collect::<Vec<_>>(),
        vec![MINTER_ADDRESS, MINTER_ADDRESS, MINTER_ADDRESS, MINTER_ADDRESS, sender]
    );
    let txns: Vec<&TransactionSigned> = sealed_block.transactions().iter().map(|t| &**t).collect();
    assert_eq!(
        txns,
        vec![&expected_tx_0, &expected_tx_1, &expected_tx_2, &expected_tx_3, &expected_tx_4]
    );
    assert_eq!(receipts.len(), 5);
    assert_eq!(trevm.read_balance(recipient), U256::from(100));

    let inbound_usdt = expected_sys_2.mint_amount();
    let inbound_usdc = expected_sys_3.mint_amount();
    let expected_third_party_balance = inbound_usdc + inbound_usdt;
    assert_eq!(trevm.read_balance(third_party), expected_third_party_balance);
}

fn fake_tx() -> TransactionSigned {
    let tx = TxEip1559::default();
    let signature = Signature::test_signature();
    TransactionSigned::new_unhashed(tx.into(), signature)
}