lightning 10.19.0 → 10.20.0

package/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Versions
 
+## 10.20.0
+
+- `payViaPaymentRequest`, `subscribeToPayViaRequest`: Add `index` to response
+    for payment offset number in payments set
+
 ## 10.19.0
 
 - `createInvoice`: add `is_encrypting_routes` to enable blinded paths feature

package/lnd_methods/invoices/create_invoice.d.ts

@@ -13,6 +13,8 @@ export type CreateInvoiceArgs = AuthenticatedLightningArgs<{
   description_hash?: string;
   /** Expires At ISO 8601 Date */
   expires_at?: string;
+  /** Use Blinded Paths For Inbound Routes */
+  is_encrypting_routes?: boolean;
   /** Is Fallback Address Included */
   is_fallback_included?: boolean;
   /** Is Fallback Address Nested */

package/lnd_methods/offchain/finished_payment.d.ts

@@ -27,6 +27,8 @@ export type FinishedPaymentArgs = AuthenticatedLightningArgs<{
     }[];
     /** Payment Hash Hex String */
     id: string;
+    /** Payment Index String */
+    index: string;
     /** Total Millitokens Paid String */
     mtokens: string;
     paths: {
@@ -129,6 +131,8 @@ export type FinishedPaymentResult = {
   }[];
   /** Payment Hash Hex String */
   id?: string;
+  /** Payment Index String */
+  index: string;
   /** Total Millitokens Paid String */
   mtokens: string;
   paths: {

package/lnd_methods/offchain/finished_payment.js

@@ -80,6 +80,7 @@ const {returnResult} = require('asyncjs-util');
       timeout: <Timeout Block Height Number>
     }]
     [id]: <Payment Hash Hex String>
+    index: <Payment Index Offset Number String>
     mtokens: <Total Millitokens Paid String>
     paths: [{
       fee_mtokens: <Total Fee Millitokens Paid String>
@@ -146,6 +147,7 @@ module.exports = ({confirmed, failed}, cbk) => {
           fee_mtokens: confirmed.fee_mtokens,
           hops: confirmed.hops,
           id: confirmed.id,
+          index: confirmed.index,
           mtokens: confirmed.mtokens,
           paths: confirmed.paths,
           secret: confirmed.secret,

package/lnd_methods/offchain/pay_via_payment_request.js

@@ -52,6 +52,7 @@ const type = 'router';
       timeout: <First Route Timeout Block Height Number>
     }]
     id: <Payment Hash Hex String>
+    index: <Payment Index Offset Number String>
     mtokens: <Total Millitokens Paid String>
     paths: [{
       fee_mtokens: <Total Fee Millitokens Paid String>

package/lnd_methods/offchain/subscribe_to_past_payment.d.ts

@@ -58,6 +58,8 @@ export type SubscribeToPastPaymentConfirmedEvent = {
 export type SubscribeToPastPaymentFailedEvent = {
   /** Payment Hash Hex */
   id: string;
+  /** Payment Canceled */
+  is_canceled: boolean;
   /** Failed Due To Lack of Balance */
   is_insufficient_balance: boolean;
   /** Failed Due to Payment Rejected At Destination */

package/lnd_methods/offchain/subscribe_to_pay.d.ts

@@ -140,7 +140,9 @@ export type SubscribeToPayConfirmedEvent = {
 export type SubscribeToPayFailedEvent = {
   /** Payment Hash Hex */
   id: string;
-  /** Failed Due To Lack of Balance Bool> */
+  /** Payment Canceled */
+  is_canceled: boolean;
+  /** Failed Due To Lack of Balance */
   is_insufficient_balance: boolean;
   /** Failed Due to Invalid Payment Bool> */
   is_invalid_payment: boolean;

package/lnd_methods/offchain/subscribe_to_pay_via_request.js

@@ -54,6 +54,7 @@ const type = 'router';
       timeout: <First Route Timeout Block Height Number>
     }]
     id: <Payment Hash Hex String>
+    index: <Payment Index Offset Number String>
     mtokens: <Total Millitokens Paid String>
     paths: [{
       fee_mtokens: <Total Fee Millitokens Paid String>
@@ -109,6 +110,7 @@ const type = 'router';
     created_at: <Payment Created At ISO 8601 Date String>
     destination: <Payment Destination Hex String>
     id: <Payment Hash Hex String>
+    index: <Payment Index Offset Number String>
     mtokens: <Total Millitokens Pending String>
     paths: [{
       fee: <Total Fee Tokens Pending Number>

package/lnd_methods/offchain/subscribe_to_payments.d.ts

@@ -7,10 +7,145 @@ import type {SubscribeToPastPaymentsPaymentEvent} from './subscribe_to_past_paym
 
 export type SubscribeToPaymentsArgs = AuthenticatedLightningArgs;
 
-export type SubscribeToPaymentsErrorEvent = LightningError;
+/** A confirmed payment event
+ * @event 'confirmed'
+ */
+export interface SubscribeToPaymentsConfirmedEvent {
+  /** Payment Confirmed At ISO 8601 Date String */
+  confirmed_at: string;
+  /** Payment Created At ISO 8601 Date String */
+  created_at: string;
+  /** Payment Destination Hex String */
+  destination: string;
+  /** Total Fee Tokens Paid Rounded Down Number */
+  fee: number;
+  /** Total Fee Millitokens Paid String */
+  fee_mtokens: string;
+  /** Payment Hash Hex String */
+  id: string;
+  /** Total Millitokens Paid String */
+  mtokens: string;
+  /** Payment paths */
+  paths?: Array<{
+    /** Total Fee Tokens Paid Number */
+    fee: number;
+    /** Total Fee Millitokens Paid String */
+    fee_mtokens: string;
+    /** Hops in the path */
+    hops: Array<{
+      /** Standard Format Channel Id String */
+      channel: string;
+      /** Channel Capacity Tokens Number */
+      channel_capacity: number;
+      /** Fee Tokens Rounded Down Number */
+      fee: number;
+      /** Fee Millitokens String */
+      fee_mtokens: string;
+      /** Forward Tokens Number */
+      forward: number;
+      /** Forward Millitokens String */
+      forward_mtokens: string;
+      /** Public Key Hex String */
+      public_key: string;
+      /** Timeout Block Height Number */
+      timeout: number;
+    }>;
+    /** Total Millitokens Paid String */
+    mtokens: string;
+    /** Total Fee Tokens Paid Rounded Up Number */
+    safe_fee: number;
+    /** Total Tokens Paid, Rounded Up Number */
+    safe_tokens: number;
+    /** Expiration Block Height Number */
+    timeout: number;
+  }>;
+  /** BOLT 11 Encoded Payment Request String */
+  request?: string;
+  /** Total Fee Tokens Paid Rounded Up Number */
+  safe_fee: number;
+  /** Total Tokens Paid, Rounded Up Number */
+  safe_tokens: number;
+  /** Payment Preimage Hex String */
+  secret: string;
+  /** Expiration Block Height Number */
+  timeout: number;
+  /** Total Tokens Paid Rounded Down Number */
+  tokens: number;
+}
+
+/** A failed payment event
+ * @event 'failed'
+ */
+export interface SubscribeToPaymentsFailedEvent {
+  /** Payment Hash Hex String */
+  id: string;
+  /** Payment Canceled Bool */
+  is_canceled: boolean;
+  /** Failed Due To Lack of Balance Bool */
+  is_insufficient_balance: boolean;
+  /** Failed Due to Payment Rejected At Destination Bool */
+  is_invalid_payment: boolean;
+  /** Failed Due to Pathfinding Timeout Bool */
+  is_pathfinding_timeout: boolean;
+  /** Failed Due to Absence of Path Through Graph Bool */
+  is_route_not_found: boolean;
+}
 
-export type SubscribeToPaymentsPaymentEvent =
-  SubscribeToPastPaymentsPaymentEvent;
+/** A paying (in-progress) payment event
+ * @event 'paying'
+ */
+export interface SubscribeToPaymentsPayingEvent {
+  /** Payment Created At ISO 8601 Date String */
+  created_at: string;
+  /** Payment Destination Hex String */
+  destination: string;
+  /** Payment Hash Hex String */
+  id: string;
+  /** Total Millitokens Pending String */
+  mtokens: string;
+  /** Payment paths */
+  paths?: Array<{
+    /** Total Fee Tokens Pending Number */
+    fee: number;
+    /** Total Fee Millitokens Pending String */
+    fee_mtokens: string;
+    /** Hops in the path */
+    hops: Array<{
+      /** Standard Format Channel Id String */
+      channel: string;
+      /** Channel Capacity Tokens Number */
+      channel_capacity: number;
+      /** Fee Tokens Rounded Down Number */
+      fee: number;
+      /** Fee Millitokens String */
+      fee_mtokens: string;
+      /** Forward Tokens Number */
+      forward: number;
+      /** Forward Millitokens String */
+      forward_mtokens: string;
+      /** Public Key Hex String */
+      public_key: string;
+      /** Timeout Block Height Number */
+      timeout: number;
+    }>;
+    /** Total Millitokens Pending String */
+    mtokens: string;
+    /** Total Fee Tokens Pending Rounded Up Number */
+    safe_fee: number;
+    /** Total Tokens Pending, Rounded Up Number */
+    safe_tokens: number;
+    /** Expiration Block Height Number */
+    timeout: number;
+  }>;
+  /** BOLT 11 Encoded Payment Request String */
+  request?: string;
+  /** Total Tokens Pending, Rounded Up Number */
+  safe_tokens: number;
+  /** Expiration Block Height Number */
+  timeout?: number;
+  /** Total Tokens Pending Rounded Down Number */
+  tokens: number;
+}
 
 /**
  * Subscribe to outgoing payments

package/lnd_responses/confirmed_from_payment.d.ts

@@ -105,6 +105,8 @@ export type ConfirmedFromPaymentResult = {
   }[];
   /** Payment Hash Hex String */
   id: string;
+  /** Payment Index String */
+  index: string;
   /** Total Millitokens Paid String */
   mtokens: string;
   paths: {

package/lnd_responses/confirmed_from_payment.js

@@ -81,6 +81,7 @@ const nsAsDate = ns => new Date(Number(BigInt(ns) / BigInt(1e6)));
       timeout: <First Path Timeout Block Height Number>
     }]
     id: <Payment Hash Hex String>
+    index: <Payment Index Offset Number String>
     mtokens: <Total Millitokens Paid String>
     paths: [{
       fee: <Total Fee Tokens Paid Number>
@@ -159,6 +160,7 @@ module.exports = payment => {
     fee_mtokens: payment.fee_msat,
     hops: success.route.hops,
     id: payment.payment_hash,
+    index: payment.payment_index,
     mtokens: mtokens.toString(),
     paths: successes.map(n => n.route),
     request: payment.payment_request || undefined,

package/lnd_responses/pending_from_payment.js

@@ -67,6 +67,7 @@ const nsAsDate = ns => new Date(Number(BigInt(ns) / BigInt(1e6)));
     created_at: <Payment Created At ISO 8601 Date String>
     destination: <Payment Destination Public Key Hex String>
     id: <Payment Hash Hex String>
+    index: <Payment Index Offset Number String>
     mtokens: <Total Millitokens Pending String>
     paths: [{
       fee: <Total Fee Tokens Pending Number>
@@ -134,6 +135,7 @@ module.exports = payment => {
     destination,
     created_at: nsAsDate(payment.creation_time_ns).toISOString(),
     id: payment.payment_hash,
+    index: payment.payment_index,
     mtokens: mtokens.toString(),
     paths: pending.map(n => n.route),
     request: payment.payment_request || undefined,

package/package.json

@@ -9,7 +9,7 @@
   "dependencies": {
     "@grpc/grpc-js": "1.11.1",
     "@grpc/proto-loader": "0.7.13",
-    "@types/node": "22.5.0",
+    "@types/node": "22.5.4",
     "@types/request": "2.48.12",
     "@types/ws": "8.5.12",
     "async": "3.2.6",
@@ -22,11 +22,11 @@
     "invoices": "3.0.0",
     "psbt": "3.0.0",
     "tiny-secp256k1": "2.2.3",
-    "type-fest": "4.25.0"
+    "type-fest": "4.26.0"
   },
   "description": "Lightning Network client library",
   "devDependencies": {
-    "tsd": "0.31.1",
+    "tsd": "0.31.2",
     "typescript": "5.5.4"
   },
   "engines": {
@@ -53,5 +53,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "10.19.0"
+  "version": "10.20.0"
 }

package/test/lnd_methods/offchain/test_finished_payment.js

@@ -20,6 +20,7 @@ const makeArgs = overrides => {
         timeout: 1,
       }],
       id: Buffer.alloc(32).toString('hex'),
+      index: '1',
       mtokens: '1000',
       paths: [{
         fee_mtokens: '1000',
@@ -107,6 +108,7 @@ const tests = [
         timeout: 1,
       }],
       id: '0000000000000000000000000000000000000000000000000000000000000000',
+      index: '1',
       mtokens: '1000',
       paths: [{
         fee_mtokens: '1000',

package/test/lnd_methods/offchain/test_get_payment.js

@@ -194,6 +194,7 @@ const tests = [
           created_at: '1970-01-01T00:00:00.000Z',
           destination: Buffer.alloc(33).toString('hex'),
           id: Buffer.alloc(32).toString('hex'),
+          index: '1',
           mtokens: '2000',
           paths: [{
             fee: 1,

package/test/lnd_methods/offchain/test_subscribe_to_past_payments.js

@@ -222,6 +222,7 @@ const tests = [
         }
       ],
       id: '0000000000000000000000000000000000000000000000000000000000000000',
+      index: '1',
       mtokens: '2000',
       paths: [
         {

package/test/lnd_methods/offchain/test_subscribe_to_payments.js

@@ -111,6 +111,7 @@ const tests = [
           timeout: 1,
         }],
         id: Buffer.alloc(32).toString('hex'),
+        index: '1',
         mtokens: '2000',
         paths: [{
           fee: 1,

package/test/lnd_responses/test_confirmed_from_payment.js

@@ -71,6 +71,7 @@ const makeExpected = overrides => {
       timeout: 1,
     }],
     id: Buffer.alloc(32).toString('hex'),
+    index: '1',
     mtokens: '2000',
     paths: [{
       fee: 1,

package/test/lnd_responses/test_pending_from_payment.js

@@ -58,6 +58,7 @@ const makeExpected = overrides => {
     created_at: '1970-01-01T00:00:00.000Z',
     destination: Buffer.alloc(33).toString('hex'),
     id: Buffer.alloc(32).toString('hex'),
+    index: '1',
     mtokens: '2000',
     paths: [{
       fee: 1,

package/test/typescript/finished_payment.test-d.ts

@@ -22,6 +22,7 @@ const args = {
       },
     ],
     id: Buffer.alloc(32).toString('hex'),
+    index: '1',
     mtokens: '1000',
     paths: [
       {