ln-service 52.15.0 → 52.16.0

package/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Versions
 
+## 52.16.0
+
+- `subscribeToPayViaDetails`, `subscribeToPayViaRequest`: Add `paying`,  and
+    `routing_failure` events to follow in-flight attempts and encountered routing failures
+
 ## 52.15.0
 
 - `getPayment`, `subscribeToPastPayment`: Add `pending` for pending payment details

package/README.md

@@ -5360,7 +5360,61 @@ Requires `offchain:write` permission
     }
 
     @event 'paying'
-    {}
+    {
+      created_at: <Payment Created At ISO 8601 Date String>
+      destination: <Payment Destination Hex String>
+      id: <Payment Hash Hex String>
+      mtokens: <Total Millitokens Pending String>
+      paths: [{
+        fee: <Total Fee Tokens Pending Number>
+        fee_mtokens: <Total Fee Millitokens Pending String>
+        hops: [{
+          channel: <Standard Format Channel Id String>
+          channel_capacity: <Channel Capacity Tokens Number>
+          fee: <Fee Tokens Rounded Down Number>
+          fee_mtokens: <Fee Millitokens String>
+          forward: <Forward Tokens Number>
+          forward_mtokens: <Forward Millitokens String>
+          public_key: <Public Key Hex String>
+          timeout: <Timeout Block Height Number>
+        }]
+        mtokens: <Total Millitokens Pending String>
+        safe_fee: <Total Fee Tokens Pending Rounded Up Number>
+        safe_tokens: <Total Tokens Pending, Rounded Up Number>
+        timeout: <Expiration Block Height Number>
+      }]
+      safe_tokens: <Total Tokens Pending, Rounded Up Number>
+      [timeout]: <Expiration Block Height Number>
+      tokens: <Total Tokens Pending Rounded Down Number>
+    }
+
+    @event 'routing_failure'
+    {
+      [channel]: <Standard Format Channel Id String>
+      index: <Failure Index Number>
+      [mtokens]: <Millitokens String>
+      [public_key]: <Public Key Hex String>
+      reason: <Failure Reason String>
+      route: {
+        fee: <Total Route Fee Tokens To Pay Number>
+        fee_mtokens: <Total Route Fee Millitokens To Pay String>
+        hops: [{
+          channel: <Standard Format Channel Id String>
+          channel_capacity: <Channel Capacity Tokens Number>
+          fee: <Fee Number>
+          fee_mtokens: <Fee Millitokens String>
+          forward: <Forward Tokens Number>
+          forward_mtokens: <Forward Millitokens String>
+          public_key: <Public Key Hex String>
+          timeout: <Timeout Block Height Number>
+        }]
+        mtokens: <Total Route Millitokens String>
+        [payment]: <Payment Identifier Hex String>
+        timeout: <Expiration Block Height Number>
+        tokens: <Total Route Tokens Number>
+        [total_mtokens]: <Total Millitokens String>
+      }
+    }
 
 Example:
 
@@ -5457,7 +5511,61 @@ Requires `offchain:write` permission
     }
 
     @event 'paying'
-    {}
+    {
+      created_at: <Payment Created At ISO 8601 Date String>
+      destination: <Payment Destination Hex String>
+      id: <Payment Hash Hex String>
+      mtokens: <Total Millitokens Pending String>
+      paths: [{
+        fee: <Total Fee Tokens Pending Number>
+        fee_mtokens: <Total Fee Millitokens Pending String>
+        hops: [{
+          channel: <Standard Format Channel Id String>
+          channel_capacity: <Channel Capacity Tokens Number>
+          fee: <Fee Tokens Rounded Down Number>
+          fee_mtokens: <Fee Millitokens String>
+          forward: <Forward Tokens Number>
+          forward_mtokens: <Forward Millitokens String>
+          public_key: <Public Key Hex String>
+          timeout: <Timeout Block Height Number>
+        }]
+        mtokens: <Total Millitokens Pending String>
+        safe_fee: <Total Fee Tokens Pending Rounded Up Number>
+        safe_tokens: <Total Tokens Pending, Rounded Up Number>
+        timeout: <Expiration Block Height Number>
+      }]
+      safe_tokens: <Total Tokens Pending, Rounded Up Number>
+      [timeout]: <Expiration Block Height Number>
+      tokens: <Total Tokens Pending Rounded Down Number>
+    }
+
+    @event 'routing_failure'
+    {
+      [channel]: <Standard Format Channel Id String>
+      index: <Failure Index Number>
+      [mtokens]: <Millitokens String>
+      [public_key]: <Public Key Hex String>
+      reason: <Failure Reason String>
+      route: {
+        fee: <Total Route Fee Tokens To Pay Number>
+        fee_mtokens: <Total Route Fee Millitokens To Pay String>
+        hops: [{
+          channel: <Standard Format Channel Id String>
+          channel_capacity: <Channel Capacity Tokens Number>
+          fee: <Fee Number>
+          fee_mtokens: <Fee Millitokens String>
+          forward: <Forward Tokens Number>
+          forward_mtokens: <Forward Millitokens String>
+          public_key: <Public Key Hex String>
+          timeout: <Timeout Block Height Number>
+        }]
+        mtokens: <Total Route Millitokens String>
+        [payment]: <Payment Identifier Hex String>
+        timeout: <Expiration Block Height Number>
+        tokens: <Total Route Tokens Number>
+        [total_mtokens]: <Total Millitokens String>
+      }
+    }
 
 Example:
 

