sim-cli 0.9.0

CLI tool for running and comparing Solana simulator backtests
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

use clap::Parser;
use eyre::Result;
use sim_cli::{ApiKeyArg, engine::format_slot};
use simulator_client::{BacktestClient, RangeBound, filter_ranges};

const SIZE_TOLERANCE: f64 = 0.1;

#[derive(Parser, Debug, Clone)]
pub struct RangesArgs {
    /// Only show ranges that start at or after this point.
    /// Accepts a slot number or a timestamp (RFC 3339 or YYYY-MM-DD).
    #[arg(long)]
    pub after: Option<String>,

    #[command(flatten)]
    pub api_key: Option<ApiKeyArg>,

    /// Only show ranges that end at or before this point.
    /// Accepts a slot number or a timestamp (RFC 3339 or YYYY-MM-DD).
    #[arg(long)]
    pub before: Option<String>,

    /// Only show ranges whose bundle size is within 10% of this value.
    #[arg(long)]
    pub size: Option<u64>,

    /// Print output as JSON
    #[arg(long)]
    pub json: bool,
}

pub async fn ranges(args: RangesArgs, url: String) -> Result<()> {
    let after: Option<RangeBound> = args.after.as_deref().map(str::parse).transpose()?;
    let before: Option<RangeBound> = args.before.as_deref().map(str::parse).transpose()?;

    let client_builder = BacktestClient::builder().url(url);
    let client = if let Some(api_key) = args.api_key.as_ref() {
        client_builder.api_key(api_key.get()).build()
    } else {
        client_builder.build()
    };
    let all = client.available_ranges().await?;
    let time_bound = filter_ranges(&all, after.as_ref(), before.as_ref());
    let matched: Vec<_> = match args.size {
        None => time_bound,
        Some(target) => time_bound
            .into_iter()
            .filter(|r| {
                r.max_bundle_size.is_some_and(|size| {
                    let delta = (size as f64 - target as f64).abs();
                    delta / target as f64 <= SIZE_TOLERANCE
                })
            })
            .collect(),
    };

    if matched.is_empty() {
        if args.json {
            println!("[]");
        } else {
            println!("No available ranges matching the given filters.");
        }
        return Ok(());
    }

    if args.json {
        println!("{}", serde_json::to_string_pretty(&matched)?);
        return Ok(());
    }

    println!(
        "\n{:<30} {:<30} {:<15} {:<15} Bundle Size",
        "Start Time (UTC)", "End Time (UTC)", "Start Slot", "End Slot"
    );
    println!("{}", "-".repeat(105));
    for range in &matched {
        let start_time = range.bundle_start_slot_utc.as_deref().unwrap_or("-");
        let end_time = range.max_bundle_end_slot_utc.as_deref().unwrap_or("-");
        let start_slot = format_slot(range.bundle_start_slot);
        let end_slot = range
            .max_bundle_end_slot
            .map(format_slot)
            .unwrap_or_else(|| "unbounded".to_string());
        let bundle_size = range.max_bundle_size;
        println!(
            "{start_time:<30} {end_time:<30} {start_slot:<15} {end_slot:<15} {}",
            bundle_size
                .map(format_slot)
                .unwrap_or_else(|| "unbounded".to_string()),
        );
    }

    Ok(())
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn api_key_is_optional_and_flows_when_given() {
        let args = RangesArgs::try_parse_from(["ranges", "--api-key", "k"]).unwrap();
        assert_eq!(
            args.api_key.as_ref().map(ApiKeyArg::get),
            Some("k".to_string())
        );
    }
}