Skip to main content

PaymentCandidate

Struct PaymentCandidate 

Source
pub struct PaymentCandidate {
    pub chain_id: ChainId,
    pub asset: CompactString,
    pub amount: CompactString,
    pub scheme: CompactString,
    pub pay_to: CompactString,
    pub requirements: PaymentRequirements,
    pub signer: Box<dyn PaymentCandidateSigner>,
}
Expand description

One payment option produced by SchemeClient::accept.

Fields§

§chain_id: ChainId

CAIP-2 chain id of the target chain.

§asset: CompactString

Token asset address / mint.

§amount: CompactString

Amount in the token’s smallest unit, stringified.

§scheme: CompactString

Scheme identifier ("exact", "upto", …).

§pay_to: CompactString

Recipient address.

§requirements: PaymentRequirements

Wire requirements this candidate was built from.

§signer: Box<dyn PaymentCandidateSigner>

Signer that can produce the authorization.

Implementations§

Source§

impl PaymentCandidate

Source

pub async fn sign(&self) -> Result<String, ClientError>

Signs the candidate, returning the base64-encoded payload.

§Errors

Returns ClientError when signing fails.

Trait Implementations§

Source§

impl Debug for PaymentCandidate

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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