/help Command

The /help command provides users with comprehensive information about all available commands and features in the CopperX Payout Bot.

Command Overview

Purpose: Display help information and guide users

Authentication Required: No

KYC Required: No

Implementation File: src/bot/handlers/help.handler.ts

Functionality

When a user sends the /help command, the bot:

Displays a comprehensive guide to all available commands

Provides detailed information about each command's purpose

Explains authentication and KYC requirements

Offers additional resources via inline buttons

Response Example

📚 CopperX Payout Bot - Help Guide

Welcome to the CopperX Payout Bot! Here's a complete guide to all available commands:

🚀 Basic Commands

/start - Start the bot and see the welcome screen
  • New users will be prompted to log in
  • Existing users will see their verification status

/help - Show this help message with all commands and instructions

🔐 Authentication

/login - Log in to your CopperX account
  • Step 1: Enter your email address
  • Step 2: Enter the OTP sent to your email
  • Note: KYC verification is required for most features

/logout - Log out from your current session

💰 Wallet Management

/wallet - Manage your cryptocurrency wallet
  • View all your wallets across different networks
  • Check wallet balances
  • Set a default wallet for transactions
  • Generate deposit addresses
  • Create new wallets on supported networks

💸 Transfer & Payments

/transfer - Access all transfer-related features
  • View your transaction history
  • Send funds to others
  • Withdraw to external wallets
  • Set up batch transfers
  • Convert crypto to fiat (offramp)

/send - Quick command to send funds (shortcut)
  • Can send via email or wallet address
  • Supports multiple currencies
  • Requires purpose code for compliance

🔍 Additional Information

• Rate Limiting: For system stability, you're limited to 10 requests per minute
• KYC Verification: Most financial operations require KYC verification
• Security: Never share your OTP with anyone, including support

Need more help? Use the buttons below to visit our website, contact support, or review our terms of service.

Followed by buttons:

🌐 Visit Website

🤝 Support

📝 Terms & Conditions

Implementation Details

The help command is implemented as follows:

Message Template

The help message is defined in src/bot/messages/help.messages.ts:

Command and Callback Integration

The help command is registered in:

commandOperations in src/bot/operations/command.operations.ts:

callbackOperations in src/bot/operations/callback.operations.ts:

Best Practices for Help Content

The help system follows these best practices:

Organization: Content is organized by categories (Basic Commands, Authentication, etc.)

Formatting: Uses Telegram HTML formatting with bold text and bullet points

Completeness: Covers all commands and major features

Conciseness: Provides enough detail to be useful without being overwhelming

Resources: Includes links to additional resources

Accessibility: Available to all users (not requiring authentication)

Maintenance: Kept up-to-date with all commands

src/bot/messages/help.messages.ts - Contains the help message template

src/constants/bot-commands.ts - Defines all available commands

src/bot/operations/command.operations.ts - Maps commands to handlers

src/bot/operations/callback.operations.ts - Maps callbacks to handlers

Extension Points

The help system can be extended in these ways:

Localization: Adding language support for help messages

Command-specific Help: Adding support for /help command to get detailed help for a specific command

Interactive Help: Adding interactive tutorials for complex features

Contextual Help: Providing help based on the user's current state

help

/help Command#

Command Overview#

Functionality#

Response Example#

Implementation Details#

Message Template#

Command and Callback Integration#

Best Practices for Help Content#

Related Files#

Extension Points#