balanceofsatoshis 11.41.0 → 11.45.0

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Versions
 
+## 11.45.0
+
+- `increase-inbound-liquidity`: Add support for formulas in `--amount`
+
+## 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
+- `limit-forwards`: Add `--only-allow` to restrict forwards to allowed edges
+- `open-balanced-channel`: Disallow fractional fee rate entry
+
+## 11.42.0
+
+- `call`: Add support for `fundPsbt` to create a funded PSBT ready to sign
+- `call`: Add support for `partiallySignPsbt` to add a partial sig to a PSBT
+- `call`: Add support for `signPsbt` to sign and finalize a PSBT for broadcast
+
 ## 11.41.0
 
 - `remove-peer`: Add interactive mode to select channels to close

package/CONTRIBUTING.md

@@ -0,0 +1,72 @@
+# Contribution Guidelines
+
+- Feel free to open issues or pull requests
+- They may not be addressed or merged
+- You can ignore coding styles if you want
+
+## Coding Style
+
+If you want to help with style, here are some rough guidelines on style ideas:
+
+### Formatting
+
+- Spaces not tabs, 2 spaces
+- Arguments to methods are snake_case
+- Regular variables are camelCase
+- Returned attributes are snake_case
+- Minimize function nesting, make new files if nesting is required
+- No extraneous whitespace
+- A single newline should appear at the end of a file
+- Don't bother with () in functions when not needed: `const a = b => c`
+- If there are multiple things together, alphabetize them
+- Don't split up long strings over multiple lines
+- Lines should be terminated by explicit semicolons
+- Logic like ternary operators should not extend beyond a single line
+- Don't let any lines linger when they don't do anything
+- Tightly space objects, like `{attribute: value}` not `{ attribute : value }`
+- Use single '' quotes not double "" quotes, except when `` is required
+- If conditions should avoid spanning multiple lines
+- Avoid double specifying an attribute and value, `{type: type}` vs `{type}`
+
+### Control Flow
+
+- Async functions should support both cbk and Promise style
+- Use async.js methods for asynchronous control flow
+- Try to exit early from functions when possible, and note this exit in comment
+- Prefer cbk over Promise style, aside from in tests or in Promise libs
+- Use `asyncAuto` for asynchronous control flow dependency management
+- Callbacks should generally be named cbk even when redefinining in inner scope
+- Avoid mixing non-async complex logic and async control flows in the same file
+- Minimize async nesting in returned attributes and in method arguments
+- Methods should always document their arguments and their output
+
+### Variables
+
+- Generally use undefined rather than null when defining nil types
+- Prefer variable assignments on new lines rather than on a single line
+- Reduce the usage of . property access, like isArray instead of Array.isArray
+- When there is a newline in an object, always put a comma at the end of a line
+- Short properties always go first in objects: `{short, longer: type}`
+- If a statement relies on a statement above it, it should have a newline above
+- Avoid including scalar values such as strings or numbers in the code itself
+
+### JS Features
+
+- Limit usage of `let` and never use `var`, prefer `const`
+- Limit use of npm dependencies when possible, only use good dependencies
+- Target support of the oldest node.js LTS release still being supported
+- Never use class or prototype
+- Do not import more methods from an import than you actually use
+- Try to avoid passing objects in arguments as much as possible
+- Prefer using function iteration like map and forEach over for and while
+- Use arrow functions and not `function` functions whenever possible
+
+### Errors
+
+- Never ignore an error case, always deal with it as soon as possible
+- In the case of errors, do include the error string in the code
+- Add simple validations to help target simple calling mistakes
+- When throwing or returning error messages, use PascalCase for the message
+- Use HTTP status codes as a guideline: 4** is a local issue, 5** is remote
+- Return async errors as arrays: `[typeNumber, errorMsgString, extraDetails]`
+- Try to be very specific with error messages and try to not repeat one

package/bos

@@ -25,6 +25,7 @@ const {accountingCategories} = commandConstants;
 const balances = importLazy('./balances');
 const chain = importLazy('./chain');
 const commands = importLazy('./commands');
+const display = importLazy('./display');
 const encryption = importLazy('./encryption');
 const lnd = importLazy('./lnd');
 const network = importLazy('./network');
@@ -54,7 +55,6 @@ const months = [...Array(12).keys()].map(n => ++n);
 const {REPEATABLE} = prog;
 const {STRING} = prog;
 const yearMatch = /^\d{4}$/;
-
 prog
   .version(version)
 
@@ -826,10 +826,14 @@ prog
 
   // Intercept forwarding requests, enforce requirements on acceptance
   .command('limit-forwarding', 'Enforce rules for routing payments')