package/package.json

@@ -10,8 +10,8 @@
     "bolt07": "1.7.4",
     "cors": "2.8.5",
     "express": "4.17.1",
-    "invoices": "2.0.1",
-    "lightning": "4.14.1",
+    "invoices": "2.0.2",
+    "lightning": "4.14.3",
     "macaroon": "3.0.4",
     "morgan": "1.10.0",
     "ws": "8.2.3"
@@ -23,8 +23,9 @@
     "async": "3.2.2",
     "asyncjs-util": "1.2.7",
     "bip66": "1.1.5",
-    "bitcoinjs-lib": "5.2.0",
+    "bitcoinjs-lib": "6.0.0",
     "bn.js": "5.2.0",
+    "ecpair": "1.0.1",
     "portfinder": "1.0.28",
     "psbt": "1.1.10",
     "rimraf": "3.0.2",
@@ -61,5 +62,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.15.0"
+  "version": "52.16.0"
 }

package/test/integration/test_send_message_to_peer.js

@@ -49,13 +49,15 @@ test(`Send peer message`, async ({end, equal, strictSame}) => {
     }
   });
 
+  const [message] = messages;
+
   strictSame(
-    messages,
-    [{
+    message,
+    {
       message: Buffer.from('message').toString('hex'),
       public_key: cluster.control.public_key,
       type: 32768,
-    }],
+    },
     'Message successfully sent to peer'
   );
 

package/test/macros/btcsuite_type_daemon.js

@@ -2,7 +2,7 @@ const {join} = require('path');
 const {spawn} = require('child_process');
 
 const asyncAuto = require('async/auto');
-const {ECPair} = require('bitcoinjs-lib');
+const {ECPair} = require('ecpair');
 const openPortFinder = require('portfinder');
 const {networks} = require('bitcoinjs-lib');
 const {payments} = require('bitcoinjs-lib');

package/test/macros/chain_send_transaction.js

@@ -2,7 +2,7 @@ const {encode} = require('varuint-bitcoin');
 
 const {address} = require('bitcoinjs-lib');
 const {crypto} = require('bitcoinjs-lib');
-const {ECPair} = require('bitcoinjs-lib');
+const {ECPair} = require('ecpair');
 const {networks} = require('bitcoinjs-lib');
 const {payments} = require('bitcoinjs-lib');
 const {script} = require('bitcoinjs-lib');

package/test/macros/change_password.js

@@ -6,7 +6,7 @@ const {spawn} = require('child_process');
 const asyncAuto = require('async/auto');
 const asyncMapSeries = require('async/mapSeries');
 const asyncRetry = require('async/retry');
-const {ECPair} = require('bitcoinjs-lib');
+const {ECPair} = require('ecpair');
 const {networks} = require('bitcoinjs-lib');
 const openPortFinder = require('portfinder');
 

package/test/macros/generate_blocks.js

@@ -2,7 +2,7 @@ const asyncAuto = require('async/auto');
 const asyncMap = require('async/map');
 const asyncTimesSeries = require('async/timesSeries');
 const asyncRetry = require('async/retry');
-const {ECPair} = require('bitcoinjs-lib');
+const {ECPair} = require('ecpair');
 const {networks} = require('bitcoinjs-lib');
 const {payments} = require('bitcoinjs-lib');
 const {returnResult} = require('asyncjs-util');

