mpp-br 0.8.1

Rust SDK for the Machine Payments Protocol (MPP)
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

//! mpp - Machine Payment Protocol for Rust
//!
//! A Rust library implementing the Web Payment Auth protocol.
//!
//! # Quick Start
//!
//! ```no_run
//! use mpp_br::{PaymentChallenge, PaymentCredential, Receipt, ChargeRequest};
//! use mpp_br::{parse_www_authenticate, format_authorization};
//! # fn main() {}
//! ```
//!
//! # Signer Integration
//!
#![cfg_attr(feature = "evm", doc = "```no_run")]
#![cfg_attr(not(feature = "evm"), doc = "```ignore")]
//! use mpp_br::{Signer, PrivateKeySigner};
//! # fn main() {}
//! ```
//!
//! Consumers provide their own signer. The library does not manage keystores.

pub const VERSION: &str = env!("CARGO_PKG_VERSION");

// ==================== Internal Modules ====================

pub mod body_digest;
pub mod error;
pub mod expires;
pub mod mcp;
pub mod protocol;
pub mod proxy;
pub mod store;

#[cfg(feature = "evm")]
pub mod evm;

#[cfg(feature = "client")]
pub mod client;

#[cfg(feature = "server")]
pub mod server;

#[cfg(feature = "tempo")]
pub mod tempo;

// ==================== Flat Re-exports ====================

// Error types
pub use error::{MppError, Result};

// RFC 9457 Problem Details
pub use error::{
    PaymentError, PaymentErrorDetails, CORE_PROBLEM_TYPE_BASE, SESSION_PROBLEM_TYPE_BASE,
};

// Deprecated: remove in next major version.
#[allow(deprecated)]
pub use error::STREAM_PROBLEM_TYPE_BASE;

// Core protocol types
pub use protocol::core::{
    compute_challenge_id, ChallengeEcho, PaymentChallenge, PaymentCredential, PaymentPayload,
    Receipt, ReceiptStatus,
};

// Header parsing/formatting
pub use protocol::core::{
    format_authorization, format_receipt, format_www_authenticate, format_www_authenticate_many,
    parse_authorization, parse_receipt, parse_www_authenticate, parse_www_authenticate_all,
};

// Schema types
pub use protocol::core::{
    base64url_decode, base64url_encode, Base64UrlJson, IntentName, MethodName, PayloadType,
    PaymentProtocol, AUTHORIZATION_HEADER, PAYMENT_RECEIPT_HEADER, PAYMENT_SCHEME,
    WWW_AUTHENTICATE_HEADER,
};

// Store types
pub use store::{FileStore, MemoryStore, Store, StoreError};

#[cfg(all(feature = "server", feature = "tempo"))]
pub use store::ChannelStoreAdapter;

// Intent types
pub use protocol::intents::{
    deserialize_request, deserialize_request_typed, parse_units, request_from_challenge,
    request_from_challenge_typed, serialize_request, ChargeRequest, Request as PaymentRequest,
    SessionRequest,
};

// ==================== Alloy Re-exports ====================

#[cfg(feature = "evm")]
pub use alloy::signers::Signer;

#[cfg(feature = "evm")]
pub use alloy::signers::local::PrivateKeySigner;

#[cfg(feature = "evm")]
pub use alloy::primitives::{Address, U256};

#[cfg(feature = "tempo")]
pub use alloy::providers::{ProviderBuilder, RootProvider};