ln-service 57.1.2 → 57.2.0

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Versions
 
+## 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
+
 ## 57.1.2
 
 - Add support for LND 0.17.2

package/README.md

@@ -9,7 +9,7 @@ through npm.
 
 Supported LND versions:
 
-- v0.17.0-beta to v0.17.2-beta
+- v0.17.0-beta to v0.17.3-beta
 - v0.16.0-beta to v0.16.4-beta
 - v0.15.2-beta to v0.15.5-beta
 - v0.14.4-beta to v0.14.5-beta
@@ -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,6 +181,7 @@ 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
@@ -966,6 +968,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 +1660,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.

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,6 +40,7 @@ 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');
@@ -173,6 +175,7 @@ module.exports = {
   createUnsignedRequest,
   createWallet,
   decodePaymentRequest,
+  deleteChainTransaction,
   deleteFailedPayAttempts,
   deleteFailedPayments,
   deleteForwardingReputations,
@@ -196,6 +199,7 @@ module.exports = {
   getChainBalance,
   getChainFeeEstimate,
   getChainFeeRate,
+  getChainTransaction,
   getChainTransactions,
   getChannel,
   getChannelBalance,

package/package.json

@@ -9,7 +9,7 @@
   "dependencies": {
     "bolt07": "1.8.4",
     "invoices": "3.0.0",
-    "lightning": "10.1.3",
+    "lightning": "10.2.0",
     "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.6",
     "p2tr": "2.0.0",
     "portfinder": "1.0.32",
     "psbt": "3.0.0",
@@ -52,6 +52,8 @@
     "url": "https://github.com/alexbosworth/ln-service.git"
   },
   "scripts": {
+    "integration-test-0.17.3": "DOCKER_LND_VERSION=v0.17.3-beta npm run test",
+    "integration-test-0.17.2": "DOCKER_LND_VERSION=v0.17.2-beta npm run test",
     "integration-test-0.17.1": "DOCKER_LND_VERSION=v0.17.1-beta npm run test",
     "integration-test-0.17.0": "DOCKER_LND_VERSION=v0.17.0-beta npm run test",
     "integration-test-0.16.4": "DOCKER_LND_VERSION=v0.16.4-beta npm run test",
@@ -67,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.2"
+  "version": "57.2.0"
 }

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;
+});