Skip to content

Commit 66be240

Browse files
luisleo526claude
andcommitted
docs: state the 1.1.0 hash folds and scope two runner sentences
The 1.1.0 lead now says how state-hash values change while the epoch and the domain tags stay: a run whose fills an adapter change alters hashes to new values, and three changes fold more state, so a run can hash differently from 1.0.1 with byte-identical trades: #315 (an unbatched same-bar entry request and placement; the stream report's terminal re-mark leaves the hashed extremes; witness row Stream/0/1 re-pinned), #316 (an opening stop's next waypoint; Random44/0/0 and /1 re-pinned) and #319 (tick-volume state, every existing pin kept). In the runner tooling bullet, "No versioned engine PF_API export ... changes" and "Plugin-free ledger identity bytes remain unchanged" read as release-wide; they now speak for #320 itself and for a strategy without the checked settings calls. The Report keys intro points at the report schema page. The terminal-quote bullet names the chart feed that PINEFORGE_RUN_REPORT_CHART_QUOTE points at, and two runner bullet headings are re-wrapped. Replaces text introduced by a80485c (this branch's first commit): the lead's "A run whose fills one of the Pine adapter changes below alters hashes to new values, and [#316] adds one placement field to the adapter's hashed state, for which two witnesses with byte-identical trades were re-pinned.", the Report keys intro and the terminal-quote harness clause; and text introduced by dbd17b3 (#320): "No versioned engine PF_API export, native C++ surface, script ABI epoch or engine behavior changes." and "Plugin-free ledger identity bytes remain unchanged". Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
1 parent a80485c commit 66be240

1 file changed

