fix: gateway selection (#13)

fedimint · Sep 12, 2024 · ad4cf7b · ad4cf7b
1 parent be1582e
commit ad4cf7b
Show file tree

Hide file tree

Showing 4 changed files with 56 additions and 5 deletions.
diff --git a/.changeset/itchy-suits-leave.md b/.changeset/itchy-suits-leave.md
@@ -0,0 +1,5 @@
+---
+'@fedimint/core-web': patch
+---
+
+Fix Lightning Gateway selection
diff --git a/packages/core-web/README.md b/packages/core-web/README.md
@@ -52,7 +52,7 @@ const unsubscribe = wallet.subscribeBalance((balance: number) => {
 await wallet.reissueNotes('A11qgqpw9thwvaz7t...')
 
 // Pay Lightning Invoice
-await wallet.payInvoice('lnbc...')
+await wallet.payBolt11Invoice('lnbc...')
 ```
 
 ## Check out the example

diff --git a/packages/core-web/src/FedimintWallet.ts b/packages/core-web/src/FedimintWallet.ts
@@ -10,6 +10,7 @@ import {
   StreamError,
   CreateBolt11Response,
   ModuleKind,
+  GatewayInfo,
 } from './types/wallet.js'
 
 const DEFAULT_CLIENT_NAME = 'fm-default' as const
@@ -291,13 +292,30 @@ export class FedimintWallet {
 
   // Lightning Network module methods
 
+  async createBolt11InvoiceWithGateway(
+    amount: number,
+    description: string,
+    expiryTime: number | null = null,
+    extraMeta: JSONObject = {},
+    gatewayInfo: GatewayInfo,
+  ) {
+    return await this._rpcSingle('ln', 'create_bolt11_invoice', {
+      amount,
+      description,
+      expiry_time: expiryTime,
+      extra_meta: extraMeta,
+      gateway: gatewayInfo,
+    })
+  }
+
   async createBolt11Invoice(
     amount: number,
     description: string,
     expiryTime: number | null = null,
     extraMeta: JSONObject = {},
-    gateway: LightningGateway | null = null,
   ): Promise<CreateBolt11Response> {
+    await this.updateGatewayCache()
+    const gateway = await this._getDefaultGatewayInfo()
     return await this._rpcSingle('ln', 'create_bolt11_invoice', {
       amount,
       description,
@@ -307,13 +325,31 @@ export class FedimintWallet {
     })
   }
 
+  async payBolt11InvoiceWithGateway(
+    invoice: string,
+    gatewayInfo: GatewayInfo,
+    extraMeta: JSONObject = {},
+  ) {
+    return await this._rpcSingle('ln', 'pay_bolt11_invoice', {
+      maybe_gateway: gatewayInfo,
+      invoice,
+      extra_meta: extraMeta,
+    })
+  }
+
+  async _getDefaultGatewayInfo(): Promise<LightningGateway> {
+    const gateways = await this.listGateways()
+    return gateways[0]
+  }
+
   async payBolt11Invoice(
     invoice: string,
-    maybeGateway: LightningGateway | null = null,
     extraMeta: JSONObject = {},
   ): Promise<OutgoingLightningPayment> {
+    await this.updateGatewayCache()
+    const gateway = await this._getDefaultGatewayInfo()
     return await this._rpcSingle('ln', 'pay_bolt11_invoice', {
-      maybe_gateway: maybeGateway,
+      maybe_gateway: gateway.info,
       invoice,
       extra_meta: extraMeta,
     })
@@ -376,6 +412,7 @@ export class FedimintWallet {
   }
 
   async updateGatewayCache(): Promise<void> {
+    console.trace('Updating gateway cache')
     await this._rpcSingle('ln', 'update_gateway_cache', {})
   }
 }
diff --git a/packages/core-web/src/types/wallet.ts b/packages/core-web/src/types/wallet.ts
@@ -10,14 +10,22 @@ type JSONValue =
 
 type JSONObject = Record<string, JSONValue>
 
-type LightningGateway = {
+type GatewayInfo = {
   gateway_id: string
   api: string
   node_pub_key: string
   federation_index: number
   route_hints: RouteHint[]
   fees: FeeToAmount
 }
+type LightningGateway = {
+  info: GatewayInfo
+  vetted: boolean
+  ttl: {
+    nanos: number
+    secs: number
+  }
+}
 
 type RouteHint = {
   // TODO: Define the structure of RouteHint
@@ -84,6 +92,7 @@ export {
   LnPayState,
   LnReceiveState,
   CreateBolt11Response,
+  GatewayInfo,
   StreamError,
   StreamSuccess,
   StreamResult,