Skip to content

A Telegram bot that provides token information and bubble maps visualization from BubbleMaps. Get instant access to token ownership distribution, market data, and decentralization metrics directly in Telegram.

License

Notifications You must be signed in to change notification settings

incryptomax/bubblemapstelegrambot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

30 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

BubbleMaps Telegram Bot

A powerful Telegram bot that provides instant token information and bubble maps visualization from BubbleMaps. Get real-time access to token ownership distribution, market data, and decentralization metrics directly in Telegram, for both private chats and communities.

Telegram Bot Version License

๐ŸŒŸ Features

Token Analysis

  • ๐Ÿ” One-click token lookup by pasting any contract address directly in chat
  • ๐Ÿ”„ Automatic blockchain detection across all supported networks
  • ๐Ÿ“Š Real-time market data integration (price, volume, market cap, 24h change)
  • ๐Ÿ“ˆ Decentralization score and metrics visualization
  • ๐Ÿ‘ฅ Detailed top holders identification and distribution analysis
  • ๐Ÿ–ผ๏ธ Token ownership visualization with interactive bubble maps
  • ๐ŸŒ Multi-chain support with seamless cross-chain analysis

Community Features

  • ๐Ÿ‘ฅ Bot can be setup in community chats for group token analysis
  • ๐Ÿ“Š Community statistics for tracking popular tokens and chains
  • ๐Ÿ”ฅ Trending tokens analytics for the last 3 days
  • ๐Ÿ‘๐Ÿ‘Ž Community rating system with like/dislike functionality
  • ๐Ÿ† Top rated tokens by community voting
  • ๐Ÿ“ฃ Mass message broadcasting system for announcements

User Experience

  • โญ๏ธ Favorites system to save and quickly access tokens
  • ๐Ÿ•’ Recently viewed tokens history
  • ๐Ÿ“ฑ Intuitive Telegram interface with seamless navigation
  • ๐Ÿš€ Optimized performance for faster token lookups

Administration

  • ๐Ÿ”’ Comprehensive admin dashboard with usage statistics
  • ๐Ÿ“‹ User management tools
  • ๐Ÿ“ Detailed logging system for monitoring bot activity

๐ŸŽฌ Demo Video

Watch our demo video to see the BubbleMaps Telegram Bot in action:

BubbleMaps Telegram Bot Demo

Click the image above to watch the demo on YouTube.

๐Ÿ”— Supported Networks

  • Ethereum (ETH) - Auto-detected
  • BNB Smart Chain (BSC) - Auto-detected
  • Fantom (FTM) - Auto-detected
  • Avalanche (AVAX) - Auto-detected
  • Cronos (CRO) - Auto-detected
  • Arbitrum (ARBI) - Auto-detected
  • Polygon (POLY) - Auto-detected
  • Base (BASE) - Auto-detected
  • Solana (SOL) - Auto-detected
  • Sonic (SONIC) - Auto-detected

๐Ÿš€ Quick Start

  1. Find the Bot on Telegram: BubbleMaps Telegram Bot
  2. Start a Chat: Click "Start" to initiate the bot
  3. Check a Token: Paste any contract address to get instant analysis

๐Ÿ’ป Self-Hosted Deployment

Prerequisites

  • Node.js 16+
  • MongoDB 4.4+
  • Telegram Bot Token (from @BotFather)

Installation Steps

  1. Clone the repository:
git clone https://github.com/incryptomax/bubblemapstelegrambot.git
cd bubblemapstelegrambot
  1. Install dependencies:
npm install
npx playwright install chromium
  1. Configure environment:
cp .env.example .env
# Edit .env with your settings
  1. Start the bot:
npm start

Docker Deployment

Deploy using Docker Compose:

# Build and start services
docker-compose up -d

# View logs
docker-compose logs -f bot

# Stop services
docker-compose down

๐Ÿ”ง Configuration

Required Environment Variables

TELEGRAM_BOT_TOKEN=   # Your Telegram bot token from @BotFather
MONGODB_URI=         # MongoDB connection URI
ADMIN_USER_IDS=     # Comma-separated Telegram user IDs for admin access