Lines changed: 32 additions & 23 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 32 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,22 @@ attaches the three prebuilt tarballs, `pineforge-v1.1.0-linux-x86_64.tar.gz`,
1818
`PF_ABI_VERSION` stays 4: `pineforge.h` only gains declarations, and
1919
`native_c_api.h` and the native C++ host headers are unchanged, so no published
2020
layout moves; the frozen historical headers and archives are untouched. The
21-
script ABI epoch stays `engine_script_run_v19`, and its state-hash recipes keep
22-
their domain tags, `pineforge-broker-state/v19` and
23-
`pineforge-source-adapter/v4`. A run whose fills one of the Pine adapter
24-
changes below alters hashes to new values, and [#316] adds one placement field
25-
to the adapter's hashed state, for which two witnesses with byte-identical
26-
trades were re-pinned. The installed header `pineforge/live_parser.h` is
27-
removed with the runner's parser plugins ([#320]); no surface of the
28-
[public contract](docs/pages/public-contract.md) covers it. The four rows of
29-
the 1.0 C boundary that were scheduled for 1.1.0 (C-SURFACE-2: a non-mutating
30-
execution preview, the origin and label of an applied event, a closed-trade
31-
entry-comment accessor and a replace-options word) are not in this release.
21+
script ABI epoch stays `engine_script_run_v19`, and the state hashes keep their
22+
domain tags, `pineforge-broker-state/v19` and `pineforge-source-adapter/v4`.
23+
Their values change in two ways. A run whose fills a Pine adapter change below
24+
alters hashes to new values. Three changes also fold more state, so a run can
25+
hash differently from 1.0.1 with byte-identical trades: [#315] folds a pending
26+
same-bar entry's original (unbatched) request and placement and no longer folds
27+
a stream report's terminal re-mark into the hashed extremes, re-pinning one
28+
witness row (`Stream/0/1`, whose recorded-row digest alone moves); [#316] folds
29+
an opening stop's next waypoint, re-pinning `Random44/0/0` and `Random44/0/1`;
30+
and [#319] folds tick-volume accumulator state only where it adds information,
31+
so every existing pin holds. The installed header `pineforge/live_parser.h` is
32+
removed with the runner's parser plugins ([#320]); no surface of the [public
33+
contract](docs/pages/public-contract.md) covers it. The four rows of the 1.0 C
34+
boundary that were scheduled for 1.1.0 (C-SURFACE-2: a non-mutating execution
35+
preview, the origin and label of an applied event, a closed-trade entry-comment
36+
accessor and a replace-options word) are not in this release.
3237

3338
- **Checked strategy settings ([#317]).** The six functions are
3439
`strategy_settings_api_version`, `strategy_create_checked`,
@@ -87,8 +92,10 @@ entry-comment accessor and a replace-options word) are not in this release.
8792
information, so the existing tick, bar and batch hash pins hold.
8893

8994
- **Report-only terminal quote ([#321]).** A magnified intraday batch run can be
90-
given the chart's terminal quote: `scripts/run_strategy.py` reads it from
91-
`PINEFORGE_RUN_REPORT_CHART_QUOTE` with its `_SHA256` pin, a C host sets the
95+
given the chart's terminal quote: `scripts/run_strategy.py` takes the terminal
96+
bar's time and close from the chart feed that
97+
`PINEFORGE_RUN_REPORT_CHART_QUOTE` names (pinned by
98+
`PINEFORGE_RUN_REPORT_CHART_QUOTE_SHA256`), a C host sets the
9299
metadata keys `report_terminal_quote_time_ms` and
93100
`report_terminal_quote_close` with `strategy_set_syminfo_metadata`, and a C++
94101
host calls `PineStrategyHost::set_report_terminal_quote`. The report then
@@ -126,8 +133,9 @@ entry-comment accessor and a replace-options word) are not in this release.
126133
hub copies `docker/run_json.py` from the engine tag, so `pineforge-release`
127134
1.1.0 carries it.
128135

129-
- **Native runner routing and delivery ([#320]).** Webhooks are optional; `--webhook-routes`
130-
adds first-match per-action targets and payload `pineforge-native-order-action/v2`.
136+
- **Native runner routing and delivery ([#320]).** Webhooks are optional;
137+
`--webhook-routes` adds first-match per-action targets and payload
138+
`pineforge-native-order-action/v2`.
131139
New `actions`, `status` and offline `redeliver` commands expose the journal and
132140
delivery audit. `redeliver` requires the ledger's `--deployment` identity.
133141
Existing `--webhook-url` deployments keep one default target, exact v1 payload
@@ -142,9 +150,9 @@ entry-comment accessor and a replace-options word) are not in this release.
142150
the migrated ledger. Back up the ledger before upgrading. This runner change
143151
leaves the engine library as it was.
144152

145-
- **Runner tooling removal ([#320]).** The native live runner accepts only normalized
146-
PineForge feed events from stdin, files, or a user's own HTTP/WebSocket feed
147-
service. The installed `pineforge/live_parser.h` header, its
153+
- **Runner tooling removal ([#320]).** The native live runner accepts only
154+
normalized PineForge feed events from stdin, files, or a user's own
155+
HTTP/WebSocket feed service. The installed `pineforge/live_parser.h` header, its
148156
`PF_LIVE_PARSER_*` types/constants and `pf_live_parser_abi_version` /
149157
`pf_live_parse_message` plugin exports, the `--parser` / `--parser-config`
150158
flags, and the example plugin are removed. This breaks callers that included
@@ -154,9 +162,10 @@ entry-comment accessor and a replace-options word) are not in this release.
154162
that adapter, not an exchange. The outbound order-action webhook remains.
155163
Strict native runner configurations now also require 1m input; higher script
156164
timeframes still aggregate those minutes.
157-
No versioned engine `PF_API` export, native C++ surface, script ABI epoch or
158-
engine behavior changes. Frozen historical ABI header manifests and archives
159-
remain intact. Plugin-free ledger identity bytes remain unchanged; ledgers
165+
This change itself alters no versioned engine `PF_API` export, native C++
166+
surface, script ABI epoch or engine behavior. Frozen historical ABI header
167+
manifests and archives remain intact. For a strategy without the checked
168+
settings calls, plugin-free ledger identity bytes remain unchanged; ledgers
160169
bound to removed plugins cannot be resumed by this runner and must not be
161170
silently rewritten.
162171

@@ -178,8 +187,8 @@ entry-comment accessor and a replace-options word) are not in this release.
178187

179188
### Report keys
180189

181-
The JSON report of `docker/run_json.py`, which pineforge-app parses, from
182-
v1.0.1 to v1.1.0:
190+
The JSON report of `docker/run_json.py`, the release image's
191+
[report schema](docs/pages/report-schema.md), from v1.0.1 to v1.1.0:
183192

184193
- No key is removed or renamed. `EQUITY_REPORT_KEYS` is unchanged:
185194
`metrics.equity.sharpe_tv` and `sortino_tv` stay.

0 commit comments

Comments
 (0)