Skip to main content

SiwxGate

r402_http::server

Struct SiwxGate 

Source 
pub struct SiwxGate { /* private fields */ }
Available on crate feature server only.
Expand description

Resource-server SIWX configuration used by the HTTP gate.

Implementations§

Source§

impl SiwxGate

Source

pub fn new(origin: SiwxOrigin, store: impl PaidAddressStore + 'static) -> Self

Binds SIWX to a configured public origin and paid-address store.

Origin is required. There is no Host constructor.

Source

pub fn with_chain(self, chain: SiwxChain) -> Self

Adds a supported authentication chain.

Source

pub fn with_statement(self, statement: impl Into<CompactString>) -> Self

Sets the CAIP-122 statement shown to the wallet.

Source

pub const fn with_auth_only(self) -> Self

Grants access on valid signature even when the address has not paid.

Source

pub fn with_evm_rpc_map( self, map: impl IntoIterator<Item = (u64, impl Into<String>)>, timeout: Option<Duration>, ) -> Self

Available on crate feature siwx-eip1271 only.

Server-configured per-chain RPC for EIP-1271 / EIP-6492.

timeout None keeps siwx-evm’s 5s default. Some is applied after with_rpc_map, which resets timeout.

Source

pub const fn is_auth_only(&self) -> bool

Whether empty price tags must not bypass the gate.

Source

pub const fn origin(&self) -> &SiwxOrigin

Configured public origin (never Host).

Source

pub fn store(&self) -> &dyn PaidAddressStore

Shared paid-address / nonce store.

Source

pub fn challenge_entry(&self, path: &str) -> Result<ExtensionEntry, SiwxError>

Per-request 402 challenge entry (fresh nonce and timestamps).

§Errors

SiwxError when nonce or timestamp formatting fails.

Source

pub fn record_success(&self, path: &str, address: &str)

Records a successful settlement against configured origin + path.

Source

pub const fn key() -> &'static str

Wire key inserted on PaymentRequired.extensions.

Trait Implementations§

Source§

impl Clone for SiwxGate

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SiwxGate

Source§

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

Formats the value using the given formatter. Read more
Source§

impl GateHooks for SiwxGate

Source§

fn on_protected_request<'a>( &'a self, req: &'a Request<Body>, ) -> impl Future<Output = ProtectedRequestOutcome> + Send + 'a

Fires on every protected request, before the payment check.
Source§

fn on_payment_verified<'a>( &'a self, _req: &'a mut Request<Body>, ) -> impl Future<Output = ()> + Send + 'a

Fires after a payment is verified, before the inner handler.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynGateHooks for T
where T: GateHooks + ?Sized,

Source§

fn on_protected_request<'a>( &'a self, req: &'a Request<Body>, ) -> Pin<Box<dyn Future<Output = ProtectedRequestOutcome> + Send + 'a>>

Available on crate feature server only.
See GateHooks::on_protected_request.
Source§

fn on_payment_verified<'a>( &'a self, req: &'a mut Request<Body>, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'a>>

Available on crate feature server only.
See GateHooks::on_payment_verified.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more