slotstrike 1.0.0

Low-latency Solana slotstrike runtime for event-driven token execution
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
use serde::Deserialize;
use std::path::PathBuf;
use thiserror::Error;

#[derive(Clone, Debug, Deserialize)]
pub struct SniperConfigFile {
    pub runtime: RuntimeConfigSection,
    #[serde(default)]
    pub sof: SofConfigSection,
    #[serde(default)]
    pub sof_tx: SofTxConfigSection,
    #[serde(default)]
    pub telemetry: TelemetryConfigSection,
    #[serde(default)]
    pub rules: Vec<RuleConfigEntry>,
}

#[derive(Clone, Debug, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct RuntimeConfigSection {
    pub keypair_path: String,
    pub rpc_url: String,
    pub wss_url: String,
    pub priority_fees: u64,
    #[serde(default)]
    pub dry_run: bool,
    #[serde(default = "default_tx_submission_mode")]
    pub tx_submission_mode: String,
    #[serde(default)]
    pub jito_url: Option<String>,
    #[serde(default)]
    pub replay_benchmark: bool,
    #[serde(default = "default_replay_event_count")]
    pub replay_event_count: usize,
    #[serde(default = "default_replay_burst_size")]
    pub replay_burst_size: usize,
}

#[derive(Clone, Debug, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct SofConfigSection {
    #[serde(default = "default_sof_enabled")]
    pub enabled: bool,
    #[serde(default = "default_sof_source")]
    pub source: String,
    #[serde(default)]
    pub websocket_url: Option<String>,
    #[serde(default)]
    pub grpc_url: Option<String>,
    #[serde(default)]
    pub grpc_x_token: Option<String>,
    #[serde(default)]
    pub private_shred_socket_path: Option<String>,
    #[serde(default = "default_sof_private_shred_source_addr")]
    pub private_shred_source_addr: String,
    #[serde(default)]
    pub trusted_private_shreds: bool,
    #[serde(default)]
    pub gossip_entrypoints: Vec<String>,
    #[serde(default)]
    pub gossip_validators: Vec<String>,
    #[serde(default = "default_sof_gossip_runtime_mode")]
    pub gossip_runtime_mode: String,
    #[serde(default = "default_sof_commitment")]
    pub commitment: String,
    #[serde(default = "default_sof_inline_transaction_dispatch")]
    pub inline_transaction_dispatch: bool,
    #[serde(default)]
    pub startup_step_logs: bool,
    #[serde(default)]
    pub worker_threads: Option<usize>,
    #[serde(default)]
    pub dataset_workers: Option<usize>,
    #[serde(default)]
    pub packet_workers: Option<usize>,
    #[serde(default)]
    pub ingest_queue_mode: Option<String>,
    #[serde(default)]
    pub ingest_queue_capacity: Option<usize>,
}

impl Default for SofConfigSection {
    fn default() -> Self {
        Self {
            enabled: default_sof_enabled(),
            source: default_sof_source(),
            websocket_url: None,
            grpc_url: None,
            grpc_x_token: None,
            private_shred_socket_path: None,
            private_shred_source_addr: default_sof_private_shred_source_addr(),
            trusted_private_shreds: false,
            gossip_entrypoints: Vec::new(),
            gossip_validators: Vec::new(),
            gossip_runtime_mode: default_sof_gossip_runtime_mode(),
            commitment: default_sof_commitment(),
            inline_transaction_dispatch: default_sof_inline_transaction_dispatch(),
            startup_step_logs: false,
            worker_threads: None,
            dataset_workers: None,
            packet_workers: None,
            ingest_queue_mode: None,
            ingest_queue_capacity: None,
        }
    }
}

