balanceofsatoshis 11.64.2 → 12.0.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Versions
 
+## 12.0.0
+
+- `peers`: Add `capacity` as a variable for the `--filter` option
+- `remove-peer`: Add `capacity` as a variable for the `--filter` option
+- `remove-peer`: Add `--filter` option to filter the type of peer to remove
+
+### Breaking Changes
+
+For `peers` and `remove-peer` commands:
+
+- `--inbound-below`: Removed option. Use `--filter "inbound_liquidity < X"`
+- `--outbound-below`: Removed option. Use `--filter "outbound_liquidity < X"`
+
 ## 11.64.2
 
 - `trade-secret`: Fix connecting when not already peered with seller

package/README.md

@@ -22,6 +22,7 @@ Or use a platform-specific guide:
 - [RaspiBlitz install guide][raspiblitz-install-guide]
 - [RaspiBolt/Debian guide][raspibolt-install-guide]
 - [Umbrel install guide][umbrel-install-guide]
+- [Voltage install guide][voltage-install-guide]
 
 If you want to try out any command without npm install, you can also do `npx
 balanceofsatoshis` to run a command directly.
@@ -707,3 +708,4 @@ bos inbound-channel-rules "capacity < 2*m"
 [raspiblitz-install-guide]: https://gist.github.com/openoms/823f99d1ab6e1d53285e489f7ba38602
 [raspibolt-install-guide]: https://raspibolt.org/guide/bonus/lightning/balance-of-satoshis.html
 [umbrel-install-guide]: https://plebnet.wiki/wiki/Umbrel_-_Installing_BoS
+[voltage-install-guide]: https://docs.voltage.cloud/balance-of-satoshis-guides/balance-of-satoshis

package/bos

@@ -1222,6 +1222,7 @@ prog
   .help('Icons: 🦐 limited max htlc')
   .help('Filters can take formula expressions to limit results')
   .help('Filter variable AGE: "age > 144 * 7" for peers older than a week')
+  .help('Filter variable CAPACITY: "capacity > 8*m"')
   .help('Filter variable DISK_USAGE_MB: "disk_usage_mb > 9" for disk estimate')
   .help('Filter variable INBOUND_LIQUIDITY: "inbound_liquidity > 1*m"')
   .help('Filter variable OUTBOUND_LIQUIDITY: "outbound_liquidity > 1*m"')
@@ -1230,12 +1231,10 @@ prog
   .option('--fee-days <past_days>', 'Include fees earned over n days', INT)
   .option('--filter <formula>', 'Filter formula to apply', REPEATABLE)
   .option('--idle-days <days>', 'No receives or routes for n days', INT)
-  .option('--inbound-below <amount>', 'Inbound liquidity below amount', INT)
   .option('--no-color', 'Mute all colors')
   .option('--node <node_name>', 'Node to get peers for')
   .option('--offline', 'Only offline peer channels')
   .option('--omit <key>', 'Omit peer with public key', REPEATABLE)
-  .option('--outbound-below <amount>', 'Outbound liquidity below amount', INT)
   .option('--private', 'Only private channels')
   .option('--public', 'Only peers with public channels')
   .option('--sort <by>', 'Sort results by peer attribute', peerSortOptions)
@@ -1250,7 +1249,6 @@ prog
           filters: flatten([options.filter].filter(n => !!n)),
           fs: {getFile: readFile},
           idle_days: options.idleDays || undefined,
-          inbound_liquidity_below: options.inboundBelow,
           is_active: !!options.active,
           is_monochrome: !!options.noColor,
           is_offline: !!options.offline,
@@ -1259,7 +1257,6 @@ prog
           is_table: !options.complete,
           lnd: (await lnd.authenticatedLnd({logger, node: options.node})).lnd,
           omit: flatten([options.omit].filter(n => !!n)),
-          outbound_liquidity_below: options.outboundBelow,
           sort_by: options.sort,
           tags: flatten([options.tag].filter(n => !!n)),
         },
@@ -1432,19 +1429,19 @@ prog
 
   // Remove a peer
   .command('remove-peer', 'Close out with a channel-connected peer')
+  .help('--filter command uses same filters as peers command')
   .argument('[public_key]', 'Choose a specific peer to close with')
   .option('--active', 'Make sure the peer is online')
   .option('--address <address>', 'Address to close out funds to')
   .option('--dryrun', 'Avoid actually closing channels with peer')
   .option('--fee-rate <rate>', 'Fee rate per vbyte to close out with', FLOAT)
+  .option('--filter <formula>', 'Filter formula to apply', REPEATABLE)
   .option('--force', 'Force close channels if they cannot be coop closed')
   .option('--idle-days <days>', 'No receives or routes for n days', INT)
-  .option('--inbound-below <amount>', 'Peer inbound is below amount', INT)
   .option('--no-color', 'Mute all colors')
   .option('--node <node_name>', 'Node to remove peer on')
   .option('--offline', 'Make sure the peer is offline')
   .option('--omit <key>', 'Avoid closing peer with public key', REPEATABLE)
