solana-streamer-sdk 3.0.5

A low-latency Solana DEX event streaming facade over sol-parser-sdk with Yellowstone gRPC, ShredStream, and RPC parsing helpers.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
use crate::common::AnyResult;
use crate::streaming::common::MetricsEventType;
use crate::streaming::event_parser::common::filter::{
    build_sdk_parse_event_filter, build_sdk_shred_parse_event_filter, passes_event_type_filter,
    transaction_cost_selection, EventTypeFilter,
};
use crate::streaming::event_parser::common::high_performance_clock::elapsed_micros_since;
use crate::streaming::event_parser::core::common_event_parser::CommonEventParser;
use crate::streaming::event_parser::core::transaction_cost_event::TransactionCostEvent;
use crate::streaming::event_parser::{core::traits::DexEvent, Protocol};
use crate::streaming::grpc::{EventPretty, MetricsManager};
use crate::streaming::parser_sdk_bridge::{
    adapt_parser_event, adapt_parser_events_list, parse_account_event_for_streamer,
    AccountParseResult,
};
use crate::streaming::shred::TransactionWithSlot;
use sol_parser_sdk::grpc::parse_subscribe_update_transaction_low_latency;
use solana_sdk::pubkey::Pubkey;
use solana_sdk::signature::Signature;
use solana_sdk::transaction::VersionedTransaction;
use std::cell::RefCell;
use std::sync::Arc;
use yellowstone_grpc_proto::geyser::SubscribeUpdateTransaction;

thread_local! {
    static SHRED_SDK_EVENTS: RefCell<Vec<sol_parser_sdk::DexEvent>> =
        RefCell::new(Vec::with_capacity(4));
}

/// Wrap the user callback and update transaction metrics after delivery.
#[inline]
fn create_metrics_callback(
    callback: Arc<dyn Fn(DexEvent) + Send + Sync>,
) -> Arc<dyn Fn(DexEvent) + Send + Sync> {
    Arc::new(move |event: DexEvent| {
        let metadata = event.metadata();
        let processing_time_us = metadata.handle_us as f64;
        let recv_us = metadata.recv_us;
        let block_time_ms = metadata.block_time_ms;

        callback(event);

        update_metrics_with_latency(
            MetricsEventType::Transaction,
            1,
            processing_time_us,
            recv_us,
            block_time_ms,
        );
    })
}

#[inline]
pub fn transaction_metrics_callback(
    callback: Arc<dyn Fn(DexEvent) + Send + Sync>,
) -> Arc<dyn Fn(DexEvent) + Send + Sync> {
    create_metrics_callback(callback)
}

pub fn parse_grpc_transaction_events(
    transaction_pretty: crate::streaming::grpc::TransactionPretty,
    protocols: &[Protocol],
    event_type_filter: Option<&EventTypeFilter>,
    bot_wallet: Option<Pubkey>,
) -> Vec<DexEvent> {
    MetricsManager::global().add_tx_process_count();

    let slot = transaction_pretty.slot;
    let block_time = transaction_pretty.block_time;
    let recv_us = transaction_pretty.recv_us;
    let grpc_tx = transaction_pretty.grpc_tx;
    let block_time_us = block_time.map(|t| t.seconds * 1_000_000 + t.nanos as i64 / 1_000);
    let cost_selection = transaction_cost_selection(event_type_filter);
    let transaction_cost = cost_selection
        .requested
        .then(|| {
            let transaction = grpc_tx.transaction.as_ref()?;
            let meta = grpc_tx.meta.as_ref()?;
            sol_parser_sdk::parse_yellowstone_transaction_cost(transaction, meta)
        })
        .flatten();
    let mut events = if cost_selection.only {
        Vec::with_capacity(1)
    } else {
        let update = SubscribeUpdateTransaction { slot, transaction: Some(grpc_tx) };
        let sdk_parse_filter = build_sdk_parse_event_filter(event_type_filter);
        let sdk_events = parse_subscribe_update_transaction_low_latency(
            &update,
            recv_us,
            block_time_us,
            sdk_parse_filter.as_ref(),
        );
        adapt_parser_events_list(
            sdk_events,
            block_time.as_ref(),
            recv_us,
            protocols,
            event_type_filter,
        )
    };

    if let Some(cost) = transaction_cost {
        events.push(DexEvent::TransactionCostEvent(TransactionCostEvent::from_parser(
            cost,
            transaction_pretty.signature,
            slot,
            transaction_pretty.tx_index,
            block_time_us,
            recv_us,
            None,
        )));
    }

    for event in events.iter_mut() {
        event.metadata_mut().handle_us = elapsed_micros_since(recv_us);
    }

    events
        .into_iter()
        .map(|event| {
            crate::streaming::event_parser::core::event_parser::helpers::process_event(
                event, bot_wallet,
            )
        })
        .collect()
}

