ln-service 52.14.1 → 52.15.0

package/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Versions
 
-## 52.14.1
+## 52.15.0
+
+- `getPayment`, `subscribeToPastPayment`: Add `pending` for pending payment details
+
+## 52.14.4
 
 - `probeForRoute`, `subscribeToProbeForRoute`, `subscribeToPayViaRoutes`,
     `payViaRoutes`: When probing (no hash), delete the payment failure record after the probe

package/README.md

@@ -9,7 +9,7 @@ through npm.
 
 Supported LND versions:
 
-- v0.13.0-beta to v0.13.3-beta
+- v0.13.0-beta to v0.13.4-beta
 - v0.12.0-beta to v0.12.1-beta
 - v0.11.0-beta to v0.11.1-beta
 
@@ -806,7 +806,7 @@ Requires `offchain:write` permission
 
 Method not supported on LND 0.12.1 or below
 
-`id` is not supported on LND 0.13.3 or below
+`id` is not supported on LND 0.13.4 or below
 
     {
       [id]: <Delete Only Failed Attempt Records For Payment With Hash Hex String>
@@ -874,7 +874,7 @@ Delete a payment record
 
 Requires `offchain:write` permission
 
-Note: this method is not supported on LND 0.13.3 and below
+Note: this method is not supported on LND 0.13.4 and below
 
     {
       id: <Payment Preimage Hash Hex String>
@@ -2324,6 +2324,30 @@ Requires `offchain:read` permission
         timeout: <Expiration Block Height Number>
         tokens: <Total Tokens Paid Number>
       }
+      [pending]: {
+        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_mtokens: <Total Fee Millitokens Paid 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: <Forwarded Tokens Number>
+            forward_mtokens: <Forward Millitokens String>
+            public_key: <Public Key Hex String>
+            timeout: <Timeout Block Height Number>
+          }]
+          mtokens: <Total Millitokens Pending String>
+        }]
+        [request]: <BOLT 11 Encoded Payment Request String>
+        safe_tokens: <Payment Tokens Rounded Up Number>
+        [timeout]: <Expiration Block Height Number>
+        tokens: <Total Tokens Pending Number>
+      }
     }
 
 Example:
@@ -2908,7 +2932,7 @@ Get wallet status.
 
 This method is not supported on LND 0.12.1 and below
 
-`is_ready` is not supported on LND 0.13.3 and below
+`is_ready` is not supported on LND 0.13.4 and below
 
     {
       lnd: <Unauthenticated LND API Object>
@@ -4066,7 +4090,7 @@ 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
+Note: this method is not supported in LND versions 0.13.4 and below
 
 Requires `offchain:write` permission
 
@@ -4736,7 +4760,7 @@ Subscribe to HTLC events
 
 Requires `offchain:read` permission
 
-Note: LND 0.13.3 and below do not return `secret` for forwards
+Note: LND 0.13.4 and below do not return `secret` for forwards
 
     {
       lnd: <Authenticated LND API Object>
@@ -5138,7 +5162,34 @@ Requires `offchain:read` 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>
+      }]
+      [request]: <BOLT 11 Encoded Payment Request String>
+      safe_tokens: <Total Tokens Pending, Rounded Up Number>
+      [timeout]: <Expiration Block Height Number>
+      tokens: <Total Tokens Pending Rounded Down Number>
+    }
 
 Example:
 
@@ -5156,7 +5207,7 @@ Subscribe to successful outgoing payments
 
 Requires `offchain:read` permission
 