#[derive(Clone, Debug, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct SofTxConfigSection {
    #[serde(default = "default_sof_tx_enabled")]
    pub enabled: bool,
    #[serde(default = "default_sof_tx_mode")]
    pub mode: String,
    #[serde(default = "default_sof_tx_strategy")]
    pub strategy: String,
    #[serde(default)]
    pub routes: Vec<String>,
    #[serde(default = "default_sof_tx_reliability")]
    pub reliability: String,
    #[serde(default = "default_sof_tx_jito_transport")]
    pub jito_transport: String,
    #[serde(default)]
    pub jito_endpoint: Option<String>,
    #[serde(default = "default_sof_tx_bundle_only")]
    pub bundle_only: bool,
    #[serde(default = "default_sof_tx_routing_next_leaders")]
    pub routing_next_leaders: usize,
    #[serde(default = "default_sof_tx_routing_backup_validators")]
    pub routing_backup_validators: usize,
    #[serde(default = "default_sof_tx_routing_max_parallel_sends")]
    pub routing_max_parallel_sends: usize,
    #[serde(default = "default_sof_tx_guard_require_stable_control_plane")]
    pub guard_require_stable_control_plane: bool,
    #[serde(default = "default_sof_tx_guard_reject_on_replay_recovery_pending")]
    pub guard_reject_on_replay_recovery_pending: bool,
    #[serde(default = "default_sof_tx_guard_max_state_version_drift")]
    pub guard_max_state_version_drift: u64,
    #[serde(default = "default_sof_tx_guard_max_opportunity_age_ms")]
    pub guard_max_opportunity_age_ms: u64,
    #[serde(default = "default_sof_tx_guard_suppression_ttl_ms")]
    pub guard_suppression_ttl_ms: u64,
}

impl Default for SofTxConfigSection {
    fn default() -> Self {
        Self {
            enabled: default_sof_tx_enabled(),
            mode: default_sof_tx_mode(),
            strategy: default_sof_tx_strategy(),
            routes: Vec::new(),
            reliability: default_sof_tx_reliability(),
            jito_transport: default_sof_tx_jito_transport(),
            jito_endpoint: None,
            bundle_only: default_sof_tx_bundle_only(),
            routing_next_leaders: default_sof_tx_routing_next_leaders(),
            routing_backup_validators: default_sof_tx_routing_backup_validators(),
            routing_max_parallel_sends: default_sof_tx_routing_max_parallel_sends(),
            guard_require_stable_control_plane: default_sof_tx_guard_require_stable_control_plane(),
            guard_reject_on_replay_recovery_pending:
                default_sof_tx_guard_reject_on_replay_recovery_pending(),
            guard_max_state_version_drift: default_sof_tx_guard_max_state_version_drift(),
            guard_max_opportunity_age_ms: default_sof_tx_guard_max_opportunity_age_ms(),
            guard_suppression_ttl_ms: default_sof_tx_guard_suppression_ttl_ms(),
        }
    }
}

#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq)]
#[serde(rename_all = "lowercase")]
pub enum RuleKind {
    Mint,
    Deployer,
}

#[derive(Clone, Debug, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct RuleConfigEntry {
    pub kind: RuleKind,
    pub address: String,
    pub snipe_height_sol: String,
    pub tip_budget_sol: String,
    pub slippage_pct: String,
}

#[derive(Clone, Debug, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct TelemetryConfigSection {
    #[serde(default = "default_telemetry_enabled")]
    pub enabled: bool,
    #[serde(default = "default_telemetry_sample_capacity")]
    pub sample_capacity: usize,
    #[serde(default = "default_telemetry_slo_ns")]
    pub slo_ns: u64,
    #[serde(default = "default_telemetry_report_period_secs")]
    pub report_period_secs: u64,
}

impl Default for TelemetryConfigSection {
    fn default() -> Self {
        Self {
            enabled: default_telemetry_enabled(),
            sample_capacity: default_telemetry_sample_capacity(),
            slo_ns: default_telemetry_slo_ns(),
            report_period_secs: default_telemetry_report_period_secs(),
        }
    }
}

#[derive(Debug, Error)]
pub enum ConfigError {
    #[error("failed to read config file at {path}")]
    ReadConfigFile {
        path: PathBuf,
        #[source]
        source: std::io::Error,
    },
    #[error("invalid slotstrike.toml format")]
    ParseToml {
        #[source]
        source: toml::de::Error,
    },
}

pub fn load_sniper_config_file(path: &str) -> Result<SniperConfigFile, ConfigError> {
    let config_text =
        std::fs::read_to_string(path).map_err(|source| ConfigError::ReadConfigFile {
            path: PathBuf::from(path),
            source,
        })?;
    parse_sniper_config_toml(&config_text)
}

pub fn parse_sniper_config_toml(config_text: &str) -> Result<SniperConfigFile, ConfigError> {
    toml::from_str::<SniperConfigFile>(config_text)
        .map_err(|source| ConfigError::ParseToml { source })
}

fn default_tx_submission_mode() -> String {
    "jito".to_owned()
}

const fn default_sof_enabled() -> bool {
    true
}

