Skip to main content

CreateOfferRequest

Struct CreateOfferRequest 

Source
pub struct CreateOfferRequest {
    pub expiry_secs: Option<u32>,
    pub amount: Option<Amount>,
    pub description: Option<String>,
    pub max_quantity: Option<MaxQuantity>,
    pub issuer: Option<String>,
}

Fields§

§expiry_secs: Option<u32>§amount: Option<Amount>

The amount we’re requesting for payments using this offer.

If None, the offer is variable amount and the payer can choose any value.

If Some, the offer amount is fixed and the payer must pay exactly this value (per item, see max_quantity).

§description: Option<String>

The description to be encoded into the invoice.

If None, the description field inside the invoice will be an empty string (“”), as lightning requires a description to be set.

§max_quantity: Option<MaxQuantity>

The max number of items that can be purchased in any one payment for the offer.

NOTE: this is not related to single-use vs reusable offers.

The expected amount paid for this offer is offer.amount * quantity, where offer.amount is the value per item and quantity is the number of items chosen by the payer. The payer’s chosen quantity must be in the range: 0 < quantity <= offer.max_quantity.

If None, defaults to MaxQuantity::ONE, i.e., the expected paid amount is just offer.amount.

§issuer: Option<String>

The issuer of the offer.

If Some, offer will encode the string. Bolt12 spec expects this tring to be a domain or a user@domain address. If None, offer issuer will encode “lexe.app” as the issuer.

Trait Implementations§

Source§

impl Default for CreateOfferRequest

Source§

fn default() -> CreateOfferRequest

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for CreateOfferRequest

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<CreateOfferRequest, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for CreateOfferRequest

Source§

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

Serialize this value into the given Serde serializer. 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<F, T, U> Apply<F, U> for T
where F: FnOnce(T) -> U,

Source§

fn apply(self, f: F) -> U

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> 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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: 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,