ln-service 53.19.0 → 53.22.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Versions
 
+## 53.22.0
+
+- `parsePaymentRequest`: Add support for parsing payment request metadata
+
+## 53.21.0
+
+- `getLockedUtxos`: Add support for locked UTXO `output_script`, `tokens`
+
+## 53.20.0
+
+- `closeChannel`: Add support for `max_tokens_per_vbyte` to set max fee rate
+- `getChainTransactions`: Add `inputs` support for previous outpoints
+- `subscribeToTransactions`: Add `inputs` support for previous outpoints
+
 ## 53.19.0
 
 - `signBytes`: Add `type` and support for specifying `schnorr` type signing

package/README.md

@@ -9,11 +9,10 @@ through npm.
 
 Supported LND versions:
 
-- v0.15.0-beta
+- v0.15.0-beta to v0.15.1-beta
 - v0.14.0-beta to v0.14.3-beta
 - v0.13.0-beta to v0.13.4-beta
 - v0.12.0-beta to v0.12.1-beta
-- v0.11.0-beta to v0.11.1-beta
 
 For typescript-ready methods, check out https://github.com/alexbosworth/lightning#readme
 
@@ -529,17 +528,23 @@ Either an id or a transaction id / transaction output index is required
 
 If cooperatively closing, pass a public key and socket to connect
 
-Requires `info:read`, `offchain:write`, `onchain:write`, `peers:write` permissions
+`max_tokens_per_vbyte` will be ignored when closing a peer initiated channel
+
+Requires `info:read`, `offchain:write`, `onchain:write`, `peers:write`
+permissions
+
+`max_tokens_per_vbyte` is not supported in LND 0.15.0 and below
 
     {
       [address]: <Request Sending Local Channel Funds To Address String>
       [id]: <Standard Format Channel Id String>
       [is_force_close]: <Is Force Close Bool>
       lnd: <Authenticated LND API Object>
+      [max_tokens_per_vbyte]: <Fail Cooperative Close Above Fee Rate Number>
       [public_key]: <Peer Public Key String>
       [socket]: <Peer Socket String>
       [target_confirmations]: <Confirmation Target Number>
-      [tokens_per_vbyte]: <Tokens Per Virtual Byte Number>
+      [tokens_per_vbyte]: <Target Tokens Per Virtual Byte Number>
       [transaction_id]: <Transaction Id Hex String>
       [transaction_vout]: <Transaction Output Index Number>
     }
@@ -1486,10 +1491,12 @@ Get chain transactions.
 
 Requires `onchain:read` permission
 
+`inputs` are not supported on LND 0.15.0 and below
+
     {
       [after]: <Confirmed After Current Best Chain Block Height Number>
       [before]: <Confirmed Before Current Best Chain Block Height Number>
-      lnd: <Authenticated LND Object>
+      lnd: <Authenticated LND API Object>
     }
 
     @returns via cbk or Promise
@@ -1502,6 +1509,11 @@ Requires `onchain:read` permission
         [description]: <Transaction Label String>
         [fee]: <Fees Paid Tokens Number>
         id: <Transaction Id String>
+        inputs: [{
+          is_local: <Spent Outpoint is Local Bool>
+          transaction_id: <Transaction Id Hex String>
+          transaction_vout: <Transaction Output Index Number>
+        }]
         is_confirmed: <Is Confirmed Bool>
         is_outgoing: <Transaction Outbound Bool>
         output_addresses: [<Address String>]
@@ -2241,6 +2253,8 @@ Requires LND built with `walletrpc` build tag
 
 This method is not supported on LND 0.12.1 and below
 
+`output_script`, `tokens` are not supported on LND 0.15.0 and below
+
     {
       lnd: <Authenticated LND API Object>
     }
@@ -2250,6 +2264,8 @@ This method is not supported on LND 0.12.1 and below
       utxos: [{
         lock_expires_at: <Lock Expires At ISO 8601 Date String>
         lock_id: <Locking Id Hex String>
+        [output_script]: <Outpoint Output Script Hex String>
+        [tokens]: <Token Value of Outpoint Number>
         transaction_id: <Transaction Id Hex String>
         transaction_vout: <Transaction Output Index Number>
       }]
