lightning 4.6.0 → 4.7.0

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Versions
 
+## 4.7.0
+
+- `getPayment`: Add `created_at` to indicate the creation date of the payment
+- `getPayment`: Add `request` to indicate serialized payment request
+- `subscribeToPastPayment`: Add `created_at` to indicate the creation date of the payment
+- `subscribeToPastPayment`: Add `request` to indicate serialized payment request
+- `subscribeToPastPayments`: Add `created_at` to indicate the creation date of the payment
+- `subscribeToPastPayments`: Add `request` to indicate serialized payment request
+
 ## 4.6.0
 
 - `getPayment`: Add `destination` to indicate the destination of the payment

package/lnd_methods/offchain/get_payment.d.ts

@@ -28,6 +28,8 @@ export type GetPaymentResult = {
   payment?: {
     /** Confirmed at ISO-8601 Date */
     confirmed_at: string;
+    /** Created at ISO-8601 Date */
+    created_at: string;
     /** Payment Destination Public Key Hex */
     destination: string;
     /** Total Fee Millitokens To Pay */
@@ -54,6 +56,8 @@ export type GetPaymentResult = {
     id: string;
     /** Total Millitokens Paid */
     mtokens: string;
+    /** BOLT 11 Payment Request */
+    request?: string;
     /** Payment Forwarding Fee Rounded Up Tokens */
     safe_fee: number;
     /** Payment Tokens Rounded Up */

package/lnd_methods/offchain/get_payment.js

@@ -30,6 +30,7 @@ const type = 'router';
     [is_pending]: <Payment Is Pending Bool>
     [payment]: {
       confirmed_at: <Payment Confirmed At ISO 8601 Date String>
+      created_at: <Payment Created At ISO 8601 Date String>
       destination: <Payment Destination Hex String>
       fee: <Total Fees Paid Rounded Down Number>
       fee_mtokens: <Total Fee Millitokens Paid String>
@@ -58,6 +59,7 @@ const type = 'router';
         }]
         mtokens: <Total Millitokens Paid String>
       }]
+      [request]: <BOLT 11 Encoded Payment Request String>
       safe_fee: <Payment Forwarding Fee Rounded Up Tokens Number>
       safe_tokens: <Payment Tokens Rounded Up Number>
       secret: <Payment Preimage Hex String>

package/lnd_methods/offchain/subscribe_to_past_payment.d.ts

@@ -11,6 +11,8 @@ export type SubscribeToPastPaymentArgs = AuthenticatedLightningArgs<{
 export type SubscribeToPastPaymentConfirmedEvent = {
   /** Confirmed at ISO-8601 Date */
   confirmed: string;
+  /** Created at ISO-8601 Date */
+  created_at: string;
   /** Payment Destination Public Key Hex */
   destination: string;
   /** Payment Forwarding Fee Rounded Down Tokens */
@@ -39,6 +41,8 @@ export type SubscribeToPastPaymentConfirmedEvent = {
   id: string;
   /** Total Millitokens Paid */
   mtokens: string;
+  /** BOLT 11 Payment Request */
+  request?: string;
   /** Payment Forwarding Fee Rounded Up Tokens */
   safe_fee: number;
   /** Payment Tokens Rounded Up */

package/lnd_methods/offchain/subscribe_to_past_payment.js

@@ -41,6 +41,7 @@ const unknownServiceErr = 'unknown service verrpc.Versioner';
   @event 'confirmed'
   {
     confirmed_at: <Payment Confirmed At ISO 8601 Date String>
+    created_at: <Payment Created At ISO 8601 Date String>
     destination: <Payment Destination Hex String>
     fee: <Total Fee Tokens Paid Rounded Down Number>
     fee_mtokens: <Total Fee Millitokens Paid String>
@@ -64,6 +65,7 @@ const unknownServiceErr = 'unknown service verrpc.Versioner';
       safe_tokens: <Total Tokens Paid, Rounded Up Number>
       timeout: <Expiration Block Height Number>
     }]
+    [request]: <BOLT 11 Encoded Payment Request String>
     safe_fee: <Total Fee Tokens Paid Rounded Up Number>
     safe_tokens: <Total Tokens Paid, Rounded Up Number>
     secret: <Payment Preimage Hex String>

package/lnd_methods/offchain/subscribe_to_past_payments.d.ts

@@ -12,6 +12,8 @@ export type SubscribeToPastPaymentsErrorEvent = LightningError;
 export type SubscribeToPastPaymentsPaymentEvent = {
   /** Payment Confirmed At ISO 8601 Date String */
   confirmed_at: string;
+  /** Created at ISO-8601 Date */
+  created_at: string;
   /** Payment Destination Public Key Hex */
   destination: string;
   /** Paid Routing Fee Rounded Down Tokens Number */
@@ -48,6 +50,8 @@ export type SubscribeToPastPaymentsPaymentEvent = {
       mtokens: string;
     }
   ];
+  /** BOLT 11 Payment Request */
+  request?: string;
   /** Total Fee Tokens Paid Rounded Up Number */
   safe_fee: number;
   /** Total Tokens Paid, Rounded Up Number */

package/lnd_methods/offchain/subscribe_to_past_payments.js

@@ -41,6 +41,7 @@ const unknownFailureMessage = '2 UNKNOWN: unknown failure detail type: <nil>';
   @event 'payment'
   {
     confirmed_at: <Payment Confirmed At ISO 8601 Date String>
+    created_at: <Payment Created At ISO 8601 Date String>
     destination: <Payment Destination Hex String>
     fee: <Paid Routing Fee Rounded Down Tokens Number>
     fee_mtokens: <Paid Routing Fee in Millitokens String>
@@ -59,6 +60,7 @@ const unknownFailureMessage = '2 UNKNOWN: unknown failure detail type: <nil>';
       }]
       mtokens: <Total Millitokens Paid String>
     }]
