lightning 10.10.0 → 10.10.2

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Versions
 
+## 10.10.2
+
+- `getChainFeeEstimate`: Add default chain fee conf target when none is passed
+
+## 10.10.1
+
+- `closeChannel`, `openChannel`, `sendToChainAddress`, `sendToChainAddresses`:
+    Add default chain fee conf target when no chain fee is specified
+
 ## 10.10.0
 
 - `getPendingSweeps`: Add method to get the list of pending outpoints to sweep

package/lnd_messages/close_channel_request.js

@@ -10,7 +10,7 @@ const hashAsTxId = hash => hash.slice().reverse().toString('hex');
     delivery_address: <Request Cooperative Close Address String>
     force: <Force Close Channel Bool>
     max_fee_per_vbyte: <Max Fee Tokens Per VByte String>
-    sat_per_byte: <Chain Fee Tokens Per Virtual Byte String>
+    sat_per_vbyte: <Chain Fee Tokens Per Virtual Byte String>
     target_conf: <Target Confirm Within N Blocks Number>
   }
 
@@ -31,7 +31,7 @@ module.exports = args => {
     is_force_close: args.force || undefined,
     max_tokens_per_vbyte: Number(args.max_fee_per_vbyte) || undefined,
     target_confirmations: args.target_conf || undefined,
-    tokens_per_vbyte: Number(args.sat_per_byte) || undefined,
+    tokens_per_vbyte: Number(args.sat_per_vbyte) || undefined,
     transaction_id: hashAsTxId(args.channel_point.funding_txid_bytes),
     transaction_vout: args.channel_point.output_index,
   };

package/lnd_methods/offchain/get_connected_watchtowers.js

@@ -142,7 +142,7 @@ module.exports = (args, cbk) => {
               backups_count: session.num_backups,
               max_backups_count: session.max_backups,
               pending_backups_count: session.num_pending_backups,
-              sweep_tokens_per_vbyte: session.sweep_sat_per_byte,
+              sweep_tokens_per_vbyte: session.sweep_sat_per_vbyte,
             })),
             sockets: tower.addresses,
           }));
@@ -183,13 +183,13 @@ module.exports = (args, cbk) => {
             return cbk([503, 'ExpectedMaxUpdateCountInWatchtowerPolicyInfo']);
           }
 
-          if (res.sweep_sat_per_byte === undefined) {
+          if (res.sweep_sat_per_vbyte === undefined) {
             return cbk([503, 'ExpectedSweepSatsPerByteInWatchtowerPolicy']);
           }
 
           return cbk(null, {
             max_session_update_count: res.max_updates,
-            sweep_tokens_per_vbyte: res.sweep_sat_per_byte,
+            sweep_tokens_per_vbyte: res.sweep_sat_per_vbyte,
           });
         });
       }],

package/lnd_methods/onchain/close_channel.js

@@ -6,6 +6,7 @@ const {addPeer} = require('./../peers');
 const {getChannel} = require('./../info');
 const {isLnd} = require('./../../lnd_requests');
 
+const defaultConfTarget = 6;
 const method = 'closeChannel';
 const type = 'default';
 
@@ -107,8 +108,28 @@ module.exports = (args, cbk) => {
         return getChannel({id: args.id, lnd: args.lnd}, cbk);
       }],
 
+      // Determine what the confirmations to confirm should be
+      targetConf: ['validate', ({}, cbk) => {
+        // Exit early when a chain fee cannot be specified
+        if (!!args.is_force_close) {
+          return cbk();
+        }
+
+        // Exit early when there is a chain fee rate specified
+        if (!!args.tokens_per_vbyte) {
+          return cbk();
+        }
+
+        return cbk(null, args.target_confirmations || defaultConfTarget);
+      }],
+
       // Close out the channel
