Struct GatewayLdkClient

pub struct GatewayLdkClient {
    node: Arc<Node>,
    esplora_client: AsyncClient,
    event_handler_task_handle: JoinHandle<()>,
    htlc_stream_receiver_or: Option<Receiver<Result<InterceptHtlcRequest, Status>>>,
}

Fields

node: Arc<Node>

The underlying lightning node.

esplora_client: AsyncClient

The client for querying data about the blockchain.

event_handler_task_handle: JoinHandle<()>

A handle to the task that processes incoming events from the lightning node. Responsible for sending incoming HTLCs to the caller of route_htlcs. TODO: This should be a shutdown sender instead, and we can discard the handle.

htlc_stream_receiver_or: Option<Receiver<Result<InterceptHtlcRequest, Status>>>

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

Implementations

impl GatewayLdkClient

pub fn new( data_dir: &Path, esplora_server_url: &str, network: Network, lightning_port: u16, mnemonic: Mnemonic, ) -> 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<Result<InterceptHtlcRequest, Status>>, )

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,

Get the public key and alias of 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,

Get 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,

Attempt to pay an invoice using the lightning node

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: InterceptHtlcResponse, ) -> Pin<Box<dyn Future<Output = Result<EmptyResponse, LightningRpcError>> + Send + 'async_trait>>

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

Complete 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,

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,

Get a funding address belonging to the gateway’s lightning node wallet.

fn withdraw_onchain<'life0, 'async_trait>( &'life0 self, address: Address, amount: BitcoinAmountOrAll, _fee_rate_sats_per_vbyte: u64, ) -> Pin<Box<dyn Future<Output = Result<WithdrawOnchainResponse, LightningRpcError>> + Send + 'async_trait>>

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

fn open_channel<'life0, 'async_trait>( &'life0 self, pubkey: PublicKey, host: String, channel_size_sats: u64, push_amount_sats: u64, ) -> Pin<Box<dyn Future<Output = Result<OpenChannelResponse, LightningRpcError>> + Send + 'async_trait>>

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

Open a channel with a peer lightning node from the gateway’s lightning node.

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

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

Close all channels with a peer lightning node from the gateway’s lightning node.

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

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

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,

fn sync_to_chain<'life0, 'async_trait>( &'life0 self, block_height: u32, ) -> Pin<Box<dyn Future<Output = Result<EmptyResponse, 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,

Attempt to pay an invoice using the lightning node using a PrunedInvoice, increasing the user’s privacy by not sending the invoice description to the gateway.

fn supports_private_payments(&self) -> bool

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