Struct PaymentRequirements 

#[non_exhaustive]
pub struct PaymentRequirements<TScheme = CompactString, TAmount = CompactString, TAddress = CompactString, TExtra = Value> {
    pub scheme: TScheme,
    pub network: ChainId,
    pub amount: TAmount,
    pub pay_to: TAddress,
    pub max_timeout_seconds: u64,
    pub asset: TAddress,
    pub extra: Option<TExtra>,
}

Payment terms set by the seller, carried inside PaymentRequired.accepts[].

Generic parameters allow concrete chain crates to specialise the scheme name, amount representation, addresses, and scheme-specific extra blob. The wire-level defaults are all strings plus an opaque JSON value for extra, mirroring the protocol exactly.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

scheme: TScheme

The payment scheme, e.g. "exact" or "upto".

network: ChainId

CAIP-2 chain identifier (e.g. "eip155:8453").

amount: TAmount

Payment amount in the token’s smallest unit (as string for precision).

pay_to: TAddress

Recipient address on the target chain.

max_timeout_seconds: u64

Maximum time in seconds the authorization remains valid.

asset: TAddress

Token asset address / mint.

extra: Option<TExtra>

Scheme-specific auxiliary data.

Implementations

impl<TScheme, TAmount, TAddress, TExtra> PaymentRequirements<TScheme, TAmount, TAddress, TExtra>

pub const fn new( scheme: TScheme, network: ChainId, amount: TAmount, pay_to: TAddress, asset: TAddress, max_timeout_seconds: u64, ) -> Self

Constructs the requirements from the six required wire fields. Use Self::with_extra / Self::with_optional_extra to attach the scheme-specific blob.

pub fn with_extra(self, extra: TExtra) -> Self

Builder: attaches the scheme-specific extra blob.

pub fn with_optional_extra(self, extra: Option<TExtra>) -> Self

Builder: passes through an optional extra blob (useful when the value is produced via Option::map upstream).

impl PaymentRequirements

pub fn matches_payload_accepted(&self, accepted: &Self) -> bool

Returns true when accepted matches this requirement under Go FindMatchingRequirements rules (server.go): scheme, network, amount, asset, payTo must be equal.

maxTimeoutSeconds and extra are intentionally not compared (same as the foundation Go / Casper preflight convention).

pub fn as_concrete<TScheme, TAmount, TAddress, TExtra>( &self, ) -> Option<PaymentRequirements<TScheme, TAmount, TAddress, TExtra>>

where TScheme: FromStr, TAmount: FromStr, TAddress: FromStr, TExtra: DeserializeOwned,

Attempts to convert the wire-level requirements (all-strings) into a concrete, strongly-typed variant.

Returns None if any component fails to parse.

Trait Implementations

impl<TScheme: Clone, TAmount: Clone, TAddress: Clone, TExtra: Clone> Clone for PaymentRequirements<TScheme, TAmount, TAddress, TExtra>

fn clone(&self) -> PaymentRequirements<TScheme, TAmount, TAddress, TExtra>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<TScheme: Debug, TAmount: Debug, TAddress: Debug, TExtra: Debug> Debug for PaymentRequirements<TScheme, TAmount, TAddress, TExtra>

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

Formats the value using the given formatter.

impl<'de, TScheme, TAmount, TAddress, TExtra> Deserialize<'de> for PaymentRequirements<TScheme, TAmount, TAddress, TExtra>

where TScheme: Deserialize<'de>, TAmount: Deserialize<'de>, TAddress: Deserialize<'de>, TExtra: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<TScheme: Eq, TAmount: Eq, TAddress: Eq, TExtra: Eq> Eq for PaymentRequirements<TScheme, TAmount, TAddress, TExtra>

impl<TScheme: PartialEq, TAmount: PartialEq, TAddress: PartialEq, TExtra: PartialEq> PartialEq for PaymentRequirements<TScheme, TAmount, TAddress, TExtra>

fn eq( &self, other: &PaymentRequirements<TScheme, TAmount, TAddress, TExtra>, ) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialEq<PaymentRequirements> for PriceTag

Matches a PriceTag against wire-level requirements on the five protocol-critical fields only (scheme / network / amount / asset / pay_to).

max_timeout_seconds and extra are deliberately ignored so enriched fields attached by the facilitator do not cause false negatives.

fn eq(&self, other: &PaymentRequirements) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<TScheme, TAmount, TAddress, TExtra> Serialize for PaymentRequirements<TScheme, TAmount, TAddress, TExtra>

where TScheme: Serialize, TAmount: Serialize, TAddress: Serialize, TExtra: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<TScheme: PartialEq, TAmount: PartialEq, TAddress: PartialEq, TExtra: PartialEq> StructuralPartialEq for PaymentRequirements<TScheme, TAmount, TAddress, TExtra>