An open API service indexing awesome lists of open source software.

https://github.com/barkprotocol/bark-trading-bot


https://github.com/barkprotocol/bark-trading-bot

Last synced: 12 months ago
JSON representation

Awesome Lists containing this project

README

          

# BarkBOT: Telegram Solana Bot (Raydium, Jupiter, Pump.fun)

## Overview

Bark**BOT** is a powerful Telegram-based trading and tracking bot designed for Solana blockchain enthusiasts. It provides a seamless and secure way to monitor, trade, and manage SPL tokens across popular platforms like Raydium, Jupiter, and Pump.fun. With integrated tools for automated trading, PNL report generation, and enhanced wallet security, Bark**BOT** is tailored for both casual users and advanced traders.

The bot eliminates the need for exposing private keys by creating secure wallets for transactions. Additionally, Bark**BOT** leverages APIs like JITO for trading optimization, Raydium SDK for liquidity pool operations, and Birdeye API for market insights, making it a comprehensive solution for Solana token management.

## Main Features

- **Track All Tokens & Pools**: Comprehensive tracking of tokens and liquidity pools on Raydium (AMM, CLMM), Jupiter, and Pump.fun.
- **Trade SPL Tokens**: Buy and sell all Solana Program Library (SPL) tokens using JITO integration across Raydium, Jupiter, and Pump.fun.
- **Automated Trading**: Enable auto-buy/sell functionality based on user-defined settings.
- **PNL Card Generation**: Generate detailed Profit & Loss (PNL) reports.
- **Secure Wallet Integration**: Enhance user security by creating new wallets, eliminating the need for private keys from user wallets.

## Screenshot

*Add relevant screenshots showcasing the bot's interface and features.*

---

## Tech Stack

- **TypeScript**: For type-safe development.
- **Telegram API**: Enables bot interaction.
- **Solana/web3**: Blockchain integration and transaction management.
- **Raydium SDK**: For AMM and CLMM pool operations.
- **Jupiter API**: For cross-platform token trading.
- **Pump.fun**: Token tracking and trading.
- **JITO**: Trading optimization.
- **Birdeye API**: Token and market data analytics.
- **MongoDB**: Persistent data storage.
- **Redis**: For caching and session management.

---

## Prerequisites

Before you start, ensure you have the following:

- **Node.js**: Version 18 or above.
- **Telegram Bot Token**: Obtainable from BotFather on Telegram.
- **MongoDB URI**: Connection string for your MongoDB cluster.
- **Redis URI**: Connection string for your Redis instance.

---

## Configuration

1. **Clone the Repository**
```sh
git clone https://github.com/bark-protocol/bark-telegram-bot.git
```

2. **Install Dependencies**
```sh
pnpm install
```

3. **Create an `.env` File**
Add the following environment variables to a new `.env` file:

```env
MONGODB_URL=
REDIS_URI=

# Telegram Bot IDs and API Tokens
BARK_BOT_ID=
BARK_ALERT_BOT_ID=
BridgeBotID=
ALERT_BOT_API_TOKEN=
TELEGRAM_BOT_API_TOKEN=

# RPC Endpoints
MAINNET_RPC=
PRIVATE_RPC_ENDPOINT=
RPC_WEBSOCKET_ENDPOINT=

# JITO and External API Configuration
JITO_UUID=
BIRD_EYE_API=
BARKBOT_API_ENDPOINT=
PNL_IMG_GENERATOR_API=
```

4. **Run the Bot**
```sh
const createKeyboardButton = (text: string, command: string): TelegramBot.InlineKeyboardButton => ({
text,
callback_data: JSON.stringify({ command })
});
```

---

## Usage

- Use Telegram to interact with the Bark**BOT**.
- Access advanced trading features and manage settings directly through the Bark**BOT** interface.

---

## Contribution

If you'd like to contribute to Bark**BOT**, feel free to fork the repository, create a new branch, and submit a pull request.

---

## License

This project is licensed under the MIT License.
```