ln-service 57.5.1 → 57.7.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Versions
 
+## 57.7.0
+
+- `getPendingChannels`: Add support for `close_transaction` to return raw tx
+
+## 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

@@ -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
@@ -3074,6 +3101,8 @@ Requires `offchain:read` permission
 
 `blocks_until_expiry` is not supported in LND 0.16.4 or before
 
+`close_transaction` is not supported in LND 0.17.4 or before
+
     {
       lnd: <Authenticated LND API Object>
     }
@@ -3083,6 +3112,7 @@ Requires `offchain:read` permission
       pending_channels: [{
         [blocks_until_expiry]: <Blocks Until Open Channel Expires Number>
         capacity: <Channel Capacity Tokens Number>
+        [close_transaction]: <Channel Closing Raw Transaction Hex String>
         [close_transaction_id]: <Channel Closing Transaction Id String>
         [description]: <Channel Description String>
         is_active: <Channel Is Active Bool>

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.1",
+    "lightning": "10.7.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.10",
+    "ln-docker-daemons": "6.0.11",
     "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.1"
+  "version": "57.7.0"
 }

package/test/integration/test_get_pending_coop.js

@@ -1,7 +1,10 @@
+const {equal} = require('node:assert').strict;
 const {strictEqual} = require('node:assert').strict;
 const test = require('node:test');
 
 const asyncRetry = require('async/retry');
+const {componentsOfTransaction} = require('@alexbosworth/blockchain');
+const {idForTransactionComponents} = require('@alexbosworth/blockchain');
 const {setupChannel} = require('ln-docker-daemons');
 const {spawnLightningCluster} = require('ln-docker-daemons');
 
@@ -11,6 +14,7 @@ const {getWalletInfo} = require('./../../');
 
 const defaultFee = 1e3;
 const give = 1e4;
+const hexAsBuffer = hex => Buffer.from(hex, 'hex');
 const interval = 10;
 const size = 2;
 const times = 2000;
@@ -55,6 +59,30 @@ test(`Get pending channels`, async () => {
       return {channel};
     });
 
+    const transaction = channel.close_transaction;
+
+    // LND 0.17.4 and below do not support close_transaction
+    if (!!transaction) {
+      const components = componentsOfTransaction({transaction});
+
+      const closing = idForTransactionComponents({
+        inputs: components.inputs.map(input => ({
+          hash: hexAsBuffer(input.id).reverse(),
+          script: hexAsBuffer(input.script),
+          sequence: input.sequence,
+          vout: input.vout,
+        })),
+        locktime: components.locktime,
+        outputs: components.outputs.map(output => ({
+          script: hexAsBuffer(output.script),
+          tokens: output.tokens,
+        })),
+        version: components.version,
+      });
+
+      equal(closing.id, channel.close_transaction_id, 'Got closing tx');
+    }
+
     if (channel.is_partner_initiated !== undefined) {
       strictEqual(channel.is_partner_initiated, false, 'Channel initiated');
     }
@@ -82,11 +110,13 @@ test(`Get pending channels`, async () => {
     if (!!channel.remote_balance) {
       strictEqual(channel.remote_balance, give, 'Opposing channel balance');
     }
+
+    await kill({});
   } catch (err) {
+    await kill({});
+
     strictEqual(err, null, 'Expected no error');
   }
 
-  await kill({});
-
   return;
 });

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;
+});