balanceofsatoshis 11.14.0 → 11.16.2

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Versions
 
+## 11.16.2
+
+- Address Docker image installation issues
+- `open-balanced-channel`: Move up indicator of waiting for incoming channel
+
+## 11.16.1
+
+- `send`: Add support for global ignores from `tags` when `--avoid` unspecified
+
+## 11.16.0
+
+- `open-balanced-channel`: Add `--coop-close-address` to add a close-to-address
+
+## 11.15.0
+
+- `inbound-channel-rules`: Add `--coop-close-address` to request close address
+
 ## 11.14.0
 
 - `open-balanced-channel`: Add support for accepting using p2p messaging

package/Dockerfile

@@ -1,4 +1,4 @@
-FROM node:lts-alpine
+FROM node:16
 
 # UID / GID 1000 is default for user `node` in the `node:latest` image, this
 # way the process will run as a non-root user
@@ -15,6 +15,6 @@ USER $USER_ID:$GROUP_ID
 
 COPY . /app/
 
-RUN npm ci --only=production
+RUN npm ci
 
 ENTRYPOINT [ "/app/bos" ]

package/README.md

@@ -6,33 +6,35 @@ Commands for working with LND balances.
 
 Supported LND versions:
 
-- v0.14.0-beta to v0.14.1-beta
-- v0.13.0-beta to v0.13.4-beta
-- v0.12.0-beta to v0.12.1-beta
-- v0.11.0-beta to v0.11.1-beta
+- v0.11.0-beta to v0.14.1-beta
 
 ## Install
 
