lightning 5.15.0 → 5.15.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Versions
 
+## 5.15.1
+
+- `getFailedPayments`, `getPayments`, `getPendingPayments`: Remove
+    `confirmed_at` date when a payment is not confirmed, add `created_at` and
+    `failed_at` dates for attempt start and attempt failed dates.
+
 ## 5.15.0
 
 - `beginGroupSigningSession`: Add method to start a MuSig2 signing session

package/lnd_methods/offchain/get_failed_payments.js

@@ -56,7 +56,9 @@ const type = 'default';
           message: <Error Message String>
         }
         [index]: <Payment Add Index Number>
-        [confirmed_at]: <Payment Confirmed At ISO 8601 Date String>
+        [confirmed_at]: <Payment Attempt Succeeded At ISO 8601 Date String>
+        created_at: <Attempt Was Started At ISO 8601 Date String>
+        [failed_at]: <Payment Attempt Failed 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>

package/lnd_methods/offchain/get_payments.js

@@ -55,7 +55,9 @@ const type = 'default';
           message: <Error Message String>
         }
         [index]: <Payment Add Index Number>
-        [confirmed_at]: <Payment Confirmed At ISO 8601 Date String>
+        [confirmed_at]: <Payment Attempt Succeeded At ISO 8601 Date String>
+        created_at: <Attempt Was Started At ISO 8601 Date String>
+        [failed_at]: <Payment Attempt Failed 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>

package/lnd_methods/offchain/get_pending_payments.js

@@ -57,6 +57,8 @@ const type = 'default';
         }
         [index]: <Payment Add Index Number>
         [confirmed_at]: <Payment Confirmed At ISO 8601 Date String>
+        created_at: <Attempt Was Started At ISO 8601 Date String>
+        [failed_at]: <Payment Attempt Failed 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>

package/lnd_responses/rpc_attempt_htlc_as_attempt.js

@@ -61,7 +61,9 @@ const nsAsMs = ns => Number(BigInt(ns) / BigInt(1e6));
 
   @returns
   {
-    confirmed_at: <Payment Succeeded At ISO 8601 Date String>
+    [confirmed_at]: <Payment Attempt Succeeded At ISO 8601 Date String>
+    created_at: <Attempt Was Started At ISO 8601 Date String>
+    [failed_at]: <Payment Attempt Failed 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>
@@ -91,6 +93,10 @@ module.exports = attempt => {
     throw new Error('ExpectedRpcAttemptDetailsToDeriveAttempt');
   }
 
+  if (!attempt.attempt_time_ns) {
+    throw new Error('ExpectedRpcAttemptStartTimeNs');
+  }
+
   if (!attempt.resolve_time_ns) {
     throw new Error('ExpectedRpcAttemptResolveTimeNs');
   }
@@ -103,11 +109,39 @@ module.exports = attempt => {
     throw new Error('ExpectedAttemptStatusInRpcAttemptDetails');
   }
 
+  const route = rpcRouteAsRoute(attempt.route);
+
+  if (attempt.status === attemptStates.confirmed) {
+    return {
+      route,
+      confirmed_at: new Date(nsAsMs(attempt.resolve_time_ns)).toISOString(),
+      created_at: new Date(nsAsMs(attempt.attempt_time_ns)).toISOString(),
+      failed_at: undefined,
+      is_confirmed: true,
+      is_failed: false,
+      is_pending: false,
+    };
+  }
+
+  if (attempt.status === attemptStates.failed) {
+    return {
+      route,
+      confirmed_at: undefined,
+      created_at: new Date(nsAsMs(attempt.attempt_time_ns)).toISOString(),
+      failed_at: new Date(nsAsMs(attempt.resolve_time_ns)).toISOString(),
+      is_confirmed: false,
+      is_failed: true,
+      is_pending: false,
+    };
+  }
+
   return {
-    confirmed_at: new Date(nsAsMs(attempt.resolve_time_ns)).toISOString(),
-    is_confirmed: attempt.status === attemptStates.confirmed,
-    is_failed: attempt.status === attemptStates.failed,
+    route,
+    confirmed_at: undefined,
+    created_at: new Date(nsAsMs(attempt.attempt_time_ns)).toISOString(),
+    failed_at: undefined,
+    is_confirmed: false,
+    is_failed: false,
     is_pending: attempt.status === attemptStates.pending,
-    route: rpcRouteAsRoute(attempt.route),
   };
 };

package/lnd_responses/rpc_payment_as_payment.js

