ln-service 57.17.0 → 57.19.0

package/CHANGELOG.md

@@ -1,9 +1,21 @@
 # Versions
 
+## 57.19.0
+
+- `createInvoice`: add `is_encrypting_routes` to enable blinded paths feature
+
+- `pay`, `subscribeToPastPayment`, `subscribeToPayViaDetails`,
+    `subscribeToPayViaRequest`, `subscribeToPayments`: Add `is_canceled` for
+    when the payment loop was explicitly canceled.
+
+## 57.18.0
+
+- `getMinimumRelayFee`: Add method to get the chain backend minimum relay fee
+
 ## 57.17.0
 
 - `getFeeRates`: Add support for `inbound_base_discount_mtokens`,
-    'inbound_rate_discount` for inbound fee policy discounts
+    `inbound_rate_discount` for inbound fee policy discounts
 
 ## 57.16.0
 

package/README.md

@@ -830,6 +830,7 @@ Requires `address:write`, `invoices:write` permission
       [description]: <Invoice Description String>
       [description_hash]: <Hashed Description of Payment Hex String>
       [expires_at]: <Expires At ISO 8601 Date String>
+      [is_encrypting_routes]: <Use Blinded Paths For Inbound Routes Bool>
       [is_fallback_included]: <Is Fallback Address Included Bool>
       [is_fallback_nested]: <Is Fallback Address Nested Bool>
       [is_including_private_channels]: <Invoice Includes Private Channels Bool>