package/test/macros/spawn_lnd.js

@@ -7,7 +7,7 @@ const asyncAuto = require('async/auto');
 const asyncMap = require('async/map');
 const asyncMapSeries = require('async/mapSeries');
 const asyncRetry = require('async/retry');
-const {ECPair} = require('bitcoinjs-lib');
+const {ECPair} = require('ecpair');
 const {networks} = require('bitcoinjs-lib');
 const openPortFinder = require('portfinder');
 

package/test/routerrpc-integration/test_get_forwarding_reputations.js

@@ -4,8 +4,6 @@ const {test} = require('@alexbosworth/tap');
 const {addPeer} = require('./../../');
 const {createCluster} = require('./../macros');
 const {createInvoice} = require('./../../');
-const {deleteForwardingReputations} = require('./../../');
-const {delay} = require('./../macros');
 const {getChannels} = require('./../../');
 const {getForwardingReputations} = require('./../../');
 const {payViaRoutes} = require('./../../');

package/test/routerrpc-integration/test_subscribe_to_forward_requests.js

@@ -1,3 +1,4 @@
+const {once} = require('events');
 const {test} = require('@alexbosworth/tap');
 
 const {addPeer} = require('./../../');
@@ -10,6 +11,7 @@ const {getPayment} = require('./../../');
 const {getWalletVersion} = require('./../../');
 const {payViaPaymentRequest} = require('./../../');
 const {subscribeToForwardRequests} = require('./../../');
+const {subscribeToPayViaRequest} = require('./../../');
 const {setupChannel} = require('./../macros');
 const {waitForRoute} = require('./../macros');
 
@@ -62,6 +64,67 @@ test(`Pay via payment request`, async ({end, equal, rejects, strictSame}) => {
     );
 
     sub.removeAllListeners();
+
+    await deleteForwardingReputations({lnd});
+
+    const sub2 = subscribeToForwardRequests({lnd: cluster.target.lnd});
+
+    sub2.on('forward_request', forward => forward.reject());
+
+    const failures = [];
+    const paying = [];
+
+    const pay = subscribeToPayViaRequest({lnd, request: invoice.request});
+
+    pay.on('paying', pending => paying.push(pending));
+    pay.on('routing_failure', failure => failures.push(failure));
+
+    await once(pay, 'failed');
+
+    strictSame(
+      failures,
+      [{
+        channel: channel.id,
+        index: 1,
+        mtokens: '101000',
+        public_key: cluster.target.public_key,
+        reason: 'TemporaryChannelFailure',
+        route: {
+          fee: 1,
+          fee_mtokens: '1000',
+          hops: [
+            {
+              channel: channel.id,
+              channel_capacity: 1e6,
+              fee: 1,
+              fee_mtokens: '1000',
+              forward: 100,
+              forward_mtokens: '100000',
+              public_key: cluster.target.public_key,
+              timeout: 497,
+            },
+            {
+              channel: remoteChan.id,
+              channel_capacity: 1e6,
+              fee: 0,
+              fee_mtokens: '0',
+              forward: 100,
+              forward_mtokens: '100000',
+              public_key: cluster.remote.public_key,
+              timeout: 497,
+            },
+          ],
+          mtokens: '101000',
+          payment: invoice.payment,
+          timeout: 537,
+          tokens: 101,
+          total_mtokens: '100000',
+        },
+      }],
+      'Failure is emitted'
+    );
+
+    sub2.removeAllListeners();
   }
 
   await deleteForwardingReputations({lnd});
@@ -126,7 +189,7 @@ test(`Pay via payment request`, async ({end, equal, rejects, strictSame}) => {
       equal(forward.fee_mtokens, '1000', 'Forward has precise routing fee');
       equal(forward.hash, invoice.id, 'Forward has payment hash');
       equal(forward.in_channel, channel.id, 'Forward has inbound channel')
-      equal(forward.in_payment, [invoice].length, 'Forward has payment index');
+      equal(forward.in_payment, 2, 'Forward has payment index');
       equal(forward.messages.length, [].length, 'Forward has no messages');
       equal(forward.mtokens, invoice.mtokens, 'Forward has tokens out');
       equal(forward.out_channel, remoteChan.id, 'Forward has outbound chan');