lightning 10.3.1 → 10.5.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Versions
 
+## 10.5.0
+
+- `getSweepTransactions`: Add `after` to scope sweep result set
+
+## 10.4.0
+
+- `getConnectedWatchtowers`: Add `is_taproot` to get P2TR channels
+
 ## 10.3.1
 
 - `getConfiguration`: Add method to get the configuration file options

package/grpc/protos/walletkit.proto

@@ -1,10 +1,10 @@
 syntax = "proto3";
 
+package walletrpc;
+
 import "lightning.proto";
 import "signer.proto";
 
-package walletrpc;
-
 option go_package = "github.com/lightningnetwork/lnd/lnrpc/walletrpc";
 
 /*
@@ -976,6 +976,91 @@ enum WitnessType {
     to an output which is under complete control of the backing wallet.
     */
     TAPROOT_PUB_KEY_SPEND = 22;
+
+    /*
+    A witness type that allows us to spend our settled local commitment after a
+    CSV delay when we force close the channel.
+    */
+    TAPROOT_LOCAL_COMMIT_SPEND = 23;
+
+    /*
+    A witness type that allows us to spend our settled local commitment after
+    a CSV delay when the remote party has force closed the channel.
+    */
+    TAPROOT_REMOTE_COMMIT_SPEND = 24;
+
+    /*
+    A witness type that we'll use for spending our own anchor output.
+    */
+    TAPROOT_ANCHOR_SWEEP_SPEND = 25;
+
+    /*
+    A witness that allows us to timeout an HTLC we offered to the remote party
+    on our commitment transaction. We use this when we need to go on chain to
+    time out an HTLC.
+    */
+    TAPROOT_HTLC_OFFERED_TIMEOUT_SECOND_LEVEL = 26;
+
+    /*
+    A witness type that allows us to sweep an HTLC we accepted on our commitment
+    transaction after we go to the second level on chain.
+    */
+    TAPROOT_HTLC_ACCEPTED_SUCCESS_SECOND_LEVEL = 27;
+
+    /*
+    A witness that allows us to sweep an HTLC on the revoked transaction of the
+    remote party that goes to the second level.
+    */
+    TAPROOT_HTLC_SECOND_LEVEL_REVOKE = 28;
+
+    /*
+    A witness that allows us to sweep an HTLC sent to us by the remote party
+    in the event that they broadcast a revoked state.
+    */
+    TAPROOT_HTLC_ACCEPTED_REVOKE = 29;
+
+    /*
+    A witness that allows us to sweep an HTLC we offered to the remote party if
+    they broadcast a revoked commitment.
+    */
+    TAPROOT_HTLC_OFFERED_REVOKE = 30;
+
+    /*
+    A witness that allows us to sweep an HTLC we offered to the remote party
+    that lies on the commitment transaction for the remote party. We can spend
+    this output after the absolute CLTV timeout of the HTLC as passed.
+    */
+    TAPROOT_HTLC_OFFERED_REMOTE_TIMEOUT = 31;
+
+    /*
+    A witness type that allows us to sign the second level HTLC timeout
+    transaction when spending from an HTLC residing on our local commitment
+    transaction.
+    This is used by the sweeper to re-sign inputs if it needs to aggregate
+    several second level HTLCs.
+    */
+    TAPROOT_HTLC_LOCAL_OFFERED_TIMEOUT = 32;
+
+    /*
+    A witness that allows us to sweep an HTLC that was offered to us by the
+    remote party for a taproot channels. We use this witness in the case that
+    the remote party goes to chain, and we know the pre-image to the HTLC. We
+    can sweep this without any additional timeout.
+    */
+    TAPROOT_HTLC_ACCEPTED_REMOTE_SUCCESS = 33;
+
+    /*
+    A witness type that allows us to sweep the HTLC offered to us on our local
+    commitment transaction. We'll use this when we need to go on chain to sweep
+    the HTLC. In this case, this is the second level HTLC success transaction.
+    */
+    TAPROOT_HTLC_ACCEPTED_LOCAL_SUCCESS = 34;
+
+    /*
+    A witness that allows us to sweep the settled output of a malicious
+    counterparty's who broadcasts a revoked taproot commitment transaction.
+    */
+    TAPROOT_COMMITMENT_REVOKE = 35;
 }
 
 message PendingSweep {
@@ -1078,6 +1163,13 @@ message ListSweepsRequest {
     replaced-by-fee, so will not be included in this output.
     */
     bool verbose = 1;
+
+    /*
+    The start height to use when fetching sweeps. If not specified (0), the
+    result will start from the earliest sweep. If set to -1 the result will
+    only include unconfirmed sweeps (at the time of the call).
+    */
+    int32 start_height = 2;
 }
 
 message ListSweepsResponse {

package/grpc/protos/wtclient.proto

@@ -193,6 +193,9 @@ enum PolicyType {
 
     // Selects the policy from the anchor tower client.
     ANCHOR = 1;
+
+    // Selects the policy from the taproot tower client.
+    TAPROOT = 2;
 }
 
 message PolicyRequest {

package/lnd_methods/info/get_configuration.d.ts

@@ -22,7 +22,7 @@ export type GetConfigurationResult = {
  * Requires `info:read`, `offchain:read`, `onchain:read`, `peers:read`
   permissions
  *
- * This method is not supported on LND 0.17.3 and below
+ * This method is not supported on LND 0.17.4 and below
  */
 export const getConfiguration: AuthenticatedLightningMethod<
   GetConfigurationArgs,

package/lnd_methods/info/get_configuration.js

@@ -17,7 +17,7 @@ const {values} = Object;
   Requires `info:read`, `offchain:read`, `onchain:read`, `peers:read`
   permissions
 
-  This method is not supported on LND 0.17.3 and below
+  This method is not supported on LND 0.17.4 and below
 
   {
     lnd: <Authenticated LND API Object>

package/lnd_methods/offchain/get_connected_watchtowers.d.ts

@@ -6,6 +6,8 @@ import {
 export type GetConnectedWatchTowersArgs = AuthenticatedLightningArgs<{
   /** Get Anchor Type Tower Info Bool */
   is_anchor?: boolean;
+  /** Get Taproot Type Tower Info Bool */
+  is_taproot?: boolean;
 }>;
 
 export type GetConnectedWatchTowersResult = {
@@ -53,6 +55,8 @@ export type GetConnectedWatchTowersResult = {
  * Requires `offchain:read` permission
  *
  * `is_anchor` flag is not supported on LND 0.11.1 and below
+ *
+ * `is_taproot` flag is not supported on LND 0.17.4 and below
  */
 export const getConnectedWatchtowers: AuthenticatedLightningMethod<
   GetConnectedWatchTowersArgs,

package/lnd_methods/offchain/get_connected_watchtowers.js

@@ -18,8 +18,11 @@ const unimplementedError = '12 UNIMPLEMENTED: unknown service wtclientrpc.Watcht
 
   `is_anchor` flag is not supported on LND 0.11.1 and below
 
+  `is_taproot` flag is not supported on LND 0.17.4 and below
+
   {
     [is_anchor]: <Get Anchor Type Tower Info Bool>
+    [is_taproot]: <Get Taproot Type Tower Info Bool>
     lnd: <Authenticated LND API Object>
   }
 
@@ -57,39 +60,6 @@ module.exports = (args, cbk) => {
         return cbk();
       },
 
-      // Get policy
-      getPolicy: ['validate', ({}, cbk) => {
-        return args.lnd[type].policy({
-          policy_type: !!args.is_anchor ? 'ANCHOR' : 'LEGACY',
-        },
-        (err, res) => {
-          if (!!err && err.message === unimplementedError) {
-            return cbk([503, 'ExpectedWatchtowerClientLndToGetPolicy']);
-          }
-
-          if (!!err) {
-            return cbk([503, 'UnexpectedErrorGettingWatchtowerPolicy', {err}]);
-          }
-
-          if (!res) {
-            return cbk([503, 'ExpectedResultForWatchtowerPolicy']);
-          }
-
-          if (res.max_updates === undefined) {
-            return cbk([503, 'ExpectedMaxUpdateCountInWatchtowerPolicyInfo']);
-          }
-
-          if (res.sweep_sat_per_byte === undefined) {
-            return cbk([503, 'ExpectedSweepSatsPerByteInWatchtowerPolicy']);
-          }
-
-          return cbk(null, {
-            max_session_update_count: res.max_updates,
-            sweep_tokens_per_vbyte: res.sweep_sat_per_byte,
-          });
-        });
-      }],
-
       // Get stats
       getStats: ['validate', ({}, cbk) => {
         return args.lnd[type].stats({}, (err, res) => {
@@ -181,6 +151,49 @@ module.exports = (args, cbk) => {
         });
       }],
 
+      // Determine the policy type
+      policyType: ['validate', ({}, cbk) => {
+        if (!!args.is_anchor) {
+          return cbk(null, 'ANCHOR');
+        }
+
+        if (!!args.is_taproot) {
+          return cbk(null, 'TAPROOT');
+        }
+
+        return cbk(null, 'LEGACY');
+      }],
+
+      // Get policy
+      getPolicy: ['policyType', ({policyType}, cbk) => {
+        return args.lnd[type].policy({policy_type: policyType}, (err, res) => {
+          if (!!err && err.message === unimplementedError) {
+            return cbk([503, 'ExpectedWatchtowerClientLndToGetPolicy']);
+          }
+
+          if (!!err) {
+            return cbk([503, 'UnexpectedErrorGettingWatchtowerPolicy', {err}]);
+          }
+
+          if (!res) {
+            return cbk([503, 'ExpectedResultForWatchtowerPolicy']);
+          }
+
+          if (res.max_updates === undefined) {
+            return cbk([503, 'ExpectedMaxUpdateCountInWatchtowerPolicyInfo']);
+          }
+
+          if (res.sweep_sat_per_byte === undefined) {
+            return cbk([503, 'ExpectedSweepSatsPerByteInWatchtowerPolicy']);
+          }
+
+          return cbk(null, {
+            max_session_update_count: res.max_updates,
+            sweep_tokens_per_vbyte: res.sweep_sat_per_byte,
+          });
+        });
+      }],
+
       // Connected watchtowers
       watchtowers: [
         'getPolicy',

package/lnd_methods/onchain/delete_chain_transaction.d.ts

@@ -14,6 +14,6 @@ export type DeleteChainTransactionArgs = AuthenticatedLightningArgs<{
  *
  * Requires `onchain:write` permission
  *
- * This method is not supported on LND 0.17.3 and below
+ * This method is not supported on LND 0.17.4 and below
  */
 export const deleteChainTransaction: AuthenticatedLightningMethod<DeleteChainTransactionArgs>;

package/lnd_methods/onchain/delete_chain_transaction.js

@@ -13,7 +13,7 @@ const type = 'wallet';
 
   Requires `onchain:write` permission
 
-  This method is not supported on LND 0.17.3 and below
+  This method is not supported on LND 0.17.4 and below
 
   {
     id: <Transaction Id Hex String>

package/lnd_methods/onchain/get_chain_transaction.d.ts

@@ -16,7 +16,7 @@ export type GetChainTransactionResult = ChainTransaction;
  *
  * Requires `onchain:read` permission
  *
- * This method is not supported on LND 0.17.3 and below
+ * This method is not supported on LND 0.17.4 and below
  */
 export const getChainTransaction: AuthenticatedLightningMethod<
   GetChainTransactionArgs,

package/lnd_methods/onchain/get_chain_transaction.js

@@ -13,7 +13,7 @@ const type = 'wallet';
 
   Requires `onchain:read` permission
 
-  This method is not supported on LND 0.17.3 and below
+  This method is not supported on LND 0.17.4 and below
 
   {
     id: <Transaction Id Hex String>

package/lnd_methods/onchain/get_sweep_transactions.d.ts

@@ -3,7 +3,10 @@ import {
   AuthenticatedLightningMethod,
 } from '../../typescript';
 
-export type GetSweepTransactionArgs = AuthenticatedLightningArgs;
+export type GetSweepTransactionArgs = AuthenticatedLightningArgs<{
+  /** Confirmed After Block Height */
+  after?: number;
+}>;
 
 export type GetSweepTransactionsResult = {
   transactions: {
@@ -44,6 +47,10 @@ export type GetSweepTransactionsResult = {
  * Get self-transfer spend transactions related to channel closes
  *
  * Requires `onchain:read` permission
+ *
+ * Requires LND built with `walletrpc` build tag
+ *
+ * `after` is not supported in LND 0.17.3 or below
  */
 export const getSweepTransactions: AuthenticatedLightningMethod<
   GetSweepTransactionArgs,

package/lnd_methods/onchain/get_sweep_transactions.js

@@ -17,7 +17,10 @@ const type = 'wallet';
 
   Requires LND built with `walletrpc` build tag
 
+  `after` is not supported in LND 0.17.3 or below
+
   {
+    [after]: <Confirmed After Block Height Number>
     lnd: <Authenticated LND API Object>
   }
 
@@ -43,7 +46,7 @@ const type = 'wallet';
     }]
   }
 */
-module.exports = ({lnd}, cbk) => {
+module.exports = ({after, lnd}, cbk) => {
   return new Promise((resolve, reject) => {
     return asyncAuto({
       // Check arguments
@@ -57,7 +60,7 @@ module.exports = ({lnd}, cbk) => {
 
       // Get sweep transaction ids
       getSweeps: ['validate', ({}, cbk) => {
-        return lnd[type][method]({}, (err, res) => {
+        return lnd[type][method]({start_height: after}, (err, res) => {
           if (!!err && err.details === notSupportedError) {
             return cbk([501, 'BackingLndDoesNotSupportListingSweeps']);
           }

package/package.json

@@ -7,9 +7,9 @@
     "url": "https://github.com/alexbosworth/lightning/issues"
   },
   "dependencies": {
-    "@grpc/grpc-js": "1.9.14",
+    "@grpc/grpc-js": "1.10.0",
     "@grpc/proto-loader": "0.7.10",
-    "@types/node": "20.11.5",
+    "@types/node": "20.11.16",
     "@types/request": "2.48.12",
     "@types/ws": "8.5.10",
     "async": "3.2.5",
@@ -22,7 +22,7 @@
     "invoices": "3.0.0",
     "psbt": "3.0.0",
     "tiny-secp256k1": "2.2.3",
-    "type-fest": "4.9.0"
+    "type-fest": "4.10.2"
   },
   "description": "Lightning Network client library",
   "devDependencies": {
@@ -53,5 +53,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "10.3.1"
+  "version": "10.5.0"
 }

package/test/lnd_methods/offchain/test_get_connected_watchtowers.js

@@ -198,7 +198,7 @@ const tests = [
     error: [503, 'ExpectedResultForWatchtowerListing'],
   },
   {
-    args: {lnd: makeLnd({towersRes: {}})},
+    args: {is_taproot: true, lnd: makeLnd({towersRes: {}})},
     description: 'Towers array is expected',
     error: [503, 'ExpectedArrayOfTowersForWatchtowerListing'],
   },

package/test/typescript/get_connected_watchtowers.test-d.ts

@@ -7,6 +7,7 @@ import {
 
 const lnd = {} as AuthenticatedLnd;
 const is_anchor = true;
+const is_taproot = true;
 
 expectError(getConnectedWatchtowers());
 expectError(getConnectedWatchtowers({}));
@@ -16,6 +17,9 @@ expectType<GetConnectedWatchTowersResult>(await getConnectedWatchtowers({lnd}));
 expectType<GetConnectedWatchTowersResult>(
   await getConnectedWatchtowers({lnd, is_anchor})
 );
+expectType<GetConnectedWatchTowersResult>(
+  await getConnectedWatchtowers({lnd, is_taproot})
+);
 
 expectType<void>(
   getConnectedWatchtowers({lnd}, (error, result) => {
@@ -27,3 +31,8 @@ expectType<void>(
     expectType<GetConnectedWatchTowersResult>(result);
   })
 );
+expectType<void>(
+  getConnectedWatchtowers({lnd, is_taproot}, (error, result) => {
+    expectType<GetConnectedWatchTowersResult>(result);
+  })
+);