/// Process GRPC transaction events
pub async fn process_grpc_transaction(
    event_pretty: EventPretty,
    protocols: &[Protocol],
    event_type_filter: Option<&EventTypeFilter>,
    callback: Arc<dyn Fn(DexEvent) + Send + Sync>,
    bot_wallet: Option<Pubkey>,
) -> AnyResult<()> {
    match event_pretty {
        EventPretty::Account(account_pretty) => {
            MetricsManager::global().add_account_process_count();

            match parse_account_event_for_streamer(&account_pretty, protocols, event_type_filter) {
                AccountParseResult::Event(mut event) => {
                    event.metadata_mut().handle_us = elapsed_micros_since(account_pretty.recv_us);
                    let processing_time_us = event.metadata().handle_us as f64;
                    callback(*event);
                    update_metrics(MetricsEventType::Account, 1, processing_time_us);
                    return Ok(());
                }
                AccountParseResult::Filtered => return Ok(()),
                AccountParseResult::Unsupported => return Ok(()),
            }
        }
        EventPretty::Transaction(transaction_pretty) => {
            let callback = transaction_metrics_callback(callback);
            for event in parse_grpc_transaction_events(
                transaction_pretty,
                protocols,
                event_type_filter,
                bot_wallet,
            ) {
                callback(event);
            }
        }
        EventPretty::BlockMeta(block_meta_pretty) => {
            MetricsManager::global().add_block_meta_process_count();

            let block_time_ms = block_meta_pretty
                .block_time
                .map(|ts| ts.seconds * 1000 + ts.nanos as i64 / 1_000_000)
                .unwrap_or_else(|| {
                    std::time::SystemTime::now()
                        .duration_since(std::time::UNIX_EPOCH)
                        .unwrap()
                        .as_millis() as i64
                });

            let block_meta_event = CommonEventParser::generate_block_meta_event(
                block_meta_pretty.slot,
                block_meta_pretty.block_hash,
                block_time_ms,
                block_meta_pretty.recv_us,
            );

            if !passes_event_type_filter(event_type_filter, &block_meta_event) {
                return Ok(());
            }

            let processing_time_us = block_meta_event.metadata().handle_us as f64;
            callback(block_meta_event);
            update_metrics(MetricsEventType::BlockMeta, 1, processing_time_us);
        }
    }

    Ok(())
}

/// Process Shred transaction events
pub async fn process_shred_transaction(
    transaction_with_slot: TransactionWithSlot,
    protocols: &[Protocol],
    event_type_filter: Option<&EventTypeFilter>,
    callback: Arc<dyn Fn(DexEvent) + Send + Sync>,
    bot_wallet: Option<Pubkey>,
) -> AnyResult<()> {
    MetricsManager::global().add_tx_process_count();

    let tx = transaction_with_slot.transaction;
    let slot = transaction_with_slot.slot;
    let tx_index = transaction_with_slot.tx_index;

    if tx.signatures.is_empty() {
        return Ok(());
    }

    let signature = tx.signatures[0];
    let recv_us = transaction_with_slot.recv_us;

    let adapter_callback = create_metrics_callback(callback);
    parse_shred_transaction_events(
        &tx,
        signature,
        slot,
        tx_index,
        recv_us,
        protocols,
        event_type_filter,
        bot_wallet,
        |event| adapter_callback(event),
    );

    Ok(())
}

