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