Optional Settings

LOG_LEVEL=info      # Logging level (debug, info, warn, error)
PLAYWRIGHT_TIMEOUT=60000       # Screenshot timeout (ms)
NAVIGATION_TIMEOUT=120000      # Page navigation timeout (ms)
STABILIZATION_TIME=25000      # Page stabilization wait time (ms)

๐Ÿ“ฑ How to Use

The bot is designed to be simple and intuitive:

  1. Direct Contract Input: Paste any contract address directly in the chat
  2. Command: Use the /check <address> command
  3. Button Interface: Click the "Check a token" button and follow the prompts
  4. Community Statistics: Use /topstat to view popular tokens and trends
  5. User Features: Access /favorites and /recent to manage your token history

Available Commands

User Commands

  • /start - Initialize the bot and display main menu
  • /help - Display command list and usage instructions
  • /check <address> - Analyze token by contract address
  • /favorites - View and manage your saved tokens
  • /recent - View your recently checked tokens history
  • /topstat - Access community token statistics and trends

Admin Commands

  • /stats - View detailed usage statistics and metrics
  • /broadcast - Send a message to all bot users

๐ŸŒ Adding the Bot to Communities

Adding the BubbleMaps Telegram Bot to your community enhances your group's capabilities for on-chain token analysis.

Step 1: Add the Bot to Your Group

  1. Search for the Bot:

  2. Add to Group:

    • Start a chat with the bot and click the three dots (โ‹ฎ) in the top right
    • Select "Add to Group" or "Add to Channel"
    • Choose your community from the list

Step 2: Configure Bot Permissions

For optimal functionality, ensure the bot has these permissions:

  • โœ… Send Messages
  • โœ… Send Media
  • โœ… Send Stickers & GIFs
  • โœ… Embed Links

Step 3: Pasting a contract address to get instant token analysis

Community Features

  • Automatic Token Analysis: Members can paste any contract address for instant analysis
  • Blockchain Auto-Detection: No need to specify which network the token is on
  • Visual Representation: Get bubble map screenshots directly in the group chat
  • Deep-Link Integration: "Check more details" button for private analysis with the bot

๐Ÿ“ Logging System

The bot features a comprehensive logging system:

Log Levels

  • DEBUG: Detailed diagnostic information for development
  • INFO: General operational information about normal system activity
  • WARN: Warning conditions that might require attention
  • ERROR: Error conditions preventing normal operations

Log Directory Structure

logs/
  โ”œโ”€โ”€ combined.log     # All log entries
  โ”œโ”€โ”€ error.log        # Error-level entries only
  โ”œโ”€โ”€ debug-YYYY-MM-DD.log  # Daily rotated debug logs
  โ””โ”€โ”€ exceptions.log   # Uncaught exceptions

๐Ÿ“ Project Structure

.
โ”œโ”€โ”€ config/         # Configuration files
โ”œโ”€โ”€ src/
โ”‚   โ”œโ”€โ”€ handlers/   # Command and callback handlers
โ”‚   โ”œโ”€โ”€ models/     # Database models
โ”‚   โ”œโ”€โ”€ services/   # Business logic and API integrations
โ”‚   โ”œโ”€โ”€ utils/      # Utility modules
โ”‚   โ””โ”€โ”€ assets/     # Static assets for the bot
โ”œโ”€โ”€ logs/           # Application logs
โ”œโ”€โ”€ screenshots/    # Generated screenshots for tokens
โ”œโ”€โ”€ Dockerfile      # Docker configuration
โ”œโ”€โ”€ docker-compose.yml # Docker Compose configuration
โ””โ”€โ”€ package.json    # Project metadata and dependencies

๐Ÿ‘จโ€๐Ÿ’ป Author

incryptomax

๐Ÿ“œ License

This project is licensed under the MIT License. See the LICENSE file for details.

๐Ÿ™ Acknowledgments

About

A Telegram bot that provides token information and bubble maps visualization from BubbleMaps. Get instant access to token ownership distribution, market data, and decentralization metrics directly in Telegram.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published