balanceofsatoshis 10.16.2 → 10.17.0

package/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Versions
 
+## Version 10.17.0
+
+- `chart-fees-paid`: Add tag icons to nodes in table view
+- `telegram`: Add `/costs` command to report rebalance and chain fees
+
 ## Version 10.16.2
 
 - `chart-chain-fees`: Add mempool space chain fee lookup redundancy

package/README.md

@@ -227,7 +227,12 @@ Use any shorthand you'd like when choosing this profile node name
 
 #### Umbrel Saved Node
 
-Note: Umbrel is not FOSS software, use at your own risk.
+*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`
 
 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

package/bos

@@ -358,6 +358,7 @@ prog
       try {
         return routing.getFeesPaid({
           days: options.days,
+          fs: {getFile: readFile},
           is_most_fees_table: options.mostFees,
           is_most_forwarded_table: options.mostForwarded,
           is_network: options.network,

package/package.json

@@ -35,9 +35,9 @@
     "inquirer": "8.1.5",
     "invoices": "2.0.0",
     "ln-accounting": "5.0.3",
-    "ln-service": "52.4.0",
-    "ln-sync": "1.0.0",
-    "ln-telegram": "3.2.11",
+    "ln-service": "52.5.0",
+    "ln-sync": "2.0.0",
+    "ln-telegram": "3.3.0",
     "moment": "2.29.1",
     "paid-services": "2.1.1",
     "probing": "1.3.6",
@@ -80,5 +80,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/fiat/*.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": "10.16.2"
+  "version": "10.17.0"
 }

package/routing/get_fees_paid.js

@@ -3,11 +3,13 @@ const asyncMap = require('async/map');
 const {getNode} = require('ln-service');
 const {getChannels} = require('ln-service');
 const {getPayments} = require('ln-sync');
+const {getRebalancePayments} = require('ln-sync');
 const moment = require('moment');
 const {returnResult} = require('asyncjs-util');
 
+const {chartAliasForPeer} = require('./../display');
 const feesForSegment = require('./fees_for_segment');
-const getRebalancePayments = require('./get_rebalance_payments');
+const {getIcons} = require('./../display');
 const {sortBy} = require('./../arrays');
 
 const by = 'confirmed_at';
@@ -27,6 +29,9 @@ const tokensAsBigUnit = tokens => (tokens / 1e8).toFixed(8);
 
   {
     days: <Fees Earned Over Days Count Number>
+    fs: {
+      getFile: <Read File Contents Function> (path, cbk) => {}
+    }
     [is_most_fees_table]: <Is Most Fees Table Bool>
     [is_most_forwarded_table]: <Is Most Forwarded Bool>
     [is_network]: <Show Only Non-Peers In Table Bool>
@@ -50,6 +55,10 @@ module.exports = (args, cbk) => {
           return cbk([400, 'ExpectedNumberOfDaysToGetFeesOverForChart']);
         }
 
+        if (!args.fs) {
+          return cbk([400, 'ExpectedFsMethodsToGetRoutingFeesPaid']);
+        }
+
         if (!!args.is_network && !!args.is_peer) {
           return cbk([400, 'ExpectedEitherNetworkOrPeersNotBoth']);
         }
@@ -75,6 +84,9 @@ module.exports = (args, cbk) => {
         });
       }],
 
+      // Get node icons
+      getIcons: ['validate', ({}, cbk) => getIcons({fs: args.fs}, cbk)],
+
       // Segment measure
       measure: ['validate', ({}, cbk) => {
         if (args.days > maxChartDays) {
@@ -130,7 +142,12 @@ module.exports = (args, cbk) => {
       }],
 
       // Fees paid to specific forwarding peers
-      rows: ['forwards', 'getChannels', ({forwards, getChannels}, cbk) => {
+      rows: [
+        'forwards',
+        'getChannels',
+        'getIcons',
+        ({forwards, getChannels, getIcons}, cbk) =>
+      {
         if (!args.is_most_forwarded_table && !args.is_most_fees_table) {
           return cbk();
         }
@@ -224,12 +241,22 @@ module.exports = (args, cbk) => {
 
               return !!args.is_peer ? isPeer : !isPeer;
             })
-            .map(n => {
+            .map(node => {
+              const key = node.public_key;
+
+              const nodeIcons = getIcons.nodes.find(n => n.public_key === key);
+
+              const {display} = chartAliasForPeer({
+                alias: node.alias || ' ',
+                icons: !!nodeIcons ? nodeIcons.icons : undefined,
+                public_key: key,
+              });
+
               return [
-                n.alias,
-                n.public_key,
-                mtokensAsBigUnit(n.fees_paid),
-                mtokensAsBigUnit(n.forwarded),
+                display,
+                key,
+                mtokensAsBigUnit(node.fees_paid),
+                mtokensAsBigUnit(node.forwarded),
               ];
             });
 

package/telegram/start_telegram_bot.js

@@ -13,6 +13,7 @@ const {getWalletInfo} = require('ln-service');
 const {handleBackupCommand} = require('ln-telegram');
 const {handleBlocknotifyCommand} = require('ln-telegram');
 const {handleConnectCommand} = require('ln-telegram');
+const {handleCostsCommand} = require('ln-telegram');
 const {handleEarningsCommand} = require('ln-telegram');
 const {handleInvoiceCommand} = require('ln-telegram');
 const {handleLiquidityCommand} = require('ln-telegram');
@@ -194,6 +195,7 @@ module.exports = ({fs, id, limits, lnds, logger, payments, request}, cbk) => {
           {command: 'backup', description: 'Get node backup file'},
           {command: 'blocknotify', description: 'Get notified on next block'},
           {command: 'connect', description: 'Get connect code for the bot'},
+          {command: 'costs', description: 'Show costs over the week'},
           {command: 'earnings', description: 'Show earnings over the week'},
           {command: 'invoice', description: 'Create an invoice'},
           {command: 'liquidity', description: 'Get liquidity [with-peer]'},
@@ -272,14 +274,27 @@ module.exports = ({fs, id, limits, lnds, logger, payments, request}, cbk) => {
           return;
         });
 
+        bot.command('costs', ctx => {
+          handleCostsCommand({
+            request,
+            from: ctx.message.from.id,
+            id: connectedId,
+            nodes: allNodes,
+            reply: n => ctx.replyWithMarkdown(n),
+            working: () => ctx.replyWithChatAction('typing'),
+          },
+          err => !!err && !!err[0] >= 500 ? logger.error({err}) : null);
+
+          return;
+        });
+
         bot.command('earnings', ctx => {
           handleEarningsCommand({
             from: ctx.message.from.id,
             id: connectedId,
-            key: apiKey.key,
             nodes: allNodes,
             reply: n => ctx.replyWithMarkdown(n),
-            text: ctx.message.text,
+            working: () => ctx.replyWithChatAction('typing'),
           },
           err => !!err && !!err[0] >= 500 ? logger.error({err}) : null);
 
@@ -397,6 +412,7 @@ module.exports = ({fs, id, limits, lnds, logger, payments, request}, cbk) => {
             '/backup - Get node backup file',
             '/blocknotify - Notification on next block',
             '/connect - Connect bot',
+            '/costs - View costs over the past week',
             '/earnings - View earnings over the past week',
             '/invoice - Make an invoice',
             '/liquidity [with] - View node liquidity',

package/wallets/get_received_chart.js

@@ -3,11 +3,11 @@ const asyncDetect = require('async/detect');
 const asyncFilterLimit = require('async/filterLimit');
 const asyncMap = require('async/map');
 const {formatTokens} = require('ln-sync');
+const {getAllInvoices} = require('ln-sync');
 const {getPayment} = require('ln-service');
 const moment = require('moment');
 const {returnResult} = require('asyncjs-util');
 
-const getAllInvoices = require('./get_all_invoices');
 const {segmentMeasure} = require('./../display');
 const {sumsForSegment} = require('./../display');
 

package/wallets/index.js

@@ -1,6 +1,5 @@
-const getAllInvoices = require('./get_all_invoices');
 const getReceivedChart = require('./get_received_chart');
 const getReport = require('./get_report');
 const unlockWallet = require('./unlock_wallet');
 
-module.exports = {getAllInvoices, getReceivedChart, getReport, unlockWallet};
+module.exports = {getReceivedChart, getReport, unlockWallet};

package/routing/get_rebalance_payments.js

@@ -1,162 +0,0 @@
-const asyncAuto = require('async/auto');
-const asyncMap = require('async/map');
-const asyncMapLimit = require('async/mapLimit');
-const {getPayment} = require('ln-service');
-const {returnResult} = require('asyncjs-util');
-
-const getAllInvoices = require('./../wallets/get_all_invoices');
-
-const flatten = arr => [].concat(...arr);
-const {isArray} = Array;
-const maxGetPayments = 100;
-const notFound = 404;
-
-/** Get payments that were rebalances
-
-  {
-    after: <Rebalance Payments After ISO 8601 Date String>
-    lnds: [<Authenticated LND API Object>]
-  }
-
-  @returns via cbk or Promise
-  {
-    payments: [{
-      attempts: [{
-        [failure]: {
-          code: <Error Type Code Number>
-          [details]: {
-            [channel]: <Standard Format Channel Id String>
-            [height]: <Error Associated Block Height Number>
-            [index]: <Failed Hop Index Number>
-            [mtokens]: <Error Millitokens String>
-            [policy]: {
-              base_fee_mtokens: <Base Fee Millitokens String>
-              cltv_delta: <Locktime Delta Number>
-              fee_rate: <Fees Charged in Millitokens Per Million Number>
-              [is_disabled]: <Channel is Disabled Bool>
-              max_htlc_mtokens: <Maximum HLTC Millitokens Value String>
-              min_htlc_mtokens: <Minimum HTLC Millitokens Value String>
-              updated_at: <Updated At ISO 8601 Date String>
-            }
-            [timeout_height]: <Error CLTV Timeout Height Number>
-            [update]: {
-              chain: <Chain Id Hex String>
-              channel_flags: <Channel Flags Number>
-              extra_opaque_data: <Extra Opaque Data Hex String>
-              message_flags: <Message Flags Number>
-              signature: <Channel Update Signature Hex String>
-            }
-          }
-          message: <Error Message String>
-        }
-        [index]: <Payment Add Index Number>
-        [confirmed_at]: <Payment Confirmed At ISO 8601 Date String>
-        is_confirmed: <Payment Attempt Succeeded Bool>
-        is_failed: <Payment Attempt Failed Bool>
-        is_pending: <Payment Attempt is Waiting For Resolution Bool>
-        route: {
-          fee: <Route Fee Tokens Number>
-          fee_mtokens: <Route Fee Millitokens String>
-          hops: [{
-            channel: <Standard Format Channel Id String>
-            channel_capacity: <Channel Capacity Tokens Number>
-            fee: <Fee Number>
-            fee_mtokens: <Fee Millitokens String>
-            forward: <Forward Tokens Number>
-            forward_mtokens: <Forward Millitokens String>
-            [public_key]: <Forward Edge Public Key Hex String>
-            [timeout]: <Timeout Block Height Number>
-          }]
-          mtokens: <Total Fee-Inclusive Millitokens String>
-          [payment]: <Payment Identifier Hex String>
-          timeout: <Timeout Block Height Number>
-          tokens: <Total Fee-Inclusive Tokens Number>
-          [total_mtokens]: <Total Millitokens String>
-        }
-      }]
-      confirmed_at: <Payment Confirmed At ISO 8601 Date String>
-      created_at: <Payment at ISO-8601 Date String>
-      destination: <Destination Node Public Key Hex String>
-      fee: <Paid Routing Fee Rounded Down Tokens Number>
-      fee_mtokens: <Paid Routing Fee in Millitokens String>
-      hops: [<First Route Hop Public Key Hex String>]
-      id: <Payment Preimage Hash String>
-      [index]: <Payment Add Index Number>
-      is_confirmed: <Payment is Confirmed Bool>
-      is_outgoing: <Transaction Is Outgoing Bool>
-      mtokens: <Millitokens Sent to Destination String>
-      [request]: <BOLT 11 Payment Request String>
-      safe_fee: <Payment Forwarding Fee Rounded Up Tokens Number>
-      safe_tokens: <Payment Tokens Rounded Up Number>
-      secret: <Payment Preimage Hex String>
-      tokens: <Rounded Down Tokens Sent to Destination Number>
-    }]
-  }
-*/
-module.exports = ({after, lnds}, cbk) => {
-  return new Promise((resolve, reject) => {
-    return asyncAuto({
-      // Check arguments
-      validate: cbk => {
-        if (!after) {
-          return cbk([400, 'ExpectedAfterDateToGetRebalancePayments']);
-        }
-
-        if (!isArray(lnds)) {
-          return cbk([400, 'ExpectedArrayOfLndsToGetRebalancePayments']);
-        }
-
-        return cbk();
-      },
-
-      // Get all the settled invoices
-      getSettled: ['validate', ({}, cbk) => {
-        return asyncMap(lnds, (lnd, cbk) => {
-          return getAllInvoices({lnd, created_after: after}, cbk);
-        },
-        (err, res) => {
-          if (!!err) {
-            return cbk(err);
-          }
-
-          return cbk(null, flatten(res.map(({invoices}) => invoices)));
-        });
-      }],
-
-      // Find self-payments by looking for payments with invoice ids
-      getRebalances: ['getSettled', ({getSettled}, cbk) => {
-        return asyncMap(lnds, (lnd, cbk) => {
-          return asyncMapLimit(getSettled, maxGetPayments, ({id}, cbk) => {
-            return getPayment({id, lnd}, (err, res) => {
-              // Exit early when there is no matching payment
-              if (isArray(err) && err.shift() === notFound) {
-                return cbk();
-              }
-
-              if (!!err) {
-                return cbk(err);
-              }
-
-              return cbk(null, res.payment);
-            });
-          },
-          (err, payments) => {
-            if (!!err) {
-              return cbk(err);
-            }
-
-            return cbk(null, payments.filter(n => !!n));
-          });
-        },
-        (err, res) => {
-          if (!!err) {
-            return cbk(err);
-          }
-
-          return cbk(null, {payments: flatten(res)});
-        });
-      }],
-    },
-    returnResult({reject, resolve, of: 'getRebalances'}, cbk));
-  });
-};

package/wallets/get_all_invoices.js

@@ -1,125 +0,0 @@
-const asyncAuto = require('async/auto');
-const asyncUntil = require('async/until');
-const {returnResult} = require('asyncjs-util');
-
-const {getInvoices} = require('ln-service');
-
-const defaultInvoicesLimit = 100;
-
-/** Get all invoices
-
-  {
-    [confirmed_after]: <Confirmed At or After ISO 8601 Date String>
-    [created_after]: <Confirmed At or After ISO 8601 Date String>
-    lnd: <Authenticated LND API Object>
-  }
-
-  @returns via cbk or Promise
-  {
-    invoices: [{
-      [chain_address]: <Fallback Chain Address String>
-      cltv_delta: <Final CLTV Delta Number>
-      [confirmed_at]: <Settled at ISO 8601 Date String>
-      created_at: <ISO 8601 Date String>
-      description: <Description String>
-      [description_hash]: <Description Hash Hex String>
-      expires_at: <ISO 8601 Date String>
-      features: [{
-        bit: <BOLT 09 Feature Bit Number>
-        is_known: <Feature is Known Bool>
-        is_required: <Feature Support is Required To Pay Bool>
-        type: <Feature Type String>
-      }]
-      id: <Payment Hash String>
-      [is_canceled]: <Invoice is Canceled Bool>
-      is_confirmed: <Invoice is Confirmed Bool>
-      [is_held]: <HTLC is Held Bool>
-      is_private: <Invoice is Private Bool>
-      [is_push]: <Invoice is Push Payment Bool>
-      payments: [{
-        [confirmed_at]: <Payment Settled At ISO 8601 Date String>
-        created_at: <Payment Held Since ISO 860 Date String>
-        created_height: <Payment Held Since Block Height Number>
-        in_channel: <Incoming Payment Through Channel Id String>
-        is_canceled: <Payment is Canceled Bool>
-        is_confirmed: <Payment is Confirmed Bool>
-        is_held: <Payment is Held Bool>
-        messages: [{
-          type: <Message Type Number String>
-          value: <Raw Value Hex String>
-        }]
-        mtokens: <Incoming Payment Millitokens String>
-        [pending_index]: <Pending Payment Channel HTLC Index Number>
-        tokens: <Payment Tokens Number>
-        [total_mtokens]: <Total Millitokens String>
-      }]
-      received: <Received Tokens Number>
-      received_mtokens: <Received Millitokens String>
-      [request]: <Bolt 11 Invoice String>
-      secret: <Secret Preimage Hex String>
-      tokens: <Tokens Number>
-    }]
-  }
-*/
-module.exports = (args, cbk) => {
-  return new Promise((resolve, reject) => {
-    return asyncAuto({
-      // Check arguments
-      validate: cbk => {
-        if (!args.lnd) {
-          return cbk([400, 'ExpectedAuthenticatedLndToGetAllInvoices']);
-        }
-
-        return cbk();
-      },
-
-      // Get all the invoices
-      getInvoices: ['validate', ({}, cbk) => {
-        const confAfter = args.confirmed_after;
-        const createdAfter = args.created_after;
-        const invoices = [];
-        let token;
-
-        return asyncUntil(
-          cbk => cbk(null, token === false),
-          cbk => {
-            return getInvoices({
-              token,
-              limit: !token ? defaultInvoicesLimit : undefined,
-              lnd: args.lnd,
-            },
-            (err, res) => {
-              if (!!err) {
-                return cbk(err);
-              }
-
-              token = res.next || false;
-
-              res.invoices
-                .filter(n => !confAfter || n.confirmed_at >= confAfter)
-                .filter(n => !createdAfter || n.created_at >= createdAfter)
-                .forEach(n => invoices.push(n));
-
-              const createdAt = res.invoices.map(n => n.created_at);
-
-              // Stop paging when created after is set
-              if (!!createdAfter && createdAt.find(n => n < createdAfter)) {
-                token = false;
-              }
-
-              return cbk();
-            });
-          },
-          err => {
-            if (!!err) {
-              return cbk(err);
-            }
-
-            return cbk(null, {invoices});
-          }
-        );
-      }],
-    },
-    returnResult({reject, resolve, of: 'getInvoices'}, cbk));
-  });
-};