+  .help('Setting --only-allow will disable all forwards except only allowed')
+  .help('--only-allow option can be repeated for multiple forwards')
   .option('--node <node_name>', 'Saved node to enforce rules on')
   .option('--disable-forwards', 'Disable all forwards')
   .option('--max-hours-since-last-block <h>', 'Require fresh blocks', INT, 5)
   .option('--max-new-pending-per-hour <h>', 'Limit held HTLCs', INT)
+  .option('--min-channel-confirmations <confs>', 'Minimum channel confs', INT)
+  .option('--only-allow <pair>', 'only forward fromKey/toKey', REPEATABLE)
   .action((args, options, logger) => {
     return new Promise(async (resolve, reject) => {
       try {
@@ -839,6 +843,8 @@ prog
           lnd: (await lndForNode(logger, options.node)).lnd,
           max_hours_since_last_block: options.maxHoursSinceLastBlock,
           max_new_pending_per_hour: options.maxNewPendingPerHour,
+          min_channel_confirmations: options.minChannelConfirmations,
+          only_allow: flatten([options.onlyAllow].filter(n => !!n)),
         });
       } catch (err) {
         return reject(logger.error({err}));
@@ -878,10 +884,11 @@ prog
   .command('increase-inbound-liquidity', 'Increase node inbound liquidity')
   .help('Spend down a channel to get inbound. Fee is an estimate, may be more')
   .help('If you want to control chain fee increases, use show-raw-recoveries')
+  .help('Formulas supported for --amount like 5*m or 0.05*BTC for 5 million')
   .option('--address <out_address>', 'Out chain address to send funds out to')
   .option('--api-key <api_key>', 'Pre-paid API key to use')
+  .option('--amount <amount>', 'Amount to increase inbound', STRING, '500*k')
   .option('--avoid <pubkey/chan/tag>', 'Avoid forwarding through', REPEATABLE)
-  .option('--amount <amount>', 'Amount to increase liquidity', INT, 5e5)
   .option('--confs <confs>', 'Confs to consider reorg safe', INT, 1)
   .option('--dryrun', 'Only show cost estimate for increase')
   .option('--fast', 'Request swap server avoid batching delay')
@@ -924,11 +931,11 @@ prog
           spend_address: options.spendAddress || undefined,
           spend_tokens: options.spendAmount || undefined,
           timeout: 1000 * 60 * 60 * 10,
-          tokens: options.amount,
+          tokens: display.parseAmount({amount: options.amount}).tokens,
         },
         responses.returnObject({exit, logger, reject, resolve}));
       } catch (err) {
-        return reject(err);
+        return reject(logger.error({err}));
       }
     });
   })
@@ -1458,6 +1465,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')
@@ -1478,6 +1486,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/commands/api.json

@@ -242,6 +242,20 @@
       ],
       "method": "enableChannel"
     },
+    {
+      "arguments": [
+        {
+          "description": "Base PSBT to fund",
+          "named": "psbt"
+        },
+        {
+          "description": "Fee rate per vbyte to use for funding",
+          "named": "fee_tokens_per_vbyte",
+          "optional": true
+        }
+      ],
+      "method": "fundPsbt"
+    },
     {
       "method": "getAccessIds"
     },
@@ -582,6 +596,13 @@
       ],
       "method": "openChannel"
     },
+    {
+      "arguments": [{
+        "description": "Funded PSBT Hex String",
+        "named": "psbt"
+      }],
+      "method": "partiallySignPsbt"
+    },
     {
       "arguments": [
         {
@@ -689,6 +710,13 @@
       }],
       "method": "signMessage"
     },
+    {
+      "arguments": [{
+        "description": "Funded PSBT to sign and finalize",
+        "named": "psbt"
+      }],
+      "method": "signPsbt"
+    },
     {
       "method": "stopDaemon"
     },

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

@@ -28,7 +28,7 @@
     "crypto-js": "4.1.1",
     "csv-parse": "5.0.4",
     "goldengate": "11.0.0",
-    "grammy": "1.6.2",
+    "grammy": "1.7.0",
     "hot-formula-parser": "4.0.0",
     "import-lazy": "4.0.0",
     "ini": "2.0.0",
@@ -36,7 +36,7 @@
     "invoices": "2.0.3",
     "ln-accounting": "5.0.5",
     "ln-service": "53.6.0",
-    "ln-sync": "3.8.0",
+    "ln-sync": "3.9.0",
     "ln-telegram": "3.12.0",
     "moment": "2.29.1",
     "paid-services": "3.11.0",