fn default_sof_source() -> String {
    "websocket".to_owned()
}

fn default_sof_private_shred_source_addr() -> String {
    "127.0.0.1:8899".to_owned()
}

fn default_sof_commitment() -> String {
    "processed".to_owned()
}

fn default_sof_gossip_runtime_mode() -> String {
    "control_plane_only".to_owned()
}

const fn default_sof_inline_transaction_dispatch() -> bool {
    true
}

const fn default_sof_tx_enabled() -> bool {
    true
}

fn default_sof_tx_mode() -> String {
    "jito".to_owned()
}

fn default_sof_tx_strategy() -> String {
    "ordered_fallback".to_owned()
}

fn default_sof_tx_reliability() -> String {
    "balanced".to_owned()
}

fn default_sof_tx_jito_transport() -> String {
    "json_rpc".to_owned()
}

const fn default_sof_tx_bundle_only() -> bool {
    true
}

const fn default_sof_tx_routing_next_leaders() -> usize {
    2
}

const fn default_sof_tx_routing_backup_validators() -> usize {
    1
}

const fn default_sof_tx_routing_max_parallel_sends() -> usize {
    4
}

const fn default_sof_tx_guard_require_stable_control_plane() -> bool {
    true
}

const fn default_sof_tx_guard_reject_on_replay_recovery_pending() -> bool {
    true
}

const fn default_sof_tx_guard_max_state_version_drift() -> u64 {
    4
}

const fn default_sof_tx_guard_max_opportunity_age_ms() -> u64 {
    750
}

const fn default_sof_tx_guard_suppression_ttl_ms() -> u64 {
    750
}

const fn default_replay_event_count() -> usize {
    50_000
}

const fn default_replay_burst_size() -> usize {
    512
}

const fn default_telemetry_sample_capacity() -> usize {
    4_096
}

const fn default_telemetry_enabled() -> bool {
    true
}

const fn default_telemetry_slo_ns() -> u64 {
    1_000_000
}

const fn default_telemetry_report_period_secs() -> u64 {
    15
}

#[cfg(test)]
mod tests {
    use super::{RuleKind, parse_sniper_config_toml};

    #[test]
    fn parses_runtime_and_rules_from_toml() {
        let config = parse_sniper_config_toml(
            r#"
[runtime]
keypair_path = "keypair.json"
rpc_url = "https://rpc.example"
wss_url = "wss://wss.example"
priority_fees = 1000
dry_run = true
tx_submission_mode = "direct"
jito_url = "https://jito.example"
replay_benchmark = false
replay_event_count = 50000
replay_burst_size = 512

[telemetry]
enabled = true
sample_capacity = 1024
slo_ns = 500000
report_period_secs = 5

[[rules]]
kind = "mint"
address = "So11111111111111111111111111111111111111112"
snipe_height_sol = "0.01"
tip_budget_sol = "0.001"
slippage_pct = "1"
"#,
        );

        assert!(config.is_ok());
        if let Ok(config) = config {
            assert_eq!(config.runtime.priority_fees, 1_000);
            assert!(config.runtime.dry_run);
            assert!(config.telemetry.enabled);
            assert_eq!(config.telemetry.sample_capacity, 1_024);
            assert_eq!(config.rules.len(), 1);
            if let Some(rule) = config.rules.first() {
                assert_eq!(rule.kind, RuleKind::Mint);
            }
        }
    }

    #[test]
    fn telemetry_enabled_defaults_to_true() {
        let config = parse_sniper_config_toml(
            r#"
[runtime]
keypair_path = "keypair.json"
rpc_url = "https://rpc.example"
wss_url = "wss://wss.example"
priority_fees = 1000
tx_submission_mode = "direct"
replay_benchmark = false
replay_event_count = 50000
replay_burst_size = 512
"#,
        );

        assert!(config.is_ok());
        if let Ok(config) = config {
            assert!(!config.runtime.dry_run);
            assert!(config.telemetry.enabled);
        }
    }

    #[test]
    fn rejects_legacy_runtime_fields() {
        let config = parse_sniper_config_toml(
            r#"
[runtime]
keypair_path = "keypair.json"
rpc_url = "https://rpc.example"
wss_url = "wss://wss.example"
priority_fees = 1000
tx_submission_mode = "direct"
kernel_tcp_bypass = true
replay_benchmark = false
replay_event_count = 50000
replay_burst_size = 512
"#,
        );

        assert!(config.is_err());
    }
}