-      closeChannel: ['addPeer', 'getChannel', ({getChannel}, cbk) => {
+      closeChannel: [
+        'addPeer',
+        'getChannel',
+        'targetConf',
+        ({getChannel, targetConf}, cbk) =>
+      {
         let isFinished = false;
         const tokensPerVByte = args.tokens_per_vbyte;
         const transactionId = Buffer.from(getChannel.transaction_id, 'hex');
@@ -122,8 +143,8 @@ module.exports = (args, cbk) => {
           delivery_address: args.address || undefined,
           force: !!args.is_force_close,
           max_fee_per_vbyte: args.max_tokens_per_vbyte || undefined,
-          sat_per_byte: !!tokensPerVByte ? tokensPerVByte : undefined,
-          target_conf: args.target_confirmations || undefined,
+          sat_per_vbyte: !!tokensPerVByte ? tokensPerVByte : undefined,
+          target_conf: targetConf,
         });
 
         const finished = (err, res) => {

package/lnd_methods/onchain/get_chain_fee_estimate.js

@@ -3,6 +3,7 @@ const {returnResult} = require('asyncjs-util');
 
 const {isLnd} = require('./../../lnd_requests');
 
+const defaultConfTarget = 6;
 const hasNumber = n => !!n && n !== '0';
 const {isArray} = Array;
 const method = 'estimateFee';
@@ -75,7 +76,7 @@ module.exports = (args, cbk) => {
         return args.lnd[type][method]({
           AddrToAmount,
           coin_selection_strategy: strategy(args.utxo_selection),
-          target_conf: args.target_confirmations || undefined,
+          target_conf: args.target_confirmations || defaultConfTarget,
           min_confs: args.utxo_confirmations || undefined,
           spend_unconfirmed: args.utxo_confirmations === unconfirmedConfCount,
         },
@@ -92,21 +93,10 @@ module.exports = (args, cbk) => {
             return cbk([503, 'ExpectedChainFeeInResponseToChainFeeEstimate']);
           }
 
-          if (!res.feerate_sat_per_byte) {
-            return cbk([503, 'ExpectedFeeRateValueInChainFeeEstimateQuery']);
-          }
-
-          const fee = Number(res.fee_sat);
-
-          // Exit early in LND 0.12.1 and below that do not support sat/vbyte
-          if (!hasNumber(res.sat_per_vbyte)) {
-            return cbk(null, {
-              fee,
-              tokens_per_vbyte: Number(res.feerate_sat_per_byte),
-            });
-          }
-
-          return cbk(null, {fee, tokens_per_vbyte: Number(res.sat_per_vbyte)});
+          return cbk(null, {
+            fee: Number(res.fee_sat),
+            tokens_per_vbyte: Number(res.sat_per_vbyte),
+          });
         });
       }],
     },

package/lnd_methods/onchain/open_channel.js

@@ -5,6 +5,7 @@ const {addPeer} = require('./../peers');
 const {isLnd} = require('./../../lnd_requests');
 
 const anchors = 'ANCHORS';
+const defaultChainFeeConfTarget = 6;
 const defaultMinConfs = 1;
 const defaultMinHtlcMtokens = '1';
 const errMemoLength = /^provided memo \(.*\) is of length \d*, exceeds (\d*)$/;
@@ -170,7 +171,9 @@ module.exports = (args, cbk) => {
         };
 
         if (!!args.chain_fee_tokens_per_vbyte) {
-          options.sat_per_byte = args.chain_fee_tokens_per_vbyte;
+          options.sat_per_vbyte = args.chain_fee_tokens_per_vbyte;
+        } else {
+          options.target_conf = defaultChainFeeConfTarget;
         }
 
         if (!!args.cooperative_close_address) {

package/lnd_methods/onchain/request_chain_fee_increase.js

@@ -54,7 +54,7 @@ module.exports = (args, cbk) => {
       feeRate: ['validate', ({}, cbk) => {
         // Exit early when the fee rate is specified
         if (!!args.fee_tokens_per_vbyte) {
-          return cbk(null, {sat_per_byte: args.fee_tokens_per_vbyte});
+          return cbk(null, {sat_per_vbyte: args.fee_tokens_per_vbyte});
         }
 
         // Exit early when the confirmation target is specified
@@ -74,7 +74,7 @@ module.exports = (args, cbk) => {
             output_index: args.transaction_vout,
             txid_str: args.transaction_id,
           },
-          sat_per_byte: feeRate.sat_per_byte,
+          sat_per_vbyte: feeRate.sat_per_vbyte,
           target_conf: feeRate.target_conf,
         },
         (err, res) => {

package/lnd_methods/onchain/send_to_chain_address.js

@@ -3,6 +3,7 @@ const {returnResult} = require('asyncjs-util');
 
 const {isLnd} = require('./../../lnd_requests');
 
+const defaultConfTarget = 6;
 const initialConfirmationCount = 0;
 const {isArray} = Array;
 const {isInteger} = Number;
@@ -83,18 +84,28 @@ module.exports = (args, cbk) => {
         return cbk();
       },
 
+      // Determine what the confirmations to confirm should be
+      targetConf: ['validate', ({}, cbk) => {
+        // Exit early when there is a chain fee rate specified
+        if (!!args.fee_tokens_per_vbyte) {
+          return cbk();
+        }
+
+        return cbk(null, args.target_confirmations || defaultConfTarget);
+      }],
+
       // Send coins
-      send: ['validate', ({}, cbk) => {
+      send: ['targetConf', ({targetConf}, cbk) => {
         return args.lnd.default.sendCoins({
           addr: args.address,
           amount: args.tokens || undefined,
           coin_selection_strategy: strategy(args.utxo_selection),
           min_confs: args.utxo_confirmations || undefined,
           label: args.description || undefined,
-          sat_per_byte: args.fee_tokens_per_vbyte || undefined,
+          sat_per_vbyte: args.fee_tokens_per_vbyte || undefined,
           send_all: args.is_send_all || undefined,
           spend_unconfirmed: args.utxo_confirmations === unconfirmedConfCount,
-          target_conf: args.target_confirmations || undefined,
+          target_conf: targetConf,
         },
         (err, res) => {
           if (!!err && err.details === lowBalanceErr) {

package/lnd_methods/onchain/send_to_chain_addresses.js

@@ -3,6 +3,7 @@ const {returnResult} = require('asyncjs-util');
 
 const {isLnd} = require('./../../lnd_requests');
 
+const defaultConfTarget = 6;
 const initialConfirmationCount = 0;
 const {isArray} = Array;
 const method = 'sendMany';
@@ -74,7 +75,17 @@ module.exports = (args, cbk) => {
         return cbk();
       },
 
-      send: ['validate', ({}, cbk) => {
+      // Determine what the confirmations to confirm should be
+      targetConf: ['validate', ({}, cbk) => {
+        // Exit early when there is a chain fee rate specified
+        if (!!args.fee_tokens_per_vbyte) {
+          return cbk();
+        }
+
+        return cbk(null, args.target_confirmations || defaultConfTarget);
+      }],
+
+      send: ['targetConf', ({targetConf}, cbk) => {
         const AddrToAmount = {};
 
         args.send_to
@@ -85,9 +96,9 @@ module.exports = (args, cbk) => {
           coin_selection_strategy: strategy(args.utxo_selection),
           label: args.description || undefined,
           min_confs: args.utxo_confirmations || undefined,
-          sat_per_byte: args.fee_tokens_per_vbyte || undefined,
+          sat_per_vbyte: args.fee_tokens_per_vbyte || undefined,
           spend_unconfirmed: args.utxo_confirmations === unconfirmedConfCount,
-          target_conf: args.target_confirmations || undefined,
+          target_conf: targetConf,
         };
 
         return args.lnd.default.sendMany(send, (err, res) => {

package/package.json

@@ -53,5 +53,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "10.10.0"
+  "version": "10.10.2"
 }

package/test/lnd_messages/test_close_channel_request.js

@@ -12,7 +12,7 @@ const makeArgs = overrides => {
     },
     delivery_address: 'delivery_address',
     force: true,
-    sat_per_byte: '1',
+    sat_per_vbyte: '1',
     target_conf: 1,
   };
 
@@ -47,7 +47,7 @@ const tests = [
     args: makeArgs({
       delivery_address: '',
       force: false,
-      sat_per_byte: '0',
+      sat_per_vbyte: '0',
       target_conf: 0,
     }),
     description: 'Defaults are selected',

package/test/lnd_methods/macaroon/test_handle_rpc_request_update.js

@@ -19,7 +19,7 @@ const tests = [
               },
               delivery_address: 'delivery_address',
               force: true,
-              sat_per_byte: '1',
+              sat_per_vbyte: '1',
               target_conf: 1,
             }),
           },

package/test/lnd_methods/offchain/test_get_connected_watchtowers.js

@@ -28,7 +28,7 @@ const makeTower = overrides => {
       max_backups: 1,
       num_backups: 1,
       num_pending_backups: 1,
-      sweep_sat_per_byte: 1,
+      sweep_sat_per_vbyte: 1,
     }],
   };
 
@@ -60,7 +60,7 @@ const makeLnd = args => {
           return cbk(null, args.policyRes);
         }
 
-        return cbk(null, {max_updates: 1, sweep_sat_per_byte: 1});
+        return cbk(null, {max_updates: 1, sweep_sat_per_vbyte: 1});
       },
       stats: ({}, cbk) => {
         if (!!args.statsErr) {

package/test/lnd_methods/onchain/test_get_chain_fee_estimate.js

@@ -57,52 +57,12 @@ const tests = [
     description: 'Fee sat is expected in estimate fee response',
     error: [503, 'ExpectedChainFeeInResponseToChainFeeEstimate'],
   },
-  {
-    args: {
-      lnd: {default: {estimateFee: ({}, cbk) => cbk(null, {fee_sat: '1'})}},
-      send_to: [{address: 'address', tokens: 1}],
-    },
-    description: 'Fee rate is expected in estimate fee response',
-    error: [503, 'ExpectedFeeRateValueInChainFeeEstimateQuery'],
-  },
-  {
-    args: {
-      lnd: {
-        default: {
-          estimateFee: ({}, cbk) => cbk(null, {
-            fee_sat: '1',
-            feerate_sat_per_byte: '1',
-          }),
-        },
-      },
-      send_to: [{address: 'address', tokens: 1}],
-    },
-    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},
-  },
   {
     args: {
       lnd: {
         default: {
           estimateFee: ({}, cbk) => cbk(null, {
             fee_sat: '1',
-            feerate_sat_per_byte: '1',
             sat_per_vbyte: '2',
           }),
         },
@@ -119,7 +79,6 @@ const tests = [
         default: {
           estimateFee: ({}, cbk) => cbk(null, {
             fee_sat: '1',
-            feerate_sat_per_byte: '1',
             sat_per_vbyte: '2',
           }),
         },

package/test/lnd_methods/onchain/test_send_to_chain_address.js

@@ -1,4 +1,4 @@
-const {deepStrictEqual} = require('node:assert').strict;
+const {deepEqual} = require('node:assert').strict;
 const {rejects} = require('node:assert').strict;
 const test = require('node:test');
 
@@ -22,6 +22,20 @@ const makeArgs = overrides => {
   return args;
 };
 
+const makeExpected = overrides => {
+  const args = {
+    confirmation_count: 0,
+    id: Buffer.alloc(32).toString('hex'),
+    is_confirmed: false,
+    is_outgoing: true,
+    tokens: 1,
+  };
+
+  Object.keys(overrides).forEach(k => args[k] = overrides[k]);
+
+  return args;
+};
+
 const tests = [
   {
     args: makeArgs({address: undefined}),
@@ -89,35 +103,17 @@ const tests = [
   {
     args: makeArgs({log: console.log, wss: [{clients: [null]}]}),
     description: 'Send coins with null wss client',
-    expected: {
-      confirmation_count: 0,
-      id: Buffer.alloc(32).toString('hex'),
-      is_confirmed: false,
-      is_outgoing: true,
-      tokens: 1,
-    },
+    expected: makeExpected({}),
   },
   {
     args: makeArgs({log: console.log, wss: [{clients: [{}]}]}),
     description: 'Send coins with no ready state',
-    expected: {
-      confirmation_count: 0,
-      id: Buffer.alloc(32).toString('hex'),
-      is_confirmed: false,
-      is_outgoing: true,
-      tokens: 1,
-    },
+    expected: makeExpected({}),
   },
   {
     args: makeArgs({log: () => {}, wss: [{clients: [{readyState: 1}]}]}),
     description: 'Send coins with no send method',
-    expected: {
-      confirmation_count: 0,
-      id: Buffer.alloc(32).toString('hex'),
-      is_confirmed: false,
-      is_outgoing: true,
-      tokens: 1,
-    },
+    expected: makeExpected({}),
   },
   {
     args: makeArgs({
@@ -127,35 +123,22 @@ const tests = [
       tokens: undefined,
     }),
     description: 'Send coins with broadcast',
-    expected: {
-      confirmation_count: 0,
-      id: Buffer.alloc(32).toString('hex'),
-      is_confirmed: false,
-      is_outgoing: true,
-      tokens: undefined,
-    },
+    expected: makeExpected({tokens: undefined}),
   },
   {
     args: makeArgs({}),
     description: 'Send coins',
-    expected: {
-      confirmation_count: 0,
-      id: Buffer.alloc(32).toString('hex'),
-      is_confirmed: false,
-      is_outgoing: true,
-      tokens: 1,
-    },
+    expected: makeExpected({}),
+  },
+  {
+    args: makeArgs({fee_tokens_per_vbyte: 1}),
+    description: 'Send coins with a fee rate',
+    expected: makeExpected({}),
   },
   {
     args: makeArgs({utxo_selection: 'random'}),
     description: 'Send coins with coin selection',
-    expected: {
-      confirmation_count: 0,
-      id: Buffer.alloc(32).toString('hex'),
-      is_confirmed: false,
-      is_outgoing: true,
-      tokens: 1,
-    },
+    expected: makeExpected({}),
   },
 ];
 
@@ -166,7 +149,7 @@ tests.forEach(({args, description, error, expected}) => {
     } else {
       const res = await sendToChainAddress(args);
 
-      deepStrictEqual(res, expected, 'Got expected result');
+      deepEqual(res, expected, 'Got expected result');
     }
 
     return;

package/test/lnd_methods/onchain/test_send_to_chain_addresses.js

@@ -21,6 +21,20 @@ const makeArgs = overrides => {
   return args;
 };
 
+const makeExpected = overrides => {
+  const args = {
+    confirmation_count: 0,
+    id: Buffer.alloc(32).toString('hex'),
+    is_confirmed: false,
+    is_outgoing: true,
+    tokens: 1,
+  };
+
+  Object.keys(overrides).forEach(k => args[k] = overrides[k]);
+
+  return args;
+};
+
 const tests = [
   {
     args: makeArgs({lnd: undefined}),
@@ -75,35 +89,17 @@ const tests = [
   {
     args: makeArgs({log: console.log, wss: [{clients: [null]}]}),
     description: 'Send coins with null wss client',
-    expected: {
-      confirmation_count: 0,
-      id: Buffer.alloc(32).toString('hex'),
-      is_confirmed: false,
-      is_outgoing: true,
-      tokens: 1,
-    },
+    expected: makeExpected({}),
   },
   {
     args: makeArgs({log: console.log, wss: [{clients: [{}]}]}),
     description: 'Send coins with no ready state',
-    expected: {
-      confirmation_count: 0,
-      id: Buffer.alloc(32).toString('hex'),
-      is_confirmed: false,
-      is_outgoing: true,
-      tokens: 1,
-    },
+    expected: makeExpected({}),
   },
   {
     args: makeArgs({log: () => {}, wss: [{clients: [{readyState: 1}]}]}),
     description: 'Send coins with no send method',
-    expected: {
-      confirmation_count: 0,
-      id: Buffer.alloc(32).toString('hex'),
-      is_confirmed: false,
-      is_outgoing: true,
-      tokens: 1,
-    },
+    expected: makeExpected({}),
   },
   {
     args: makeArgs({
@@ -111,35 +107,22 @@ const tests = [
       wss: [{clients: [{readyState: 1, send: () => {}}]}],
     }),
     description: 'Send coins with broadcast',
-    expected: {
-      confirmation_count: 0,
-      id: Buffer.alloc(32).toString('hex'),
-      is_confirmed: false,
-      is_outgoing: true,
-      tokens: 1,
-    },
+    expected: makeExpected({}),
   },
   {
     args: makeArgs({}),
     description: 'Send coins',
-    expected: {
-      confirmation_count: 0,
-      id: Buffer.alloc(32).toString('hex'),
-      is_confirmed: false,
-      is_outgoing: true,
-      tokens: 1,
-    },
+    expected: makeExpected({}),
+  },
+  {
+    args: makeArgs({fee_tokens_per_vbyte: 1}),
+    description: 'Send coins with fee rate',
+    expected: makeExpected({}),
   },
   {
     args: makeArgs({utxo_selection: 'random'}),
     description: 'Send coins with coin selection',
-    expected: {
-      confirmation_count: 0,
-      id: Buffer.alloc(32).toString('hex'),
-      is_confirmed: false,
-      is_outgoing: true,
-      tokens: 1,
-    },
+    expected: makeExpected({}),
   },
 ];