lightning 4.13.3 → 4.14.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Versions
 
+## 4.14.0
+
+- `getPayment`, `subscribeToPastPayment`: Add `pending` for pending payment details
+
 ## 4.13.3
 
 - Add `sendMessageToPeer` to send a peer to peer message to a connected peer

package/lnd_methods/offchain/emit_payment.js

@@ -1,5 +1,6 @@
 const {confirmedFromPayment} = require('./../../lnd_responses');
 const {failureFromPayment} = require('./../../lnd_responses');
+const {pendingFromPayment} = require('./../../lnd_responses');
 const {states} = require('./payment_states');
 
 /** Emit payment from payment event
@@ -21,7 +22,7 @@ module.exports = ({data, emitter}) => {
       return emitter.emit('failed', failureFromPayment(data));
 
     case states.paying:
-      return emitter.emit('paying', {});
+      return emitter.emit('paying', pendingFromPayment(data));
 
     default:
       return;

package/lnd_methods/offchain/get_payment.d.ts

@@ -105,6 +105,60 @@ export type GetPaymentResult = {
     /** Total Tokens Paid */
     tokens: number;
   };
+  pending?: {
+    /** Created at ISO-8601 Date */
+    created_at: string;
+    /** Payment Destination Public Key Hex */
+    destination: string;
+    /** Payment Hash Hex */
+    id: string;
+    /** Total Millitokens Pending */
+    mtokens: string;
+    paths: {
+      /** Total Path Fee Tokens */
+      fee: number;
+      /** Total Path Fee Millitokens */
+      fee_mtokens: string;
+      hops: {
+        /** Standard Format Channel Id */
+        channel: string;
+        /** Channel Capacity Tokens */
+        channel_capacity: number;
+        /** Routing Fee Tokens */
+        fee: number;
+        /** Fee Millitokens */
+        fee_mtokens: string;
+        /** Forwarded Tokens */
+        forward: number;
+        /** Forward Millitokens */
+        forward_mtokens: string;
+        /** Public Key Hex */
+        public_key: string;
+        /** Timeout Block Height */
+        timeout: number;
+      }[];
+      /** Total Path Millitokens Paid */
+      mtokens: string;
+      /** MPP Payment Identifying Nonce */
+      payment: string;
+      /** Expiration Block Height */
+      timeout: number;
+      /** Path Tokens Paid */
+      tokens: number;
+      /** Total Millitokens Pending */
+      total_mtokens: string;
+    }[]
+    /** BOLT 11 Payment Request */
+    request?: string;
+    /** Payment Tokens Rounded Up */
+    safe_tokens: number;
+    /** Payment Preimage Hex */
+    secret: string;
+    /** Expiration Block Height */
+    timeout?: number;
+    /** Total Tokens Pending */
+    tokens: number;
+  };
 };
 
 /**

package/lnd_methods/offchain/get_payment.js

@@ -67,6 +67,30 @@ const type = 'router';
       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>
+    }
   }
 */
 module.exports = ({id, lnd}, cbk) => {
@@ -102,6 +126,7 @@ module.exports = ({id, lnd}, cbk) => {
             is_failed: !!res.failed,
             is_pending: !res.payment && !res.failed,
             payment: res.payment || undefined,
+            pending: res.pending || undefined,
           });
         };
 
@@ -109,7 +134,7 @@ module.exports = ({id, lnd}, cbk) => {
         sub.once('end', () => cbk([503, 'UnknownStatusOfPayment']));
         sub.once('error', err => finished(err));
         sub.once('failed', failed => finished(null, {failed}));
-        sub.once('paying', () => finished(null, {}));
+        sub.once('paying', pending => finished(null, {pending}));
 
         return;
       }],

package/lnd_methods/offchain/subscribe_to_past_payment.js

@@ -82,7 +82,34 @@ const unknownServiceErr = 'unknown service verrpc.Versioner';
   }
 
   @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>
