ln-service 53.11.0 → 53.14.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Versions
 
+## 53.14.0
+
+- `addExternalSocket`: Add method to add a socket to graph announcements
+- `removeExternalSocket`: Add method to remove sockets from graph announcements
+
+## 53.13.0
+
+- `getWalletVersion`: Add support for LND 0.14.3-beta
+
+## 53.12.0
+
+- `updateAlias`: Add method to update the node graph announcement alias
+- `updateColor`: Add method to update the node graph announcement color
+
 ## 53.11.0
 
 - Use TLV for all hops when sending HTLCs along routes

package/README.md

@@ -9,7 +9,7 @@ through npm.
 
 Supported LND versions:
 
-- v0.14.0-beta to v0.14.2-beta
+- v0.14.0-beta to v0.14.3-beta
 - v0.13.0-beta to v0.13.4-beta
 - v0.12.0-beta to v0.12.1-beta
 - v0.11.0-beta to v0.11.1-beta
@@ -102,6 +102,7 @@ for `unlocker` methods.
 
 ## All Methods
 
+- [addExternalSocket](#addexternalsocket) - Advertise a new p2p host:ip address
 - [addPeer](#addpeer) - Connect to a peer
 - [authenticatedLndGrpc](#authenticatedlndgrpc) - LND API Object
 - [broadcastChainTransaction](#broadcastchaintransaction) - Push a chain tx
@@ -201,6 +202,7 @@ for `unlocker` methods.
 - [proposeChannel](#proposechannel) - Offer a channel proposal to a peer
 - [recoverFundsFromChannel](#recoverfundsfromchannel) - Restore a channel
 - [recoverFundsFromChannels](#recoverfundsfromchannels) - Restore all channels
+- [removeExternalSocket](#removeexternalsocket) - Remove a p2p host:ip announce
 - [removePeer](#removepeer) - Disconnect from a connected peer
 - [requestChainFeeIncrease](#requestchainfeeincrease) - Request a CPFP spend on
     a UTXO
@@ -249,8 +251,10 @@ for `unlocker` methods.
 - [unlockUtxo](#unlockutxo) - Release a locked UTXO so that it can be used
     again
 - [unlockWallet](#unlockwallet) - Unlock a locked lnd
+- [updateAlias](#updatealias) - Update node graph identity alias
 - [updateChainTransaction](#updatechaintransaction) - Update a chain
     transaction
+- [updateColor](#updatecolor) - Update node graph color value
 - [updateConnectedWatchtower](#updateconnectedwatchtower) - Update watchtower
 - [updatePathfindingSettings](#updatepathfindingsettings) - Update pathfinding
     configuration
@@ -271,14 +275,40 @@ for `unlocker` methods.
 - [lightning](https://npmjs.com/package/lightning) - methods with typescript
     typing support
 - [ln-accounting](https://npmjs.com/package/ln-accounting) - accounting records
-- [ln-docker-daemons](https://github.com/alexbosworth/ln-docker-daemons)
-    - run regtest integration tests
+- [ln-docker-daemons](https://github.com/alexbosworth/ln-docker-daemons) -
+    run regtest integration tests
 - [ln-pathfinding](https://npmjs.com/package/ln-accounting) - pathfinding
     utilities
 - [ln-sync](https://www.npmjs.com/package/ln-sync) - metadata helper methods
 - [probing](https://npmjs.com/package/probing) - payment probing utilities
 - [psbt](https://www.npmjs.com/package/psbt) - BIP 174 PSBT utilities
 
+### addExternalSocket
+
+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
+
+Example:
+
+```node
+const {addExternalSocket} = require('ln-service');
+
+// Add a new address to advertise on the graph via gossip
+await addExternalSocket({lnd, socket: '192.168.0.1:9735'});
+```
+
 ### addPeer
 
 Add a peer if possible (not self, or already connected)
@@ -3537,7 +3567,7 @@ Requires `onchain:write` permission
 
 Requires LND built with `walletrpc` tag
 
-This method is not supported in LND 0.14.3 and below
+This method is not supported in LND 0.14.1 and below
 
     {
       lnd: <Authenticated LND API Object>
@@ -4137,6 +4167,32 @@ const {backup} = await getBackups({lnd});
 await recoverFundsFromChannels({backup, lnd});
 ```
 
+### removeExternalSocket
+
+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
+
+Example:
+
+```node
+const {removeExternalSocket} = require('ln-service');
+
+// Stop an address being advertised on the graph via gossip
+await removeExternalSocket({lnd, socket: '127.0.0.1:9735'});
+```
+
 ### removePeer
 
 Remove a peer if possible
@@ -6571,6 +6627,32 @@ const {lnd} = unauthenticatedLndGrpc({});
 await unlockWallet({lnd, password: 'walletSecretPassword'});
 ```
 
+### updateAlias
+
+Update the node alias as advertised in the graph
+
+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
+
+    {
+      alias: <Node Alias String>
+      lnd: <Authenticated LND API Object>
+    }
+
+    @returns via cbk or Promise
+
+Example:
+
+```node
+const {updateAlias} = require('ln-service');
+
+// Set the node alias to "foo"
+await updateAlias({lnd, alias: 'foo'});
+```
+
 ### updateChainTransaction
 
 Update an on-chain transaction record metadata
@@ -6599,6 +6681,32 @@ const [{id}] = transactions;
 await updateChainTransaction({id, lnd, description: 'First transaction'});
 ```
 
+### updateColor
+
+Update the node color as advertised in the graph
+
+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
+
+    {
+      color: <Node Color String>
+      lnd: <Authenticated LND API Object>
+    }
+
+    @returns via cbk or Promise
+
+Example:
+
+```node
+const {updateColor} = require('ln-service');
+
+// Update the node color identity in the network graph
+await updateColor({lnd, color: '#123456'});
+```
+
 ### updateConnectedWatchtower
 
 Update a watchtower

package/index.js

@@ -1,3 +1,4 @@
+const {addExternalSocket} = require('lightning');
 const {addPeer} = require('lightning');
 const {authenticatedLndGrpc} = require('lightning');
 const {broadcastChainTransaction} = require('lightning');
@@ -88,6 +89,7 @@ const {probeForRoute} = require('lightning');
 const {proposeChannel} = require('lightning');
 const {recoverFundsFromChannel} = require('lightning');
 const {recoverFundsFromChannels} = require('lightning');
+const {removeExternalSocket} = require('lightning');
 const {removePeer} = require('lightning');
 const {requestChainFeeIncrease} = require('lightning');
 const {restrictMacaroon} = require('./macaroons');
@@ -129,7 +131,9 @@ const {subscribeToWalletStatus} = require('lightning');
 const {unauthenticatedLndGrpc} = require('lightning');
 const {unlockUtxo} = require('lightning');
 const {unlockWallet} = require('lightning');
+const {updateAlias} = require('lightning');
 const {updateChainTransaction} = require('lightning');
+const {updateColor} = require('lightning');
 const {updateConnectedWatchtower} = require('lightning');
 const {updatePathfindingSettings} = require('lightning');
 const {updateRoutingFees} = require('lightning');
@@ -140,6 +144,7 @@ const {verifyBytesSignature} = require('lightning');
 const {verifyMessage} = require('lightning');
 
 module.exports = {
+  addExternalSocket,
   addPeer,
   authenticatedLndGrpc,
   broadcastChainTransaction,
@@ -230,6 +235,7 @@ module.exports = {
   proposeChannel,
   recoverFundsFromChannel,
   recoverFundsFromChannels,
+  removeExternalSocket,
   removePeer,
   requestChainFeeIncrease,
   restrictMacaroon,
@@ -271,7 +277,9 @@ module.exports = {
   unauthenticatedLndGrpc,
   unlockUtxo,
   unlockWallet,
+  updateAlias,
   updateChainTransaction,
+  updateColor,
   updateConnectedWatchtower,
   updatePathfindingSettings,
   updateRoutingFees,

package/package.json

@@ -10,8 +10,8 @@
     "bolt07": "1.8.1",
     "cors": "2.8.5",
     "express": "4.17.3",
-    "invoices": "2.0.5",
-    "lightning": "5.10.1",
+    "invoices": "2.0.6",
+    "lightning": "5.13.0",
     "macaroon": "3.0.4",
     "morgan": "1.10.0",
     "ws": "8.5.0"
@@ -28,7 +28,7 @@
     "bn.js": "5.2.0",
     "bs58check": "2.1.2",
     "ecpair": "2.0.1",
-    "ln-docker-daemons": "2.2.7",
+    "ln-docker-daemons": "2.2.9",
     "p2tr": "1.3.1",
     "portfinder": "1.0.28",
     "psbt": "2.0.1",
@@ -57,6 +57,7 @@
   },
   "scripts": {
     "integration-test-daily-lnd-build": "DOCKER_LND_VERSION=daily-testing-only npm run test",
+    "integration-test-0.14.3": "DOCKER_LND_VERSION=v0.14.3-beta npm run test",
     "integration-test-0.14.2": "DOCKER_LND_VERSION=v0.14.2-beta npm run test",
     "integration-test-0.14.1": "DOCKER_LND_VERSION=v0.14.1-beta npm run test",
     "integration-test-0.14.0": "DOCKER_LND_VERSION=v0.14.0-beta npm run test",
@@ -67,7 +68,7 @@
     "integration-test-0.13.0": "DOCKER_LND_VERSION=v0.13.0-beta npm run test",
     "integration-test-0.12.1": "DOCKER_LND_VERSION=v0.12.1-beta npm run test",
     "integration-test-0.12.0": "DOCKER_LND_VERSION=v0.12.0-beta npm run test",
-    "test": "echo $DOCKER_LND_VERSION && tap -j 2 --branches=1 --functions=1 --lines=1 --statements=1 -t 200 test/autopilotrpc-integration/*.js test/chainrpc-integration/*.js test/integration/*.js test/invoicesrpc-integration/*.js test/routerrpc-integration/*.js test/signerrpc-integration/*.js test/tower_clientrpc-integration/*.js test/tower_serverrpc-integration/*.js test/walletrpc-integration/*.js"
+    "test": "echo $DOCKER_LND_VERSION && tap -j 2 --branches=1 --functions=1 --lines=1 --statements=1 -t 200 test/autopilotrpc-integration/*.js test/chainrpc-integration/*.js test/integration/*.js test/invoicesrpc-integration/*.js test/peersrpc-integration/*.js test/routerrpc-integration/*.js test/signerrpc-integration/*.js test/tower_clientrpc-integration/*.js test/tower_serverrpc-integration/*.js test/walletrpc-integration/*.js"
   },
-  "version": "53.11.0"
+  "version": "53.14.0"
 }

package/test/peersrpc-integration/test_add_external_socket.js

@@ -0,0 +1,34 @@
+const {spawnLightningCluster} = require('ln-docker-daemons');
+const {test} = require('@alexbosworth/tap');
+
+const {addExternalSocket} = require('./../../');
+const {getWalletInfo} = require('./../../');
+
+const socket = '192.168.0.1:12345';
+
+// Adding a node socket should result in an updated advertised socket
+test(`Add external socket`, async ({end, strictSame}) => {
+  const {kill, nodes} = await spawnLightningCluster({});
+
+  const [{id, lnd}] = nodes;
+
+  const additional = `${id}@${socket}`;
+
+  try {
+    const {uris} = await getWalletInfo({lnd});
+
+    const [existing] = uris;
+
+    await addExternalSocket({lnd, socket});
+
+    const updated = await getWalletInfo({lnd});
+
+    strictSame(updated.uris, [existing, additional], 'Added new socket');
+  } catch (err) {
+    strictSame(err, [400, 'ExpectedPeersRpcLndBuildTagToAddSocket']);
+  }
+
+  await kill({});
+
+  return end();
+});

package/test/peersrpc-integration/test_remove_external_socket.js

@@ -0,0 +1,32 @@
+const {spawnLightningCluster} = require('ln-docker-daemons');
+const {test} = require('@alexbosworth/tap');
+
+const {getWalletInfo} = require('./../../');
+const {removeExternalSocket} = require('./../../');
+
+// Removign a node socket should result in a no longer advertised socket
+test(`Add external socket`, async ({end, strictSame}) => {
+  const {kill, nodes} = await spawnLightningCluster({});
+
+  const [{id, lnd}] = nodes;
+
+  try {
+    const {uris} = await getWalletInfo({lnd});
+
+    const [uri] = uris;
+
+    const [, socket] = uri.split('@');
+
+    await removeExternalSocket({lnd, socket});
+
+    const updated = await getWalletInfo({lnd});
+
+    strictSame(updated.uris, [], 'External socket removed');
+  } catch (err) {
+    strictSame(err, [400, 'ExpectedPeersRpcLndBuildTagToRemoveSocket']);
+  }
+
+  await kill({});
+
+  return end();
+});

package/test/peersrpc-integration/test_update_alias.js

@@ -0,0 +1,31 @@
+const {spawnLightningCluster} = require('ln-docker-daemons');
+const {test} = require('@alexbosworth/tap');
+
+const {getWalletInfo} = require('./../../');
+const {updateAlias} = require('./../../');
+
+const alias = 'alias';
+
+// Updating a node alias should result in an updated alias
+test(`Update alias`, async ({end, strictSame}) => {
+  const {kill, nodes} = await spawnLightningCluster({});
+
+  const [{lnd}] = nodes;
+
+  try {
+    const {color} = await getWalletInfo({lnd});
+
+    await updateAlias({alias, lnd});
+
+    const updated = await getWalletInfo({lnd});
+
+    strictSame(updated.alias, alias, 'Alias was updated');
+    strictSame(updated.color, color, 'Color was not updated');
+  } catch (err) {
+    strictSame(err, [400, 'ExpectedPeersRpcLndBuildTagToUpdateAlias']);
+  }
+
+  await kill({});
+
+  return end();
+});

package/test/peersrpc-integration/test_update_color.js

@@ -0,0 +1,31 @@
+const {spawnLightningCluster} = require('ln-docker-daemons');
+const {test} = require('@alexbosworth/tap');
+
+const {getWalletInfo} = require('./../../');
+const {updateColor} = require('./../../');
+
+const color = '#666666'
+
+// Updating a node color should result in an updated color
+test(`Update color`, async ({end, strictSame}) => {
+  const {kill, nodes} = await spawnLightningCluster({});
+
+  const [{lnd}] = nodes;
+
+  try {
+    const {alias} = await getWalletInfo({lnd});
+
+    await updateColor({color, lnd});
+
+    const updated = await getWalletInfo({lnd});
+
+    strictSame(updated.alias, alias, 'Alias was not updated');
+    strictSame(updated.color, color, 'Color was updated');
+  } catch (err) {
+    strictSame(err, [400, 'ExpectedPeersRpcLndBuildTagToUpdateColor']);
+  }
+
+  await kill({});
+
+  return end();
+});