sandbox-quant 0.25.0

Terminal-based multi-strategy crypto trading sandbox with centralized risk controls
Documentation

sandbox-quant

docs.rs crates.io

Terminal-based Rust trading sandbox for Binance Spot Testnet.

It provides real-time market streaming, strategy-driven order execution, cumulative trade history, and a ratatui dashboard for monitoring positions and performance.

What Is sandbox-quant?

cargo run multi terminal snapshot

  • Real-time market + strategy loop (WebSocket + REST)
  • Multi-view terminal dashboard (chart, positions, orders, history, logs)
  • Persistent history with SQLite and incremental recovery
  • Per-strategy and manual-performance attribution (W/L/T/PnL)
  • Fill markers and strategy-aware UI telemetry
  • Operational safeguards for time sync and rate-limit pressure

Quick Start

  1. Create .env:
cp .env.example .env
  1. Set Binance Spot Testnet credentials:
BINANCE_API_KEY=your_testnet_api_key_here
BINANCE_API_SECRET=your_testnet_api_secret_here
  1. Run app:
cargo run --bin sandbox-quant

Key Controls

Area Keys Description
App Q Quit
Strategy Runtime P / R Pause / Resume
Manual Orders B / S Manual Buy / Sell
Selector T / Y Open Symbol / Strategy Selector
Timeframe 0/1/H/D/W/M 1s/1m/1h/1d/1w/1M
Grid G Open/Close Portfolio Grid

Strategy Status

Current strategy implementation status (code-based):

Strategy Category Status Source Test Doc
MA Crossover Trend ✅ src/strategy/ma_crossover.rs tests/ma_crossover_tests.rs docs/strategy/ma-crossover.md
EMA Crossover Trend ✅ src/strategy/ema_crossover.rs tests/ema_crossover_tests.rs docs/strategy/ema-crossover.md
MACD Crossover Trend ✅ src/strategy/macd_crossover.rs tests/macd_crossover_tests.rs docs/strategy/macd-crossover.md
ROC Momentum Trend ✅ src/strategy/roc_momentum.rs tests/roc_momentum_tests.rs docs/strategy/roc-momentum.md
Aroon Trend Trend ✅ src/strategy/aroon_trend.rs tests/aroon_trend_tests.rs docs/strategy/aroon-trend.md
ATR Expansion Volatility ✅ src/strategy/atr_expansion.rs tests/atr_expansion_tests.rs docs/strategy/atr-expansion.md
Channel Breakout Breakout ✅ src/strategy/channel_breakout.rs tests/channel_breakout_tests.rs docs/strategy/channel-breakout.md
RSA Hybrid ✅ src/strategy/rsa.rs tests/rsa_strategy_tests.rs docs/strategy/rsa.md
Donchian Trend Trend ✅ src/strategy/donchian_trend.rs tests/donchian_trend_tests.rs docs/strategy/donchian-trend.md
MA Reversion MeanReversion ✅ src/strategy/ma_reversion.rs tests/ma_reversion_tests.rs docs/strategy/ma-reversion.md
Bollinger Reversion MeanReversion ✅ src/strategy/bollinger_reversion.rs tests/bollinger_reversion_tests.rs docs/strategy/bollinger-reversion.md
Stochastic Reversion MeanReversion ✅ src/strategy/stochastic_reversion.rs tests/stochastic_reversion_tests.rs docs/strategy/stochastic-reversion.md
Volatility Compression Volatility ✅ src/strategy/volatility_compression.rs tests/volatility_compression_tests.rs docs/strategy/volatility-compression.md
Opening Range Breakout Breakout ✅ src/strategy/opening_range_breakout.rs tests/opening_range_breakout_tests.rs docs/strategy/opening-range-breakout.md
Regime Switch Hybrid ✅ src/strategy/regime_switch.rs tests/regime_switch_tests.rs docs/strategy/regime-switch.md
Ensemble Vote Hybrid ✅ src/strategy/ensemble_vote.rs tests/ensemble_vote_tests.rs docs/strategy/ensemble-vote.md

UI Overview

  • Main Dashboard: Live chart view with active position summary, strategy metrics, and runtime logs. Main Dashboard

  • Portfolio Grid - Assets Tab: Consolidated asset balances, position quantities, and realized/unrealized PnL. Portfolio Grid - Assets Tab

  • Portfolio Grid - Strategies Tab: ON/OFF strategy panels with per-strategy stats (W/L/T/PnL) and running time. Portfolio Grid - Strategies Tab

  • Portfolio Grid - Strategies + Config Popup: Strategy configuration editor for symbol and parameter tuning. Portfolio Grid - Strategies + Config Popup

  • Portfolio Grid - Network Tab: Operational network health panel (latency, drop rates, reconnect signals). Portfolio Grid - Network Tab

  • Account Popup: Quick account balance overview for available assets and quote holdings. Account Popup

Configuration

Edit config/default.toml for runtime behavior.

Common knobs:

  • Strategy parameters (fast/slow/cooldown)
  • Order sizing and risk limits
  • Default symbols and market behavior

Documentation Links

cargo install mdbook
mdbook serve docs-site --open
  • Rustdoc local:
cargo doc --no-deps --open

Development Workflow

Useful commands:

cargo test -q

Testing references:

  • TESTING.md
  • tests/

AI PR Policy

  • Gemini-assisted PR workflow: .github/workflows/gemini-pr.yml
  • Review and safety guide: GEMINI.md
  • Gemini automation lane is limited to RFC/issue proposal docs (no runtime strategy code generation).

Appendix: Run Capture

Terminal screenshot from a real run:

cargo run terminal snapshot

Captured raw output:

  • docs/assets/cargo-run-output.txt

Note:

  • This is a TUI app. Running in non-interactive output redirection contexts can fail terminal initialization.
  • For normal usage, run directly in an interactive terminal.