Struct CdkBdk 

pub struct CdkBdk { /* private fields */ }

CDK onchain payment backend using BDK (Bitcoin Development Kit)

Implementations

impl CdkBdk

pub fn new( mnemonic: Mnemonic, network: Network, chain_source: ChainSource, storage_dir_path: String, fee_reserve: FeeReserve, kv_store: Arc<dyn KVStore<Err = Error> + Send + Sync>, batch_config: Option<BatchConfig>, num_confs: u32, min_receive_amount_sat: u64, min_send_amount_sat: u64, sync_interval_secs: u64, shutdown_timeout_secs: Option<u64>, sync_config: Option<SyncConfig>, ) -> Result<Self, Error>

Create a new CdkBdk instance

Trait Implementations

impl Clone for CdkBdk

fn clone(&self) -> CdkBdk

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl MintPayment for CdkBdk

type Err = Error

Mint Lightning Error

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

where Self: 'async_trait, 'life0: 'async_trait,

Start the payment processor Called when the mint starts up to initialize the payment processor

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

where Self: 'async_trait, 'life0: 'async_trait,

Stop the payment processor Called when the mint shuts down to gracefully stop the payment processor

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

where Self: 'async_trait, 'life0: 'async_trait,

Base Settings

fn get_payment_quote<'life0, 'life1, 'async_trait>( &'life0 self, _unit: &'life1 CurrencyUnit, options: OutgoingPaymentOptions, ) -> Pin<Box<dyn Future<Output = Result<PaymentQuoteResponse, Self::Err>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

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

fn make_payment<'life0, 'life1, 'async_trait>( &'life0 self, _unit: &'life1 CurrencyUnit, options: OutgoingPaymentOptions, ) -> Pin<Box<dyn Future<Output = Result<MakePaymentResponse, Self::Err>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Pay request

fn create_incoming_payment_request<'life0, 'async_trait>( &'life0 self, options: IncomingPaymentOptions, ) -> Pin<Box<dyn Future<Output = Result<CreateIncomingPaymentResponse, Self::Err>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Create a new invoice

fn wait_payment_event<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Pin<Box<dyn Stream<Item = Event> + 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

fn check_incoming_payment_status<'life0, 'life1, 'async_trait>( &'life0 self, payment_identifier: &'life1 PaymentIdentifier, ) -> Pin<Box<dyn Future<Output = Result<Vec<WaitPaymentResponse>, Self::Err>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Check the status of an incoming payment

fn check_outgoing_payment<'life0, 'life1, 'async_trait>( &'life0 self, payment_identifier: &'life1 PaymentIdentifier, ) -> 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

fn is_payment_event_stream_active(&self) -> bool

Is the payment event stream active

fn cancel_payment_event_stream(&self)

Cancel the payment event stream