lightning 10.5.0 → 10.6.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Versions
 
+## 10.6.0
+
+- `addAdvertisedFeature`: Add method to advertise a feature bit support
+
+## 10.5.1
+
+- Add support for LND 0.17.4
+
 ## 10.5.0
 
 - `getSweepTransactions`: Add `after` to scope sweep result set

package/README.md

@@ -80,6 +80,8 @@ variables set:
 
 ## Methods
 
+- [addAdvertisedFeature](https://github.com/alexbosworth/ln-service#addadvertisedfeature):
+    Add a new supported feature to the graph node announcement
 - [addExternalSocket](https://github.com/alexbosworth/ln-service#addexternalsocket):
     Add a new LN p2p network socket to node advertisement
 - [addPeer](https://github.com/alexbosworth/ln-service#addpeer): Connect to a new peer

package/index.js

@@ -1,3 +1,4 @@
+const {addAdvertisedFeature} = require('./lnd_methods');
 const {addExternalSocket} = require('./lnd_methods');
 const {addPeer} = require('./lnd_methods');
 const {authenticatedLndGrpc} = require('./lnd_grpc');
@@ -153,6 +154,7 @@ const {verifyChainAddressMessage} = require('./lnd_methods');
 const {verifyMessage} = require('./lnd_methods');
 
 module.exports = {
+  addAdvertisedFeature,
   addExternalSocket,
   addPeer,
   authenticatedLndGrpc,

package/lnd_methods/index.js

@@ -1,3 +1,4 @@
+const {addAdvertisedFeature} = require('./peers');
 const {addExternalSocket} = require('./peers');
 const {addPeer} = require('./peers');
 const {beginGroupSigningSession} = require('./signer');
@@ -152,6 +153,7 @@ const {verifyChainAddressMessage} = require('./onchain');
 const {verifyMessage} = require('./message');
 
 module.exports = {
+  addAdvertisedFeature,
   addExternalSocket,
   addPeer,
   beginGroupSigningSession,

package/lnd_methods/info/constants.json

@@ -40,6 +40,7 @@
     "7f34774529fa0964d47fc418d4d2965435cbfdc0": "0.11.1-beta",
     "86d3dec7b939b21bb10f2cd1ff56970c392a1c69": "0.13.2-beta",
     "86114c575c2dff9dff1e1bb4df961c64aea9fc1c": "0.10.4-beta",
+    "8bba79222f439127e46ec3ff7ec7c650e0d88d56": "0.17.4-beta",
     "96fe51e2e5c2ee0c97909499e0e96a3d3755757e": "0.15.4-beta",
     "aff2ed3a6a118d664049835c325a5b69e977172f": "0.15.2-beta",
     "b4e7131bdb47531ad2f00ce345ddcdb58935bba5": "0.15.3-beta",

package/lnd_methods/macaroon/methods.json

@@ -1,4 +1,8 @@
 {
+  "addAdvertisedFeature": {
+    "method": "updateNodeAnnouncement",
+    "type": "peers"
+  },
   "addExternalSocket": {
     "method": "updateNodeAnnouncement",
     "type": "peers"

package/lnd_methods/peers/add_advertised_feature.js

@@ -0,0 +1,62 @@
+const asyncAuto = require('async/auto');
+const {returnResult} = require('asyncjs-util');
+
+const {isLnd} = require('./../../lnd_requests');
+
+const action = 0;
+const errorUnimplemented = 'unknown service peersrpc.Peers';
+const method = 'updateNodeAnnouncement';
+const type = 'peers';
+
+/** Add an advertised feature to the graph node announcement
+
+  Note: this method is not supported in LND versions 0.14.5 and below
+
+  Requires LND built with `peersrpc` build tag
+
+  Requires `peers:write` permissions
+
+  {
+    feature: <BOLT 09 Feature Bit Number>
+    lnd: <Authenticated LND API Object>
+  }
+
+  @returns via cbk or Promise
+*/
+module.exports = ({feature, lnd}, cbk) => {
+  return new Promise((resolve, reject) => {
+    return asyncAuto({
+      // Check arguments
+      validate: cbk => {
+        if (!feature) {
+          return cbk([400, 'ExpectedFeatureToAddAnnouncementFeature']);
+        }
+
+        if (!isLnd({lnd, method, type})) {
+          return cbk([400, 'ExpectedLndToAddNodeAnnouncementFeature']);
+        }
+
+        return cbk();
+      },
+
+      // Update the node features with the updated feature
+      updateFeatures: ['validate', ({}, cbk) => {
+        return lnd[type][method]({
+          feature_updates: [{action, feature_bit: feature}],
+        },
+        (err, res) => {
+          if (!!err && err.details === errorUnimplemented) {
+            return cbk([400, 'ExpectedPeersRpcLndBuildTagToUpdateFeatures']);
+          }
+
+          if (!!err) {
+            return cbk([503, 'UnexpectedErrorUpdatingNodeFeatures', {err}]);
+          }
+
+          return cbk();
+        });
+      }],
+    },
+    returnResult({reject, resolve}, cbk));
+  });
+};

package/lnd_methods/peers/index.js

@@ -1,3 +1,4 @@
+const addAdvertisedFeature = require('./add_advertised_feature');
 const addExternalSocket = require('./add_external_socket');
 const addPeer = require('./add_peer');
 const getPeers = require('./get_peers');
@@ -8,6 +9,7 @@ const updateAlias = require('./update_alias');
 const updateColor = require('./update_color');
 
 module.exports = {
+  addAdvertisedFeature,
   addExternalSocket,
   addPeer,
   getPeers,

package/package.json

@@ -7,9 +7,9 @@
     "url": "https://github.com/alexbosworth/lightning/issues"
   },
   "dependencies": {
-    "@grpc/grpc-js": "1.10.0",
+    "@grpc/grpc-js": "1.10.1",
     "@grpc/proto-loader": "0.7.10",
-    "@types/node": "20.11.16",
+    "@types/node": "20.11.19",
     "@types/request": "2.48.12",
     "@types/ws": "8.5.10",
     "async": "3.2.5",
@@ -53,5 +53,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "10.5.0"
+  "version": "10.6.0"
 }

package/test/lnd_methods/peers/test_add_advertised_feature.js

@@ -0,0 +1,57 @@
+const {rejects} = require('node:assert').strict;
+const test = require('node:test');
+
+const {addAdvertisedFeature} = require('./../../../');
+
+const makeLnd = ({err}) => {
+  return {peers: {updateNodeAnnouncement: (args, cbk) => cbk(err)}};
+};
+
+const makeArgs = overrides => {
+  const args = {feature: 127, lnd: makeLnd({})};
+
+  Object.keys(overrides).forEach(key => args[key] = overrides[key]);
+
+  return args;
+};
+
+const tests = [
+  {
+    args: makeArgs({feature: undefined}),
+    description: 'A feature is required to add an advertised feature',
+    error: [400, 'ExpectedFeatureToAddAnnouncementFeature'],
+  },
+  {
+    args: makeArgs({lnd: undefined}),
+    description: 'LND is required to add an advertised feature',
+    error: [400, 'ExpectedLndToAddNodeAnnouncementFeature'],
+  },
+  {
+    args: makeArgs({
+      lnd: makeLnd({err: {details: 'unknown service peersrpc.Peers'}}),
+    }),
+    description: 'LND with peersrpc is required to add an advertised feature',
+    error: [400, 'ExpectedPeersRpcLndBuildTagToUpdateFeatures'],
+  },
+  {
+    args: makeArgs({lnd: makeLnd({err: 'err'})}),
+    description: 'LND error is returned',
+    error: [503, 'UnexpectedErrorUpdatingNodeFeatures', {err: 'err'}],
+  },
+  {
+    args: makeArgs({}),
+    description: 'Feature added successfully',
+  },
+];
+
+tests.forEach(({args, description, error, expected}) => {
+  return test(description, async () => {
+    if (!!error) {
+      await rejects(() => addAdvertisedFeature(args), error, 'Got error');
+    } else {
+      await addAdvertisedFeature(args);
+    }
+
+    return;
+  });
+});