balanceofsatoshis 12.3.0 → 12.5.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Versions
 
+## 12.5.0
+
+- `lnurl`: Add support for paying to https://lightningaddress.com/ type urls
+
+## 12.4.1
+
+- Add support for LND 0.14.3-beta
+- `telegram`: Disallow non connect user id queries for /mempool and /version
+
+## 12.4.0
+
+- `chart-fees-paid`: Allow using aliases when specifying --in and --out peers
+
 ## 12.3.0
 
 - `lnurl`: Add support for the `auth` function to authenticate with a node key
@@ -67,7 +80,7 @@ For `peers` and `remove-peer` commands:
 
 ## 11.59.4
 
-- `telegram`: Fix oepn trade-secret serving
+- `telegram`: Fix open trade-secret serving
 - `telegram`: Fix `/stop` command to require confirmation before termination
 
 ## 11.59.2

package/README.md

@@ -6,7 +6,7 @@ Commands for working with LND balances.
 
 Supported LND versions:
 
-- v0.11.0-beta to v0.14.2-beta
+- v0.11.0-beta to v0.14.3-beta
 
 ## Install
 

package/bos

@@ -398,12 +398,12 @@ prog
   .help('Show the routing fees paid to forwarding nodes')
   .help('--rebalances can return results much more quickly')
   .option('--days <days>', 'Chart fees over the past number of days', INT, 60)
-  .option('--in <public_key>', 'Fees paid on routes in node with public key')
+  .option('--in <key_or_alias>', 'Fees paid on routes in node with peer')
   .option('--most-fees', 'View table of fees paid per node')
   .option('--most-forwarded', 'View table of forwarded per node')
   .option('--network', 'Show only non-peers in table view')
   .option('--node <node_name>', 'Get fees chart for saved node(s)', REPEATABLE)
