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
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
//! Integration tests for wallet-side batch operations (wallet_sendCalls / EIP-5792).
//!
//! Per the ERC-7730 spec, batch operations are handled by the **wallet**, not the library.
//! The wallet calls `format_calldata()` once per inner call and composes the results.
//! These tests document and validate the expected wallet-side batch usage pattern.

use clear_signing::decoder::parse_signature;
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::{format_calldata, DisplayEntry, DisplayModel, TransactionContext};

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 wrap_rd(descriptor: Descriptor, chain_id: u64, address: &str) -> Vec<ResolvedDescriptor> {
    vec![ResolvedDescriptor {
        descriptor,
        chain_id,
        address: address.to_lowercase(),
    }]
}

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
}

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
}

fn build_erc20_approve_calldata(spender: &str, amount: u128) -> Vec<u8> {
    let sig = parse_signature("approve(address,uint256)").unwrap();
    let mut calldata = Vec::new();
    calldata.extend_from_slice(&sig.selector);
    calldata.extend_from_slice(&address_word(spender));
    calldata.extend_from_slice(&uint_word(amount));
    calldata
}

/// Simulate the wallet-side batch intent join pattern.
/// Uses `interpolated_intent` when available, falls back to `intent`.
fn join_intents(models: &[&DisplayModel]) -> String {
    models
        .iter()
        .map(|m| m.interpolated_intent.as_deref().unwrap_or(&m.intent))
        .collect::<Vec<_>>()
        .join(" and ")
}

fn pad32(len: usize) -> usize {
    len.div_ceil(32) * 32
}

fn build_exec_transaction_calldata(
    to: &str,
    value: u128,
    inner_calldata: &[u8],
    operation: u8,
) -> Vec<u8> {
    let sig = parse_signature(
        "execTransaction(address,uint256,bytes,uint8,uint256,uint256,uint256,address,address,bytes)",
    )
    .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(value));
    calldata.extend_from_slice(&uint_word(320)); // data offset
    calldata.extend_from_slice(&uint_word(operation as u128));
    calldata.extend_from_slice(&uint_word(0)); // safeTxGas
    calldata.extend_from_slice(&uint_word(21000)); // baseGas
    calldata.extend_from_slice(&uint_word(0)); // gasPrice
    calldata.extend_from_slice(&[0u8; 32]); // gasToken
    calldata.extend_from_slice(&[0u8; 32]); // refundReceiver
    let data_offset = 320 + 32 + pad32(inner_calldata.len());
    calldata.extend_from_slice(&uint_word(data_offset as u128)); // signatures offset

    calldata.extend_from_slice(&uint_word(inner_calldata.len() as u128));
    calldata.extend_from_slice(inner_calldata);
    let padding = pad32(inner_calldata.len()) - inner_calldata.len();
    calldata.extend_from_slice(&vec![0u8; padding]);

    calldata.extend_from_slice(&uint_word(0)); // signatures length = 0

    calldata
}

/// Wallet calls `format_calldata()` twice for two ERC-20 transfers to different
/// recipients. Verifies each produces a correct `DisplayModel` with intent and
/// formatted amounts. Joins intents with " and ".
#[tokio::test]
async fn wallet_batch_two_erc20_transfers() {
    let descriptor = load_descriptor("erc20-transfer.json");
    let usdc_addr = "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48";
    let recipient_a = "0x1111111111111111111111111111111111111111";
    let recipient_b = "0x2222222222222222222222222222222222222222";

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

    let descriptors = wrap_rd(descriptor, 1, usdc_addr);

    // Wallet calls format_calldata once per inner call
    let calldata_a = build_erc20_transfer_calldata(recipient_a, 1_000_000); // 1 USDC
    let tx_a = TransactionContext {
        chain_id: 1,
        to: usdc_addr,
        calldata: &calldata_a,
        value: None,
        from: None,
        implementation_address: None,
    };
    let result_a = format_calldata(&descriptors, &tx_a, &tokens).await.unwrap();

    let calldata_b = build_erc20_transfer_calldata(recipient_b, 5_000_000); // 5 USDC
    let tx_b = TransactionContext {
        chain_id: 1,
        to: usdc_addr,
        calldata: &calldata_b,
        value: None,
        from: None,
        implementation_address: None,
    };
    let result_b = format_calldata(&descriptors, &tx_b, &tokens).await.unwrap();

    // Each produces correct DisplayModel
    assert_eq!(result_a.intent, "Transfer tokens");
    assert_eq!(result_b.intent, "Transfer tokens");

    if let DisplayEntry::Item(ref item) = result_a.entries[1] {
        assert_eq!(item.label, "Amount");
        assert_eq!(item.value, "1 USDC");
    } else {
        panic!("expected Item for amount A");
    }

    if let DisplayEntry::Item(ref item) = result_b.entries[1] {
        assert_eq!(item.label, "Amount");
        assert_eq!(item.value, "5 USDC");
    } else {
        panic!("expected Item for amount B");
    }

    // Wallet joins intents with " and "
    let batch_summary = join_intents(&[&result_a, &result_b]);
    assert_eq!(batch_summary, "Transfer tokens and Transfer tokens");
}

