cdk_common::payment

Trait MintPayment

Source 
pub trait MintPayment {
    type Err: Into<Error> + From<Error>;

    // Required methods
    fn get_settings<'life0, 'async_trait>(
        &'life0 self,
    ) -> Pin<Box<dyn Future<Output = Result<Value, Self::Err>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn create_incoming_payment_request<'life0, 'life1, 'async_trait>(
        &'life0 self,
        amount: Amount,
        unit: &'life1 CurrencyUnit,
        description: String,
        unix_expiry: Option<u64>,
    ) -> Pin<Box<dyn Future<Output = Result<CreateIncomingPaymentResponse, Self::Err>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn get_payment_quote<'life0, 'life1, 'life2, 'async_trait>(
        &'life0 self,
        request: &'life1 str,
        unit: &'life2 CurrencyUnit,
        options: Option<MeltOptions>,
    ) -> Pin<Box<dyn Future<Output = Result<PaymentQuoteResponse, Self::Err>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait,
             'life2: 'async_trait;
    fn make_payment<'life0, 'async_trait>(
        &'life0 self,
        melt_quote: MeltQuote,
        partial_amount: Option<Amount>,
        max_fee_amount: Option<Amount>,
    ) -> Pin<Box<dyn Future<Output = Result<MakePaymentResponse, Self::Err>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn wait_any_incoming_payment<'life0, 'async_trait>(
        &'life0 self,
    ) -> Pin<Box<dyn Future<Output = Result<Pin<Box<dyn Stream<Item = String> + Send>>, Self::Err>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn is_wait_invoice_active(&self) -> bool;
    fn cancel_wait_invoice(&self);
    fn check_incoming_payment_status<'life0, 'life1, 'async_trait>(
        &'life0 self,
        request_lookup_id: &'life1 str,
    ) -> Pin<Box<dyn Future<Output = Result<MintQuoteState, Self::Err>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn check_outgoing_payment<'life0, 'life1, 'async_trait>(
        &'life0 self,
        request_lookup_id: &'life1 str,
    ) -> Pin<Box<dyn Future<Output = Result<MakePaymentResponse, Self::Err>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
}
Expand description

Mint payment trait

Required Associated Types§

Source

type Err: Into<Error> + From<Error>

Mint Lightning Error

Required Methods§

Source

fn get_settings<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Value, Self::Err>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Base Settings

Source

fn create_incoming_payment_request<'life0, 'life1, 'async_trait>( &'life0 self, amount: Amount, unit: &'life1 CurrencyUnit, description: String, unix_expiry: Option<u64>, ) -> Pin<Box<dyn Future<Output = Result<CreateIncomingPaymentResponse, Self::Err>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Create a new invoice

Source

fn get_payment_quote<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, request: &'life1 str, unit: &'life2 CurrencyUnit, options: Option<MeltOptions>, ) -> Pin<Box<dyn Future<Output = Result<PaymentQuoteResponse, Self::Err>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Get payment quote Used to get fee and amount required for a payment request

Source

fn make_payment<'life0, 'async_trait>( &'life0 self, melt_quote: MeltQuote, partial_amount: Option<Amount>, max_fee_amount: Option<Amount>, ) -> Pin<Box<dyn Future<Output = Result<MakePaymentResponse, Self::Err>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Pay request

Source

fn wait_any_incoming_payment<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Pin<Box<dyn Stream<Item = String> + Send>>, Self::Err>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Listen for invoices to be paid to the mint Returns a stream of request_lookup_id once invoices are paid

Source

fn is_wait_invoice_active(&self) -> bool

Is wait invoice active

Source

fn cancel_wait_invoice(&self)

Cancel wait invoice

Source

fn check_incoming_payment_status<'life0, 'life1, 'async_trait>( &'life0 self, request_lookup_id: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<MintQuoteState, Self::Err>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Check the status of an incoming payment

Source

fn check_outgoing_payment<'life0, 'life1, 'async_trait>( &'life0 self, request_lookup_id: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<MakePaymentResponse, Self::Err>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Check the status of an outgoing payment

Implementors§