-  .option('--out <public_key>', 'Fees paid on routes out peer with public key')
+  .option('--out <key_or_alias>', 'Fees paid on routes out node with peer')
   .option('--peers', 'Show only peers in table view')
   .option('--rebalances', 'Only consider fees paid in self-to-self transfers')
   .action((args, options, logger) => {

package/lnurl/parse_url.js

@@ -0,0 +1,59 @@
+const {bech32} = require('bech32');
+
+const asLnurl = n => n.substring(n.startsWith('lightning:') ? 10 : 0);
+const bech32CharLimit = 2000;
+const {decode} = bech32;
+const isEmail = n => /^[a-zA-Z0-9._-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,4}$/.test(n);
+const isOnion = n => /.onion$/.test(n);
+const isUsername = n => /^[a-z0-9_.]*$/.test(n);
+const join = arr => arr.join('');
+const parseEmail = email => email.split('@');
+const prefix = 'lnurl';
+const sslProtocol = 'https://';
+const urlString = '/.well-known/lnurlp/';
+const wordsAsUtf8 = n => Buffer.from(bech32.fromWords(n)).toString('utf8');
+
+/** Parse lnurl or LUD-16 lightning address
+
+  {
+    url: <Lnurl or Lightning Address String>
+  }
+
+  @throws
+  <Error>
+
+  @returns
+  {
+    url: <Callback Url String>
+  }
+*/
+module.exports = ({url}) => {
+  if (!url) {
+    throw new Error('ExpectedLnurlOrLightningAddressToParse');
+  }
+
+  // Exit early when the URL looks like an email, indicating lightning address
+  if (!!isEmail(url)) {
+    const [username, domain] = parseEmail(url);
+
+    // Check if the user name is valid
+    if (!isUsername(username)) {
+      throw new Error('ExpectedValidUsernameInLightningAddress');
+    }
+
+    // Because of restrictions on the HTTP request library, disallow onion URLs
+    if (!!isOnion(domain)) {
+      throw new Error('LnurlOnionUrlsCurrentlyUnsupported');
+    }
+
+    return {url: join([sslProtocol, domain, urlString, username])};
+  }
+
+  if (decode(asLnurl(url), bech32CharLimit).prefix !== prefix) {
+    throw new Error('ExpectedLnurlPrefix');
+  }
+
+  const {words} = decode(asLnurl(url), bech32CharLimit);
+
+  return {url: wordsAsUtf8(words)};
+};

package/lnurl/pay.js

@@ -1,18 +1,15 @@
 const {createHash} = require('crypto');
 
 const asyncAuto = require('async/auto');
-const {bech32} = require('bech32');
 const {getNodeAlias} = require('ln-sync');
 const moment = require('moment');
 const {returnResult} = require('asyncjs-util');
 const {parsePaymentRequest} = require('ln-service');
 
+const parseUrl = require('./parse_url');
 const {pay} = require('./../network');
 
-const asLnurl = n => n.substring(n.startsWith('lightning:') ? 10 : 0);
-const bech32CharLimit = 2000;
 const errorStatus = 'ERROR';
-const {decode} = bech32;
 const {isArray} = Array;
 const isNumber = n => !isNaN(n);
 const lowestSendableValue = 1000;
@@ -22,7 +19,6 @@ const minMinSendable = 1;
 const mtokensAsTokens = n => Math.floor(n / 1000);
 const {parse} = JSON;
 const payRequestTag = 'payRequest';
-const prefix = 'lnurl';
 const {round} = Math;
 const sha256 = n => createHash('sha256').update(n).digest().toString('hex');
 const sslProtocol = 'https:';
@@ -30,7 +26,6 @@ const textPlain = 'text/plain';
 const tokensAsBigUnit = tokens => (tokens / 1e8).toFixed(8);
 const tokensAsMillitokens = n => n * 1000;
 const utf8AsBuffer = utf8 => Buffer.from(utf8, 'utf8');
-const wordsAsUtf8 = n => Buffer.from(bech32.fromWords(n)).toString('utf8');
 
 /** Pay to lnurl
  {
@@ -63,13 +58,9 @@ module.exports = (args, cbk) => {
         }
 
         try {
-          decode(asLnurl(args.lnurl), bech32CharLimit);
+          parseUrl({url: args.lnurl});
         } catch (err) {
-          return cbk([400, 'FailedToDecodeLnurlToPay']);
-        }
-
-        if (decode(asLnurl(args.lnurl), bech32CharLimit).prefix !== prefix) {
-          return cbk([400, 'ExpectedLnUrlPrefixToPay']);
+          return cbk([400, err.message]);
         }
 
         if (!args.lnd) {
@@ -101,9 +92,7 @@ module.exports = (args, cbk) => {
 
       // Get accepted terms from the encoded url
       getTerms: ['validate', ({}, cbk) => {
-        const {words} = decode(asLnurl(args.lnurl), bech32CharLimit);
-
-        const url = wordsAsUtf8(words);
+        const {url} = parseUrl({url: args.lnurl});
 
         return args.request({url, json: true}, (err, r, json) => {
           if (!!err) {

package/lnurl/sign_auth_challenge.js

@@ -43,4 +43,4 @@ module.exports = ({ecp, hostname, k1, seed}) => {
     public_key: bufferAsHex(linkingKey.publicKey),
     signature: derEncodeSignature({signature}).encoded,
   };
-};
+};

package/package.json

@@ -36,16 +36,16 @@
     "ini": "3.0.0",
     "inquirer": "8.2.2",
     "ln-accounting": "5.0.6",
-    "ln-service": "53.11.0",
+    "ln-service": "53.13.0",
     "ln-sync": "3.12.0",
-    "ln-telegram": "3.21.1",
+    "ln-telegram": "3.21.2",
     "moment": "2.29.3",
     "paid-services": "3.15.1",
     "probing": "2.0.5",
     "psbt": "2.0.1",
     "qrcode-terminal": "0.12.0",
     "sanitize-filename": "1.6.3",
-    "socks-proxy-agent": "6.2.0-beta.0",
+    "socks-proxy-agent": "6.2.0",
     "table": "6.8.0",
     "tiny-secp256k1": "2.2.1",
     "update-notifier": "5.1.0",
@@ -55,7 +55,7 @@
   "devDependencies": {
     "@alexbosworth/tap": "15.0.11",
     "invoices": "2.0.6",
-    "ln-docker-daemons": "2.2.7",
+    "ln-docker-daemons": "2.2.9",
     "mock-lnd": "1.4.1",
     "tiny-secp256k1": "2.2.1"
   },
@@ -84,5 +84,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": "12.3.0"
+  "version": "12.5.0"
 }

package/routing/get_fees_paid.js

@@ -1,5 +1,6 @@
 const asyncAuto = require('async/auto');
 const asyncMap = require('async/map');
+const {findKey} = require('ln-sync');
 const {getNode} = require('ln-service');
 const {getNodeAlias} = require('ln-sync');
 const {getChannels} = require('ln-service');
@@ -19,14 +20,17 @@ const flatten = arr => [].concat(...arr);
 const {floor} = Math;
 const heading = [['Node', 'Public Key', 'Fees Paid', 'Forwarded']];
 const hoursPerDay = 24;
+const isAmbiguous = n => n[1] === 'AmbiguousAliasSpecified';
 const {isArray} = Array;
 const {keys} = Object;
 const minChartDays = 4;
 const maxChartDays = 90;
 const mtokensAsBigUnit = n => (Number(n / BigInt(1e3)) / 1e8).toFixed(8);
 const mtokensAsTokens = mtokens => Number(mtokens / BigInt(1e3));
+const niceAlias = n => `${(n.alias || n.id).trim()} ${n.id.substring(0, 8)}`;
 const title = 'Routing fees paid';
 const tokensAsBigUnit = tokens => (tokens / 1e8).toFixed(8);
+const uniq = arr => Array.from(new Set(arr));
 
 /** Get routing fees paid
 
@@ -35,11 +39,13 @@ const tokensAsBigUnit = tokens => (tokens / 1e8).toFixed(8);
     fs: {
       getFile: <Read File Contents Function> (path, cbk) => {}
     }
+    [in]: <In Node Public Key or Alias String>
     [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>
     [is_peer]: <Show Only Peers In Table Bool>
     lnds: [<Authenticated LND API Object>]
+    [out]: <Out Node Public Key or Alias String>
   }
 
   @returns via cbk or Promise
@@ -90,6 +96,88 @@ module.exports = (args, cbk) => {
       // Get node icons
       getIcons: ['validate', ({}, cbk) => getIcons({fs: args.fs}, cbk)],
 
+      // Determine the in public key to use
+      getInKey: ['validate', ({}, cbk) => {
+        // Exit early when no in query is specified
+        if (!args.in) {
+          return cbk();
+        }
+
+        return asyncMap(args.lnds, (lnd, cbk) => {
+          return findKey({lnd, query: args.in}, (err, res) => {
+            // Exit for ambiguous queries
+            if (!!err && isAmbiguous(err)) {
+              return cbk(err);
+            }
+
+            // Ignore all other errors, since a peer may not exist on all nodes
+            if (!!err) {
+              return cbk();
+            }
+
+            return cbk(null, res.public_key);
+          });
+        },
+        (err, res) => {
+          if (!!err) {
+            return cbk(err);
+          }
+
+          const [key, otherKey] = uniq(res.filter(n => !!n));
+
+          if (!key) {
+            return cbk([400, 'FailedToFindMatchesForInQueryAlias']);
+          }
+
+          if (!!otherKey) {
+            return cbk([400, 'MultipleMatchesForInQueryAlias']);
+          }
+
+          return cbk(null, key);
+        });
+      }],
+
+      // Determine the out public key to use
+      getOutKey: ['validate', ({}, cbk) => {
+        // Exit early when no out query is specified
+        if (!args.out) {
+          return cbk();
+        }
+
+        return asyncMap(args.lnds, (lnd, cbk) => {
+          return findKey({lnd, query: args.out}, (err, res) => {
+            // Exit for ambiguous queries
+            if (!!err && isAmbiguous(err)) {
+              return cbk(err);
+            }
+
+            // Ignore all other errors, since a peer may not exist on all nodes
+            if (!!err) {
+              return cbk();
+            }
+
+            return cbk(null, res.public_key);
+          });
+        },
+        (err, res) => {
+          if (!!err) {
+            return cbk(err);
+          }
+
+          const [key, otherKey] = uniq(res.filter(n => !!n));
+
+          if (!key) {
+            return cbk([400, 'FailedToFindMatchesForOutQueryAlias']);
+          }
+
+          if (!!otherKey) {
+            return cbk([400, 'MultipleMatchesForOutQueryAlias']);
+          }
+
+          return cbk(null, key);
+        });
+      }],
+
       // Segment measure
       measure: ['validate', ({}, cbk) => {
         if (args.days > maxChartDays) {
@@ -141,7 +229,13 @@ module.exports = (args, cbk) => {
       }],
 
       // Filter the payments
-      forwards: ['getPayments', 'start', ({getPayments, start}, cbk) => {
+      forwards: [
+        'getInKey',
+        'getOutKey',
+        'getPayments',
+        'start',
+        ({getInKey, getOutKey, getPayments, start}, cbk) =>
+      {
         const payments = getPayments
           .filter(payment => payment.is_confirmed !== false)
           .filter(payment => payment.confirmed_at > start.toISOString())
@@ -163,7 +257,7 @@ module.exports = (args, cbk) => {
               }
 
               // Ignore attempts that do not include the specified out hop
-              if (!!args.out && outHop !== args.out) {
+              if (!!args.out && outHop !== getOutKey) {
                 return false;
               }
 
@@ -172,7 +266,7 @@ module.exports = (args, cbk) => {
               }
 
               // Ignore attempts that do not include the specified in hop
-              if (!!args.in && inHop !== args.in) {
+              if (!!args.in && inHop !== getInKey) {
                 return false;
               }
 
@@ -375,14 +469,19 @@ module.exports = (args, cbk) => {
       }],
 
       // Title for fees paid
-      title: ['validate', async ({}) => {
+      title: [
+        'validate',
+        'getInKey',
+        'getOutKey',
+        async ({getInKey, getOutKey}) =>
+      {
         const [lnd] = args.lnds;
 
-        const into = !args.in ? null : await getNodeAlias({lnd, id: args.in});
-        const out = !args.out ? null : await getNodeAlias({lnd, id: args.out});
+        const into = !args.in ? {} : await getNodeAlias({lnd, id: getInKey});
+        const out = !args.out ? {} : await getNodeAlias({lnd, id: getOutKey});
 
-        const inPeer = !!args.in ? `in ${into.alias || into.id}` : '';
-        const outPeer = !!args.out ? `out ${out.alias || out.id}` : '';
+        const inPeer = !!args.in ? `in ${niceAlias(into)}` : '';
+        const outPeer = !!args.out ? `out ${niceAlias(out)}` : '';
 
         return [title, outPeer, inPeer].filter(n => !!n).join(' ');
       }],
@@ -395,6 +494,13 @@ module.exports = (args, cbk) => {
         'title',
         ({description, rows, sum, title}, cbk) =>
       {
+        const isRows = args.is_most_fees_table || args.is_most_forwarded_table;
+
+        // Add a title row when there is a restriction involved
+        if (!!isRows && (!!args.in || !!args.out)) {
+          rows.unshift([String(), title, String(), String()]);
+        }
+
         return cbk(null, {description, rows, title, data: sum.fees});
       }],
     },

package/telegram/start_telegram_bot.js

@@ -302,6 +302,8 @@ module.exports = (args, cbk) => {
         args.bot.command('mempool', async ctx => {
           try {
             return await handleMempoolCommand({
+              from: ctx.message.from.id,
+              id: connectedId,
               reply: n => ctx.reply(n, markdown),
               request: args.request,
             });
@@ -409,6 +411,8 @@ module.exports = (args, cbk) => {
             await handleVersionCommand({
               named,
               version,
+              from: ctx.message.from.id,
+              id: connectedId,
               request: args.request,
               reply: n => ctx.reply(n, markdown),
             });