rust-x402 0.3.0

HTTP-native micropayments with x402 protocol
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
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
//! Integration tests for the x402 library

use base64::Engine;
use mockito::{Matcher, Server};
use rust_x402::{
    client::{DiscoveryClient, DiscoveryFilters, X402Client},
    types::*,
    X402Error,
};
use serde_json::json;
use std::str::FromStr;

#[tokio::test]
async fn test_client_with_payment_required() {
    // Mock a 402 response
    let mut server = Server::new_async().await;
    let _m = server
        .mock("GET", "/protected")
        .with_status(402)
        .with_header("content-type", "application/json")
        .with_body(
            json!({
                "x402Version": 1,
                "error": "X-PAYMENT header is required",
                "accepts": [{
                    "scheme": "exact",
                    "network": "base-sepolia",
                    "maxAmountRequired": "1000000",
                    "asset": "0x036CbD53842c5426634e7929541eC2318f3dCF7e",
                    "payTo": "0x209693Bc6afc0C5328bA36FaF03C514EF312287C",
                    "resource": "https://example.com/protected",
                    "description": "Test protected resource",
                    "mimeType": "application/json",
                    "maxTimeoutSeconds": 60
                }]
            })
            .to_string(),
        )
        .create();

    let client = X402Client::new().expect("Client creation MUST succeed");
    let response = client
        .get(&format!("{}/protected", server.url()))
        .send()
        .await
        .expect("HTTP request MUST succeed");

    assert_eq!(
        response.status(),
        402,
        "Response status MUST be exactly 402 Payment Required"
    );

    let payment_req: PaymentRequirementsResponse =
        response.json().await.expect("JSON parsing MUST succeed");
    assert_eq!(
        payment_req.x402_version, 1,
        "X402 version MUST be exactly 1"
    );
    assert_eq!(
        payment_req.error, "X-PAYMENT header is required",
        "Error message MUST be exactly 'X-PAYMENT header is required'"
    );
    assert_eq!(
        payment_req.accepts.len(),
        1,
        "Must accept exactly 1 payment scheme"
    );
    assert_eq!(
        payment_req.accepts[0].scheme, "exact",
        "Payment scheme MUST be exactly 'exact'"
    );
    assert_eq!(
        payment_req.accepts[0].network, "base-sepolia",
        "Network MUST be exactly 'base-sepolia'"
    );
}

#[tokio::test]
async fn test_client_with_successful_payment() {
    // Mock successful response after payment
    let mut server = Server::new_async().await;
    let _m = server.mock("GET", "/protected")
        .with_status(200)
        .with_header("content-type", "application/json")
        .with_header("X-PAYMENT-RESPONSE", "eyJzdWNjZXNzIjp0cnVlLCJ0cmFuc2FjdGlvbiI6IjB4MTIzNDU2Nzg5MGFiY2RlZjEyMzQ1Njc4OTBhYmNkZWYxMjM0NTY3ODkwYWJjZGVmMTIzNDU2Nzg5MGFiY2RlZiIsIm5ldHdvcmsiOiJiYXNlLXNlcG9saWEiLCJwYXllciI6IjB4ODU3YjA2NTE5RTkxZTNBNTQ1Mzg3OTFiRGJiMEUyMjM3M2UzNkI2NiJ9")
        .with_body(json!({
            "data": "This is protected content",
            "timestamp": "2024-01-01T00:00:00Z"
        }).to_string())
        .create();

    let client = X402Client::new().expect("Client creation MUST succeed");
    let payment_payload = create_test_payment_payload();

    let response = client
        .get(&format!("{}/protected", server.url()))
        .payment(&payment_payload)
        .expect("Payment header creation MUST succeed")
        .send()
        .await
        .expect("HTTP request with payment MUST succeed");

    assert_eq!(
        response.status(),
        200,
        "Response status MUST be exactly 200 OK after payment"
    );

    // Check settlement response header first (before consuming response)
    let settlement_header = response
        .headers()
        .get("X-PAYMENT-RESPONSE")
        .expect("X-PAYMENT-RESPONSE header MUST be present")
        .clone();
    let data: serde_json::Value = response.json().await.expect("JSON parsing MUST succeed");
    assert_eq!(
        data["data"], "This is protected content",
        "Response data MUST be exactly 'This is protected content'"
    );

    let settlement: SettleResponse = serde_json::from_slice(
        &base64::engine::general_purpose::STANDARD
            .decode(
                settlement_header
                    .to_str()
                    .expect("Header value MUST be valid UTF-8"),
            )
            .expect("Header value MUST be valid base64"),
    )
    .expect("Settlement response MUST be valid JSON");
    assert!(settlement.success, "Settlement MUST be successful");
    assert_eq!(
        settlement.network, "base-sepolia",
        "Settlement network MUST be exactly 'base-sepolia'"
    );
}

