Struct CdkLdkNode 

pub struct CdkLdkNode { /* private fields */ }

CDK Lightning backend using LDK Node

Provides Lightning Network functionality for CDK with support for Cashu operations. Handles payment creation, processing, and event management using the Lightning Development Kit.

Implementations

impl CdkLdkNode

pub fn new( network: Network, chain_source: ChainSource, gossip_source: GossipSource, storage_dir_path: String, fee_reserve: FeeReserve, listening_address: Vec<SocketAddress>, runtime: Option<Arc<Runtime>>, ) -> Result<Self, Error>

Create a new CDK LDK Node instance

Arguments

• network - Bitcoin network (mainnet, testnet, regtest, signet)
• chain_source - Source of blockchain data (Esplora or Bitcoin RPC)
• gossip_source - Source of Lightning network gossip data
• storage_dir_path - Directory path for node data storage
• fee_reserve - Fee reserve configuration for payments
• listening_address - Socket addresses for peer connections
• runtime - Optional Tokio runtime to use for starting the node

Returns

A new CdkLdkNode instance ready to be started

Errors

Returns an error if the LDK node builder fails to create the node

pub fn set_web_addr(&mut self, addr: Option<SocketAddr>)

Set the web server address for the LDK node management interface

Arguments

• addr - Socket address for the web server. If None, no web server will be started.

pub fn default_web_addr() -> SocketAddr

Get a default web server address using an unused port

Returns a SocketAddr with localhost and port 0, which will cause the system to automatically assign an available port

pub fn start_ldk_node(&self) -> Result<(), Error>

Start the CDK LDK Node

Starts the underlying LDK node and begins event processing. Sets up event handlers to listen for Lightning events like payment received.

Returns

Returns Ok(()) on successful start, error otherwise

Errors

Returns an error if the LDK node fails to start or event handling setup fails

pub fn start_web_server(&self, web_addr: SocketAddr) -> Result<(), Error>

Start the web server for the LDK node management interface

Starts a web server that provides a user interface for managing the LDK node. The web interface allows users to view balances, manage channels, create invoices, and send payments.

Arguments

• web_addr - The socket address to bind the web server to

Returns

Returns Ok(()) on successful start, error otherwise

Errors

Returns an error if the web server fails to start

pub fn stop_ldk_node(&self) -> Result<(), Error>

Stop the CDK LDK Node

Gracefully stops the node by cancelling all active tasks and event handlers. This includes:

• Cancelling the event handler task
• Cancelling any active wait_invoice streams
• Stopping the underlying LDK node

Returns

Returns Ok(()) on successful shutdown, error otherwise

Errors

Returns an error if the underlying LDK node fails to stop

pub fn handle_events(&self) -> Result<(), Error>

Set up event handling for the node

pub fn node(&self) -> Arc<Node>

Get Node used

Trait Implementations

impl Clone for CdkLdkNode

fn clone(&self) -> CdkLdkNode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Drop for CdkLdkNode

fn drop(&mut self)

Executes the destructor for this type.

impl MintPayment for CdkLdkNode

Mint payment trait

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 Starts the LDK node and begins event processing

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 Gracefully stops the LDK node and cancels all background tasks

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

fn create_incoming_payment_request<'life0, 'life1, 'async_trait>( &'life0 self, unit: &'life1 CurrencyUnit, options: IncomingPaymentOptions, ) -> 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

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 wait_any_incoming_payment<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Pin<Box<dyn Stream<Item = WaitPaymentResponse> + 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 is_wait_invoice_active(&self) -> bool

Is wait invoice active

fn cancel_wait_invoice(&self)

Cancel wait invoice

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, request_lookup_id: &'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

type Err = Error

Mint Lightning Error