ln-service 57.1.3 → 57.3.0

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Versions
 
+## 57.3.0
+
+- `getConfiguration`: Add method to return configuration information
+
+## 57.2.0
+
+- `deleteChainTransaction`: Add method to delete a chain transaction
+- `getChainTransaction`: Add method to get a chain transaction
+
 ## 57.1.3
 
 - Add support for LND 0.17.3

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017-2023 Alex Bosworth
+Copyright (c) 2017-2024 Alex Bosworth
 Copyright (c) 2017 BitcoinJS
 
 Permission is hereby granted, free of charge, to any person obtaining a copy

package/README.md

@@ -153,6 +153,7 @@ for `unlocker` methods.
 - [createUnsignedRequest](#createunsignedrequest) - create an unsigned invoice
 - [createWallet](#createwallet) - Make a new wallet
 - [decodePaymentRequest](#decodepaymentrequest) - Decode a Lightning invoice
+- [deleteChainTransaction](#deletechaintransaction) - Remove chain transaction
 - [deleteFailedPayAttempts](#deletefailedpayattempts) - Remove records of 
     failed pay attempts
 - [deleteFailedPayments](#deletefailedpayments) - Remove records of payments 
@@ -180,11 +181,13 @@ for `unlocker` methods.
 - [getChainBalance](#getchainbalance) - Get the confirmed chain balance
 - [getChainFeeEstimate](#getchainfeeestimate) - Get a chain fee estimate
 - [getChainFeeRate](#getchainfeerate) - Get the fee rate for a conf target
+- [getChainTransaction](#getchaintransaction) - Get single wallet transaction
 - [getChainTransactions](#getchaintransactions) - Get all chain transactions
 - [getChannel](#getchannel) - Get graph information about a channel
 - [getChannelBalance](#getchannelbalance) - Get the balance of channel funds
 - [getChannels](#getchannels) - Get all open channels
 - [getClosedChannels](#getclosedchannels) - Get previously open channels
+- [getConfiguration](#getconfiguration) - Get configuration information
 - [getConnectedWatchtowers](#getconnectedwatchtowers) - Get connected towers
 - [getEphemeralChannelIds](#getephemeralchannelids) - Get other channel ids
 - [getFailedPayments](#getfailedpayments) - Get payments that were failed back
@@ -966,6 +969,30 @@ const request = 'bolt11EncodedPaymentRequestString';
 const details = await decodePaymentRequest({lnd, request});
 ```
 
+### deleteChainTransaction
+
+Remove a chain transaction.
+
+Requires `onchain:write` permission
+
+This method is not supported on LND 0.17.3 and below
+
+    {
+      id: <Transaction Id Hex String>
+      lnd: <Authenticated LND API Object>
+    }
+
+    @returns via cbk or Promise
+
+Example:
+
+```node
+const {deleteChainTransaction} = require('ln-service');
+
+// Eliminate past broadcast chain transaction
+await deleteChainTransaction({id, lnd});
+```
+
 ### deleteFailedPayAttempts
 
 Delete failed payment attempt records
@@ -1634,6 +1661,47 @@ const {getChainFeeRate} = require('ln-service');
 const fee = (await getChainFeeRate({lnd, confirmation_target: 6})).tokens_per_vbyte;
 ```
 
+### getChainTransaction
+
+Get a chain transaction.
+
+Requires `onchain:read` permission
+
+This method is not supported on LND 0.17.3 and below
+
+    {
+      id: <Transaction Id Hex String>
+      lnd: <Authenticated LND API Object>
+    }
+
+    @returns via cbk or Promise
+    {
+      [block_id]: <Block Hash String>
+      [confirmation_count]: <Confirmation Count Number>
+      [confirmation_height]: <Confirmation Block Height Number>
+      created_at: <Created ISO 8601 Date String>
+      [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>]
+      tokens: <Tokens Including Fee Number>
+      [transaction]: <Raw Transaction Hex String>
+    }
+
+Example:
+
+```node
+const {getChainTransaction} = require('ln-service');
+const txIsConfirmed = (await getChainTransaction({id, lnd})).is_confirmed;
+```
+
 ### getChainTransactions
 
 Get chain transactions.
@@ -1905,6 +1973,36 @@ const {getClosedChannels} = require('ln-service');
 const breachCount = await getClosedChannels({lnd, is_breach_close: true});
 ```
 
+### getConfiguration
+
+Get the current configuration file settings and the output log
+
+Requires `info:read`, `offchain:read`, `onchain:read`, `peers:read`
+permissions
+
+This method is not supported on LND 0.17.3 and below
+
+    {
+      lnd: <Authenticated LND API Object>
+    }
+
+    @returns via cbk or Promise
+    {
+      log: [<Log Line String>]
+      options: [{
+        type: <Option Type String>
+        value: <Option Value String>
+      }]
+    }
+
+Example:
+
+```node
+const {getConfiguration} = require('ln-service');
+const {log, options} = await getConfiguration({});
+const minimumChannelSize = options.find(n => n.type === 'minchansize').value;
+```
+
 ### getConnectedWatchtowers
 
 Get a list of connected watchtowers and watchtower info
@@ -2274,6 +2372,7 @@ Requires `invoices:read` permission
       [chain_address]: <Fallback Chain Address String>
       cltv_delta: <CLTV Delta Number>
       [confirmed_at]: <Settled at ISO 8601 Date String>
+      [confirmed_index]: <Confirmed Index Number>
       created_at: <ISO 8601 Date String>
       description: <Description String>
       [description_hash]: <Description Hash Hex String>

package/index.js

@@ -16,6 +16,7 @@ const {createSignedRequest} = require('invoices');
 const {createUnsignedRequest} = require('invoices');
 const {createWallet} = require('lightning');
 const {decodePaymentRequest} = require('lightning');
+const {deleteChainTransaction} = require('lightning');
 const {deleteForwardingReputations} = require('lightning');
 const {deleteFailedPayAttempts} = require('lightning');
 const {deleteFailedPayments} = require('lightning');
@@ -39,11 +40,13 @@ const {getChainAddresses} = require('lightning');
 const {getChainBalance} = require('lightning');
 const {getChainFeeEstimate} = require('lightning');
 const {getChainFeeRate} = require('lightning');
+const {getChainTransaction} = require('lightning');
 const {getChainTransactions} = require('lightning');
 const {getChannel} = require('lightning');
 const {getChannelBalance} = require('lightning');
 const {getChannels} = require('lightning');
 const {getClosedChannels} = require('lightning');
+const {getConfiguration} = require('lightning');
 const {getConnectedWatchtowers} = require('lightning');
 const {getEphemeralChannelIds} = require('lightning');
 const {getFailedPayments} = require('lightning');
@@ -173,6 +176,7 @@ module.exports = {
   createUnsignedRequest,
   createWallet,
   decodePaymentRequest,
+  deleteChainTransaction,
   deleteFailedPayAttempts,
   deleteFailedPayments,
   deleteForwardingReputations,
@@ -196,11 +200,13 @@ module.exports = {
   getChainBalance,
   getChainFeeEstimate,
   getChainFeeRate,
+  getChainTransaction,
   getChainTransactions,
   getChannel,
   getChannelBalance,
   getChannels,
   getClosedChannels,
+  getConfiguration,
   getConnectedWatchtowers,
   getEphemeralChannelIds,
   getFailedPayments,

package/package.json

@@ -9,7 +9,7 @@
   "dependencies": {
     "bolt07": "1.8.4",
     "invoices": "3.0.0",
-    "lightning": "10.1.4",
+    "lightning": "10.3.1",
     "macaroon": "3.0.4"
   },
   "description": "Interaction helper for your Lightning Network daemon",
@@ -24,7 +24,7 @@
     "bn.js": "5.2.1",
     "bs58check": "3.0.1",
     "ecpair": "2.1.0",
-    "ln-docker-daemons": "6.0.5",
+    "ln-docker-daemons": "6.0.7",
     "p2tr": "2.0.0",
     "portfinder": "1.0.32",
     "psbt": "3.0.0",
@@ -69,5 +69,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.1.3"
+  "version": "57.3.0"
 }

package/test/integration/test_get_configuration.js

@@ -0,0 +1,35 @@
+const {deepEqual} = require('node:assert').strict;
+const {equal} = require('node:assert').strict;
+const {ok} = require('node:assert').strict;
+const test = require('node:test');
+
+const asyncRetry = require('async/retry');
+const {spawnLightningCluster} = require('ln-docker-daemons');
+
+const {getConfiguration} = require('./../../');
+const {getWalletInfo} = require('./../../');
+
+// Getting the configuration info should return info about the config
+test(`Get configuration info`, async () => {
+  const {kill, nodes} = await spawnLightningCluster({});
+
+  const [{lnd}] = nodes;
+
+  try {
+    const {log, options} = await getConfiguration({lnd});
+
+    ok(!!log.length, 'Got the log lines');
+
+    const color = options.find(n => n.type === 'color').value.toLowerCase();
+
+    equal(color, (await getWalletInfo({lnd})).color, 'Got color from config');
+
+    await kill({});
+  } catch (err) {
+    await kill({});
+
+    deepEqual(err, [501, 'GetDebugConfigurationInfoNotSupported'], '404');
+  }
+
+  return;
+});

package/test/integration/test_get_forwards.js

@@ -24,12 +24,16 @@ test('Get forwards', async () => {
 
   const [{generate, lnd}, target, remote] = nodes;
 
-  await setupChannel({generate, lnd, to: target});
+  await asyncRetry({interval, times}, async () => {
+    await addPeer({lnd, public_key: remote.id, socket: remote.socket});
 
-  await setupChannel({
-    lnd: target.lnd,
-    generate: target.generate,
-    to: remote,
+    await setupChannel({generate, lnd, to: target});
+
+    await setupChannel({
+      lnd: target.lnd,
+      generate: target.generate,
+      to: remote,
+    });
   });
 
   await addPeer({lnd, public_key: remote.id, socket: remote.socket});

package/test/integration/test_get_network_centrality.js

@@ -24,14 +24,16 @@ test(`Get network centrality`, async () => {
   try {
     await control.generate({count: 100});
 
-    await addPeer({lnd, public_key: remote.id, socket: remote.socket});
+    await asyncRetry({interval, times}, async () => {
+      await addPeer({lnd, public_key: remote.id, socket: remote.socket});
 
-    await setupChannel({lnd, generate: control.generate, to: target});
+      await setupChannel({lnd, generate: control.generate, to: target});
 
-    await setupChannel({
-      generate: target.generate,
-      lnd: target.lnd,
-      to: remote,
+      await setupChannel({
+        generate: target.generate,
+        lnd: target.lnd,
+        to: remote,
+      });
     });
 
     await asyncRetry({interval, times}, async () => {

package/test/routerrpc-integration/test_is_destination_payable.js

@@ -2,12 +2,15 @@ const {deepEqual} = require('node:assert').strict;
 const {equal} = require('node:assert').strict;
 const test = require('node:test');
 
+const asyncRetry = require('async/retry');
 const {setupChannel} = require('ln-docker-daemons');
 const {spawnLightningCluster} = require('ln-docker-daemons');
 
 const {isDestinationPayable} = require('./../../');
 
+const interval = 100;
 const size = 2;
+const times = 1000;
 const tokens = 1e6 / 2;
 
 // Determining if a route is payable should indicate if a route can be found
@@ -17,7 +20,9 @@ test('Is destination payable', async () => {
   const [{generate, lnd}, target] = nodes;
 
   try {
-    await setupChannel({generate, lnd, to: target});
+    await asyncRetry({interval, times}, async () => {
+      await setupChannel({generate, lnd, to: target});
+    });
 
     const canPay = await isDestinationPayable({lnd, destination: target.id});
 

package/test/routerrpc-integration/test_pay_via_payment_request.js

@@ -42,7 +42,9 @@ test(`Pay via payment request`, async () => {
       }
     });
 
-    const channel = await setupChannel({generate, lnd, to: target});
+    const channel = await asyncRetry({interval, times}, async () => {
+      return await setupChannel({generate, lnd, to: target});
+    });
 
     // Make sure that an error is returned when there is no route
     try {

package/test/walletrpc-integration/test_delete_chain_transaction.js

@@ -0,0 +1,82 @@
+const {deepEqual} = require('node:assert').strict;
+const {equal} = require('node:assert').strict;
+const test = require('node:test');
+
+const asyncRetry = require('async/retry');
+const {spawnLightningCluster} = require('ln-docker-daemons');
+
+const {broadcastChainTransaction} = require('./../../');
+const {createChainAddress} = require('./../../');
+const {deleteChainTransaction} = require('./../../');
+const {fundPsbt} = require('./../../');
+const {getChainTransactions} = require('./../../');
+const {getWalletInfo} = require('./../../');
+const {signPsbt} = require('./../../');
+
+const count = 100;
+const defaultFee = 1e3;
+const format = 'np2wpkh';
+const interval = 100;
+const times = 300;
+const tokens = 1e6;
+
+// Deleting a chain transaction should delete the chain transactions
+test(`Delete chain transaction`, async () => {
+  const {kill, nodes} = await spawnLightningCluster({});
+
+  const [{generate, lnd}] = nodes;
+
+  // Generate some funds for LND
+  await generate({count});
+
+  await asyncRetry({interval: 10, times: 6000}, async () => {
+    const wallet = await getWalletInfo({lnd});
+
+    if (!wallet.is_synced_to_chain) {
+      throw new Error('ExpectedWalletSyncedToChain');
+    }
+
+    await generate({});
+
+    if (wallet.current_block_height < count + 1) {
+      throw new Error('ExpectedFullySyncedToChain');
+    }
+  });
+
+  // Wait for generation to be over
+  const tx = await asyncRetry({times}, async () => {
+    const {transactions} = await getChainTransactions({lnd});
+
+    const [tx] = transactions;
+
+    if (!tx.is_confirmed) {
+      throw new Error('ExpectedTransactionConfirmed');
+    }
+
+    return tx;
+  });
+
+  const {address} = await createChainAddress({lnd});
+
+  const funded = await asyncRetry({interval, times}, async () => {
+    await generate({});
+
+    return await fundPsbt({lnd, outputs: [{address, tokens}]});
+  });
+
+  const {transaction} = await signPsbt({lnd, psbt: funded.psbt});
+
+  const {id} = await broadcastChainTransaction({lnd, transaction});
+
+  try {
+    await deleteChainTransaction({id, lnd});
+
+    await kill({});
+  } catch (err) {
+    await kill({});
+
+    deepEqual(err, [501, 'RemoveChainTransactionMethodNotSupported'], 'None');
+  }
+
+  return;
+});

package/test/walletrpc-integration/test_get_chain_transaction.js

@@ -0,0 +1,70 @@
+const {deepEqual} = require('node:assert').strict;
+const {equal} = require('node:assert').strict;
+const test = require('node:test');
+
+const asyncRetry = require('async/retry');
+const {spawnLightningCluster} = require('ln-docker-daemons');
+
+const {getChainTransaction} = require('./../../');
+const {getChainTransactions} = require('./../../');
+const {getWalletInfo} = require('./../../');
+
+const count = 100;
+const defaultFee = 1e3;
+const format = 'np2wpkh';
+const times = 300;
+
+// Getting a chain transaction should return the chain transactions
+test(`Get chain transaction`, async () => {
+  const {kill, nodes} = await spawnLightningCluster({});
+
+  const [{generate, lnd}] = nodes;
+
+  // Generate some funds for LND
+  await generate({count});
+
+  await asyncRetry({interval: 10, times: 6000}, async () => {
+    const wallet = await getWalletInfo({lnd});
+
+    if (!wallet.is_synced_to_chain) {
+      throw new Error('ExpectedWalletSyncedToChain');
+    }
+
+    await generate({});
+
+    if (wallet.current_block_height < count + 1) {
+      throw new Error('ExpectedFullySyncedToChain');
+    }
+  });
+
+  // Wait for generation to be over
+  await asyncRetry({times}, async () => {
+    const {transactions} = await getChainTransactions({lnd});
+
+    const [tx] = transactions;
+
+    if (!tx.is_confirmed) {
+      throw new Error('ExpectedTransactionConfirmed');
+    }
+
+    return;
+  });
+
+  const {transactions} = await getChainTransactions({lnd});
+
+  const [tx] = transactions;
+
+  try {
+    const singleTx = await getChainTransaction({lnd, id: tx.id});
+
+    await kill({});
+
+    deepEqual(singleTx, tx, 'Transactions are the same');
+  } catch (err) {
+    await kill({});
+
+    deepEqual(err, [501, 'GetChainTransactionMethodNotSupported'], 'Invalid');
+  }
+
+  return;
+});