ln-service 53.13.0 → 53.15.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Versions
 
+## 53.15.0
+
+- `getRouteToDestination`, `isDestinationPayable`, `pay`,
+    `payViaPaymentDetails`, `payViaPaymentRequest`, `probeForRoute`,
+    `subscribeToPayViaDetails`, `subscribeToPayViaRequest`,
+    `subscribeToProbeForRoute` - add support for pathfinding `confidence`
+
+## 53.14.1
+
+- `signTransaction`: Fix multi-input signing for upcoming Taproot API changes
+
+## 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

package/README.md

@@ -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
@@ -281,6 +283,32 @@ for `unlocker` 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)
@@ -2903,8 +2931,11 @@ Call this iteratively after failed route attempts to get new routes
 
 Requires `info:read` permission
 
+Preferred `confidence` is not supported on LND 0.14.3 and below
+
     {
       [cltv_delta]: <Final CLTV Delta Number>
+      [confidence]: <Preferred Route Confidence Number Out of One Million Number>
       destination: <Final Send Destination Hex Encoded Public Key String>
       [features]: [{
         bit: <Feature Bit Number>
@@ -3303,8 +3334,11 @@ Determine if a payment destination is actually payable by probing it
 
 Requires `offchain:write` permission
 
+Preferred `confidence` is not supported on LND 0.14.3 and below
+
     {
       [cltv_delta]: <Final CLTV Delta Number>
+      [confidence]: <Preferred Route Confidence Number Out of One Million Number>
       destination: <Pay to Node with Public Key Hex String>
       [incoming_peer]: <Pay Through Specific Final Hop Public Key Hex String>
       lnd: <Authenticated LND API Object>
@@ -3584,7 +3618,10 @@ Requires `offchain:write` permission
 
 `max_path_mtokens` is not supported in LND 0.12.0 or below
 
+Preferred `confidence` is not supported on LND 0.14.3 and below
+
     {
+      [confidence]: <Preferred Route Confidence Number Out of One Million Number>
       [incoming_peer]: <Pay Through Specific Final Hop Public Key Hex String>
       lnd: <Authenticated LND API Object>
       [max_fee]: <Maximum Additional Fee Tokens To Pay Number>
@@ -3671,8 +3708,11 @@ Requires `offchain:write` permission
 
 `max_path_mtokens` is not supported in LND 0.12.0 or below
 
+Preferred `confidence` is not supported on LND 0.14.3 and below
+
     {
       [cltv_delta]: <Final CLTV Delta Number>
+      [confidence]: <Preferred Route Confidence Number Out of One Million Number>
       destination: <Destination Public Key String>
       [features]: [{
         bit: <Feature Bit Number>
@@ -3758,7 +3798,10 @@ Requires `offchain:write` permission
 
 `max_path_mtokens` is not supported in LND 0.12.0 or below
 
+Preferred `confidence` is not supported on LND 0.14.3 and below
+
     {
+      [confidence]: <Preferred Route Confidence Number Out of One Million Number>
       [incoming_peer]: <Pay Through Specific Final Hop Public Key Hex String>
       lnd: <Authenticated LND API Object>
       [max_fee]: <Maximum Fee Tokens To Pay Number>
@@ -3960,8 +4003,11 @@ If `total_mtokens` are specified, a `payment` nonce is required.
 
 Requires `offchain:write` permission
 
+Preferred `confidence` is not supported on LND 0.14.3 and below
+
     {
       [cltv_delta]: <Final CLTV Delta Number>
+      [confidence]: <Preferred Route Confidence Number Out of One Million Number>
       destination: <Destination Public Key Hex String>
       [features]: [{
         bit: <Feature Bit Number>
@@ -4139,6 +4185,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
@@ -5519,8 +5591,11 @@ Requires `offchain:write` permission
 
 `max_path_mtokens` is not supported in LND 0.12.0 or below
 
+Preferred `confidence` is not supported on LND 0.14.3 and below
+
     {
       [cltv_delta]: <Final CLTV Delta Number>
+      [confidence]: <Preferred Route Confidence Number Out of One Million Number>
       destination: <Destination Public Key String>
       [features]: [{
         bit: <Feature Bit Number>
@@ -5682,7 +5757,10 @@ Requires `offchain:write` permission
 
 `max_path_mtokens` is not supported in LND 0.12.0 or below
 
+Preferred `confidence` is not supported on LND 0.14.3 and below
+
     {
+      [confidence]: <Preferred Route Confidence Number Out of One Million Number>
       [incoming_peer]: <Pay Through Specific Final Hop Public Key Hex String>
       lnd: <Authenticated LND API Object>
       [max_fee]: <Maximum Fee Tokens To Pay Number>
@@ -6090,8 +6168,11 @@ Subscribe to a probe attempt
 
 Requires `offchain:write` permission
 
+Preferred `confidence` is not supported on LND 0.14.3 and below
+
     {
       [cltv_delta]: <Final CLTV Delta Number>
+      [confidence]: <Preferred Route Confidence Number Out of One Million Number>
       destination: <Destination Public Key Hex String>
       [features]: [{
         bit: <Feature Bit Number>

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');
@@ -142,6 +144,7 @@ const {verifyBytesSignature} = require('lightning');
 const {verifyMessage} = require('lightning');
 
 module.exports = {
+  addExternalSocket,
   addPeer,
   authenticatedLndGrpc,
   broadcastChainTransaction,
@@ -232,6 +235,7 @@ module.exports = {
   proposeChannel,
   recoverFundsFromChannel,
   recoverFundsFromChannels,
+  removeExternalSocket,
   removePeer,
   requestChainFeeIncrease,
   restrictMacaroon,

package/package.json

@@ -11,7 +11,7 @@
     "cors": "2.8.5",
     "express": "4.17.3",
     "invoices": "2.0.6",
-    "lightning": "5.12.0",
+    "lightning": "5.14.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.8",
+    "ln-docker-daemons": "2.2.9",
     "p2tr": "1.3.1",
     "portfinder": "1.0.28",
     "psbt": "2.0.1",
@@ -70,5 +70,5 @@
     "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/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.13.0"
+  "version": "53.15.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();
+});