Merge remote-tracking branch 'upstream/main' into issue726

Author: Matobi98

.env-sample

@@ -96,3 +96,10 @@ GOLDEN_HONEY_BADGER_PROBABILITY=100
 
 # Number of notification messages sent to the admin, informing them of lack of solvers before disabling the community. The admin receives `MAX_ADMIN_WARNINGS_BEFORE_DEACTIVATION - 1` notification messages.
 MAX_ADMIN_WARNINGS_BEFORE_DEACTIVATION=10
+
+# The file in which commands will be logged. It can be both an absolute or relative path (realative to the directory in which your run `npm start`)
+COMMAND_LOG_FILE='commands.log'
+# The maximum size of each command log file in megabytes
+COMMAND_LOG_SIZE_MB=4
+# The maximum number of log files to keep
+MAX_LOG_FILES=5

.gitignore

@@ -3,4 +3,5 @@ node_modules
 admin.macaroon
 tls.cert
 dist/
-.history/
+.history/
+commands.log

bot/messages.ts

@@ -18,6 +18,7 @@ import { logger } from '../logger';
 import { HasTelegram, MainContext } from './start';
 import { UserDocument } from '../models/user';
 import { IOrder } from '../models/order';
+import { Order, User, Community } from '../models';
 import { I18nContext } from '@grammyjs/i18n';
 import { IConfig } from '../models/config';
 import { IPendingPayment } from '../models/pending_payment';
@@ -26,7 +27,6 @@ import { IFiat } from '../util/fiatModel';
 import { CommunityContext } from './modules/community/communityContext';
 import { imageCache } from '../util/imageCache';
 import { ImageProcessingError } from '../util/errors';
-import { Community } from '../models';
 
 const { I18n } = require('@grammyjs/i18n');
 
@@ -2000,10 +2000,11 @@ const showConfirmationButtons = async (
           };
         })
         .map(ord => ({
-          text: `${ord._id.slice(0, 2)}..${ord._id.slice(-2)} - ${ord.type} - ${
-            ord.fiat
-          } ${ord.amount}`,
-          callback_data: `${commandString}_${ord._id}`,
+          text: `${ord._id.slice(0, 2)}..${ord._id.slice(-2)} - ${ord.type} - ${ord.fiat} ${ord.amount}`,
+          callback_data:
+            commandString === 'release'
+              ? `show_release_confirmation_${ord._id}`
+              : `${commandString}_${ord._id}`,
         }));
       inlineKeyboard.push(lineBtn);
     }
@@ -2021,6 +2022,49 @@ const showConfirmationButtons = async (
   }
 };
 
