Handi Cat Wallet Tracker

<!-- Improved compatibility of back to top link: See: https://github.com/othneildrew/Best-README-Template/pull/73 -->

<a id="readme-top"></a>

<!-- PROJECT LOGO --> <br /> <div align="center"> <a href="https://github.com/DracoR22/handi-cat_wallet-tracker"> <img src="showcase/logo.jpg" alt="Logo" width="80" height="80"> </a> <h3 align="center">🐱 Handi Cat | Wallet Tracker</h3> <p align="center"> Track any Solana transaction in Real-Time </p> </div> <!-- ABOUT THE PROJECT -->

About The Project

Handi Cat is a Telegram bot that can track any Solana wallet in real time, it provides relevant information of each transaction made in Raydium, Jupiter, Pump.fun and Pump AMM(PumpSwap) including transaction hash, tokens and amount swapped, price of the token in SOL, token market cap and much more.

Features

• 📈 Tracks in Real-Time any SOL transfer
• 🔍 Detects Raydium, Jupiter, Pump.fun and PumpSwap transactions
• 💰 Gets SOL price of the token swapped
• 📊 Gets token market cap at the time swapped
• 💰 Gets token amount and supply percentage owned by each tracked wallet
• 🤖 Each transaction message includes links to popular Solana trading bots to quickly buy the token
• 🔗 Each transaction provides links to Photon, GMGN and Dex Screener to quickly see the token chart

<p align="right">(<a href="#readme-top">back to top</a>)</p>

Bot Commands

• /start – Opens the bot's main menu
• /add – Add a new wallet address
• /delete – Delete a wallet addresss
• /upgrade – Access the subscription menu
• /ban_wallet – Flag a wallet as BANNED and remove it from the wallet pool (admin only)
• /help_notify – Learn how bot notifications work
• /help_group – Instructions for adding the bot to group chats

<p align="right">(<a href="#readme-top">back to top</a>)</p>

Built With

• 🌐 Node.JS
• 📘 TypeScript
• 📊 Prisma ORM
• 🪙 Solana Web3.js

<p align="right">(<a href="#readme-top">back to top</a>)</p> <!-- GETTING STARTED -->

Getting Started

Follow these simple steps to setup Handi Cat locally on your machine

Prerequisites

Node version 14.x

Steps

1. Clone the repo

   git clone https://github.com/DracoR22/handi-cat_wallet-tracker.git
   

2. Install NPM packages

   pnpm install
   

3. Rename .env.example file to .env

4. Create a Postgres database and paste the connection string into DATABASE_URL in .env

5. Create a new Telegram Bot using Bot Father and get your BOT_TOKEN. Paste it into the corresponding variable in .env

6. Run the migration command to push the database schemas and generate all types

  pnpm db:migrate

7. (Optional) To use a webhook connection instead of polling, set your .env like this:

ENVIRONMENT=production
APP_URL=https://your-domain.com

# APP_URL must be the public HTTPS URL where your bot is deployed.
# The bot will automatically register its webhook at `APP_URL/webhook/telegram.

8. (Optional) Set up custom RPC providers by adding them to the RPC_ENDPOINTS environment variable. You can list multiple endpoints separated by commas, e.g.:

RPC_ENDPOINTS=https://rpc1.com,https://rpc2.com

9. Start the bot

  pnpm start

10. That's it! now your local version of Handi Cat is ready to use.

<p align="center"><img src="./showcase/cli-pic.png" width="95%" alt="Screenshot of bot succesfully running"/></> <p align="right">(<a href="#readme-top">back to top</a>)</p> <!-- CONTACT -->

Contact

<!-- [@your_twitter](https://twitter.com/your_username) --> - rdraco039@gmail.com

My solana wallet for the struggles - 5EVQsbVErvJruJvi3v8i3sDSy58GUnGfewwRb8pJk8N1

Project Link: https://github.com/DracoR22/handi-cat_wallet-tracker

<p align="right">(<a href="#readme-top">back to top</a>)</p> <!-- MARKDOWN LINKS & IMAGES --> <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->