|
| 1 | +# Changelog |
| 2 | + |
| 3 | +All notable changes to this project will be documented in this file. |
| 4 | + |
| 5 | +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), |
| 6 | +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). |
| 7 | + |
| 8 | +## [Unreleased] |
| 9 | + |
| 10 | +See [TODO.md](TODO.md) for the production readiness checklist and performance roadmap. |
| 11 | + |
| 12 | +## [1.1.0] - 2026-03-26 |
| 13 | + |
| 14 | +### Added |
| 15 | + |
| 16 | +- **All 61 endpoints** via declarative macro (was 19 hand-written) — covers every |
| 17 | + v3 gRPC RPC: stock, option, index, interest rate, calendar |
| 18 | +- **All 61 endpoints in every SDK** — Python, Go, C++, C FFI all match Rust core |
| 19 | +- **Zero-allocation FPSS path** — fully sync I/O thread + LMAX Disruptor ring buffer |
| 20 | + (`disruptor-rs` v4), no tokio in the streaming hot path |
| 21 | +- **Cache-line aligned tick types** — `#[repr(C, align(64))]` on TradeTick, QuoteTick, OhlcTick, EodTick |
| 22 | +- **Cached QueryInfo template** — no per-request String allocation |
| 23 | +- **Precomputed DataTable column indices** — O(1) per row, not O(headers) |
| 24 | +- **pow10 lookup tables** for Price comparison and conversion |
| 25 | +- **`#[inline]`** on all hot-path functions (FIT decode, Price ops, tick accessors) |
| 26 | +- **Reusable thread-local zstd decompressor** — no fresh allocation per chunk |
| 27 | +- **Criterion benchmarks** — fit_decode, price_to_f64, price_compare, all_greeks, fie_encode |
| 28 | +- **AdaptiveWaitStrategy** — 3-phase spin/yield/hint tuned for ~100us FPSS tick intervals |
| 29 | + |
| 30 | +### Verified |
| 31 | + |
| 32 | +- Authenticated against real Nexus API (session established) |
| 33 | +- Retrieved 25,341 stock symbols from MDDS |
| 34 | +- Retrieved 42 AAPL EOD ticks (Jan-Mar 2024) with correct OHLCV data |
| 35 | +- Retrieved 2,010 SPY option expirations |
| 36 | +- Retrieved 13,160 index symbols |
| 37 | +- Calendar endpoint returned valid data |
| 38 | +- `client_type = "rust-thetadatadx"` accepted by server |
| 39 | + |
| 40 | +## [1.0.1] - 2026-03-26 |
| 41 | + |
| 42 | +### Changed |
| 43 | + |
| 44 | +- Renamed crate from `thetadx` to `thetadatadx` (crates.io + PyPI) |
| 45 | +- Renamed repository from `thetadx` to `ThetaDataDx` |
| 46 | +- Switched license to GPL-3.0-or-later |
| 47 | +- Added disclaimer, legal considerations, and EU interoperability section |
| 48 | +- README updated with GitHub callouts (NOTE, TIP, IMPORTANT, WARNING, CAUTION) |
| 49 | +- Fixed PyPI package description (was empty — added readme field to pyproject.toml) |
| 50 | + |
| 51 | +## [1.0.0] - 2026-03-26 |
| 52 | + |
| 53 | +### Added |
| 54 | + |
| 55 | +- **DirectClient** for MDDS gRPC — all 60 gRPC RPCs exposed as 61 typed endpoint methods |
| 56 | + (stock/option/index/rate/calendar: list, history, snapshot, at-time, greeks) via |
| 57 | + declarative `define_endpoint!` macro |
| 58 | +- **FpssClient** for FPSS streaming — real-time quotes, trades, open interest, OHLC |
| 59 | + via TLS/TCP with heartbeat and manual reconnection |
| 60 | +- **Auth module** — Nexus API authentication (email/password → session UUID) |
| 61 | +- **FIT/FIE codec** — nibble-based tick compression/decompression (ported from Java) |
| 62 | +- **Greeks calculator** — full Black-Scholes: 22 Greeks + IV bisection solver with |
| 63 | + precomputed shared intermediates and edge-case guards (t=0, v=0) |
| 64 | +- **All tick types** — TradeTick, QuoteTick, OhlcTick, EodTick, OpenInterestTick, |
| 65 | + SnapshotTradeTick, TradeQuoteTick with fixed-point Price encoding |
| 66 | +- **80+ DataType enum codes** — quotes, trades, OHLC, all Greek orders, dividends, |
| 67 | + splits, fundamentals |
| 68 | +- **Proto definitions** — extracted via runtime FileDescriptor reflection from |
| 69 | + ThetaData Terminal v202603181 (endpoints.proto + v3_endpoints.proto) |
| 70 | +- **Runtime configuration** — `DirectConfig` with all JVM-equivalent tuning knobs |
| 71 | +- `contract_lookup(id)` on `FpssClient` for single-entry hot-path lookup |
| 72 | +- `FpssEvent::Error` variant for surfacing protocol parse failures |
| 73 | +- Date parameter validation on all `DirectClient` methods |
| 74 | +- `async-zstd` feature flag for optional streaming decompression |
| 75 | +- **Python SDK** (PyO3/maturin) — wraps the Rust crate, not a reimplementation |
| 76 | +- **Go SDK** — CGo FFI bindings over the C ABI layer |
| 77 | +- **C++ SDK** — RAII C++ wrapper over the C header |
| 78 | +- **C FFI crate** (`thetadatadx-ffi`) — stable `extern "C"` ABI for all SDKs |
| 79 | +- **Documentation** — architecture (Mermaid), API reference, reverse-engineering guide, JVM deviations |
| 80 | +- **CI/CD** — GitHub Actions (fmt, clippy, test, FFI build, crates.io publish, PyPI publish, GitHub Release) |
| 81 | +- **Project infrastructure** — CHANGELOG, CONTRIBUTING, SECURITY, CODE_OF_CONDUCT, |
| 82 | + clippy.toml, cliff.toml, rust-toolchain.toml, LICENSE (GPL-3.0-or-later) |
| 83 | + |
| 84 | +### Security |
| 85 | + |
| 86 | +- Credential `Debug` redaction — passwords never appear in debug output |
| 87 | +- `AuthRequest` does not derive `Debug` (prevents password in error traces) |
| 88 | +- Session UUID redaction — bearer tokens logged at `debug!` level only, first 8 chars |
| 89 | +- `assert!` on FPSS frame size limits — enforced in release builds |
| 90 | +- Unified TLS via rustls for all connections (MDDS gRPC + FPSS TCP + Nexus HTTP) |
| 91 | +- Timeouts on all network operations (auth 10s/5s, gRPC keepalive, FPSS connect, FPSS read 10s) |
| 92 | +- 7 credential/account errors treated as permanent disconnect (no futile reconnect loops) |
| 93 | +- Contract root length validated before wire serialization |
| 94 | +- FIT decoder uses i64 accumulator with i32 saturation (no silent overflow) |
| 95 | +- Price type range enforced with `assert!` in release builds |
| 96 | + |
| 97 | +[Unreleased]: https://github.com/userFRM/ThetaDataDx/compare/v1.1.0...HEAD |
| 98 | +[1.1.0]: https://github.com/userFRM/ThetaDataDx/compare/v1.0.1...v1.1.0 |
| 99 | +[1.0.1]: https://github.com/userFRM/ThetaDataDx/compare/v1.0.0...v1.0.1 |
| 100 | +[1.0.0]: https://github.com/userFRM/ThetaDataDx/releases/tag/v1.0.0 |
0 commit comments