ln-service 53.11.0 → 53.12.0

package/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Versions
 
+## 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

@@ -249,8 +249,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,8 +273,8 @@ 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
@@ -3537,7 +3539,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>
@@ -6571,6 +6573,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 +6627,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

@@ -129,7 +129,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');
@@ -271,7 +273,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.11.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.8",
     "p2tr": "1.3.1",
     "portfinder": "1.0.28",
     "psbt": "2.0.1",
@@ -67,7 +67,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.12.0"
 }

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