@@ -2732,6 +2733,25 @@ const allowedMethods = methods.filter(method => {
 });
 ```
 
+### getMinimumRelayFee
+
+Get the current minimum relay fee for the chain backend
+
+Requires LND built with `walletrpc` tag
+
+Requires `onchain:read` permission
+
+This method is not supported on LND 0.18.2 and below
+
+    {
+      lnd: <Authenticated LND API Object>
+    }
+
+    @returns via cbk or Promise
+    {
+      tokens_per_vbyte: <Minimum Relayable Tokens Per Virtual Byte Number>
+    }
+
 ### getNetworkCentrality
 
 Get the graph centrality scores of the nodes on the network
@@ -3773,10 +3793,13 @@ Requires `info:read` permission
         type: <Feature Type String>
       }]
       is_synced_to_chain: <Is Synced To Chain Bool>
+      [is_synced_to_graph]: <Is Synced To Network Graph Bool>
       latest_block_at: <Latest Known Block At Date String>
       peers_count: <Peer Count Number>
       pending_channels_count: <Pending Channels Count Number>
       public_key: <Public Key String>
+      [uris]: [<The URIs of the Node String>]
+      version: <LND Version String>
     }
 
 Example:
@@ -6415,6 +6438,7 @@ Preferred `confidence` is not supported on LND 0.14.5 and below
     @event 'failed'
     {
       id: <Payment Hash Hex String>
+      is_canceled: <Payment Canceled Bool>
       is_insufficient_balance: <Failed Due To Lack of Balance Bool>
       is_invalid_payment: <Failed Due to Invalid Payment Bool>
       is_pathfinding_timeout: <Failed Due to Pathfinding Timeout Bool>
@@ -6570,6 +6594,7 @@ Preferred `confidence` is not supported on LND 0.14.5 and below
     @event 'failed'
     {
       id: <Payment Hash Hex String>
+      is_canceled: <Payment Canceled Bool>
       is_insufficient_balance: <Failed Due To Lack of Balance Bool>
       is_invalid_payment: <Failed Due to Invalid Payment Bool>
       is_pathfinding_timeout: <Failed Due to Pathfinding Timeout Bool>
@@ -6904,6 +6929,7 @@ Note: Method not supported on LND 0.15.5 and below
     @event 'failed'
     {
       id: <Payment Hash Hex String>
+      is_canceled: <Payment Canceled Bool>
       is_insufficient_balance: <Failed Due To Lack of Balance Bool>
       is_invalid_payment: <Failed Due to Payment Rejected At Destination Bool>
       is_pathfinding_timeout: <Failed Due to Pathfinding Timeout Bool>

package/index.js

@@ -63,6 +63,7 @@ const {getInvoices} = require('lightning');
 const {getLockedUtxos} = require('lightning');
 const {getMasterPublicKeys} = require('lightning');
 const {getMethods} = require('lightning');
+const {getMinimumRelayFee} = require('lightning');
 const {getNetworkCentrality} = require('lightning');
 const {getNetworkGraph} = require('lightning');
 const {getNetworkInfo} = require('lightning');
@@ -228,6 +229,7 @@ module.exports = {
   getLockedUtxos,
   getMasterPublicKeys,
   getMethods,
+  getMinimumRelayFee,
   getNetworkCentrality,
   getNetworkGraph,
   getNetworkInfo,

package/package.json

@@ -9,14 +9,14 @@
   "dependencies": {
     "bolt07": "1.9.4",
     "invoices": "3.0.0",
-    "lightning": "10.17.0",
+    "lightning": "10.19.0",
     "macaroon": "3.0.4"
   },
   "description": "Interaction helper for your Lightning Network daemon",
   "devDependencies": {
     "@alexbosworth/blockchain": "2.0.0",
     "@alexbosworth/node-fetch": "2.6.2",
-    "async": "3.2.5",
+    "async": "3.2.6",
     "asyncjs-util": "1.2.12",
     "bip32": "4.0.0",
     "bip66": "2.0.0",
@@ -24,7 +24,7 @@
     "bn.js": "5.2.1",
     "bs58check": "4.0.0",
     "ecpair": "2.1.0",
-    "ln-docker-daemons": "6.0.21",
+    "ln-docker-daemons": "6.0.23",
     "p2tr": "2.0.0",
     "portfinder": "1.0.32",
     "psbt": "3.0.0",
@@ -74,5 +74,5 @@
     "integration-test-0.14.4": "DOCKER_LND_VERSION=v0.14.4-beta npm run test",
     "test": "echo $DOCKER_LND_VERSION && node test/runner"
   },
-  "version": "57.17.0"
+  "version": "57.19.0"
 }

package/test/integration/test_encrypted_routes.js

@@ -0,0 +1,66 @@
+const asyncRetry = require('async/retry');
+const {strictEqual} = require('node:assert').strict;
+const test = require('node:test');
+
+const {setupChannel} = require('ln-docker-daemons');
+const {spawnLightningCluster} = require('ln-docker-daemons');
+
+const {addPeer} = require('./../../');
+const {createInvoice} = require('./../../');
+const {decodePaymentRequest} = require('./../../');
+const {getWalletInfo} = require('./../../');
+const {parsePaymentRequest} = require('./../../');
+const {pay} = require('./../../');
+
+const count = 100;
+const expiry = () => new Date(Date.now() + (4 * 60 * 60 * 1000)).toISOString();
+const give = 500000;
+const interval = 100;
+const size = 3;
+const times = 10000;
+const tokens = 100;
+
+// Paying to an encrypted routes invoice should result in a payment
+test(`Create an invoice`, async () => {
+  const {kill, nodes} = await spawnLightningCluster({size});
+
+  const [{generate, lnd}, target, remote] = nodes;
+
+  await generate({count});
+
+  try {
+    await setupChannel({generate, lnd, give_tokens: give, to: target});
+
+    await addPeer({lnd, public_key: remote.id, socket: remote.socket});
+
+    await setupChannel({
+      generate: target.generate,
+      give_tokens: give,
+      lnd: target.lnd,
+      to: remote,
+    });
+
+    await asyncRetry({interval, times}, async () => {
+      await generate({});
+
+      const invoice = await createInvoice({
+        lnd,
+        tokens,
+        expires_at: expiry(),
+        is_encrypting_routes: true,
+      });
+
+      await addPeer({lnd, public_key: remote.id, socket: remote.socket});
+
+      await pay({lnd: remote.lnd, request: invoice.request});
+    });
+
+    await kill({});
+  } catch (err) {
+    await kill({});
+
+    strictEqual(err, null, 'Expected no error in create invoice');
+  }
+
+  return;
+});

package/test/integration/test_get_failed_payments.js

@@ -114,6 +114,7 @@ test('Get failed payments', async () => {
         {
           failed: {
             id: payment.id,
+            is_canceled: false,
             is_insufficient_balance: false,
             is_invalid_payment: false,
             is_pathfinding_timeout: false,
@@ -151,11 +152,13 @@ test('Get failed payments', async () => {
       deepStrictEqual(payment.safe_tokens, invoice.tokens, 'Safe tokens');
       deepStrictEqual(payment.tokens, invoice.tokens, 'Failed has tokens');
     }
+
+    await kill({});
   } catch (err) {
+    await kill({});
+
     strictEqual(err, null, 'Expected no error');
   }
 
-  await kill({});
-
   return;
 });

package/test/walletrpc-integration/test_get_minimum_relay_fee.js

@@ -0,0 +1,26 @@
+const {equal} = require('node:assert').strict;
+const test = require('node:test');
+
+const {spawnLightningCluster} = require('ln-docker-daemons');
+
+const {getMinimumRelayFee} = require('./../../');
+
+// Getting the min chain fee rate should return the min fee rate
+test(`Get minimum chain fee rate`, async () => {
+  const [{kill, lnd}] = (await spawnLightningCluster({})).nodes;
+
+  try {
+    const feeRate = await getMinimumRelayFee({lnd});
+
+    await kill({});
+
+    // LND 0.18.2 and below do not return a minimum relay fee rate
+    if (!!feeRate.tokens_per_vbyte) {
+      equal(feeRate.tokens_per_vbyte, 1.012, 'Fee rate is returned');
+    }
+  } catch (err) {
+    equal(null, err, 'Expected no error getting relay fee');
+  }
+
+  return;
+});