balanceofsatoshis 11.44.0 → 11.45.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # 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

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)
 
@@ -884,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')
@@ -930,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}));
       }
     });
   })

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",
@@ -52,7 +52,7 @@
   "description": "Lightning balance CLI",
   "devDependencies": {
     "@alexbosworth/tap": "15.0.10",
-    "ln-docker-daemons": "2.2.2",
+    "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.44.0"
+  "version": "11.45.0"
 }