@@ -52,7 +52,7 @@
   "description": "Lightning balance CLI",
   "devDependencies": {
     "@alexbosworth/tap": "15.0.10",
-    "ln-docker-daemons": "2.2.1",
+    "ln-docker-daemons": "2.2.3",
     "mock-lnd": "1.4.1",
     "secp256k1": "4.0.3"
   },
@@ -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.41.0"
+  "version": "11.45.0"
 }

package/peers/limit_forwarding.js

@@ -4,6 +4,8 @@ const {returnResult} = require('asyncjs-util');
 
 const disableAllForwards = 0;
 const hoursAsSeconds = hours => hours * 60 * 60;
+const {isArray} = Array;
+const isEdge = n => !!n && /^[0-9A-F]{66}\/[0-9A-F]{66}$/i.test(n);
 
 /** Limit forwarding requests
 
@@ -11,8 +13,10 @@ const hoursAsSeconds = hours => hours * 60 * 60;
     lnd: (await lndForNode(logger, options.node)).lnd,
     logger: <Winston Logger Object>
     [is_disabling_all_forwards]: <All Forwards Are Disabled Bool>
-    [max_hours_since_last_block]: options.maxHoursSinceLastBlock,
-    [max_new_pending_per_hour]: options.maxNewPendingPerHour,
+    [max_hours_since_last_block]: <Maximum Hours Since Last Block Number>
+    [max_new_pending_per_hour]: <Maximum Outstanding New HTLCs Per Hour Number>
+    [min_channel_confirmations]: <Minimum Required Channel Confs Number>
+    only_allow: [<In Public Key / Out Public Key String>]
   }
 
   @returns via cbk or Promise
@@ -22,6 +26,14 @@ module.exports = (args, cbk) => {
     return asyncAuto({
       // Check arguments
       validate: cbk => {
+        if (!isArray(args.only_allow)) {
+          return cbk([400, 'ExpectedOnlyAllowArrayToLimitForwarding']);
+        }
+
+        if (!!args.only_allow.filter(n => !isEdge(n)).length) {
+          return cbk([400, 'ExpectedOnlyAllowAsPublicKeyPairs']);
+        }
+
         if (!args.logger) {
           return cbk([400, 'ExpectedWinstonLoggerToLimitForwarding']);
         }
@@ -55,11 +67,25 @@ module.exports = (args, cbk) => {
         return cbk(null, hoursAsSeconds(args.max_hours_since_last_block));
       }],
 
+      // Only allow pairs
+      onlyAllow: ['validate', ({}, cbk) => {
+        if (!args.only_allow.length) {
+          return cbk();
+        }
+
+        const allow = args.only_allow.map(([inKey, outKey]) => {
+          return {inbound_peer: inKey, outbound_peer: outKey};
+        });
+
+        return cbk(null, allow);
+      }],
+
       // Limit forward requests
       limit: [
         'maxPendingPerHour',
         'maxSecondsSinceLastBlock',
-        ({maxPendingPerHour, maxSecondsSinceLastBlock}, cbk) =>
+        'onlyAllow',
+        ({maxPendingPerHour, maxSecondsSinceLastBlock, onlyAllow}, cbk) =>
       {
         args.logger.info({limiting_forwards: true});
 
@@ -67,6 +93,8 @@ module.exports = (args, cbk) => {
           lnd: args.lnd,
           max_new_pending_per_hour: maxPendingPerHour,
           max_seconds_since_last_block: maxSecondsSinceLastBlock,
+          min_activation_age: args.min_channel_confirmations || undefined,
+          only_allow: onlyAllow,
         });
 
         sub.on('error', err => {

package/services/initiate_balanced_channel.js

@@ -41,6 +41,7 @@ const giveTokens = capacity => Math.ceil(capacity / 2);
 const hasInbound = channels => !!channels.find(n => !!n.remote_balance);
 const hexAsBuffer = hex => Buffer.from(hex, 'hex');
 const idAsHash = id => Buffer.from(id, 'hex').reverse();
+const {isInteger} = Number;
 const isNumber = n => !isNaN(n);
 const isOdd = n => n % 2;
 const isPublicKey = n => !!n && /^0[2-3][0-9A-F]{64}$/i.test(n);
@@ -237,11 +238,11 @@ module.exports = (args, cbk) => {
           default: round(getChainFee.tokens_per_vbyte),
           message: 'Fee rate per vbyte for the joint funding transaction?',
           name: 'rate',
-          type: 'number',
+          validate: n => !!isNumber(n) && !!Number(n) && isInteger(Number(n)),
         };
 
         return args.ask(feeRate, ({rate}) => {
-          if (!isNumber(rate)) {
+          if (!isNumber(Number(rate))) {
             return cbk([400, 'ExpectedFeeRatePerVirtualByteToProposeChannel']);
           }