Skip to content

feat: add optional [community] param to /buy and /sell commands #879

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Matobi98 wants to merge 3 commits into from
Closed

feat: add optional [community] param to /buy and /sell commands #879

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8155735
feat: add optional [community] param to /buy and /sell commands
Matobi98 Jul 20, 2026
15406a9
fix: positional order params and secure community name lookup
Matobi98 Jul 21, 2026
c837168
test: cover /buy and /sell community routing on the command path
Matobi98 Jul 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 40 additions & 14 deletions bot/modules/orders/commands.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import * as ordersActions from '../../ordersActions';
import { deletedCommunityMessage } from './messages';
import {
getCommunityInfo,
getCommunityByIdentifier,
isCurrencySupported,
} from '../../../util/communityHelper';
import { takebuy, takesell, takebuyValidation } from './takeOrder';
Expand Down Expand Up @@ -50,18 +51,15 @@ const sell = async (ctx: MainContext) => {
const sellOrderParams = await validateSellOrder(ctx);

if (!sellOrderParams) return;
const { amount, fiatAmount, fiatCode, paymentMethod } = sellOrderParams;
const { amount, fiatAmount, fiatCode, paymentMethod, communityName } =
sellOrderParams;
let priceMargin = sellOrderParams.priceMargin;
priceMargin = isFloat(priceMargin)
? parseFloat(priceMargin.toFixed(2))
: parseInt(priceMargin);

// Optimized community lookup - single database query instead of multiple
const communityInfo = await getCommunityInfo(
user,
ctx.message?.chat.type || 'private',
ctx.message?.chat as Chat.UserNameChat,
);
const communityInfo = await resolveOrderCommunity(ctx, user, communityName);
if (!communityInfo) return;

const { community, communityId, isBanned } = communityInfo;

Expand Down Expand Up @@ -119,18 +117,15 @@ const buy = async (ctx: MainContext) => {
const buyOrderParams = await validateBuyOrder(ctx);
if (!buyOrderParams) return;

const { amount, fiatAmount, fiatCode, paymentMethod } = buyOrderParams;
const { amount, fiatAmount, fiatCode, paymentMethod, communityName } =
buyOrderParams;
let priceMargin = buyOrderParams.priceMargin;
priceMargin = isFloat(priceMargin)
? parseFloat(priceMargin.toFixed(2))
: parseInt(priceMargin);

// Optimized community lookup - single database query instead of multiple
const communityInfo = await getCommunityInfo(
user,
ctx.message?.chat.type || 'private',
ctx.message?.chat as Chat.UserNameChat,
);
const communityInfo = await resolveOrderCommunity(ctx, user, communityName);
if (!communityInfo) return;

const { community, communityId, isBanned } = communityInfo;

Expand Down Expand Up @@ -182,6 +177,37 @@ const buy = async (ctx: MainContext) => {
}
};

// Decides which community an order should be published to.
// When the user passes a community name in a private chat, the order is
// published to that community. Otherwise the default behaviour applies: the
// group's community when the command runs inside a group, or the user's
// default community in private. Returns null when the flow must stop because
// an error was already reported to the user.
async function resolveOrderCommunity(
ctx: MainContext,
user: UserDocument,
communityName?: string,
) {
const isPrivate = (ctx.message?.chat.type || 'private') === 'private';

// The community name is only honored in private chats; inside a group the
// group's own community always wins.
if (communityName && isPrivate) {
Comment thread
grunch marked this conversation as resolved.
Outdated
const communityInfo = await getCommunityByIdentifier(user, communityName);
if (!communityInfo.community) {
await ctx.reply(ctx.i18n.t('community_not_found'));
return null;
}
return communityInfo;

@ermeme ermeme Bot Jul 23, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔴 Blocking scope mismatch: this returns a single resolved destination, and each handler calls createOrder only once. However, #877 explicitly asks for the optional community to be published alongside the currently selected community; requiring the user to run the command again preserves the workflow the issue was meant to remove. Please either implement the two-destination behavior or explicitly realign the issue/PR contract instead of closing #877.

@Matobi98 Matobi98 Jul 23, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This PR intentionally publishes to a single destination. Double-publishing to two communities at once was considered too complex and out of scope. The [community] param lets the user choose the destination explicitly; publishing to a second community means running the command again. We're realigning the scope: this PR does not fully close #877, it delivers the optional-community parameter only.

}

return getCommunityInfo(
user,
ctx.message?.chat.type || 'private',
ctx.message?.chat as Chat.UserNameChat,
);
}

async function enterWizard(
ctx: CommunityContext,
user: UserDocument,
Expand Down
34 changes: 32 additions & 2 deletions bot/validations.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,28 @@ const processParameters = (args: string[]) => {
return correctedArgs;
};

// The two optional trailing params of /buy and /sell are the price margin and
// the community name. They are told apart by type, not position: the numeric
// one is the price margin, the non-numeric one is the community name. This
// works whether the user passes both, only one, or none of them.
const parseOptionalOrderParams = (optionalArgs: string[]) => {
// priceMargin is kept loosely typed because downstream callers feed it
// through isFloat/parseInt/isNaN, matching the previous untyped behaviour.
let priceMargin: any;
let communityName: string | undefined;

for (const arg of optionalArgs) {
if (arg === '') continue;
if (isNaN(Number(arg))) {
Comment thread
grunch marked this conversation as resolved.
Outdated
communityName = arg;
} else {
priceMargin = arg;
}
}

return { priceMargin, communityName };
};

const validateSellOrder = async (ctx: MainContext) => {
try {
let args = ctx.state.command.args;
Expand All @@ -170,7 +192,10 @@ const validateSellOrder = async (ctx: MainContext) => {
}
args = processParameters(args);

let [amount, fiatAmount, fiatCode, paymentMethod, priceMargin] = args;
let [amount, fiatAmount, fiatCode, paymentMethod] = args;
const { priceMargin, communityName } = parseOptionalOrderParams(
args.slice(4),
);

if (priceMargin && isNaN(priceMargin)) {
await ctx.reply(
Expand Down Expand Up @@ -244,6 +269,7 @@ const validateSellOrder = async (ctx: MainContext) => {
fiatCode: fiatCode.toUpperCase(),
paymentMethod,
priceMargin,
communityName,
};
} catch (error) {
logger.error(error);
Expand All @@ -260,7 +286,10 @@ const validateBuyOrder = async (ctx: MainContext) => {
}
args = processParameters(args);

let [amount, fiatAmount, fiatCode, paymentMethod, priceMargin] = args;
let [amount, fiatAmount, fiatCode, paymentMethod] = args;
const { priceMargin, communityName } = parseOptionalOrderParams(
args.slice(4),
);

if (priceMargin && isNaN(priceMargin)) {
await ctx.reply(
Expand Down Expand Up @@ -332,6 +361,7 @@ const validateBuyOrder = async (ctx: MainContext) => {
fiatCode: fiatCode.toUpperCase(),
paymentMethod,
priceMargin,
communityName,
};
} catch (error) {
logger.error(error);
Expand Down
12 changes: 8 additions & 4 deletions locales/de.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,9 @@ must_be_numeric: ${fieldName} muss numerisch sein
sats_amount: sats Wert
fiat_amount: fiat Wert
sell_correct_format: |
/sell \<_Anzahl sats_\> \<_fiat Wert_\> \<_fiat code_\> \<_Zahlungsmethode_\> \[_Zuschlag/Rabatt_\]
/sell \<_Anzahl sats_\> \<_fiat Wert_\> \<_fiat code_\> \<_Zahlungsmethode_\> \[_Zuschlag/Rabatt_\] \[_Community_\]

Du kannst den Namen einer deiner Communities als letzten Parameter hinzufügen, um die Order dort statt in deiner Standard\-Community zu veröffentlichen\.

Um einen Verkaufsauftrag von 1000 Sats für 2 Euro \(EUR\) zu erstellen und anzugeben, dass die Zahlung in FIAT durch Überweisung oder Einzahlung am Geldautomaten erfolgt, musst du \<\> und \[\] weglassen\.

Expand All @@ -85,7 +87,9 @@ sell_correct_format: |

`/sell 0 100\-500 EUR "Zahlungsmethode" 3`
buy_correct_format: |
/buy \<_Anzahl sats_\> \<_fiat Wert_\> \<_fiat code_\> \<_Zahlungsmethode_\> \[_Zuschlag/Rabatt_\]
/buy \<_Anzahl sats_\> \<_fiat Wert_\> \<_fiat code_\> \<_Zahlungsmethode_\> \[_Zuschlag/Rabatt_\] \[_Community_\]

Du kannst den Namen einer deiner Communities als letzten Parameter hinzufügen, um die Order dort statt in deiner Standard\-Community zu veröffentlichen\.

Um einen Auftrag über 1000 Sats für 2 \(EUR\) zu erstellen und anzugeben, dass die Zahlung per Überweisung erfolgt, musst du sowohl \<\> als auch \[\] weglassen\.

Expand Down Expand Up @@ -241,8 +245,8 @@ must_be_number_or_range: 'Fiat_amount muss eine Zahl oder ein numerischer Bereic
invalid_lightning_address: Ungültige Lightning-Adresse
unavailable_lightning_address: Nicht verfügbare Lightning-Adresse ${la}
help: |
/sell <_Anzahl sats_> <_fiat Wert_> <_fiat code_> <_Zahlungsmethode_> \[_Zuschlag/Rabatt_] - Erstellt einen Bitcoin Verkaufsauftrag
/buy <_Anzahl sats_> <_fiat Wert_> <_fiat code_> <_Zahlungsmethode_> \[_Zuschlag/Rabatt_] - Erstellt eine Bitcoin Kaufauftrag
/sell <_Anzahl sats_> <_fiat Wert_> <_fiat code_> <_Zahlungsmethode_> \[_Zuschlag/Rabatt_] \[_Community_] - Erstellt einen Bitcoin Verkaufsauftrag
/buy <_Anzahl sats_> <_fiat Wert_> <_fiat code_> <_Zahlungsmethode_> \[_Zuschlag/Rabatt_] \[_Community_] - Erstellt eine Bitcoin Kaufauftrag
/takeorder <_order id_> - Ermöglicht Ihnen, eine Bestellung aus dem Chat mit dem Bot anzunehmen, ohne zu dem Kanal zu gehen, in dem sie veröffentlicht wurde
/info - Zeigt zusätzliche Informationen über das Bot an
/showusername - Schaltet die Anzeige des Benutzernamens in jedem neu erstellten Auftrag aus. Der Standardwert ist *nein* (false)
Expand Down
12 changes: 8 additions & 4 deletions locales/en.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,9 @@ must_be_numeric: ${fieldName} must be numeric
sats_amount: sats amount
fiat_amount: fiat amount
sell_correct_format: |
/sell \<_sats amount_\> \<_fiat amount_\> \<_fiat code_\> \<_payment method_\> \[_premium/discount_\]
/sell \<_sats amount_\> \<_fiat amount_\> \<_fiat code_\> \<_payment method_\> \[_premium/discount_\] \[_community_\]

You can add the name of one of your communities as the last parameter to publish the order there instead of your default community\.

In order to create a sell order of 1000 satoshis for 2 US dollars \(USD\) and indicate that the fiat payment is through transfer or ATM deposit, you must avoid \<\> and \[\]\.

Expand All @@ -87,7 +89,9 @@ sell_correct_format: |

`/sell 0 100\-500 USD "payment method" 3`
buy_correct_format: |
/buy \<_sats amount_\> \<_fiat amount_\> \<_fiat code_\> \<_payment method_\> \[_premium/discount_\]
/buy \<_sats amount_\> \<_fiat amount_\> \<_fiat code_\> \<_payment method_\> \[_premium/discount_\] \[_community_\]

You can add the name of one of your communities as the last parameter to publish the order there instead of your default community\.

In order to create an order for 1000 satoshis for 2 \(USD\) and indicate that fiat payment is through transfer, you must to omit both \<\> and \[\]\.

Expand Down Expand Up @@ -245,8 +249,8 @@ invalid_lightning_address: Invalid lightning address
unavailable_lightning_address: Unavailable lightning address ${la}
ln_address_temporarily_disabled: ⚠️ Lightning Address payouts are temporarily disabled for maintenance. Please send a regular Lightning invoice (BOLT11) for the exact order amount to receive your sats.
help: |
/sell <_sats amount_> <_fiat amount_> <_fiat code_> <_payment method_> [premium/discount] - Creates a Sell order
/buy <_sats amount_> <_fiat amount_> <_Fiat code_> <_payment method_> [premium/discount] - Creates a Purchase Order
/sell <_sats amount_> <_fiat amount_> <_fiat code_> <_payment method_> [premium/discount] [community] - Creates a Sell order
/buy <_sats amount_> <_fiat amount_> <_Fiat code_> <_payment method_> [premium/discount] [community] - Creates a Purchase Order
/takeorder <_order id_> - Allows the user to take an order from the chat with the bot without going to the channel where it was published
/info - Shows additional info about the bot
/showusername - Toggles off the username display in each new order created. Default value is set to false
Expand Down
12 changes: 8 additions & 4 deletions locales/es.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,9 @@ must_be_numeric: ${fieldName} debe ser numérico
sats_amount: monto en sats
fiat_amount: monto en fiat
sell_correct_format: |
/sell \<_monto en sats_\> \<_monto en fiat_\> \<_código fiat_\> \<_método de pago_\> \[_prima/descuento_\]
/sell \<_monto en sats_\> \<_monto en fiat_\> \<_código fiat_\> \<_método de pago_\> \[_prima/descuento_\] \[_comunidad_\]

Puedes agregar el nombre de una de tus comunidades como último parámetro para publicar la orden ahí en lugar de en tu comunidad por defecto\.

Para crear una venta de 1000 satoshis por 2 bolívares \(VES\) e indicar que el método de pago fiat es pago móvil, debes omitir los \<\> y los \[\]\.

Expand All @@ -85,7 +87,9 @@ sell_correct_format: |

`/sell 0 100\-500 ves "pago móvil" 3`
buy_correct_format: |
/buy \<_monto en sats_\> \<_monto en fiat_\> \<_código fiat_\> \<_método de pago_\> \[_prima/descuento_\]
/buy \<_monto en sats_\> \<_monto en fiat_\> \<_código fiat_\> \<_método de pago_\> \[_prima/descuento_\] \[_comunidad_\]

Puedes agregar el nombre de una de tus comunidades como último parámetro para publicar la orden ahí en lugar de en tu comunidad por defecto\.

Para crear una compra de 1000 satoshis por 2 bolívares \(VES\) e indicar que el método de pago fiat es pago móvil, debes omitir los \<\> y los \[\]\.

Expand Down Expand Up @@ -242,8 +246,8 @@ invalid_lightning_address: Dirección lightning no válida
unavailable_lightning_address: Dirección lightning ${la} no disponible
ln_address_temporarily_disabled: ⚠️ Los pagos a Lightning Address están temporalmente deshabilitados por mantenimiento. Por favor envía una factura Lightning normal (BOLT11) por el monto exacto de la orden para recibir tus sats.
help: |
/sell <_monto en sats_> <_monto en fiat_> <_código fiat_> <_método de pago_> [prima/descuento] - Crea una orden de venta
/buy <_monto en sats_> <_monto en fiat_> <_código fiat_> <_método de pago_> [prima/descuento] - Crea una orden de compra
/sell <_monto en sats_> <_monto en fiat_> <_código fiat_> <_método de pago_> [prima/descuento] [comunidad] - Crea una orden de venta
/buy <_monto en sats_> <_monto en fiat_> <_código fiat_> <_método de pago_> [prima/descuento] [comunidad] - Crea una orden de compra
/takeorder <_order id_> - Permite tomar una orden desde el chat con el bot sin ir al canal donde fue publicada
/info - Muestra información sobre el bot
/showusername - Permite mostrar u ocultar el username en cada nueva orden creada, el valor predeterminado es no (falso)
Expand Down
12 changes: 8 additions & 4 deletions locales/fa.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,9 @@ must_be_numeric: '${fieldName} باید عدد باشد.'
sats_amount: تعداد ساتوشی
fiat_amount: مقدار فیات
sell_correct_format: |
/sell \<_sats amount_\> \<_fiat amount_\> \<_fiat code_\> \<_payment method_\> \[_premium/discount_\]
/sell \<_sats amount_\> \<_fiat amount_\> \<_fiat code_\> \<_payment method_\> \[_premium/discount_\] \[_community_\]

می‌توانید نام یکی از اجتماع‌های خود را به عنوان آخرین پارامتر اضافه کنید تا سفارش به جای اجتماع پیش‌فرض شما در آنجا منتشر شود\.

جهت ایجاد سفارش فروش 1000 ساتوشی در ازای 300 هزار تومان \(IRT\) و اعلام «کارت به کارت» به عنوان روش پرداخت، باید از به کار بردن \<\> و \[\]\ اجتناب کنید\.

Expand All @@ -88,7 +90,9 @@ sell_correct_format: |

`/sell 0 300000\-500000 IRT "payment method" 3`
buy_correct_format: |
/buy \<_sats amount_\> \<_fiat amount_\> \<_fiat code_\> \<_payment method_\> \[_premium/discount_\]
/buy \<_sats amount_\> \<_fiat amount_\> \<_fiat code_\> \<_payment method_\> \[_premium/discount_\] \[_community_\]

می‌توانید نام یکی از اجتماع‌های خود را به عنوان آخرین پارامتر اضافه کنید تا سفارش به جای اجتماع پیش‌فرض شما در آنجا منتشر شود\.

جهت ایجاد سفارش خرید 1000 ساتوشی در ازای 300 هزار تومان \(IRT\) و اعلام «کارت به کارت» به عنوان روش پرداخت، باید از به کار بردن \<\> و \[\]\ اجتناب کنید\.

Expand Down Expand Up @@ -254,10 +258,10 @@ must_be_number_or_range: |
invalid_lightning_address: نشانی لایتنینگ نامعتبر است.
unavailable_lightning_address: 'نشانی لایتنینگ ${la} در دسترس نیست.'
help: |
/sell <_sats amount_> <_fiat amount_> <_fiat code_> <_payment method_> [premium/discount]
/sell <_sats amount_> <_fiat amount_> <_fiat code_> <_payment method_> [premium/discount] [community]
سفارش فروش ایجاد می‌کند.

/buy <_sats amount_> <_fiat amount_> <_Fiat code_> <_payment method_> [premium/discount]
/buy <_sats amount_> <_fiat amount_> <_Fiat code_> <_payment method_> [premium/discount] [community]
سفارش خرید ایجاد می‌کند.

/takeorder <_order id_>
Expand Down
12 changes: 8 additions & 4 deletions locales/fr.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,9 @@ must_be_numeric: ${fieldName} doit être numérique
sats_amount: montant en sats
fiat_amount: montant en fiat
sell_correct_format: |
/sell \<_montant en sats_\> \<_montant en fiat_\> \<_code monnaie fiat_\> \<_méthode de paiement_\> \[_plus-value/remise_\]
/sell \<_montant en sats_\> \<_montant en fiat_\> \<_code monnaie fiat_\> \<_méthode de paiement_\> \[_plus-value/remise_\] \[_communauté_\]

Vous pouvez ajouter le nom d'une de vos communautés comme dernier paramètre pour y publier l'ordre au lieu de votre communauté par défaut\.

Pour créer une offre de vente de 1000 satoshis pour 6000 Francs CFA \(XOF\) et indiquer que le paiement fiat doit se faire via Wave ou Mobile Money, il faut omettre les caractères \<\> and \[\]\.

Expand All @@ -87,7 +89,9 @@ sell_correct_format: |

`/sell 0 50000\-100000 XOF "Wave ou Mobile Money" 3`
buy_correct_format: |
/buy \<_montant en sats_\> \<_montant en fiat_\> \<_code monnaie fiat_\> \<_méthode de paiement_\> \[_plus-value/remise_\]
/buy \<_montant en sats_\> \<_montant en fiat_\> \<_code monnaie fiat_\> \<_méthode de paiement_\> \[_plus-value/remise_\] \[_communauté_\]

Vous pouvez ajouter le nom d'une de vos communautés comme dernier paramètre pour y publier l'ordre au lieu de votre communauté par défaut\.

Pour créer une offre d'achat de 1000 satoshis pour 6000 Francs CFA \(XOF\) et indiquer que le paiement fiat doit se faire via transfert en ligne, il faut omettre les caractères \<\> and \[\]\.

Expand Down Expand Up @@ -243,8 +247,8 @@ must_be_number_or_range: 'Le montant fiat doit être un nombre entier ou une pla
invalid_lightning_address: Adresse Lightning invalide !
unavailable_lightning_address: Adresse Lightning non disponible ${la}
help: |
/sell <_montant en sats_> <_montant en fiat_> <_code fiat_> <_méthode de paiement_> [plus-value/remise] - Pour créer une offre de vente
/buy <_montant en sats_> <_montant en fiat_> <_code fiat_> <_méthode de paiement_> [plus-value/remise] - Pour créer une offre d'achat
/sell <_montant en sats_> <_montant en fiat_> <_code fiat_> <_méthode de paiement_> [plus-value/remise] [communauté] - Pour créer une offre de vente
/buy <_montant en sats_> <_montant en fiat_> <_code fiat_> <_méthode de paiement_> [plus-value/remise] [communauté] - Pour créer une offre d'achat
/takeorder <_order id_> - Vous permet de prendre une commande depuis le chat avec le bot sans accéder au canal où elle a été publiée
/info - Affiche des informations additionnelles à propos du bot
/showusername - Désactive l'affichage du nom d'utilisateur dans chaque offre nouvellement créée. La valeur par défaut est définie sur false
Expand Down
Loading
Loading