#[tokio::test]
async fn test_discovery_client() {
    let mut server = Server::new_async().await;
    let _m = server
        .mock("GET", "/resources")
        .with_status(200)
        .with_header("content-type", "application/json")
        .with_body(
            json!({
                "x402Version": 1,
                "items": [
                    {
                        "resource": "https://api.example.com/premium-data",
                        "type": "http",
                        "x402Version": 1,
                        "accepts": [{
                            "scheme": "exact",
                            "network": "base-sepolia",
                            "maxAmountRequired": "10000",
                            "resource": "https://api.example.com/premium-data",
                            "description": "Access to premium market data",
                            "mimeType": "application/json",
                            "payTo": "0x209693Bc6afc0C5328bA36FaF03C514EF312287C",
                            "maxTimeoutSeconds": 60,
                            "asset": "0x036CbD53842c5426634e7929541eC2318f3dCF7e"
                        }],
                        "lastUpdated": 1703123456,
                        "metadata": {
                            "category": "finance",
                            "provider": "Example Corp"
                        }
                    }
                ],
                "pagination": {
                    "limit": 20,
                    "offset": 0,
                    "total": 1
                }
            })
            .to_string(),
        )
        .create();

    let discovery = DiscoveryClient::new(server.url());
    let response = discovery
        .get_all_resources()
        .await
        .expect("Discovery request MUST succeed");

    assert_eq!(
        response.x402_version, 1,
        "Discovery response X402 version MUST be exactly 1"
    );
    assert_eq!(
        response.items.len(),
        1,
        "Discovery response MUST contain exactly 1 item"
    );
    assert_eq!(
        response.items[0].resource, "https://api.example.com/premium-data",
        "Resource URL MUST be exactly 'https://api.example.com/premium-data'"
    );
    assert_eq!(
        response.items[0].r#type, "http",
        "Resource type MUST be exactly 'http'"
    );
    assert_eq!(
        response.pagination.total, 1,
        "Pagination total MUST be exactly 1"
    );
}

#[tokio::test]
async fn test_discovery_with_filters() {
    let mut server = Server::new_async().await;
    let _m = server
        .mock("GET", "/resources")
        .with_status(200)
        .match_query(Matcher::AllOf(vec![
            Matcher::UrlEncoded("type".to_string(), "http".to_string()),
            Matcher::UrlEncoded("limit".to_string(), "10".to_string()),
            Matcher::UrlEncoded("offset".to_string(), "0".to_string()),
        ]))
        .with_header("content-type", "application/json")
        .with_body(
            json!({
                "x402Version": 1,
                "items": [],
                "pagination": {
                    "limit": 10,
                    "offset": 0,
                    "total": 0
                }
            })
            .to_string(),
        )
        .create();

    let discovery = DiscoveryClient::new(server.url());
    let filters = DiscoveryFilters::new()
        .with_resource_type("http")
        .with_limit(10)
        .with_offset(0);

    let response = discovery
        .discover_resources(Some(filters))
        .await
        .expect("Filtered discovery request MUST succeed");

    assert_eq!(
        response.items.len(),
        0,
        "Filtered discovery MUST return exactly 0 items"
    );
    assert_eq!(
        response.pagination.limit, 10,
        "Pagination limit MUST be exactly 10"
    );
}

#[tokio::test]
async fn test_payment_requirements_creation() {
    let mut requirements = PaymentRequirements::new(
        "exact",
        "base-sepolia",
        "1000000",
        "0x036CbD53842c5426634e7929541eC2318f3dCF7e",
        "0x209693Bc6afc0C5328bA36FaF03C514EF312287C",
        "https://example.com/test",
        "Test payment",
    );

    // Test USDC info setting
    requirements
        .set_usdc_info(Network::Testnet)
        .expect("USDC info setting MUST succeed for testnet");
    assert!(
        requirements.extra.is_some(),
        "Extra field MUST be populated after setting USDC info"
    );

    let extra = requirements
        .extra
        .as_ref()
        .expect("Extra field MUST be available");
    assert_eq!(extra["name"], "USDC", "USDC name MUST be exactly 'USDC'");
    assert_eq!(extra["version"], "2", "USDC version MUST be exactly '2'");

    // Test amount conversion
    let amount_decimal = requirements
        .amount_as_decimal()
        .expect("Amount conversion to decimal MUST succeed");
    assert_eq!(
        amount_decimal,
        rust_decimal::Decimal::from(1000000u64),
        "Amount as decimal MUST be exactly 1000000"
    );

    let amount_in_units = requirements
        .amount_in_decimal_units(6)
        .expect("Amount conversion to decimal units MUST succeed");
    assert_eq!(
        amount_in_units,
        rust_decimal::Decimal::from_str("1.0").expect("Decimal parsing MUST succeed"),
        "Amount in decimal units MUST be exactly 1.0"
    );
}

