ln-service 52.14.4 → 52.15.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Versions
 
+## 52.15.0
+
+- `getPayment`, `subscribeToPastPayment`: Add `pending` for pending payment details
+
 ## 52.14.4
 
 - `probeForRoute`, `subscribeToProbeForRoute`, `subscribeToPayViaRoutes`,

package/README.md

@@ -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:
@@ -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:
 

package/package.json

@@ -11,7 +11,7 @@
     "cors": "2.8.5",
     "express": "4.17.1",
     "invoices": "2.0.1",
-    "lightning": "4.13.3",
+    "lightning": "4.14.1",
     "macaroon": "3.0.4",
     "morgan": "1.10.0",
     "ws": "8.2.3"
@@ -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.4"
+  "version": "52.15.0"
 }

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_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/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');