LP Notifier Bot

A Telegram bot for monitoring Uniswap V3 liquidity positions across multiple chains and notifying users when positions go out of range.

Features

🔗 Multi-Chain Support: Monitor LP positions on Ethereum, Polygon, Arbitrum, Sui, and Solana
📊 Real-time Monitoring: Check position status and range deviations
🔔 Smart Notifications: Get alerted when positions go out of range
👛 Wallet Management: Add and manage multiple wallet addresses
⚙️ Customizable Settings: Configure notification preferences and thresholds
📈 Position Analytics: View detailed position information and status

Supported Chains

Ethereum (ETH): Mainnet with Uniswap V3
Polygon (MATIC): Polygon network with Uniswap V3
Arbitrum (ARB): Arbitrum One with Uniswap V3
Sui (SUI): Mainnet with Cetus, Turbos, and Kriya protocols
Solana (SOL): Mainnet with Orca, Raydium, and Meteora protocols

Installation

Prerequisites

Python 3.8 or higher
Telegram Bot Token (get from @BotFather)
RPC endpoints for supported chains

Setup

Clone the repository

git clone <repository-url>
cd lp-notifier

Install dependencies

# Create virtual environment
python3 -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install all dependencies including Solana/Sui packages
pip install -r requirements.txt

Configure environment variables

cp .env.example .env
# Edit .env with your configuration

Set up your environment variables

# Required
BOT_TOKEN=your_telegram_bot_token_here

# EVM Chain RPC URLs
ETHEREUM_RPC_URL=https://mainnet.infura.io/v3/YOUR_PROJECT_ID
POLYGON_RPC_URL=https://polygon-rpc.com
ARBITRUM_RPC_URL=https://arb1.arbitrum.io/rpc

# NEW: Non-EVM Chain RPC URLs
SUI_RPC_URL=https://fullnode.mainnet.sui.io:443
SOLANA_RPC_URL=https://api.mainnet-beta.solana.com

# Optional: Customize monitoring settings
LP_CHECK_INTERVAL=300
PRICE_DEVIATION_THRESHOLD=0.05
RANGE_DEVIATION_THRESHOLD=0.10

Run the bot
```
python main.py
```

Usage

Bot Commands

Command	Description
`/start`	Start the bot and see welcome message
`/help`	Show help and available commands
`/addwallet`	Add a new wallet address to monitor
`/removewallet <address>`	Remove a wallet from monitoring
`/wallets`	List all your registered wallets
`/check`	Check current status of all your LP positions
`/status`	Get a quick overview of your positions
`/settings`	Configure notification preferences and enabled chains

Quick Start

Start the bot: Send /start to begin
Add your wallet: Use /addwallet and follow the prompts
Check positions: Use /check to see your LP status
Configure settings: Use /settings to customize notifications

Adding Wallets for Different Chains

Ethereum/Polygon/Arbitrum Wallets

/addwallet
0x742d35Cc6634C0532925a3b8D4C9db96C4b4d8b6

Then provide a label: Main DeFi Wallet

Sui Wallets

/addwallet
0x1eabed72c53feb3805120a081dc15963c204dc8d091542592abaf7a35689b2fb123456789012345678901234567890123456789012345678901234567890

Then provide a label: Sui Trading Wallet

Solana Wallets

/addwallet
So11111111111111111111111111111111111111112

Then provide a label: Solana DeFi Wallet

Example Usage

/start
/addwallet
0x742d35Cc6634C0532925a3b8D4C9db96C4b4d8b6
Main DeFi Wallet
/check

Sample Bot Output

Position Check Results

📊 LP Position Report

Total Positions: 8
Out of Range: 2

⚠️ ALERT: Some positions are out of range!

🔗 Main DeFi Wallet
0x742d35Cc6634C0532925a3b8D4C9db96C4b4d8b6

  📍 Ethereum: 2 positions (1 out of range)
    ⚠️ ETH/USDC (ID: 12345)
       Deviation: 12.5%

  📍 Polygon: 1 position

🔗 Sui Trading Wallet
0x1eabed72c53feb3805120a081dc15963c204dc8d091542592abaf7a35689b2fb...

  📍 Sui: 3 positions (1 out of range)
    ⚠️ SUI/USDC (Cetus - ID: cetus_123)
       Deviation: 8.7%

🔗 Solana DeFi Wallet
So11111111111111111111111111111111111111112

  📍 Solana: 2 positions
    • Orca: 1 position
    • Meteora: 1 position

Out-of-Range Notifications

⚠️ LP Position Alert

Wallet: Sui Trading Wallet
0x1eabed72c53feb3805120a081dc15963c204dc8d091542592abaf7a35689b2fb...

Out of Range Positions: 1

1. SUI/USDC (Cetus - Sui)
   Position ID: cetus_position_123
   Deviation: 15.2%
   Current Tick: 2000
   Range: 1800 - 2200

Use /check to see all your positions.

Configuration

Environment Variables

Variable	Description	Default
`BOT_TOKEN`	Telegram bot token (required)	-
`ETHEREUM_RPC_URL`	Ethereum RPC endpoint	Infura default
`POLYGON_RPC_URL`	Polygon RPC endpoint	Polygon RPC
`ARBITRUM_RPC_URL`	Arbitrum RPC endpoint	Arbitrum RPC
`SUI_RPC_URL`	Sui RPC endpoint	Sui mainnet
`SOLANA_RPC_URL`	Solana RPC endpoint	Solana mainnet
`LP_CHECK_INTERVAL`	Position check interval (seconds)	300
`PRICE_DEVIATION_THRESHOLD`	Price deviation alert threshold	0.05 (5%)
`RANGE_DEVIATION_THRESHOLD`	Range deviation alert threshold	0.10 (10%)
`ENABLE_NOTIFICATIONS`	Enable/disable notifications	true
`MAX_NOTIFICATIONS_PER_HOUR`	Rate limit for notifications	10

