lightning 5.8.1 → 5.8.4

package/CHANGELOG.md

@@ -1,6 +1,14 @@
 # Versions
 
-## 5.8.1
+## 5.8.4
+
+- `getWalletInfo`, `payViaPaymentDetails`: Correct typescript fields
+
+## 5.8.3
+
+- `getInvoice`: Add typescript timeout field on individual payment HTLCs
+
+## 5.8.2
 
 - `getMasterPublicKeys`: Add method to lookup wallet extended public keys
 

package/README.md

@@ -6,6 +6,8 @@ Methods for working with the Lightning Network
 
 ## Selected Projects using Lightning
 
+- [bitpay.com crypto-rpc](https://bitpay.com/) -
+    https://github.com/bitpay/crypto-rpc
 - [coinos.io](https://coinos.io/) - https://github.com/coinos/coinos-server
 - [Lightning Shell](https://lightningshell.app/) -
     https://github.com/ibz/lightning-shell
@@ -27,6 +29,8 @@ Methods for working with the Lightning Network
 - [rekr](https://rekr.app/) - https://github.com/ryan-lingle/rekr
 - [Suredbits API](https://suredbits.com/) -
     https://github.com/Suredbits/sb-api-lnd
+- [Synonym demo server](https://synonym.to) -
+    https://github.com/synonymdev/slash-pay-demo-server
 
 ## LND Authentication
 

package/lnd_methods/info/get_wallet_info.d.ts

@@ -34,6 +34,8 @@ export type GetWalletInfoResult = {
   pending_channels_count: number;
   /** Public Key */
   public_key: string;
+  /** Version String */
+  version: string;
 };
 
 /**

package/lnd_methods/invoices/get_invoice.d.ts

@@ -76,6 +76,8 @@ export type GetInvoiceResult = {
     mtokens: string;
     /** Pending Payment Channel HTLC Index */
     pending_index?: number;
+    /** HTLC CLTV Timeout Height Number */
+    timeout: number;
     /** Payment Tokens */
     tokens: number;
   }[];

package/lnd_methods/offchain/pay_via_payment_details.d.ts

@@ -42,7 +42,7 @@ export type PayViaPaymentDetailsArgs = AuthenticatedLightningArgs<{
   pathfinding_timeout?: number;
   /** Payment Identifier Hex String */
   payment?: string;
-  routes: {
+  routes?: {
     /** Base Routing Fee In Millitokens */
     base_fee_mtokens?: string;
     /** Standard Format Channel Id */

package/lnd_methods/offchain/pay_via_payment_details.js

@@ -42,7 +42,7 @@ const type = 'router';
     [outgoing_channels]: [<Pay Out of Outgoing Channel Ids String>]
     [pathfinding_timeout]: <Time to Spend Finding a Route Milliseconds Number>
     [payment]: <Payment Identifier Hex String>
-    routes: [[{
+    [routes]: [[{
       [base_fee_mtokens]: <Base Routing Fee In Millitokens String>
       [channel]: <Standard Format Channel Id String>
       [cltv_delta]: <CLTV Blocks Delta Number>

package/lnd_methods/offchain/subscribe_to_past_payments.d.ts

@@ -67,6 +67,8 @@ export type SubscribeToPastPaymentsPaymentEvent = {
 /**
  * Subscribe to successful outgoing payments
  *
+ * Payments may be omitted if LND does not finalize the payment record
+ *
  * Requires `offchain:read` permission
  *
  * Note: Method not supported on LND 0.13.4 and below

package/lnd_methods/offchain/subscribe_to_past_payments.js

@@ -21,6 +21,8 @@ const unknownFailureMessage = '2 UNKNOWN: unknown failure detail type: <nil>';
 
 /** Subscribe to successful outgoing payments
 
+  Payments may be omitted if LND does not finalize the payment record
+
   Requires `offchain:read` permission
 
   Note: Method not supported on LND 0.13.4 and below

package/lnd_methods/onchain/subscribe_to_chain_address.js

@@ -113,7 +113,7 @@ module.exports = args => {
       return;
     }
 
-    eventEmitter.emit('error', new Error('UnexpectedErrInTxSubscription'));
+    eventEmitter.emit('error', err);
 
     return;
   });

package/lnd_methods/peers/subscribe_to_peers.js

@@ -51,8 +51,6 @@ module.exports = ({lnd}) => {
 
     subscription.cancel();
 
-    subscription.removeAllListeners();
-
     return;
   });
 

package/package.json

@@ -7,12 +7,12 @@
     "url": "https://github.com/alexbosworth/lightning/issues"
   },
   "dependencies": {
-    "@grpc/grpc-js": "1.5.5",
+    "@grpc/grpc-js": "1.5.9",
     "@grpc/proto-loader": "0.6.9",
     "@types/express": "4.17.13",
-    "@types/node": "17.0.18",
+    "@types/node": "17.0.22",
     "@types/request": "2.48.8",
-    "@types/ws": "8.2.2",
+    "@types/ws": "8.5.3",
     "async": "3.2.3",
     "asyncjs-util": "1.2.8",
     "bitcoinjs-lib": "6.0.1",
@@ -22,18 +22,18 @@
     "bolt09": "0.2.2",
     "cbor": "8.1.0",
     "ecpair": "2.0.1",
-    "express": "4.17.2",
+    "express": "4.17.3",
     "invoices": "2.0.4",
     "psbt": "2.0.0",
-    "tiny-secp256k1": "2.2.0",
-    "type-fest": "2.11.2"
+    "tiny-secp256k1": "2.2.1",
+    "type-fest": "2.12.1"
   },
   "description": "Lightning Network client library",
   "devDependencies": {
     "@alexbosworth/node-fetch": "2.6.2",
     "@alexbosworth/tap": "15.0.10",
     "tsd": "0.19.1",
-    "typescript": "4.5.5",
+    "typescript": "4.6.2",
     "ws": "8.5.0"
   },
   "engines": {
@@ -59,5 +59,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "5.8.1"
+  "version": "5.8.4"
 }

package/test/lnd_methods/onchain/test_fund_pending_channels.js

@@ -3,6 +3,7 @@ const {test} = require('@alexbosworth/tap');
 const {fundPendingChannels} = require('./../../../lnd_methods');
 
 const id = Buffer.alloc(32).toString('hex');
+const id2 = Buffer.alloc(32, 1).toString('hex');
 
 const makeLnd = ({finalizeErr, verifyErr}) => {
   return {
@@ -75,6 +76,35 @@ const tests = [
     args: makeArgs({}),
     description: 'Channel funding is executed',
   },
+  {
+    args: makeArgs({
+      channels: [id, id2],
+      lnd: {
+        default: {
+          fundingStateStep: (args, cbk) => {
+            const finalize = args.psbt_finalize;
+
+            if (!finalize) {
+              return cbk();
+            }
+
+            const pendingId = finalize.pending_chan_id.toString('hex');
+
+            if (pendingId === id && finalize.no_publish !== true) {
+              return cbk('ExpectedFirstChannelIsNoPublish');
+            }
+
+            if (pendingId === id2 && finalize.no_publish !== false) {
+              return cbk('ExpectedLastChannelIsNotNoPublish');
+            }
+
+            return cbk();
+          },
+        },
+      },
+    }),
+    description: 'Channel funding across multiple channels is executed',
+  },
 ];
 
 tests.forEach(({args, description, error, expected}) => {

package/test/lnd_methods/onchain/test_open_channels.js

@@ -5,6 +5,8 @@ const {test} = require('@alexbosworth/tap');
 const {openChannels} = require('./../../../lnd_methods');
 
 const emitter = new EventEmitter();
+const nodeKey1 = Buffer.alloc(33).toString('hex');
+const nodeKey2 = Buffer.alloc(33, 2).toString('hex');
 
 const makeChannels = ({}) => {
   return [{
@@ -128,6 +130,57 @@ const tests = [
     description: 'Channels are pending',
     expected: {pending: {address: 'funding_address', tokens: 1}},
   },
+  {
+    args: {
+      channels: [
+        {capacity: 1, partner_public_key: nodeKey1},
+        {capacity: 2, partner_public_key: nodeKey2},
+      ],
+      lnd: {
+        default: {
+          fundingStateStep: ({}, cbk) => cbk(),
+          openChannel: args => {
+            const eventEmitter = new EventEmitter();
+
+            const key = args.node_pubkey.toString('hex');
+
+            if (key === nodeKey1 && !args.funding_shim.psbt_shim.no_publish) {
+              throw new Error('ExpectedFirstKeyIsNoPublish');
+            }
+
+            if (key === nodeKey2 && !!args.funding_shim.psbt_shim.no_publish) {
+              throw new Error('TheSecondChannelShouldPublish');
+            }
+
+            process.nextTick(() => {
+              eventEmitter.emit('data', {});
+
+              eventEmitter.emit('data', {
+                psbt_fund: {
+                  funding_address: 'funding_address',
+                  funding_amount: '1',
+                },
+                update: 'psbt_fund',
+              });
+
+              // Emit twice to make sure that cbk isn't called twice
+              eventEmitter.emit('data', {
+                psbt_fund: {
+                  funding_address: 'funding_address',
+                  funding_amount: '1',
+                },
+                update: 'psbt_fund',
+              });
+            });
+
+            return eventEmitter;
+          },
+        },
+      },
+    },
+    description: 'Multiple channels are pending',
+    expected: {pending: {address: 'funding_address', tokens: 1}},
+  },
 ];
 
 tests.forEach(({args, description, error, expected}) => {

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

@@ -44,7 +44,6 @@ expectError(payViaPaymentDetails({destination}));
 expectError(payViaPaymentDetails({destination, routes}));
 expectError(payViaPaymentDetails({routes}));
 expectError(payViaPaymentDetails({lnd}));
-expectError(payViaPaymentDetails({lnd, destination}));
 expectError(payViaPaymentDetails({lnd, routes}));
 
 expectType<PayViaPaymentDetailsResult>(