lightning 5.20.2 → 5.21.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Versions
 
+## 5.21.0
+
+- `getChainFeeEstimate`: Add support for specifying min `utxo_confirmations`
+
 ## 5.20.2
 
 - `getWalletInfo`: Add support for detecting lnd versions 0.15.0 and 0.15.1

package/lnd_methods/onchain/get_chain_fee_estimate.d.ts

@@ -12,6 +12,8 @@ export type GetChainFeeEstimateArgs = AuthenticatedLightningArgs<{
   }[];
   /** Target Confirmations */
   target_confirmations?: number;
+  /** Minimum Confirmations for UTXO Selection */
+  utxo_confirmations?: number;
 }>;
 
 export type GetChainFeeEstimateResult = {

package/lnd_methods/onchain/get_chain_fee_estimate.js

@@ -8,11 +8,14 @@ const {isArray} = Array;
 const method = 'estimateFee';
 const notFound = -1;
 const type = 'default';
+const unconfirmedConfCount = 0;
 
 /** Get a chain fee estimate for a prospective chain send
 
   Requires `onchain:read` permission
 
+  Specifying 0 for `utxo_confirmations` is not supported in LND 0.13.0 or below
+
   {
     lnd: <Authenticated LND API Object>
     send_to: [{
@@ -20,6 +23,7 @@ const type = 'default';
       tokens: <Tokens Number>
     }]
     [target_confirmations]: <Target Confirmations Number>
+    [utxo_confirmations]: <Minimum Confirmations for UTXO Selection Number>
   }
 
   @returns via cbk or Promise
@@ -65,6 +69,8 @@ module.exports = (args, cbk) => {
         return args.lnd[type][method]({
           AddrToAmount,
           target_conf: args.target_confirmations || undefined,
+          min_confs: args.utxo_confirmations || undefined,
+          spend_unconfirmed: args.utxo_confirmations === unconfirmedConfCount,
         },
         (err, res) => {
           if (!!err) {

package/package.json

@@ -7,7 +7,7 @@
     "url": "https://github.com/alexbosworth/lightning/issues"
   },
   "dependencies": {
-    "@grpc/grpc-js": "1.6.11",
+    "@grpc/grpc-js": "1.6.12",
     "@grpc/proto-loader": "0.7.2",
     "@types/express": "4.17.13",
     "@types/node": "18.7.14",
@@ -59,5 +59,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "5.20.2"
+  "version": "5.21.0"
 }

package/test/lnd_methods/onchain/test_get_chain_fee_estimate.js

@@ -78,6 +78,22 @@ const tests = [
     description: 'Fee rate and fee are given in chain response',
     expected: {fee: 1, tokens_per_vbyte: 1},
   },
+  {
+    args: {
+      lnd: {
+        default: {
+          estimateFee: ({}, cbk) => cbk(null, {
+            fee_sat: '1',
+            feerate_sat_per_byte: '1',
+          }),
+        },
+      },
+      send_to: [{address: 'address', tokens: 1}],
+      utxo_confirmations: 0,
+    },
+    description: 'Passing 0 UTXO confirmations is supported',
+    expected: {fee: 1, tokens_per_vbyte: 1},
+  },
 ];
 
 tests.forEach(({args, description, error, expected}) => {