lightning 9.11.0 → 9.11.2

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Versions
 
-## 9.11.0
+## 9.11.2
 
 - `openChannel`: Add `inputs` to select inputs for channel open funding
 

package/lnd_methods/invoices/create_hodl_invoice.d.ts

@@ -1,6 +1,7 @@
 import {
   AuthenticatedLightningArgs,
   AuthenticatedLightningMethod,
+  Routes,
 } from '../../typescript';
 
 export type CreateHodlInvoiceArgs = AuthenticatedLightningArgs<{
@@ -22,6 +23,7 @@ export type CreateHodlInvoiceArgs = AuthenticatedLightningArgs<{
   is_including_private_channels?: boolean;
   /** Millitokens */
   mtokens?: string;
+  routes?: Routes;
   /** Tokens */
   tokens?: number;
 }>;

package/lnd_methods/invoices/create_invoice.d.ts

@@ -1,6 +1,7 @@
 import {
   AuthenticatedLightningArgs,
   AuthenticatedLightningMethod,
+  Routes,
 } from '../../typescript';
 
 export type CreateInvoiceArgs = AuthenticatedLightningArgs<{
@@ -22,6 +23,7 @@ export type CreateInvoiceArgs = AuthenticatedLightningArgs<{
   secret?: string;
   /** Millitokens */
   mtokens?: string;
+  routes?: Routes;
   /** Tokens */
   tokens?: number;
 }>;

package/lnd_methods/offchain/decode_payment_request.d.ts

@@ -1,6 +1,7 @@
 import type {
   AuthenticatedLightningArgs,
   AuthenticatedLightningMethod,
+  Routes,
 } from '../../typescript';
 
 export type DecodePaymentRequestArgs = AuthenticatedLightningArgs<{
@@ -8,21 +9,6 @@ export type DecodePaymentRequestArgs = AuthenticatedLightningArgs<{
   request: string;
 }>;
 
-export type DecodePaymentRouteEdge = {
-  /** Base Routing Fee In Millitokens */
-  base_fee_mtokens?: string;
-  /** Standard Format Channel Id */
-  channel?: string;
-  /** CLTV Blocks Delta */
-  cltv_delta?: number;
-  /** Fees Charged in Millitokens Per Million */
-  fee_rate?: number;
-  /** Forward Edge Public Key Hex */
-  public_key: string;
-};
-
-export type DecodePaymentRoutes = DecodePaymentRouteEdge[][];
-
 export type DecodePaymentRequestResult = {
   /** Fallback Chain Address */
   chain_address: string;
@@ -52,7 +38,7 @@ export type DecodePaymentRequestResult = {
   mtokens: string;
   /** Payment Identifier Hex Encoded */
   payment?: string;
-  routes: DecodePaymentRoutes;
+  routes: Routes;
   /** Requested Tokens Rounded Up */
   safe_tokens: number;
   /** Requested Tokens Rounded Down */

package/lnd_methods/offchain/probe_for_route.d.ts

@@ -2,15 +2,15 @@ import type {MergeExclusive} from 'type-fest';
 import type {
   AuthenticatedLightningArgs,
   AuthenticatedLightningMethod,
+  RouteNode,
 } from '../../typescript';
-import type {DecodePaymentRouteEdge} from './decode_payment_request';
 
-export type ProbeForRouteRouteEdge = DecodePaymentRouteEdge & {
+export type ProbeForRouteNode = RouteNode & {
   /** Channel Capacity Tokens Number */
   channel_capacity?: number;
 };
 
-export type ProbeForRouteRoutes = ProbeForRouteRouteEdge[][];
+export type ProbeForRouteRoutes = ProbeForRouteNode[][];
 
 export type ProbeForRouteArgs = AuthenticatedLightningArgs<
   {

package/lnd_methods/offchain/subscribe_to_probe_for_route.js

@@ -201,6 +201,7 @@ module.exports = args => {
 
   const emitter = new EventEmitter();
   const ignore = [];
+  let isErrored = false;
   let isFinal = false;
   let isTimedOut = false;
   const temporaryChannelFailures = [];
@@ -213,10 +214,13 @@ module.exports = args => {
   }
 
   const emitError = err => {
-    if (!emitter.listenerCount('error')) {
+    if (isErrored || !emitter.listenerCount('error')) {
       return;
     }
 
+    // Safeguard against returning multiple errors
+    isErrored = true;
+
     return emitter.emit('error', err);
   };
 

package/lnd_methods/onchain/open_channel.d.ts

@@ -3,6 +3,13 @@ import {
   AuthenticatedLightningMethod,
 } from '../../typescript';
 
+export type ChannelOpenOptionsInput = {
+  /** Fund With Unspent Transaction Id Hex String */
+  transaction_id: string
+  /** Fund With Unspent Transaction Output Index Number */
+  transaction_vout: number
+}
+
 export type ChannelOpenOptions = {
   /** Routing Base Fee Millitokens Charged String */
   base_fee_mtokens?: string;
@@ -16,6 +23,9 @@ export type ChannelOpenOptions = {
   fee_rate?: number;
   /** Tokens to Gift To Partner */
   give_tokens?: number;
+  inputs?: ChannelOpenOptionsInput[]
+  /** Use Maximal Chain Funds For Local Funding Bool */
+  is_max_funding?: boolean;
   /** Channel is Private */
   is_private?: boolean;
   /** Peer Should Avoid Waiting For Confirmation */
@@ -26,10 +36,10 @@ export type ChannelOpenOptions = {
   min_confirmations?: number;
   /** Minimum HTLC Millitokens */
   min_htlc_mtokens?: string;
-  /** Public Key Hex */
-  partner_public_key: string;
   /** Peer Output CSV Delay */
   partner_csv_delay?: number;
+  /** Public Key Hex */
+  partner_public_key: string;
   /** Peer Connection Host:Port */
   partner_socket?: string;
 };
@@ -54,8 +64,18 @@ export type OpenChannelResult = {
  *
  * External funding requires LND compiled with `walletrpc` build tag
  *
+ * `is_trusted_funding` is not supported on LND 0.15.0 and below and requires
+ * `--protocol.option-scid-alias` and `--protocol.zero-conf` set on both sides
+ * as well as a channel open request listener to accept the trusted funding.
+ * 
  * `base_fee_mtokens` is not supported on LND 0.15.5 and below
  * `fee_rate` is not supported on LND 0.15.5 and below
+ * 
+ * `is_max_funding` is not supported on LND 0.16.4 and below
+ * 
+ * `description` is not supported on LND 0.16.4 and below
+ * 
+ * `inputs` is not supported on LND 0.16.4 and below
  */
 export const openChannel: AuthenticatedLightningMethod<
   OpenChannelArgs,

package/package.json

@@ -10,7 +10,7 @@
     "@grpc/grpc-js": "1.9.0",
     "@grpc/proto-loader": "0.7.8",
     "@types/express": "4.17.17",
-    "@types/node": "20.4.6",
+    "@types/node": "20.5.0",
     "@types/request": "2.48.8",
     "@types/ws": "8.5.5",
     "async": "3.2.4",
@@ -26,7 +26,7 @@
     "invoices": "3.0.0",
     "psbt": "3.0.0",
     "tiny-secp256k1": "2.2.3",
-    "type-fest": "4.1.0"
+    "type-fest": "4.2.0"
   },
   "description": "Lightning Network client library",
   "devDependencies": {
@@ -59,5 +59,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "9.11.0"
+  "version": "9.11.2"
 }

package/test/lnd_responses/test_channel_accept_as_open_request.js

@@ -68,6 +68,11 @@ const tests = [
     description: 'Open request missing channel reserve',
     error: 'ExpectedChannelReserveForChannelRequest',
   },
+  {
+    args: makeArgs({commitment_type: undefined}),
+    description: 'Open request missing commitment type',
+    error: 'ExpectedCommitmentTypeForChannelRequest',
+  },
   {
     args: makeArgs({csv_delay: undefined}),
     description: 'Open request missing csv delay',

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

@@ -1,6 +1,7 @@
 import {expectError, expectType} from 'tsd';
 import {AuthenticatedLnd} from '../../lnd_grpc';
 import {createHodlInvoice, CreateHodlInvoiceResult} from '../../lnd_methods';
+import {Routes} from '../../typescript';
 
 const lnd = {} as AuthenticatedLnd;
 const cltv_delta = 1;
@@ -12,6 +13,13 @@ const is_fallback_nested = true;
 const is_including_private_channels = true;
 const mtokens = '1000';
 const tokens = 1;
+const routes: Routes = [[{
+  base_fee_mtokens: '1',
+  channel: '0',
+  cltv_delta: 1,
+  fee_rate: 1,
+  public_key: 'pubkey'
+}]];
 
 expectError(createHodlInvoice());
 expectError(createHodlInvoice({}));
@@ -29,13 +37,13 @@ expectType<CreateHodlInvoiceResult>(
     is_including_private_channels,
     mtokens,
     tokens,
-  })
+ })
 );
 
 expectType<void>(
   createHodlInvoice({lnd}, (error, result) => {
     expectType<CreateHodlInvoiceResult>(result);
-  })
+ })
 );
 expectType<void>(
   createHodlInvoice(
@@ -49,10 +57,11 @@ expectType<void>(
       is_fallback_nested,
       is_including_private_channels,
       mtokens,
+      routes,
       tokens,
-    },
+   },
     (error, result) => {
       expectType<CreateHodlInvoiceResult>(result);
-    }
+   }
   )
 );

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

@@ -1,6 +1,7 @@
 import {expectError, expectType} from 'tsd';
 import {AuthenticatedLnd} from '../../lnd_grpc';
 import {createInvoice, CreateInvoiceResult} from '../../lnd_methods';
+import {Routes} from '../../typescript';
 
 const lnd = {} as AuthenticatedLnd;
 const cltv_delta = 1;
@@ -12,6 +13,13 @@ const is_including_private_channels = true;
 const secret = Buffer.alloc(32).toString('hex');
 const mtokens = '1000';
 const tokens = 1;
+const routes: Routes = [[{
+  base_fee_mtokens: '1',
+  channel: '0',
+  cltv_delta: 1,
+  fee_rate: 1,
+  public_key: 'pubkey'
+}]];
 
 expectError(createInvoice());
 expectError(createInvoice({}));
@@ -29,13 +37,13 @@ expectType<CreateInvoiceResult>(
     secret,
     mtokens,
     tokens,
-  })
+ })
 );
 
 expectType<void>(
   createInvoice({lnd}, (error, result) => {
     expectType<CreateInvoiceResult>(result);
-  })
+ })
 );
 expectType<void>(
   createInvoice(
@@ -49,10 +57,11 @@ expectType<void>(
       is_including_private_channels,
       secret,
       mtokens,
+      routes,
       tokens,
-    },
+   },
     (error, result) => {
       expectType<CreateInvoiceResult>(result);
-    }
+   }
   )
 );

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