@@ -3679,6 +3695,7 @@ Note: either description or description_hash will be returned
       }]
       id: <Payment Request Hash String>
       is_expired: <Invoice is Expired Bool>
+      [metadata]: <Payment Metadata Hex String>
       [mtokens]: <Requested Milli-Tokens Value String> (can exceed Number limit)
       network: <Network Name String>
       [payment]: <Payment Identifier Hex Encoded String>
@@ -6615,6 +6632,8 @@ Subscribe to transactions
 
 Requires `onchain:read` permission
 
+`inputs` are not supported on LND 0.15.0 and below
+
     {
       lnd: <Authenticated LND API Object>
     }
@@ -6633,6 +6652,11 @@ Requires `onchain:read` permission
       created_at: <Created ISO 8601 Date String>
       [fee]: <Fees Paid Tokens Number>
       id: <Transaction Id String>
+      inputs: [{
+        is_local: <Spent Outpoint is Local Bool>
+        transaction_id: <Transaction Id Hex String>
+        transaction_vout: <Transaction Output Index Number>
+      }]
       is_confirmed: <Is Confirmed Bool>
       is_outgoing: <Transaction Outbound Bool>
       output_addresses: [<Address String>]

package/package.json

@@ -10,8 +10,8 @@
     "bolt07": "1.8.2",
     "cors": "2.8.5",
     "express": "4.18.1",
-    "invoices": "2.1.0",
-    "lightning": "5.18.0",
+    "invoices": "2.2.0",
+    "lightning": "5.20.2",
     "macaroon": "3.0.4",
     "morgan": "1.10.0",
     "ws": "8.8.1"
@@ -28,7 +28,7 @@
     "bn.js": "5.2.1",
     "bs58check": "2.1.2",
     "ecpair": "2.0.1",
-    "ln-docker-daemons": "2.3.3",
+    "ln-docker-daemons": "2.3.6",
     "p2tr": "1.3.1",
     "portfinder": "1.0.32",
     "psbt": "2.7.1",
@@ -56,7 +56,7 @@
     "url": "https://github.com/alexbosworth/ln-service.git"
   },
   "scripts": {
-    "integration-test-daily-lnd-build": "DOCKER_LND_VERSION=daily-testing-only npm run test",
+    "integration-test-0.15.1": "DOCKER_LND_VERSION=v0.15.1-beta npm run test",
     "integration-test-0.15.0": "DOCKER_LND_VERSION=v0.15.0-beta npm run test",
     "integration-test-0.14.3": "DOCKER_LND_VERSION=v0.14.3-beta npm run test",
     "integration-test-0.14.2": "DOCKER_LND_VERSION=v0.14.2-beta npm run test",
@@ -71,5 +71,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/peersrpc-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.19.0"
+  "version": "53.22.0"
 }

package/test/integration/test_add_peer.js

@@ -8,7 +8,7 @@ const {getPeers} = require('./../../');
 
 const interval = 100;
 const size = 2;
-const times = 2000;
+const times = 4000;
 const timeout = 100;
 
 // Adding peers should result in a connected peer

package/test/integration/test_delete_pending_channel.js

@@ -18,6 +18,7 @@ const {fundPsbt} = require('./../../');
 const {getChainBalance} = require('./../../');
 const {getChannels} = require('./../../');
 const {getLockedUtxos} = require('./../../');
+const {getMasterPublicKeys} = require('./../../');
 const {getPendingChannels} = require('./../../');
 const {openChannels} = require('./../../');
 const {signPsbt} = require('./../../');
