1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
use crate::primitives::{Address, Bytes, TransactTo, TxEnv, U256};
use core::ops::Range;
use std::boxed::Box;
/// Inputs for a call.
#[derive(Clone, Debug, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct CallInputs {
/// The call data of the call.
pub input: Bytes,
/// The return memory offset where the output of the call is written.
///
/// In EOF, this range is invalid as EOF calls do not write output to memory.
pub return_memory_offset: Range<usize>,
/// The gas limit of the call.
pub gas_limit: u64,
/// The account address of bytecode that is going to be executed.
///
/// Previously `context.code_address`.
pub bytecode_address: Address,
/// Target address, this account storage is going to be modified.
///
/// Previously `context.address`.
pub target_address: Address,
/// This caller is invoking the call.
///
/// Previously `context.caller`.
pub caller: Address,
/// Call value.
///
/// NOTE: This value may not necessarily be transferred from caller to callee, see [`CallValue`].
///
/// Previously `transfer.value` or `context.apparent_value`.
pub value: CallValue,
/// The call scheme.
///
/// Previously `context.scheme`.
pub scheme: CallScheme,
/// Whether the call is initiated inside a static call.
pub is_static: bool,
/// Whether the call is initiated from EOF bytecode.
pub is_eof: bool,
}
impl CallInputs {
/// Creates new call inputs.
///
/// Returns `None` if the transaction is not a call.
pub fn new(tx_env: &TxEnv, gas_limit: u64) -> Option<Self> {
let TransactTo::Call(target_address) = tx_env.transact_to else {
return None;
};
Some(CallInputs {
input: tx_env.data.clone(),
gas_limit,
target_address,
bytecode_address: target_address,
caller: tx_env.caller,
value: CallValue::Transfer(tx_env.value),
scheme: CallScheme::Call,
is_static: false,
is_eof: false,
return_memory_offset: 0..0,
})
}
/// Creates new boxed call inputs.
///
/// Returns `None` if the transaction is not a call.
pub fn new_boxed(tx_env: &TxEnv, gas_limit: u64) -> Option<Box<Self>> {
Self::new(tx_env, gas_limit).map(Box::new)
}
/// Returns `true` if the call will transfer a non-zero value.
#[inline]
pub fn transfers_value(&self) -> bool {
self.value.transfer().is_some_and(|x| x > U256::ZERO)
}
/// Returns the transfer value.
///
/// This is the value that is transferred from caller to callee, see [`CallValue`].
#[inline]
pub const fn transfer_value(&self) -> Option<U256> {
self.value.transfer()
}
/// Returns the **apparent** call value.
///
/// This value is not actually transferred, see [`CallValue`].
#[inline]
pub const fn apparent_value(&self) -> Option<U256> {
self.value.apparent()
}
/// Returns the address of the transfer source account.
///
/// This is only meaningful if `transfers_value` is `true`.
#[inline]
pub const fn transfer_from(&self) -> Address {
self.caller
}
/// Returns the address of the transfer target account.
///
/// This is only meaningful if `transfers_value` is `true`.
#[inline]
pub const fn transfer_to(&self) -> Address {
self.target_address
}
/// Returns the call value, regardless of the transfer value type.
///
/// NOTE: this value may not necessarily be transferred from caller to callee, see [`CallValue`].
#[inline]
pub const fn call_value(&self) -> U256 {
self.value.get()
}
}
/// Call scheme.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum CallScheme {
/// `CALL`.
Call,
/// `CALLCODE`
CallCode,
/// `DELEGATECALL`
DelegateCall,
/// `STATICCALL`
StaticCall,
}
/// Call value.
#[derive(Clone, Debug, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum CallValue {
/// Concrete value, transferred from caller to callee at the end of the transaction.
Transfer(U256),
/// Apparent value, that is **not** actually transferred.
///
/// Set when in a `DELEGATECALL` call type, and used by the `CALLVALUE` opcode.
Apparent(U256),
}
impl Default for CallValue {
#[inline]
fn default() -> Self {
CallValue::Transfer(U256::ZERO)
}
}
impl CallValue {
/// Returns the call value, regardless of the type.
#[inline]
pub const fn get(&self) -> U256 {
match *self {
Self::Transfer(value) | Self::Apparent(value) => value,
}
}
/// Returns the transferred value, if any.
#[inline]
pub const fn transfer(&self) -> Option<U256> {
match *self {
Self::Transfer(transfer) => Some(transfer),
Self::Apparent(_) => None,
}
}
/// Returns whether the call value will be transferred.
#[inline]
pub const fn is_transfer(&self) -> bool {
matches!(self, Self::Transfer(_))
}
/// Returns the apparent value, if any.
#[inline]
pub const fn apparent(&self) -> Option<U256> {
match *self {
Self::Transfer(_) => None,
Self::Apparent(apparent) => Some(apparent),
}
}
/// Returns whether the call value is apparent, and not actually transferred.
#[inline]
pub const fn is_apparent(&self) -> bool {
matches!(self, Self::Apparent(_))
}
}