#[allow(clippy::too_many_arguments)]
pub(crate) fn parse_shred_transaction_events(
    tx: &VersionedTransaction,
    signature: Signature,
    slot: u64,
    tx_index: Option<u64>,
    recv_us: i64,
    protocols: &[Protocol],
    event_type_filter: Option<&EventTypeFilter>,
    bot_wallet: Option<Pubkey>,
    mut on_event: impl FnMut(DexEvent),
) {
    if tx.sanitize().is_err() {
        log::debug!("Ignoring unsanitized ShredStream transaction");
        return;
    }

    let cost_selection = transaction_cost_selection(event_type_filter);
    if cost_selection.requested {
        let cost = sol_parser_sdk::parse_shred_transaction_cost(tx);
        let recent_blockhash = Some(tx.message.recent_blockhash().to_string());
        let mut event = DexEvent::TransactionCostEvent(TransactionCostEvent::from_parser(
            cost,
            signature,
            slot,
            tx_index,
            None,
            recv_us,
            recent_blockhash,
        ));
        event.metadata_mut().handle_us = elapsed_micros_since(recv_us);
        on_event(event);
    }

    if cost_selection.only {
        return;
    }

    let sdk_parse_filter = build_sdk_shred_parse_event_filter(protocols, event_type_filter);

    SHRED_SDK_EVENTS.with(|slot_events| {
        let mut events = {
            let mut slot_events = slot_events.borrow_mut();
            std::mem::take(&mut *slot_events)
        };
        events.clear();
        sol_parser_sdk::shredstream::parse_transaction_dex_events_with_filter(
            tx,
            signature,
            slot,
            tx_index.unwrap_or(0),
            recv_us,
            sdk_parse_filter.as_ref(),
            &mut events,
        );

        for sdk_event in events.drain(..) {
            if let Some(mut event) =
                adapt_parser_event(sdk_event, None, recv_us, protocols, event_type_filter)
            {
                event.metadata_mut().tx_index = tx_index;
                event.metadata_mut().handle_us = elapsed_micros_since(recv_us);
                event = crate::streaming::event_parser::core::event_parser::helpers::process_event(
                    event, bot_wallet,
                );
                on_event(event);
            }
        }

        *slot_events.borrow_mut() = events;
    });
}

/// Update metrics for event processing (with optional latency check)
#[inline]
fn update_metrics(ty: MetricsEventType, count: u64, time_us: f64) {
    MetricsManager::global().update_metrics(ty, count, time_us);
}

/// Update metrics with latency check
#[inline]
fn update_metrics_with_latency(
    ty: MetricsEventType,
    count: u64,
    time_us: f64,
    recv_us: i64,
    block_time_ms: i64,
) {
    MetricsManager::global().update_metrics_with_latency(
        ty,
        count,
        time_us,
        recv_us,
        block_time_ms,
    );
}

#[cfg(test)]
mod tests {
    use super::{parse_grpc_transaction_events, process_shred_transaction};
    use crate::streaming::event_parser::common::filter::EventTypeFilter;
    use crate::streaming::event_parser::common::EventType;
    use crate::streaming::event_parser::{DexEvent, Protocol};
    use crate::streaming::grpc::TransactionPretty;
    use crate::streaming::shred::TransactionWithSlot;
    use sol_parser_sdk::{
        instr::program_ids::PUMPFUN_PROGRAM_ID,
        transaction_cost::{GLAIVE_TIP_ACCOUNTS, JITO_TIP_ACCOUNTS},
        SwqosProvider,
    };
    use solana_sdk::hash::Hash;
    use solana_sdk::message::{
        compiled_instruction::CompiledInstruction, v0, MessageHeader, VersionedMessage,
    };
    use solana_sdk::pubkey::Pubkey;
    use solana_sdk::signature::Signature;
    use solana_sdk::transaction::VersionedTransaction;
    use std::sync::{Arc, Mutex};
    use yellowstone_grpc_proto::prelude::{
        CompiledInstruction as GrpcInstruction, Message, Transaction, TransactionStatusMeta,
    };

