mirror of
https://github.com/0xfnzero/solana-streamer.git
synced 2026-08-13 17:08:05 +00:00
- Rename verbose method names to shorter, clearer alternatives - program_received_time_us() → recv_us() - program_handle_time_consuming_us() → handle_us() - instruction_outer_index() → outer_index() - instruction_inner_index() → inner_index() - Update all implementations across event parsers and processors Improves developer experience while maintaining semantic clarity.
662 lines
26 KiB
Markdown
Executable File
662 lines
26 KiB
Markdown
Executable File
# Solana Streamer
|
|
[中文](https://github.com/0xfnzero/solana-streamer/blob/main/README_CN.md) | [English](https://github.com/0xfnzero/solana-streamer/blob/main/README.md) | [Telegram](https://t.me/fnzero_group)
|
|
|
|
A lightweight Rust library for real-time event streaming from Solana DEX trading programs. This library provides efficient event parsing and subscription capabilities for PumpFun, PumpSwap, Bonk, and Raydium CPMM protocols.
|
|
|
|
## Project Features
|
|
|
|
1. **Real-time Event Streaming**: Subscribe to live trading events from multiple Solana DEX protocols
|
|
2. **Yellowstone gRPC Support**: High-performance event subscription using Yellowstone gRPC
|
|
3. **ShredStream Support**: Alternative event streaming using ShredStream protocol
|
|
4. **Multi-Protocol Support**:
|
|
- **PumpFun**: Meme coin trading platform events
|
|
- **PumpSwap**: PumpFun's swap protocol events
|
|
- **Bonk**: Token launch platform events (letsbonk.fun)
|
|
- **Raydium CPMM**: Raydium's Concentrated Pool Market Maker events
|
|
- **Raydium CLMM**: Raydium's Concentrated Liquidity Market Maker events
|
|
- **Raydium AMM V4**: Raydium's Automated Market Maker V4 events
|
|
5. **Unified Event Interface**: Consistent event handling across all supported protocols
|
|
6. **Event Parsing System**: Automatic parsing and categorization of protocol-specific events
|
|
7. **Account State Monitoring**: Real-time monitoring of protocol account states and configuration changes
|
|
8. **Transaction & Account Event Filtering**: Separate filtering for transaction events and account state changes
|
|
9. **High Performance**: Optimized for low-latency event processing
|
|
10. **Batch Processing Optimization**: Batch processing events to reduce callback overhead
|
|
11. **Performance Monitoring**: Built-in performance metrics monitoring, including event processing speed, etc.
|
|
12. **Memory Optimization**: Object pooling and caching mechanisms to reduce memory allocations
|
|
13. **Flexible Configuration System**: Support for custom batch sizes, backpressure strategies, channel sizes, and other parameters
|
|
14. **Preset Configurations**: Provides high-throughput and low-latency preset configurations optimized for different use cases
|
|
15. **Backpressure Handling**: Supports blocking and dropping backpressure strategies
|
|
16. **Runtime Configuration Updates**: Supports dynamic configuration parameter updates at runtime
|
|
17. **Full Function Performance Monitoring**: All subscribe_events functions support performance monitoring, automatically collecting and reporting performance metrics
|
|
18. **Graceful Shutdown**: Support for programmatic stop() method for clean shutdown
|
|
19. **Dynamic Subscription Management**: Runtime filter updates without reconnection, enabling adaptive monitoring strategies
|
|
|
|
## Installation
|
|
|
|
### Direct Clone
|
|
|
|
Clone this project to your project directory:
|
|
|
|
```bash
|
|
cd your_project_root_directory
|
|
git clone https://github.com/0xfnzero/solana-streamer
|
|
```
|
|
|
|
Add the dependency to your `Cargo.toml`:
|
|
|
|
```toml
|
|
# Add to your Cargo.toml
|
|
solana-streamer-sdk = { path = "./solana-streamer", version = "0.4.1" }
|
|
```
|
|
|
|
### Use crates.io
|
|
|
|
```toml
|
|
# Add to your Cargo.toml
|
|
solana-streamer-sdk = "0.4.1"
|
|
```
|
|
|
|
## Configuration System
|
|
|
|
### Preset Configurations
|
|
|
|
The library provides three preset configurations optimized for different use cases:
|
|
|
|
#### 1. High Throughput Configuration (`high_throughput()`)
|
|
|
|
Optimized for high-concurrency scenarios, prioritizing throughput over latency:
|
|
|
|
```rust
|
|
let config = StreamClientConfig::high_throughput();
|
|
// Or use convenience methods
|
|
let grpc = YellowstoneGrpc::new_high_throughput(endpoint, token)?;
|
|
let shred = ShredStreamGrpc::new_high_throughput(endpoint).await?;
|
|
```
|
|
|
|
**Features:**
|
|
- **Backpressure Strategy**: Drop - drops messages during high load to avoid blocking
|
|
- **Buffer Size**: 5,000 permits to handle burst traffic
|
|
- **Use Case**: Scenarios where you need to process large volumes of data and can tolerate occasional message drops during peak loads
|
|
|
|
#### 2. Low Latency Configuration (`low_latency()`)
|
|
|
|
Optimized for real-time scenarios, prioritizing latency over throughput:
|
|
|
|
```rust
|
|
let config = StreamClientConfig::low_latency();
|
|
// Or use convenience methods
|
|
let grpc = YellowstoneGrpc::new_low_latency(endpoint, token)?;
|
|
let shred = ShredStreamGrpc::new_low_latency(endpoint).await?;
|
|
```
|
|
|
|
**Features:**
|
|
- **Backpressure Strategy**: Block - ensures no data loss
|
|
- **Buffer Size**: 4000 permits for balanced throughput and latency
|
|
- **Immediate Processing**: No buffering, processes events immediately
|
|
- **Use Case**: Scenarios where every millisecond counts and you cannot afford to lose any events, such as trading applications or real-time monitoring
|
|
|
|
|
|
### Custom Configuration
|
|
|
|
You can also create custom configurations:
|
|
|
|
```rust
|
|
let config = StreamClientConfig {
|
|
connection: ConnectionConfig {
|
|
connect_timeout: 30,
|
|
request_timeout: 120,
|
|
max_decoding_message_size: 20 * 1024 * 1024, // 20MB
|
|
},
|
|
backpressure: BackpressureConfig {
|
|
permits: 2000,
|
|
strategy: BackpressureStrategy::Block,
|
|
},
|
|
enable_metrics: true,
|
|
};
|
|
```
|
|
|
|
## Usage Examples
|
|
|
|
### Quick Start - Parse Transaction Events
|
|
|
|
You can quickly test the library by running the built-in example that parses transaction events:
|
|
|
|
```bash
|
|
cargo run --example parse_tx_events
|
|
```
|
|
|
|
This example demonstrates:
|
|
- How to parse transaction data from Solana mainnet using RPC
|
|
- Event parsing for multiple protocols (PumpFun, PumpSwap, Bonk, Raydium CPMM/CLMM/AMM V4)
|
|
- Transaction details extraction including fees, logs, and compute units
|
|
|
|
The example uses a predefined transaction signature and shows how to extract protocol-specific events from the transaction data.
|
|
|
|
### Dynamic Subscription Management Example
|
|
|
|
Test runtime filter updates without reconnection:
|
|
|
|
```bash
|
|
cargo run --example dynamic_subscription
|
|
```
|
|
|
|
This example demonstrates:
|
|
- Creating initial subscriptions with specific protocol filters
|
|
- Updating subscription filters at runtime without reconnection
|
|
- Single subscription enforcement and proper error handling
|
|
- Clean shutdown and resource management
|
|
|
|
### Advanced Usage - Complete Example
|
|
|
|
```rust
|
|
use solana_streamer_sdk::{
|
|
match_event,
|
|
streaming::{
|
|
event_parser::{
|
|
common::{filter::EventTypeFilter, EventType},
|
|
protocols::{
|
|
bonk::{
|
|
parser::BONK_PROGRAM_ID, BonkGlobalConfigAccountEvent, BonkMigrateToAmmEvent,
|
|
BonkMigrateToCpswapEvent, BonkPlatformConfigAccountEvent, BonkPoolCreateEvent,
|
|
BonkPoolStateAccountEvent, BonkTradeEvent,
|
|
},
|
|
pumpfun::{
|
|
parser::PUMPFUN_PROGRAM_ID, PumpFunBondingCurveAccountEvent,
|
|
PumpFunCreateTokenEvent, PumpFunGlobalAccountEvent, PumpFunMigrateEvent,
|
|
PumpFunTradeEvent,
|
|
},
|
|
pumpswap::{
|
|
parser::PUMPSWAP_PROGRAM_ID, PumpSwapBuyEvent, PumpSwapCreatePoolEvent,
|
|
PumpSwapDepositEvent, PumpSwapGlobalConfigAccountEvent,
|
|
PumpSwapPoolAccountEvent, PumpSwapSellEvent, PumpSwapWithdrawEvent,
|
|
},
|
|
raydium_amm_v4::{
|
|
parser::RAYDIUM_AMM_V4_PROGRAM_ID, RaydiumAmmV4AmmInfoAccountEvent,
|
|
RaydiumAmmV4DepositEvent, RaydiumAmmV4Initialize2Event, RaydiumAmmV4SwapEvent,
|
|
RaydiumAmmV4WithdrawEvent, RaydiumAmmV4WithdrawPnlEvent,
|
|
},
|
|
raydium_clmm::{
|
|
parser::RAYDIUM_CLMM_PROGRAM_ID, RaydiumClmmAmmConfigAccountEvent,
|
|
RaydiumClmmClosePositionEvent, RaydiumClmmCreatePoolEvent,
|
|
RaydiumClmmDecreaseLiquidityV2Event, RaydiumClmmIncreaseLiquidityV2Event,
|
|
RaydiumClmmOpenPositionV2Event, RaydiumClmmOpenPositionWithToken22NftEvent,
|
|
RaydiumClmmPoolStateAccountEvent, RaydiumClmmSwapEvent, RaydiumClmmSwapV2Event,
|
|
RaydiumClmmTickArrayStateAccountEvent,
|
|
},
|
|
raydium_cpmm::{
|
|
parser::RAYDIUM_CPMM_PROGRAM_ID, RaydiumCpmmAmmConfigAccountEvent,
|
|
RaydiumCpmmDepositEvent, RaydiumCpmmInitializeEvent,
|
|
RaydiumCpmmPoolStateAccountEvent, RaydiumCpmmSwapEvent,
|
|
RaydiumCpmmWithdrawEvent,
|
|
},
|
|
BlockMetaEvent,
|
|
},
|
|
Protocol, UnifiedEvent,
|
|
},
|
|
grpc::ClientConfig,
|
|
shred::StreamClientConfig,
|
|
yellowstone_grpc::{AccountFilter, TransactionFilter},
|
|
ShredStreamGrpc, YellowstoneGrpc,
|
|
},
|
|
};
|
|
|
|
#[tokio::main]
|
|
async fn main() -> Result<(), Box<dyn std::error::Error>> {
|
|
println!("Starting Solana Streamer...");
|
|
test_grpc().await?;
|
|
test_shreds().await?;
|
|
Ok(())
|
|
}
|
|
|
|
async fn test_grpc() -> Result<(), Box<dyn std::error::Error>> {
|
|
println!("Subscribing to Yellowstone gRPC events...");
|
|
|
|
// Create low-latency configuration
|
|
let mut config = ClientConfig::low_latency();
|
|
// Enable performance monitoring, has performance overhead, disabled by default
|
|
config.enable_metrics = true;
|
|
let grpc = YellowstoneGrpc::new_with_config(
|
|
"https://solana-yellowstone-grpc.publicnode.com:443".to_string(),
|
|
None,
|
|
config,
|
|
)?;
|
|
|
|
println!("GRPC client created successfully");
|
|
|
|
let callback = create_event_callback();
|
|
|
|
// Will try to parse corresponding protocol events from transactions
|
|
let protocols = vec![
|
|
Protocol::PumpFun,
|
|
Protocol::PumpSwap,
|
|
Protocol::Bonk,
|
|
Protocol::RaydiumCpmm,
|
|
Protocol::RaydiumClmm,
|
|
Protocol::RaydiumAmmV4,
|
|
];
|
|
|
|
println!("Protocols to monitor: {:?}", protocols);
|
|
|
|
// Filter accounts
|
|
let account_include = vec![
|
|
PUMPFUN_PROGRAM_ID.to_string(), // Listen to pumpfun program ID
|
|
PUMPSWAP_PROGRAM_ID.to_string(), // Listen to pumpswap program ID
|
|
BONK_PROGRAM_ID.to_string(), // Listen to bonk program ID
|
|
RAYDIUM_CPMM_PROGRAM_ID.to_string(), // Listen to raydium_cpmm program ID
|
|
RAYDIUM_CLMM_PROGRAM_ID.to_string(), // Listen to raydium_clmm program ID
|
|
RAYDIUM_AMM_V4_PROGRAM_ID.to_string(), // Listen to raydium_amm_v4 program ID
|
|
];
|
|
let account_exclude = vec![];
|
|
let account_required = vec![];
|
|
|
|
// Transaction filter for monitoring transaction events
|
|
let transaction_filter = TransactionFilter {
|
|
account_include: account_include.clone(),
|
|
account_exclude,
|
|
account_required,
|
|
};
|
|
|
|
// Account filter for monitoring account state changes
|
|
let account_filter = AccountFilter { account: vec![], owner: account_include.clone() };
|
|
|
|
// Event type filtering - optional
|
|
// No event filtering, includes all events
|
|
let event_type_filter = None;
|
|
// Only include PumpSwapBuy and PumpSwapSell events
|
|
// let event_type_filter = Some(EventTypeFilter { include: vec![EventType::PumpSwapBuy, EventType::PumpSwapSell] });
|
|
|
|
println!("Starting to listen for events, press Ctrl+C to stop...");
|
|
println!("Monitoring programs: {:?}", account_include);
|
|
|
|
println!("Starting subscription...");
|
|
|
|
grpc.subscribe_events_immediate(
|
|
protocols,
|
|
None,
|
|
transaction_filter,
|
|
account_filter,
|
|
event_type_filter,
|
|
None,
|
|
callback,
|
|
)
|
|
.await?;
|
|
|
|
// Support stop method, test code - stop after 1000 seconds asynchronously
|
|
let grpc_clone = grpc.clone();
|
|
tokio::spawn(async move {
|
|
tokio::time::sleep(std::time::Duration::from_secs(1000)).await;
|
|
grpc_clone.stop().await;
|
|
});
|
|
|
|
println!("Waiting for Ctrl+C to stop...");
|
|
tokio::signal::ctrl_c().await?;
|
|
|
|
Ok(())
|
|
}
|
|
|
|
async fn test_shreds() -> Result<(), Box<dyn std::error::Error>> {
|
|
println!("Subscribing to ShredStream events...");
|
|
|
|
// Create low-latency configuration
|
|
let mut config = StreamClientConfig::low_latency();
|
|
// Enable performance monitoring, has performance overhead, disabled by default
|
|
config.enable_metrics = true;
|
|
let shred_stream =
|
|
ShredStreamGrpc::new_with_config("http://127.0.0.1:10800".to_string(), config).await?;
|
|
|
|
let callback = create_event_callback();
|
|
let protocols = vec![
|
|
Protocol::PumpFun,
|
|
Protocol::PumpSwap,
|
|
Protocol::Bonk,
|
|
Protocol::RaydiumCpmm,
|
|
Protocol::RaydiumClmm,
|
|
Protocol::RaydiumAmmV4,
|
|
];
|
|
|
|
// Event filtering
|
|
// No event filtering, includes all events
|
|
let event_type_filter = None;
|
|
// Only include PumpSwapBuy events and PumpSwapSell events
|
|
// let event_type_filter =
|
|
// EventTypeFilter { include: vec![EventType::PumpSwapBuy, EventType::PumpSwapSell] };
|
|
|
|
println!("Listening for events, press Ctrl+C to stop...");
|
|
shred_stream.shredstream_subscribe(protocols, None, event_type_filter, callback).await?;
|
|
|
|
// Support stop method, test code - stop after 1000 seconds asynchronously
|
|
let shred_clone = shred_stream.clone();
|
|
tokio::spawn(async move {
|
|
tokio::time::sleep(std::time::Duration::from_secs(1000)).await;
|
|
shred_clone.stop().await;
|
|
});
|
|
|
|
println!("Waiting for Ctrl+C to stop...");
|
|
tokio::signal::ctrl_c().await?;
|
|
|
|
Ok(())
|
|
}
|
|
|
|
fn create_event_callback() -> impl Fn(Box<dyn UnifiedEvent>) {
|
|
|event: Box<dyn UnifiedEvent>| {
|
|
println!("🎉 Event received! Type: {:?}, ID: {}", event.event_type(), event.id());
|
|
match_event!(event, {
|
|
// -------------------------- block meta -----------------------
|
|
BlockMetaEvent => |e: BlockMetaEvent| {
|
|
println!("BlockMetaEvent: {e:?}");
|
|
},
|
|
// -------------------------- bonk -----------------------
|
|
BonkPoolCreateEvent => |e: BonkPoolCreateEvent| {
|
|
// When using grpc, you can get block_time from each event
|
|
println!("block_time: {:?}, block_time_ms: {:?}", e.metadata.block_time, e.metadata.block_time_ms);
|
|
println!("BonkPoolCreateEvent: {:?}", e.base_mint_param.symbol);
|
|
},
|
|
BonkTradeEvent => |e: BonkTradeEvent| {
|
|
println!("BonkTradeEvent: {e:?}");
|
|
},
|
|
BonkMigrateToAmmEvent => |e: BonkMigrateToAmmEvent| {
|
|
println!("BonkMigrateToAmmEvent: {e:?}");
|
|
},
|
|
BonkMigrateToCpswapEvent => |e: BonkMigrateToCpswapEvent| {
|
|
println!("BonkMigrateToCpswapEvent: {e:?}");
|
|
},
|
|
// -------------------------- pumpfun -----------------------
|
|
PumpFunTradeEvent => |e: PumpFunTradeEvent| {
|
|
println!("PumpFunTradeEvent: {e:?}");
|
|
},
|
|
PumpFunMigrateEvent => |e: PumpFunMigrateEvent| {
|
|
println!("PumpFunMigrateEvent: {e:?}");
|
|
},
|
|
PumpFunCreateTokenEvent => |e: PumpFunCreateTokenEvent| {
|
|
println!("PumpFunCreateTokenEvent: {e:?}");
|
|
},
|
|
// -------------------------- pumpswap -----------------------
|
|
PumpSwapBuyEvent => |e: PumpSwapBuyEvent| {
|
|
println!("Buy event: {e:?}");
|
|
},
|
|
PumpSwapSellEvent => |e: PumpSwapSellEvent| {
|
|
println!("Sell event: {e:?}");
|
|
},
|
|
PumpSwapCreatePoolEvent => |e: PumpSwapCreatePoolEvent| {
|
|
println!("CreatePool event: {e:?}");
|
|
},
|
|
PumpSwapDepositEvent => |e: PumpSwapDepositEvent| {
|
|
println!("Deposit event: {e:?}");
|
|
},
|
|
PumpSwapWithdrawEvent => |e: PumpSwapWithdrawEvent| {
|
|
println!("Withdraw event: {e:?}");
|
|
},
|
|
// -------------------------- raydium_cpmm -----------------------
|
|
RaydiumCpmmSwapEvent => |e: RaydiumCpmmSwapEvent| {
|
|
println!("RaydiumCpmmSwapEvent: {e:?}");
|
|
},
|
|
RaydiumCpmmDepositEvent => |e: RaydiumCpmmDepositEvent| {
|
|
println!("RaydiumCpmmDepositEvent: {e:?}");
|
|
},
|
|
RaydiumCpmmInitializeEvent => |e: RaydiumCpmmInitializeEvent| {
|
|
println!("RaydiumCpmmInitializeEvent: {e:?}");
|
|
},
|
|
RaydiumCpmmWithdrawEvent => |e: RaydiumCpmmWithdrawEvent| {
|
|
println!("RaydiumCpmmWithdrawEvent: {e:?}");
|
|
},
|
|
// -------------------------- raydium_clmm -----------------------
|
|
RaydiumClmmSwapEvent => |e: RaydiumClmmSwapEvent| {
|
|
println!("RaydiumClmmSwapEvent: {e:?}");
|
|
},
|
|
RaydiumClmmSwapV2Event => |e: RaydiumClmmSwapV2Event| {
|
|
println!("RaydiumClmmSwapV2Event: {e:?}");
|
|
},
|
|
RaydiumClmmClosePositionEvent => |e: RaydiumClmmClosePositionEvent| {
|
|
println!("RaydiumClmmClosePositionEvent: {e:?}");
|
|
},
|
|
RaydiumClmmDecreaseLiquidityV2Event => |e: RaydiumClmmDecreaseLiquidityV2Event| {
|
|
println!("RaydiumClmmDecreaseLiquidityV2Event: {e:?}");
|
|
},
|
|
RaydiumClmmCreatePoolEvent => |e: RaydiumClmmCreatePoolEvent| {
|
|
println!("RaydiumClmmCreatePoolEvent: {e:?}");
|
|
},
|
|
RaydiumClmmIncreaseLiquidityV2Event => |e: RaydiumClmmIncreaseLiquidityV2Event| {
|
|
println!("RaydiumClmmIncreaseLiquidityV2Event: {e:?}");
|
|
},
|
|
RaydiumClmmOpenPositionWithToken22NftEvent => |e: RaydiumClmmOpenPositionWithToken22NftEvent| {
|
|
println!("RaydiumClmmOpenPositionWithToken22NftEvent: {e:?}");
|
|
},
|
|
RaydiumClmmOpenPositionV2Event => |e: RaydiumClmmOpenPositionV2Event| {
|
|
println!("RaydiumClmmOpenPositionV2Event: {e:?}");
|
|
},
|
|
// -------------------------- raydium_amm_v4 -----------------------
|
|
RaydiumAmmV4SwapEvent => |e: RaydiumAmmV4SwapEvent| {
|
|
println!("RaydiumAmmV4SwapEvent: {e:?}");
|
|
},
|
|
RaydiumAmmV4DepositEvent => |e: RaydiumAmmV4DepositEvent| {
|
|
println!("RaydiumAmmV4DepositEvent: {e:?}");
|
|
},
|
|
RaydiumAmmV4Initialize2Event => |e: RaydiumAmmV4Initialize2Event| {
|
|
println!("RaydiumAmmV4Initialize2Event: {e:?}");
|
|
},
|
|
RaydiumAmmV4WithdrawEvent => |e: RaydiumAmmV4WithdrawEvent| {
|
|
println!("RaydiumAmmV4WithdrawEvent: {e:?}");
|
|
},
|
|
RaydiumAmmV4WithdrawPnlEvent => |e: RaydiumAmmV4WithdrawPnlEvent| {
|
|
println!("RaydiumAmmV4WithdrawPnlEvent: {e:?}");
|
|
},
|
|
// -------------------------- account -----------------------
|
|
BonkPoolStateAccountEvent => |e: BonkPoolStateAccountEvent| {
|
|
println!("BonkPoolStateAccountEvent: {e:?}");
|
|
},
|
|
BonkGlobalConfigAccountEvent => |e: BonkGlobalConfigAccountEvent| {
|
|
println!("BonkGlobalConfigAccountEvent: {e:?}");
|
|
},
|
|
BonkPlatformConfigAccountEvent => |e: BonkPlatformConfigAccountEvent| {
|
|
println!("BonkPlatformConfigAccountEvent: {e:?}");
|
|
},
|
|
PumpSwapGlobalConfigAccountEvent => |e: PumpSwapGlobalConfigAccountEvent| {
|
|
println!("PumpSwapGlobalConfigAccountEvent: {e:?}");
|
|
},
|
|
PumpSwapPoolAccountEvent => |e: PumpSwapPoolAccountEvent| {
|
|
println!("PumpSwapPoolAccountEvent: {e:?}");
|
|
},
|
|
PumpFunBondingCurveAccountEvent => |e: PumpFunBondingCurveAccountEvent| {
|
|
println!("PumpFunBondingCurveAccountEvent: {e:?}");
|
|
},
|
|
PumpFunGlobalAccountEvent => |e: PumpFunGlobalAccountEvent| {
|
|
println!("PumpFunGlobalAccountEvent: {e:?}");
|
|
},
|
|
RaydiumAmmV4AmmInfoAccountEvent => |e: RaydiumAmmV4AmmInfoAccountEvent| {
|
|
println!("RaydiumAmmV4AmmInfoAccountEvent: {e:?}");
|
|
},
|
|
RaydiumClmmAmmConfigAccountEvent => |e: RaydiumClmmAmmConfigAccountEvent| {
|
|
println!("RaydiumClmmAmmConfigAccountEvent: {e:?}");
|
|
},
|
|
RaydiumClmmPoolStateAccountEvent => |e: RaydiumClmmPoolStateAccountEvent| {
|
|
println!("RaydiumClmmPoolStateAccountEvent: {e:?}");
|
|
},
|
|
RaydiumClmmTickArrayStateAccountEvent => |e: RaydiumClmmTickArrayStateAccountEvent| {
|
|
println!("RaydiumClmmTickArrayStateAccountEvent: {e:?}");
|
|
},
|
|
RaydiumCpmmAmmConfigAccountEvent => |e: RaydiumCpmmAmmConfigAccountEvent| {
|
|
println!("RaydiumCpmmAmmConfigAccountEvent: {e:?}");
|
|
},
|
|
RaydiumCpmmPoolStateAccountEvent => |e: RaydiumCpmmPoolStateAccountEvent| {
|
|
println!("RaydiumCpmmPoolStateAccountEvent: {e:?}");
|
|
},
|
|
});
|
|
}
|
|
}
|
|
```
|
|
|
|
### Event Filtering
|
|
|
|
The library supports flexible event filtering to reduce processing overhead and improve performance:
|
|
|
|
#### Basic Filtering
|
|
|
|
```rust
|
|
use solana_streamer_sdk::streaming::event_parser::common::{filter::EventTypeFilter, EventType};
|
|
|
|
// No filtering - receive all events
|
|
let event_type_filter = None;
|
|
|
|
// Filter specific event types - only receive PumpSwap buy/sell events
|
|
let event_type_filter = Some(EventTypeFilter {
|
|
include: vec![EventType::PumpSwapBuy, EventType::PumpSwapSell]
|
|
});
|
|
```
|
|
|
|
#### Performance Impact
|
|
|
|
Event filtering can provide significant performance improvements:
|
|
- **60-80% reduction** in unnecessary event processing
|
|
- **Lower memory usage** by filtering out irrelevant events
|
|
- **Reduced network bandwidth** in distributed setups
|
|
- **Better focus** on events that matter to your application
|
|
|
|
#### Filtering Examples by Use Case
|
|
|
|
**Trading Bot (Focus on Trade Events)**
|
|
```rust
|
|
let event_type_filter = Some(EventTypeFilter {
|
|
include: vec![
|
|
EventType::PumpSwapBuy,
|
|
EventType::PumpSwapSell,
|
|
EventType::PumpFunTrade,
|
|
EventType::RaydiumCpmmSwap,
|
|
EventType::RaydiumClmmSwap,
|
|
EventType::RaydiumAmmV4Swap,
|
|
......
|
|
]
|
|
});
|
|
```
|
|
|
|
**Pool Monitoring (Focus on Liquidity Events)**
|
|
```rust
|
|
let event_type_filter = Some(EventTypeFilter {
|
|
include: vec![
|
|
EventType::PumpSwapCreatePool,
|
|
EventType::PumpSwapDeposit,
|
|
EventType::PumpSwapWithdraw,
|
|
EventType::RaydiumCpmmInitialize,
|
|
EventType::RaydiumCpmmDeposit,
|
|
EventType::RaydiumCpmmWithdraw,
|
|
EventType::RaydiumClmmCreatePool,
|
|
......
|
|
]
|
|
});
|
|
```
|
|
|
|
## Dynamic Subscription Management
|
|
|
|
Update subscription filters at runtime without reconnecting to the stream.
|
|
|
|
```rust
|
|
// Update filters on existing subscription
|
|
grpc.update_subscription(
|
|
TransactionFilter {
|
|
account_include: vec!["new_program_id".to_string()],
|
|
account_exclude: vec![],
|
|
account_required: vec![],
|
|
},
|
|
AccountFilter {
|
|
account: vec![],
|
|
owner: vec![],
|
|
},
|
|
).await?;
|
|
```
|
|
|
|
- **No Reconnection**: Filter changes apply immediately without closing the stream
|
|
- **Atomic Updates**: Both transaction and account filters updated together
|
|
- **Single Subscription**: One active subscription per client instance
|
|
- **Compatible**: Works with both immediate and advanced subscription methods
|
|
|
|
Note: Multiple subscription attempts on the same client return an error.
|
|
|
|
## Supported Protocols
|
|
|
|
- **PumpFun**: Primary meme coin trading platform
|
|
- **PumpSwap**: PumpFun's swap protocol
|
|
- **Bonk**: Token launch platform (letsbonk.fun)
|
|
- **Raydium CPMM**: Raydium's Concentrated Pool Market Maker protocol
|
|
- **Raydium CLMM**: Raydium's Concentrated Liquidity Market Maker protocol
|
|
- **Raydium AMM V4**: Raydium's Automated Market Maker V4 protocol
|
|
|
|
## Event Streaming Services
|
|
|
|
- **Yellowstone gRPC**: High-performance Solana event streaming
|
|
- **ShredStream**: Alternative event streaming protocol
|
|
|
|
## Architecture Features
|
|
|
|
### Unified Event Interface
|
|
|
|
- **UnifiedEvent Trait**: All protocol events implement a common interface
|
|
- **Protocol Enum**: Easy identification of event sources
|
|
- **Event Factory**: Automatic event parsing and categorization
|
|
|
|
### Event Parsing System
|
|
|
|
- **Protocol-specific Parsers**: Dedicated parsers for each supported protocol
|
|
- **Event Factory**: Centralized event creation and parsing
|
|
- **Extensible Design**: Easy to add new protocols and event types
|
|
|
|
### Streaming Infrastructure
|
|
|
|
- **Yellowstone gRPC Client**: Optimized for Solana event streaming
|
|
- **ShredStream Client**: Alternative streaming implementation
|
|
- **Async Processing**: Non-blocking event handling
|
|
|
|
## Project Structure
|
|
|
|
```
|
|
src/
|
|
├── common/ # Common functionality and types
|
|
├── protos/ # Protocol buffer definitions
|
|
├── streaming/ # Event streaming system
|
|
│ ├── event_parser/ # Event parsing system
|
|
│ │ ├── common/ # Common event parsing tools
|
|
│ │ ├── core/ # Core parsing traits and interfaces
|
|
│ │ ├── protocols/# Protocol-specific parsers
|
|
│ │ │ ├── bonk/ # Bonk event parsing
|
|
│ │ │ ├── pumpfun/ # PumpFun event parsing
|
|
│ │ │ ├── pumpswap/ # PumpSwap event parsing
|
|
│ │ │ ├── raydium_amm_v4/ # Raydium AMM V4 event parsing
|
|
│ │ │ ├── raydium_cpmm/ # Raydium CPMM event parsing
|
|
│ │ │ └── raydium_clmm/ # Raydium CLMM event parsing
|
|
│ │ └── factory.rs # Parser factory
|
|
│ ├── shred_stream.rs # ShredStream client
|
|
│ ├── yellowstone_grpc.rs # Yellowstone gRPC client
|
|
│ └── yellowstone_sub_system.rs # Yellowstone subsystem
|
|
├── lib.rs # Main library file
|
|
└── main.rs # Example program
|
|
```
|
|
|
|
## License
|
|
|
|
MIT License
|
|
|
|
## Contact
|
|
|
|
- Project Repository: https://github.com/0xfnzero/solana-streamer
|
|
- Telegram Group: https://t.me/fnzero_group
|
|
|
|
## Performance Considerations
|
|
|
|
1. **Connection Management**: Properly handle connection lifecycle and reconnection
|
|
2. **Event Filtering**: Use protocol filtering to reduce unnecessary event processing
|
|
3. **Memory Management**: Implement appropriate cleanup for long-running streams
|
|
4. **Error Handling**: Robust error handling for network issues and service interruptions
|
|
5. **Batch Processing Optimization**: Use batch processing to reduce callback overhead and improve throughput
|
|
6. **Performance Monitoring**: Enable performance monitoring to identify bottlenecks and optimization opportunities
|
|
7. **Graceful Shutdown**: Use the stop() method for clean shutdown and implement signal handlers for proper resource cleanup
|
|
|
|
## Important Notes
|
|
|
|
1. **Network Stability**: Ensure stable network connection for continuous event streaming
|
|
2. **Rate Limiting**: Be aware of rate limits on public gRPC endpoints
|
|
3. **Error Recovery**: Implement proper error handling and reconnection logic
|
|
5. **Compliance**: Ensure compliance with relevant laws and regulations
|
|
|
|
## Language Versions
|
|
|
|
- [English](README.md)
|
|
- [中文](README_CN.md)
|