@@ -81,6 +81,9 @@ const routePublicKeys = route => route.hops.map(n => n.public_key);
   @returns
   {
     attempts: [{
+      [confirmed_at]: <Payment Attempt Succeeded At ISO 8601 Date String>
+      created_at: <Attempt Was Started At ISO 8601 Date String>
+      [failed_at]: <Payment Attempt Failed At ISO 8601 Date String>
       [failure]: {
         code: <Error Type Code Number>
         [details]: {
@@ -108,6 +111,9 @@ const routePublicKeys = route => route.hops.map(n => n.public_key);
         }
         message: <Error Message String>
       }
+      [confirmed_at]: <Payment Attempt Succeeded At ISO 8601 Date String>
+      created_at: <Attempt Was Started At ISO 8601 Date String>
+      [failed_at]: <Payment Attempt Failed 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>

package/package.json

@@ -59,5 +59,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "5.15.0"
+  "version": "5.15.1"
 }

package/test/lnd_methods/offchain/test_get_payments.js

@@ -65,6 +65,8 @@ const makeExpectedPayment = ({}) => {
     destination: '020202020202020202020202020202020202020202020202020202020202020202',
     attempts: [{
       confirmed_at: '1970-01-01T00:00:00.000Z',
+      created_at: '1970-01-01T00:00:00.000Z',
+      failed_at: undefined,
       is_confirmed: true,
       is_failed: false,
       is_pending: false,

package/test/lnd_responses/test_rpc_attempt_htlc_as_attempt.js

@@ -19,7 +19,12 @@ const route = {
 };
 
 const makeArgs = overrides => {
-  const args = {route, resolve_time_ns: '1', status: 'IN_FLIGHT'};
+  const args = {
+    route,
+    attempt_time_ns: '1',
+    resolve_time_ns: '1',
+    status: 'IN_FLIGHT',
+  };
 
   Object.keys(overrides).forEach(k => args[k] = overrides[k]);
 
@@ -29,6 +34,8 @@ const makeArgs = overrides => {
 const makeExpected = overrides => {
   const attempt = {
     confirmed_at: '1970-01-01T00:00:00.000Z',
+    created_at: '1970-01-01T00:00:00.000Z',
+    failed_at: undefined,
     is_confirmed: false,
     is_failed: false,
     is_pending: false,
@@ -64,6 +71,11 @@ const tests = [
     description: 'An rpc attempt is required to map to an attempt',
     error: 'ExpectedRpcAttemptDetailsToDeriveAttempt',
   },
+  {
+    args: makeArgs({attempt_time_ns: undefined}),
+    description: 'Expected attempt time in rpc attempt details',
+    error: 'ExpectedRpcAttemptStartTimeNs',
+  },
   {
     args: makeArgs({resolve_time_ns: undefined}),
     description: 'Expected resolve time in rpc attempt details',
@@ -82,7 +94,7 @@ const tests = [
   {
     args: makeArgs({}),
     description: 'An in flight rpc attempt is mapped to an attempt',
-    expected: makeExpected({is_pending: true}),
+    expected: makeExpected({confirmed_at: undefined, is_pending: true}),
   },
   {
     args: makeArgs({status: 'SUCCEEDED'}),
@@ -92,7 +104,11 @@ const tests = [
   {
     args: makeArgs({status: 'FAILED'}),
     description: 'An rpc attempt is mapped to an attempt',
-    expected: makeExpected({is_failed: true}),
+    expected: makeExpected({
+      confirmed_at: undefined,
+      failed_at: '1970-01-01T00:00:00.000Z',
+      is_failed: true,
+    }),
   },
 ];
 

package/test/lnd_responses/test_rpc_payment_as_payment.js

@@ -73,7 +73,9 @@ const makeArgs = overrides => {
 const makeExpected = overrides => {
   const expected = {
     attempts: [{
-      confirmed_at: '1970-01-01T00:00:00.001Z',
+      confirmed_at: undefined,
+      created_at: '1970-01-01T00:00:00.001Z',
+      failed_at: '1970-01-01T00:00:00.001Z',
       is_confirmed: false,
       is_failed: true,
       is_pending: false,
@@ -272,6 +274,8 @@ const tests = [
     expected: makeExpected({
       attempts: [{
         confirmed_at: '2020-04-20T19:17:16.160Z',
+        created_at: '2020-04-20T19:17:15.428Z',
+        failed_at: undefined,
         is_confirmed: true,
         is_failed: false,
         is_pending: false,