/// Wallet calls `format_calldata()` for a known contract (ERC-20 transfer) and an
/// unknown contract. Known call produces full formatting, unknown call degrades
/// gracefully to raw preview.
#[tokio::test]
async fn wallet_batch_mixed_known_unknown() {
    let descriptor = load_descriptor("erc20-transfer.json");
    let usdc_addr = "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48";
    let unknown_addr = "0x0000000000000000000000000000000000000042";
    let recipient = "0x1234567890123456789012345678901234567890";

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

    let known_descriptors = wrap_rd(descriptor, 1, usdc_addr);

    // Known call: ERC-20 transfer — full formatting
    let known_calldata = build_erc20_transfer_calldata(recipient, 2_000_000);
    let known_tx = TransactionContext {
        chain_id: 1,
        to: usdc_addr,
        calldata: &known_calldata,
        value: None,
        from: None,
        implementation_address: None,
    };
    let known_result = format_calldata(&known_descriptors, &known_tx, &tokens)
        .await
        .unwrap();

    // Unknown call: wallet has no matching descriptor for this target, so it
    // passes an empty slice and still gets graceful raw fallback.
    let unknown_calldata =
        hex::decode("deadbeef000000000000000000000000000000000000000000000000000000000000002a")
            .unwrap();
    let unknown_tx = TransactionContext {
        chain_id: 1,
        to: unknown_addr,
        calldata: &unknown_calldata,
        value: None,
        from: None,
        implementation_address: None,
    };
    let unknown_result = format_calldata(&[], &unknown_tx, &EmptyDataProvider)
        .await
        .unwrap();

    // Known call: full formatting with intent and token amounts
    assert_eq!(known_result.intent, "Transfer tokens");
    assert!(known_result.diagnostics().is_empty());
    if let DisplayEntry::Item(ref item) = known_result.entries[1] {
        assert_eq!(item.value, "2 USDC");
    } else {
        panic!("expected Item for known amount");
    }

    // Unknown call: raw fallback with warning
    assert!(
        unknown_result.intent.contains("Unknown function"),
        "expected raw fallback intent, got: {}",
        unknown_result.intent
    );
    assert!(
        unknown_result.fallback_reason().is_some(),
        "expected fallback for unknown selector"
    );

    // Wallet can still compose both into a batch summary
    let batch_summary = join_intents(&[&known_result, &unknown_result]);
    assert!(batch_summary.contains("Transfer tokens"));
    assert!(batch_summary.contains("Unknown function"));
}

/// Wallet calls `format_calldata()` for 3 calls (approve + transfer + deposit).
/// Verifies `interpolated_intent` concatenation with " and " separator matches
/// the spec expectation.
#[tokio::test]
async fn wallet_batch_intent_concatenation() {
    let approve_descriptor = load_descriptor("erc20-approve.json");
    let transfer_descriptor = load_descriptor("erc20-transfer.json");

    // Inline descriptor for deposit(uint256)
    let deposit_descriptor = Descriptor::from_json(
        r#"{
        "context": {
            "contract": {
                "deployments": [
                    { "chainId": 1, "address": "0x7d2768de32b0b80b7a3454c06bdac94a69ddc7a9" }
                ]
            }
        },
        "metadata": {
            "owner": "Aave",
            "contractName": "Lending Pool",
            "enums": {},
            "constants": {},
            "addressBook": {},
            "maps": {}
        },
        "display": {
            "definitions": {},
            "formats": {
                "deposit(uint256 amount)": {
                    "intent": "Deposit funds",
                    "fields": [
                        {
                            "path": "amount",
                            "label": "Amount",
                            "format": "raw"
                        }
                    ]
                }
            }
        }
    }"#,
    )
    .unwrap();

    let usdc_addr = "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48";
    let deposit_addr = "0x7d2768de32b0b80b7a3454c06bdac94a69ddc7a9";
    let spender = "0xdef1c0ded9bec7f1a1670819833240f027b25eff";

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

    let approve_descriptors = wrap_rd(approve_descriptor, 1, usdc_addr);
    let transfer_descriptors = wrap_rd(transfer_descriptor, 1, usdc_addr);
    let deposit_descriptors = wrap_rd(deposit_descriptor, 1, deposit_addr);

    // Call 1: approve
    let approve_calldata = build_erc20_approve_calldata(spender, 10_000_000);
    let approve_tx = TransactionContext {
        chain_id: 1,
        to: usdc_addr,
        calldata: &approve_calldata,
        value: None,
        from: None,
        implementation_address: None,
    };
    let approve_result = format_calldata(&approve_descriptors, &approve_tx, &tokens)
        .await
        .unwrap();

    // Call 2: transfer
    let recipient = "0x3333333333333333333333333333333333333333";
    let transfer_calldata = build_erc20_transfer_calldata(recipient, 10_000_000);
    let transfer_tx = TransactionContext {
        chain_id: 1,
        to: usdc_addr,
        calldata: &transfer_calldata,
        value: None,
        from: None,
        implementation_address: None,
    };
    let transfer_result = format_calldata(&transfer_descriptors, &transfer_tx, &tokens)
        .await
        .unwrap();

    // Call 3: deposit
    let deposit_sig = parse_signature("deposit(uint256)").unwrap();
    let mut deposit_calldata = Vec::new();
    deposit_calldata.extend_from_slice(&deposit_sig.selector);
    deposit_calldata.extend_from_slice(&uint_word(5_000_000));
    let deposit_tx = TransactionContext {
        chain_id: 1,
        to: deposit_addr,
        calldata: &deposit_calldata,
        value: None,
        from: None,
        implementation_address: None,
    };
    let deposit_result = format_calldata(&deposit_descriptors, &deposit_tx, &EmptyDataProvider)
        .await
        .unwrap();

    // Verify individual intents
    assert_eq!(approve_result.intent, "Approve token spending");
    assert_eq!(transfer_result.intent, "Transfer tokens");
    assert_eq!(deposit_result.intent, "Deposit funds");

    // Wallet joins interpolated_intent (falling back to intent) with " and "
    let batch_summary = join_intents(&[&approve_result, &transfer_result, &deposit_result]);

    // Verify the joined summary contains all three intents
    let parts: Vec<&str> = batch_summary.split(" and ").collect();
    assert_eq!(
        parts.len(),
        3,
        "expected 3 parts joined by ' and ', got: {batch_summary}"
    );

    // approve has interpolatedIntent, so it should use that
    assert!(
        approve_result.interpolated_intent.is_some(),
        "approve descriptor should produce interpolated_intent"
    );

    // All intents present in the summary
    assert!(batch_summary.contains("Approve") || batch_summary.contains("approve"));
    assert!(batch_summary.contains("Transfer") || batch_summary.contains("transfer"));
    assert!(batch_summary.contains("Deposit") || batch_summary.contains("deposit"));
}

