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

forge_script_sequence/
transaction.rs
