balanceofsatoshis 13.3.6 → 13.4.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Versions
 
+## 13.4.0
+
+- `rebalance`: Add `--avoid-high-fee-routes` to ignore routes over max fee rate
+
+## 13.3.7
+
+- `fund`: Fix failure using the MAX amount to fund an address to the max
+
 ## 13.3.6
 
 - Add support for LND 0.15.4

package/bos

@@ -1478,6 +1478,7 @@ prog
   .help('--out increases the inbound liquidity with a specific peer/tag')
   .option('--amount <amount>', 'Maximum amount to rebalance')
   .option('--avoid <pubkey_or_chanid>', 'Avoid forwarding through', REPEATABLE)
+  .option('--avoid-high-fee-routes', 'Avoid trying routes above max-fee-rate')
   .option('--in <pubkey_or_alias>', 'Route in through a specific peer')
   .option('--in-filter <in_filter>', 'Filter inbound tag nodes', REPEATABLE)
   .option('--in-target-outbound <amt>', 'Balance up to outbound amount')
@@ -1499,6 +1500,7 @@ prog
           in_filters: flatten([options.inFilter].filter(n => !!n)),
           in_outbound: options.inTargetOutbound || undefined,
           in_through: options.in || undefined,
+          is_strict_max_fee_rate: options.avoidHighFeeRoutes || undefined,
           lnd: (await lndForNode(logger, options.node)).lnd,
           max_fee: options.maxFee,
           max_fee_rate: options.maxFeeRate,

package/network/execute_probe.js

@@ -30,6 +30,7 @@ const tokensAsMillitokens = tok => (BigInt(tok) * BigInt(1e3)).toString();
     lnd: <Authenticated LND API Object>
     logger: <Winston Logger Object>
     [max_fee]: <Maximum Fee Tokens Number>
