Struct GatewayLndClient

pub struct GatewayLndClient {
    address: String,
    tls_cert: String,
    macaroon: String,
    lnd_sender: Option<Sender<ForwardHtlcInterceptResponse>>,
    gateway_db: Database,
    payment_hashes: Arc<RwLock<BTreeSet<Vec<u8>>>>,
}

Fields

address: String

LND client

tls_cert: String

macaroon: String

lnd_sender: Option<Sender<ForwardHtlcInterceptResponse>>

gateway_db: Database

payment_hashes: Arc<RwLock<BTreeSet<Vec<u8>>>>

Implementations

impl GatewayLndClient

pub fn new( address: String, tls_cert: String, macaroon: String, lnd_sender: Option<Sender<ForwardHtlcInterceptResponse>>, gateway_db: Database, ) -> Self

async fn connect(&self) -> Result<LndClient, LightningRpcError>

async fn spawn_lnv2_hold_invoice_subscription( &self, task_group: &TaskGroup, gateway_sender: Sender<InterceptPaymentRequest>, payment_hash: Vec<u8>, ) -> Result<(), LightningRpcError>

Spawns a new background task that subscribes to updates of a specific HOLD invoice. When the HOLD invoice is ACCEPTED, we can request the preimage from the Gateway. A new task is necessary because LND’s global subscribe_invoices does not currently emit updates for HOLD invoices: https://github.com/lightningnetwork/lnd/issues/3120

async fn spawn_lnv2_invoice_subscription( &self, task_group: &TaskGroup, gateway_sender: Sender<InterceptPaymentRequest>, ) -> Result<(), LightningRpcError>

Spawns a new background task that subscribes to “add” updates for all invoices. This is used to detect when a new invoice has been created. If this invoice is a HOLD invoice, it is potentially destined for a federation. At this point, we spawn a separate task to monitor the status of the HOLD invoice.

async fn spawn_lnv1_htlc_interceptor( &self, task_group: &TaskGroup, lnd_sender: Sender<ForwardHtlcInterceptResponse>, lnd_rx: Receiver<ForwardHtlcInterceptResponse>, gateway_sender: Sender<InterceptPaymentRequest>, ) -> Result<(), LightningRpcError>

Spawns a new background task that intercepts HTLCs from the LND node. In the LNv1 protocol, this is used as a trigger mechanism for requesting the Gateway to retrieve the preimage for a payment.

async fn spawn_interceptor( &self, task_group: &TaskGroup, lnd_sender: Sender<ForwardHtlcInterceptResponse>, lnd_rx: Receiver<ForwardHtlcInterceptResponse>, gateway_sender: Sender<InterceptPaymentRequest>, ) -> Result<(), LightningRpcError>

Spawns background tasks for monitoring the status of incoming payments.

async fn cancel_htlc( key: CircuitKey, lnd_sender: Sender<ForwardHtlcInterceptResponse>, ) -> Result<(), LightningRpcError>

async fn send_lnd_response( lnd_sender: Sender<ForwardHtlcInterceptResponse>, response: ForwardHtlcInterceptResponse, ) -> Result<(), LightningRpcError>

async fn lookup_payment( &self, payment_hash: Vec<u8>, client: &mut LndClient, ) -> Result<Option<String>, LightningRpcError>

async fn settle_hold_invoice( &self, payment_hash: Vec<u8>, preimage: Preimage, ) -> Result<(), LightningRpcError>

Settles a HOLD invoice that is specified by the payment_hash with the given preimage. If there is no invoice corresponding to the payment_hash, this function will return an error.

async fn cancel_hold_invoice( &self, payment_hash: Vec<u8>, ) -> Result<(), LightningRpcError>

Cancels a HOLD invoice that is specified by the payment_hash. If there is no invoice corresponding to the payment_hash, this function will return an error.

Trait Implementations

impl Clone for GatewayLndClient

fn clone(&self) -> GatewayLndClient

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GatewayLndClient

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

Formats the value using the given formatter.

impl ILnRpcClient for GatewayLndClient

fn supports_private_payments(&self) -> bool

Returns true if the lightning backend supports payments without full invoices

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_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 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: SendOnchainPayload, ) -> 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: OpenChannelPayload, ) -> 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: CloseChannelsWithPeerPayload, ) -> 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<Vec<ChannelInfo>, 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 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.