-Note: Method not supported on LND 0.13.3 and below
+Note: Method not supported on LND 0.13.4 and below
 
     {
       lnd: <Authenticated LND API Object>
@@ -5605,7 +5656,7 @@ Subscribe to incoming peer messages
 
 Requires `offchain:read` permission
 
-This method is not supported in LND 0.13.3 and below
+This method is not supported in LND 0.13.4 and below
 
     {
       lnd: <Authenticated LND API Object>
@@ -5851,7 +5902,7 @@ Requires `macaroon:write` permission
 
 LND must be running with "RPC middleware" enabled: `rpcmiddleware.enable=1`
 
-This method is not supported in LND 0.13.3 and below
+This method is not supported in LND 0.13.4 and below
 
     {
       [id]: <RPC Middleware Interception Name String>
@@ -5870,7 +5921,7 @@ This method is not supported in LND 0.13.3 and below
     @event 'close_channel_request'
     {
       accept: ({}, [cbk]) => {}
-      id: <Request Id Number>
+      id: <Message Id Number>
       macaroon: <Base64 Encoded Macaroon String>
       reject: ({message: <Rejection String>}, [cbk]) => {}
       request: {
@@ -5888,7 +5939,7 @@ This method is not supported in LND 0.13.3 and below
     @event 'open_channel_request'
     {
       accept: ({}, [cbk]) => {}
-      id: <Request Id Number>
+      id: <Message Id Number>
       macaroon: <Base64 Encoded Macaroon String>
       reject: ({message: <Rejection String>}, [cbk]) => {}
       request: {
@@ -5909,7 +5960,7 @@ This method is not supported in LND 0.13.3 and below
     @event 'pay_via_route_request'
     {
       accept: ({}, [cbk]) => {}
-      id: <Request Id Number>
+      id: <Message Id Number>
       macaroon: <Base64 Encoded Macaroon String>
       reject: ({message: <Rejection String>}, [cbk]) => {}
       request: {
@@ -5939,14 +5990,16 @@ This method is not supported in LND 0.13.3 and below
 
     @event 'request'
     {
-      id: <Request Id Number>
+      call: <Call Identifier Number>
+      id: <Message Id Number>
       [macaroon]: <Base64 Encoded Macaroon String>
       [uri]: <RPC URI String>
     }
 
     @event 'response'
     {
-      id: <Request Id Number>
+      call: <Call Identifier Number>
+      id: <Message Id Number>
       [macaroon]: <Base64 Encoded Macaroon String>
       [uri]: <RPC URI String>
     }
@@ -6016,7 +6069,7 @@ Subscribe to wallet status events
 
 This method is not supported on LND 0.12.1 and below
 
-`ready` is not supported on LND 0.13.3 and below
+`ready` is not supported on LND 0.13.4 and below
 
     {
       lnd: <Unauthenticated LND API Object>
@@ -6256,7 +6309,7 @@ Setting both `base_fee_tokens` and `base_fee_mtokens` is not supported
 
 Requires `offchain:write` permission
 
-`failures` are not returned on LND 0.13.3 and below
+`failures` are not returned on LND 0.13.4 and below
 
     {
       [base_fee_mtokens]: <Base Fee Millitokens Charged String>
@@ -6293,7 +6346,7 @@ await updateRoutingFees({lnd, fee_rate: 2500});
 
 Verify an access token has a given set of permissions
 
-Note: this method is not supported in LND versions 0.13.3 and below
+Note: this method is not supported in LND versions 0.13.4 and below
 
 Requires `macaroon:read` permission
 

package/package.json

@@ -10,8 +10,8 @@
     "bolt07": "1.7.4",
     "cors": "2.8.5",
     "express": "4.17.1",
-    "invoices": "2.0.0",
-    "lightning": "4.12.1",
+    "invoices": "2.0.1",
+    "lightning": "4.14.1",
     "macaroon": "3.0.4",
     "morgan": "1.10.0",
     "ws": "8.2.3"
@@ -21,7 +21,7 @@
     "@alexbosworth/tap": "15.0.10",
     "@alexbosworth/node-fetch": "2.6.2",
     "async": "3.2.2",
-    "asyncjs-util": "1.2.6",
+    "asyncjs-util": "1.2.7",
     "bip66": "1.1.5",
     "bitcoinjs-lib": "5.2.0",
     "bn.js": "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.14.1"
+  "version": "52.15.0"
 }

package/test/integration/test_delete_payment.js

@@ -33,7 +33,7 @@ test('Delete payment', async ({afterEach, fail, end, equal, strictSame}) => {
 
   const priorLength = (await getPayments({lnd})).payments.length;
 
-  // LND 0.13.3 and below do not support deletePayment
+  // LND 0.13.4 and below do not support deletePayment
   try {
     await deletePayment({lnd, id: invoice.id});
   } catch (err) {

package/test/integration/test_get_failed_payments.js

@@ -123,6 +123,7 @@ test('Get failed payments', async ({end, equal, strictSame}) => {
         is_failed: true,
         is_pending: false,
         payment: undefined,
+        pending: undefined,
       },
       'Got failed state'
     );

package/test/integration/test_get_network_info.js

@@ -15,7 +15,6 @@ test(`Get network info`, async ({end, equal}) => {
   equal(result.max_channel_size, 0, 'Maximum channel size');
   equal(result.median_channel_size, 0, 'Median channel size');
   equal(result.min_channel_size, 0, 'Minimum channel size');
-  equal(result.node_count, 1, 'Node count');
   equal(result.not_recently_updated_policy_count, 0, 'Not updated count');
   equal(result.total_capacity, 0, 'Total capacity');
 

package/test/integration/test_pay_private_invoice.js

@@ -60,7 +60,6 @@ test(`Pay private invoice`, async ({end, equal, strictSame}) => {
     to: cluster.remote,
   });
 
-
   await addPeer({
     lnd,
     public_key: cluster.remote.public_key,

package/test/integration/test_send_message_to_peer.js

@@ -23,7 +23,7 @@ test(`Send peer message`, async ({end, equal, strictSame}) => {
   } catch (err) {
     const [code] = err;
 
-    // Send message to peer is not supported on LND 0.13.3 or lower
+    // Send message to peer is not supported on LND 0.13.4 or lower
     if (code === 501) {
       await cluster.kill({});
 

package/test/integration/test_subscribe_to_peer_messages.js

@@ -23,7 +23,7 @@ test(`Subscribe to peer messages`, async ({end, equal, strictSame}) => {
   } catch (err) {
     const [code] = err;
 
-    // Send message to peer is not supported on LND 0.13.3 or lower
+    // Send message to peer is not supported on LND 0.13.4 or lower
     if (code === 501) {
       await cluster.kill({});
 

package/test/integration/test_subscribe_to_rpc_requests.js

@@ -23,7 +23,7 @@ test(`Subscribe to RPC requests`, async ({end, equal, fail, strictSame}) => {
     }
   })();
 
-  // LND 0.13.3 and below do not support rpc interception
+  // LND 0.13.4 and below do not support rpc interception
   if (!spawned) {
     return end();
   }

package/test/integration/test_update_routing_fees.js

@@ -71,7 +71,7 @@ test(`Update routing fees`, async ({end, equal, strictSame}) => {
     transaction_vout: 1,
   }];
 
-  // Failures is not supported on LND 0.13.3 and below
+  // Failures is not supported on LND 0.13.4 and below
   if (!!failures.length) {
     strictSame(failures, expectedFailures, 'Got expected failures');
   }

package/test/integration/test_verify_access.js

@@ -16,7 +16,7 @@ test(`Verify access`, async ({end, equal, rejects, strictSame}) => {
 
   const {macaroon} = await grantAccess({lnd, permissions});
 
-  // verifyAccess is not supported on LND 0.13.3 and below
+  // verifyAccess is not supported on LND 0.13.4 and below
   try {
     const validity = await verifyAccess({lnd, macaroon, permissions});
 

package/test/invoicesrpc-integration/test_get_sweep_transactions.js

@@ -86,13 +86,18 @@ test(`Get sweep transactions`, async ({end, equal}) => {
   equal(!!transaction.confirmation_count, true, 'Sweep confirm count');
   equal(!!transaction.confirmation_height, true, 'Sweep confirm height');
   equal(!!transaction.created_at, true, 'Sweep creation date');
-  equal(transaction.description, undefined, 'Sweep has description');
   equal(transaction.fee, undefined, 'Sweep fee is undefined');
   equal(transaction.id.length, 64, 'Sweep has transaction id');
   equal(transaction.is_confirmed, true, 'Sweep is confirmed');
   equal(transaction.output_addresses.length, 1, 'Sweep has out address');
   equal(!!transaction.transaction.length, true, 'Sweep has transaction');
 
+  if (!!transaction.description) {
+    equal(transaction.description, '0:sweep', 'Sweep has description');
+  } else {
+    equal(transaction.description, undefined, 'Sweep has description');
+  }
+
   await cluster.kill({});
 
   return end();

package/test/routerrpc-integration/test_subscribe_to_forward_requests.js

@@ -6,6 +6,7 @@ const {createInvoice} = require('./../../');
 const {deleteForwardingReputations} = require('./../../');
 const {getHeight} = require('./../../');
 const {getInvoice} = require('./../../');
+const {getPayment} = require('./../../');
 const {getWalletVersion} = require('./../../');
 const {payViaPaymentRequest} = require('./../../');
 const {subscribeToForwardRequests} = require('./../../');
@@ -15,7 +16,7 @@ const {waitForRoute} = require('./../macros');
 const tokens = 100;
 
 // Paying an invoice should settle the invoice
-test(`Pay via payment request`, async ({end, equal, rejects}) => {
+test(`Pay via payment request`, async ({end, equal, rejects, strictSame}) => {
   const cluster = await createCluster({});
 
   const {lnd} = cluster.control;
@@ -71,6 +72,53 @@ test(`Pay via payment request`, async ({end, equal, rejects}) => {
     const sub = subscribeToForwardRequests({lnd: cluster.target.lnd});
 
     sub.once('forward_request', async forward => {
+      const {pending} = await getPayment({lnd, id: invoice.id});
+
+      equal(pending.destination, cluster.remote.public_key, 'Pending remote');
+      equal(!!pending.created_at, true, 'Has creation date');
+      equal(pending.id, invoice.id, 'Payment id is present');
+      equal(pending.mtokens, invoice.mtokens, 'Pending payment mtokens');
+
+      strictSame(
+        pending.paths,
+        [{
+          fee: 1,
+          fee_mtokens: '1000',
+          hops: [
+            {
+              channel: forward.in_channel,
+              channel_capacity: 1e6,
+              fee: 1,
+              fee_mtokens: '1000',
+              forward: 100,
+              forward_mtokens: '100000',
+              public_key: cluster.target.public_key,
+              timeout: 497,
+            },
+            {
+              channel: forward.out_channel,
+              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',
+        }],
+        'Paths are present'
+      );
+
+      equal(pending.request, invoice.request, 'Pending pay of request');
+      equal(pending.timeout, 537, 'Pending timeout');
+      equal(pending.tokens, invoice.tokens, 'Pending pay of invoice tokens');
+
       const info = await getHeight({lnd: cluster.target.lnd});
 
       equal(forward.cltv_delta, 40, 'Forward has CLTV delta');

package/test/routerrpc-integration/test_subscribe_to_past_payments.js

@@ -54,7 +54,7 @@ test(`Subscribe to past payment`, async ({end, rejects, strictSame}) => {
 
   [sub, sub2].forEach(n => n.removeAllListeners());
 
-  // LND 0.13.3 and below do not support preimages in forward notifications
+  // LND 0.13.4 and below do not support preimages in forward notifications
   if (!!sent && !!sent.secret) {
     strictSame(got, payment, 'Payment subscription notifies of payment');
   }