signet-test-utils 0.9.0

use super::{sign_tx_with_key_pair, simple_send};
use alloy::{
    consensus::{BlobTransactionSidecar, SidecarBuilder, SimpleCoder, TxEnvelope},
    eips::eip2718::Encodable2718,
    primitives::{keccak256, Address, Bytes, B256, U256},
    rlp::Encodable,
    signers::local::PrivateKeySigner,
};
use signet_constants::test_utils::*;
use signet_extract::{Extractable, Extracts};
use signet_types::{
    constants::{KnownChains, ParseChainError, SignetSystemConstants},
    primitives::TransactionSigned,
};
use signet_zenith::Zenith::{self};
use std::str::FromStr;

/// A block spec for the Ru chain.
///
/// Typically this should be used as follows:
/// 1. Instantiate with a [`SignetSystemConstants`] object via [`Self::new`].
/// 2. Add transactions to the block with [`Self::add_tx`].
/// 3. Optionally set the gas limit with [`Self::with_gas_limit`].
/// 4. Optionally set the reward address with [`Self::with_reward_address`].
/// 5. Add to a [`HostBlockSpec`] via `HostBlockSpec::add_ru_block`.
///
/// [`HostBlockSpec`]: crate::test_utils::HostBlockSpec
#[derive(Debug, Clone)]
pub struct RuBlockSpec {
    /// The system constants for the block.
    pub constants: SignetSystemConstants,
    /// The transactions in the block.
    pub tx: Vec<Vec<u8>>,
    /// The gas limit for the block.
    pub gas_limit: Option<u64>,
    /// The reward address for the block.
    pub reward_address: Option<Address>,
}

impl RuBlockSpec {
    /// Create a new empty RU block spec.
    pub const fn new(constants: SignetSystemConstants) -> Self {
        Self { constants, tx: vec![], gas_limit: None, reward_address: None }
    }

    /// Create a new empty RU block spec with the Pecorino constants.
    pub const fn pecorino() -> Self {
        Self::new(SignetSystemConstants::pecorino())
    }

    /// Create a new empty RU block spec with the test constants.
    pub const fn test() -> Self {
        Self::new(SignetSystemConstants::test())
    }

    /// Builder method to set the gas limit.
    pub const fn with_gas_limit(mut self, gas_limit: u64) -> Self {
        self.gas_limit = Some(gas_limit);
        self
    }

    /// Builder method to set the reward address.
    pub const fn with_reward_address(mut self, reward_address: Address) -> Self {
        self.reward_address = Some(reward_address);
        self
    }

    /// Add a transaction to the block.
    pub fn add_tx(&mut self, tx: &TransactionSigned) {
        self.tx.push(tx.encoded_2718());
    }

    /// Add an alloy transaction to the block
    pub fn add_alloy_tx(&mut self, tx: &TxEnvelope) {
        self.tx.push(tx.encoded_2718());
    }

    /// Add an invalid transaction to the block.
    pub fn add_invalid_tx(&mut self, tx: impl Into<Bytes>) {
        self.tx.push(tx.into().into());
    }

    /// Add a transaction to the block, returning self.
    pub fn tx(mut self, tx: &TransactionSigned) -> Self {
        self.add_tx(tx);
        self
    }

    /// Add an alloy transaction to the block, returning self.
    pub fn alloy_tx(mut self, tx: &TxEnvelope) -> Self {
        self.add_alloy_tx(tx);
        self
    }

    /// Add a simple send to the block, returns the send added.
    pub fn add_simple_send(
        &mut self,
        wallet: &PrivateKeySigner,
        to: Address,
        amount: U256,
        nonce: u64,
    ) -> TransactionSigned {
        let tx = sign_tx_with_key_pair(
            wallet,
            simple_send(to, amount, nonce, self.constants.ru_chain_id()),
        );
        self.add_tx(&tx);
        tx
    }

    /// Convert to a host sidecar.
    pub fn to_sidecar(&self) -> (B256, BlobTransactionSidecar) {
        let mut buf = vec![];
        Vec::<Vec<u8>>::encode(&self.tx, &mut buf);

        let sidecar = SidecarBuilder::<SimpleCoder>::from_slice(&buf).build().unwrap();
        (keccak256(&buf), sidecar)
    }

    /// Convert to a block submitted, along with the sidecar.
    pub fn to_block_submitted(&self) -> (Zenith::BlockSubmitted, BlobTransactionSidecar) {
        let (bdh, sidecar) = self.to_sidecar();

        let block_submitted = Zenith::BlockSubmitted {
            sequencer: Address::repeat_byte(3),
            rollupChainId: U256::from(self.constants.ru_chain_id()),
            gasLimit: U256::from(self.gas_limit.unwrap_or(100_000_000)),
            rewardAddress: self.reward_address.unwrap_or(DEFAULT_REWARD_ADDRESS),
            blockDataHash: bdh,
        };

        (block_submitted, sidecar)
    }

    /// Assert that extracted data conforms to the block spec.
    pub fn assert_conforms<C: Extractable>(&self, extracts: &Extracts<'_, C>) {
        let submitted = extracts.submitted.as_ref().unwrap();

        if let Some(gas_limit) = self.gas_limit {
            assert_eq!(submitted.gas_limit(), gas_limit)
        }

        if let Some(reward_address) = self.reward_address {
            assert_eq!(submitted.reward_address(), reward_address)
        }
    }
}

impl TryFrom<KnownChains> for RuBlockSpec {
    type Error = ParseChainError;

    fn try_from(chain: KnownChains) -> Result<Self, Self::Error> {
        match chain {
            KnownChains::Pecorino => Ok(Self::pecorino()),
            KnownChains::Test => Ok(Self::test()),
        }
    }
}

impl FromStr for RuBlockSpec {
    type Err = ParseChainError;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        s.parse::<KnownChains>()?.try_into()
    }
}