@@ -41,6 +42,17 @@ test(`Forfeit pending channel`, async ({end, equal, strictSame}) => {
 
   const {generate, lnd} = control;
 
+  try {
+    const {keys} = await getMasterPublicKeys({lnd});
+  } catch (err) {
+    // LND 0.13.3 and below should not be tested
+    strictSame(err, [501, 'GetMasterPublicKeysMethodNotSupported'], 'Got err');
+
+    await kill({});
+
+    return end();
+  }
+
   try {
     await control.generate({count});
 

package/test/integration/test_get_chain_transactions.js

@@ -20,12 +20,16 @@ test(`Get chain transactions`, async ({end, equal, strictSame}) => {
   // Generate some funds for LND
   await generate({count});
 
-  await asyncRetry({interval: 10, times: 1000}, async () => {
+  await asyncRetry({interval: 10, times: 2000}, async () => {
     const wallet = await getWalletInfo({lnd});
 
     if (!wallet.is_synced_to_chain) {
       throw new Error('ExpectedWalletSyncedToChain');
     }
+
+    if (wallet.current_block_height !== count + 1) {
+      throw new Error('ExpectedFullySyncedToChain');
+    }
   });
 
   // Wait for generation to be over

package/test/integration/test_get_closed_channels.js

@@ -219,14 +219,14 @@ test(`Get closed channels`, async ({end, equal}) => {
   equal(!!settleHtlc.transaction_id, true, 'Output tx id');
   equal(settleHtlc.transaction_vout !== undefined, true, 'Output tx vout');
 
-  const alsoDead = await asyncRetry({interval: 2000, times: 99}, async () => {
+  const alsoDead = await asyncRetry({interval: 20, times: 7000}, async () => {
     const {channels} = await getClosedChannels({lnd: target.lnd});
 
     if (channels.length === [toForceClose, channelOpen].length) {
       return channels;
     }
 
-    await target.generate({count: 100});
+    await target.generate({});
 
     throw new Error('WaitingForTargetForceClose');
   });

package/test/integration/test_trusted_funding.js

@@ -25,7 +25,7 @@ const size = 2;
 const times = 2000;
 
 // Opening unconfirmed channels should in immediate channel opening
-test(`Open unconfirmed channels`, async ({end, equal, strictSame}) => {
+test(`Open unconfirmed channels`, async ({end, equal, match, strictSame}) => {
   // Unconfirmed channels are not supported on LND 0.15.0 and below
   {
     const {kill, nodes} = await spawnLightningCluster({});
@@ -126,15 +126,15 @@ test(`Open unconfirmed channels`, async ({end, equal, strictSame}) => {
 
     // Make sure the channel reflects that it is trusted funding
     strictSame(channel.other_ids, [], 'Got no ephemeral ids');
-    equal(channel.id, '16000000x0x0', 'Channel id is faked');
+    match(channel.id, /16000000x0/, 'Channel id is faked');
     equal(channel.is_trusted_funding, true, 'Channel funding is trusted');
 
     // Make sure the open channel event reflected that it was trusted funding
     const [event] = opened;
 
-    strictSame(event.other_ids, [], 'Got no ephemeral ids');
-    equal(event.id, '16000000x0x0', 'Channel id is faked');
-    equal(event.is_trusted_funding, true, 'Channel funding is trusted');
+    strictSame(event.other_ids, [], 'Got no event ephemeral ids');
+    match(event.id, /16000000x0/, 'Channel event id is faked');
+    equal(event.is_trusted_funding, true, 'Channel event funding is trusted');
 
     // Make sure the channel can be used immediately
     await pay({lnd, request: invoice.request});
@@ -156,7 +156,11 @@ test(`Open unconfirmed channels`, async ({end, equal, strictSame}) => {
 
     equal(confirmed.id, '102x1x0', 'Channel id is real now');
     equal(confirmed.is_trusted_funding, true, 'Channel funding was trusted');
-    strictSame(confirmed.other_ids, ['16000000x0x0'], 'Got ephemeral ids');
+    equal(confirmed.other_ids.length, 1, 'Got ephemeral id');
+
+    const [otherId] = confirmed.other_ids;
+
+    match(otherId, /16000000x0/, 'Got ephemeral id');
 
     await closeChannel({lnd, id: confirmed.id});
 
@@ -210,7 +214,11 @@ test(`Open unconfirmed channels`, async ({end, equal, strictSame}) => {
       return confirmed;
     });
 
-    strictSame(privateConfirmed.other_ids, ['16000000x0x1'], 'Got private id');
+    equal(privateConfirmed.other_ids.length, 1, 'Got private ephemeral ids');
+
+    const [privateOtherId] = privateConfirmed.other_ids;
+
+    match(privateOtherId, /16000000x0/, 'Got private id');
 
     const [closedChannel] = (await getClosedChannels({lnd})).channels;
 
@@ -224,16 +232,12 @@ test(`Open unconfirmed channels`, async ({end, equal, strictSame}) => {
 
     const ephemeralIds = await getEphemeralChannelIds({lnd});
 
-    strictSame(
-      ephemeralIds,
-      {
-        channels: [
-          {other_ids: [], reference_id: '16000000x0x0'},
-          {other_ids: [], reference_id: '16000000x0x1'},
-        ],
-      },
-      'Ephemeral ids are returned'
-    );
+    equal(ephemeralIds.channels.length, 2, 'Got ephemeral channel ids');
+
+    const [firstChannel, secondChannel] = ephemeralIds.channels;
+
+    match(firstChannel.reference_id, /16000000x0/, 'Got first channel id');
+    match(secondChannel.reference_id, /16000000x0/, 'Got second channel id');
   } catch (err) {
     equal(err, null, 'No error is reported');
   } finally {

package/test/routerrpc-integration/test_multipath_payment.js

@@ -1,7 +1,10 @@
+const asyncRetry = require('async/retry');
 const {spawnLightningCluster} = require('ln-docker-daemons');
 const {test} = require('@alexbosworth/tap');
 
 const {createInvoice} = require('./../../');
+const {getChannelBalance} = require('./../../');
+const {getChannels} = require('./../../');
 const {getInvoice} = require('./../../');
 const {getRouteToDestination} = require('./../../');
 const {parsePaymentRequest} = require('./../../');
@@ -13,8 +16,11 @@ const {waitForRoute} = require('./../macros');
 const all = promise => Promise.all(promise);
 const capacity = 1e6;
 const {ceil} = Math;
+const interval = 10;
+const maturity = 100;
 const {round} = Math;
 const size = 2;
+const times = 2000;
 
 // Paying using multiple paths should execute the payment across paths
 test(`Pay with multiple paths`, async ({end, equal, rejects, strictSame}) => {
@@ -22,22 +28,50 @@ test(`Pay with multiple paths`, async ({end, equal, rejects, strictSame}) => {
 
   const [{generate, lnd}, target] = nodes;
 
-  await generate({count: 400});
+  await generate({count: maturity});
 
   const channel1 = await setupChannel({
     capacity,
     generate,
     lnd,
+    hidden: true,
     to: target,
   });
 
+  await asyncRetry({interval, times}, async () => {
+    const {channels} = await getChannels({lnd});
+
+    await generate({});
+
+    if (!channels.length) {
+      throw new Error('ExpectedChannelCreated');
+    }
+  });
+
   const channel2 = await setupChannel({
     capacity,
     generate,
     lnd,
+    hidden: true,
     to: target,
   });
 
+  await asyncRetry({interval, times}, async () => {
+    const {channels} = await getChannels({lnd, is_active: true});
+
+    await generate({});
+
+    if (channels.length < size) {
+      throw new Error('ExpectedSecondChannelCreated');
+    }
+
+    const balance = await getChannelBalance({lnd});
+
+    if (balance.channel_balance < capacity) {
+      throw new Error('ExpectedChannelBalancePresent');
+    }
+  });
+
   const channels = [channel1, channel2];
 
   const payParts = [
@@ -50,15 +84,23 @@ test(`Pay with multiple paths`, async ({end, equal, rejects, strictSame}) => {
   const {request} = await createInvoice({tokens, lnd: target.lnd});
 
   // Payment should fail with only 1 path
-  try {
-    await payViaPaymentRequest({lnd, request, max_paths: [channel1].length});
-  } catch (err) {
-    strictSame(
-      err,
-      [503, 'PaymentPathfindingFailedToFindPossibleRoute'],
-      'No path'
-    );
-  }
+  await asyncRetry({interval, times}, async () => {
+    try {
+      await payViaPaymentRequest({lnd, request, max_paths: [channel1].length});
+    } catch (err) {
+      const [, message] = err;
+
+      if (message !== 'PaymentPathfindingFailedToFindPossibleRoute') {
+        throw err;
+      }
+
+      strictSame(
+        err,
+        [503, 'PaymentPathfindingFailedToFindPossibleRoute'],
+        'No path'
+      );
+    }
+  });
 
   // Payment should succeed with 2 paths
   try {

package/test/routerrpc-integration/test_subscribe_to_forward_requests.js

@@ -75,10 +75,15 @@ test(`Subscribe to requests`, async ({end, equal, rejects, strictSame}) => {
 
     await once(pay, 'failed');
 
+    equal(failures.length, 1, 'Got a failure');
+
+    const [failed] = failures;
+
+    delete failed.channel;
+
     strictSame(
-      failures,
-      [{
-        channel: channel.id,
+      failed,
+      {
         index: 1,
         mtokens: '101000',
         public_key: target.id,
@@ -114,7 +119,7 @@ test(`Subscribe to requests`, async ({end, equal, rejects, strictSame}) => {
           tokens: 101,
           total_mtokens: '100000',
         },
-      }],
+      },
       'Failure is emitted'
     );
 
@@ -135,10 +140,13 @@ test(`Subscribe to requests`, async ({end, equal, rejects, strictSame}) => {
       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');
+      equal(pending.paths.length, 1, 'Path is present');
+
+      const [path] = pending.paths;
 
       strictSame(
-        pending.paths,
-        [{
+        path,
+        {
           fee: 1,
           fee_mtokens: '1000',
           hops: [
@@ -168,7 +176,7 @@ test(`Subscribe to requests`, async ({end, equal, rejects, strictSame}) => {
           timeout: height + 40 + 43,
           tokens: 101,
           total_mtokens: '100000',
-        }],
+        },
         'Paths are present'
       );
 

package/test/walletrpc-integration/test_get_locked_utxos.js

@@ -43,6 +43,13 @@ test(`Lock UTXO`, async ({end, equal, rejects, strictSame}) => {
 
     const [locked] = (await getLockedUtxos({lnd})).utxos;
 
+    const got = {
+      lock_expires_at: locked.lock_expires_at,
+      lock_id: locked.lock_id,
+      transaction_id: locked.transaction_id,
+      transaction_vout: locked.transaction_vout,
+    };
+
     const expected = {
       lock_expires_at: lock.expires_at,
       lock_id: lock.id,
@@ -50,7 +57,14 @@ test(`Lock UTXO`, async ({end, equal, rejects, strictSame}) => {
       transaction_vout: utxo.transaction_vout,
     };
 
-    strictSame(locked, expected, 'Got expected UTXO lock');
+    strictSame(got, expected, 'Got expected UTXO lock');
+
+    // LND 0.15.0 and below do not support locked UTXO output script
+    if (!!locked.output_script) {
+      equal(locked.output_script, utxo.output_script, 'Got output script');
+      equal(locked.tokens, utxo.tokens, 'Got output value');
+    }
+
   } catch (err) {
     strictSame(
       err,

package/test/walletrpc-integration/test_sign_psbt.js

@@ -10,7 +10,6 @@ const {broadcastChainTransaction} = require('./../../');
 const {createChainAddress} = require('./../../');
 const {fundPsbt} = require('./../../');
 const {getChainBalance} = require('./../../');
-const {getChainTransactions} = require('./../../');
 const {getUtxos} = require('./../../');
 const {sendToChainAddress} = require('./../../');
 const {signPsbt} = require('./../../');