Skip to main content

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}
16
17#[derive(Clone, Debug, Serialize, Deserialize)]
18#[serde(
19    rename_all = "camelCase",
20    bound(
21        serialize = "N::TransactionRequest: Serialize, N::TxEnvelope: Serialize",
22        deserialize = "N::TransactionRequest: for<'de2> Deserialize<'de2>, N::TxEnvelope: for<'de2> Deserialize<'de2>"
23    )
24)]
25pub struct TransactionWithMetadata<N: Network> {
26    pub hash: Option<B256>,
27    #[serde(rename = "transactionType")]
28    pub call_kind: CallKind,
29    #[serde(default = "default_string")]
30    pub contract_name: Option<String>,
31    #[serde(default = "default_address")]
32    pub contract_address: Option<Address>,
33    #[serde(default = "default_string")]
34    pub function: Option<String>,
35    pub function_abi: Option<String>,
36    #[serde(skip)]
37    pub display_function: Option<String>,
38    #[serde(default = "default_vec_of_strings")]
39    pub arguments: Option<Vec<String>>,
40    #[serde(skip)]
41    pub rpc: String,
42    pub transaction: TransactionMaybeSigned<N>,
43    #[serde(default)]
44    pub additional_contracts: Vec<AdditionalContract>,
45    #[serde(default)]
46    pub is_fixed_gas_limit: bool,
47}
48
49const fn default_string() -> Option<String> {
50    Some(String::new())
51}
52
53const fn default_address() -> Option<Address> {
54    Some(Address::ZERO)
55}
56
57const fn default_vec_of_strings() -> Option<Vec<String>> {
58    Some(vec![])
59}
60
61impl<N: Network> TransactionWithMetadata<N> {
62    pub fn from_tx_request(transaction: TransactionMaybeSigned<N>) -> Self {
63        Self {
64            transaction,
65            hash: Default::default(),
66            call_kind: Default::default(),
67            contract_name: Default::default(),
68            contract_address: Default::default(),
69            function: Default::default(),
70            function_abi: Default::default(),
71            display_function: Default::default(),
72            arguments: Default::default(),
73            is_fixed_gas_limit: Default::default(),
74            additional_contracts: Default::default(),
75            rpc: Default::default(),
76        }
77    }
78
79    pub const fn tx(&self) -> &TransactionMaybeSigned<N> {
80        &self.transaction
81    }
82
83    pub const fn tx_mut(&mut self) -> &mut TransactionMaybeSigned<N> {
84        &mut self.transaction
85    }
86
87    pub fn is_create2(&self) -> bool {
88        self.call_kind == CallKind::Create2
89    }
90}