Skip to content

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.

License

Notifications You must be signed in to change notification settings

0xfnzero/solana-streamer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

🌊 Solana Streamer

Real-time event streaming from Solana DEX trading programs.

A lightweight Rust library providing efficient event parsing and subscription capabilities for PumpFun, PumpSwap, Bonk, and Raydium protocols.

Crates.io Documentation License GitHub stars GitHub forks

Rust Solana Real-time Streaming gRPC

δΈ­ζ–‡ | English | Website | Telegram | Discord


Table of Contents

πŸš€ Project Features

Core Capabilities

  • Real-time Event Streaming: Subscribe to live trading events from multiple Solana DEX protocols
  • Yellowstone gRPC Support: High-performance event subscription using Yellowstone gRPC
  • ShredStream Support: Alternative event streaming using ShredStream protocol
  • Unified Event Interface: Consistent event handling across all supported protocols

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

Advanced Features

  • Event Parsing System: Automatic parsing and categorization of protocol-specific events
  • Account State Monitoring: Real-time monitoring of protocol account states and configuration changes
  • Transaction & Account Event Filtering: Separate filtering for transaction events and account state changes
  • Dynamic Subscription Management: Runtime filter updates without reconnection, enabling adaptive monitoring strategies
  • Multi-Filter Support: Support for multiple transaction and account filters in a single subscription
  • Advanced Account Filtering: Memcmp filters for precise account data matching and monitoring
  • Token2022 Support: Enhanced support for SPL Token 2022 with extended state parsing

Performance & Optimization

  • High Performance: Optimized for low-latency event processing
  • Batch Processing Optimization: Batch processing events to reduce callback overhead
  • Performance Monitoring: Built-in performance metrics monitoring, including event processing speed
  • Memory Optimization: Object pooling and caching mechanisms to reduce memory allocations
  • Flexible Configuration System: Support for custom batch sizes, backpressure strategies, channel sizes
  • Preset Configurations: High-throughput and low-latency preset configurations optimized for different use cases
  • Backpressure Handling: Supports blocking and dropping backpressure strategies
  • Runtime Configuration Updates: Dynamic configuration parameter updates at runtime
  • Graceful Shutdown: Support for programmatic stop() method for clean shutdown

⚑ Installation

Direct Clone

Clone this project to your project directory:

cd your_project_root_directory
git clone https://github.com/0xfnzero/solana-streamer

Add the dependency to your Cargo.toml:

# Add to your Cargo.toml
solana-streamer-sdk = { path = "./solana-streamer", version = "0.4.12" }

Use crates.io

# Add to your Cargo.toml
solana-streamer-sdk = "0.4.12"

βš™οΈ 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:

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:

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:

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

Usage Examples Summary Table

Description Run Command Source Path
Monitor transaction events using Yellowstone gRPC cargo run --example grpc_example examples/grpc_example.rs
Monitor transaction events using ShredStream cargo run --example shred_example examples/shred_example.rs
Parse Solana mainnet transaction data cargo run --example parse_tx_events examples/parse_tx_events.rs
Update filters at runtime cargo run --example dynamic_subscription examples/dynamic_subscription.rs
Monitor specific token account balance changes cargo run --example token_balance_listen_example examples/token_balance_listen_example.rs
Track nonce account state changes cargo run --example nonce_listen_example examples/nonce_listen_example.rs
Monitor PumpSwap pool accounts using memcmp filters cargo run --example pumpswap_pool_account_listen_example examples/pumpswap_pool_account_listen_example.rs
Monitor all associated token accounts for specific mints using memcmp filters cargo run --example mint_all_ata_account_listen_example examples/mint_all_ata_account_listen_example.rs

Event Filtering

The library supports flexible event filtering to reduce processing overhead and improve performance:

Basic Filtering

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)

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)

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.

// Update filters on existing subscription
grpc.update_subscription(
    vec![TransactionFilter {
        account_include: vec!["new_program_id".to_string()],
        account_exclude: vec![],
        account_required: vec![],
    }],
    vec![AccountFilter {
        account: vec![],
        owner: vec![],
        filters: 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

⚑ 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

πŸ“„ License

MIT License

πŸ“ž Contact

⚠️ 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
  4. Compliance: Ensure compliance with relevant laws and regulations

Language Versions

About

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.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages