balanceofsatoshis 11.35.0 → 11.36.3

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Versions
 
+## 11.36.3
+
+- `telegram`: Add support for `--use-proxy` to specify a SOCKS proxy server
+
 ## 11.35.0
 
 - `graph`: Add `HOPS` variable to `--filter` for node peer distance from self

package/bos

@@ -1607,11 +1607,13 @@ prog
   .help('Supported updates: forwards, received payments, etc')
   .help('Multiple nodes are supported by repeating the `--node` flag')
   .help('See README for info on persisting the bot through Docker/nohup')
+  .help('--use-proxy requires path to JSON file for host/password/port/userId')
   .option('--budget <amount>', 'Spending amount to allow', INT, Number())
   .option('--connect <connect_code>', 'Connection code', INT)
   .option('--ignore-forwards-below <amount>', 'Ignore forwards of value', INT)
   .option('--node <node_name>', 'Node to connect to Telegram', REPEATABLE)
   .option('--reset-api-key', 'Reset the Telegram API key')
+  .option('--use-proxy <path>', 'Proxy agent to connect to Telegram')
   .action((args, options, logger) => {
     return new Promise(async (resolve, reject) => {
       try {
@@ -1628,6 +1630,7 @@ prog
           min_forward_tokens: options.ignoreForwardsBelow || undefined,
           nodes: flatten([options.node].filter(n => !!n)),
           payments: {limit: options.budget},
+          proxy: options.useProxy || undefined,
           request: commands.fetchRequest({fetch}),
         });
       } catch (err) {

package/package.json

@@ -35,15 +35,16 @@
     "inquirer": "8.2.0",
     "invoices": "2.0.3",
     "ln-accounting": "5.0.5",
-    "ln-service": "53.5.2",
-    "ln-sync": "3.7.0",
-    "ln-telegram": "3.10.0",
+    "ln-service": "53.6.0",
+    "ln-sync": "3.7.1",
+    "ln-telegram": "3.12.0",
     "moment": "2.29.1",
     "paid-services": "3.11.0",
     "probing": "2.0.2",
-    "psbt": "1.1.10",
+    "psbt": "1.1.11",
     "qrcode-terminal": "0.12.0",
     "sanitize-filename": "1.6.3",
+    "socks-proxy-agent": "6.1.1",
     "table": "6.8.0",
     "update-notifier": "5.1.0",
     "window-size": "1.1.1"
@@ -51,7 +52,7 @@
   "description": "Lightning balance CLI",
   "devDependencies": {
     "@alexbosworth/tap": "15.0.10",
-    "ln-docker-daemons": "2.2.0",
+    "ln-docker-daemons": "2.2.1",
     "mock-lnd": "1.4.1",
     "secp256k1": "4.0.3"
   },
@@ -80,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.35.0"
+  "version": "11.36.3"
 }

package/telegram/connect_to_telegram.js

@@ -29,6 +29,7 @@ const restartDelayMs = 1000 * 60 * 3;
     payments: {
       [limit]: <Total Spendable Budget Tokens Limit Number>
     }
+    [proxy]: <Path to Proxy JSON File String>
     request: <Request Function>
   }
 
@@ -114,6 +115,7 @@ module.exports = (args, cbk) => {
               },
               logger: args.logger,
               payments: {limit},
+              proxy: args.proxy,
               request: args.request,
             },
             err => {

package/telegram/interaction.json

@@ -4,10 +4,8 @@
     "name": "key",
     "type": "password"
   },
-  "bot_is_connected": "🤖 *Bot is online.* /help for commands",
   "edit_message_warning": "⚠️ *Editing past messages not supported.*\n\n_Did you mean to send a new message?_",
   "pay_budget_depleted": "⚠️ No budget for payments",
-  "start_message": "🤖 *Bot started, run /connect to authorize.*",
   "user_id_prompt": {
     "message": "Connection code? (Bot command: /connect)",
     "name": "code",

package/telegram/start_telegram_bot.js

@@ -18,11 +18,13 @@ const {handleButtonPush} = require('ln-telegram');
 const {handleConnectCommand} = require('ln-telegram');
 const {handleCostsCommand} = require('ln-telegram');
 const {handleEarningsCommand} = require('ln-telegram');
+const {handleEditedMessage} = require('ln-telegram');
 const {handleInvoiceCommand} = require('ln-telegram');
 const {handleLiquidityCommand} = require('ln-telegram');
 const {handleMempoolCommand} = require('ln-telegram');
 const {handlePayCommand} = require('ln-telegram');
 const {handlePendingCommand} = require('ln-telegram');
+const {handleStartCommand} = require('ln-telegram');
 const {handleVersionCommand} = require('ln-telegram');
 const {InputFile} = require('grammy');
 const inquirer = require('inquirer');
@@ -39,6 +41,7 @@ const {postUpdatedBackup} = require('ln-telegram');
 const {returnResult} = require('asyncjs-util');
 const {sendMessage} = require('ln-telegram');
 const {serviceAnchoredTrades} = require('paid-services');
+const SocksProxyAgent = require('socks-proxy-agent');
 const {subscribeToBackups} = require('ln-service');
 const {subscribeToBlocks} = require('goldengate');
 const {subscribeToChannels} = require('ln-service');
@@ -47,7 +50,6 @@ const {subscribeToPastPayments} = require('ln-service');
 const {subscribeToTransactions} = require('ln-service');
 
 const interaction = require('./interaction');
-const markdown = {parse_mode: 'Markdown'};
 const named = require('./../package').name;
 const {version} = require('./../package');
 
@@ -61,9 +63,11 @@ const home = '.bos';
 const {isArray} = Array;
 const isNumber = n => !isNaN(n);
 const limit = 99999;
+const markdown = {parse_mode: 'Markdown'};
 const maxCommandDelayMs = 1000 * 10;
 const msSince = epoch => Date.now() - (epoch * 1e3);
 const network = 'btc';
+const {parse} = JSON;
 const restartSubscriptionTimeMs = 1000 * 30;
 const sanitize = n => (n || '').replace(/_/g, '\\_').replace(/[*~`]/g, '');
 
@@ -85,12 +89,15 @@ const sanitize = n => (n || '').replace(/_/g, '\\_').replace(/[*~`]/g, '');
     payments: {
       [limit]: <Total Spendable Budget Tokens Limit Number>
     }
+    [proxy]: <Path to Proxy JSON File String>
     request: <Request Function>
   }
 
   @returns via cbk or Promise
 */
-module.exports = ({fs, id, limits, lnds, logger, payments, request}, cbk) => {
+module.exports = (args, cbk) => {
+  const {fs, id, limits, lnds, logger, payments, request} = args;
+
   let connectedId = id;
   let isStopped = false;
   let paymentsLimit = !payments || !payments.limit ? Number() : payments.limit;
@@ -169,6 +176,45 @@ module.exports = ({fs, id, limits, lnds, logger, payments, request}, cbk) => {
         cbk);
       }],
 
+      // Get proxy agent
+      getProxyAgent: ['validate', ({}, cbk) => {
+        // Exit early if not using a proxy
+        if (!args.proxy) {
+          return cbk();
+        }
+
+        return args.fs.getFile(args.proxy, (err, res) => {
+          if (!!err) {
+            return cbk([503, 'FailedToFindFileAtProxySpecifiedPath', {err}]);
+          }
+
+          if (!res) {
+            return cbk([503, 'ExpectedFileDataAtProxySpecifiedPath']);
+          }
+
+          try {
+            parse(res.toString());
+          } catch (err) {
+            return cbk([503, 'ExpectedValidJsonConfigFileForProxy']);
+          }
+
+          const {host, password, port, userId} = parse(res);
+
+          try {
+            const socksAgent = new SocksProxyAgent({
+              host,
+              password,
+              port,
+              userId,
+            });
+
+            return cbk(null, socksAgent);
+          } catch (err) {
+            return cbk([503, 'FailedToCreateSocksProxyAgent', {err}]);
+          }
+        });
+      }],
+
       // Save API key
       saveKey: ['apiKey', ({apiKey}, cbk) => {
         // Exit early when API key is already saved
@@ -192,7 +238,12 @@ module.exports = ({fs, id, limits, lnds, logger, payments, request}, cbk) => {
       }],
 
       // Setup the bot start action
-      initBot: ['apiKey', 'getNodes', ({apiKey, getNodes}, cbk) => {
+      initBot: [
+        'apiKey',
+        'getNodes',
+        'getProxyAgent',
+        ({apiKey, getNodes, getProxyAgent}, cbk) =>
+      {
         allNodes = getNodes;
 
         // Exit early when bot is already instantiated
@@ -200,7 +251,14 @@ module.exports = ({fs, id, limits, lnds, logger, payments, request}, cbk) => {
           return cbk();
         }
 
-        bot = new Bot(apiKey.key);
+        // Initiate bot using proxy agent when configured
+        if (!!getProxyAgent) {
+          bot = new Bot(apiKey.key, {
+            client: {baseFetchConfig: {agent: getProxyAgent, compress: true}},
+          });
+        } else {
+          bot = new Bot(apiKey.key);
+        }
 
         bot.api.setMyCommands([
           {command: 'backup', description: 'Get node backup file'},
@@ -219,18 +277,11 @@ module.exports = ({fs, id, limits, lnds, logger, payments, request}, cbk) => {
 
         bot.catch(err => logger.error({telegram_error: err}));
 
-        bot.use((ctx, next) => {
-          // Ignore messages that are old
-          if (!!ctx.message && msSince(ctx.message.date) > maxCommandDelayMs) {
-            return;
-          }
-
-          // Warn on edit of old message
-          if (!!ctx.update && !!ctx.update.edited_message) {
-            const {text} = ctx.update.edited_message;
-            const warning = interaction.edit_message_warning;
-
-            return ctx.reply(`${warning}\n${text}`, markdown);
+        bot.use(async (ctx, next) => {
+          try {
+            await handleEditedMessage({ctx});
+          } catch (err) {
+            logger.error({err});
           }
 
           return next();
@@ -239,7 +290,6 @@ module.exports = ({fs, id, limits, lnds, logger, payments, request}, cbk) => {
         bot.command('backup', ctx => {
           handleBackupCommand({
             logger,
-            request,
             from: ctx.message.from.id,
             id: connectedId,
             key: apiKey.key,
@@ -337,12 +387,10 @@ module.exports = ({fs, id, limits, lnds, logger, payments, request}, cbk) => {
               },
             }, async () => {
               await handleLiquidityCommand({
-                request,
                 from: ctx.message.from.id,
                 id: connectedId,
-                key: apiKey.key,
                 nodes: allNodes,
-                reply: ctx.reply,
+                reply: n => ctx.reply(n, markdown),
                 text: ctx.message.text,
                 working: () => ctx.replyWithChatAction('typing'),
               });
@@ -403,12 +451,10 @@ module.exports = ({fs, id, limits, lnds, logger, payments, request}, cbk) => {
         });
 
         bot.command('start', ctx => {
-          // Exit early when the bot is already connected
-          if (!!connectedId) {
-            return ctx.reply(interaction.bot_is_connected, markdown);
-          }
-
-          return ctx.reply(interaction.start_message, markdown);
+          handleStartCommand({
+            id: connectedId,
+            reply: n => ctx.reply(n, markdown),
+          });
         });
 
         bot.command('version', async ctx => {