    fn push_string(data: &mut Vec<u8>, value: &str) {
        data.extend_from_slice(&(value.len() as u32).to_le_bytes());
        data.extend_from_slice(value.as_bytes());
    }

    fn pumpfun_create_data() -> Vec<u8> {
        let mut data = Vec::new();
        data.extend_from_slice(&[24, 30, 200, 40, 5, 28, 7, 119]);
        push_string(&mut data, "Index Test");
        push_string(&mut data, "IDX");
        push_string(&mut data, "https://example.invalid/index.json");
        data.extend_from_slice(Pubkey::new_unique().as_ref());
        data
    }

    fn pumpfun_create_tx() -> VersionedTransaction {
        let mut account_keys = (0..10).map(|_| Pubkey::new_unique()).collect::<Vec<_>>();
        account_keys.push(PUMPFUN_PROGRAM_ID);

        VersionedTransaction {
            signatures: vec![Signature::default()],
            message: VersionedMessage::V0(v0::Message {
                header: MessageHeader {
                    num_required_signatures: 1,
                    num_readonly_signed_accounts: 0,
                    num_readonly_unsigned_accounts: 1,
                },
                account_keys,
                recent_blockhash: Hash::default(),
                instructions: vec![CompiledInstruction::new_from_raw_parts(
                    10,
                    pumpfun_create_data(),
                    (0..10).collect(),
                )],
                address_table_lookups: Vec::new(),
            }),
        }
    }

    fn transfer(lamports: u64) -> Vec<u8> {
        let mut data = 2u32.to_le_bytes().to_vec();
        data.extend_from_slice(&lamports.to_le_bytes());
        data
    }

    fn cost_only_shred_tx() -> VersionedTransaction {
        let source = Pubkey::new_unique();
        let system_program: Pubkey = "11111111111111111111111111111111".parse().unwrap();
        VersionedTransaction {
            signatures: vec![Signature::default()],
            message: VersionedMessage::V0(v0::Message {
                header: MessageHeader {
                    num_required_signatures: 1,
                    num_readonly_signed_accounts: 0,
                    num_readonly_unsigned_accounts: 1,
                },
                account_keys: vec![
                    source,
                    JITO_TIP_ACCOUNTS[0],
                    GLAIVE_TIP_ACCOUNTS[0],
                    system_program,
                ],
                recent_blockhash: Hash::default(),
                instructions: vec![
                    CompiledInstruction::new_from_raw_parts(3, transfer(10), vec![0, 1]),
                    CompiledInstruction::new_from_raw_parts(3, transfer(20), vec![0, 2]),
                ],
                address_table_lookups: Vec::new(),
            }),
        }
    }

    fn yellowstone_cost_transaction() -> TransactionPretty {
        let source = Pubkey::new_unique();
        let system_program: Pubkey = "11111111111111111111111111111111".parse().unwrap();
        TransactionPretty {
            slot: 42,
            tx_index: Some(7),
            signature: Signature::default(),
            recv_us: 1_000_000,
            grpc_tx: yellowstone_grpc_proto::geyser::SubscribeUpdateTransactionInfo {
                signature: Signature::default().as_ref().to_vec(),
                is_vote: false,
                transaction: Some(Transaction {
                    signatures: vec![Signature::default().as_ref().to_vec()],
                    message: Some(Message {
                        account_keys: [source, system_program, JITO_TIP_ACCOUNTS[0]]
                            .iter()
                            .map(|key| key.to_bytes().to_vec())
                            .collect(),
                        instructions: vec![GrpcInstruction {
                            program_id_index: 1,
                            accounts: vec![0, 2],
                            data: transfer(50),
                        }],
                        ..Default::default()
                    }),
                }),
                meta: Some(TransactionStatusMeta { fee: 5_000, ..Default::default() }),
                index: 7,
            },
            ..Default::default()
        }
    }

