Struct X402Middleware 

pub struct X402Middleware { /* private fields */ }

Available on crate feature server only.

Application-level x402 middleware. Owns a ResourceServer.

Not a tower::Layer. Paid routes are built with Self::with_price_tag.

Implementations

impl X402Middleware

pub fn from_facilitator(fac: impl Facilitator + 'static) -> Self

Wraps fac in a new ResourceServer.

pub const fn from_resource_server(server: ResourceServer) -> Self

Creates middleware that owns an existing ResourceServer.

pub fn try_new(url: &str) -> Result<Self, FacilitatorClientError>

Remote facilitator from a base URL.

Errors

FacilitatorClientError when the URL cannot be parsed or endpoints built.

pub fn with_scheme( self, network: ChainIdPattern, scheme: impl SchemeNetworkServer + 'static, ) -> Self

Registers a scheme/network adapter.

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

Registers a protocol extension advertised on 402 responses.

pub fn with_base_url(&self, base_url: Url) -> Self

Public origin used to build ResourceInfo.url. Required before with_price_tag.

Never derived from Host and never defaulted to http://localhost.

pub const fn resource_server(&self) -> &ResourceServer

Owned resource server.

pub fn with_siwx(&self, gate: SiwxGate) -> Self

Available on crate feature siwx only.

Enables SIWX on layers built from this middleware.

Empty static tags still require Self::with_auth_only before Self::with_price_tags.

pub fn with_auth_only(&self, gate: SiwxGate) -> Self

Available on crate feature siwx only.

Enables SIWX and treats empty price tags as auth-only.

Call before Self::with_price_tags with an empty list. Grants access on valid signature even without a paid-address hit.

pub fn with_price_tag( &self, price_tag: PriceTag, ) -> Result<X402Layer<StaticPriceTags>, BuildError>

Static single-tag layer. Fails when Self::with_base_url was not called.

Errors

BuildError::MissingBaseUrl, then other BuildError variants from static tag validation. with_resource does not waive base_url.

pub fn with_price_tags( &self, price_tags: Vec<PriceTag>, ) -> Result<X402Layer<StaticPriceTags>, BuildError>

Static multi-tag layer.

Empty list is BuildError::EmptyPriceTags unless Self::with_auth_only was already called.

Errors

BuildError::MissingBaseUrl when with_base_url was not called, or other BuildError variants when static tags are invalid. with_resource does not waive base_url.

pub fn with_dynamic_price<F, Fut>( &self, callback: F, ) -> Result<X402Layer<DynamicPriceTags>, BuildError>

where F: Fn(&HeaderMap, &Uri, &Url) -> Fut + Send + Sync + 'static, Fut: Future<Output = Vec<PriceTag>> + Send + 'static,

Dynamic price source.

Errors

BuildError::MissingBaseUrl.

Trait Implementations

impl Clone for X402Middleware

fn clone(&self) -> X402Middleware

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for X402Middleware

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

Formats the value using the given formatter.

impl TryFrom<&str> for X402Middleware

type Error = FacilitatorClientError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for X402Middleware

type Error = FacilitatorClientError

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.