r402-aptos 0.17.1

Aptos chain support for the x402 payment 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

//! Type definitions for the Aptos `"exact"` payment scheme.

pub use r402_core::scheme::ExactScheme;
use serde::{Deserialize, Serialize};

use crate::chain::AptosAddress;

/// Extra fields for Aptos payment requirements: optional facilitator `feePayer`.
#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase", deny_unknown_fields)]
pub struct AptosExtra {
    /// Account that will pay gas and must sign at settle time.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub fee_payer: Option<AptosAddress>,
}

/// Aptos exact payment payload: outer base64 of JSON-of-bytes.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ExactAptosPayload {
    /// Base64(UTF-8 JSON `{ transaction: [u8], senderAuthenticator: [u8] }`).
    pub transaction: String,
}

/// Wire format type aliases for the Aptos exact scheme.
pub mod v2 {
    use r402_core::wire;

    use super::{AptosExtra, ExactAptosPayload, ExactScheme};
    use crate::chain::{AptosAddress, AptosTokenAmount};

    /// Type alias for payment payloads with embedded requirements and Aptos data.
    pub type PaymentPayload = wire::PaymentPayload<PaymentRequirements, ExactAptosPayload>;

    /// Type alias for payment requirements with Aptos-specific types.
    pub type PaymentRequirements =
        wire::PaymentRequirements<ExactScheme, AptosTokenAmount, AptosAddress, AptosExtra>;
}

#[cfg(test)]
#[allow(clippy::unwrap_used, reason = "test assertions")]
mod tests {
    use serde_json::Value;

    use super::*;

    #[test]
    fn payload_field_is_camel_case() {
        let payload = ExactAptosPayload {
            transaction: "AQID".to_owned(),
        };
        let json = serde_json::to_value(&payload).unwrap();
        assert_eq!(
            json.get("transaction").and_then(Value::as_str),
            Some("AQID")
        );
        let back: ExactAptosPayload = serde_json::from_value(json).unwrap();
        assert_eq!(back.transaction, "AQID");
    }

    #[test]
    fn extra_rejects_unknown_fields() {
        let json = serde_json::json!({ "feePayer": crate::chain::USDC_TESTNET_FA, "alias": "x" });
        assert!(serde_json::from_value::<AptosExtra>(json).is_err());
        let empty = serde_json::json!({});
        assert!(serde_json::from_value::<AptosExtra>(empty).is_ok());
    }

    #[test]
    fn extra_golden_fixture_roundtrips() {
        let raw = include_str!("fixtures/extra.json");
        let extra: AptosExtra = serde_json::from_str(raw).unwrap();
        assert_eq!(
            extra.fee_payer.as_ref().map(AptosAddress::as_str),
            Some("0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
        );
        let encoded = serde_json::to_value(&extra).unwrap();
        assert_eq!(
            encoded,
            serde_json::json!({
                "feePayer": "0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
            })
        );
    }
}