+  }
 */
 module.exports = args => {
   if (!isHash(args.id)) {

package/lnd_responses/index.js

@@ -11,6 +11,7 @@ const nodeInfoAsNode = require('./node_info_as_node');
 const paymentFailure = require('./payment_failure');
 const paymentRequestDetails = require('./payment_request_details');
 const pendingAsPendingChannels = require('./pending_as_pending_channels');
+const pendingFromPayment = require('./pending_from_payment');
 const policyFromChannelUpdate = require('./policy_from_channel_update');
 const routesFromQueryRoutes = require('./routes_from_query_routes');
 const rpcAttemptHtlcAsAttempt = require('./rpc_attempt_htlc_as_attempt');
@@ -53,6 +54,7 @@ module.exports = {
   paymentFailure,
   paymentRequestDetails,
   pendingAsPendingChannels,
+  pendingFromPayment,
   policyFromChannelUpdate,
   routesFromQueryRoutes,
   rpcAttemptHtlcAsAttempt,

package/lnd_responses/pending_from_payment.js

@@ -0,0 +1,145 @@
+const {attemptStates} = require('./constants');
+const rpcAttemptHtlcAsAttempt = require('./rpc_attempt_htlc_as_attempt');
+const {safeTokens} = require('./../bolt00');
+
+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
+
+  The `route` attribute only returns the first route, there may be more due to
+  payment splitting
+
+  {
+    creation_date: <Creation Date Epoch Time Seconds String>
+    creation_time_ns: <Creation Date Epoch Time Nanoseconds String>
+    failure_reason: <Payment Failure Reason String>
+    fee_msat: <Fee Paid in Millitokens String>
+    fee_sat: <Fee Paid in Tokens String>
+    htlcs: [{
+      attempt_time_ns: <HTLC Sent At Epoch Time Nanoseconds String>
+      resolve_time_ns: <HTLC Resolved At Epoch Time Nanoseconds String>
+      route: {
+        hops: [{
+          amt_to_forward: <Tokens to Forward String>
+          amt_to_forward_msat: <Millitokens to Forward String>
+          chan_id: <Numeric Format Channel Id String>
+          chan_capacity: <Channel Capacity Tokens String>
+          custom_records: {
+            <UInt64 String>: <Record Data Buffer>
+          }
+          expiry: <Timeout Chain Height Number>
+          fee: <Fee in Tokens String>
+          fee_msat: <Fee in Millitokens String>
+          [mpp_record]: {
+            payment_addr: <Payment Identifier Buffer>
+            total_amt_msat: <Total Payment Millitokens Amount String>
+          }
+          [pub_key]: <Next Hop Public Key Hex String>
+          tlv_payload: <Has Extra TLV Data Bool>
+        }]
+        total_amt: <Total Tokens String>
+        total_amt_msat: <Route Total Millitokens String>
+        total_fees: <Route Fee Tokens String>
+        total_fees_msat: <Route Total Fees Millitokens String>
+        total_time_lock: <Route Total Timelock Number>
+      }
+      status: <HTLC Status String>
+    }]
+    path: [<Hop Public Key Hex String>]
+    payment_hash: <Preimage SHA256 Hash Hex String>
+    payment_index: <Payment Index String>
+    payment_preimage: <Payment Secret Preimage Hex String>
+    payment_request: <BOLT 11 Payment Request String>
+    status: <Payment State String>
+    value: <Tokens String>
+    value_msat: <Paid Tokens Without Routing Fees Millitokens String>
+    value_sat: <Paid Tokens Without Routing Fees String>
+  }
+
+  @throws
+  <Error>
+
+  @returns
+  {
+    created_at: <Payment Created At ISO 8601 Date String>
+    destination: <Payment Destination Public Key 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 Paid String>
+      safe_fee: <Total Fee Tokens Paid Rounded Up Number>
+      safe_tokens: <Total Tokens Paid, 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>
+  }
+*/
+module.exports = payment => {
+  if (!payment) {
+    throw new Error('ExpectedPendingPaymentToDerivePendingDetails');
+  }
+
+  if (!payment.creation_time_ns) {
+    throw new Error('ExpectedPaymentCreationDateToDerivePendingDetails');
+  }
+
+  if (!payment.fee_msat) {
+    throw new Error('ExpectedPaymentFeeMillitokensAmountForPendingPayment');
+  }
+
+  if (!isArray(payment.htlcs)) {
+    throw new Error('ExpectedArrayOfPaymentHtlcsInPendingPayment');
+  }
+
+  if (!payment.htlcs.find(n => n.status === attemptStates.pending)) {
+    throw new Error('ExpectedPendingHtlcInPendingPayment');
+  }
+
+  if (!is256Hex(payment.payment_hash)) {
+    throw new Error('ExpectedPaymentHashForPaymentAsPendingPayment');
+  }
+
+  if (mtokensAsTokens(payment.value_msat) !== Number(payment.value_sat)) {
+    throw new Error('ExpectedValueOfTokensAndMillitokensToBeConsistent');
+  }
+
+  const attempts = payment.htlcs.map(htlc => rpcAttemptHtlcAsAttempt(htlc));
+  const mtokens = BigInt(payment.value_msat) + BigInt(payment.fee_msat);
+
+  const pending = attempts.filter(n => n.is_pending);
+
+  const [first] = pending;
+
+  const [destination] = first.route.hops.map(n => n.public_key).reverse();
+
+  return {
+    destination,
+    created_at: nsAsDate(payment.creation_time_ns).toISOString(),
+    id: payment.payment_hash,
+    mtokens: mtokens.toString(),
+    paths: pending.map(n => n.route),
+    request: payment.payment_request || undefined,
+    safe_tokens: safeTokens({mtokens: mtokens.toString()}).safe,
+    timeout: max(...pending.map(n => n.route.timeout).filter(n => !!n)),
+    tokens: safeTokens({mtokens: mtokens.toString()}).tokens,
+  };
+};

package/package.json

@@ -20,7 +20,7 @@
     "body-parser": "1.19.0",
     "bolt07": "1.7.4",
     "bolt09": "0.2.0",
-    "cbor": "8.0.2",
+    "cbor": "8.1.0",
     "express": "4.17.1",
     "invoices": "2.0.1",
     "psbt": "1.1.10"
@@ -56,5 +56,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "4.13.3"
+  "version": "4.14.0"
 }

package/test/lnd_methods/offchain/test_get_payment.js

@@ -8,7 +8,48 @@ const makeLnd = args => {
   return {
     router: {
       trackPaymentV2: ({}) => {
-        const data = args.data || {status: 'IN_FLIGHT'};
+        const data = args.data || {
+          creation_date: '1',
+          creation_time_ns: '1',
+          failure_reason: 'FAILURE_REASON_NONE',
+          fee: '1',
+          fee_msat: '1000',
+          fee_sat: '1',
+          htlcs: [{
+            attempt_time_ns: '1',
+            status: 'IN_FLIGHT',
+            resolve_time_ns: '1',
+            route: {
+              hops: [{
+                amt_to_forward: '1',
+                amt_to_forward_msat: '1000',
+                chan_capacity: '1',
+                chan_id: '1',
+                custom_records: {'1': Buffer.alloc(1)},
+                expiry: 1,
+                fee: '1',
+                fee_msat: '1000',
+                mpp_record: {payment_addr: Buffer.alloc(32), total_amt_msat: '1000'},
+                pub_key: Buffer.alloc(33).toString('hex'),
+                tlv_payload: true,
+              }],
+              total_amt: '1',
+              total_amt_msat: '1000',
+              total_time_lock: 1,
+              total_fees: '1',
+              total_fees_msat: '1000',
+            },
+          }],
+          path: [Buffer.alloc(33).toString('hex')],
+          payment_hash: Buffer.alloc(32).toString('hex'),
+          payment_index: '1',
+          payment_preimage: Buffer.alloc(32).toString('hex'),
+          payment_request: '',
+          status: 'IN_FLIGHT',
+          value: '1',
+          value_msat: '1000',
+          value_sat: '1',
+        };
         const emitter = new EventEmitter();
 
         if (!!args.is_end) {
@@ -146,6 +187,35 @@ const tests = [
         is_failed: false,
         is_pending: true,
         payment: undefined,
+        pending: {
+          created_at: '1970-01-01T00:00:00.000Z',
+          destination: Buffer.alloc(33).toString('hex'),
+          id: Buffer.alloc(32).toString('hex'),
+          mtokens: '2000',
+          paths: [{
+            fee: 1,
+            fee_mtokens: '1000',
+            hops: [{
+              channel: '0x0x1',
+              channel_capacity: 1,
+              fee: 1,
+              fee_mtokens: '1000',
+              forward: 1,
+              forward_mtokens: '1000',
+              public_key: Buffer.alloc(33).toString('hex'),
+              timeout: 1,
+            }],
+            mtokens: '1000',
+            payment: '0000000000000000000000000000000000000000000000000000000000000000',
+            timeout: 1,
+            tokens: 1,
+            total_mtokens: '1000',
+          }],
+          request: undefined,
+          safe_tokens: 2,
+          timeout: 1,
+          tokens: 2,
+        },
       },
     },
   },

package/test/lnd_responses/test_pending_from_payment.js

@@ -0,0 +1,143 @@
+const {test} = require('@alexbosworth/tap');
+
+const {pendingFromPayment} = require('./../../lnd_responses');
+
+const makeArgs = overrides => {
+  const args = {
+    creation_date: '1',
+    creation_time_ns: '1',
+    failure_reason: 'FAILURE_REASON_NONE',
+    fee: '1',
+    fee_msat: '1000',
+    fee_sat: '1',
+    htlcs: [{
+      attempt_time_ns: '1',
+      status: 'IN_FLIGHT',
+      resolve_time_ns: '1',
+      route: {
+        hops: [{
+          amt_to_forward: '1',
+          amt_to_forward_msat: '1000',
+          chan_capacity: '1',
+          chan_id: '1',
+          custom_records: {'1': Buffer.alloc(1)},
+          expiry: 1,
+          fee: '1',
+          fee_msat: '1000',
+          mpp_record: {payment_addr: Buffer.alloc(32), total_amt_msat: '1000'},
+          pub_key: Buffer.alloc(33).toString('hex'),
+          tlv_payload: true,
+        }],
+        total_amt: '1',
+        total_amt_msat: '1000',
+        total_time_lock: 1,
+        total_fees: '1',
+        total_fees_msat: '1000',
+      },
+    }],
+    path: [Buffer.alloc(33).toString('hex')],
+    payment_hash: Buffer.alloc(32).toString('hex'),
+    payment_index: '1',
+    payment_preimage: Buffer.alloc(32).toString('hex'),
+    payment_request: '',
+    status: 'IN_FLIGHT',
+    value: '1',
+    value_msat: '1000',
+    value_sat: '1',
+  };
+
+  Object.keys(overrides).forEach(k => args[k] = overrides[k]);
+
+  return args;
+};
+
+const makeExpected = overrides => {
+  const expected = {
+    created_at: '1970-01-01T00:00:00.000Z',
+    destination: Buffer.alloc(33).toString('hex'),
+    id: Buffer.alloc(32).toString('hex'),
+    mtokens: '2000',
+    paths: [{
+      fee: 1,
+      fee_mtokens: '1000',
+      hops: [{
+        channel: '0x0x1',
+        channel_capacity: 1,
+        fee: 1,
+        fee_mtokens: '1000',
+        forward: 1,
+        forward_mtokens: '1000',
+        public_key: Buffer.alloc(33).toString('hex'),
+        timeout: 1,
+      }],
+      mtokens: '1000',
+      payment: '0000000000000000000000000000000000000000000000000000000000000000',
+      timeout: 1,
+      tokens: 1,
+      total_mtokens: '1000',
+    }],
+    request: undefined,
+    safe_tokens: 2,
+    timeout: 1,
+    tokens: 2,
+  };
+
+  Object.keys(overrides).forEach(k => expected[k] = overrides[k]);
+
+  return expected;
+};
+
+const tests = [
+  {
+    args: undefined,
+    description: 'A payment is expected',
+    error: 'ExpectedPendingPaymentToDerivePendingDetails',
+  },
+  {
+    args: makeArgs({creation_time_ns: undefined}),
+    description: 'Creation time is expected',
+    error: 'ExpectedPaymentCreationDateToDerivePendingDetails',
+  },
+  {
+    args: makeArgs({fee_msat: undefined}),
+    description: 'Fee millitokens are expected',
+    error: 'ExpectedPaymentFeeMillitokensAmountForPendingPayment',
+  },
+  {
+    args: makeArgs({htlcs: undefined}),
+    description: 'HTLCs are expected',
+    error: 'ExpectedArrayOfPaymentHtlcsInPendingPayment',
+  },
+  {
+    args: makeArgs({htlcs: [{}]}),
+    description: 'A successful HTLC is expected',
+    error: 'ExpectedPendingHtlcInPendingPayment',
+  },
+  {
+    args: makeArgs({payment_hash: undefined}),
+    description: 'A payment hash is expected',
+    error: 'ExpectedPaymentHashForPaymentAsPendingPayment',
+  },
+  {
+    args: makeArgs({value_sat: '1', value_msat: '0'}),
+    description: 'Values are expected to agree',
+    error: 'ExpectedValueOfTokensAndMillitokensToBeConsistent',
+  },
+  {
+    args: makeArgs({}),
+    description: 'Payment is mapped to confirmed payment details',
+    expected: makeExpected({}),
+  },
+];
+
+tests.forEach(({args, description, error, expected}) => {
+  return test(description, ({end, strictSame, throws}) => {
+    if (!!error) {
+      throws(() => pendingFromPayment(args), new Error(error), 'Err');
+    } else {
+      strictSame(pendingFromPayment(args), expected, 'Mapped');
+    }
+
+    return end();
+  });
+});