From 6d1eb12c8b7074a1896f8bc64164836f1ace295d Mon Sep 17 00:00:00 2001 From: Chris Sellers Date: Fri, 22 Mar 2024 19:18:10 +1100 Subject: [PATCH] Update README and release notes --- README.md | 14 ++++++++++++-- RELEASES.md | 14 +++++++------- 2 files changed, 19 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 48c1b629811e..85de4c767bbc 100644 --- a/README.md +++ b/README.md @@ -135,8 +135,8 @@ This project makes the [Soundness Pledge](https://raphlinus.github.io/rust/2020/ ## Integrations -NautilusTrader is designed in a modular way to work with 'adapters' which provide -connectivity to data providers and/or trading venues - converting their raw API +NautilusTrader is designed in a modular way to work with _adapters_ which provide +connectivity to trading venues and/or data providers - converting their raw API into a unified interface. The following integrations are currently supported: | Name | ID | Type | Status | Docs | @@ -149,7 +149,17 @@ into a unified interface. The following integrations are currently supported: | [Databento](https://databento.com) | `DATABENTO` | Data Provider | ![status](https://img.shields.io/badge/beta-yellow) | [Guide](https://docs.nautilustrader.io/integrations/databento.html) | | [Interactive Brokers](https://www.interactivebrokers.com) | `INTERACTIVE_BROKERS` | Brokerage (multi-venue) | ![status](https://img.shields.io/badge/stable-green) | [Guide](https://docs.nautilustrader.io/integrations/ib.html) | +- `ID:` The default client ID for the integrations adapter clients +- `Type:` The type of integration (often the venue type) + +### Status +- `building` - Under construction and likely not in a usable state +- `beta` - Completed to a minimally working state and in a 'beta' testing phase +- `stable` - Stabilized feature set and API, the integration has been tested by both developers and users to a reasonable level (some bugs may still remain) + +```{note} Refer to the [Integrations](https://docs.nautilustrader.io/integrations/index.html) documentation for further details. +``` ## Installation diff --git a/RELEASES.md b/RELEASES.md index bef918469873..6d5588599992 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -1,27 +1,27 @@ # NautilusTrader 1.190.0 Beta -Released on TBD (UTC). +Released on 22nd March 2024 (UTC). ### Enhancements -- Added Databento adapter continuous symbology support (will infer from symbols) +- Added Databento adapter `continuous`, `parent` and `instrument_id` symbology support (will infer from symbols) - Added `DatabaseConfig.timeout` config option for timeout seconds to wait for a new connection - Added CSV tick and bar data loader params, thanks @rterbush - Implemented `LogGuard` to ensure global logger is flushed on termination, thanks @ayush-sb and @twitu +- Improved Interactive Brokers client connectivity resilience and component lifecycle, thanks @benjaminsingleton - Improved Binance execution client ping listen key error handling and logging - Improved Redis cache adapter and message bus error handling and logging -- Improved Interactive Brokers client connectivity resilience and component lifecycle, thanks @benjaminsingleton - Improved Redis port parsing (`DatabaseConfig.port` can now be either a string or integer) -- Redact Redis passwords in strings and logs - Refactored `InteractiveBrokersEWrapper`, thanks @rsmb7z -- Upgraded `redis` crate to 0.25.1 which bumps up TLS dependencies +- Redact Redis passwords in strings and logs +- Upgraded `redis` crate to 0.25.2 which bumps up TLS dependencies, and turned on `tls-rustls-webpki-roots` feature flag ### Breaking Changes None ### Fixes - Fixed JSON format for log file output (was missing `timestamp` and `trader\_id`) -- Fixed `DatabaseConfig` port JSON parsing for Redis (was always falling back to the default 6379) -- Fixed `ChandeMomentumOscillator` indicator divide by zero error +- Fixed `DatabaseConfig` port JSON parsing for Redis (was always defaulting to 6379) +- Fixed `ChandeMomentumOscillator` indicator divide by zero error (both Rust and Cython versions) ---