forked from argotorg/fe
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcall_with_default.fe
More file actions
265 lines (228 loc) · 7.22 KB
/
Copy pathcall_with_default.fe
File metadata and controls
265 lines (228 loc) · 7.22 KB
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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
/// Tests for `call_with_default`: like `call<M>`/`Address::call`, but a call
/// that succeeds with EMPTY returndata yields a caller-supplied default
/// instead of a decode revert. Reverts still bubble and non-empty returndata
/// is still decoded strictly.
use std::evm::{RawMem, RawOps, last_returndata, mem}
/// Strict caller-side view of an ERC20-style `transfer`.
msg TokenMsg {
#[selector = sol("transfer(address,uint256)")]
Transfer { receiver: Address, amount: u256 } -> bool,
}
/// Same selector, but declared without a return type so the handler returns
/// void (empty returndata), like USDT-style tokens.
msg NoRetTokenMsg {
#[selector = sol("transfer(address,uint256)")]
Transfer { receiver: Address, amount: u256 },
}
pub contract CompliantToken {
recv TokenMsg {
Transfer { receiver, amount } -> bool {
true
}
}
}
/// Reverts with a distinctive 32-byte payload; the marker sits in the top
/// bytes so `#[test(should_revert, selector = 0xdeadbeef)]` can match it.
pub contract RevertingToken {
recv TokenMsg {
Transfer { receiver, amount } -> bool {
let marker: u256 = 0xdeadbeefcafebabe << 192
revert(marker)
}
}
}
pub contract NoReturnToken {
recv NoRetTokenMsg {
Transfer { receiver, amount } {}
}
}
pub contract FalseToken {
recv TokenMsg {
Transfer { receiver, amount } -> bool {
false
}
}
}
/// Returns fewer than 32 bytes of returndata.
pub contract MalformedToken {
recv TokenMsg {
Transfer { receiver, amount } -> bool uses (raw: mut RawOps) {
let ptr = mem::alloc(32)
raw.mstore(addr: ptr, value: 0xaabbccdd << 224)
raw.return_data(offset: ptr, len: 4)
}
}
}
/// Non-bool returns: proves the API is generic, not bool-special-cased.
msg ValueQueryMsg {
#[selector = 0x10]
GetValue -> u256,
#[selector = 0x11]
GetNothing -> u256,
}
msg ValueImplMsg {
#[selector = 0x10]
GetValue -> u256,
}
msg NoRetValueImplMsg {
#[selector = 0x11]
GetNothing,
}
pub contract ValueToken {
recv ValueImplMsg {
GetValue -> u256 {
42
}
}
recv NoRetValueImplMsg {
GetNothing {}
}
}
/// Wrapper contract so a test can observe the revert data that
/// `call_with_default` bubbles out of a reverting callee.
msg CallerMsg {
#[selector = 0x01]
DoTransfer { token: Address } -> bool,
}
pub contract Caller uses (call: mut Call) {
recv CallerMsg {
DoTransfer { token } -> bool uses (mut call) {
call.call_with_default(
addr: token,
gas: 100000,
value: 0,
message: TokenMsg::Transfer { receiver: Address { inner: 9 }, amount: 1 },
default: true,
)
}
}
}
fn receiver() -> Address {
Address { inner: 2 }
}
#[test]
fn test_present_returndata_is_decoded_not_defaulted() uses (evm: mut Evm) {
let token = evm.create2<CompliantToken>(value: 0, args: (), salt: 0)
// default is false; the decoded `true` must win
let ok: bool = evm.call_with_default(
addr: token,
gas: 100000,
value: 0,
message: TokenMsg::Transfer { receiver: receiver(), amount: 1 },
default: false,
)
assert!(ok)
}
#[test]
fn test_empty_returndata_yields_default() uses (evm: mut Evm) {
let token = evm.create2<NoReturnToken>(value: 0, args: (), salt: 0)
let ok: bool = evm.call_with_default(
addr: token,
gas: 100000,
value: 0,
message: TokenMsg::Transfer { receiver: receiver(), amount: 1 },
default: true,
)
assert!(ok)
}
#[test]
fn test_default_never_masks_present_false() uses (evm: mut Evm) {
let token = evm.create2<FalseToken>(value: 0, args: (), salt: 0)
let ok: bool = evm.call_with_default(
addr: token,
gas: 100000,
value: 0,
message: TokenMsg::Transfer { receiver: receiver(), amount: 1 },
default: true,
)
assert!(!ok)
}
#[test(should_revert, selector = 0xdeadbeef)]
fn test_reverting_token_still_bubbles() uses (evm: mut Evm) {
let token = evm.create2<RevertingToken>(value: 0, args: (), salt: 0)
let _: bool = evm.call_with_default(
addr: token,
gas: 100000,
value: 0,
message: TokenMsg::Transfer { receiver: receiver(), amount: 1 },
default: true,
)
}
#[test]
fn test_bubbled_revert_data_survives_verbatim() uses (evm: mut Evm) {
let token = evm.create2<RevertingToken>(value: 0, args: (), salt: 0)
let caller = evm.create2<Caller>(value: 0, args: (), salt: 1)
// Hand-encode CallerMsg::DoTransfer { token } so we can observe the
// wrapped call's revert data instead of reverting the test itself.
let ptr = mem::alloc(36)
evm.mstore(addr: ptr, value: 1 << 224)
evm.mstore(addr: ptr + 4, value: token.inner)
assert!(!evm.raw_call(addr: caller, gas: 300000, value: 0, args_offset: ptr, args_len: 36))
// The token's revert data must arrive untouched: exactly one word
// holding the marker.
let ret = last_returndata()
assert!(ret.len == 32)
assert!(evm.mload(ret.base) == 0xdeadbeefcafebabe << 192)
}
#[test(should_revert)]
fn test_malformed_returndata_still_reverts_in_decoder() uses (evm: mut Evm) {
let token = evm.create2<MalformedToken>(value: 0, args: (), salt: 0)
let _: bool = evm.call_with_default(
addr: token,
gas: 100000,
value: 0,
message: TokenMsg::Transfer { receiver: receiver(), amount: 1 },
default: true,
)
}
#[test]
fn test_no_code_address_yields_default() uses (evm: mut Evm) {
// Documented trap: a call to an address with no code succeeds with empty
// returndata, so the default surfaces as a silent "success".
let eoa = Address { inner: 0xe0a }
let ok: bool = evm.call_with_default(
addr: eoa,
gas: 100000,
value: 0,
message: TokenMsg::Transfer { receiver: receiver(), amount: 1 },
default: true,
)
assert!(ok)
}
#[test]
fn test_non_bool_return_type() uses (evm: mut Evm) {
let token = evm.create2<ValueToken>(value: 0, args: (), salt: 0)
// Non-empty path: the decoded value wins over a non-trivial default.
let value: u256 = evm.call_with_default(
addr: token,
gas: 100000,
value: 0,
message: ValueQueryMsg::GetValue {},
default: 777,
)
assert!(value == 42)
// Empty path: the default surfaces.
let value: u256 = evm.call_with_default(
addr: token,
gas: 100000,
value: 0,
message: ValueQueryMsg::GetNothing {},
default: 777,
)
assert!(value == 777)
}
#[test]
fn test_address_call_with_default_convenience() uses (evm: mut Evm, call: mut Call) {
let compliant = evm.create2<CompliantToken>(value: 0, args: (), salt: 0)
let silent = evm.create2<NoReturnToken>(value: 0, args: (), salt: 1)
let ok: bool = compliant.call_with_default(
TokenMsg::Transfer { receiver: receiver(), amount: 1 },
default: false,
)
assert!(ok)
let ok: bool = silent.call_with_default(
TokenMsg::Transfer { receiver: receiver(), amount: 1 },
default: true,
)
assert!(ok)
}