ln-service 57.5.0 → 57.6.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Versions
 
+## 57.6.0
+
+- `addAdvertisedFeature`: Add method to advertise a feature bit support
+
 ## 57.5.0
 
 - `getSweepTransactions`: Add `after` to scope sweep result set

package/README.md

@@ -9,7 +9,7 @@ through npm.
 
 Supported LND versions:
 
-- v0.17.0-beta to v0.17.3-beta
+- v0.17.0-beta to v0.17.4-beta
 - v0.16.0-beta to v0.16.4-beta
 - v0.15.2-beta to v0.15.5-beta
 - v0.14.4-beta to v0.14.5-beta
@@ -135,6 +135,7 @@ for `unlocker` methods.
 
 ## All Methods
 
+- [addAdvertisedFeature](#addadvertisedfeature) - Advertise a supported feature
 - [addExternalSocket](#addexternalsocket) - Advertise a new p2p host:ip address
 - [addPeer](#addpeer) - Connect to a peer
 - [authenticatedLndGrpc](#authenticatedlndgrpc) - LND API Object
@@ -329,6 +330,32 @@ for `unlocker` methods.
 - [probing](https://npmjs.com/package/probing) - payment probing utilities
 - [psbt](https://www.npmjs.com/package/psbt) - BIP 174 PSBT utilities
 
+### addAdvertisedFeature
+
+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
+
+Example:
+
+```node
+const {addAdvertisedFeature} = require('ln-service');
+
+// Add a new supported feature to the graph node announcement
+await addAdvertisedFeature({lnd, feature: 12345});
+```
+
 ### addExternalSocket
 
 Add a new advertised p2p socket address

package/index.js

@@ -1,3 +1,4 @@
+const {addAdvertisedFeature} = require('lightning');
 const {addExternalSocket} = require('lightning');
 const {addPeer} = require('lightning');
 const {authenticatedLndGrpc} = require('lightning');
@@ -158,6 +159,7 @@ const {verifyChainAddressMessage} = require('lightning');
 const {verifyMessage} = require('lightning');
 
 module.exports = {
+  addAdvertisedFeature,
   addExternalSocket,
   addPeer,
   authenticatedLndGrpc,

package/package.json

@@ -9,7 +9,7 @@
   "dependencies": {
     "bolt07": "1.8.4",
     "invoices": "3.0.0",
-    "lightning": "10.5.0",
+    "lightning": "10.6.0",
     "macaroon": "3.0.4"
   },
   "description": "Interaction helper for your Lightning Network daemon",
@@ -24,7 +24,7 @@
     "bn.js": "5.2.1",
     "bs58check": "3.0.1",
     "ecpair": "2.1.0",
-    "ln-docker-daemons": "6.0.9",
+    "ln-docker-daemons": "6.0.10",
     "p2tr": "2.0.0",
     "portfinder": "1.0.32",
     "psbt": "3.0.0",
@@ -69,5 +69,5 @@
     "integration-test-0.14.4": "DOCKER_LND_VERSION=v0.14.4-beta npm run test",
     "test": "echo $DOCKER_LND_VERSION && node test/runner"
   },
-  "version": "57.5.0"
+  "version": "57.6.0"
 }

package/test/peersrpc-integration/test_add_advertised_feature.js

@@ -0,0 +1,43 @@
+const {deepEqual} = require('node:assert').strict;
+const test = require('node:test');
+
+const {spawnLightningCluster} = require('ln-docker-daemons');
+
+const {addAdvertisedFeature} = require('./../../');
+const {getWalletInfo} = require('./../../');
+
+const feature = 12345;
+
+// Adding a feature should result in an updated advertised feature
+test(`Add external socket`, async () => {
+  const {kill, nodes} = await spawnLightningCluster({});
+
+  const [{id, lnd}] = nodes;
+
+  try {
+    await addAdvertisedFeature({feature, lnd});
+
+    const {features} = await getWalletInfo({lnd});
+
+    const added = features.find(n => n.bit === feature);
+
+    deepEqual(
+      added,
+      {
+        bit: 12345,
+        is_known: false,
+        is_required: false,
+        type: undefined,
+      },
+      'Feature bit is advertised'
+    );
+
+    await kill({});
+  } catch (err) {
+    await kill({});
+
+    deepEqual(err, [400, 'ExpectedPeersRpcLndBuildTagToAddFeature']);
+  }
+
+  return;
+});