#[tokio::test]
async fn test_payment_payload_serialization() {
    let authorization = ExactEvmPayloadAuthorization::new(
        "0x857b06519E91e3A54538791bDbb0E22373e36b66",
        "0x209693Bc6afc0C5328bA36FaF03C514EF312287C",
        "1000000",
        "1745323800",
        "1745323985",
        "0xf3746613c2d920b5fdabc0856f2aeb2d4f88ee6037b8cc5d04a71a4462f13480",
    );

    let payload = ExactEvmPayload {
        signature: "0x2d6a7588d6acca505cbf0d9a4a227e0c52c6c34008c8e8986a1283259764173608a2ce6496642e377d6da8dbbf5836e9bd15092f9ecab05ded3d6293af148b571c".to_string(),
        authorization,
    };

    let payment_payload = PaymentPayload::new("exact", "base-sepolia", payload);

    // Test base64 encoding/decoding
    let encoded = payment_payload
        .to_base64()
        .expect("Base64 encoding MUST succeed");
    let decoded = PaymentPayload::from_base64(&encoded).expect("Base64 decoding MUST succeed");

    assert_eq!(
        payment_payload.x402_version, decoded.x402_version,
        "X402 version MUST be preserved after encoding/decoding"
    );
    assert_eq!(
        payment_payload.scheme, decoded.scheme,
        "Scheme MUST be preserved after encoding/decoding"
    );
    assert_eq!(
        payment_payload.network, decoded.network,
        "Network MUST be preserved after encoding/decoding"
    );
    assert_eq!(
        payment_payload.payload.authorization.from, decoded.payload.authorization.from,
        "Authorization 'from' field MUST be preserved after encoding/decoding"
    );
    assert_eq!(
        payment_payload.payload.authorization.to, decoded.payload.authorization.to,
        "Authorization 'to' field MUST be preserved after encoding/decoding"
    );
}

#[tokio::test]
async fn test_authorization_validity() {
    let now = chrono::Utc::now().timestamp();

    // Test valid authorization
    let valid_auth = ExactEvmPayloadAuthorization::new(
        "0x857b06519E91e3A54538791bDbb0E22373e36b66",
        "0x209693Bc6afc0C5328bA36FaF03C514EF312287C",
        "1000000",
        (now - 100).to_string(), // valid_after
        (now + 100).to_string(), // valid_before
        "0xf3746613c2d920b5fdabc0856f2aeb2d4f88ee6037b8cc5d04a71a4462f13480",
    );

    assert!(
        valid_auth
            .is_valid_now()
            .expect("Authorization validity check MUST succeed"),
        "Valid authorization MUST be valid now"
    );

    // Test expired authorization
    let expired_auth = ExactEvmPayloadAuthorization::new(
        "0x857b06519E91e3A54538791bDbb0E22373e36b66",
        "0x209693Bc6afc0C5328bA36FaF03C514EF312287C",
        "1000000",
        (now - 200).to_string(), // valid_after
        (now - 100).to_string(), // valid_before (expired)
        "0xf3746613c2d920b5fdabc0856f2aeb2d4f88ee6037b8cc5d04a71a4462f13480",
    );

    assert!(
        !expired_auth
            .is_valid_now()
            .expect("Authorization validity check MUST succeed"),
        "Expired authorization MUST NOT be valid now"
    );

    // Test not yet valid authorization
    let future_auth = ExactEvmPayloadAuthorization::new(
        "0x857b06519E91e3A54538791bDbb0E22373e36b66",
        "0x209693Bc6afc0C5328bA36FaF03C514EF312287C",
        "1000000",
        (now + 100).to_string(), // valid_after (future)
        (now + 200).to_string(), // valid_before
        "0xf3746613c2d920b5fdabc0856f2aeb2d4f88ee6037b8cc5d04a71a4462f13480",
    );

    assert!(
        !future_auth
            .is_valid_now()
            .expect("Authorization validity check MUST succeed"),
        "Future authorization MUST NOT be valid now"
    );
}

