Struct X402Client 

pub struct X402Client<TSelector = FirstMatch> { /* private fields */ }

Available on crate feature client only.

HTTP middleware over a core PaymentClient.

On 402 Payment Required, signs a payment and retries once (or twice if on_payment_response signals recovery). Other statuses, including 412 and 502, are never retried.

Implementations

impl X402Client<FirstMatch>

pub fn new() -> Self

Creates a new client with FirstMatch selection.

impl<TSelector> X402Client<TSelector>

pub const fn from_payment_client(inner: PaymentClient<TSelector>) -> Self

Builds from an existing core payment client.

pub const fn payment_client(&self) -> &PaymentClient<TSelector>

Returns a shared reference to the core payment client.

pub fn register(self, scheme: impl SchemeClient + 'static) -> Self

Registers a scheme client.

pub fn with_selector<P: PaymentSelector>(self, selector: P) -> X402Client<P>

Sets a custom payment selector.

pub fn with_policy(self, policy: impl PaymentPolicy + 'static) -> Self

Adds a payment policy.

pub fn with_hook(self, hook: impl ClientHooks + 'static) -> Self

Adds a client lifecycle hook (including on_payment_response).

pub fn with_extension(self, extension: impl ClientExtension + 'static) -> Self

Adds a client extension (HTTP 402 header hook and payload enrich).

pub fn with_spend_controls(self, controls: SpendControls) -> Self

Enables spend controls with the given configuration.

pub fn disable_spend_controls(self) -> Self

Disables all spend controls (any asset, no caps).

impl<TSelector> X402Client<TSelector>

where TSelector: PaymentSelector,

pub async fn make_payment_headers( &self, res: Response, ) -> Result<HeaderMap, ClientError>

Creates Payment-Signature plus advertised extension headers from a 402.

SIGN-IN-WITH-X is included when a registered extension’s key is in PaymentRequired.extensions.

Errors

Parse, selection, signing, or before-hook abort.

pub async fn create_payment( &self, payment_required: &PaymentRequired, ) -> Result<CreatedPayment, ClientError>

Creates a payment for an already-parsed challenge.

Errors

Selection, signing, or before-hook abort.

impl<S> X402Client<S>

where Self: Middleware,

pub fn wrap(self, client: Client) -> ClientWithMiddleware

Wraps a reqwest Client with x402 payment middleware.

pub fn wrap_builder(self, client: Client) -> ClientBuilder

Wraps a reqwest Client and returns the middleware builder.

Trait Implementations

impl<TSelector> Debug for X402Client<TSelector>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for X402Client<FirstMatch>

fn default() -> Self

Returns the “default value” for a type.

impl<TSelector> Middleware for X402Client<TSelector>

where TSelector: PaymentSelector + Send + Sync + 'static,

fn handle<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, req: Request, extensions: &'life1 mut Extensions, next: Next<'life2>, ) -> Pin<Box<dyn Future<Output = Result<Response>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Invoked with a request before sending it. If you want to continue processing the request, you should explicitly call next.run(req, extensions).