clear-signing 0.1.0

ERC-7730 v2 clear signing library: decodes and formats Ethereum calldata and EIP-712 typed data for human-readable display.
Documentation
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
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
//! Integration tests for ERC-4337 UserOps nested calldata via EIP-712.
//!
//! Tests the `#.` path prefix, EIP-712 → calldata nesting, and multi-level
//! UserOp → execute → ERC-20 transfer chains.

use clear_signing::decoder::parse_signature;
use clear_signing::eip712::TypedData;
use clear_signing::provider::EmptyDataProvider;
use clear_signing::resolver::ResolvedDescriptor;
use clear_signing::token::{StaticTokenSource, TokenMeta};
use clear_signing::types::descriptor::Descriptor;
use clear_signing::DisplayEntry;

fn load_descriptor(fixture: &str) -> Descriptor {
    let path = format!("{}/tests/fixtures/{fixture}", env!("CARGO_MANIFEST_DIR"));
    let json = std::fs::read_to_string(&path).unwrap_or_else(|e| panic!("read {path}: {e}"));
    Descriptor::from_json(&json).unwrap_or_else(|e| panic!("parse {path}: {e}"))
}

fn address_word(hex_addr: &str) -> Vec<u8> {
    let hex_str = hex_addr
        .strip_prefix("0x")
        .or_else(|| hex_addr.strip_prefix("0X"))
        .unwrap_or(hex_addr);
    let addr_bytes = hex::decode(hex_str).expect("valid hex address");
    let mut word = vec![0u8; 12];
    word.extend_from_slice(&addr_bytes);
    assert_eq!(word.len(), 32);
    word
}

fn uint_word(val: u128) -> Vec<u8> {
    let mut word = vec![0u8; 16];
    word.extend_from_slice(&val.to_be_bytes());
    assert_eq!(word.len(), 32);
    word
}

/// Build ERC-20 `transfer(address,uint256)` calldata.
fn build_erc20_transfer_calldata(to: &str, amount: u128) -> Vec<u8> {
    let sig = parse_signature("transfer(address,uint256)").unwrap();
    let mut calldata = Vec::new();
    calldata.extend_from_slice(&sig.selector);
    calldata.extend_from_slice(&address_word(to));
    calldata.extend_from_slice(&uint_word(amount));
    calldata
}

/// Build smart account `execute(address,uint256,bytes)` calldata wrapping inner data.
fn build_execute_calldata(dest: &str, value: u128, inner_func: &[u8]) -> Vec<u8> {
    let sig = parse_signature("execute(address,uint256,bytes)").unwrap();
    let mut calldata = Vec::new();
    calldata.extend_from_slice(&sig.selector);

    // Param 0: dest (address)
    calldata.extend_from_slice(&address_word(dest));
    // Param 1: value (uint256)
    calldata.extend_from_slice(&uint_word(value));
    // Param 2: func (bytes) — offset pointer (3 params × 32 = 96)
    calldata.extend_from_slice(&uint_word(96));
    // Data section: length + data + padding
    calldata.extend_from_slice(&uint_word(inner_func.len() as u128));
    calldata.extend_from_slice(inner_func);
    let pad = inner_func.len().div_ceil(32) * 32 - inner_func.len();
    calldata.extend_from_slice(&vec![0u8; pad]);

    calldata
}

/// Build a PackedUserOperation EIP-712 typed data message with callData.
fn build_userop_typed_data(sender: &str, call_data: &[u8]) -> TypedData {
    let typed_data_json = serde_json::json!({
        "types": {
            "EIP712Domain": [
                {"name": "name", "type": "string"},
                {"name": "version", "type": "string"},
                {"name": "chainId", "type": "uint256"},
                {"name": "verifyingContract", "type": "address"}
            ],
            "PackedUserOperation": [
                {"name": "sender", "type": "address"},
                {"name": "nonce", "type": "uint256"},
                {"name": "callData", "type": "bytes"},
                {"name": "preVerificationGas", "type": "uint256"}
            ]
        },
        "primaryType": "PackedUserOperation",
        "domain": {
            "name": "Account",
            "version": "1",
            "chainId": 1,
            "verifyingContract": "0x5ff137d4b0fdcd49dca30c7cf57e578a026d2789"
        },
        "message": {
            "sender": sender,
            "nonce": "1",
            "callData": format!("0x{}", hex::encode(call_data)),
            "preVerificationGas": "21000"
        }
    });

    serde_json::from_value(typed_data_json).unwrap()
}