+    [max_fee_mtokens]: <Maximum Fee Millitokens Number String>
     [max_timeout_height]: <Maximum Timeout Height Number>
     [messages]: [{
       type: <Message To Final Destination Type Number String>
@@ -114,8 +115,28 @@ module.exports = (args, cbk) => {
         return cbk(null, tokensAsMillitokens(args.tokens));
       }],
 
+      // Determine the strict maximum fee to use
+      strictMaxFee: ['validate', ({}, cbk) => {
+        // Exit early when there is no strict max fee to enforce in pathfinding
+        if (!args.is_strict_max_fee) {
+          return cbk();
+        }
+
+        // Exit early with error when there is no fee to use
+        if (args.max_fee === undefined && !args.max_fee_mtokens) {
+          return cbk([400, 'ExpectedMaxFeeValueToUseStrictly']);
+        }
+
+        // Exit early when there is a max fee in tokens set
+        if (args.max_fee !== undefined) {
+          return cbk(null, tokensAsMillitokens(args.max_fee));
+        }
+
+        return cbk(null, args.max_fee_mtokens);
+      }],
+
       // Probe
-      probe: ['mtokens', ({mtokens}, cbk) => {
+      probe: ['mtokens', 'strictMaxFee', ({mtokens, strictMaxFee}, cbk) => {
         const attemptedPaths = [];
         const {features} = args;
         const start = now();
@@ -130,7 +151,7 @@ module.exports = (args, cbk) => {
           ignore: args.ignore,
           incoming_peer: args.in_through,
           lnd: args.lnd,
-          max_fee: !args.is_strict_max_fee ? undefined : args.max_fee,
+          max_fee_mtokens: strictMaxFee || undefined,
           max_timeout_height: args.max_timeout_height,
           messages: args.messages,
           outgoing_channel: args.outgoing_channel,

package/network/probe_destination.js

@@ -60,6 +60,7 @@ const tokAsMtok = tokens => (BigInt(tokens || 0) * BigInt(1e3)).toString();
     lnd: <Authenticated LND gRPC API Object>
     logger: <Winston Logger Object>
     [max_fee]: <Maximum Fee Tokens Number>
+    [max_fee_mtokens]: <Maximum Fee Millitokens Number>
     [message]: <Message String>
     [messages]: [{
       type: <Additional Message To Final Destination Type Number String>
@@ -365,6 +366,7 @@ module.exports = (args, cbk) => {
           lnd: args.lnd,
           logger: args.logger,
           max_fee: args.max_fee,
+          max_fee_mtokens: args.max_fee_mtokens,
           mtokens: !BigInt(to.mtokens) ? tokAsMtok(defaultTokens) : to.mtokens,
           outgoing_channel: outgoingChannelId,
           payment: to.payment,

package/package.json

@@ -30,17 +30,17 @@
     "csv-parse": "5.3.1",
     "ecpair": "2.1.0",
     "goldengate": "11.4.0",
-    "grammy": "1.11.2",
+    "grammy": "1.12.0",
     "hot-formula-parser": "4.0.0",
     "import-lazy": "4.0.0",
     "ini": "3.0.1",
     "inquirer": "9.1.4",
     "ln-accounting": "6.1.0",
-    "ln-service": "54.2.5",
-    "ln-sync": "4.0.4",
+    "ln-service": "54.2.6",
+    "ln-sync": "4.0.5",
     "ln-telegram": "4.2.0",
     "moment": "2.29.4",
-    "paid-services": "4.0.4",
+    "paid-services": "4.0.5",
     "probing": "3.0.0",
     "psbt": "2.7.1",
     "qrcode-terminal": "0.12.0",
@@ -83,5 +83,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/telegram/*.js test/wallets/*.js"
   },
-  "version": "13.3.6"
+  "version": "13.4.0"
 }

package/swaps/manage_rebalance.js

@@ -16,6 +16,7 @@ const {isArray} = Array;
     [in_filters]: [<Inbound Filter Formula String>]
     [in_outbound]: <Inbound Target Outbound Liquidity Tokens Number>
     [in_through]: <Pay In Through Peer String>
+    [is_strict_max_fee_rate]: <Avoid Probing Too-High Fee Rate Routes Bool>
     lnd: <Authenticated LND API Object>
     logger: <Winston Logger Object>
     [max_fee]: <Maximum Fee Tokens Number>
@@ -91,6 +92,7 @@ module.exports = (args, cbk) => {
             in_filters: args.in_filters,
             in_outbound: args.in_outbound,
             in_through: args.in_through,
+            is_strict_max_fee_rate: args.is_strict_max_fee_rate,
             lnd: args.lnd,
             logger: args.logger,
             max_fee: Number(args.max_fee) || undefined,

package/swaps/rebalance.js

@@ -32,6 +32,7 @@ const defaultCltvDelta = 40;
 const defaultMaxFee = 1337;
 const defaultMaxFeeRate = 250;
 const defaultMaxFeeTotal = Math.floor(5e6 * 0.0025);
+const feeFromRate = (mtok, rate) => BigInt(mtok) * BigInt(rate) / BigInt(1e6);
 const flatten = arr => [].concat(...arr);
 const highInbound = 4500000;
 const initialProbeTokens = size => Math.round((Math.random() * size) + size);
@@ -54,11 +55,13 @@ const probeSizeMinimal = 1e2;
 const probeSizeRegular = 2e5
 const pubKeyHexLength = 66;
 const rateDivisor = 1e6;
+const {round} = Math;
 const sample = a => !!a.length ? a[Math.floor(Math.random()*a.length)] : null;
 const sumOf = arr => arr.reduce((sum, n) => sum + n);
 const tagFilePath = () => homePath({file: 'tags.json'}).path;
 const times = 6;
 const tokAsBigTok = tokens => !tokens ? undefined : (tokens / 1e8).toFixed(8);
+const tokensAsMillitokens = tok => (BigInt(tok) * BigInt(1e3)).toString();
 const topOf = arr => arr.slice(0, Math.ceil(arr.length / 2));
 const uniq = arr => Array.from(new Set(arr));
 
@@ -72,6 +75,7 @@ const uniq = arr => Array.from(new Set(arr));
     [in_filters]: [<Inbound Filter Formula String>]
     [in_outbound]: <Inbound Target Outbound Liquidity Tokens Number>
     [in_through]: <Pay In Through Peer String>
+    [is_strict_max_fee_rate]: <Avoid Probing Too-High Fee Rate Routes Bool>
     lnd: <Authenticated LND API Object>
     logger: <Winston Logger Object>
     [max_fee]: <Maximum Fee Tokens Number>
@@ -559,6 +563,24 @@ module.exports = (args, cbk) => {
         });
       }],
 
+      // Calculate a max fee to use in the intial probe
+      maxFeeMtokens: ['tokens', ({tokens}, cbk) => {
+        // Exit early when there is no strict max fee
+        if (!args.is_strict_max_fee_rate) {
+          return cbk(null, tokensAsMillitokens(defaultMaxFeeTotal));
+        }
+
+        // Exit early with error when there is no fee rate to use
+        if (args.max_fee_rate === undefined) {
+          return cbk([400, 'ExpectedMaxFeeRateToUseStrictly']);
+        }
+
+        // Convert the initial amount to probe to mtokens
+        const mtokens = tokensAsMillitokens(tokens);
+
+        return cbk(null, feeFromRate(mtokens, args.max_fee_rate).toString());
+      }],
+
       // Find a route to the destination
       findRoute: [
         'findInKey',
@@ -568,6 +590,7 @@ module.exports = (args, cbk) => {
         'getPublicKey',
         'ignore',
         'max',
+        'maxFeeMtokens',
         'tokens',
         ({
           findInKey,
@@ -577,6 +600,7 @@ module.exports = (args, cbk) => {
           getPublicKey,
           ignore,
           max,
+          maxFeeMtokens,
           tokens,
         },
         cbk) =>
@@ -610,9 +634,10 @@ module.exports = (args, cbk) => {
             return ![findInKey, findOutKey].includes(n.from_public_key);
           }),
           in_through: getInbound.public_key,
+          is_strict_max_fee: args.is_strict_max_fee_rate || undefined,
           logger: args.logger,
           lnd: args.lnd,
-          max_fee: defaultMaxFeeTotal,
+          max_fee_mtokens: maxFeeMtokens,
           out_through: getOutbound.public_key,
           timeout_minutes: args.timeout_minutes,
         },

package/swaps/swap_out.js

@@ -125,8 +125,7 @@ const uniq = arr => Array.from(new Set(arr));
     tokens: <Tokens Number>
   }
 
-  @returns via cbk
-  {}
+  @returns via cbk or Promise
 */
 module.exports = (args, cbk) => {
   return new Promise((resolve, reject) => {
@@ -1689,7 +1688,7 @@ module.exports = (args, cbk) => {
 
         args.logger.info(resolution);
 
-        return cbk(null, {});
+        return cbk();
       }],
     },
     returnResult({reject, resolve, of: 'summary'}, cbk));