openoutcry 0.6.1

OpenOutcry — leak-free point-in-time trading-agent environment (a Gym for trading agents).
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

//! # OpenOutcry — the trading-agent environment
//!
//! A leak-free, point-in-time market environment with a dead-simple, language-agnostic
//! agent contract: **the harness sends an [`MarketObservation`], the agent returns a
//! [`Decision`], repeat.** Look-ahead is structurally impossible — [`Dataset`] never hands
//! out a future bar — and trajectories are recompute-from-raw-decisions, so an agent cannot
//! lie about its returns.
//!
//! ## M0 — extraction scaffold
//!
//! This crate currently *re-exports* the point-in-time simulator that already lives in
//! `sharpebench-sim`, promoting it from "the benchmark's internal engine" to a standalone
//! environment whose public reason to exist is "run an agent in a market." The Gym-style
//! [`reset`]/[`step`] lifecycle, the frozen `CONTRACT_VERSION`, the WASM/npm + Python
//! surfaces, and the ecosystem wiring land in later milestones (see
//! `specs/SPEC-trading-agent-env.md`). v0.1 depends on `sharpebench-sim`; the `gl-sim-core`
//! extraction is a follow-up refactor, not a blocker.
//!
//! [`reset`]: https://gymnasium.farama.org
//! [`step`]: https://gymnasium.farama.org
#![forbid(unsafe_code)]

// --- The frozen wire-contract version (the standard OpenOutcry governs) --------------------

pub mod contract;
pub use contract::CONTRACT_VERSION;

// --- Seeded procedural scenario generation (Procgen-style seed intervals) ------------------

pub mod scenario_gen;
pub use scenario_gen::{
    generate_scenario, level_seed, train_test_split, DistributionMode, ScenarioSpec,
};

// --- Vectorized, batched environment (gym3's "vectorized-first" design) -------------------

pub mod vec_env;
pub use vec_env::{BatchStep, LaneConfig, VecTradingEnv};

// --- Per-scenario trading mandates (MiniGrid Fetch-style per-episode objective) -----------

pub mod mandate;
pub use mandate::{mandate_breach, sample_mandate, Mandate, MandateStyle};

// --- Execution-noise perturbation (seeded sticky-actions / slippage; ALE-style) -----------

pub mod exec_noise;
pub use exec_noise::{perturb as perturb_action, ExecNoise};

// --- Limit-order-book matching engine (M3) -------------------------------------------------

pub mod lob_market;
pub use lob_market::{Fill, LadderSnapshot, OrderBook, OrderKind, RestingOrder, Side};

// --- Endogenous price-impact shared-book market (M2) ---------------------------------------

pub mod market;
pub use market::{clear_bar, AgentFill, ClearResult, MarketClearing, MarketParams};

// --- Point-in-time simulator surface (extraction from `sharpebench-sim`) ------------------

pub use sharpebench_sim::{
    // Trajectory capture + replay-recompute (the tamper-evidence path).
    replay_run,
    replay_submission,
    // The single-backtest engine + its window type.
    run_backtest,
    run_backtest_capture,
    // Walk-forward out-of-sample windows + regime tagging.
    tag_regime,
    walk_forward,
    // In-process reference/baseline agents + the trait they implement.
    Agent,
    BuyAndHold,
    // Leak-free data model + execution cost model.
    CostModel,
    CostProfile,
    Dataset,
    // O(1) env state snapshot (clone_state / restore_state) — sharpebench-sim 0.0.8.
    EnvState,
    // External transports — a conforming agent is just a program that reads observations
    // (stdin / `POST /decide`) and writes decisions.
    ExternalAgent,
    HoldAgent,
    HttpAgent,
    Momentum,
    RandomAgent,
    Regime,
    // The Gym-style open-loop environment: `reset()` / `step()` over the same engine,
    // plus the named crisis-suite/scenario bundle.
    Scenario,
    StepInfo,
    StepResult,
    TeamAgent,
    TradingEnv,
    Window,
};

// --- The language-agnostic wire contract (the standard OpenOutcry governs) -----------------

pub use sharpebench_protocol::{
    Action, AgentTrajectory, Decision, DecisionStep, MarketObservation, Order, PositionState,
    RunTrajectory, SymbolSnapshot,
};

// --- The scored output (so callers read returns/trace without a second dependency) --------

pub use sharpebench_core::Run;