Quickstart

What the FTH Trading Engine is, what exists today, and how to read these docs.

Status

The engine is in development and not released. No package is published. Everything described as Real here runs from the source repository and is covered by its test suite.

Status labels

• Real: the code runs and its tests pass.
• Simulation: runs against the simulated venue only.
• Testnet: runs against the XRP Ledger test network, where tokens have no value.
• Being built: code is being written in the current task and has not run.
• Planned: not built.
• Proposed: a design only.
• Reference: a page about the project rather than a system.

The idea

A strategy is a small program that reacts to events: a new quote, a trade, a closed bar, a timer, an order update. The engine delivers those events in order, from history in a backtest or from a venue live, and the strategy reacts the same way in both.

What exists today

• M1: value types, clock, events, message bus and cache, in Rust.
• M2: orders, pre-trade risk checks, portfolio, the simulated venue and the backtest engine.
• M3: bars, stop orders, brackets, mark-to-market equity and static HTML tear sheets.
• M4: the Parquet data catalog and the fth-catalog tool.
• M5 part 1: the engine made generic over a venue, an incremental run API and startup reconciliation.
• M6: the XRPL testnet venue and the fth-xrpl tool; two testnet transactions accepted.

Reading order

• Architecture
• Strategies and Orders
• Backtesting, then First backtest
• The live engine seam and XRPL venue
• Review and verification