qs-backtest-api 0.4.1

Provider-neutral request, response, event, and client contracts for the quant-system backtest service
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

use std::pin::Pin;

use async_trait::async_trait;
use futures::Stream;
use qs_service::TransportFailure;
use thiserror::Error;

use crate::{
    AddProfileRequest, AddProfileResponse, BacktestEvent, BacktestStatusResponse,
    CancelBacktestResponse, DeleteResultArtifactRequest, DeleteResultArtifactResponse,
    GetBacktestResultResponse, GetResultArtifactChunkRequest, GetResultArtifactChunkResponse,
    GetSearchResultResponse, ListProfilesResponse, ListSymbolsRequest, ListSymbolsResponse,
    PingResponse, ReloadProfilesResponse, RemoveProfileRequest, RemoveProfileResponse,
    RunBacktestMultiRequest, RunBacktestMultiResponse, RunBacktestRequest, RunBacktestResponse,
    RunConfiguredStrategyRequest, RunPortfolioRequest, SubmitBacktestRequest,
    SubmitBacktestResponse, SubmitConfiguredStrategyRequest, SubmitPortfolioRequest,
    SubmitSearchRequest,
};

pub type BacktestEventStream =
    Pin<Box<dyn Stream<Item = Result<BacktestEvent, BacktestClientError>> + Send>>;

/// Provider-neutral client port for the retained backtest-job workflow.
#[async_trait]
pub trait BacktestClient: Send + Sync {
    async fn ping(&self) -> Result<PingResponse, BacktestClientError>;
    async fn submit(
        &self,
        request: SubmitBacktestRequest,
    ) -> Result<SubmitBacktestResponse, BacktestClientError>;
    async fn status(&self, job_id: &str) -> Result<BacktestStatusResponse, BacktestClientError>;
    async fn watch(&self, job_id: &str) -> Result<BacktestEventStream, BacktestClientError>;
    async fn result(&self, job_id: &str) -> Result<GetBacktestResultResponse, BacktestClientError>;
    async fn get_result_artifact_chunk(
        &self,
        request: GetResultArtifactChunkRequest,
    ) -> Result<GetResultArtifactChunkResponse, BacktestClientError>;
    async fn delete_result_artifact(
        &self,
        request: DeleteResultArtifactRequest,
    ) -> Result<DeleteResultArtifactResponse, BacktestClientError>;
    async fn cancel(&self, job_id: &str) -> Result<CancelBacktestResponse, BacktestClientError>;
}

/// Provider-neutral client port for finite synchronous backtest execution.
#[async_trait]
pub trait BacktestSyncClient: Send + Sync {
    async fn run_backtest(
        &self,
        request: RunBacktestRequest,
    ) -> Result<RunBacktestResponse, BacktestClientError>;
    async fn run_backtest_multi(
        &self,
        request: RunBacktestMultiRequest,
    ) -> Result<RunBacktestMultiResponse, BacktestClientError>;
}

/// Provider-neutral client port for profile and market-data discovery.
#[async_trait]
pub trait BacktestDiscoveryClient: Send + Sync {
    async fn list_profiles(&self) -> Result<ListProfilesResponse, BacktestClientError>;
    async fn list_symbols(
        &self,
        request: ListSymbolsRequest,
    ) -> Result<ListSymbolsResponse, BacktestClientError>;
}

/// Provider-neutral client port for configured strategy runs, portfolio runs, and server-side parameter searches.
///
/// Submitted jobs share the retained-job workflow: status, watch, cancel, results, and artifacts go through [`BacktestClient`] with the returned job ID.
#[async_trait]
pub trait BacktestStrategyClient: Send + Sync {
    async fn run_configured_strategy(
        &self,
        request: RunConfiguredStrategyRequest,
    ) -> Result<RunBacktestResponse, BacktestClientError>;
    async fn submit_configured_strategy(
        &self,
        request: SubmitConfiguredStrategyRequest,
    ) -> Result<SubmitBacktestResponse, BacktestClientError>;
    async fn run_portfolio(
        &self,
        request: RunPortfolioRequest,
    ) -> Result<RunBacktestResponse, BacktestClientError>;
    async fn submit_portfolio(
        &self,
        request: SubmitPortfolioRequest,
    ) -> Result<SubmitBacktestResponse, BacktestClientError>;
    async fn submit_search(
        &self,
        request: SubmitSearchRequest,
    ) -> Result<SubmitBacktestResponse, BacktestClientError>;
    async fn search_result(
        &self,
        job_id: &str,
    ) -> Result<GetSearchResultResponse, BacktestClientError>;
}

/// Provider-neutral client port for runtime profile administration.
#[async_trait]
pub trait BacktestAdminClient: Send + Sync {
    async fn add_profile(
        &self,
        request: AddProfileRequest,
    ) -> Result<AddProfileResponse, BacktestClientError>;
    async fn remove_profile(
        &self,
        request: RemoveProfileRequest,
    ) -> Result<RemoveProfileResponse, BacktestClientError>;
    async fn reload_profiles(&self) -> Result<ReloadProfilesResponse, BacktestClientError>;
}

#[derive(Debug, Clone, Error)]
pub enum BacktestClientError {
    #[error("backtest service rejected the request: {0}")]
    Service(String),
    #[error(transparent)]
    Transport(#[from] TransportFailure),
    #[error(transparent)]
    Protocol(#[from] BacktestServiceProtocolError),
}

#[derive(Debug, Clone, Error)]
#[error("backtest service protocol failure: {detail}")]
pub struct BacktestServiceProtocolError {
    pub detail: String,
}