ln-service 52.12.0 → 52.14.1

package/CHANGELOG.md

@@ -1,6 +1,16 @@
 # Versions
 
-## 52.12.0
+## 52.14.1
+
+- `probeForRoute`, `subscribeToProbeForRoute`, `subscribeToPayViaRoutes`,
+    `payViaRoutes`: When probing (no hash), delete the payment failure record after the probe
+
+## 52.13.0
+
+- Add method `sendMessageToPeer` to send a custom peer message
+- Add method `subscribeToPeerMessages` to be notified on custom peer messages
+
+## 52.12.1
 
 - `getFailedPayments`: Add method to get payments that failed
 

package/README.md

@@ -191,38 +191,40 @@ for `unlocker` methods.
 - [recoverFundsFromChannels](#recoverFundsFromChannels) - Restore all channels
 - [removePeer](#removePeer) - Disconnect from a connected peer
 - [requestChainFeeIncrease](#requestchainfeeincrease) - Request a CPFP spend on a UTXO
-- [restrictMacaroon](#restrictMacaroon) - Add limitations to a macaroon
-- [revokeAccess](#revokeAccess) - Revoke all access macaroons given to an id
-- [routeFromChannels](#routeFromChannels) - Convert channel series to a route
-- [sendToChainAddress](#sendToChainAddress) - Send on-chain to an address
-- [sendToChainAddresses](#sendToChainAddresses) - Send on-chain to addresses
+- [restrictMacaroon](#restrictmacaroon) - Add limitations to a macaroon
+- [revokeAccess](#revokeaccess) - Revoke all access macaroons given to an id
+- [routeFromChannels](#routefromchannels) - Convert channel series to a route
+- [sendMessageToPeer](#sendmessagetopeer) - Send a custom message to a peer
+- [sendToChainAddress](#sendtochainaddress) - Send on-chain to an address
+- [sendToChainAddresses](#sendtochainaddresses) - Send on-chain to addresses
 - [sendToChainOutputScripts](#sendtochainoutputscripts) - Send to on-chain script outputs
-- [setAutopilot](#setAutopilot) - Turn autopilot on and set autopilot scores
-- [settleHodlInvoice](#settleHodlInvoice) - Accept a HODL HTLC invoice
-- [signBytes](#signBytes) -  Sign over arbitrary bytes with node keys
-- [signMessage](#signMessage) - Sign a message with the node identity key
-- [signPsbt](#signPsbt) - Sign and finalize an unsigned PSBT using internal keys
-- [signTransaction](#signTransaction) - Sign an on-chain transaction
-- [stopDaemon](#stopDaemon) - Stop lnd
-- [subscribeToBackups](#subscribeToBackups) - Subscribe to channel backups
-- [subscribeToBlocks](#subscribeToBlocks) - Subscribe to on-chain blocks
-- [subscribeToChainAddress](#subscribeToChainAddress) - Subscribe to receives
-- [subscribeToChainSpend](#subscribeToChainSpend) - Subscribe to chain spends
-- [subscribeToChannels](#subscribeToChannels) - Subscribe to channel statuses
-- [subscribeToForwardRequests](#subscribeToForwardRequests) - Interactive route 
-- [subscribeToForwards](#subscribeToForwards) - Subscribe to HTLC events
-- [subscribeToGraph](#subscribeToGraph) - Subscribe to network graph updates
-- [subscribeToInvoice](#subscribeToInvoice) - Subscribe to invoice updates
-- [subscribeToInvoices](#subscribeToInvoices) - Subscribe to all invoices
-- [subscribeToOpenRequests](#subscribeToOpenRequests) - Approve open requests
-- [subscribeToPastPayment](#subscribeToPastPayment) - Subscribe to a payment
+- [setAutopilot](#setautopilot) - Turn autopilot on and set autopilot scores
+- [settleHodlInvoice](#settlehodlinvoice) - Accept a HODL HTLC invoice
+- [signBytes](#signbytes) -  Sign over arbitrary bytes with node keys
+- [signMessage](#signmessage) - Sign a message with the node identity key
+- [signPsbt](#signpsbt) - Sign and finalize an unsigned PSBT using internal keys
+- [signTransaction](#signtransaction) - Sign an on-chain transaction
+- [stopDaemon](#stopdaemon) - Stop lnd
+- [subscribeToBackups](#subscribetobackups) - Subscribe to channel backups
+- [subscribeToBlocks](#subscribetoblocks) - Subscribe to on-chain blocks
+- [subscribeToChainAddress](#subscribetochainaddress) - Subscribe to receives
+- [subscribeToChainSpend](#subscribetochainspend) - Subscribe to chain spends
+- [subscribeToChannels](#subscribetochannels) - Subscribe to channel statuses
+- [subscribeToForwardRequests](#subscribetoforwardrequests) - Interactively route
+- [subscribeToForwards](#subscribetoforwards) - Subscribe to HTLC events
+- [subscribeToGraph](#subscribetograph) - Subscribe to network graph updates
+- [subscribeToInvoice](#subscribetoinvoice) - Subscribe to invoice updates
+- [subscribeToInvoices](#subscribetoinvoices) - Subscribe to all invoices
+- [subscribeToOpenRequests](#subscribetoopenrequests) - Approve open requests
+- [subscribeToPastPayment](#subscribetopastpayment) - Subscribe to a payment
 - [subscribeToPastPayments](#subscribetopastpayments) - Subscribe to all sent payments
-- [subscribeToPayViaDetails](#subscribeToPayViaDetails) - Pay using details
-- [subscribeToPayViaRequest](#subscribeToPayViaRequest) - Pay using a request
-- [subscribeToPayViaRoutes](#subscribeToPayViaRoutes) - Pay using routes
-- [subscribeToPeers](#subscribeToPeers) - Subscribe to peers connectivity
-- [subscribeToProbe](#subscribeToProbe) - Subscribe to a probe for a route
-- [subscribeToProbeForRoute](#subscribeToProbeForRoute) - Probe for a route
+- [subscribeToPayViaDetails](#subscribetopayviadetails) - Pay using details
+- [subscribeToPayViaRequest](#subscribetopayviarequest) - Pay using a request
+- [subscribeToPayViaRoutes](#subscribetopayviaroutes) - Pay using routes
+- [subscribeToPeerMessages](#subscribetopeermessages) - Listen to incoming custom messages
+- [subscribeToPeers](#subscribetopeers) - Subscribe to peers connectivity
+- [subscribeToProbe](#subscribetoprobe) - Subscribe to a probe for a route
+- [subscribeToProbeForRoute](#subscribetoprobeforroute) - Probe for a route
 - [subscribeToRpcRequests](#subscribetorpcrequests) - Subscribe to rpc requests
 - [subscribeToTransactions](#subscribetotransactions) - Subscribe to chain tx
 - [subscribeToWalletStatus](#subscribetowalletstatus) - Subscribe to node state
@@ -4056,6 +4058,39 @@ const res = routeFromChannels({channels, destination, height, mtokens});
 const {route} = res;
 ```
 
+### sendMessageToPeer
+
+Send a custom message to a connected peer
+
+If specified, message type is expected to be between 32768 and 65535
+
+Message data should not be larger than 65533 bytes
+
+Note: this method is not supported in LND versions 0.13.3 and below
+
+Requires `offchain:write` permission
+
+    {
+      lnd: <Authenticated LND API Object>
+      message: <Message Hex String>
+      public_key: <To Peer Public Key Hex String>
+      [type]: <Message Type Number>
+    }
+
+    @returns via cbk or Promise
+
+Example:
+
+```node
+const {sendMessageToPeer} = require('ln-service');
+
+await sendMessageToPeer({
+  lnd,
+  message: Buffer.from('Hello world').toString('hex'),
+  public_key: peerPublicKeyHex,
+});
+```
+
 ### sendToChainAddress
 
 Send tokens in a blockchain transaction.
@@ -5564,6 +5599,42 @@ const sub = subscribeToPayViaRoutes({lnd, routes: [route]});
 const [success] = await once(sub, 'success');
 ```
 
+### subscribeToPeerMessages
+
+Subscribe to incoming peer messages
+
+Requires `offchain:read` permission
+
+This method is not supported in LND 0.13.3 and below
+
+    {
+      lnd: <Authenticated LND API Object>
+    }
+
+    @returns
+    <EventEmitter Object>
+
+    // A message was received from a peer
+    @event 'message_received'
+    {
+      message: <Message Hex String>
+      public_key: <From Peer Public Key Hex String>
+      type: <Message Type Number>
+    }
+
+Example
+
+```node
+const {subscribeToPeerMessages} = require('ln-service');
+
+const sub = subscribeToPeerMessages({lnd});
+
+const messages = [];
+
+// Collect peer custom messages
+sub.on('message_received', received => messages.push(received.message));
+```
+
 ### subscribeToPeers
 
 Subscribe to peer connectivity events

package/index.js

@@ -38,7 +38,7 @@ const {getChannelBalance} = require('lightning');
 const {getChannels} = require('lightning');
 const {getClosedChannels} = require('lightning');
 const {getConnectedWatchtowers} = require('lightning');
-const {getFailedPayments} = require('lightning/lnd_methods');
+const {getFailedPayments} = require('lightning');
 const {getFeeRates} = require('lightning');
 const {getForwardingConfidence} = require('lightning');
 const {getForwardingReputations} = require('lightning');
@@ -78,7 +78,7 @@ const {parsePaymentRequest} = require('invoices');
 const {pay} = require('lightning');
 const {payViaPaymentDetails} = require('lightning');
 const {payViaPaymentRequest} = require('lightning');
-const {payViaRoutes} = require('lightning/lnd_methods');
+const {payViaRoutes} = require('lightning');
 const {prepareForChannelProposal} =  require('lightning');
 const {probeForRoute} = require('lightning');
 const {proposeChannel} = require('lightning');
@@ -89,6 +89,7 @@ const {requestChainFeeIncrease} = require('lightning');
 const {restrictMacaroon} = require('./macaroons');
 const {revokeAccess} = require('lightning');
 const {routeFromChannels} = require('bolt07');
+const {sendMessageToPeer} = require('lightning/lnd_methods');
 const {sendToChainAddress} = require('lightning');
 const {sendToChainAddresses} = require('lightning');
 const {sendToChainOutputScripts} = require('lightning');
@@ -115,9 +116,10 @@ const {subscribeToPastPayments} = require('lightning');
 const {subscribeToPayViaDetails} = require('lightning');
 const {subscribeToPayViaRequest} = require('lightning');
 const {subscribeToPayViaRoutes} = require('lightning');
+const {subscribeToPeerMessages} = require('lightning/lnd_methods');
 const {subscribeToPeers} = require('lightning');
 const {subscribeToProbeForRoute} = require('lightning');
-const {subscribeToRpcRequests} = require('lightning/lnd_methods');
+const {subscribeToRpcRequests} = require('lightning');
 const {subscribeToTransactions} = require('lightning');
 const {subscribeToWalletStatus} = require('lightning');
 const {unauthenticatedLndGrpc} = require('lightning');
@@ -225,6 +227,7 @@ module.exports = {
   restrictMacaroon,
   revokeAccess,
   routeFromChannels,
+  sendMessageToPeer,
   sendToChainAddress,
   sendToChainAddresses,
   sendToChainOutputScripts,
@@ -251,6 +254,7 @@ module.exports = {
   subscribeToPayViaDetails,
   subscribeToPayViaRequest,
   subscribeToPayViaRoutes,
+  subscribeToPeerMessages,
   subscribeToPeers,
   subscribeToProbeForRoute,
   subscribeToRpcRequests,

package/package.json

@@ -7,11 +7,11 @@
     "url": "https://github.com/alexbosworth/ln-service/issues"
   },
   "dependencies": {
-    "bolt07": "1.7.3",
+    "bolt07": "1.7.4",
     "cors": "2.8.5",
     "express": "4.17.1",
     "invoices": "2.0.0",
-    "lightning": "4.10.5",
+    "lightning": "4.12.1",
     "macaroon": "3.0.4",
     "morgan": "1.10.0",
     "ws": "8.2.3"
@@ -20,7 +20,7 @@
   "devDependencies": {
     "@alexbosworth/tap": "15.0.10",
     "@alexbosworth/node-fetch": "2.6.2",
-    "async": "3.2.1",
+    "async": "3.2.2",
     "asyncjs-util": "1.2.6",
     "bip66": "1.1.5",
     "bitcoinjs-lib": "5.2.0",
@@ -61,5 +61,5 @@
     "tower_server-integration-tests": "tap --no-coverage test/tower_serverrpc-integration/*.js",
     "wallet-integration-tests": "tap --no-coverage test/walletrpc-integration/*.js"
   },
-  "version": "52.12.0"
+  "version": "52.14.1"
 }

package/test/integration/test_get_failed_payments.js

@@ -9,8 +9,7 @@ const {deleteForwardingReputations} = require('./../../');
 const {getFailedPayments} = require('./../../');
 const {getPayment} = require('./../../');
 const {getPayments} = require('./../../');
-const {payViaRoutes} = require('./../../');
-const {probeForRoute} = require('./../../');
+const {pay} = require('./../../');
 const {sendToChainAddress} = require('./../../');
 const {setupChannel} = require('./../macros');
 
@@ -59,21 +58,16 @@ test('Get failed payments', async ({end, equal, strictSame}) => {
 
   const invoice = await createInvoice({tokens, lnd: cluster.remote.lnd});
 
+  const bigInvoice = await createInvoice({
+    tokens: (channelCapacityTokens / 2) + (channelCapacityTokens / 4),
+    lnd: cluster.remote.lnd,
+  });
+
   await delay(1000);
 
   try {
-    await probeForRoute({
-      lnd,
-      destination: cluster.remote_node_public_key,
-      is_ignoring_past_failures: true,
-      tokens: invoice.tokens,
-    });
+    await pay({lnd, request: bigInvoice.request});
   } catch (err) {
-    const [code, message, {failure}] = err;
-
-    equal(code, 503, 'Failed to find route');
-    equal(message, 'RoutingFailure', 'Hit a routing failure');
-    equal(failure.reason, 'TemporaryChannelFailure', 'Temporary failure');
   }
 
   // Create a new channel to increase total edge liquidity
@@ -88,32 +82,7 @@ test('Get failed payments', async ({end, equal, strictSame}) => {
   await deleteForwardingReputations({lnd});
 
   try {
-    const {route} = await probeForRoute({
-      lnd,
-      destination: cluster.remote.public_key,
-      payment: invoice.payment,
-      tokens: invoice.tokens,
-      total_mtokens: !!invoice.payment ? invoice.mtokens : undefined,
-    });
-
-    if (!route) {
-      throw new Error('ExpectedRouteFromProbe');
-    }
-
-    equal(route.fee, 1, 'Found route fee');
-    equal(route.fee_mtokens, '1500', 'Found route fee mtokens');
-    strictSame(route.hops.length, 2, 'Found route hops returned');
-    equal(route.mtokens, '500001500', 'Found route mtokens');
-    equal(route.timeout, 586, 'Found route timeout');
-    equal(route.tokens, 500001, 'Found route tokens');
-
-    const {secret} = await payViaRoutes({
-      lnd,
-      id: invoice.id,
-      routes: [route],
-    });
-
-    equal(secret, invoice.secret, 'Route works');
+    const {secret} = await pay({lnd, request: invoice.request});
   } catch (err) {
     equal(err, null, 'No error when probing for route');
   }
@@ -128,17 +97,16 @@ test('Get failed payments', async ({end, equal, strictSame}) => {
     equal(!!payment.created_at, true, 'Got payment created date');
     equal(payment.fee, undefined, 'No fee when not paid');
     equal(payment.fee_mtokens, undefined, 'No fee mtokens when not paid');
-    strictSame(payment.hops, [cluster.target.public_key], 'Got hops');
     equal(!!payment.id, true, 'Got a payment id');
     equal(!!payment.index, true, 'Got payment index');
     equal(payment.is_confirmed, false, 'Failed payment is not confirmed');
     equal(payment.is_outgoing, true, 'Failed payment is outgoing');
-    equal(payment.mtokens, invoice.mtokens, 'Payment has mtokens');
-    equal(payment.request, undefined, 'Probe has no request');
+    equal(payment.mtokens, bigInvoice.mtokens, 'Payment has mtokens');
+    equal(payment.request, bigInvoice.request, 'Probe has a request');
     equal(payment.secret, undefined, 'Failed has no secret');
     equal(payment.safe_fee, undefined, 'Failed has no fee');
-    equal(payment.safe_tokens, invoice.tokens, 'Failed has safe tokens');
-    equal(payment.tokens, invoice.tokens, 'Failed has tokens');
+    equal(payment.safe_tokens, bigInvoice.tokens, 'Failed has safe tokens');
+    equal(payment.tokens, bigInvoice.tokens, 'Failed has tokens');
 
     const gotFailed = await getPayment({lnd, id: payment.id});
 
@@ -147,9 +115,9 @@ test('Get failed payments', async ({end, equal, strictSame}) => {
       {
         failed: {
           is_insufficient_balance: false,
-          is_invalid_payment: true,
+          is_invalid_payment: false,
           is_pathfinding_timeout: false,
-          is_route_not_found: false,
+          is_route_not_found: true,
         },
         is_confirmed: false,
         is_failed: true,
@@ -176,7 +144,7 @@ test('Get failed payments', async ({end, equal, strictSame}) => {
     equal(payment.is_confirmed, true, 'Failed payment is not confirmed');
     equal(payment.is_outgoing, true, 'Failed payment is outgoing');
     equal(payment.mtokens, invoice.mtokens, 'Payment has mtokens');
-    equal(payment.request, undefined, 'Probed payment has no request');
+    equal(payment.request, invoice.request, 'Payment has a request');
     equal(!!payment.secret, true, 'Failed has no secret');
     equal(payment.safe_fee, 2, 'Failed has no fee');
     equal(payment.safe_tokens, invoice.tokens, 'Failed has safe tokens');

package/test/integration/test_send_message_to_peer.js

@@ -0,0 +1,65 @@
+const asyncRetry = require('async/retry');
+const {test} = require('@alexbosworth/tap');
+
+const {createCluster} = require('./../macros');
+const {sendMessageToPeer} = require('./../../');
+const {subscribeToPeerMessages} = require('./../../');
+
+const interval = 10;
+const times = 1000;
+
+// Sending a message to a peer should result in the message received
+test(`Send peer message`, async ({end, equal, strictSame}) => {
+  const cluster = await createCluster({is_remote_skipped: true});
+
+  const {lnd} = cluster.control;
+
+  try {
+    await sendMessageToPeer({
+      lnd,
+      message: Buffer.from('message').toString('hex'),
+      public_key: cluster.target.public_key,
+    });
+  } catch (err) {
+    const [code] = err;
+
+    // Send message to peer is not supported on LND 0.13.3 or lower
+    if (code === 501) {
+      await cluster.kill({});
+
+      return end();
+    }
+  }
+
+  const sub = subscribeToPeerMessages({lnd: cluster.target.lnd});
+
+  const messages = [];
+
+  sub.on('message_received', message => messages.push(message));
+
+  await sendMessageToPeer({
+    lnd,
+    message: Buffer.from('message').toString('hex'),
+    public_key: cluster.target.public_key,
+  });
+
+  await asyncRetry({interval, times}, async () => {
+    if (!messages.length) {
+      throw new Error('ExpectedMessage');
+    }
+  });
+
+  strictSame(
+    messages,
+    [{
+      message: Buffer.from('message').toString('hex'),
+      public_key: cluster.control.public_key,
+      type: 32768,
+    }],
+    'Message successfully sent to peer'
+  );
+
+  await cluster.kill({});
+
+  return end();
+});

package/test/integration/test_subscribe_to_peer_messages.js

@@ -0,0 +1,83 @@
+const asyncRetry = require('async/retry');
+const {test} = require('@alexbosworth/tap');
+
+const {createCluster} = require('./../macros');
+const {sendMessageToPeer} = require('./../../');
+const {subscribeToPeerMessages} = require('./../../');
+
+const interval = 10;
+const times = 1000;
+
+// Messages should be received from peers
+test(`Subscribe to peer messages`, async ({end, equal, strictSame}) => {
+  const cluster = await createCluster({});
+
+  const {lnd} = cluster.control;
+
+  try {
+    await sendMessageToPeer({
+      lnd,
+      message: Buffer.from('message').toString('hex'),
+      public_key: cluster.target.public_key,
+    });
+  } catch (err) {
+    const [code] = err;
+
+    // Send message to peer is not supported on LND 0.13.3 or lower
+    if (code === 501) {
+      await cluster.kill({});
+
+      return end();
+    }
+  }
+
+  const targetSub = subscribeToPeerMessages({lnd: cluster.target.lnd});
+  const remoteSub = subscribeToPeerMessages({lnd: cluster.remote.lnd});
+
+  const messages = [];
+
+  remoteSub.on('message_received', message => messages.push(message));
+
+  targetSub.on('message_received', async ({message, type}) => {
+    if (type !== 40805) {
+      return;
+    }
+
+    // Relay message from control to remote
+    return await sendMessageToPeer({
+      message,
+      type,
+      lnd: cluster.target.lnd,
+      public_key: cluster.remote.public_key,
+    });
+  });
+
+  // Control send a message to target peer
+  await sendMessageToPeer({
+    lnd,
+    message: Buffer.from('message to remote').toString('hex'),
+    public_key: cluster.target.public_key,
+    type: 40805,
+  });
+
+  // Wait for message to appear
+  await asyncRetry({interval, times}, async () => {
+    if (!messages.length) {
+      throw new Error('ExpectedMessage');
+    }
+  });
+
+  strictSame(
+    messages,
+    [{
+      message: Buffer.from('message to remote').toString('hex'),
+      public_key: cluster.target.public_key,
+      type: 40805,
+    }],
+    'Message successfully relayed through target'
+  );
+
+  await cluster.kill({});
+
+  return end();
+});

package/test/routerrpc-integration/test_probe_for_route.js

@@ -6,6 +6,8 @@ const {createCluster} = require('./../macros');
 const {createInvoice} = require('./../../');
 const {delay} = require('./../macros');
 const {deleteForwardingReputations} = require('./../../');
+const {getFailedPayments} = require('./../../');
+const {getWalletVersion} = require('./../../');
 const {payViaRoutes} = require('./../../');
 const {probeForRoute} = require('./../../');
 const {sendToChainAddress} = require('./../../');
@@ -75,6 +77,16 @@ test('Probe for route', async ({end, equal, strictSame}) => {
     equal(failure.reason, 'TemporaryChannelFailure', 'Temporary failure');
   }
 
+  const {version} = await getWalletVersion({lnd});
+
+  const [, minor] = (version || '').split('.');
+
+  if (!version || parseInt(minor) > 13) {
+    const {payments} = await getFailedPayments({lnd});
+
+    strictSame(payments, [], 'Probes do not leave a failed state behind');
+  }
+
   // Create a new channel to increase total edge liquidity
   await setupChannel({
     capacity: channelCapacityTokens,