ln-service 53.8.1 → 53.9.0

package/README.md

@@ -170,6 +170,7 @@ for `unlocker` methods.
 - [getPeers](#getpeers) - Get all connected peers
 - [getPendingChainBalance](#getpendingchainbalance) - Get pending chain balance
 - [getPendingChannels](#getpendingchannels) - Get channels in pending states
+- [getPendingPayments](#getpendingpayments) - Get in-flight outgoing payments
 - [getPublicKey](#getpublickey) - Get a public key out of the seed
 - [getRouteConfidence](#getrouteconfidence) - Get confidence in a route
 - [getRouteThroughHops](#getroutethroughhops) - Get a route through nodes
@@ -2662,6 +2663,98 @@ const {getPendingChannels} = require('ln-service');
 const pendingChannels = (await getPendingChannels({lnd})).pending_channels;
 ```
 
+### getPendingPayments
+
+Get pending payments made through channels.
+
+Requires `offchain:read` permission
+
+    {
+      [limit]: <Page Result Limit Number>
+      lnd: <Authenticated LND API Object>
+      [token]: <Opaque Paging Token String>
+    }
+
+    @returns via cbk or Promise
+    {
+      payments: [{
+        attempts: [{
+          [failure]: {
+            code: <Error Type Code Number>
+            [details]: {
+              [channel]: <Standard Format Channel Id String>
+              [height]: <Error Associated Block Height Number>
+              [index]: <Failed Hop Index Number>
+              [mtokens]: <Error Millitokens String>
+              [policy]: {
+                base_fee_mtokens: <Base Fee Millitokens String>
+                cltv_delta: <Locktime Delta Number>
+                fee_rate: <Fees Charged in Millitokens Per Million Number>
+                [is_disabled]: <Channel is Disabled Bool>
+                max_htlc_mtokens: <Maximum HLTC Millitokens Value String>
+                min_htlc_mtokens: <Minimum HTLC Millitokens Value String>
+                updated_at: <Updated At ISO 8601 Date String>
+              }
+              [timeout_height]: <Error CLTV Timeout Height Number>
+              [update]: {
+                chain: <Chain Id Hex String>
+                channel_flags: <Channel Flags Number>
+                extra_opaque_data: <Extra Opaque Data Hex String>
+                message_flags: <Message Flags Number>
+                signature: <Channel Update Signature Hex String>
+              }
+            }
+            message: <Error Message String>
+          }
+          [index]: <Payment Add Index Number>
+          [confirmed_at]: <Payment Confirmed At ISO 8601 Date String>
+          is_confirmed: <Payment Attempt Succeeded Bool>
+          is_failed: <Payment Attempt Failed Bool>
+          is_pending: <Payment Attempt is Waiting For Resolution Bool>
+          route: {
+            fee: <Route Fee Tokens Number>
+            fee_mtokens: <Route Fee Millitokens 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]: <Forward Edge Public Key Hex String>
+              [timeout]: <Timeout Block Height Number>
+            }]
+            mtokens: <Total Fee-Inclusive Millitokens String>
+            [payment]: <Payment Identifier Hex String>
+            timeout: <Timeout Block Height Number>
+            tokens: <Total Fee-Inclusive Tokens Number>
+            [total_mtokens]: <Total Millitokens String>
+          }
+        }]
+        created_at: <Payment at ISO-8601 Date String>
+        [destination]: <Destination Node Public Key Hex String>
+        id: <Payment Preimage Hash String>
+        [index]: <Payment Add Index Number>
+        is_confirmed: <Payment is Confirmed Bool>
+        is_outgoing: <Transaction Is Outgoing Bool>
+        mtokens: <Millitokens Attempted to Pay to Destination String>
+        [request]: <BOLT 11 Payment Request String>
+        safe_tokens: <Payment Tokens Attempted to Pay Rounded Up Number>
+        tokens: <Rounded Down Tokens Attempted to Pay to Destination Number>
+      }]
+      [next]: <Next Opaque Paging Token String>
+    }
+
+```node
+const {getPendingPayments} = require('ln-service')
+
+const {next, payments} = await getPendingPayments({lnd});
+
+if (!next) {
+  const inFlightPaymentsCount = payments.length;
+}
+```
+
 ### getPublicKey
 
 Get a public key in the seed

package/index.js

@@ -61,6 +61,7 @@ const {getPayments} = require('lightning');
 const {getPeers} = require('lightning');
 const {getPendingChainBalance} = require('lightning');
 const {getPendingChannels} = require('lightning');
+const {getPendingPayments} = require('lightning');
 const {getPublicKey} = require('lightning');
 const {getRouteConfidence} = require('lightning');
 const {getRouteThroughHops} = require('lightning');
@@ -202,6 +203,7 @@ module.exports = {
   getPeers,
   getPendingChainBalance,
   getPendingChannels,
+  getPendingPayments,
   getPublicKey,
   getRouteConfidence,
   getRouteThroughHops,

package/package.json

@@ -11,7 +11,7 @@
     "cors": "2.8.5",
     "express": "4.17.2",
     "invoices": "2.0.4",
-    "lightning": "5.7.1",
+    "lightning": "5.8.0",
     "macaroon": "3.0.4",
     "morgan": "1.10.0",
     "ws": "8.5.0"
@@ -68,5 +68,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/routerrpc-integration/*.js test/signerrpc-integration/*.js test/tower_clientrpc-integration/*.js test/tower_serverrpc-integration/*.js test/walletrpc-integration/*.js"
   },
-  "version": "53.8.1"
+  "version": "53.9.0"
 }

package/test/integration/test_get_pending_payments.js

@@ -0,0 +1,87 @@
+const {once} = require('events');
+
+const {spawnLightningCluster} = require('ln-docker-daemons');
+const {test} = require('@alexbosworth/tap');
+
+const {addPeer} = require('./../../');
+const {createCluster} = require('./../macros');
+const {createInvoice} = require('./../../');
+const {deleteForwardingReputations} = require('./../../');
+const {getHeight} = require('./../../');
+const {getInvoice} = require('./../../');
+const {getPayment} = require('./../../');
+const {getPendingPayments} = require('./../../');
+const {payViaPaymentRequest} = require('./../../');
+const {subscribeToForwardRequests} = require('./../../');
+const {subscribeToPayViaRequest} = require('./../../');
+const {setupChannel} = require('./../macros');
+const {waitForRoute} = require('./../macros');
+
+const size = 3;
+const tokens = 100;
+
+// Getting pending payments should list out payments in flight
+test(`Get pending payments`, async ({end, equal, rejects, strictSame}) => {
+  const {kill, nodes} = await spawnLightningCluster({size});
+
+  const [{generate, lnd}, target, remote] = nodes;
+
+  const channel = await setupChannel({generate, lnd, to: target});
+
+  await remote.generate({count: 100});
+
+  const remoteChan = await setupChannel({
+    lnd: target.lnd,
+    generate: target.generate,
+    to: remote,
+  });
+
+  await addPeer({lnd, public_key: remote.id, socket: remote.socket});
+
+  const {routes} = await waitForRoute({lnd, tokens, destination: remote.id});
+
+  let height;
+  const [route] = routes;
+
+  {
+    const invoice = await createInvoice({tokens, lnd: remote.lnd});
+
+    const sub = subscribeToForwardRequests({lnd: target.lnd});
+
+    sub.once('forward_request', async forward => {
+      const {pending} = await getPayment({lnd, id: invoice.id});
+
+      const {next, payments} = await getPendingPayments({lnd});
+
+      strictSame(next, undefined, 'No more pages');
+      strictSame(payments.length, 1, 'A single pending payment');
+
+      const [payment] = payments;
+
+      strictSame(payment.destination, remote.id, 'Paying to remote');
+      strictSame(payment.index, 1, 'First payment');
+      strictSame(payment.request, invoice.request, 'Paying invoice request');
+      strictSame(payment.confirmed_at, undefined, 'Not a confirmed payment');
+      strictSame(!!payment.created_at, true, 'Has created date');
+      strictSame(payment.fee, undefined, 'No fee yet');
+      strictSame(payment.fee_mtokens, undefined, 'No fee mtokens');
+      strictSame(payment.hops.length, 1, 'Going through hops');
+      strictSame(payment.id, invoice.id, 'Paying to the same hash');
+      strictSame(payment.is_confirmed, false, 'Payment is pending');
+      strictSame(payment.is_outgoing, true, 'Outgoing payment type');
+      strictSame(payment.mtokens, invoice.mtokens, 'Paying invoiced mtokens');
+      strictSame(payment.safe_fee, undefined, 'No fee paid yet');
+      strictSame(payment.safe_tokens, invoice.tokens, 'Paying safe tokens');
+      strictSame(payment.secret, undefined, 'Preimage not yet known');
+      strictSame(payment.tokens, invoice.tokens, 'Paying invoiced tokens');
+
+      return forward.accept();
+    });
+
+    await payViaPaymentRequest({lnd, request: invoice.request});
+  }
+
+  await kill({});
+
+  return end();
+});