User Preferences

Users can configure:

Enabled chains for monitoring
Notification frequency
Price deviation thresholds
Range deviation thresholds

Architecture

Core Components

telegram_bot.py: Main bot implementation with command handlers
lp_monitor.py: LP position monitoring and range checking
database.py: SQLite database for user data and preferences
config.py: Configuration management and chain settings

Database Schema

users: User information and preferences
wallet_addresses: Registered wallet addresses per user
lp_positions: Cached LP position data
notifications: Notification history and rate limiting
user_preferences: User-specific settings

Development

Project Structure

lp-notifier/
├── main.py              # Main entry point
├── telegram_bot.py      # Telegram bot implementation
├── lp_monitor.py        # LP monitoring logic
├── database.py          # Database operations
├── config.py            # Configuration management
├── requirements.txt     # Python dependencies
├── .env.example         # Environment variables template
├── README.md           # This file
└── lp_notifier.db      # SQLite database (created automatically)

Adding New Chains

To add support for a new chain:

Add chain configuration to config.py
Update SUPPORTED_CHAINS dictionary
Implement chain-specific logic in lp_monitor.py
Update documentation

Testing

# Run basic tests
python -m pytest tests/

# Run with coverage
python -m pytest --cov=. tests/

Security Considerations

Private Keys: Never store private keys in the bot
RPC Endpoints: Use secure, private RPC endpoints in production
Rate Limiting: Implement rate limiting for API calls
Data Privacy: User data is stored locally in SQLite

Contributing

Fork the repository
Create a feature branch
Make your changes
Add tests if applicable
Submit a pull request

License

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

Troubleshooting

Common Issues

"Invalid address format"

Ethereum/Polygon/Arbitrum: Use 40 hex characters after 0x (e.g., 0x742d35Cc6634C0532925a3b8D4C9db96C4b4d8b6)
Sui: Use 64 hex characters after 0x (e.g., 0x1eabed72c53feb3805120a081dc15963c204dc8d091542592abaf7a35689b2fb123456789012345678901234567890123456789012345678901234567890)
Solana: Use Base58 encoded public key (e.g., So11111111111111111111111111111111111111112)

"No positions found"

Verify the wallet has LP positions on the specified chain
Check if the RPC endpoints are working
Ensure the wallet address is correct

"Connection failed"

Check your RPC URLs in the .env file
Verify internet connection
Try different RPC endpoints

Testing

# Test basic functionality
python test_bot.py

# Test new chain integrations
python test_sui_solana.py

# Test specific components
python -c "from sui_monitor import SuiMonitor; print('Sui monitor OK')"
python -c "from solana_monitor import SolanaMonitor; print('Solana monitor OK')"

Logs and Debugging

# View bot logs
tail -f lp_notifier.log

# Check database
sqlite3 lp_notifier.db ".tables"
sqlite3 lp_notifier.db "SELECT * FROM users LIMIT 5;"

Docker Deployment

Using Docker Compose

# Build and run
docker-compose up -d

# View logs
docker-compose logs -f lp-notifier-bot

# Stop
docker-compose down

Manual Docker Build

# Build image
docker build -t lp-notifier-bot .

# Run container
docker run -d \
  --name lp-notifier-bot \
  --env-file .env \
  -v $(pwd)/data:/app/data \
  lp-notifier-bot

Support

For support or questions:

Create an issue on GitHub
Contact the bot administrator
Check the /help command in the bot

Name		Name	Last commit message	Last commit date
Latest commit History 2 Commits
__pycache__		__pycache__
.env.example		.env.example
.gitignore		.gitignore
Dockerfile		Dockerfile
IMPLEMENTATION_REVIEW.md		IMPLEMENTATION_REVIEW.md
QUICK_START.md		QUICK_START.md
README.md		README.md
config.py		config.py
database.py		database.py
docker-compose.yml		docker-compose.yml
lp_monitor.py		lp_monitor.py
main.py		main.py
monitor_service.py		monitor_service.py
requirements.txt		requirements.txt
solana_monitor.py		solana_monitor.py
sui_monitor.py		sui_monitor.py
telegram_bot.py		telegram_bot.py
test.db		test.db
test_bot.py		test_bot.py
test_config.py		test_config.py
test_lp_monitor.py		test_lp_monitor.py
test_sui_solana.py		test_sui_solana.py

raulalexe/lp-notifier

Folders and files

Latest commit

History

Repository files navigation

LP Notifier Bot

Features

Supported Chains

Installation

Prerequisites

Setup

Usage

Bot Commands

Quick Start

Adding Wallets for Different Chains

Ethereum/Polygon/Arbitrum Wallets

Sui Wallets

Solana Wallets

Example Usage

Sample Bot Output

Position Check Results

Out-of-Range Notifications

Configuration

Environment Variables

User Preferences

Architecture

Core Components

Database Schema

Development

Project Structure

Adding New Chains

Testing

Security Considerations

Contributing

License

Troubleshooting

Common Issues

"Invalid address format"

"No positions found"

"Connection failed"

Testing

Logs and Debugging

Docker Deployment

Using Docker Compose

Manual Docker Build

Support

Roadmap

About

Resources

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages