lightning 5.16.3 → 5.16.6

package/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Versions
 
-## 5.16.3
+## 5.16.6
+
+- `subscribeToInvoices`: Cancel subscription when there are no event listeners
+
+## 5.16.4
 
 - `signTransaction`: Add `root_hash` to support Taproot signatures with scripts
 

package/README.md

@@ -18,6 +18,7 @@ Methods for working with the Lightning Network
     https://github.com/ibz/lightning-shell
 - [LNMarkets](https://twitter.com/lnmarkets) -
     https://github.com/lnmarkets/umbrel
+- [mempool.space](https://mempool.space/) - https://github.com/mempool/mempool
 - [p2plnbot](https://telegram.me/lnp2pbot) - https://github.com/grunch/p2plnbot
 - [rekr](https://rekr.app/) - https://github.com/ryan-lingle/rekr
 - [stackernews](https://stacker.news/) -
@@ -64,6 +65,14 @@ const {lnd} = authenticatedLndGrpc({
 To access unauthenticated methods like the wallet unlocker, use 
 `unauthenticatedLndGrpc` instead.
 
+## Debugging
+
+If you encounter any issues connecting and wish to view detailed information
+about the underlying grpc calls, you can run Node with these environment
+variables set:
+
+    GRPC_VERBOSITY=DEBUG GRPC_TRACE=all node YOURSCRIPTNAME.js
+
 ## Methods
 
 - [addExternalSocket](https://github.com/alexbosworth/ln-service#addexternalsocket):

package/lnd_methods/invoices/subscribe_to_invoices.js

@@ -2,12 +2,15 @@ const EventEmitter = require('events');
 
 const asyncDoUntil = require('async/doUntil');
 
-const {rpcInvoiceAsInvoice} = require('./../../lnd_responses');
+const {handleRemoveListener} = require('./../../grpc');
 const {isLnd} = require('./../../lnd_requests');
+const {rpcInvoiceAsInvoice} = require('./../../lnd_responses');
 
 const connectionFailureMessage = 'failed to connect to all addresses';
+const events = ['end', 'error', 'invoice_updated', 'status'];
 const msPerSec = 1e3;
 const restartSubscriptionMs = 1000 * 30;
+const sumOf = arr => arr.reduce((sum, n) => sum + n, Number());
 const updateEvent = 'invoice_updated';
 
 /** Subscribe to invoices
@@ -94,6 +97,9 @@ module.exports = args => {
       settle_index: !!confirmedAfter ? confirmedAfter.toString() : undefined,
     });
 
+    // Terminate subscription when all listeners are removed
+    handleRemoveListener({subscription, events, emitter: eventEmitter});
+
     // Subscription finished callback
     const finished = err => {
       if (!!eventEmitter.listenerCount('error')) {
@@ -107,14 +113,30 @@ module.exports = args => {
 
       isFinished = true;
 
+      const listenerCount = eventEmitter.listenerCount(updateEvent);
+
+      // Exit early when there are no listeners
+      if (!listenerCount) {
+        return cbk(null, {listener_count: listenerCount});
+      }
+
+      // Delay restart when there are listeners
       return setTimeout(() => {
-        return cbk(null, {
-          listener_count: eventEmitter.listenerCount(updateEvent),
-        });
+        return cbk(null, {listener_count: listenerCount});
       },
       args.restart_delay_ms || restartSubscriptionMs);
     };
 
+    // Finish early when all listeners are removed
+    eventEmitter.on('removeListener', () => {
+      // Exit early when there are still active listeners
+      if (!!sumOf(events.map(n => eventEmitter.listenerCount(n)))) {
+        return;
+      }
+
+      return finished();
+    });
+
     // Relay invoice updates to the emitter
     subscription.on('data', invoice => {
       try {

package/lnd_methods/offchain/get_channels.d.ts

@@ -44,7 +44,7 @@ export type GetChannelsResult = {
     local_balance: number;
     /** Local CSV Blocks Delay */
     local_csv?: number;
-    /** Remote Non-Enforceable Amount Tokens */
+    /** Local Non-Enforceable Amount Tokens */
     local_dust?: number;
     /** Local Initially Pushed Tokens */
     local_given?: number;

package/lnd_methods/offchain/get_channels.js

@@ -40,7 +40,7 @@ const type = 'default';
       is_private: <Channel Is Private Bool>
       local_balance: <Local Balance Tokens Number>
       [local_csv]: <Local CSV Blocks Delay Number>
-      [local_dust]: <Remote Non-Enforceable Amount Tokens Number>
+      [local_dust]: <Local Non-Enforceable Amount Tokens Number>
       [local_given]: <Local Initially Pushed Tokens Number>
       [local_max_htlcs]: <Local Maximum Attached HTLCs Number>
       [local_max_pending_mtokens]: <Local Maximum Pending Millitokens String>

package/package.json

@@ -7,15 +7,15 @@
     "url": "https://github.com/alexbosworth/lightning/issues"
   },
   "dependencies": {
-    "@grpc/grpc-js": "1.6.7",
-    "@grpc/proto-loader": "0.6.13",
+    "@grpc/grpc-js": "1.6.8",
+    "@grpc/proto-loader": "0.7.0",
     "@types/express": "4.17.13",
-    "@types/node": "17.0.41",
+    "@types/node": "18.6.3",
     "@types/request": "2.48.8",
     "@types/ws": "8.5.3",
     "async": "3.2.4",
-    "asyncjs-util": "1.2.9",
-    "bitcoinjs-lib": "6.0.1",
+    "asyncjs-util": "1.2.10",
+    "bitcoinjs-lib": "6.0.2",
     "bn.js": "5.2.1",
     "body-parser": "1.20.0",
     "bolt07": "1.8.2",
@@ -23,18 +23,18 @@
     "cbor": "8.1.0",
     "ecpair": "2.0.1",
     "express": "4.18.1",
-    "invoices": "2.0.7",
-    "psbt": "2.6.0",
+    "invoices": "2.1.0",
+    "psbt": "2.7.1",
     "tiny-secp256k1": "2.2.1",
-    "type-fest": "2.13.0"
+    "type-fest": "2.18.0"
   },
   "description": "Lightning Network client library",
   "devDependencies": {
     "@alexbosworth/node-fetch": "2.6.2",
     "@alexbosworth/tap": "15.0.11",
-    "tsd": "0.20.0",
-    "typescript": "4.7.3",
-    "ws": "8.7.0"
+    "tsd": "0.22.0",
+    "typescript": "4.7.4",
+    "ws": "8.8.1"
   },
   "engines": {
     "node": ">=12.20"
@@ -59,5 +59,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "5.16.3"
+  "version": "5.16.6"
 }

package/test/lnd_methods/invoices/test_subscribe_to_invoices.js

@@ -7,6 +7,8 @@ const {subscribeToInvoices} = require('./../../../');
 
 const emitter = new EventEmitter();
 
+emitter.cancel = () => {};
+
 const makeLnd = ({err}) => ({default: {subscribeInvoices: ({}) => emitter}});
 
 const tests = [