+    [request]: <BOLT 11 Encoded Payment Request String>
     safe_fee: <Total Fee Tokens Paid Rounded Up Number>
     safe_tokens: <Total Tokens Paid, Rounded Up Number>
     secret: <Payment Preimage Hex String>

package/lnd_responses/confirmed_from_payment.js

@@ -6,6 +6,7 @@ const {isArray} = Array;
 const is256Hex = n => !!n && /^[0-9A-F]{64}$/i.test(n);
 const {max} = Math;
 const mtokensAsTokens = mtokens => safeTokens({mtokens}).tokens;
+const nsAsDate = ns => new Date(Number(BigInt(ns) / BigInt(1e6)));
 
 /** Calculate total payment details from RPC payment HTLC elements
 
@@ -65,6 +66,7 @@ const mtokensAsTokens = mtokens => safeTokens({mtokens}).tokens;
   @returns
   {
     confirmed_at: <Payment Confirmed At ISO 8601 Date String>
+    created_at: <Payment Created At ISO 8601 Date String>
     destination: <Payment Destination Public Key Hex String>
     fee: <Total Fee Tokens Paid Rounded Down Number>
     fee_mtokens: <Total Fee Millitokens Paid String>
@@ -98,6 +100,7 @@ const mtokensAsTokens = mtokens => safeTokens({mtokens}).tokens;
       safe_tokens: <Total Tokens Paid, Rounded Up Number>
       timeout: <Expiration Block Height Number>
     }]
+    [request]: <BOLT 11 Encoded Payment Request String>
     safe_fee: <Total Fee Tokens Paid Rounded Up Number>
     safe_tokens: <Total Tokens Paid, Rounded Up Number>
     secret: <Payment Preimage Hex String>
@@ -110,6 +113,10 @@ module.exports = payment => {
     throw new Error('ExpectedConfirmedPaymentToDeriveConfirmationDetails');
   }
 
+  if (!payment.creation_time_ns) {
+    throw new Error('ExpectedPaymentCreationDateToDerivePaymentDetails');
+  }
+
   if (!payment.fee_msat) {
     throw new Error('ExpectedPaymentFeeMillitokensAmountForPayment');
   }
@@ -147,12 +154,14 @@ module.exports = payment => {
   return {
     destination,
     confirmed_at: confirmedAt,
+    created_at: nsAsDate(payment.creation_time_ns).toISOString(),
     fee: safeTokens({mtokens: payment.fee_msat}).tokens,
     fee_mtokens: payment.fee_msat,
     hops: success.route.hops,
     id: payment.payment_hash,
     mtokens: mtokens.toString(),
     paths: successes.map(n => n.route),
+    request: payment.payment_request || undefined,
     safe_fee: safeTokens({mtokens: payment.fee_msat}).safe,
     safe_tokens: safeTokens({mtokens: mtokens.toString()}).safe,
     secret: payment.payment_preimage,

package/package.json

@@ -56,5 +56,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "4.6.0"
+  "version": "4.7.0"
 }

package/test/lnd_methods/offchain/test_pay_via_payment_details.js

@@ -306,7 +306,7 @@ const tests = [
   {
     args: makeArgs({lnd: makeLnd({data: {status: 'SUCCEEDED'}})}),
     description: 'A payment attempt is in flight',
-    error: [503, 'ExpectedPaymentFeeMillitokensAmountForPayment'],
+    error: [503, 'ExpectedPaymentCreationDateToDerivePaymentDetails'],
   },
 ];
 

package/test/lnd_methods/offchain/test_subscribe_to_past_payments.js

@@ -204,6 +204,7 @@ const tests = [
     description: 'A past payment is emitted',
     expected: {
       confirmed_at: '1970-01-01T00:00:00.000Z',
+      created_at: '1970-01-01T00:00:00.000Z',
       destination: '000000000000000000000000000000000000000000000000000000000000000000',
       fee: 1,
       fee_mtokens: '1000',
@@ -244,6 +245,7 @@ const tests = [
           total_mtokens: '1000',
         }
       ],
+      request: undefined,
       safe_fee: 1,
       safe_tokens: 2,
       secret: '0000000000000000000000000000000000000000000000000000000000000000',

package/test/lnd_responses/test_confirmed_from_payment.js

@@ -54,6 +54,7 @@ const makeArgs = overrides => {
 const makeExpected = overrides => {
   const expected = {
     confirmed_at: '1970-01-01T00:00:00.000Z',
+    created_at: '1970-01-01T00:00:00.000Z',
     destination: Buffer.alloc(33).toString('hex'),
     fee: 1,
     fee_mtokens: '1000',
@@ -88,6 +89,7 @@ const makeExpected = overrides => {
       tokens: 1,
       total_mtokens: '1000',
     }],
+    request: undefined,
     safe_fee: 1,
     safe_tokens: 2,
     secret: Buffer.alloc(32).toString('hex'),