-  .option('--outbound-below <amount>', 'Peer outbound is below amount', INT)
   .option('--outpoint', 'Only remove specific channel with funding txid:vout')
   .option('--private', 'Peer is privately connected')
   .option('--public', 'Peer is publicly connected')
@@ -1460,6 +1457,7 @@ prog
           address: options.address,
           ask: (n, cbk) => inquirer.prompt([n]).then(n => cbk(n)),
           chain_fee_rate: options.feeRate || undefined,
+          filters: flatten([options.filter].filter(n => !!n)),
           fs: {getFile: readFile},
           idle_days: options.idleDays,
           inbound_liquidity_below: options.inboundBelow,

package/network/get_peers.js

@@ -58,7 +58,6 @@ const maxPaySize = 4294967;
       getFile: <Read File Contents Function> (path, cbk) => {}
     }
     [idle_days]: <Not Active For Days Number>
-    [inbound_liquidity_below]: <Inbound Liquidity Below Tokens Number>
     [is_active]: <Active Channels Only Bool>
     [is_monochrome]: <Mute Colors Bool>
     [is_offline]: <Offline Channels Only Bool>
@@ -67,7 +66,6 @@ const maxPaySize = 4294967;
     [is_table]: <Peers As Table Bool>
     lnd: <Authenticated LND gRPC API Object>
     omit: [<Omit Peer With Public Key Hex String>]
-    [outbound_liquidity_below]: <Outbound Liquidity Below Tokens Number>
     [sort_by]: <Sort Results By Attribute String>
     [tags]: [<Tag Identifier String>]
   }
@@ -415,8 +413,6 @@ module.exports = (args, cbk) => {
         },
         {});
 
-        const maxInbound = args.inbound_liquidity_below;
-        const maxOutbound = args.outbound_liquidity_below;
         const {network} = getNetwork.value || {};
         const peerKeys = getChannels.channels.map(n => n.partner_public_key);
         const wallet = await getHeight({lnd: args.lnd});
@@ -507,6 +503,7 @@ module.exports = (args, cbk) => {
             filters: args.filters || [],
             variables: {
               age: blocks,
+              capacity: totalCapacity,
               disk_usage_mb: estimateDiskFootprint(pastStates),
               fee_earnings: mtokensAsTokens(feeMtokens),
               inbound_fee_rate: feeRate,
@@ -565,8 +562,6 @@ module.exports = (args, cbk) => {
         return {
           peers: sortBy({array: peers, attribute: args.sort_by || defaultSort})
             .sorted
-            .filter(n => !maxInbound || n.inbound_liquidity < maxInbound)
-            .filter(n => !maxOutbound || n.outbound_liquidity < maxOutbound)
             .filter(n => args.omit.indexOf(n.public_key) === notFoundIndex)
             .filter(n => {
               // Always return peer when no idle days are specified

package/network/remove_peer.js

@@ -36,7 +36,6 @@ const tokensAsBigUnit = tokens => (tokens / 1e8).toFixed(8);
       getFile: <Read File Contents Function> (path, cbk) => {}
     }
     [idle_days]: <No Activity From Peer For Days Number>
-    [inbound_liquidity_below]: <Peer Has Inbound Liquidity Below Tokens Number>
     [is_active]: <Peer Is Actively Connected Bool>
     [is_dry_run]: <Avoid Actually Closing Channel Bool>
     [is_forced]: <Force Close When Cooperative Close Is Impossible Bool>
@@ -47,7 +46,6 @@ const tokensAsBigUnit = tokens => (tokens / 1e8).toFixed(8);
     lnd: <Authenticated LND API Object>
     logger: <Winston Logger Object>
     [omit]: [<Avoid Peer With Public Key String>]
-    [outbound_liquidity_below]: <Has Outbound Liquidity Below Tokens Number>
     outpoints: [<Only Remove Specific Channel Funding Outpoint String>]
     [public_key]: <Public Key Hex String>
     request: <Request Function>
@@ -131,9 +129,9 @@ module.exports = (args, cbk) => {
       getPeers: ['validate', ({}, cbk) => {
         return getPeers({
           earnings_days: args.idle_days || defaultDays,
+          filters: args.filters,
           fs: args.fs,
           idle_days: args.idle_days || Number(),
-          inbound_liquidity_below: args.inbound_liquidity_below,
           is_active: args.is_active,
           is_offline: args.is_offline,
           is_private: args.is_private,
@@ -141,7 +139,6 @@ module.exports = (args, cbk) => {
           is_showing_last_received: true,
           lnd: args.lnd,
           omit: args.omit || [],
-          outbound_liquidity_below: args.outbound_liquidity_below,
           sort_by: 'last_activity',
         },
         cbk);

package/package.json

@@ -29,7 +29,7 @@
     "crypto-js": "4.1.1",
     "csv-parse": "5.0.4",
     "goldengate": "11.1.1",
-    "grammy": "1.7.1",
+    "grammy": "1.7.3",
     "hot-formula-parser": "4.0.0",
     "import-lazy": "4.0.0",
     "ini": "3.0.0",
@@ -82,5 +82,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": "11.64.2"
+  "version": "12.0.0"
 }