From 688c85b53002a06d1e966ff4ad079a749492cab4 Mon Sep 17 00:00:00 2001 From: Wiktor Jelen <35398584+Akinzou@users.noreply.github.com> Date: Mon, 9 Nov 2026 13:36:24 +0100 Subject: [PATCH] docs: release 3.0.0; record the owner's choice to keep connect(magic=0) CHANGELOG: 3.0.0 dated 2026-11-09 and an empty [Unreleased] section, as Keep a Changelog expects. ADR 0011: the owner kept magic=0 as the connect() default; residual risk (manual positions closed and manual pending orders cancelled by a bot without its own magic) written down, with when the warning fires and when it does not. Long lines reflowed. --- CHANGELOG.md | 4 +++- .../adr/0011-close-all-defaults-to-own-magic.md | 17 +++++++++-------- 2 files changed, 12 insertions(+), 9 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7164d8a..58cb03b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,7 +4,9 @@ All notable changes to this project are documented here. The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and the project uses [Semantic Versioning](https://semver.org/). -## [3.0.0] - Unreleased +## [Unreleased] + +## [3.0.0] - 2026-11-09 Complete rewrite. See [MIGRATION.md](MIGRATION.md) for every behaviour change. diff --git a/docs/adr/0011-close-all-defaults-to-own-magic.md b/docs/adr/0011-close-all-defaults-to-own-magic.md index c733061..131328b 100644 --- a/docs/adr/0011-close-all-defaults-to-own-magic.md +++ b/docs/adr/0011-close-all-defaults-to-own-magic.md @@ -30,8 +30,8 @@ gives trades opened by hand magic 0. `True`, `1.5`, `-1`, `2**64`). `"42"` would match nothing and report an empty success with every position still open. - **The trader's own magic must be an integer from 0 to 2\*\*64-1** (MT5's - ulong). `connect()` returns `Err(INVALID_ARGUMENT)` and `Trader(...)` raises `ValueError` for - `None`, `ANY_MAGIC`, `"1001"` or `True`. Without this check, + ulong). `connect()` returns `Err(INVALID_ARGUMENT)` and `Trader(...)` + raises `ValueError` for `None`, `ANY_MAGIC`, `"1001"` or `True`. Without this check, `connect(magic=cfg.get("magic"))` with the key missing made "own" mean "every magic" (found in review). - **`Broker` keeps 2.x.** `Close(symbol)` and `CancelOrders(symbol)` closed @@ -41,12 +41,13 @@ gives trades opened by hand magic 0. - A trader connected with the default `magic=0` shares that magic with manual trades, so its close-all still closes them. The protection only works once - a bot sets its own `magic`. `connect()` keeps `magic=0` as its default - rather than making `magic` required; that is an API choice left to the - owner before release (`Broker` builds its `Trader` directly and is not - affected either way). A defaulted close/cancel on a magic-0 trader that - matches something logs a warning that manual trades are included; passing - `magic=0` explicitly acknowledges it. + a bot sets its own `magic`. Making `magic` required in `connect()` was + offered before release; the owner chose to keep `magic=0` as the default + (2026-11-09). Residual risk: a bot that never sets `magic` still closes + manual positions and cancels manual pending orders. A defaulted + close/cancel on a magic-0 trader that matches something logs a warning + that manual trades are included; an explicit `magic=0` acknowledges it and + logs nothing. - On a **netting** account one position per symbol collects every deal, and it keeps the magic of the deal that opened it. A bot's deal that merges into a manual position is then not "own", and a manual deal that merges