lightning 5.12.0 → 5.13.0

package/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Versions
 
+## 5.13.0
+
+- `addExternalSocket`: Add method to add a socket to graph announcements
+- `removeExternalSocket`: Add method to remove sockets from graph announcements
+
 ## 5.12.0
 
 - `getWalletVersion`: Add support for LND 0.14.3-beta

package/index.js

@@ -1,3 +1,4 @@
+const {addExternalSocket} = require('./lnd_methods');
 const {addPeer} = require('./lnd_methods');
 const {authenticatedLndGrpc} = require('./lnd_grpc');
 const {broadcastChainTransaction} = require('./lnd_methods');
@@ -88,6 +89,7 @@ const {probeForRoute} = require('./lnd_methods');
 const {proposeChannel} = require('./lnd_methods');
 const {recoverFundsFromChannel} = require('./lnd_methods');
 const {recoverFundsFromChannels} = require('./lnd_methods');
+const {removeExternalSocket} = require('./lnd_methods');
 const {removePeer} = require('./lnd_methods');
 const {requestChainFeeIncrease} = require('./lnd_methods');
 const {revokeAccess} = require('./lnd_methods');
@@ -140,6 +142,7 @@ const {verifyBytesSignature} = require('./lnd_methods');
 const {verifyMessage} = require('./lnd_methods');
 
 module.exports = {
+  addExternalSocket,
   addPeer,
   authenticatedLndGrpc,
   broadcastChainTransaction,
@@ -230,6 +233,7 @@ module.exports = {
   proposeChannel,
   recoverFundsFromChannel,
   recoverFundsFromChannels,
+  removeExternalSocket,
   removePeer,
   requestChainFeeIncrease,
   revokeAccess,

package/lnd_methods/index.js

@@ -1,3 +1,4 @@
+const {addExternalSocket} = require('./peers');
 const {addPeer} = require('./peers');
 const {broadcastChainTransaction} = require('./onchain');
 const {cancelHodlInvoice} = require('./invoices');
@@ -85,6 +86,7 @@ const {probeForRoute} = require('./offchain');
 const {proposeChannel} = require('./onchain');
 const {recoverFundsFromChannel} = require('./offchain');
 const {recoverFundsFromChannels} = require('./offchain');
+const {removeExternalSocket} = require('./peers');
 const {removePeer} = require('./peers');
 const {requestChainFeeIncrease} = require('./onchain');
 const {revokeAccess} = require('./macaroon');
@@ -136,6 +138,7 @@ const {verifyBytesSignature} = require('./signer');
 const {verifyMessage} = require('./message');
 
 module.exports = {
+  addExternalSocket,
   addPeer,
   broadcastChainTransaction,
   cancelHodlInvoice,
@@ -223,6 +226,7 @@ module.exports = {
   proposeChannel,
   recoverFundsFromChannel,
   recoverFundsFromChannels,
+  removeExternalSocket,
   removePeer,
   requestChainFeeIncrease,
   revokeAccess,

package/lnd_methods/macaroon/methods.json

@@ -1,4 +1,8 @@
 {
+  "addExternalSocket": {
+    "method": "updateNodeAnnouncement",
+    "type": "peers"
+  },
   "addPeer": {
     "method": "ConnectPeer",
     "type": "default"
@@ -338,6 +342,10 @@
     "method": "restoreChannelBackups",
     "type": "default"
   },
+  "removeExternalSocket": {
+    "method": "updateNodeAnnouncement",
+    "type": "peers"
+  },
   "removePeer": {
     "method": "DisconnectPeer",
     "type": "default"

package/lnd_methods/peers/add_external_socket.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 a new advertised p2p socket address
+
+  Note: this method is not supported in LND versions 0.14.3 and below
+
+  Requires LND built with `peersrpc` build tag
+
+  Requires `peers:write` permissions
+
+  {
+    lnd: <Authenticated LND API Object>
+    socket: <Add Socket Address String>
+  }
+
+  @returns via cbk or Promise
+*/
+module.exports = ({lnd, socket}, cbk) => {
+  return new Promise((resolve, reject) => {
+    return asyncAuto({
+      // Check arguments
+      validate: cbk => {
+        if (!isLnd({lnd, method, type})) {
+          return cbk([400, 'ExpectedLndToAddExternalSocket']);
+        }
+
+        if (!socket) {
+          return cbk([400, 'ExpectedHostAndPortOfSocketToAdd']);
+        }
+
+        return cbk();
+      },
+
+      // Add external socket to be advertised
+      add: ['validate', ({}, cbk) => {
+        return lnd[type][method]({
+          address_updates: [{action, address: socket}],
+        },
+        err => {
+          if (!!err && err.details === errorUnimplemented) {
+            return cbk([400, 'ExpectedPeersRpcLndBuildTagToAddSocket']);
+          }
+
+          if (!!err) {
+            return cbk([503, 'UnexpectedErrorAddingExternalSocket', {err}]);
+          }
+
+          return cbk();
+        });
+      }],
+    },
+    returnResult({reject, resolve}, cbk));
+  });
+};

package/lnd_methods/peers/index.js

@@ -1,13 +1,17 @@
+const addExternalSocket = require('./add_external_socket');
 const addPeer = require('./add_peer');
 const getPeers = require('./get_peers');
+const removeExternalSocket = require('./remove_external_socket');
 const removePeer = require('./remove_peer');
 const subscribeToPeers = require('./subscribe_to_peers');
 const updateAlias = require('./update_alias');
 const updateColor = require('./update_color');
 
 module.exports = {
+  addExternalSocket,
   addPeer,
   getPeers,
+  removeExternalSocket,
   removePeer,
   subscribeToPeers,
   updateAlias,

package/lnd_methods/peers/remove_external_socket.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 existing advertised p2p socket address
+
+  Note: this method is not supported in LND versions 0.14.3 and below
+
+  Requires LND built with `peersrpc` build tag
+
+  Requires `peers:write` permissions
+
+  {
+    lnd: <Authenticated LND API Object>
+    socket: <Remove Socket Address String>
+  }
+
+  @returns via cbk or Promise
+*/
+module.exports = ({lnd, socket}, cbk) => {
+  return new Promise((resolve, reject) => {
+    return asyncAuto({
+      // Check arguments
+      validate: cbk => {
+        if (!isLnd({lnd, method, type})) {
+          return cbk([400, 'ExpectedLndToRemoveExternalSocket']);
+        }
+
+        if (!socket) {
+          return cbk([400, 'ExpectedHostAndPortOfSocketToRemove']);
+        }
+
+        return cbk();
+      },
+
+      // Stop external socket from being advertised
+      add: ['validate', ({}, cbk) => {
+        return lnd[type][method]({
+          address_updates: [{action, address: socket}],
+        },
+        err => {
+          if (!!err && err.details === errorUnimplemented) {
+            return cbk([400, 'ExpectedPeersRpcLndBuildTagToRemoveSocket']);
+          }
+
+          if (!!err) {
+            return cbk([503, 'UnexpectedErrorRemovingExternalSocket', {err}]);
+          }
+
+          return cbk();
+        });
+      }],
+    },
+    returnResult({reject, resolve}, cbk));
+  });
+};

package/package.json

@@ -7,7 +7,7 @@
     "url": "https://github.com/alexbosworth/lightning/issues"
   },
   "dependencies": {
-    "@grpc/grpc-js": "1.6.6",
+    "@grpc/grpc-js": "1.6.7",
     "@grpc/proto-loader": "0.6.9",
     "@types/express": "4.17.13",
     "@types/node": "17.0.25",
@@ -59,5 +59,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "5.12.0"
+  "version": "5.13.0"
 }

package/test/lnd_methods/peers/test_add_external_socket.js

@@ -0,0 +1,56 @@
+const {test} = require('@alexbosworth/tap');
+
+const {addExternalSocket} = require('./../../../');
+
+const makeLnd = ({err}) => {
+  return {peers: {updateNodeAnnouncement: (args, cbk) => cbk(err)}};
+};
+
+const makeArgs = overrides => {
+  const args = {lnd: makeLnd({}), socket: '127.0.0.1:9735'};
+
+  Object.keys(overrides).forEach(key => args[key] = overrides[key]);
+
+  return args;
+};
+
+const tests = [
+  {
+    args: makeArgs({lnd: undefined}),
+    description: 'LND is required to add an external socket',
+    error: [400, 'ExpectedLndToAddExternalSocket'],
+  },
+  {
+    args: makeArgs({socket: undefined}),
+    description: 'A socket is required to add an external socket',
+    error: [400, 'ExpectedHostAndPortOfSocketToAdd'],
+  },
+  {
+    args: makeArgs({
+      lnd: makeLnd({err: {details: 'unknown service peersrpc.Peers'}}),
+    }),
+    description: 'LND with peersrpc is required to add an external socket',
+    error: [400, 'ExpectedPeersRpcLndBuildTagToAddSocket'],
+  },
+  {
+    args: makeArgs({lnd: makeLnd({err: 'err'})}),
+    description: 'LND error is returned',
+    error: [503, 'UnexpectedErrorAddingExternalSocket', {err: 'err'}],
+  },
+  {
+    args: makeArgs({}),
+    description: 'Socket added successfully',
+  },
+];
+
+tests.forEach(({args, description, error, expected}) => {
+  return test(description, async ({deepEqual, end, equal, rejects}) => {
+    if (!!error) {
+      await rejects(() => addExternalSocket(args), error, 'Got error');
+    } else {
+      await addExternalSocket(args);
+    }
+
+    return end();
+  });
+});

package/test/lnd_methods/peers/test_remove_external_socket.js

@@ -0,0 +1,56 @@
+const {test} = require('@alexbosworth/tap');
+
+const {removeExternalSocket} = require('./../../../');
+
+const makeLnd = ({err}) => {
+  return {peers: {updateNodeAnnouncement: (args, cbk) => cbk(err)}};
+};
+
+const makeArgs = overrides => {
+  const args = {lnd: makeLnd({}), socket: '127.0.0.1:9735'};
+
+  Object.keys(overrides).forEach(key => args[key] = overrides[key]);
+
+  return args;
+};
+
+const tests = [
+  {
+    args: makeArgs({lnd: undefined}),
+    description: 'LND is required to remove an external socket',
+    error: [400, 'ExpectedLndToRemoveExternalSocket'],
+  },
+  {
+    args: makeArgs({socket: undefined}),
+    description: 'A socket is required to remove an external socket',
+    error: [400, 'ExpectedHostAndPortOfSocketToRemove'],
+  },
+  {
+    args: makeArgs({
+      lnd: makeLnd({err: {details: 'unknown service peersrpc.Peers'}}),
+    }),
+    description: 'LND with peersrpc is required to add an external socket',
+    error: [400, 'ExpectedPeersRpcLndBuildTagToRemoveSocket'],
+  },
+  {
+    args: makeArgs({lnd: makeLnd({err: 'err'})}),
+    description: 'LND error is returned',
+    error: [503, 'UnexpectedErrorRemovingExternalSocket', {err: 'err'}],
+  },
+  {
+    args: makeArgs({}),
+    description: 'Socket removed successfully',
+  },
+];
+
+tests.forEach(({args, description, error, expected}) => {
+  return test(description, async ({deepEqual, end, equal, rejects}) => {
+    if (!!error) {
+      await rejects(() => removeExternalSocket(args), error, 'Got error');
+    } else {
+      await removeExternalSocket(args);
+    }
+
+    return end();
+  });
+});