    async fn parse_single_shred_create(tx_index: Option<u64>) -> DexEvent {
        let events = Arc::new(Mutex::new(Vec::new()));
        let captured = events.clone();
        let callback = Arc::new(move |event| {
            captured.lock().unwrap().push(event);
        });

        process_shred_transaction(
            TransactionWithSlot::new(pumpfun_create_tx(), 42, 1_000_000, tx_index),
            &[Protocol::PumpFun],
            None,
            callback,
            None,
        )
        .await
        .expect("process shred transaction");

        let mut events = events.lock().unwrap();
        assert_eq!(events.len(), 1);
        events.pop().unwrap()
    }

    #[tokio::test]
    async fn shred_transaction_preserves_unknown_tx_index() {
        let event = parse_single_shred_create(None).await;

        assert!(matches!(event, DexEvent::PumpFunCreateTokenEvent(_)));
        assert_eq!(event.metadata().tx_index, None);
    }

    #[tokio::test]
    async fn shred_transaction_preserves_present_tx_index() {
        let event = parse_single_shred_create(Some(42)).await;

        assert!(matches!(event, DexEvent::PumpFunCreateTokenEvent(_)));
        assert_eq!(event.metadata().tx_index, Some(42));
    }

    #[tokio::test]
    async fn shred_cost_parsing_is_opt_in_and_provider_aware() {
        let events = Arc::new(Mutex::new(Vec::new()));
        let captured = events.clone();
        let callback = Arc::new(move |event| captured.lock().unwrap().push(event));
        let filter = EventTypeFilter::include_only([EventType::TransactionCost]);

        process_shred_transaction(
            TransactionWithSlot::new(cost_only_shred_tx(), 42, 1_000_000, Some(7)),
            &[],
            Some(&filter),
            callback,
            None,
        )
        .await
        .expect("process cost transaction");

        let events = events.lock().unwrap();
        assert_eq!(events.len(), 1);
        let DexEvent::TransactionCostEvent(cost) = &events[0] else {
            panic!("expected transaction cost event");
        };
        assert_eq!(cost.tip_lamports, 30);
        assert_eq!(cost.tip_lamports_for(SwqosProvider::Jito), 10);
        assert_eq!(cost.tip_lamports_for(SwqosProvider::Glaive), 20);
        assert!(!cost.tip_payments_confirmed);
        assert_eq!(cost.metadata.tx_index, Some(7));
    }

    #[tokio::test]
    async fn shred_transaction_rejects_unsanitized_message() {
        let mut transaction = pumpfun_create_tx();
        let VersionedMessage::V0(message) = &mut transaction.message else {
            panic!("expected V0 fixture");
        };
        message.instructions[0].program_id_index = u8::MAX;
        let events = Arc::new(Mutex::new(Vec::new()));
        let captured = events.clone();

        process_shred_transaction(
            TransactionWithSlot::new(transaction, 42, 1_000_000, Some(0)),
            &[Protocol::PumpFun],
            None,
            Arc::new(move |event| captured.lock().unwrap().push(event)),
            None,
        )
        .await
        .expect("reject malformed Shred transaction");

        assert!(events.lock().unwrap().is_empty());
    }

    #[test]
    fn yellowstone_cost_parsing_is_opt_in() {
        let without_cost =
            parse_grpc_transaction_events(yellowstone_cost_transaction(), &[], None, None);
        assert!(without_cost.is_empty());

        let filter = EventTypeFilter::include_only([EventType::TransactionCost]);
        let with_cost =
            parse_grpc_transaction_events(yellowstone_cost_transaction(), &[], Some(&filter), None);
        assert_eq!(with_cost.len(), 1);
        let DexEvent::TransactionCostEvent(cost) = &with_cost[0] else {
            panic!("expected transaction cost event");
        };
        assert_eq!(cost.transaction_fee_lamports, Some(5_000));
        assert_eq!(cost.tip_lamports, 50);
        assert!(cost.tip_payments_confirmed);
        assert_eq!(cost.metadata.tx_index, Some(7));
    }
}