ln-service 53.9.4 → 53.12.0

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # 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
+- `signTransaction`: Add `spending` attribute for specifying external inputs
+
+## 53.10.0
+
+- `createChainAddress`: Add support for creating P2TR addresses
+- `getUtxos`: Add support for showing P2TR address types
+
 ## 53.9.4
 
 - `getPendingPayments`: Add method to get payments in flight

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
@@ -514,12 +516,19 @@ Create a new receive address.
 
 Requires `address:write` permission
 
+LND 0.14.3 and below do not support p2tr addresses
+
     {
-      [format]: <Receive Address Type String> // "np2wpkh" || "p2wpkh"
+      [format]: <Receive Address Type String> // "np2wpkh" || "p2tr" || "p2wpkh"
       [is_unused]: <Get As-Yet Unused Address Bool>
       lnd: <Authenticated LND API Object>
     }
 
+    @returns via cbk or Promise
+    {
+      address: <Chain Address String>
+    }
+
 Example:
 
 ```node
@@ -3530,7 +3539,7 @@ Requires `onchain:write` permission
 
 Requires LND built with `walletrpc` tag
 
-This method is not supported in LND 0.14.2 and below
+This method is not supported in LND 0.14.1 and below
 
     {
       lnd: <Authenticated LND API Object>
@@ -4614,10 +4623,14 @@ const {transaction} = await signPsbt({lnd, psbt});
 
 Sign transaction
 
-Requires LND built with `signerrpc` build tag
+`spending` is required for non-internal inputs for a Taproot signature
+
+Requires LND built with `signrpc` build tag
 
 Requires `signer:generate` permission
 
+`spending` is not supported in LND 0.14.3 and below
+
     {
       inputs: [{
         key_family: <Key Family Number>
@@ -4629,14 +4642,13 @@ Requires `signer:generate` permission
         witness_script: <Witness Script Hex String>
       }]
       lnd: <Authenticated LND API Object>
+      [spending]: [{
+        output_script: <Non-Internal Spend Output Script Hex String>
+        output_tokens: <Non-Internal Spend Output Tokens Number>
+      }]
       transaction: <Unsigned Transaction Hex String>
     }
 
-    @returns via cbk or Promise
-    {
-      signatures: [<Signature Hex String>]
-    }
-
 Example:
 
 ```node
@@ -4783,10 +4795,15 @@ Subscribe to confirmations of a spend
 
 A chain address or raw output script is required
 
+When specifying a P2TR output script, `transaction_id` and `transaction_vout`
+are required.
+
 Requires LND built with `chainrpc` build tag
 
 Requires `onchain:read` permission
 
+Subscribing to P2TR outputs is not supported in LND 0.14.3 and below
+
     {
       [bech32_address]: <Bech32 P2WPKH or P2WSH Address String>
       lnd: <Authenticated LND API Object>
@@ -6556,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
@@ -6584,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

@@ -7,11 +7,11 @@
     "url": "https://github.com/alexbosworth/ln-service/issues"
   },
   "dependencies": {
-    "bolt07": "1.8.0",
+    "bolt07": "1.8.1",
     "cors": "2.8.5",
     "express": "4.17.3",
-    "invoices": "2.0.4",
-    "lightning": "5.8.6",
+    "invoices": "2.0.6",
+    "lightning": "5.11.0",
     "macaroon": "3.0.4",
     "morgan": "1.10.0",
     "ws": "8.5.0"
@@ -21,17 +21,17 @@
     "@alexbosworth/tap": "15.0.11",
     "@alexbosworth/node-fetch": "2.6.2",
     "async": "3.2.3",
-    "asyncjs-util": "1.2.8",
+    "asyncjs-util": "1.2.9",
     "bip32": "3.0.1",
     "bip66": "1.1.5",
     "bitcoinjs-lib": "6.0.1",
     "bn.js": "5.2.0",
     "bs58check": "2.1.2",
     "ecpair": "2.0.1",
-    "ln-docker-daemons": "2.2.5",
-    "p2tr": "1.3.0",
+    "ln-docker-daemons": "2.2.8",
+    "p2tr": "1.3.1",
     "portfinder": "1.0.28",
-    "psbt": "2.0.0",
+    "psbt": "2.0.1",
     "rimraf": "3.0.2",
     "secp256k1": "4.0.3",
     "tiny-secp256k1": "2.2.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.9.4"
+  "version": "53.12.0"
 }

package/test/chainrpc-integration/test_subscribe_to_blocks.js

@@ -10,7 +10,6 @@ const {delay} = require('./../macros');
 const {generateBlocks} = require('./../macros');
 const {getHeight} = require('./../../');
 const {getChainBalance} = require('./../../');
-const {spawnLnd} = require('./../macros');
 const {subscribeToBlocks} = require('./../../');
 const {waitForTermination} = require('./../macros');
 

package/test/chainrpc-integration/test_subscribe_to_chain_address.js

@@ -11,7 +11,6 @@ const {getChainTransactions} = require('./../../');
 const {getHeight} = require('./../../');
 const {mineTransaction} = require('./../macros');
 const {sendToChainAddress} = require('./../../');
-const {spawnLnd} = require('./../macros');
 const {subscribeToChainAddress} = require('./../../');
 const {waitForTermination} = require('./../macros');
 

package/test/integration/test_create_chain_address.js

@@ -7,6 +7,7 @@ const {createChainAddress} = require('./../../');
 const formats = ['np2wpkh', 'p2wpkh'];
 const p2shAddressVersion = 196;
 const pkHashByteLength = 20;
+const prefixForV1 = 'bcrt1p';
 const regtestBech32AddressHrp = 'bcrt';
 
 // Creating addresses should result in addresses
@@ -34,6 +35,14 @@ test(`Create address results in address creation`, async ({end, equal}) => {
   equal(np2wpkh.address, unusedNp2wpkh.address, 'Nested is reused');
   equal(p2wpkh.address, unusedP2wpkh.address, 'Native is reused');
 
+  try {
+    const {address} = await createChainAddress({lnd, format: 'p2tr'});
+
+    equal(address.startsWith(prefixForV1), true, 'A taproot address is made');
+  } catch (err) {
+    // LND 0.14.3 and below do not support TR addresses
+  }
+
   await kill({});
 
   return end();

package/test/integration/test_get_pending_force.js

@@ -178,7 +178,7 @@ test(`Get pending channels`, async ({end, equal}) => {
   equal(forceClose.received, 0, 'No receive amount');
   equal(forceClose.recovered_tokens, undefined, 'No recovered amount');
 
-  // LND 0.14.2 and below do not support remote balance info
+  // LND 0.14.3 and below do not support remote balance info
   if (!!forceClose.remote_balance) {
     equal(forceClose.remote_balance, giftTokens, 'Got gift remote balance');
   } else {

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