How agutinbaigo28/trading-backtest-kit works
Backtest Kit is a TypeScript engine for researching and running trading strategies in backtest, paper, and live modes, with a CLI and frontend for operation and inspection. The primary workflow is to configure exchange, frame, and strategy schemas, run a mode against market data, evaluate signals and manage positions, then persist and emit results. The README documents these capabilities; source excerpts additionally show strategy execution context, event emitters, and storage behavior. Some subsystems are represented by tree paths and README claims because their implementation was not sampled.
Main entry points: ClientStrategy.ts Strategy client · main.ts CLI entry · Storage.ts Signal storage · StorageDbService.ts Mongo storage
Components 25
Trading engine
- Strategy schemas
src/index.ts - Exchange data
src/client/ClientExchange.ts - Strategy client
src/client/ClientStrategy.ts - Execution context
src/lib/services/context/ExecutionContextService.ts - Schema context
src/lib/services/context/MethodContextService.ts - Trading events
cli/src/config/emitters.ts
Execution modes
- Backtest runner
cli/src/lib/services/main/BacktestMainService.ts - Live runner
cli/src/lib/services/main/LiveMainService.ts - Paper runner
cli/src/lib/services/main/PaperMainService.ts - Walker runner
cli/src/lib/services/main/WalkerMainService.ts
CLI and operations
- CLI entry
cli/src/main/main.ts - Telegram notifications
cli/src/lib/services/api/TelegramApiService.ts
Persistence
- Signal storage
src/classes/Storage.ts - Mongo storage
packages/mongo/src/lib/services/db/StorageDbService.ts - Mongo cache
packages/mongo/src/lib/services/cache/StorageCacheService.ts - Postgres storage
packages/pg/src/lib/services/db/StorageDbService.ts - Postgres cache
packages/pg/src/lib/services/cache/StorageCacheService.ts
Frontend
- Trading dashboard
packages/front/modules/frontend/src/components/App.tsx - Dashboard parameters
packages/front/modules/frontend/src/config/params.ts - Signal inspection
packages/front/modules/frontend/src/hooks/useAverageBuyCommitView/useAverageBuyCommitView.tsx
Other components
- Strategy developer
- Exchange service
- MongoDB
- PostgreSQL
- Trader
Connections 27
- Strategy developer → Strategy schemas: registers
- Strategy schemas → Exchange data: configures
- CLI entry → Backtest runner: routes
- CLI entry → Live runner: routes
- CLI entry → Paper runner: routes
- CLI entry → Walker runner: routes
- Backtest runner → Strategy client: runs
- Live runner → Strategy client: runs
- Paper runner → Strategy client: runs
- Walker runner → Strategy client: evaluates
- Strategy client → Exchange data: fetches candles
- Strategy client → Execution context: uses time
src/client/ClientStrategy.ts - Strategy client → Schema context: uses schemas
- Strategy client → Signal storage: persists signals
- Strategy client → Trading events: emits events
- Signal storage → Mongo storage: adapts storage
- Signal storage → Postgres storage: adapts storage
- Mongo storage → Mongo cache: updates cache
packages/mongo/src/lib/services/db/StorageDbService.ts - Postgres storage → Postgres cache: updates cache
packages/pg/src/lib/services/db/StorageDbService.ts - Mongo storage → MongoDB: reads and writes
packages/mongo/src/lib/services/db/StorageDbService.ts - Postgres storage → PostgreSQL: reads and writes
packages/pg/src/lib/services/db/StorageDbService.ts - Trader → CLI entry: runs commands
- Trader → Trading dashboard: inspects results
- Trading dashboard → Dashboard parameters: uses settings
- Signal inspection → Exchange service: requests candles
packages/front/modules/frontend/src/hooks/useAverageBuyCommitView/useAverageBuyCommitView.tsx - Signal inspection → Trader: presents details
- CLI entry → Telegram notifications: configures notifications