-- Requires an [installation of Node v12.20+](https://gist.github.com/alexbosworth/8fad3d51f9e1ff67995713edf2d20126)
-- Have a RaspiBlitz? Check out [this install guide](https://gist.github.com/openoms/823f99d1ab6e1d53285e489f7ba38602)
-
-If you want to try out any command without npm install, you can also do `npx
-balanceofsatoshis` to run a command directly.
-
-If you have [Docker](https://docs.docker.com/get-docker/) installed or are using a Docker based
-platform like Umbrel or BTCPayServer, you can [run through Docker](#docker) instead.
+- Requires an [installation of Node v12.20+][nodejs-install-guide]
 
 ```shell
 npm install -g balanceofsatoshis
 ```
 
-Verify it's installed:
+Or use a platform-specific guide:
+
+- [Docker/BTCPayServer install notes](#docker)
+- [RaspiBlitz install guide][raspiblitz-install-guide]
+- [RaspiBolt/Debian guide][raspibolt-install-guide]
+- [Umbrel install guide][umbrel-install-guide]
+
+If you want to try out any command without npm install, you can also do `npx
+balanceofsatoshis` to run a command directly.
+
+Get the version to verify that it's installed:
 
 ```shell
 bos --version
 # current installed version
 ``` 
 
+Re-install if you want to update to a new version.
+
 ## Usage
 
 To see a list of available options and flags run: 
@@ -49,7 +51,7 @@ Or ask about commands on [Telegram](https://t.me/balanceofsatoshis)
 If you want autocomplete on commands and options you can do:
 
 ```
-## Autocomplete on ZSH shells (on startup: you can add this to ~/.zshrc)
+## Autocomplete on MacOS/ZSH shells (on startup: you can add this to ~/.zshrc)
 autoload -Uz compinit && compinit
 source <(bos completion zsh)
 
@@ -132,6 +134,9 @@ bos nodes
 # Open channels to public keys in a batch transaction
 bos open "public_keys..."
 
+# Open a balanced channel with a peer
+bos open-balanced-channel
+
 # Outputs the sum total of local channel liquidity
 bos outbound-liquidity
 
@@ -177,15 +182,16 @@ bos utxos
 - Another `rebalance` [command howto](https://yalls.org/articles/97d67df1-d721-417d-a6c0-11d793739be9:0965AC5E-56CD-4870-9041-E69616660E6F/30a7c519-0ec0-4644-b3aa-341c41bac296)
 - Running `rebalance` [video (In German)](https://www.youtube.com/watch?v=EimVHnv-SUk)
 - Secrets of `rebalance` [command revealed](https://yalls.org/articles/97d67df1-d721-417d-a6c0-11d793739be9:0965AC5E-56CD-4870-9041-E69616660E6F/3c0709b7-5f6a-4a3c-944e-48b80e0556df)
-- Running `telegram` [via nohup/tmux howto](https://plebnet.wiki/wiki/Umbrel_-_Installing_BoS)
+- Running `telegram` [via nohup/tmux howto](https://plebnet.wiki/wiki/Umbrel_-_Installing_BoS#Installing_Telegram_Bot)
 - Running `telegram` [via systemd](https://github.com/ziggie1984/miscellanous/blob/97c4905747fe23a824b6e53dc674c4a571ac0f5c/automation_telegram_bot.md)
+- Another `rebalance` + `tags` & `telegram` [commands howto](https://raspibolt.org/bonus/lightning/balance-of-satoshis.html#balance-of-satoshis-in-action)
 
 Want to stack some sats? Write your own LN paywalled guide!
 
 ## Nodes
 
-By default `bos` expects `tls.cert` in the root of the default `lnd` directory and
-`admin.macaroon` in `<default_lnd_dir>/data/chain/bitcoin/<network>`.
+By default `bos` expects `tls.cert` in the root of the default `lnd` directory
+and `admin.macaroon` in `<default_lnd_dir>/data/chain/bitcoin/<network>`.
 
 Default LND directories:
 * macOS: `~/Library/Application Support/Lnd/`
@@ -211,13 +217,13 @@ Use any shorthand you'd like when choosing this profile node name
 
 2. Each file should have the following format:
 
-    ```json
+```json
     {
       "cert": "base64 tls.cert value",
       "macaroon": "base64 .macaroon value",
       "socket": "host:port"
     }
-    ```
+```
 
     > **Note:** `cert` and (admin) `macaroon` should have base64-encoded, and newline-stripped content of the files. To get the strings in appropriate format you can run, ex:
     >
@@ -231,23 +237,23 @@ Use any shorthand you'd like when choosing this profile node name
     >
     > **Note_2:** `socket` should contain `host:port` pointing to `lnd`'s gRPC interface, `localhost:10009` by convention.  
  
- You can also set `cert_path` and `macaroon_path` to the path of the relevant
- files instead.
+You can also set `cert_path` and `macaroon_path` to the path of the relevant
+files instead.
 
 #### Umbrel Saved Node
 
 *Note: Umbrel is not FOSS software, use at your own risk.*
 
 If you are using Umbrel and you have already installed but you get an error like
-`Name resolution failed for target dns:umbrel.local:10009` then try adding umbrel.local
-to your `/etc/hosts` file, like `sudo nano /etc/hosts` and add a line
-`127.0.0.1 umbrel.local`
+`Name resolution failed for target dns:umbrel.local:10009` then try adding
+umbrel.local to your `/etc/hosts` file, like `sudo nano /etc/hosts` and add a line `127.0.0.1 umbrel.local`
 
 1. Identify your Umbrel home dir, like /home/umbrel/umbrel
-2. Look in the .env file in that dir for the `LND_IP` to use as the socket to connect to
+2. Look in the .env file in that dir for the `LND_IP` to use as the socket to 
+    connect to
 
-You can also use umbrel.local if that is in your Umbrel TLS cert but you will have to make sure the
-hostname is known to the client.
+You can also use umbrel.local if that is in your Umbrel TLS cert but you will 
+have to make sure the hostname is known to the client.
 
 ```
 {
@@ -333,7 +339,8 @@ Keep a channel balanced between two of your own nodes
 */30 * * * * /home/ubuntu/.npm-global/bin/bos send PUBKEY --max-fee 0 --message="rebalance" --amount="IF(OUTBOUND+1*m>(LIQUIDITY/2), OUTBOUND-(LIQUIDITY/2), 0)"
 ```
 
-If you want to 50:50 rebalance with a peer node, you can use --out-target-inbound=capacity/2
+If you want to 50:50 rebalance with a peer node, you can use 
+`--out-target-inbound=capacity/2` with `bos rebalance`
 
 ## Alerts and Reports with `sendnotification`
 
@@ -398,9 +405,9 @@ Examples of shell scripts that could be executed by crontab:
 
 ### Persist Long-Running Commands
 
-If you are running a long-running command and want it to persist, you will need something like
-Docker or nohup or tmux to assist you in that and then kill the process and restart it when
-updating.
+If you are running a long-running command and want it to persist, you will need 
+something like Docker or nohup or tmux to assist you in that and then kill the 
+process and restart it when updating.
 
 Nohup example:
 
@@ -418,23 +425,23 @@ docker run -d --restart always -v $HOME/.bos:/home/node/.bos alexbosworth/balanc
 
 This presumes you have Docker installed.
 
-- [Instructions for installing Docker on Ubuntu](https://www.digitalocean.com/community/tutorials/how-to-install-and-use-docker-on-ubuntu-18-04)
-
-### Docker Load
+- [Instructions for installing Docker on Ubuntu][docker-install-guide]
 
 Install the Docker image:
 
-```
+```shell
 docker pull alexbosworth/balanceofsatoshis
 ```
 
+### Docker Load
+
 You can also build the image yourself: `npm run build-docker`, this will make
 `balanceofsatoshis.tar.gz` that you can rsync or scp somewhere else and then
 do `docker load < balanceofsatoshis.tar.gz`.
 
 Once the image is installed, you can "docker run" commands for all the commands:
 
-```
+```shell
 # Make sure you have a home directory created to give Docker access to
 mkdir $HOME/.bos
 
@@ -450,17 +457,17 @@ dir as an additional -v argument to docker run:
 
 If you are on MacOS:
 
-```
+```shell
 --network="host" -v $HOME/Library/Application\ Support/Lnd/:/home/node/.lnd:ro
 ```
 
 Or on Linux:
 
-```
+```shell
 --network="host" -v $HOME/.lnd:/home/node/.lnd:ro
 ```
 
-On BTCpayServer:
+On BTCPayServer:
 
 Create the credential.json file as explained in the saved nodes section, and for socket put:
 `"socket": "lnd_bitcoin:10009"`
@@ -481,22 +488,20 @@ On Umbrel this would be:
 docker run -it --rm --network="host" --add-host=umbrel.local:192.168.1.23 -v $HOME/.bos:/home/node/.bos -v $HOME/umbrel/lnd:/home/node/.lnd:ro alexbosworth/balanceofsatoshis report
 ```
 
-Note: For [umbrel-os](https://github.com/getumbrel/umbrel-os) users, when running the above
-docker run command, ensure the "192.168.1.23" portion of the command is updated to reflect the
-IP of the lnd container. You can find the IP by looking for the `LND_IP` value inside the
-`$HOME/umbrel/.env` file.
-
-(Note: Umbrel is not FOSS software, use at your own risk.)
+Note: For [umbrel-os](https://github.com/getumbrel/umbrel-os) users, when
+running the above docker run command, ensure the "192.168.1.23" portion of the 
+command is updated to reflect the IP of the lnd container. You can find the IP 
+by looking for the `LND_IP` value inside the `$HOME/umbrel/.env` file.
 
 Otherwise you can just pass the local node credentials as shown above using the
 saved nodes.
 
-If you are running a long-running command like `telegram`, use  `-d --restart always` instead
-of `-it --rm` to run in daemon mode and auto-restart.
+If you are running a long-running command like `telegram`, use  `-d --restart 
+always` instead of `-it --rm` to run in daemon mode and auto-restart.
 
-Note: if you are used to using ctrl+c to terminate the process, that doesn't work on Docker.
-Instead, you can use ctrl+p and then ctrl+q to background the interactive mode, then do
-`docker ps` and `docker rm` to kill the instance.
+Note: if you are used to using ctrl+c to terminate the process, that doesn't
+work on Docker. Instead, you can use ctrl+p and then ctrl+q to background the 
+interactive mode, then do `docker ps` and `docker rm` to kill the instance.
 
 ### Build Your Own
 
@@ -525,8 +530,9 @@ You can also define an alias for placing in `~/.profile` or `~/.bash_profile`:
 alias bos="docker run -it --rm -v $HOME/.bos:/home/node/.bos alexbosworth/balanceofsatoshis"
 ```
 
-Adjust this alias to however you run the full Docker command. Remember to execute the ~/.profile
-to install the alias into your current session: `. ~/.profile`
+Adjust this alias to however you run the full Docker command. Remember to
+execute the ~/.profile to install the alias into your current session: `. 
+~/.profile`
 
 You can also create an alias to run a command in the background
 
@@ -536,18 +542,19 @@ alias bosd="docker run -d --rm -v $HOME/.bos:/home/node/.bos alexbosworth/balanc
 
 ## Formulas
 
-Some commands take formula arguments. Formulas are expressions that allow you to perform
-functions and reference variables.
+Some commands take formula arguments. Formulas are expressions that allow you 
+to perform functions and reference variables.
 
 There is a dynamic playground here where you can play with expressions:
 https://formulajs.info/functions/
 
 ### `--avoid`
 
-In `--avoid` flag commands like rebalance, a formula can be applied directionally:
+In `--avoid` flag commands like rebalance, a formula can be applied
+directionally:
 
-`--avoid "fee_rate < 100/<PUBKEY>"` to avoid channels forwarding to the public key that
-charge a fee rate under 100 PPM.
+`--avoid "fee_rate < 100/<PUBKEY>"` to avoid channels forwarding to the public
+key that charge a fee rate under 100 PPM.
 
 Available variables:
 
@@ -577,14 +584,14 @@ defined:
 
 Examples:
 
-```
-bos fund <address> 7*m
+```shell
+bos fund <address> "7*m"
 // Fund address with value 7,000,000
 
-bos probe <key> 100*k
+bos probe <key> "100*k"
 // Probe to key amount 100,000
 
-bos send <key> m/2
+bos send <key> "m/2"
 // Push 500,000 to key
 ```
 
@@ -604,9 +611,9 @@ And for `--in-filter` and `--out-filter`:
 
 Example:
 
-```
+```shell
 // Rebalance with a target of 1,000,000
-bos rebalance --amount 1*m
+bos rebalance --amount "1*m"
 ```
 
 #### `send`
@@ -621,9 +628,9 @@ Send defines additional variables:
 
 Example:
 
-```
+```shell
 // Send node $1
-bos send <key> --amount 1*usd
+bos send <key> --amount "1*usd"
 ```
 
 #### `transfer`
@@ -636,7 +643,7 @@ Transfer variables:
 
 Example:
 
-```
+```shell
 // Equalize inbound with a mutual peer
 bos transfer node "in_inbound - (in_inbound + out_inbound)/2" --through peer
 ```
@@ -657,7 +664,7 @@ You can also use functions:
 
 Example:
 
-```
+```shell
 // Set the fee rate to a tag to 1% of the value forwarded
 bos fees --to tag --set-fee-rate "percent(1)"
 ```
@@ -677,7 +684,13 @@ Formula variables:
 
 Example:
 
-```
+```shell
 // Reject channels that are smaller than 2,000,000 capacity
 bos inbound-channel-rules "capacity < 2*m"
 ```
+
+[docker-install-guide]: https://www.digitalocean.com/community/tutorials/how-to-install-and-use-docker-on-ubuntu-18-04
+[nodejs-install-guide]: https://gist.github.com/alexbosworth/8fad3d51f9e1ff67995713edf2d20126
+[raspiblitz-install-guide]: https://gist.github.com/openoms/823f99d1ab6e1d53285e489f7ba38602
+[raspibolt-install-guide]: https://raspibolt.org/bonus/lightning/balance-of-satoshis.html
+[umbrel-install-guide]: https://plebnet.wiki/wiki/Umbrel_-_Installing_BoS

package/balances/get_liquidity.js

@@ -1,7 +1,6 @@
 const asyncAuto = require('async/auto');
 const {getChannels} = require('ln-service');
 const {getLiquidity} = require('ln-sync');
-const {getNetwork} = require('ln-sync');
 const {getNode} = require('ln-service');
 const {getScoredNodes} = require('ln-sync');
 const {returnResult} = require('asyncjs-util');

package/bos

@@ -199,7 +199,7 @@ prog
   .action((args, options, logger) => {
     return new Promise(async (resolve, reject) => {
       try {
-        return chain.broadcastTransaction({
+        return lnSync.broadcastTransaction({
           logger,
           description: options.description,
           lnd: (await lnd.authenticatedLnd({logger, node: options.node})).lnd,
@@ -742,24 +742,26 @@ prog
     });
   })
 
-  // Reject inbound channel requests
+  // Intercept inbound channel requests and set requirements for inbound opens
   .command('inbound-channel-rules', 'Enforce rules for inbound channels')
-  .help('At least one rule is required.')
-  .help('A rule should be written evaluating to TRUE to accept a channel')
+  .help('Rules should be written evaluating to TRUE to accept a channel')
+  .help('Example rule: --rule "CAPACITY > 100000"')
   .help('For formulas: CAPACITIES are the sizes of the peer public channels')
   .help('For formulas: CAPACITY is the size of the requested channel open')
   .help('For formulas: CHANNEL_AGES are the block ages of public channels')
   .help('For formulas: FEE_RATES are the outbound fee rates for the peer')
   .help('For formulas: LOCAL_BALANCE is the gifted amount from the peer')
   .help('For formulas: PUBLIC_KEY is the public key of the requesting peer')
+  .option('--coop-close-address', 'Request using a cooperative close address')
   .option('--node <node_name>', 'Saved node to reject inbound channels on')
   .option('--reason <message>', 'Message to return when rejecting a request')
   .option('--rule <formula>', 'Freeform rule for inbound channel', REPEATABLE)
   .action((args, options, logger) => {
     return new Promise(async (resolve, reject) => {
       try {
-        return await peers.rejectInboundChannels({
+        return await peers.interceptInboundChannels({
           logger,
+          address: options.coopCloseAddress || undefined,
           lnd: (await lndForNode(logger, options.node)).lnd,
           reason: options.reason,
           rules: flatten([options.rule].filter(n => !!n)),
@@ -1003,6 +1005,7 @@ prog
   .help('Remote node must be prepared to receive this type of channel')
   .help('The remote node should also run this same command after you propose')
   .help('Channel details are negotiated with keysend so that is also required')
+  .option('--coop-close-address <addr>', 'Close address (for proposing open)')
   .option('--node <node_name>', 'Use saved node details instead of local node')
   .option('--recover <addr>', 'Recover if funds sent to an address by mistake')
   .action((args, options, logger) => {
@@ -1010,6 +1013,7 @@ prog
       try {
         return services.openBalancedChannel({
           logger,
+          address: options.coopCloseAddress || undefined,
           after: new Date(Date.now() - (1000 * 60 * 60 * 6)).toISOString(),
           ask: (n, cbk) => inquirer.prompt([n]).then(res => cbk(res)),
           lnd: (await lnd.authenticatedLnd({logger, node: options.node})).lnd,

package/chain/index.js

@@ -1,4 +1,3 @@
-const broadcastTransaction = require('./broadcast_transaction');
 const fundTransaction = require('./fund_transaction');
 const getAddressUtxo = require('./get_address_utxo');
 const getChainFees = require('./get_chain_fees');
@@ -11,7 +10,6 @@ const recoverP2pk = require('./recover_p2pk');
 const splitUtxos = require('./split_utxos');
 
 module.exports = {
-  broadcastTransaction,
   fundTransaction,
   getAddressUtxo,
   getChainFees,

package/network/push_payment.js

@@ -126,11 +126,6 @@ module.exports = (args, cbk) => {
 
       // Get the node identity public key
       getIdentity: ['validate', ({}, cbk) => {
-        // Exit early when there are no avoids
-        if (!args.avoid.length) {
-          return cbk();
-        }
-
         return getIdentity({lnd: args.lnd}, cbk);
       }],
 
@@ -153,14 +148,7 @@ module.exports = (args, cbk) => {
       }],
 
       // Get tags for figuring out avoid flags
-      getTags: ['validate', ({}, cbk) => {
-        // Exit early when there are no avoids
-        if (!args.avoid.length) {
-          return cbk();
-        }
-
-        return getTags({fs: args.fs}, cbk);
-      }],
+      getTags: ['validate', ({}, cbk) => getTags({fs: args.fs}, cbk)],
 
       // Get ignores
       getIgnores: [
@@ -169,11 +157,6 @@ module.exports = (args, cbk) => {
         'getTags',
         ({getChannels, getIdentity, getTags}, cbk) =>
       {
-        // Exit early when there are no avoids
-        if (!args.avoid.length) {
-          return cbk(null, {ignore: []});
-        }
-
         return getIgnores({
           avoid: args.avoid,
           channels: getChannels.channels,

package/package.json

@@ -27,15 +27,16 @@
     "colorette": "2.0.16",
     "crypto-js": "4.1.1",
     "csv-parse": "5.0.3",
-    "goldengate": "10.4.2",
+    "goldengate": "11.0.0",
+    "grammy": "1.5.4",
     "hot-formula-parser": "4.0.0",
     "import-lazy": "4.0.0",
     "ini": "2.0.0",
     "inquirer": "8.2.0",
     "invoices": "2.0.2",
     "ln-accounting": "5.0.5",
-    "ln-service": "53.1.2",
-    "ln-sync": "3.1.0",
+    "ln-service": "53.2.0",
+    "ln-sync": "3.6.0",
     "ln-telegram": "3.4.2",
     "moment": "2.29.1",
     "paid-services": "3.2.0",
@@ -44,14 +45,12 @@
     "qrcode-terminal": "0.12.0",
     "sanitize-filename": "1.6.3",
     "table": "6.7.5",
-    "telegraf": "4.4.2",
     "update-notifier": "5.1.0",
     "window-size": "1.1.1"
   },
   "description": "Lightning balance CLI",
   "devDependencies": {
     "@alexbosworth/tap": "15.0.10",
-    "ecpair": "1.0.1",
     "ln-docker-daemons": "2.1.0",
     "mock-lnd": "1.4.1",
     "secp256k1": "4.0.2"
@@ -76,9 +75,10 @@
   },
   "scripts": {
     "build-docker": "docker build -t alexbosworth/balanceofsatoshis . && docker save alexbosworth/balanceofsatoshis > balanceofsatoshis.tar && gzip balanceofsatoshis.tar",
+    "integration-tests": "tap --branches=1 --functions=1 --lines=1 --statements=1 -t 120 test/integration/*.js",
     "postpack": "PACKAGE_VERSION=$(cat package.json | grep \\\"version\\\" | head -1 | awk -F: '{ print $2 }' | sed 's/[\",]//g' | tr -d '[[:space:]]') && git tag -s v$PACKAGE_VERSION -m v$PACKAGE_VERSION && git push github --tags",
     "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.14.0"
+  "version": "11.16.2"
 }

package/peers/detect_open_rule_violation.js

@@ -68,6 +68,11 @@ module.exports = (args, cbk) => {
         'getNodeFees',
         ({getHeight, getNodeFees}, cbk) =>
       {
+        // Exit early when there are no rules to evaluate
+        if (!args.rules.length) {
+          return cbk(null, {});
+        }
+
         const key = args.partner_public_key;
 
         const channelAges = getNodeFees.channels.map(({id}) => {

package/peers/index.js

@@ -1,5 +1,5 @@
 const findTagMatch = require('./find_tag_match');
+const interceptInboundChannels = require('./intercept_inbound_channels');
 const openChannels = require('./open_channels');
-const rejectInboundChannels = require('./reject_inbound_channels');
 
-module.exports = {findTagMatch, openChannels, rejectInboundChannels};
+module.exports = {findTagMatch, interceptInboundChannels, openChannels};