@@ -10,6 +10,9 @@ const chain_fee_tokens_per_vbyte = 1;
 const cooperative_close_address = 'close_address';
 const give_tokens = 1;
 
+const is_max_funding = true;
+const inputs = [{transaction_id: 'id', transaction_vout: 0}];
+
 expectError(openChannel());
 expectError(openChannel({}));
 expectError(openChannel({local_tokens}));
@@ -29,6 +32,8 @@ expectType<OpenChannelResult>(
     chain_fee_tokens_per_vbyte,
     cooperative_close_address,
     give_tokens,
+    is_max_funding,
+    inputs,
   })
 );
 
@@ -46,6 +51,8 @@ expectType<void>(
       chain_fee_tokens_per_vbyte,
       cooperative_close_address,
       give_tokens,
+      is_max_funding,
+      inputs,
     },
     (error, result) => {
       expectType<OpenChannelResult>(result);

package/typescript/shared.d.ts

@@ -101,3 +101,20 @@ export type DateRangeFilterArgs = {
   /** Creation Date Before or Equal to ISO 8601 Date String */
   created_before?: string;
 };
+
+export type RouteNode = {
+  /** Base Routing Fee In Millitokens */
+  base_fee_mtokens?: string;
+  /** Standard Format Channel Id */
+  channel?: string;
+  /** CLTV Blocks Delta */
+  cltv_delta?: number;
+  /** Fees Charged in Millitokens Per Million */
+  fee_rate?: number;
+  /** Forward Edge Public Key Hex */
+  public_key: string;
+}
+
+export type Route = RouteNode[]
+
+export type Routes = Route[]