Struct GatewayLdkClient

pub struct GatewayLdkClient {
    node: Arc<Node>,
    bitcoind_rpc: DynBitcoindRpc,
    task_group: TaskGroup,
    htlc_stream_receiver_or: Option<Receiver<InterceptPaymentRequest>>,
    outbound_lightning_payment_lock_pool: LockPool<PaymentId>,
    outbound_offer_lock_pool: LockPool<LdkOfferId>,
}

Fields

node: Arc<Node>

The underlying lightning node.

bitcoind_rpc: DynBitcoindRpc

The client for querying data about the blockchain.

task_group: TaskGroup

htlc_stream_receiver_or: Option<Receiver<InterceptPaymentRequest>>

The HTLC stream, until it is taken by calling ILnRpcClient::route_htlcs.

outbound_lightning_payment_lock_pool: LockPool<PaymentId>

Lock pool used to ensure that our implementation of ILnRpcClient::pay doesn’t allow for multiple simultaneous calls with the same invoice to execute in parallel. This helps ensure that the function is idempotent.

outbound_offer_lock_pool: LockPool<LdkOfferId>

Lock pool used to ensure that our implementation of ILnRpcClient::pay_offer doesn’t allow for multiple simultaneous calls with the same offer to execute in parallel. This helps ensure that the function is idempotent.

Implementations

impl GatewayLdkClient

pub fn new( data_dir: &Path, chain_source_config: GatewayLdkChainSourceConfig, network: Network, lightning_port: u16, alias: String, mnemonic: Mnemonic, runtime: Arc<Runtime>, ) -> Result<Self>

Creates a new GatewayLdkClient instance and starts the underlying lightning node. All resources, including the lightning node, will be cleaned up when the returned GatewayLdkClient instance is dropped. There’s no need to manually stop the node.

async fn handle_next_event( node: &Node, htlc_stream_sender: &Sender<InterceptPaymentRequest>, handle: &TaskHandle, )

async fn outpoint_to_scid(&self, funding_txo: OutPoint) -> Result<u64>

Converts a transaction outpoint to a short channel ID by querying the blockchain.

Trait Implementations

impl Debug for GatewayLdkClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for GatewayLdkClient

fn drop(&mut self)

Executes the destructor for this type.

impl ILnRpcClient for GatewayLdkClient

fn info<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<GetNodeInfoResponse, LightningRpcError>> + Send + 'async_trait>>

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

Returns high-level info about the lightning node.

fn routehints<'life0, 'async_trait>( &'life0 self, _num_route_hints: usize, ) -> Pin<Box<dyn Future<Output = Result<GetRouteHintsResponse, LightningRpcError>> + Send + 'async_trait>>

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

Returns route hints to the lightning node.

fn pay<'life0, 'async_trait>( &'life0 self, invoice: Bolt11Invoice, max_delay: u64, max_fee: Amount, ) -> Pin<Box<dyn Future<Output = Result<PayInvoiceResponse, LightningRpcError>> + Send + 'async_trait>>

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

Attempts to pay an invoice using the lightning node, waiting for the payment to complete and returning the preimage.

fn route_htlcs<'a, 'life0, 'async_trait>( self: Box<Self>, _task_group: &'life0 TaskGroup, ) -> Pin<Box<dyn Future<Output = Result<(RouteHtlcStream<'a>, Arc<dyn ILnRpcClient>), LightningRpcError>> + Send + 'async_trait>>

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

Consumes the current client and returns a stream of intercepted HTLCs and a new client. complete_htlc must be called for all successfully intercepted HTLCs sent to the returned stream.

fn complete_htlc<'life0, 'async_trait>( &'life0 self, htlc: InterceptPaymentResponse, ) -> Pin<Box<dyn Future<Output = Result<(), LightningRpcError>> + Send + 'async_trait>>

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

Completes an HTLC that was intercepted by the gateway. Must be called for all successfully intercepted HTLCs sent to the stream returned by route_htlcs.

fn create_invoice<'life0, 'async_trait>( &'life0 self, create_invoice_request: CreateInvoiceRequest, ) -> Pin<Box<dyn Future<Output = Result<CreateInvoiceResponse, LightningRpcError>> + Send + 'async_trait>>

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

Requests the lightning node to create an invoice. The presence of a payment hash in the CreateInvoiceRequest determines if the invoice is intended to be an ecash payment or a direct payment to this lightning node.

fn get_ln_onchain_address<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<GetLnOnchainAddressResponse, LightningRpcError>> + Send + 'async_trait>>

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

Gets a funding address belonging to the lightning node’s on-chain wallet.

fn send_onchain<'life0, 'async_trait>( &'life0 self, __arg1: SendOnchainRequest, ) -> Pin<Box<dyn Future<Output = Result<SendOnchainResponse, LightningRpcError>> + Send + 'async_trait>>

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

Executes an onchain transaction using the lightning node’s on-chain wallet.

fn open_channel<'life0, 'async_trait>( &'life0 self, __arg1: OpenChannelRequest, ) -> Pin<Box<dyn Future<Output = Result<OpenChannelResponse, LightningRpcError>> + Send + 'async_trait>>

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

Opens a channel with a peer lightning node.

fn close_channels_with_peer<'life0, 'async_trait>( &'life0 self, __arg1: CloseChannelsWithPeerRequest, ) -> Pin<Box<dyn Future<Output = Result<CloseChannelsWithPeerResponse, LightningRpcError>> + Send + 'async_trait>>

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

Closes all channels with a peer lightning node.

fn list_active_channels<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<ListActiveChannelsResponse, LightningRpcError>> + Send + 'async_trait>>

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

Lists the lightning node’s active channels with all peers.

fn get_balances<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<GetBalancesResponse, LightningRpcError>> + Send + 'async_trait>>

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

Returns a summary of the lightning node’s balance, including the onchain wallet, outbound liquidity, and inbound liquidity.

fn get_invoice<'life0, 'async_trait>( &'life0 self, get_invoice_request: GetInvoiceRequest, ) -> Pin<Box<dyn Future<Output = Result<Option<GetInvoiceResponse>, LightningRpcError>> + Send + 'async_trait>>

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

fn list_transactions<'life0, 'async_trait>( &'life0 self, start_secs: u64, end_secs: u64, ) -> Pin<Box<dyn Future<Output = Result<ListTransactionsResponse, LightningRpcError>> + Send + 'async_trait>>

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

fn create_offer( &self, amount: Option<Amount>, description: Option<String>, expiry_secs: Option<u32>, quantity: Option<u64>, ) -> Result<String, LightningRpcError>

fn pay_offer<'life0, 'async_trait>( &'life0 self, offer: String, quantity: Option<u64>, amount: Option<Amount>, payer_note: Option<String>, ) -> Pin<Box<dyn Future<Output = Result<Preimage, LightningRpcError>> + Send + 'async_trait>>

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

fn pay_private<'life0, 'async_trait>( &'life0 self, _invoice: PrunedInvoice, _max_delay: u64, _max_fee: Amount, ) -> Pin<Box<dyn Future<Output = Result<PayInvoiceResponse, LightningRpcError>> + Send + 'async_trait>>

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

Attempts to pay an invoice using the lightning node, waiting for the payment to complete and returning the preimage.

fn supports_private_payments(&self) -> bool

Returns true if the lightning backend supports payments without full invoices. If this returns true, ILnRpcClient::pay_private must be implemented.