#[tokio::test]
async fn userop_with_erc20_transfer_via_execute() {
    // Three-level nesting: UserOp (EIP-712) → execute (calldata) → transfer (calldata)
    let userop_descriptor = load_descriptor("userops-eip712.json");
    let account_descriptor = load_descriptor("smart-account-execute.json");
    let erc20_descriptor = load_descriptor("erc20-transfer.json");

    let sender = "0x1111111111111111111111111111111111111111";
    let usdc_addr = "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48";
    let recipient = "0x2222222222222222222222222222222222222222";

    // Innermost: ERC-20 transfer
    let transfer_calldata = build_erc20_transfer_calldata(recipient, 5_000_000); // 5 USDC

    // Middle: smart account execute wrapping the transfer
    let execute_calldata = build_execute_calldata(usdc_addr, 0, &transfer_calldata);

    // Outermost: UserOp EIP-712 typed data
    let typed_data = build_userop_typed_data(sender, &execute_calldata);

    let descriptors = vec![
        ResolvedDescriptor {
            descriptor: account_descriptor,
            chain_id: 1,
            address: sender.to_string(),
        },
        ResolvedDescriptor {
            descriptor: erc20_descriptor,
            chain_id: 1,
            address: usdc_addr.to_string(),
        },
    ];

    let mut tokens = StaticTokenSource::new();
    tokens.insert(
        1,
        usdc_addr,
        TokenMeta {
            symbol: "USDC".to_string(),
            decimals: 6,
            name: "USD Coin".to_string(),
        },
    );

    let mut all_descriptors = vec![ResolvedDescriptor {
        descriptor: userop_descriptor,
        chain_id: 1,
        address: "0x5ff137d4b0fdcd49dca30c7cf57e578a026d2789".to_string(),
    }];
    all_descriptors.extend(descriptors);
    let result = clear_signing::format_typed_data(&all_descriptors, &typed_data, &tokens)
        .await
        .unwrap();

    assert_eq!(result.intent, "Sign Packed User Operation");

    // Interpolated intent should include sender address
    assert!(
        result
            .interpolated_intent
            .as_ref()
            .unwrap()
            .contains(sender),
        "interpolated intent should contain sender: {:?}",
        result.interpolated_intent
    );

    // Entry 0: Sender Account
    if let DisplayEntry::Item(ref item) = result.entries[0] {
        assert_eq!(item.label, "Sender Account");
        // Should be the sender address (or resolved name)
        assert!(
            item.value
                .to_lowercase()
                .contains(&sender[2..].to_lowercase()),
            "sender value should contain sender address: {}",
            item.value
        );
    } else {
        panic!(
            "expected Item for Sender Account, got {:?}",
            result.entries[0]
        );
    }

    // Entry 1: Nonce — should be hidden (visible: "never"), so skip it
    // Entry 1 should be the Embedded Call (callData field)
    match &result.entries[1] {
        DisplayEntry::Nested {
            label,
            intent,
            entries,
            ..
        } => {
            assert_eq!(label, "Embedded Call");
            assert_eq!(intent, "Execute call");

            // The execute call should have: Destination, Value, Inner Call (nested)
            assert!(
                entries.len() >= 2,
                "expected at least 2 entries in execute, got {}",
                entries.len()
            );

            // Inner entry 0: Destination (checksummed address — account descriptor doesn't know USDC)
            if let DisplayEntry::Item(ref item) = entries[0] {
                assert_eq!(item.label, "Destination");
                assert!(
                    item.value
                        .to_lowercase()
                        .contains("a0b86991c6218b36c1d19d4a2e9eb0ce3606eb48"),
                    "destination should contain USDC address: {}",
                    item.value
                );
            } else {
                panic!("expected Item for Destination");
            }

            // Inner entry 2: Inner Call (another Nested)
            let inner_call_idx = entries.len() - 1; // last entry should be the nested call
            match &entries[inner_call_idx] {
                DisplayEntry::Nested {
                    label,
                    intent,
                    entries: inner_entries,
                    ..
                } => {
                    assert_eq!(label, "Inner Call");
                    assert_eq!(intent, "Transfer tokens");

                    // Should have To and Amount
                    if let DisplayEntry::Item(ref item) = inner_entries[0] {
                        assert_eq!(item.label, "To");
                    }
                    if let DisplayEntry::Item(ref item) = inner_entries[1] {
                        assert_eq!(item.label, "Amount");
                        assert_eq!(item.value, "5 USDC");
                    }
                }
                other => {
                    panic!("expected Nested for Inner Call, got {:?}", other);
                }
            }
        }
        other => {
            panic!("expected Nested for Embedded Call, got {:?}", other);
        }
    }
}

