feat: add counterparty requirements configuration in /settings

Author: Matobi98

.env-sample

@@ -73,6 +73,10 @@ PAYMENT_ATTEMPTS=2
 # Here will go the disputes from non community orders
 DISPUTE_CHANNEL='@p2plnbotDispute'
 
+# Maximum values for counterparty requirements that users can set
+MAX_COUNTERPARTY_AGE_REQUIREMENT=30
+MAX_COUNTERPARTY_ORDERS_REQUIREMENT=10
+
 # time-to-live for communities in days, communities without successful orders on this time are deleted
 COMMUNITY_TTL=31
 

bot/messages.ts

@@ -975,6 +975,20 @@ const userTakerIsBlockedByUserOrder = async (
   }
 };
 
+const notMeetingRequirementsMessage = async (
+  ctx: MainContext,
+  user: UserDocument,
+) => {
+  try {
+    await ctx.telegram.sendMessage(
+      user.tg_id,
+      ctx.i18n.t('not_meeting_requirements'),
+    );
+  } catch (error) {
+    logger.error(error);
+  }
+};
+
 const fiatSentMessages = async (
   ctx: MainContext,
   buyer: UserDocument,
@@ -2224,4 +2238,5 @@ export {
   userTakerIsBlockedByUserOrder,
   userOrderIsBlockedByUserTaker,
   showQRCodeMessage,
+  notMeetingRequirementsMessage,
 };

bot/modules/orders/takeOrder.ts

@@ -1,7 +1,11 @@
 import { logger } from '../../../logger';
 import { Block, Order, User } from '../../../models';
 import { UserDocument } from '../../../models/user';
-import { deleteOrderFromChannel, generateRandomImage } from '../../../util';
+import {
+  deleteOrderFromChannel,
+  generateRandomImage,
+  getUserAge,
+} from '../../../util';
 import * as messages from '../../messages';
 import { HasTelegram, MainContext } from '../../start';
 import {
@@ -73,6 +77,8 @@ export const takebuy = async (
     if (await isBannedFromCommunity(user, order.community_id))
       return await messages.bannedUserErrorMessage(ctx, user);
 
+    if (!(await meetsCounterpartyRequirements(ctx, user, userOffer))) return;
+
     if (!(await validateTakeBuyOrder(ctx, bot, user, order))) return;
 
     const { randomImage } = generateRandomImage(user._id.toString());
@@ -127,6 +133,9 @@ export const takesell = async (
     // We verify if the user is not banned on this community
     if (await isBannedFromCommunity(user, order.community_id))
       return await messages.bannedUserErrorMessage(ctx, user);
+
+    if (!(await meetsCounterpartyRequirements(ctx, user, seller))) return;
+
     if (!(await validateTakeSellOrder(ctx, bot, user, order))) return;
     order.status = 'WAITING_BUYER_INVOICE';
     order.buyer_id = user._id;
@@ -143,6 +152,34 @@ export const takesell = async (
   }
 };
 
+const meetsCounterpartyRequirements = async (
+  ctx: MainContext,
+  user: UserDocument,
+  orderCreator: UserDocument,
+) => {
+  if (!orderCreator.counterparty_requirements) return true;
+
+  const { min_days_using_bot, min_completed_orders } =
+    orderCreator.counterparty_requirements;
+
+  if (min_days_using_bot > 0) {
+    const ageInDays = getUserAge(user);
+    if (ageInDays < min_days_using_bot) {
+      await messages.notMeetingRequirementsMessage(ctx, user);
+      return false;
+    }
+  }
+
+  if (min_completed_orders > 0) {
+    if (user.trades_completed < min_completed_orders) {
+      await messages.notMeetingRequirementsMessage(ctx, user);
+      return false;
+    }
+  }
+
+  return true;
+};
+
 const checkBlockingStatus = async (
   ctx: MainContext,
   user: UserDocument,

bot/modules/user/scenes/settings.ts

@@ -7,6 +7,7 @@ import {
   CommunityWizardState,
 } from '../../community/communityContext';
 import { Message } from 'telegraf/typings/core/types/typegram';
+import { logger } from '../../../../logger';
 
 function make() {
   const resetMessage = async (ctx: CommunityContext, next: () => void) => {
@@ -24,6 +25,10 @@ function make() {
       npub: '',
       community: '',
       lightning_address: '',
+      min_days_using_bot:
+        user.counterparty_requirements?.min_days_using_bot ?? 0,
+      min_completed_orders:
+        user.counterparty_requirements?.min_completed_orders ?? 0,
     };
     if (user.default_community_id) {
       const community = await Community.findById(user.default_community_id);
@@ -129,6 +134,123 @@ function make() {
     }
   });
 
+  scene.command(
+    'counterpartyage',
+    resetMessage,
+    async (ctx: CommunityContext) => {
+      try {
+        await ctx.deleteMessage();
+        const state = ctx.scene.state as CommunityWizardState;
+        if (ctx.message === undefined || !('text' in ctx.message))
+          throw new Error('ctx.message is undefined');
+        const [, days] = ctx.message.text.trim().split(' ');
+        const min_days = parseInt(days);
+        if (isNaN(min_days) || min_days < 0) throw new Error('NotValidNumber');
+        const maxAge = parseInt(
+          process.env.MAX_COUNTERPARTY_AGE_REQUIREMENT || '30',
+        );
+        if (min_days > maxAge) {
+          state.error = {
+            i18n: 'invalid_range',
+            command: '/counterpartyage',
+            max: maxAge,
+          };
+          return await updateMessage(ctx);
+        }
+        const user = state.user;
+        if (!user.counterparty_requirements) {
+          user.counterparty_requirements = {
+            min_days_using_bot: 0,
+            min_completed_orders: 0,
+          };
+        }
+        user.counterparty_requirements.min_days_using_bot = min_days;
+        await user.save();
+        state.feedback = { i18n: 'counterpartyage_updated', days: min_days };
+        await updateMessage(ctx);
+      } catch (err) {
+        logger.error(err);
+        (ctx.scene.state as CommunityWizardState).error = {
+          i18n: 'invalid_number',
+        };
+        await updateMessage(ctx);
+      }
+    },
+  );
+
+  scene.command(
+    'counterpartyorders',
+    resetMessage,
+    async (ctx: CommunityContext) => {
+      try {
+        await ctx.deleteMessage();
+        const state = ctx.scene.state as CommunityWizardState;
+        if (ctx.message === undefined || !('text' in ctx.message))
+          throw new Error('ctx.message is undefined');
+        const [, orders] = ctx.message.text.trim().split(' ');
+        const min_orders = parseInt(orders);
+        if (isNaN(min_orders) || min_orders < 0)
+          throw new Error('NotValidNumber');
+        const maxOrders = parseInt(
+          process.env.MAX_COUNTERPARTY_ORDERS_REQUIREMENT || '10',
+        );
+        if (min_orders > maxOrders) {
+          state.error = {
+            i18n: 'invalid_range',
+            command: '/counterpartyorders',
+            max: maxOrders,
+          };
+          return await updateMessage(ctx);
+        }
+        const user = state.user;
+        if (!user.counterparty_requirements) {
+          user.counterparty_requirements = {
+            min_days_using_bot: 0,
+            min_completed_orders: 0,
+          };
+        }
+        user.counterparty_requirements.min_completed_orders = min_orders;
+        await user.save();
+        state.feedback = {
+          i18n: 'counterpartyorders_updated',
+          orders: min_orders,
+        };
+        await updateMessage(ctx);
+      } catch (err) {
+        logger.error(err);
+        (ctx.scene.state as CommunityWizardState).error = {
+          i18n: 'invalid_number',
+        };
+        await updateMessage(ctx);
+      }
+    },
+  );
+
+  scene.command(
+    'resetrequirements',
+    resetMessage,
+    async (ctx: CommunityContext) => {
+      try {
+        await ctx.deleteMessage();
+        const state = ctx.scene.state as CommunityWizardState;
+        const user = state.user;
+        user.counterparty_requirements = {
+          min_days_using_bot: 0,
+          min_completed_orders: 0,
+        };
+        await user.save();
+        state.feedback = { i18n: 'requirements_reset' };
+        await updateMessage(ctx);
+      } catch (err) {
+        logger.error(err);
+        (ctx.scene.state as CommunityWizardState).error = {
+          i18n: 'generic_error',
+        };
+        await updateMessage(ctx);
+      }
+    },
+  );
+
   return scene;
 }
 

locales/de.yaml

@@ -251,6 +251,10 @@ help: |
   /setaddress <_lightning Adresse / off_> - Ermöglicht es dem Käufer, eine statische Zahlungsadresse (Lightning-Adresse) einzurichten, _off_ zum Deaktivieren 
   /setlang - Ermöglicht dem Benutzer, die Sprache zu ändern
   /settings - Zeigt die aktuellen Einstellungen des Benutzers an
+  Innerhalb von /settings kannst du Gegenpartei-Anforderungen konfigurieren:
+    /counterpartyage &lt;Tage&gt; - Legt das Mindestalter (in Tagen) für die Gegenpartei fest
+    /counterpartyorders &lt;Aufträge&gt; - Legt die Mindestanzahl abgeschlossener Aufträge für die Gegenpartei fest
+    /resetrequirements - Setzt die Anforderungen auf Standardwerte zurück
   /listorders - Benutze diesen Befehl, um alle deine ausstehenden Transaktionen aufzulisten
   /listcurrencies - Listet alle FIAT Währungen auf, die wir verwenden können 
   /fiatsent <_order id_> - Der Käufer teilt mit, dass er dem Verkäufer das FIAT-Geld geschickt hat
@@ -629,20 +633,33 @@ order_not_found: Bestellung nicht gefunden.
 
 # START modules/user
 user_settings: |
-  <strong>User settings for @${user.username}</strong>
+  <strong>Benutzereinstellungen für @${user.username}</strong>
 
-  Language:
+  Sprache:
     ${language.emoji} ${language.name}
-  Community:
+  Gemeinschaft:
     ${community || '🛇'}
   npub:
     <code>${npub || '🛇'}</code>
-  lightning address:
+  Lightning-Adresse:
     <code>${lightning_address || '🛇'}</code>
 
-  <strong># HELP</strong>
-  /setnpub &lt;npub&gt; - Configure user's Nostr public key.
-  /exit - to exit the wizard.
+  <strong>Gegenpartei-Anforderungen</strong>
+  Mindestalter: ${min_days_using_bot} Tage
+  Mindestanzahl abgeschlossener Aufträge: ${min_completed_orders}
+
+  <strong># HILFE</strong>
+  /setnpub &lt;npub&gt; - Nostr-Schlüssel des Benutzers konfigurieren.
+  /counterpartyage &lt;Tage&gt; - Legt das Mindestalter (in Tagen) für die Gegenpartei fest.
+  /counterpartyorders &lt;Aufträge&gt; - Legt die Mindestanzahl abgeschlossener Aufträge fest.
+  /resetrequirements - Setzt die Gegenpartei-Anforderungen auf Standardwerte zurück.
+  /exit - um den Assistenten zu verlassen.
+not_meeting_requirements: Du erfüllst nicht die Anforderungen der Gegenpartei, um diesen Auftrag anzunehmen.
+counterpartyage_updated: Altersanforderung der Gegenpartei auf ${days} Tage aktualisiert.
+counterpartyorders_updated: Auftragsanforderung der Gegenpartei auf ${orders} aktualisiert.
+requirements_reset: Gegenpartei-Anforderungen wurden auf Standardwerte zurückgesetzt.
+invalid_number: Ungültige Zahl.
+invalid_range: Ungültiger Wert für ${command}, bitte wähle eine Zahl im Bereich [0 - ${max}].
 # END modules/user
 # check hold invoice
 invoice_settled: Rechnung wurde bereits niedergelassen

locales/en.yaml

@@ -254,7 +254,11 @@ help: |
   /setaddress <_lightning address / off_> - Allows the buyer to establish a static payment address (lightning address), _off_ to deactivate 
   /setlang - Allows the user to change the language
   /settings - Displays the user's current settings
-  /listorders - Use this command to list all your pending transactions 
+  While in /settings you can configure counterparty requirements:
+    /counterpartyage &lt;days&gt; - Sets the minimum account age (in days) required for the counterparty to take your orders
+    /counterpartyorders &lt;orders&gt; - Sets the minimum number of completed orders required for the counterparty
+    /resetrequirements - Resets counterparty requirements to default
+  /listorders - Use this command to list all your pending transactions
   /listcurrencies - Lists all the currencies we can use to without indicatin the amount in sats. 
   /fiatsent <_order id_> - Buyer informs that he has already sent FIAT money to seller
   /release <_order id_> - Seller releases satoshis 
@@ -646,9 +650,22 @@ user_settings: |
   lightning address:
     <code>${lightning_address || '🛇'}</code>
 
+  <strong>Counterparty requirements</strong>
+  Min. account age: ${min_days_using_bot} days
+  Min. completed orders: ${min_completed_orders}
+
   <strong># HELP</strong>
   /setnpub &lt;npub&gt; - Configure user's Nostr public key.
+  /counterpartyage &lt;days&gt; - Sets the minimum account age (in days) for the counterparty.
+  /counterpartyorders &lt;orders&gt; - Sets the minimum number of completed orders for the counterparty.
+  /resetrequirements - Resets counterparty requirements to default.
   /exit - to exit the wizard.
+not_meeting_requirements: You do not meet the counterparty requirements to take this order.
+counterpartyage_updated: Counterparty age requirement updated to ${days} days.
+counterpartyorders_updated: Counterparty completed orders requirement updated to ${orders}.
+requirements_reset: Counterparty requirements have been reset to default.
+invalid_number: Invalid number.
+invalid_range: Invalid value for ${command}, please choose a number in the range [0 - ${max}].
 # END modules/user
 # check hold invoice
 invoice_settled: Invoice already settled

locales/es.yaml

@@ -251,6 +251,10 @@ help: |
   /setaddress <_lightning address / off_> - Permite al comprador indicar una dirección de pago estática (lightning address), _off_ para desactivarla
   /setlang - Le permite al usuario cambiar el idioma
   /settings - Muestra la configuración actual del usuario
+  Dentro de /settings podés configurar los requisitos de contraparte:
+    /counterpartyage &lt;días&gt; - Establece la antigüedad mínima (en días) requerida para la contraparte
+    /counterpartyorders &lt;órdenes&gt; - Establece el mínimo de órdenes completadas requeridas para la contraparte
+    /resetrequirements - Restablece los requisitos al valor por defecto
   /listorders - El usuario puede listar sus órdenes no finalizadas
   /listcurrencies - Lista las monedas que podemos utilizar sin indicar el monto en satoshis
   /fiatsent <_id orden_> - El comprador indica que ya ha enviado el dinero Fiat al vendedor
@@ -642,9 +646,22 @@ user_settings: |
   lightning address:
     <code>${lightning_address || '🛇'}</code>
 
+  <strong>Requisitos de contraparte</strong>
+  Antigüedad mínima: ${min_days_using_bot} días
+  Órdenes mínimas completadas: ${min_completed_orders}
+
   <strong># AYUDA</strong>
   /setnpub &lt;npub&gt; - Configura la llave pública de Nostr.
+  /counterpartyage &lt;días&gt; - Establece la antigüedad mínima (en días) para la contraparte.
+  /counterpartyorders &lt;órdenes&gt; - Establece el mínimo de órdenes completadas para la contraparte.
+  /resetrequirements - Restablece los requisitos de contraparte al valor por defecto.
   /exit - para salir del asistente.
+not_meeting_requirements: No cumplís los requisitos de la contraparte para tomar esta orden.
+counterpartyage_updated: Requisito de antigüedad de contraparte actualizado a ${days} días.
+counterpartyorders_updated: Requisito de órdenes completadas de contraparte actualizado a ${orders}.
+requirements_reset: Los requisitos de contraparte han sido restablecidos al valor por defecto.
+invalid_number: Número inválido.
+invalid_range: Valor inválido para ${command}, por favor elegí un número en el rango [0 - ${max}].
 # END modules/user
 # check hold invoice
 invoice_settled: Factura ya cobrada