lightning 10.7.1 → 10.8.1

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Versions
 
+## 10.8.1
+
+- `removeAdvertisedFeature`: Add method to remove a feature bit support ad
+
 ## 10.7.1
 
 - `getPendingChannels`: Add support for `close_transaction` to return raw tx

package/README.md

@@ -271,6 +271,8 @@ variables set:
     Attempt to recover channel funds from a specific channel backup.
 - [recoverFundsFromChannels](https://github.com/alexbosworth/ln-service#recoverfundsfromchannels):
     Attempt to recover funds from multiple channels using a multiple channel backup.
+- [removeAdvertisedFeature](https://github.com/alexbosworth/ln-service#removeadvertisedfeature):
+    Remove a supported feature from the graph node announcement
 - [removeExternalSocket](https://github.com/alexbosworth/ln-service#removeexternalsocket):
     Remove a LN p2p network socket from the node advertisement
 - [removePeer](https://github.com/alexbosworth/ln-service#removepeer): Disconnect from a

package/grpc/protos/autopilot.proto

@@ -4,11 +4,29 @@ package autopilotrpc;
 
 option go_package = "github.com/lightningnetwork/lnd/lnrpc/autopilotrpc";
 
+/*
+ * Comments in this file will be directly parsed into the API
+ * Documentation as descriptions of the associated method, message, or field.
+ * These descriptions should go right above the definition of the object, and
+ * can be in either block or // comment format.
+ *
+ * An RPC method can be matched to an lncli command by placing a line in the
+ * beginning of the description in exactly the following format:
+ * lncli: `methodname`
+ *
+ * Failure to specify the exact name of the command will cause documentation
+ * generation to fail.
+ *
+ * More information on how exactly the gRPC documentation is generated from
+ * this proto file can be found here:
+ * https://github.com/lightninglabs/lightning-api
+ */
+
 // Autopilot is a service that can be used to get information about the current
 // state of the daemon's autopilot agent, and also supply it with information
 // that can be used when deciding where to open channels.
 service Autopilot {
-    /*
+    /* lncli: `autopilot status`
     Status returns whether the daemon's autopilot agent is active.
     */
     rpc Status (StatusRequest) returns (StatusResponse);
@@ -19,7 +37,7 @@ service Autopilot {
     */
     rpc ModifyStatus (ModifyStatusRequest) returns (ModifyStatusResponse);
 
-    /*
+    /* lncli: `autopilot query`
     QueryScores queries all available autopilot heuristics, in addition to any
     active combination of these heruristics, for the scores they would give to
     the given nodes.

package/index.js

@@ -97,6 +97,7 @@ const {probeForRoute} = require('./lnd_methods');
 const {proposeChannel} = require('./lnd_methods');
 const {recoverFundsFromChannel} = require('./lnd_methods');
 const {recoverFundsFromChannels} = require('./lnd_methods');
+const {removeAdvertisedFeature} = require('./lnd_methods');
 const {removeExternalSocket} = require('./lnd_methods');
 const {removePeer} = require('./lnd_methods');
 const {requestChainFeeIncrease} = require('./lnd_methods');
@@ -253,6 +254,7 @@ module.exports = {
   proposeChannel,
   recoverFundsFromChannel,
   recoverFundsFromChannels,
+  removeAdvertisedFeature,
   removeExternalSocket,
   removePeer,
   requestChainFeeIncrease,

package/lnd_methods/index.js

@@ -97,6 +97,7 @@ const {probeForRoute} = require('./offchain');
 const {proposeChannel} = require('./onchain');
 const {recoverFundsFromChannel} = require('./offchain');
 const {recoverFundsFromChannels} = require('./offchain');
+const {removeAdvertisedFeature} = require('./peers');
 const {removeExternalSocket} = require('./peers');
 const {removePeer} = require('./peers');
 const {requestChainFeeIncrease} = require('./onchain');
@@ -252,6 +253,7 @@ module.exports = {
   proposeChannel,
   recoverFundsFromChannel,
   recoverFundsFromChannels,
+  removeAdvertisedFeature,
   removeExternalSocket,
   removePeer,
   requestChainFeeIncrease,

package/lnd_methods/macaroon/methods.json

@@ -388,6 +388,10 @@
     "method": "restoreChannelBackups",
     "type": "default"
   },
+  "removeAdvertisedFeature": {
+    "method": "updateNodeAnnouncement",
+    "type": "peers"
+  },
   "removeExternalSocket": {
     "method": "updateNodeAnnouncement",
     "type": "peers"

package/lnd_methods/peers/index.js

@@ -2,6 +2,7 @@ const addAdvertisedFeature = require('./add_advertised_feature');
 const addExternalSocket = require('./add_external_socket');
 const addPeer = require('./add_peer');
 const getPeers = require('./get_peers');
+const removeAdvertisedFeature = require('./remove_advertised_feature');
 const removeExternalSocket = require('./remove_external_socket');
 const removePeer = require('./remove_peer');
 const subscribeToPeers = require('./subscribe_to_peers');
@@ -13,6 +14,7 @@ module.exports = {
   addExternalSocket,
   addPeer,
   getPeers,
+  removeAdvertisedFeature,
   removeExternalSocket,
   removePeer,
   subscribeToPeers,

package/lnd_methods/peers/remove_advertised_feature.d.ts

@@ -0,0 +1,20 @@
+import {
+  AuthenticatedLightningArgs,
+  AuthenticatedLightningMethod,
+} from '../../typescript/shared';
+
+export type RemoveAdvertisedFeature = AuthenticatedLightningArgs<{
+  /** BOLT 09 Feature Bit Number */
+  feature: number;
+}>;
+
+/**
+ * Remove an advertised feature from 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
+ */
+export const removeAdvertisedFeature: AuthenticatedLightningMethod<RemoveAdvertisedFeature>;

package/lnd_methods/peers/remove_advertised_feature.js

@@ -0,0 +1,62 @@
+const asyncAuto = require('async/auto');
+const {returnResult} = require('asyncjs-util');
+
+const {isLnd} = require('./../../lnd_requests');
+
+const action = 1;
+const errorUnimplemented = 'unknown service peersrpc.Peers';
+const method = 'updateNodeAnnouncement';
+const type = 'peers';
+
+/** Remove an advertised feature from 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, 'ExpectedFeatureToRemoveAnnouncementFeature']);
+        }
+
+        if (!isLnd({lnd, method, type})) {
+          return cbk([400, 'ExpectedLndToRemoveNodeAnnouncementFeature']);
+        }
+
+        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, 'ExpectedPeersRpcLndBuildTagToRemoveFeature']);
+          }
+
+          if (!!err) {
+            return cbk([503, 'UnexpectedErrorRemovingNodeFeature', {err}]);
+          }
+
+          return cbk();
+        });
+      }],
+    },
+    returnResult({reject, resolve}, cbk));
+  });
+};

package/package.json

@@ -7,9 +7,9 @@
     "url": "https://github.com/alexbosworth/lightning/issues"
   },
   "dependencies": {
-    "@grpc/grpc-js": "1.10.2",
+    "@grpc/grpc-js": "1.10.3",
     "@grpc/proto-loader": "0.7.10",
-    "@types/node": "20.11.27",
+    "@types/node": "20.11.30",
     "@types/request": "2.48.12",
     "@types/ws": "8.5.10",
     "async": "3.2.5",
@@ -22,12 +22,12 @@
     "invoices": "3.0.0",
     "psbt": "3.0.0",
     "tiny-secp256k1": "2.2.3",
-    "type-fest": "4.12.0"
+    "type-fest": "4.13.1"
   },
   "description": "Lightning Network client library",
   "devDependencies": {
     "tsd": "0.30.7",
-    "typescript": "5.4.2"
+    "typescript": "5.4.3"
   },
   "engines": {
     "node": ">=18"
@@ -53,5 +53,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "10.7.1"
+  "version": "10.8.1"
 }

package/test/lnd_methods/peers/test_remove_advertised_feature.js

@@ -0,0 +1,57 @@
+const {rejects} = require('node:assert').strict;
+const test = require('node:test');
+
+const {removeAdvertisedFeature} = 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 remove an advertised feature',
+    error: [400, 'ExpectedFeatureToRemoveAnnouncementFeature'],
+  },
+  {
+    args: makeArgs({lnd: undefined}),
+    description: 'LND is required to remove an advertised feature',
+    error: [400, 'ExpectedLndToRemoveNodeAnnouncementFeature'],
+  },
+  {
+    args: makeArgs({
+      lnd: makeLnd({err: {details: 'unknown service peersrpc.Peers'}}),
+    }),
+    description: 'LND with peersrpc is required to remove a feature',
+    error: [400, 'ExpectedPeersRpcLndBuildTagToRemoveFeature'],
+  },
+  {
+    args: makeArgs({lnd: makeLnd({err: 'err'})}),
+    description: 'LND error is returned',
+    error: [503, 'UnexpectedErrorRemovingNodeFeature', {err: 'err'}],
+  },
+  {
+    args: makeArgs({}),
+    description: 'Feature removed successfully',
+  },
+];
+
+tests.forEach(({args, description, error, expected}) => {
+  return test(description, async () => {
+    if (!!error) {
+      await rejects(() => removeAdvertisedFeature(args), error, 'Got error');
+    } else {
+      await removeAdvertisedFeature(args);
+    }
+
+    return;
+  });
+});