/// Full wallet flow: `format_calldata()` per inner call for display, then
/// `format_calldata()` with multiple descriptors for the outer Safe `execTransaction` wrapper.
/// Verifies both layers produce valid output independently.
#[tokio::test]
async fn wallet_batch_with_safe_wrapper() {
    let erc20_descriptor = load_descriptor("erc20-transfer.json");
    let safe_descriptor = load_descriptor("common-Safe.json");

    let safe_addr = "0xd9Db270c1B5E3Bd161E8c8503c55cEABeE709552";
    let usdc_addr = "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48";
    let recipient = "0x1111111111111111111111111111111111111111";

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

    let inner_calldata = build_erc20_transfer_calldata(recipient, 1_000_000); // 1 USDC

    // --- Step 1: Wallet formats the inner call individually for display ---
    let inner_descriptors = wrap_rd(erc20_descriptor.clone(), 1, usdc_addr);
    let inner_tx = TransactionContext {
        chain_id: 1,
        to: usdc_addr,
        calldata: &inner_calldata,
        value: None,
        from: None,
        implementation_address: None,
    };
    let inner_display = format_calldata(&inner_descriptors, &inner_tx, &tokens)
        .await
        .unwrap();

    assert_eq!(inner_display.intent, "Transfer tokens");
    if let DisplayEntry::Item(ref item) = inner_display.entries[1] {
        assert_eq!(item.label, "Amount");
        assert_eq!(item.value, "1 USDC");
    } else {
        panic!("expected Item for inner Amount");
    }

    // --- Step 2: Wallet formats the outer Safe wrapper via format_calldata ---
    let outer_calldata = build_exec_transaction_calldata(usdc_addr, 0, &inner_calldata, 0);

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

    let outer_tx = TransactionContext {
        chain_id: 1,
        to: safe_addr,
        calldata: &outer_calldata,
        value: None,
        from: None,
        implementation_address: None,
    };
    let safe_result = format_calldata(&descriptors, &outer_tx, &tokens)
        .await
        .unwrap();

    // Verify outer Safe formatting
    assert_eq!(safe_result.intent, "sign multisig operation");

    // Verify nested inner call is rendered inside Safe wrapper — find by label
    let nested = safe_result
        .entries
        .iter()
        .find(|e| matches!(e, DisplayEntry::Nested { label, .. } if label == "Transaction"))
        .expect("expected Nested entry for Transaction");

    match nested {
        DisplayEntry::Nested {
            label,
            intent,
            entries,
            ..
        } => {
            assert_eq!(label, "Transaction");
            assert_eq!(intent, "Transfer tokens");
            assert!(
                entries.len() >= 2,
                "expected at least 2 inner entries, got {}",
                entries.len()
            );
            if let DisplayEntry::Item(ref item) = entries[1] {
                assert_eq!(item.label, "Amount");
                assert_eq!(item.value, "1 USDC");
            } else {
                panic!("expected Item for nested Amount");
            }
        }
        other => panic!("expected Nested for Transaction, got {:?}", other),
    }

    // Both layers produce valid, independent output
    assert!(!inner_display.intent.is_empty());
    assert!(!safe_result.intent.is_empty());
}