forge_script_sequence/
transaction.rs

1use alloy_network::Network;
2use alloy_primitives::{Address, B256, Bytes};
3use foundry_common::TransactionMaybeSigned;
4use revm_inspectors::tracing::types::CallKind;
5use serde::{Deserialize, Serialize};
6
7#[derive(Clone, Debug, Default, Serialize, Deserialize)]
8#[serde(rename_all = "camelCase")]
9pub struct AdditionalContract {
10    #[serde(rename = "transactionType")]
11    pub call_kind: CallKind,
12    pub contract_name: Option<String>,
13    pub address: Address,
14    pub init_code: Bytes,
15    #[serde(default, skip_serializing_if = "Vec::is_empty")]
16    pub creator_code_addresses: Vec<Address>,
17}
18
19#[derive(Clone, Debug, Serialize, Deserialize)]
20#[serde(
21    rename_all = "camelCase",
22    bound(
23        serialize = "N::TransactionRequest: Serialize, N::TxEnvelope: Serialize",
24        deserialize = "N::TransactionRequest: for<'de2> Deserialize<'de2>, N::TxEnvelope: for<'de2> Deserialize<'de2>"
25    )
26)]
27pub struct TransactionWithMetadata<N: Network> {
28    pub hash: Option<B256>,
29    #[serde(rename = "transactionType")]
30    pub call_kind: CallKind,
31    #[serde(default = "default_string")]
32    pub contract_name: Option<String>,
33    #[serde(default = "default_address")]
34    pub contract_address: Option<Address>,
35    #[serde(default = "default_string")]
36    pub function: Option<String>,
37    pub function_abi: Option<String>,
38    #[serde(skip)]
39    pub display_function: Option<String>,
40    #[serde(default = "default_vec_of_strings")]
41    pub arguments: Option<Vec<String>>,
42    #[serde(skip)]
43    pub rpc: String,
44    pub transaction: TransactionMaybeSigned<N>,
45    #[serde(default)]
46    pub additional_contracts: Vec<AdditionalContract>,
47    #[serde(default)]
48    pub is_fixed_gas_limit: bool,
49}
50
51const fn default_string() -> Option<String> {
52    Some(String::new())
53}
54
55const fn default_address() -> Option<Address> {
56    Some(Address::ZERO)
57}
58
59const fn default_vec_of_strings() -> Option<Vec<String>> {
60    Some(vec![])
61}
62
63impl<N: Network> TransactionWithMetadata<N> {
64    pub fn from_tx_request(transaction: TransactionMaybeSigned<N>) -> Self {
65        Self {
66            transaction,
67            hash: Default::default(),
68            call_kind: Default::default(),
69            contract_name: Default::default(),
70            contract_address: Default::default(),
71            function: Default::default(),
72            function_abi: Default::default(),
73            display_function: Default::default(),
74            arguments: Default::default(),
75            is_fixed_gas_limit: Default::default(),
76            additional_contracts: Default::default(),
77            rpc: Default::default(),
78        }
79    }
80
81    pub const fn tx(&self) -> &TransactionMaybeSigned<N> {
82        &self.transaction
83    }
84
85    pub const fn tx_mut(&mut self) -> &mut TransactionMaybeSigned<N> {
86        &mut self.transaction
87    }
88
89    pub fn is_create2(&self) -> bool {
90        self.call_kind == CallKind::Create2
91    }
92}
93
94#[cfg(test)]
95mod tests {
96    use super::*;
97
98    #[test]
99    fn additional_contract_creator_code_addresses_are_backward_compatible() {
100        let old_json = serde_json::json!({
101            "transactionType": "CREATE",
102            "contractName": null,
103            "address": Address::repeat_byte(0x11),
104            "initCode": "0x6000"
105        });
106        let contract: AdditionalContract = serde_json::from_value(old_json.clone()).unwrap();
107        assert!(contract.creator_code_addresses.is_empty());
108        assert_eq!(serde_json::to_value(contract).unwrap(), old_json);
109
110        let creator = Address::repeat_byte(0x22);
111        let contract = AdditionalContract {
112            call_kind: CallKind::Create2,
113            contract_name: None,
114            address: Address::repeat_byte(0x33),
115            init_code: Bytes::new(),
116            creator_code_addresses: vec![creator],
117        };
118        assert_eq!(
119            serde_json::to_value(contract).unwrap()["creatorCodeAddresses"],
120            serde_json::json!([creator])
121        );
122    }
123}
forge_script_sequence/transaction.rs

forge_script_sequence/
transaction.rs
