Skip to content

Commit a80485c

Browse files
luisleo526claude
andcommitted
docs: release notes and version scoping for v1.1.0
v1.1.0 is a minor release: <pineforge/pineforge.h> declares six more functions, the checked settings calls that a strategy generated by pineforge-codegen 1.1.0 exports (#317). It pairs with pineforge-codegen 1.1.0. PF_ABI_VERSION stays 4 (pineforge.h only gains declarations; native_c_api.h and the native C++ host headers are unchanged) and the script ABI epoch stays engine_script_run_v19. - CHANGELOG.md: "## Unreleased" becomes "## 1.1.0 — 2026-10-04": a lead paragraph, one bullet per change a user can observe since v1.0.1 (#312-#324), each linking its PR, a Report keys subsection (docker/run_json.py v1.0.1 -> v1.1.0) and a Migration subsection. The three Unreleased bullets stay; the lot-grid bullet now gives both failure messages. - README.md: pineforge-codegen==1.1.0, the v1.1.0 tarballs, the pairing sentence, the stream known issue's scope, the benchmark refresh line, the release scoreboard sentence (releases[1.1.0] markers) and a v1.1.0 line in Releases. The public corpus sweep's "311 excellent + 1 declared anomaly" is scoped to the v1.0.1 library it was measured on. Facts rendered from the facts file that adds releases[1.1.0]; the active scoreboard markers move to baseline pineforge-parity-baseline-20261003-engine-dbd17b38. - docs/pages/install.md: the v1.1.0 tarballs and the hub tag engine1.1.0-codegen1.1.0. - docs/pages/public-contract.md: 1.1.0's release line, engine v1.1.0 with codegen 1.1.0 among the supported pairs, and the four C-boundary rows that were planned for 1.1.0 are not in it. - docs/pages/streaming.md: the known issue's scope includes v1.1.0. Lines that state what an earlier version shipped or did stay. Replaces text introduced by dc74e63 (#318): README.md's "Release 1.0.1 still grades ... until the next release" sentence, now 1.1.0's; by d093560 (#290): public-contract.md's "Four of its rows are planned for 1.1.0"; by 783bb39 (#322): CHANGELOG.md's "The engine library is unchanged."; by dbd17b3 (#320): CHANGELOG.md's "The engine is unchanged."; by b2a578c (#300): README.md's "this repository's sweep: 311 excellent + 1 declared anomaly"; by 271d687 (#311): README.md's "its releases 1.0.0 and 1.0.1 do". Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
1 parent e9f78a6 commit a80485c

5 files changed

Lines changed: 223 additions & 49 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 186 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,128 @@ README's *Releases* section and on the GitHub releases page. From 1.0.0 the
55
version number follows semantic versioning over the surfaces the
66
[public contract](docs/pages/public-contract.md) lists.
77

8-
## Unreleased
9-
10-
- **Harness lot grid:** `docker/run_json.py` applies `mincontract` from the
11-
`--syminfo` (`PINEFORGE_SYMINFO`) file as the engine's lot grid, the metadata key
12-
`qty_step` plus the `mincontract` key a script's `syminfo.mincontract` reads, so a
13-
percent-of-equity strategy no longer trades sub-lot quantities. Absent or `null`
14-
changes nothing: the report and its fingerprint are as before, apart from
15-
`elapsed_seconds`. A value that is not a positive finite number, or, when
16-
`mincontract` is set, a strategy library without
17-
`strategy_set_syminfo_metadata`, fails the run (one
8+
## 1.1.0 — 2026-10-04
9+
10+
A minor release: it adds to the C ABI. `<pineforge/pineforge.h>` declares six
11+
more functions, the checked settings calls that a strategy generated by
12+
pineforge-codegen 1.1.0 exports ([#317]). Engine v1.1.0 pairs with
13+
pineforge-codegen 1.1.0, the pair the release hub's image
14+
`ghcr.io/pineforge-4pass/pineforge-release:1.1.0` carries. The GitHub release
15+
attaches the three prebuilt tarballs, `pineforge-v1.1.0-linux-x86_64.tar.gz`,
16+
`pineforge-v1.1.0-linux-aarch64.tar.gz` and
17+
`pineforge-v1.1.0-macos-universal.tar.gz`, each with a `.sha256`.
18+
`PF_ABI_VERSION` stays 4: `pineforge.h` only gains declarations, and
19+
`native_c_api.h` and the native C++ host headers are unchanged, so no published
20+
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.
32+
33+
- **Checked strategy settings ([#317]).** The six functions are
34+
`strategy_settings_api_version`, `strategy_create_checked`,
35+
`strategy_set_input_checked`, `strategy_set_override_checked`,
36+
`strategy_get_effective_settings` and `run_backtest_full_checked`, with the
37+
status codes `pf_settings_status_t` and `PF_SETTINGS_API_VERSION` 1. With them
38+
a C host refuses a bad input or override before a run (an unknown or ambiguous
39+
key, an invalid enum, boolean or number, a declared range violation) with a
40+
status code and a message, keeping the previous value; reads a JSON receipt of
41+
every declared input and supported override with its default and effective
42+
value; and runs a batch backtest that returns a status instead of letting a
43+
C++ exception out. Look up `strategy_settings_api_version` with `dlsym`: a
44+
module generated by an earlier codegen lacks all six and keeps the legacy
45+
calls. The generated code uses `include/pineforge/checked_settings.hpp`;
46+
[docs/checked-settings.md](docs/checked-settings.md) is the guide.
47+
48+
- **C++ exceptions stop at the C ABI ([#317]).** A module generated by codegen
49+
1.1.0 catches them at every C entry point, the legacy ones included: a legacy
50+
run or setter that throws leaves the entry point and the message in
51+
`strategy_get_last_error`, and a batch call returns the existing empty-report
52+
failure. Two behaviours change. A legacy setter that throws refuses every
53+
later batch run and stream begin on that handle; recreate the handle. A
54+
stream begin whose script preparation throws fails, with NOT_COMPLETED from
55+
`strategy_last_run_status`, instead of starting; batch keeps its behaviour
56+
for those exceptions. `pineforge-live` uses the checked calls when the
57+
strategy has them: it refuses bad settings before it opens the ledger, and it
58+
adds the effective-settings receipt to the deployment identity and to the run
59+
summary (`effective_settings`). A strategy regenerated with codegen 1.1.0
60+
therefore cannot resume a ledger its earlier build wrote. With a strategy
61+
from an earlier codegen the runner warns and keeps the legacy behaviour.
62+
63+
- **Pine adapter parity ([#315], [#316]).** The adapter follows TradingView's
64+
trade lists in more cases: same-bar entries under pyramiding; opening margin
65+
checks on TradingView's opening schedule, gap-open checks kept; stop
66+
reversals sized from their placed units; FIFO closes that split a lot, which
67+
no longer leave a zero-quantity remainder; the trail extreme and the closing
68+
stop carried through an opening fill's callback; all-in entries admitted
69+
against the buying power at the order's source time; named percentage exit
70+
targets sized from the live entry's ancestry; `request.security` calendar
71+
history that no longer depends on auxiliary feeds, with full-day minute
72+
requests published at the session close, early closes included; a stream
73+
report's cumulative mark kept at a range end; a repeated short margin check
74+
that reuses a resolved margin-call fill instead of applying slippage twice;
75+
and exact fractional reversals under default and one-pyramid sizing, with a
76+
short opening stop on a bar that opens at its high booked the way
77+
TradingView's callbacks book it. A script that reaches one of these cases can
78+
get different fills, sizes or trade counts than under 1.0.1. #315 moves 35
79+
probes from strong to excellent and #316 three more.
80+
81+
- **Tick-built bar volume ([#319]).** In a stream fed with ticks, the forming
82+
bar sums its prints' quantities exactly when the run's quantity grid is a
83+
decimal step (1, 0.1, 0.01, …) and with compensated summation otherwise, so
84+
it carries the volume that the same bar built offline from the same prints
85+
has. Confirmed-bar input and batch runs are unchanged. A tick stream's
86+
broker-state hash folds the new accumulator state only where it adds
87+
information, so the existing tick, bar and batch hash pins hold.
88+
89+
- **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
92+
metadata keys `report_terminal_quote_time_ms` and
93+
`report_terminal_quote_close` with `strategy_set_syminfo_metadata`, and a C++
94+
host calls `PineStrategyHost::set_report_terminal_quote`. The report then
95+
prices a position still open at the range end, the synthetic `open_at_end`
96+
row, at that quote: the row's exit fields, P&L and commission, the net
97+
profit, the last equity point and the metrics derived from them change;
98+
fills, the book, the hashes and the trace do not. Without the input nothing
99+
changes, and `docker/run_json.py` does not read it.
100+
[docs/report-terminal-quote.md](docs/report-terminal-quote.md) lists the
101+
fields and the limits.
102+
103+
- **Grader distinct-entry identity ([#313]).** `scripts/verify_corpus.py`
104+
checks an engine entry against every TradingView entry key with the same time
105+
and direction, not only the keys with several Signals: a price equal to one
106+
key counts only there, and a price within tolerance of a multi-Signal key and
107+
of another key refuses *excellent*. Trade matching and the thresholds are
108+
unchanged; the README's *Distinct-entry identity* section states the rule.
109+
110+
- **Harness lot grid ([#322]).** `docker/run_json.py` applies `mincontract`
111+
from the `--syminfo` (`PINEFORGE_SYMINFO`) file as the engine's lot grid, the
112+
metadata key `qty_step` plus the `mincontract` key a script's
113+
`syminfo.mincontract` reads, so order quantities are floored to the lot and a
114+
percent-of-equity strategy no longer trades sub-lot quantities; v1.0.1's
115+
harness ignored `mincontract`. Absent or `null` changes nothing: for the same
116+
strategy library the report and its fingerprint are as before, apart from
117+
`elapsed_seconds`. Instead of running without the grid, the run fails (one
18118
`{"engine":"pineforge","error":...}` line, harness exit 1, entrypoint exit 4)
19-
instead of running without the grid. An applied grid is recorded as
20-
`applied_runtime.syminfo`, so a gridded run has its own fingerprint digest. The
21-
engine library is unchanged.
119+
when `mincontract` is not a positive finite number, with the message
120+
`syminfo.mincontract must be a positive finite number, got <the value as
121+
JSON>`, or when `mincontract` is set and the strategy library has no
122+
`strategy_set_syminfo_metadata`, with the message `the strategy library has
123+
no strategy_set_syminfo_metadata, so syminfo.mincontract cannot be applied`.
124+
An applied grid is recorded as `applied_runtime.syminfo`, so a gridded run has
125+
its own fingerprint digest. The change is in the harness alone; the release
126+
hub copies `docker/run_json.py` from the engine tag, so `pineforge-release`
127+
1.1.0 carries it.
22128

23-
- **Native runner routing and delivery:** webhooks are optional; `--webhook-routes`
129+
- **Native runner routing and delivery ([#320]).** Webhooks are optional; `--webhook-routes`
24130
adds first-match per-action targets and payload `pineforge-native-order-action/v2`.
25131
New `actions`, `status` and offline `redeliver` commands expose the journal and
26132
delivery audit. `redeliver` requires the ledger's `--deployment` identity.
@@ -33,9 +139,10 @@ version number follows semantic versioning over the surfaces the
33139
SIGINT/SIGTERM exit 130. Redelivery exits 2 for failed or pending selections.
34140
Schema-1 native ledgers migrate additively to an append-only delivery log without
35141
rewriting actions. This migration is one-way: older runner binaries cannot open
36-
the migrated ledger. Back up the ledger before upgrading. The engine is unchanged.
142+
the migrated ledger. Back up the ledger before upgrading. This runner change
143+
leaves the engine library as it was.
37144

38-
- **Runner tooling removal:** the native live runner accepts only normalized
145+
- **Runner tooling removal ([#320]).** The native live runner accepts only normalized
39146
PineForge feed events from stdin, files, or a user's own HTTP/WebSocket feed
40147
service. The installed `pineforge/live_parser.h` header, its
41148
`PF_LIVE_PARSER_*` types/constants and `pf_live_parser_abi_version` /
@@ -53,6 +160,69 @@ version number follows semantic versioning over the surfaces the
53160
bound to removed plugins cannot be resumed by this runner and must not be
54161
silently rewritten.
55162

163+
- **Documentation ([#312], [#318], [#323], [#324]).** The README's new *How a
164+
change is judged* section states the merge rule's zero-score outcome as it is
165+
now: a score of exactly 0 passes only when nothing got worse (#312). The
166+
parity figures of the README and the docs pages render from the release hub's
167+
public facts tokens, kept in step by `lab facts render` and `lab facts check`,
168+
and the README keeps a release's grades apart from main's scoreboard (#318);
169+
the README's Parity and Trades badges render as images again (#324). The
170+
streaming page gains a *Known issues* section (#323).
171+
172+
- **Known issue, as in v1.0.0 and v1.0.1 ([#323]).** In a stream whose input
173+
timeframe equals its script timeframe, same-chart `request.security` values
174+
stop updating after the first realtime bar; batch backtests are unaffected.
175+
v1.1.0 does not fix it. Workaround: a script timeframe larger than the input
176+
timeframe (input `1`, script `5`), or the batch backtest
177+
([streaming known issues](docs/pages/streaming.md)).
178+
179+
### Report keys
180+
181+
The JSON report of `docker/run_json.py`, which pineforge-app parses, from
182+
v1.0.1 to v1.1.0:
183+
184+
- No key is removed or renamed. `EQUITY_REPORT_KEYS` is unchanged:
185+
`metrics.equity.sharpe_tv` and `sortino_tv` stay.
186+
- Added: `applied_runtime.syminfo`, `{"qty_step": <float>, "mincontract":
187+
<float>}`, present only when the `--syminfo` (`PINEFORGE_SYMINFO`) file
188+
carries a valid `mincontract` and absent otherwise.
189+
`fingerprint.provenance.runtime` holds the same fields as `applied_runtime`,
190+
so a gridded run's fingerprint differs from the gridless run's, and a gridless
191+
report is the one v1.0.1's harness writes for the same strategy library,
192+
apart from `elapsed_seconds`.
193+
- Failure output: the existing one-line `{"engine":"pineforge","error":...}`
194+
on stdout, harness exit 1 and image entrypoint exit 4 (the existing
195+
backtest-failure code), with two new messages:
196+
`syminfo.mincontract must be a positive finite number, got <the value as
197+
JSON, cut at 80 characters>` and `the strategy library has no
198+
strategy_set_syminfo_metadata, so syminfo.mincontract cannot be applied`.
199+
200+
### Migration
201+
202+
- Regenerate strategy C++ with pineforge-codegen 1.1.0 and relink it against
203+
v1.1.0's headers and `libpineforge.a`. Only a regenerated module has the
204+
checked settings calls and stops C++ exceptions at its C entry points.
205+
- Back up a native runner ledger before upgrading: its migration to the
206+
delivery log is one-way, and older runner binaries cannot open the migrated
207+
ledger. A ledger bound to a removed parser plugin cannot be resumed, and a
208+
strategy regenerated with codegen 1.1.0 needs a new deployment.
209+
- Code that included `pineforge/live_parser.h` or wrote a parser plugin moves
210+
that translation into an external feed adapter that emits
211+
[PineForge feed events](runner/README.md#feed-format).
212+
213+
[#312]: https://github.com/pineforge-4pass/pineforge-engine/pull/312
214+
[#313]: https://github.com/pineforge-4pass/pineforge-engine/pull/313
215+
[#315]: https://github.com/pineforge-4pass/pineforge-engine/pull/315
216+
[#316]: https://github.com/pineforge-4pass/pineforge-engine/pull/316
217+
[#317]: https://github.com/pineforge-4pass/pineforge-engine/pull/317
218+
[#318]: https://github.com/pineforge-4pass/pineforge-engine/pull/318
219+
[#319]: https://github.com/pineforge-4pass/pineforge-engine/pull/319
220+
[#320]: https://github.com/pineforge-4pass/pineforge-engine/pull/320
221+
[#321]: https://github.com/pineforge-4pass/pineforge-engine/pull/321
222+
[#322]: https://github.com/pineforge-4pass/pineforge-engine/pull/322
223+
[#323]: https://github.com/pineforge-4pass/pineforge-engine/pull/323
224+
[#324]: https://github.com/pineforge-4pass/pineforge-engine/pull/324
225+
56226
## 1.0.1 — 2026-10-02
57227

58228
A documentation-only release that pairs with pineforge-codegen 1.0.1, the pair

0 commit comments

Comments
 (0)