r402-evm 0.21.0

EIP-155 (EVM) 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
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

//! EIP-155 (EVM) chain support for the x402 payment protocol.
//!
//! Exact scheme: ERC-3009 `transferWithAuthorization` and Permit2 via
//! `x402ExactPermit2Proxy`. Upto scheme: Permit2 witness via
//! `x402UptoPermit2Proxy` (verify = max, settle = actual ≤ max).
//! EIP-1271 / EIP-6492 smart-wallet signatures are accepted on verify
//! and settle. Insufficient Permit2 allowance is
//! [`r402_protocol::error::VerificationError::Permit2AllowanceRequired`]
//! (HTTP 412). Also implements `auth-capture` and `batch-settlement`.
//!
//! # Features
//!
//! - `server` — [`Eip155Exact::price_tag`], [`Eip155Upto::price_tag`]
//! - `client` — [`Eip155ExactClient`] / [`Eip155UptoClient`] EIP-712 signing
//! - `facilitator` — [`Eip155ExactFacilitator::try_new`], [`Eip155UptoFacilitator::try_new`]
//! - `telemetry` — tracing spans on RPC paths

#![cfg_attr(docsrs, feature(doc_cfg))]
#![cfg_attr(
    test,
    allow(
        clippy::expect_used,
        clippy::indexing_slicing,
        clippy::panic,
        clippy::unwrap_used,
        reason = "unit tests panic on assertion failure"
    )
)]

// Consumed by feature-gated modules; silence the linter when default
// features disable every consumer of `compact_str`.
#[cfg(not(any(feature = "client", feature = "server", feature = "facilitator")))]
use compact_str as _;

pub mod asset;
pub mod auth_capture;
pub mod batch_settlement;
pub mod chain;
pub mod eip2612;
pub mod erc20_approval;
#[cfg(feature = "facilitator")]
#[cfg_attr(docsrs, doc(cfg(feature = "facilitator")))]
pub mod error;
pub mod exact;
mod networks;
pub mod permit2;
#[cfg(feature = "facilitator")]
#[cfg_attr(docsrs, doc(cfg(feature = "facilitator")))]
pub mod signature;
#[cfg(feature = "client")]
#[cfg_attr(docsrs, doc(cfg(feature = "client")))]
pub mod signer;
pub mod upto;

pub use asset::{AssetTransferMethod, VALIDATOR_ADDRESS};
pub use auth_capture::Eip155AuthCapture;
#[cfg(feature = "client")]
pub use auth_capture::Eip155AuthCaptureClient;
#[cfg(feature = "facilitator")]
pub use auth_capture::Eip155AuthCaptureFacilitator;
pub use batch_settlement::Eip155BatchSettlement;
#[cfg(feature = "client")]
pub use batch_settlement::Eip155BatchSettlementClient;
#[cfg(feature = "facilitator")]
pub use batch_settlement::Eip155BatchSettlementFacilitator;
pub use chain::{EVM_DEFAULT_CLOCK_SKEW_TOLERANCE_SECS, append_data_suffix};
pub use eip2612::{
    EIP2612_GAS_SPONSORING_KEY, EIP2612_GAS_SPONSORING_VERSION, Eip2612ParseError,
    Eip2612SignedPermit,
};
pub use erc20_approval::{
    ERC20_APPROVAL_GAS_SPONSORING_KEY, ERC20_APPROVAL_GAS_SPONSORING_VERSION,
    Erc20ApprovalGasSponsoringInfo, Erc20ApprovalParseError,
};
#[cfg(feature = "facilitator")]
pub use error::Eip155ExactError;
pub use exact::Eip155Exact;
#[cfg(feature = "facilitator")]
pub use exact::Eip155ExactFacilitator;
#[cfg(feature = "client")]
pub use exact::{Eip155ExactClient, Eip155ExactClientBuilder};
pub use networks::*;
pub use permit2::{PERMIT2_ADDRESS, Permit2TokenPermissions};
#[cfg(feature = "client")]
pub use permit2::{Permit2Approver, permit2_allowance_calldata, permit2_approval_calldata};
#[cfg(feature = "facilitator")]
pub use signature::StructuredSignatureFormatError;
#[cfg(feature = "client")]
pub use signer::SignerLike;
#[cfg(feature = "facilitator")]
pub use upto::Eip155UptoFacilitator;
pub use upto::{Eip155Upto, X402_UPTO_PERMIT2_PROXY};
#[cfg(feature = "client")]
pub use upto::{
    Eip155UptoClient, Eip155UptoClientBuilder, Eip2612SigningParams, sign_eip2612_permit,
};

#[cfg(test)]
mod _dev_deps {
    #[cfg(not(any(feature = "client", feature = "facilitator")))]
    use alloy_network as _;
    #[cfg(not(any(feature = "client-provider", feature = "facilitator")))]
    use alloy_provider as _;
    #[cfg(not(feature = "client"))]
    use alloy_signer_local as _;
    #[cfg(not(feature = "facilitator"))]
    use alloy_transport_http as _;
    use tokio as _;
    #[cfg(not(feature = "facilitator"))]
    use url as _;
    use wiremock as _;
}

#[cfg(test)]
mod tests {
    #[test]
    fn crate_loads() {
        assert_eq!(
            env!("CARGO_PKG_NAME"),
            "r402-evm",
            "package name must match the crate directory"
        );
    }
}