+const showReleaseConfirmationMessage = async (
+  ctx: MainContext,
+  orderId: string,
+) => {
+  try {
+    const order = await Order.findOne({ _id: orderId });
+    if (!order) return;
+
+    // Get user information
+    const seller = await User.findOne({ _id: order.seller_id });
+    const buyer = await User.findOne({ _id: order.buyer_id });
+
+    if (!seller || !buyer) return;
+
+    const message = ctx.i18n.t('release_confirmation_message', {
+      orderId: order._id,
+      counterparty: buyer.username || buyer.tg_id,
+      amount: order.amount,
+      fiatCode: order.fiat_code,
+      fiatAmount: order.fiat_amount,
+    });
+
+    const inlineKeyboard = [
+      [
+        {
+          text: ctx.i18n.t('release_confirm_button'),
+          callback_data: `confirm_release_${order._id}`,
+        },
+        {
+          text: ctx.i18n.t('release_cancel_button'),
+          callback_data: 'cancel_release',
+        },
+      ],
+    ];
+
+    await ctx.reply(message, {
+      reply_markup: { inline_keyboard: inlineKeyboard },
+    });
+  } catch (error) {
+    logger.error(error);
+  }
+};
+
 export {
   startMessage,
   initBotErrorMessage,
@@ -2135,6 +2179,7 @@ export {
   notAuthorized,
   mustBeANumber,
   showConfirmationButtons,
+  showReleaseConfirmationMessage,
   counterPartyCancelOrderMessage,
   checkInvoiceMessage,
   userTakerIsBlockedByUserOrder,

bot/middleware/commandlogging.ts

@@ -0,0 +1,89 @@
+import { MiddlewareFn } from 'telegraf';
+import { CommunityContext } from '../modules/community/communityContext';
+import winston from 'winston';
+import { extractId } from '../../util';
+
+const logFile = process.env.COMMAND_LOG_FILE || 'commands.log';
+const maxSizeMB = parseInt(process.env.COMMAND_LOG_SIZE_MB || '5', 10) || 5;
+const maxFiles = parseInt(process.env.MAX_LOG_FILES || '5', 10) || 5;
+
+const logger = winston.createLogger({
+  format: winston.format.combine(
+    winston.format.timestamp({
+      format: 'YYYY-MM-DDTHH:mm:ss.SSSZ',
+    }),
+    winston.format.printf(info => {
+      return `[${info.timestamp}] ${info.level}: ${info.message} ${
+        info.stack ? info.stack : ''
+      }`;
+    }),
+  ),
+  levels: winston.config.syslog.levels,
+  level: 'debug',
+  transports: [
+    new winston.transports.File({
+      filename: logFile,
+      maxsize: maxSizeMB * 1024 ** 2, // maxsize in MB
+      maxFiles,
+      tailable: true,
+      zippedArchive: false,
+    }),
+  ],
+  exitOnError: false,
+});
+
+export function commandLogger(): MiddlewareFn<CommunityContext> {
+  return async (ctx, next) => {
+    try {
+      if (ctx.message && 'text' in ctx.message) {
+        const msg = ctx.message;
+        const text = msg.text.trim();
+        const userId = msg.from?.id ?? 'unknown';
+
+        let command: string | null = null;
+        let args: string[] = [];
+        let isCommand: boolean;
+
+        if (text.startsWith('/')) {
+          const parts = text.split(/\s+/);
+          command = parts[0];
+          args = parts.slice(1);
+          isCommand = true;
+        } else {
+          isCommand = false;
+          command = text;
+        }
+
+        const userName = msg.from?.username ?? '';
+
+        logger.info(
+          `User @${userName} [${userId}] ${isCommand ? 'executed command:' : 'sent message:'} ${command} with args: [${args.join(', ')}]`,
+        );
+      } else if (ctx.callbackQuery && 'data' in ctx.callbackQuery) {
+        // Attempt to get message text
+
+        const callbackQueryMessage =
+          (ctx.callbackQuery?.message as any)?.text ?? '';
+        const isId = /^[a-f0-9]{24}$/.test(callbackQueryMessage);
+        const orderId = isId
+          ? callbackQueryMessage
+          : extractId(callbackQueryMessage);
+        const msgText = orderId
+          ? `Order ID: ${orderId}`
+          : `Message text: '${callbackQueryMessage}'`;
+        const callbackData = ctx.callbackQuery.data;
+        const userName = ctx.callbackQuery.from?.username ?? '';
+        const userId = ctx.callbackQuery.from?.id ?? '';
+        logger.info(
+          `User @${userName} [${userId}] sent callback query with data: ${callbackData}. '${msgText}'`,
+        );
+      } else {
+        logger.info(`Received non-command message or update from user.`);
+      }
+    } catch (err) {
+      logger.error('logging middleware failed', err);
+    }
+
+    return next();
+  };
+}

bot/start.ts

@@ -47,6 +47,7 @@ import {
   release,
   showQrCode,
 } from './commands';
+import { showReleaseConfirmationMessage } from './messages';
 import {
   settleHoldInvoice,
   cancelHoldInvoice,
@@ -74,6 +75,7 @@ import {
 import { logger } from '../logger';
 import { IUsernameId } from '../models/community';
 import { CommunityContext } from './modules/community/communityContext';
+import { commandLogger } from './middleware/commandlogging';
 
 export interface MainContext extends Context {
   match: Array<string> | null;
@@ -192,6 +194,7 @@ const initialize = (
     logger.error(err);
   });
 
+  bot.use(commandLogger());
   bot.use(session());
   bot.use(limit());
   bot.use(i18n.middleware());
@@ -917,6 +920,42 @@ const initialize = (
     },
   );
 
+  // Action to show release confirmation
+  bot.action(
+    /^show_release_confirmation_([0-9a-f]{24})$/,
+    userMiddleware,
+    async (ctx: CommunityContext) => {
+      if (ctx.match === null) {
+        throw new Error('ctx.match should not be null');
+      }
+      ctx.deleteMessage();
+      await showReleaseConfirmationMessage(ctx, ctx.match[1]);
+    },
+  );
+
+  // Action to confirm release
+  bot.action(
+    /^confirm_release_([0-9a-f]{24})$/,
+    userMiddleware,
+    async (ctx: CommunityContext) => {
+      if (ctx.match === null) {
+        throw new Error('ctx.match should not be null');
+      }
+      ctx.deleteMessage();
+      await release(ctx, ctx.match[1]);
+    },
+  );
+
+  // Action to cancel release
+  bot.action(
+    /^cancel_release$/,
+    userMiddleware,
+    async (ctx: CommunityContext) => {
+      ctx.deleteMessage();
+      await ctx.reply(ctx.i18n.t('release_operation_cancelled'));
+    },
+  );
+
   bot.action(
     /^showqrcode_([0-9a-f]{24})$/,
     userMiddleware,

locales/de.yaml

@@ -510,7 +510,21 @@ not_wizard: Sie sind momentan nicht im Assistentenmodus. Für Hilfe verwenden Si
 wizard_help: Sie befinden sich im Assistentenmodus, wenn Sie wieder zum Befehlsmodus wollen, verwenden Sie /exit
 hold_invoice_memo: '@${botName} - Auftrag #${orderId}: BTC verkaufen für ${fiatCode} ${fiatAmount} - Der Betrag wird im gehalten, bis Sie diesen mit /release freigeben. Wenn der Käufer nicht bestätigt, wird der Betrag zurückbezahlt.'
 tap_button: Wählen Sie eine Bestellung, um den Vorgang auszuführen
-tap_release: Wählen Sie die Reihenfolge aus, um die Mittel freizugeben. Sobald Sie die Schaltfläche berühren, kann der Vorgang nicht rückgängig gemacht werden.
+tap_release: Wählen Sie die Bestellung aus, um die Mittel freizugeben. Sie sehen eine Bestätigung, bevor Sie fortfahren.
+release_confirmation_message: |
+  Sie sind dabei, die folgende Bestellung freizugeben:
+
+  🆔 Bestell-ID: ${orderId}
+  👤 Gegenpartei: @${counterparty}
+  ⚡ Betrag: ${amount} sats
+  💰 Gegenwert: ${fiatAmount} ${fiatCode}
+
+  ⚠️ Dieser Vorgang kann nicht rückgängig gemacht werden.
+
+  Möchten Sie diesen Vorgang bestätigen?
+release_confirm_button: Bestätigen
+release_cancel_button: Abbrechen
+release_operation_cancelled: Freigabe-Vorgang abgebrochen.
 earnings: Verdienste
 premium: Prämie
 discount: Rabatt

locales/en.yaml

@@ -516,7 +516,21 @@ not_wizard: You are not in wizard mode at the moment, if you have doubts you can
 wizard_help: You are in wizard mode, if you need to go back to command mode run /exit
 hold_invoice_memo: '@${botName} - Escrow amount Order #${orderId}: SELL BTC for ${fiatCode} ${fiatAmount} - It WILL FREEZE IN YOUR WALLET. It will release once you run /release. It will return if buyer does not confirm the payment'
 tap_button: Select an order to perform the operation
-tap_release: Select the order to release the funds, once you press the button, the operation cannot be reversed.
+tap_release: Select the order to release the funds, you will see a confirmation before proceeding.
+release_confirmation_message: |
+  You are about to release the following order:
+
+  🆔 Order ID: ${orderId}
+  👤 Counterparty: @${counterparty}
+  ⚡ Amount: ${amount} sats
+  💰 Fiat equivalent: ${fiatAmount} ${fiatCode}
+
+  ⚠️ This operation cannot be reversed.
+
+  Do you want to confirm this operation?
+release_confirm_button: Confirm
+release_cancel_button: Cancel
+release_operation_cancelled: Release operation cancelled.
 earnings: Earnings
 premium: Premium
 discount: Discount

locales/es.yaml

@@ -511,7 +511,21 @@ not_wizard: No estás en el modo asistente en este momento, si tienes dudas pued
 wizard_help: Estás en modo asistente, si necesitas volver al modo comando ejecuta /exit
 hold_invoice_memo: '@${botName} - Depósito en garantía Orden #${orderId} - VENTA x ${fiatCode} ${fiatAmount} - SE CONGELA EN BILLETERA. Se libera una vez ejecute /release. Retorna a la wallet si el comprador no confirma el pago'
 tap_button: Selecciona una orden para realizar la operación
-tap_release: Selecciona la orden para liberar los fondos, una vez toques el botón la operación no puede ser reversada.
+tap_release: Selecciona la orden para liberar los fondos, verás una confirmación antes de proceder.
+release_confirmation_message: |
+  Estás a punto de liberar la siguiente orden:
+
+  🆔 ID de orden: ${orderId}
+  👤 Contraparte: ${counterparty}
+  ⚡ Monto: ${amount} sats
+  💰 Equivalente: ${fiatAmount} ${fiatCode}
+
+  ⚠️ Esta operación no puede ser revertida.
+
+  ¿Quieres confirmar esta operación?
+release_confirm_button: Confirmar
+release_cancel_button: Cancelar
+release_operation_cancelled: Operación de liberación cancelada.
 earnings: Ganancias
 premium: Prima
 discount: Descuento

locales/fa.yaml

@@ -510,7 +510,21 @@ not_wizard: شما در حال حاضر در حالت wizard نیستید، اگ
 wizard_help: شما در حالت wizard هستید، اگر نیاز به بازگشت به حالت فرمان دارید، /exit را اجرا کنید
 hold_invoice_memo: '@${botName} - Escrow amount Order #${orderId}: SELL BTC for ${fiatCode} ${fiatAmount} - It WILL FREEZE IN YOUR WALLET. It will release once you run /release. It will return if buyer does not confirm the payment'
 tap_button: دستوری را برای انجام عملیات انتخاب کنید
-tap_release: سفارش را انتخاب کنید تا وجه را آزاد کنید، پس از فشار دادن دکمه، عملیات قابل برگشت نیست.
+tap_release: برای آزادسازی وجه، سفارش را انتخاب کنید؛ قبل از ادامه تأییدی مشاهده خواهید کرد.
+release_confirmation_message: |
+  شما در آستانه آزاد کردن سفارش زیر هستید:
+
+  🆔 شناسه سفارش: ${orderId}
+  👤 طرف مقابل: @${counterparty}
+  ⚡ مبلغ: ${amount} sats
+  💰 معادل: ${fiatAmount} ${fiatCode}
+
+  ⚠️ این عملیات قابل برگشت نیست.
+
+  آیا می‌خواهید این عملیات را تأیید کنید؟
+release_confirm_button: تأیید
+release_cancel_button: لغو
+release_operation_cancelled: عملیات آزادسازی لغو شد.
 earnings: درآمد
 premium: حباب
 discount: تخفیف

locales/fr.yaml

@@ -509,7 +509,21 @@ not_wizard: Vous n'êtes pas en mode assistant pour le moment, si vous avez des
 wizard_help: Vous êtes en mode assistant, si vous souhaitez revenir en mode commande, exécutez /exit.
 hold_invoice_memo: "Montant du séquestre de l'offre #${orderId} : VENTE BTC pour ${fiatCode} ${fiatAmount} - CE SERA GELÉ DANS VOTRE PORTEFEUILLE. Il sera libéré une fois que vous aurez lancé la commande /release. Il vous sera remboursé si l'acheteur ne confirme pas le paiement."
 tap_button: Sélectionner une offre pour effectuer l'opération
-tap_release: Sélectionnez l'offre pour débloquer les fonds, une fois que vous avez appuyé sur le bouton, l'opération ne peut plus être annulée.
+tap_release: Sélectionnez l'offre pour débloquer les fonds, vous verrez une confirmation avant de procéder.
+release_confirmation_message: |
+  Vous êtes sur le point de libérer la commande suivante :
+
+  🆔 ID de commande : ${orderId}
+  👤 Contrepartie : @${counterparty}
+  ⚡ Montant : ${amount} sats
+  💰 Équivalent : ${fiatAmount} ${fiatCode}
+
+  ⚠️ Cette opération ne peut pas être annulée.
+
+  Voulez-vous confirmer cette opération ?
+release_confirm_button: Confirmer
+release_cancel_button: Annuler
+release_operation_cancelled: Opération de libération annulée.
 earnings: Revenus
 premium: Surcote
 discount: Décote