#[tokio::test]
async fn test_settle_response_serialization() {
    let settle_response = SettleResponse {
        success: true,
        error_reason: None,
        transaction: "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef"
            .to_string(),
        network: "base-sepolia".to_string(),
        payer: Some("0x857b06519E91e3A54538791bDbb0E22373e36b66".to_string()),
    };

    let encoded = settle_response
        .to_base64()
        .expect("Settle response base64 encoding MUST succeed");
    let decoded_bytes = base64::engine::general_purpose::STANDARD
        .decode(&encoded)
        .expect("Base64 decoding MUST succeed");
    let decoded: SettleResponse =
        serde_json::from_slice(&decoded_bytes).expect("JSON deserialization MUST succeed");

    assert_eq!(
        settle_response.success, decoded.success,
        "Success field MUST be preserved after encoding/decoding"
    );
    assert_eq!(
        settle_response.transaction, decoded.transaction,
        "Transaction field MUST be preserved after encoding/decoding"
    );
    assert_eq!(
        settle_response.network, decoded.network,
        "Network field MUST be preserved after encoding/decoding"
    );
    assert_eq!(
        settle_response.payer, decoded.payer,
        "Payer field MUST be preserved after encoding/decoding"
    );
}

#[tokio::test]
async fn test_error_handling() {
    // Test network not supported error
    let error = X402Error::NetworkNotSupported {
        network: "unsupported-network".to_string(),
    };
    assert!(
        error.to_string().contains("Network not supported"),
        "Network not supported error message MUST contain 'Network not supported'"
    );

    // Test invalid payment payload error
    let error = X402Error::invalid_payment_payload("Invalid signature");
    assert!(
        error.to_string().contains("Invalid payment payload"),
        "Invalid payment payload error message MUST contain 'Invalid payment payload'"
    );

    // Test insufficient funds error
    let error = X402Error::InsufficientFunds;
    assert!(
        error.to_string().contains("Insufficient funds"),
        "Insufficient funds error message MUST contain 'Insufficient funds'"
    );

    // Test authorization expired error
    let error = X402Error::AuthorizationExpired;
    assert!(
        error.to_string().contains("Authorization expired"),
        "Authorization expired error message MUST contain 'Authorization expired'"
    );
}

#[tokio::test]
async fn test_network_configurations() {
    // Test supported networks
    assert!(
        networks::is_supported("base-sepolia"),
        "base-sepolia MUST be supported"
    );
    assert!(networks::is_supported("base"), "base MUST be supported");
    assert!(
        networks::is_supported("avalanche-fuji"),
        "avalanche-fuji MUST be supported"
    );
    assert!(
        networks::is_supported("avalanche"),
        "avalanche MUST be supported"
    );
    assert!(
        !networks::is_supported("unsupported-network"),
        "unsupported-network MUST NOT be supported"
    );

    // Test USDC addresses
    assert_eq!(
        networks::get_usdc_address("base-sepolia"),
        Some("0x036CbD53842c5426634e7929541eC2318f3dCF7e"),
        "base-sepolia USDC address MUST be exactly 0x036CbD53842c5426634e7929541eC2318f3dCF7e"
    );
    assert_eq!(
        networks::get_usdc_address("base"),
        Some("0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913"),
        "base USDC address MUST be exactly 0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913"
    );
    assert_eq!(
        networks::get_usdc_address("avalanche-fuji"),
        Some("0x5425890298aed601595a70AB815c96711a31Bc65"),
        "avalanche-fuji USDC address MUST be exactly 0x5425890298aed601595a70AB815c96711a31Bc65"
    );

    // Test all supported networks
    let all_networks = networks::all_supported();
    assert_eq!(all_networks.len(), 4, "Must support exactly 4 networks");
    assert!(
        all_networks.contains(&"base-sepolia"),
        "Supported networks MUST include base-sepolia"
    );
    assert!(
        all_networks.contains(&"base"),
        "Supported networks MUST include base"
    );
    assert!(
        all_networks.contains(&"avalanche-fuji"),
        "Supported networks MUST include avalanche-fuji"
    );
    assert!(
        all_networks.contains(&"avalanche"),
        "Supported networks MUST include avalanche"
    );
}

// Helper function for creating test payment payload
fn create_test_payment_payload() -> PaymentPayload {
    let authorization = ExactEvmPayloadAuthorization::new(
        "0x857b06519E91e3A54538791bDbb0E22373e36b66",
        "0x209693Bc6afc0C5328bA36FaF03C514EF312287C",
        "1000000",
        "1745323800",
        "1745323985",
        "0xf3746613c2d920b5fdabc0856f2aeb2d4f88ee6037b8cc5d04a71a4462f13480",
    );

    let payload = ExactEvmPayload {
        signature: "0x2d6a7588d6acca505cbf0d9a4a227e0c52c6c34008c8e8986a1283259764173608a2ce6496642e377d6da8dbbf5836e9bd15092f9ecab05ded3d6293af148b571c".to_string(),
        authorization,
    };

    PaymentPayload::new("exact", "base-sepolia", payload)
}