BotForge Documentation

#Getting Started[link]

Welcome to BotForge! This guide will help you create your first Telegram price bot for X1 blockchain tokens. Follow these steps to get started.

#Create Your First Bot[link]

Creating a bot with BotForge is straightforward. Here is the process:

1. Connect your wallet - Use a Solana-compatible wallet (Phantom, Solflare, or Backpack) with X1 blockchain support.
2. Enter token address - Provide the mint address of the X1 token you want to track.
3. Create bot with BotFather - Use Telegram is @BotFather to create a new bot and get your token.
4. Configure price cards - Choose a template and customize how alerts will appear.
5. Set up alerts - Define thresholds for buy/sell notifications.
6. Pay and deploy - Subscribe ($50/month) to activate your bot.

#Wallet Setup Requirements[link]

BotForge requires a Solana-compatible wallet configured for the X1 blockchain:

1. Open Phantom wallet
2. Settings > Developer Settings > Change Network
3. Add custom RPC: https://rpc.mainnet.x1.xyz
4. Save and switch to X1 Mainnet

#USDC.X Acquisition[link]

USDC.X is the stablecoin used for BotForge payments. Here is how to get it:

#Bot Configuration[link]

Configure your bot to track tokens and send customized alerts.

#Token Address Setup[link]

Every bot tracks a single X1 blockchain token. Enter the mint address (44 characters):

5sN7WB75KLQHKNVkxX6wycRhc75C1NDACiKREiWepZ9n

BotForge will automatically fetch token metadata including:

• Token name and symbol
• Decimals
• Supply information
• Token image (from IPFS metadata)

#BotFather Integration[link]

Create your Telegram bot using @BotFather:

1. Open Telegram and search for @BotFather
2. Send /newbot
3. Enter a name for your bot (e.g., "PEPE Price Bot")
4. Enter a username (must end in "bot", e.g., "pepe_price_bot")
5. Copy the API token provided

#Price Card Templates[link]

Customize how price alerts appear in Telegram chats:

BUY $PEPE
Amount: 1,000,000 PEPE
Value: $150.00
MCap: $1.2M

BUY $PEPE
Amount: 1,000,000 PEPE
Spent: 100 XNT ($150)
MCap: $1.2M | FDV: $12M
Wallet: 7xKX...gAsU
[Explorer Link]

Configuration Options

#Alert Settings[link]

Fine-tune which transactions trigger alerts:

#Bot Commands[link]

Your bot responds to these commands in Telegram chats:

#/start[link]

#/price[link]

#/ca[link]

#/info[link]

#/stats[link]

#/mute and /unmute[link]

#/settings[link]

#/help[link]

#API Reference[link]

BotForge provides REST APIs for advanced integrations. Full documentation available at API.md

#Orchestrator API[link]

Base URL: http://localhost:3001 (dev) or http://orchestrator:3001 (Docker)

{
  "status": "ok",
  "service": "orchestrator"
}

{
  "tokenAddress": "5sN7WB...",
  "tokenSymbol": "PEPE",
  "cardTemplate": { ... },
  "alertSettings": { ... }
}

{
  "success": true,
  "status": "deployed",
  "containerId": "abc123..."
}

{
  "success": true,
  "status": "stopped"
}

#Price Engine API[link]

Base URL: http://localhost:3002 (dev) or http://price-engine:3002 (Docker)

{
  "address": "5sN7WB...",
  "name": "BLACK JACK",
  "symbol": "JACK",
  "decimals": 9,
  "supply": "1000000000000000000",
  "imageUrl": "https://...",
  "isToken2022": true
}

{
  "priceUsd": 0.00001234,
  "marketCap": 12340,
  "fdv": 12340000,
  "volume24h": 5678.90,
  "change24h": 15.5
}

{
  "success": true,
  "message": "Subscribed to 5sN7WB..."
}

#WebSocket Protocol[link]

Real-time transaction updates via WebSocket connection:

const ws = new WebSocket('ws://localhost:3002');

// Subscribe to token
ws.send(JSON.stringify({
  type: 'subscribe',
  tokenAddress: '5sN7WB75KLQHKNVkxX6wycRhc75C1NDACiKREiWepZ9n'
}));

// Handle messages
ws.onmessage = (event) => {
  const msg = JSON.parse(event.data);

  if (msg.type === 'transaction') {
    console.log(`${msg.data.type}: ${msg.data.amountToken} ${msg.data.tokenSymbol}`);
  }
};

Transaction Alert Format

{
  "type": "transaction",
  "data": {
    "type": "buy",
    "tokenAddress": "5sN7WB...",
    "tokenSymbol": "JACK",
    "amountToken": "1000000.00",
    "amountXnt": "100.5",
    "amountUsd": 10.05,
    "walletAddress": "7xKX...",
    "txSignature": "5VER...",
    "marketCap": 12340,
    "timestamp": "2026-01-24T10:30:00.000Z"
  }
}

#Frequently Asked Questions[link]