|
| 1 | +# 🤖 Bubblemaps Telegram Bot |
| 2 | + |
| 3 | +A Telegram bot that brings **on-chain analytics** to your fingertips. Simply send a token's contract address along with the chain, and the bot delivers **visualizations** and **metrics** straight to your chat — powered by [Bubblemaps](https://www.bubblemaps.io). |
| 4 | + |
| 5 | +## ✨ Features |
| 6 | + |
| 7 | +- 📍 **Bubble Map Screenshot** — Instantly generates a map of token holder clusters. |
| 8 | +- 📊 **Analytics Dashboard** — Market cap, price, volume, and more. |
| 9 | +- 🧠 **Decentralization Score** — See how evenly a token is distributed. |
| 10 | +- 💎 **Top Holders Info** — Know who holds what. |
| 11 | +- 🌍 Supports multiple chains (via `[chain]` argument) \[Supported chains - eth, bsc, ftm, avax, cro, arbi, poly, base, sol, sonic] |
| 12 | + |
| 13 | + |
| 14 | + |
| 15 | + |
| 16 | +## 🛠 Tech Stack |
| 17 | + |
| 18 | +- **Language:** TypeScript |
| 19 | +- **Server:** Express.js |
| 20 | +- **Bot Framework:** [node-telegram-bot-api](https://github.com/yagop/node-telegram-bot-api) |
| 21 | +- **Infra:** AWS EC2 (High performance deployment) |
| 22 | +- **Other:** Puppeteer (for screenshots), Gemini API (for AI capabilities) |
| 23 | + |
| 24 | + |
| 25 | +## 💬 Commands |
| 26 | + |
| 27 | +```bash |
| 28 | +/start |
| 29 | + Initiates interaction with the bot |
| 30 | + |
| 31 | +/help |
| 32 | + Shows available commands |
| 33 | + |
| 34 | +/analytics [chain] [address] |
| 35 | + Get basic token info, decentralization score, top holders info, and a Bubblemaps link |
| 36 | + |
| 37 | +/screenshot [chain] [address] |
| 38 | + Get a screenshot of the token's bubblemap |
| 39 | +``` |
| 40 | +
|
| 41 | +## 🚀 Getting Started |
| 42 | +
|
| 43 | +1. **Clone the Repo** |
| 44 | +```bash |
| 45 | +git clone https://github.com/your-username/bubblemaps-telegrambot.git |
| 46 | +cd bubblemaps-telegrambot |
| 47 | +``` |
| 48 | +
|
| 49 | +2. **Install Dependencies** |
| 50 | +```bash |
| 51 | +npm install |
| 52 | +``` |
| 53 | +
|
| 54 | +3. **Set Up Environment Variables** |
| 55 | +Create a `.env` file in the root directory and fill it with: |
| 56 | +```ini |
| 57 | +BOT_TOKEN=your-telegram-bot-token |
| 58 | +GEMINI_API_KEY=your-gemini-api-key |
| 59 | +``` |
| 60 | +
|
| 61 | +4. **Build and Run the Bot** |
| 62 | +```bash |
| 63 | +npm run build |
| 64 | +npm run start |
| 65 | +``` |
| 66 | +
|
| 67 | +## 📸 Screenshots |
| 68 | +
|
| 69 | +Sneak peek of the bot in action — coming soon! |
| 70 | +
|
| 71 | +| Command | Output | |
| 72 | +|---------|--------| |
| 73 | +| `/analytics` |  | |
| 74 | +| `/screenshot` |  | |
| 75 | +
|
| 76 | +## 🤝 Contributing |
| 77 | +
|
| 78 | +We welcome PRs and contributions! Just follow these general rules: |
| 79 | +
|
| 80 | +- ✅ Follow conventional code style and naming. |
| 81 | +- 🧪 Test your changes locally. |
| 82 | +- 📄 Open an issue before big features. |
| 83 | +
|
| 84 | +<!-- ## 📄 License |
| 85 | +
|
| 86 | +MIT © Your Name |
| 87 | +
|
| 88 | +## 🌐 Live Bot |
| 89 | +
|
| 90 | +🟢 Bot is live! Find it on Telegram at @Bubblemaps_orbot --> |
0 commit comments