Skip to main content

ResourceServer

Struct ResourceServer 

Source
pub struct ResourceServer { /* private fields */ }
Expand description

Server-side payment orchestrator.

Implementations§

Source§

impl ResourceServer

Source

pub async fn notify_verified_payment_canceled( &self, payload: &WirePaymentPayload, requirements: &PaymentRequirements, reason: CancelReason, error: Option<&str>, response_status: Option<u16>, )

Fires on_verified_payment_canceled for every registered hook.

Source

pub fn cancellation_guard( &self, payload: WirePaymentPayload, requirements: PaymentRequirements, ) -> CancellationGuard

Builds a one-shot cancellation dispatcher (first call wins).

Source§

impl ResourceServer

Source

pub fn find_matching_requirements<'a>( &self, available: &'a [PaymentRequirements], payload: &WirePaymentPayload, ) -> Option<&'a PaymentRequirements>

First available accept that matches payload.accepted.

Scheme-declared crate::SchemeNetworkServer::dynamic_extra_fields are omitted from the extra-subset comparison.

Source§

impl ResourceServer

Source

pub async fn create_payment_required_response( &self, accepts: Vec<PaymentRequirements>, ctx: PaymentRequiredBuildContext, ) -> Result<PaymentRequired, FacilitatorError>

One 402 body used for both unpaid challenges and paid matching.

After scheme enrich and extension advertise, each accept is resolved through the registered scheme table and written with apply_payment_flow_wire_extra. Unregistered schemes fail closed.

§Errors

FacilitatorError::Internal when hook policy, unregistered scheme, or payment-flow resolution / wire extra application fails.

Source§

impl ResourceServer

Source

pub fn new<F>(facilitator: Arc<F>) -> Self
where F: Facilitator + 'static,

Creates a resource server over any Facilitator.

Source

pub fn from_dyn(facilitator: Arc<dyn DynFacilitator>) -> Self

Creates from an already-erased facilitator handle.

Source

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

Registers a lifecycle hook. Returns self for builder chaining.

Source

pub fn add_hook(&mut self, hook: impl ResourceServerHooks + 'static)

Registers a lifecycle hook after construction.

Source

pub fn hook_count(&self) -> usize

Number of registered resource-server hooks.

Source

pub fn facilitator(&self) -> Arc<dyn DynFacilitator>

Returns a clone of the inner facilitator handle.

Source

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

Registers a scheme/network adapter. Returns self for builder chaining.

Source

pub fn register_scheme( &mut self, network: ChainIdPattern, scheme: impl SchemeNetworkServer + 'static, )

Registers a scheme/network adapter after construction.

Source

pub fn registered_scheme( &self, scheme: &str, network: &ChainId, ) -> Option<&dyn DynSchemeNetworkServer>

Registered adapter for scheme on network, if any.

Exact CAIP-2 registrations win over wildcard/set patterns.

Source

pub fn get_payment_flow( &self, requirements: &PaymentRequirements, ) -> Result<PaymentFlowName, PaymentFlowError>

Resolves the payment-flow name for this accept from the scheme table.

§Errors

PaymentFlowError::UnregisteredScheme when no adapter matches this accept, or ATM/flow errors from resolve_payment_flow.

Source

pub async fn has_settle_on_cancel( &self, requirements: &PaymentRequirements, ) -> bool

Whether the registered scheme yields cancel-settle requirements.

Escrow accepts must return true before a transport will serve them.

Source

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

Registers a protocol extension advertised on 402 responses.

Source§

impl ResourceServer

Source

pub async fn settle_payment( &self, payload: &WirePaymentPayload, requirements: &PaymentRequirements, overrides: Option<&SettlementOverrides>, phase: SettlePhase, resource_url: Option<&str>, advertised: Option<&Extensions>, ) -> Result<SettleResponse, FacilitatorError>

Optional amount overrides → before hooks → facilitator → after hooks.

Facilitator settle is attempted twice only when the first Ok result is settlement_pending with a non-empty transaction; no sleep.

§Errors

Propagates facilitator / abort / invalid-override errors unless a failure hook recovers.

Source§

impl ResourceServer

Source

pub async fn verify_payment( &self, payload: &WirePaymentPayload, requirements: &PaymentRequirements, advertised: Option<&Extensions>, ) -> Result<VerifyPaymentOutcome, FacilitatorError>

Before hooks → facilitator → after hooks.

Every accept must have a registered crate::SchemeNetworkServer. Empty schemes is crate::PaymentFlowError::UnregisteredScheme, not an always-facilitator fallback. When the resolved flow has !verify_before_handler, returns Valid without the facilitator and without after_verify.

§Errors

Propagates facilitator errors (unless recovered), before-hook aborts, after-verify aborts (FacilitatorError::Aborted), and payment-flow resolution failures.

Trait Implementations§

Source§

impl Clone for ResourceServer

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 ResourceServer

Source§

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

Formats the value using the given formatter. Read more

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<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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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> 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<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