balanceofsatoshis 11.43.0 → 11.44.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Versions
 
+## 11.44.0
+
+- `send`: Add support for `--max-fee-rate` to limit fees paid via PPM measure
+
 ## 11.43.0
 
 - `limit-forwards`: Add `--min-channel-confirmations` for custom channel ages

package/bos

@@ -1464,6 +1464,7 @@ prog
   .option('--dryrun', 'Avoid actually sending funds')
   .option('--in <pubkey_or_alias>', 'Route in through a specific node')
   .option('--max-fee <fee>', 'Maximum fee tokens', INT, 1337)
+  .option('--max-fee-rate <max_fee_rate>', 'Max fee rate in PPM to pay', INT)
   .option('--message <message>', 'Message to include with payment')
   .option('--message-omit-from-key', 'Leave out the from key on messages')
   .option('--no-color', 'Mute all colors')
@@ -1484,6 +1485,7 @@ prog
           is_omitting_message_from: options.messageOmitFromKey,
           lnd: (await lndForNode(logger, options.node)).lnd,
           max_fee: options.maxFee,
+          max_fee_rate: options.maxFeeRate,
           message: options.message,
           quiz_answers: flatten([options.quiz].filter(n => !!n)),
           out_through: options.out,

package/network/push_payment.js

@@ -16,6 +16,7 @@ const probeDestination = require('./probe_destination');
 
 const coins = ['BTC', 'LTC'];
 const defaultFiatRateProvider = 'coingecko';
+const feeTokensForFeeRate = (tokens, rate) => Math.floor(rate * tokens / 1e6);
 const fiats = ['EUR', 'USD'];
 const hasFiat = n => /(eur|usd)/gim.test(n);
 const {isArray} = Array;
@@ -23,6 +24,7 @@ const isPublicKey = n => /^[0-9A-F]{66}$/i.test(n);
 const maxQuizLength = 10;
 const rateAsTokens = rate => 1e8 / rate;
 const sumOf = arr => arr.reduce((sum, n) => sum + n, Number());
+const {min} = Math;
 const minQuiz = 2;
 const minTokens = 1;
 const networks = {btc: 'BTC', btctestnet: 'BTC', ltc: 'LTC'};
@@ -45,6 +47,7 @@ const utf8AsHex = n => Buffer.from(n, 'utf8').toString('hex');
     lnd: <Authenticated LND API Object>
     logger: <Winston Logger Object>
     max_fee: <Maximum Fee Tokens Number>
+    [max_fee_rate]: <Max Fee Rate Tokens Per Million Number>
     [message]: <Message to Include With Payment String>
     [out_through]: <Pay Out Through Peer String>
     quiz_answers: [<Quiz Answer String>]
@@ -346,7 +349,18 @@ module.exports = (args, cbk) => {
         };
 
         try {
-          return cbk(null, parseAmount({variables, amount: args.amount}));
+          const {tokens} = parseAmount({variables, amount: args.amount});
+
+          // Exit early when there is no max fee rate to compute max fee for
+          if (!!args.max_fee_rate === undefined) {
+            return cbk(null, {tokens, max_fee: args.mage_fee});
+          }
+
+          // Compute the max potential fee given the max fee rate constraint
+          const maxFeeByRate = feeTokensForFeeRate(tokens, args.max_fee_rate);
+
+          // The maximum fee to pay is the lower of the fee limit, fee by rate
+          return cbk(null, {tokens, max_fee: min(args.max_fee, maxFeeByRate)});
         } catch (err) {
           return cbk([400, 'FailedToParsePushAmount', err]);
         }
@@ -384,7 +398,7 @@ module.exports = (args, cbk) => {
           is_omitting_message_from: args.is_omitting_message_from,
           is_push: payment.is_push,
           is_real_payment: true,
-          max_fee: args.max_fee,
+          max_fee: parseAmount.max_fee,
           message: args.message,
           messages: args.quiz_answers.map((answer, i) => ({
             type: (quizStart + i).toString(),

package/package.json

@@ -81,5 +81,5 @@
     "postpublish": "docker buildx build --platform linux/amd64,linux/arm64,linux/arm/v7 -t alexbosworth/balanceofsatoshis --push .",
     "test": "tap --branches=1 --functions=1 --lines=1 --statements=1 -t 60 test/arrays/*.js test/balances/*.js test/chain/*.js test/display/*.js test/encryption/*.js test/lnd/*.js test/network/*.js test/nodes/*.js test/peers/*.js test/responses/*.js test/routing/*.js test/services/*.js test/swaps/*.js test/tags/*.js test/wallets/*.js"
   },
-  "version": "11.43.0"
+  "version": "11.44.0"
 }