#[tokio::test]
async fn userop_direct_erc20_transfer() {
    // Two-level nesting: UserOp (EIP-712) → transfer (calldata directly in callData)
    // Simulates an account whose callData IS the target call (no execute wrapper)
    let userop_descriptor = load_descriptor("userops-eip712.json");
    let erc20_descriptor = load_descriptor("erc20-transfer.json");

    // The sender IS the token contract (unusual but tests #. path resolution)
    let usdc_addr = "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48";
    let recipient = "0x3333333333333333333333333333333333333333";

    let transfer_calldata = build_erc20_transfer_calldata(recipient, 2_000_000); // 2 USDC
    let typed_data = build_userop_typed_data(usdc_addr, &transfer_calldata);

    let descriptors = vec![ResolvedDescriptor {
        descriptor: erc20_descriptor,
        chain_id: 1,
        address: usdc_addr.to_string(),
    }];

    let mut tokens = StaticTokenSource::new();
    tokens.insert(
        1,
        usdc_addr,
        TokenMeta {
            symbol: "USDC".to_string(),
            decimals: 6,
            name: "USD Coin".to_string(),
        },
    );

    let mut all_descriptors = vec![ResolvedDescriptor {
        descriptor: userop_descriptor,
        chain_id: 1,
        address: "0x5ff137d4b0fdcd49dca30c7cf57e578a026d2789".to_string(),
    }];
    all_descriptors.extend(descriptors);
    let result = clear_signing::format_typed_data(&all_descriptors, &typed_data, &tokens)
        .await
        .unwrap();

    assert_eq!(result.intent, "Sign Packed User Operation");

    // Embedded Call should resolve to ERC-20 transfer via #.sender → USDC address
    match &result.entries[1] {
        DisplayEntry::Nested {
            label,
            intent,
            entries,
            ..
        } => {
            assert_eq!(label, "Embedded Call");
            assert_eq!(intent, "Transfer tokens");

            if let DisplayEntry::Item(ref item) = entries[1] {
                assert_eq!(item.label, "Amount");
                assert_eq!(item.value, "2 USDC");
            }
        }
        other => {
            panic!("expected Nested for Embedded Call, got {:?}", other);
        }
    }
}

#[tokio::test]
async fn userop_no_matching_inner_descriptor() {
    // UserOp with callData pointing to an unknown contract — graceful degradation
    let userop_descriptor = load_descriptor("userops-eip712.json");
    let unknown_sender = "0x9999999999999999999999999999999999999999";

    let random_calldata =
        hex::decode("12345678000000000000000000000000000000000000000000000000000000000000002a")
            .unwrap();
    let typed_data = build_userop_typed_data(unknown_sender, &random_calldata);

    // No inner descriptors provided
    let all_descriptors = vec![ResolvedDescriptor {
        descriptor: userop_descriptor,
        chain_id: 1,
        address: "0x5ff137d4b0fdcd49dca30c7cf57e578a026d2789".to_string(),
    }];
    let result =
        clear_signing::format_typed_data(&all_descriptors, &typed_data, &EmptyDataProvider)
            .await
            .unwrap();

    assert_eq!(result.intent, "Sign Packed User Operation");
    assert_eq!(
        result.fallback_reason(),
        Some(&clear_signing::FallbackReason::NestedCallNotClearSigned)
    );

    // Embedded Call should degrade gracefully
    match &result.entries[1] {
        DisplayEntry::Nested { label, intent, .. } => {
            assert_eq!(label, "Embedded Call");
            assert!(
                intent.contains("Unknown function"),
                "expected raw fallback, got: {intent}"
            );
        }
        other => {
            panic!("expected Nested for Embedded Call, got {:?}", other);
        }
    }
}

#[tokio::test]
async fn userop_hash_prefix_resolves_from_message() {
    // Verify that `#.sender` resolves from the EIP-712 message field, not from calldata
    let userop_descriptor = load_descriptor("userops-eip712.json");
    let erc20_descriptor = load_descriptor("erc20-transfer.json");

    // Use the USDC address as sender — `#.sender` should resolve to this
    let sender = "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48";
    let recipient = "0x4444444444444444444444444444444444444444";

    let transfer_calldata = build_erc20_transfer_calldata(recipient, 1_000_000);
    let typed_data = build_userop_typed_data(sender, &transfer_calldata);

    let descriptors = vec![ResolvedDescriptor {
        descriptor: erc20_descriptor,
        chain_id: 1,
        address: sender.to_string(), // sender == USDC contract
    }];

    let mut all_descriptors = vec![ResolvedDescriptor {
        descriptor: userop_descriptor,
        chain_id: 1,
        address: "0x5ff137d4b0fdcd49dca30c7cf57e578a026d2789".to_string(),
    }];
    all_descriptors.extend(descriptors);
    let result =
        clear_signing::format_typed_data(&all_descriptors, &typed_data, &EmptyDataProvider)
            .await
            .unwrap();

    // The #.sender path should have resolved to the sender address from the message,
    // matched against the ERC-20 descriptor, and decoded the transfer calldata
    match &result.entries[1] {
        DisplayEntry::Nested {
            intent, entries, ..
        } => {
            assert_eq!(intent, "Transfer tokens");
            assert!(entries.len() >= 2);
            if let DisplayEntry::Item(ref item) = entries[0] {
                assert_eq!(item.label, "To");
            }
        }
        other => {
            panic!(
                "expected Nested with Transfer tokens intent, got {:?}",
                other
            );
        }
    }
}