pineforge-codegen 1.1.0__tar.gz → 1.3.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/.gitignore +1 -0
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/CHANGELOG.md +465 -0
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/CONTRIBUTING.md +13 -6
- pineforge_codegen-1.3.0/LEGAL.md +42 -0
- pineforge_codegen-1.3.0/LICENSE +261 -0
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/PKG-INFO +286 -169
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/README.md +89 -36
- pineforge_codegen-1.3.0/VERSION +1 -0
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/docs/PUBLIC_CONTRACT.md +156 -5
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/docs/pine-cap-activation.md +6 -5
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/__init__.py +1 -0
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/codegen/base.py +48 -2
- pineforge_codegen-1.3.0/pineforge_codegen/codegen/capabilities.py +319 -0
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/codegen/checked_settings.py +64 -5
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/codegen/emit_top.py +5 -3
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/codegen/helpers.py +7 -0
- pineforge_codegen-1.3.0/pineforge_codegen/codegen/order_shapes.py +356 -0
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/codegen/security.py +54 -5
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/codegen/tables.py +12 -0
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/codegen/visit_call.py +61 -0
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/codegen/visit_expr.py +8 -2
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/codegen/visit_stmt.py +2 -4
- pineforge_codegen-1.3.0/pineforge_codegen/diagnostic_codes.py +341 -0
- pineforge_codegen-1.3.0/pineforge_codegen/diagnostics_catalog.json +631 -0
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/errors.py +23 -0
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/external_requests.py +16 -0
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/support_checker.py +19 -10
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pyproject.toml +2 -2
- pineforge_codegen-1.1.0/LEGAL.md +0 -32
- pineforge_codegen-1.1.0/LICENSE +0 -197
- pineforge_codegen-1.1.0/VERSION +0 -1
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/docs/codegen-coverage-gaps.md +0 -0
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/analyzer/__init__.py +0 -0
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/analyzer/base.py +0 -0
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/analyzer/call_handlers.py +0 -0
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/analyzer/contracts.py +0 -0
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/analyzer/diagnostics.py +0 -0
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/analyzer/tables.py +0 -0
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/analyzer/types.py +0 -0
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/ast_nodes.py +0 -0
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/block_locals.py +0 -0
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/builtin_keywords.py +0 -0
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/codegen/__init__.py +0 -0
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/codegen/collection_history.py +0 -0
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/codegen/constant_fold.py +0 -0
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/codegen/drawing.py +0 -0
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/codegen/helpers_syminfo.py +0 -0
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/codegen/host_members.py +0 -0
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/codegen/input.py +0 -0
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/codegen/session_market.py +0 -0
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/codegen/ta.py +0 -0
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/codegen/tv_number_format.py +0 -0
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/codegen/types.py +0 -0
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/collection_history.py +0 -0
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/finite_ta_length.py +0 -0
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/lexer.py +0 -0
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/library_inline.py +0 -0
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/library_modules.py +0 -0
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/library_v5.py +0 -0
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/limits.py +0 -0
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/method_binding.py +0 -0
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/parser.py +0 -0
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/pine_libraries.py +0 -0
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/pine_spelling.py +0 -0
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/pragmas.py +0 -0
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/request_discovery.py +0 -0
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/security_contexts.py +0 -0
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/session_reads.py +0 -0
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/signatures.py +0 -0
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/symbols.py +0 -0
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/tokens.py +0 -0
- {pineforge_codegen-1.1.0 → pineforge_codegen-1.3.0}/pineforge_codegen/tv_input_choices.py +0 -0
|
@@ -20,6 +20,471 @@ supported as exact pairs; on the 0.x line they are independent. See the
|
|
|
20
20
|
the release commit. A prerelease note describes changes since the preceding
|
|
21
21
|
prerelease or stable tag; the final stable note consolidates the series.
|
|
22
22
|
|
|
23
|
+
## 1.3.0 — 2026-10-06
|
|
24
|
+
|
|
25
|
+
A minor release: generated strategy libraries gain two receipts beside 1.2.0's
|
|
26
|
+
capability receipt, the confirmed-bar receipt, which engine `v1.3.0`'s live
|
|
27
|
+
runner reads, and the order-shapes receipt; a string dropdown that uses a
|
|
28
|
+
built-in constant no longer breaks the checked settings; and the package is
|
|
29
|
+
licensed under the PineForge Source License 1.2. It covers the changes merged
|
|
30
|
+
to `main` since 1.2.0:
|
|
31
|
+
[#173](https://github.com/pineforge-4pass/pineforge-codegen-oss/pull/173) and
|
|
32
|
+
[#178](https://github.com/pineforge-4pass/pineforge-codegen-oss/pull/178) add
|
|
33
|
+
the receipts to the emitted C++,
|
|
34
|
+
[#179](https://github.com/pineforge-4pass/pineforge-codegen-oss/pull/179)
|
|
35
|
+
changes its checked settings metadata,
|
|
36
|
+
[#177](https://github.com/pineforge-4pass/pineforge-codegen-oss/pull/177)
|
|
37
|
+
replaces the license, string values derived from a script are validated and
|
|
38
|
+
escaped wherever they are written into generated C++ (see "Hardening"),
|
|
39
|
+
[#174](https://github.com/pineforge-4pass/pineforge-codegen-oss/pull/174)
|
|
40
|
+
renders the README's scoreboard, and
|
|
41
|
+
[#175](https://github.com/pineforge-4pass/pineforge-codegen-oss/pull/175)
|
|
42
|
+
changes the repository's CI only. Codegen `1.3.0` supports only engine
|
|
43
|
+
`v1.3.0`. Engine `v1.3.0`'s `<pineforge/pineforge.h>` is the same file as
|
|
44
|
+
`v1.2.0`'s: the pair keeps C ABI version 4, `PF_SETTINGS_API_VERSION` and
|
|
45
|
+
`PF_CAPABILITIES_API_VERSION` 1 and the script ABI epoch
|
|
46
|
+
`engine_script_run_v19`, and no engine header declares the new receipt
|
|
47
|
+
functions, which a host looks up in the library by name.
|
|
48
|
+
|
|
49
|
+
### Compatibility and migration
|
|
50
|
+
|
|
51
|
+
- Regenerate C++ with 1.3.0 and relink it against engine `v1.3.0`'s headers
|
|
52
|
+
and `libpineforge.a`. The C++ defines the two new receipts beside the
|
|
53
|
+
capability functions, only when the engine's `pineforge/pineforge.h` defines
|
|
54
|
+
both `PF_SETTINGS_API_VERSION` and `PF_CAPABILITIES_API_VERSION`, as engine
|
|
55
|
+
`v1.3.0`'s does. Engine `v1.2.0`'s header defines both too; that does not
|
|
56
|
+
make 1.3.0 with engine `v1.2.0` a supported pair. C++ generated by 1.2.0 has
|
|
57
|
+
neither receipt, and engine `v1.3.0`'s live runner keeps its original
|
|
58
|
+
receipt policy for it (see "Confirmed-bar receipt").
|
|
59
|
+
- Every generated C++ file changes: it gains the two receipts. Beyond that,
|
|
60
|
+
the C++ does not change for the engine's 325 public corpus sources and this
|
|
61
|
+
repository's 277 gate fixtures: each transpiled in a fresh process, 1.3.0's
|
|
62
|
+
C++ with the confirmed-bar and order-shapes functions removed is 1.2.0's C++
|
|
63
|
+
byte for byte, and the 13 fixtures the gate expects to be refused are
|
|
64
|
+
refused with the same message. Elsewhere, #173 changes the capability
|
|
65
|
+
receipt's request entries and `unresolved` list, and #179 the settings
|
|
66
|
+
metadata of a string input that uses a built-in constant (see below),
|
|
67
|
+
shapes none of those sources has. The trading code is unchanged.
|
|
68
|
+
- The Python and JSON contract does not change: no argument, result key or
|
|
69
|
+
envelope is added, removed or renamed. Since 1.2.0 the package's code
|
|
70
|
+
changed only in the code generator (`pineforge_codegen/codegen/`) and its
|
|
71
|
+
support checker (`pineforge_codegen/support_checker.py`):
|
|
72
|
+
`pineforge_codegen/__init__.py`, `pineforge_codegen/errors.py`,
|
|
73
|
+
`gate/glue.py` and `pineforge_codegen/diagnostics_catalog.json` (628 codes)
|
|
74
|
+
are 1.2.0's files. For the 602 sources above, each in a fresh process,
|
|
75
|
+
`transpile_full()`'s result without `cpp`, the diagnostics' codes and
|
|
76
|
+
arguments included, and the `transpile_json` envelope without `cpp` are
|
|
77
|
+
1.2.0's. The GitHub release attaches the catalog as
|
|
78
|
+
`diagnostics_catalog-v1.3.0.json`.
|
|
79
|
+
- Report keys: the engine's Docker harness (`docker/run_json.py`, which the
|
|
80
|
+
`pineforge-release` image runs) is the same file in engine `v1.3.0` as in
|
|
81
|
+
`v1.2.0`, so no report key is added, removed or renamed;
|
|
82
|
+
`metrics.equity.sharpe_tv` and `sortino_tv` (`EQUITY_REPORT_KEYS`) are
|
|
83
|
+
unchanged, and the engine's ADR-0001 keeps serialized report keys as they
|
|
84
|
+
are. A report's fingerprint still differs between 1.2.0 and 1.3.0, since it
|
|
85
|
+
records the engine and codegen versions and the generated C++'s hash, and
|
|
86
|
+
the engine's Pine adapter changes since `v1.2.0`
|
|
87
|
+
([pineforge-engine#341](https://github.com/pineforge-4pass/pineforge-engine/pull/341),
|
|
88
|
+
[#345](https://github.com/pineforge-4pass/pineforge-engine/pull/345),
|
|
89
|
+
[#347](https://github.com/pineforge-4pass/pineforge-engine/pull/347)) can
|
|
90
|
+
change a run's trades.
|
|
91
|
+
- 1.3.0 is the first release under the PineForge Source License 1.2. 1.2.0
|
|
92
|
+
shipped under the PineForge Source License 1.1, and releases up to and
|
|
93
|
+
including 1.1.0 under "PineForge Codegen — License"; copies of each release
|
|
94
|
+
keep the license it shipped with (see "License").
|
|
95
|
+
|
|
96
|
+
### Confirmed-bar receipt
|
|
97
|
+
|
|
98
|
+
From [#173](https://github.com/pineforge-4pass/pineforge-codegen-oss/pull/173):
|
|
99
|
+
|
|
100
|
+
- Built against engine `v1.3.0`, a generated strategy library also defines
|
|
101
|
+
`strategy_confirmed_bar_api_version()`, which returns 1, and
|
|
102
|
+
`strategy_confirmed_bar_receipt(s, json, capacity, required, error,
|
|
103
|
+
error_capacity)`, with the buffer protocol and statuses of
|
|
104
|
+
`strategy_capabilities_receipt`. Its canonical JSON is written into the C++
|
|
105
|
+
when it is generated, as the capability receipt's is, and has the keys
|
|
106
|
+
`version`, `requests` (the capability receipt's request fields and the
|
|
107
|
+
lowered `expression`), `orders` and `intrabar_persistence`. `orders` lists
|
|
108
|
+
the distinct classified shapes of the script's `strategy.*` order calls,
|
|
109
|
+
sorted: `entry:market`, `entry:stop`, `entry:limit`, `exit:short_bracket`
|
|
110
|
+
and `close:market` for the modeled calls and arguments, and the call's name
|
|
111
|
+
marked unproven, such as `strategy.exit (unproven exit terms)`, for any other
|
|
112
|
+
call or argument, risk rules and an order ID that is not a string literal
|
|
113
|
+
included. With `process_orders_on_close=true`, `strategy()` sizing, slippage
|
|
114
|
+
or account settings outside the tested literal profiles add
|
|
115
|
+
`strategy() (unproven POOC sizing, slippage or account settings)`.
|
|
116
|
+
- The capability receipt keeps its version and keys, but its request entries
|
|
117
|
+
now take their timeframe, Heikin-Ashi flag and feed from the request's
|
|
118
|
+
registration, as the confirmed-bar receipt's do. A timeframe held by a
|
|
119
|
+
constant global (`htf = "D"`) or passed as a literal to a helper called once
|
|
120
|
+
(`f("5")`) is that timeframe, where 1.2.0 wrote the name (`htf`) and listed
|
|
121
|
+
`request.security[N].timeframe` in `unresolved`. A Heikin-Ashi request of the
|
|
122
|
+
chart's symbol is `feed: "chart"`, where 1.2.0 wrote `auxiliary` and set
|
|
123
|
+
`requirements.auxiliary_security_feeds`. Symbol `""`, which lowers through
|
|
124
|
+
another symbol's feed, is `feed: "auxiliary"` and sets
|
|
125
|
+
`requirements.auxiliary_security_feeds`, where 1.2.0 wrote `chart`. A request
|
|
126
|
+
of `close`, `close[1]`, `ta.sma(close, 4)` or `ta.ema(close, 3)` in a script
|
|
127
|
+
that declares its own `close` adds
|
|
128
|
+
`request.security.expression (user-bound close)` to `unresolved`. An input,
|
|
129
|
+
reassigned or other run-time timeframe stays unresolved.
|
|
130
|
+
- Engine `v1.3.0`'s live runner, `pineforge-live`, reads both receipts
|
|
131
|
+
([pineforge-engine#342](https://github.com/pineforge-4pass/pineforge-engine/pull/342)),
|
|
132
|
+
checks that they agree and fails closed on a malformed field or a missing
|
|
133
|
+
proof. With the confirmed-bar receipt it admits a same-chart request in the
|
|
134
|
+
proven shapes the engine's `docs/strategy-capabilities.md` lists (such as
|
|
135
|
+
`close` requested at `5`, `60` or `D`, on confirmed one-minute bars) and a
|
|
136
|
+
standalone close-only `varip` on script clock `1`, where engine `v1.2.0`'s
|
|
137
|
+
runner refused every request and every `varip`. Two requests together, a
|
|
138
|
+
request with `varip`, and `process_orders_on_close=true` whatever the order
|
|
139
|
+
shapes stay refused. A library without the confirmed-bar receipt, such as
|
|
140
|
+
one generated by 1.2.0, keeps the original receipt's policy. A batch run
|
|
141
|
+
reads neither receipt, and its computation is unchanged.
|
|
142
|
+
|
|
143
|
+
### Order-shapes receipt
|
|
144
|
+
|
|
145
|
+
From [#178](https://github.com/pineforge-4pass/pineforge-codegen-oss/pull/178):
|
|
146
|
+
|
|
147
|
+
- A generated strategy library also defines
|
|
148
|
+
`strategy_order_shapes_api_version()`, which returns 1, and
|
|
149
|
+
`strategy_order_shapes_receipt(s, json, capacity, required, error,
|
|
150
|
+
error_capacity)`, with the same buffer protocol, whether
|
|
151
|
+
`process_orders_on_close` is on or off. Its canonical JSON describes the
|
|
152
|
+
strategy's order calls as they are lowered, for closing-time order
|
|
153
|
+
processing: the keys are `version`, `process_orders_on_close`, `calls`,
|
|
154
|
+
`entry_ids`, `host_reads`, `settings` and `unmodeled`. `calls` has one entry
|
|
155
|
+
per lowered `strategy.entry`, `strategy.order`, `strategy.exit`,
|
|
156
|
+
`strategy.close`, `strategy.close_all`, `strategy.cancel` or
|
|
157
|
+
`strategy.cancel_all` site, in source order, classing each parameter the
|
|
158
|
+
call passes: a number as `absent` (the default), `literal`, `never_na` or
|
|
159
|
+
`maybe_na`, and text, enums, directions and IDs in classes of their own, an
|
|
160
|
+
ID without its string; a site in a loop, a user function or a method is
|
|
161
|
+
marked `repeatable`. `entry_ids` counts the IDs that `strategy.entry` and
|
|
162
|
+
`strategy.order` sites set, by direction, shared and repeated; `host_reads`
|
|
163
|
+
lists the execution members the generated C++ references; `settings` holds
|
|
164
|
+
the compiled `strategy()` order settings (`pyramiding`, `default_qty_type`,
|
|
165
|
+
`initial_capital`, `slippage`, ...), not later overrides; `unmodeled` names
|
|
166
|
+
every other `strategy.*` call that is not read-only, risk rules included.
|
|
167
|
+
- The receipt describes the calls; it is not an admission decision. Engine
|
|
168
|
+
`v1.3.0` does not read it: the runner-side policy that reads it ships in a
|
|
169
|
+
separate engine change. #178 leaves the capability and confirmed-bar
|
|
170
|
+
receipts byte for byte as they were, the confirmed-bar `orders` included
|
|
171
|
+
(`tests/test_order_shapes.py` pins both), and the trading code unchanged.
|
|
172
|
+
The [public contract](docs/PUBLIC_CONTRACT.md#optional-compiled-execution-capabilities)
|
|
173
|
+
describes both new receipts.
|
|
174
|
+
|
|
175
|
+
### Checked settings
|
|
176
|
+
|
|
177
|
+
From [#179](https://github.com/pineforge-4pass/pineforge-codegen-oss/pull/179):
|
|
178
|
+
|
|
179
|
+
- A strategy whose `input.string` dropdown uses a built-in constant as its
|
|
180
|
+
default or an option no longer breaks its checked settings. 1.2.0 wrote a
|
|
181
|
+
display constant's integer code, such as `size.tiny`'s or
|
|
182
|
+
`position.top_left`'s, where an option of the settings metadata needs a
|
|
183
|
+
string, so building the metadata made a string from a null pointer and
|
|
184
|
+
`strategy_get_effective_settings` or `strategy_set_input_checked` failed or
|
|
185
|
+
crashed. A constant that the generated code reads as a string
|
|
186
|
+
(`alert.freq_*`, `order.ascending` and `descending`, `session.regular` and
|
|
187
|
+
`extended`, and the `currency.*` and `format.*` members, which publish their
|
|
188
|
+
own names) keeps its exact default and choices. A default or option with no
|
|
189
|
+
faithful string marks the input `"supported": false` in the settings
|
|
190
|
+
receipt, with `"options": []` and, when the default is such a constant,
|
|
191
|
+
`"default": ""`, where 1.2.0 published the input as supported;
|
|
192
|
+
`strategy_set_input_checked` refuses it with `PF_SETTINGS_UNSUPPORTED`. The
|
|
193
|
+
legacy `strategy_set_input`, the input getters and the strategy's execution
|
|
194
|
+
are unchanged.
|
|
195
|
+
|
|
196
|
+
### Hardening
|
|
197
|
+
|
|
198
|
+
- String values derived from a script are validated and escaped wherever
|
|
199
|
+
they are written into generated C++. The generated C++ of the 602 sources
|
|
200
|
+
measured under "Compatibility and migration" does not change.
|
|
201
|
+
|
|
202
|
+
### License
|
|
203
|
+
|
|
204
|
+
From [#177](https://github.com/pineforge-4pass/pineforge-codegen-oss/pull/177):
|
|
205
|
+
|
|
206
|
+
- 1.3.0 is the first release under the PineForge Source License 1.2.
|
|
207
|
+
Compared with 1.1 it changes two places and nothing else. In the Personal
|
|
208
|
+
Trading section, an account that a proprietary-trading firm or a
|
|
209
|
+
funded-trader program provides or allocates to the person to trade,
|
|
210
|
+
including a challenge, evaluation or simulated account, whether the capital
|
|
211
|
+
in it is real or simulated, is not the person's own account and is not
|
|
212
|
+
funded by the person's own capital. In the Commercial Use section, the
|
|
213
|
+
capital in such an account is investment capital whether it is real or
|
|
214
|
+
simulated, so trading it, or researching, developing or backtesting
|
|
215
|
+
strategies for it, is Investment Management, which `LICENSE` makes
|
|
216
|
+
Commercial Use for every individual and every organization unless it is
|
|
217
|
+
Personal Trading. 1.2.0 shipped under the PineForge Source License 1.1, and
|
|
218
|
+
releases up to and including 1.1.0 under "PineForge Codegen — License", the
|
|
219
|
+
PolyForm Noncommercial License 1.0.0 with PineForge's supplemental sections;
|
|
220
|
+
copies of those releases keep the license they shipped with. `LICENSE` is the
|
|
221
|
+
controlling text; `LEGAL.md` summarizes it and is not legal advice.
|
|
222
|
+
- Packaging: the PyPI classifier and `@pineforge/codegen-pyodide`'s
|
|
223
|
+
`package.json` license field are 1.2.0's; the `LICENSE` both packages carry
|
|
224
|
+
is version 1.2.
|
|
225
|
+
|
|
226
|
+
### Documentation
|
|
227
|
+
|
|
228
|
+
- The README's scoreboard of `main` renders from the facts tokens of
|
|
229
|
+
`pineforge-release` at 3e39d64
|
|
230
|
+
([#174](https://github.com/pineforge-4pass/pineforge-codegen-oss/pull/174)):
|
|
231
|
+
baseline `pineforge-parity-baseline-20261005-input-reanchor-781b8f00`
|
|
232
|
+
(engine 3c414528, this repository at 39545379), 7,975 excellent and 14
|
|
233
|
+
strong of 7,989 graded probes, none below strong.
|
|
234
|
+
Release 1.3.0 is graded on registry baseline <!-- pf:releases[1.3.0].scoreboard.id|code -->`pineforge-parity-baseline-20261006-engine-7a1f01c0`<!-- /pf -->,
|
|
235
|
+
which holds <!-- pf:releases[1.3.0].scoreboard.excellent|int -->7,982<!-- /pf --> excellent and <!-- pf:releases[1.3.0].scoreboard.strong|int -->7<!-- /pf --> strong of <!-- pf:releases[1.3.0].scoreboard.graded|int -->7,989<!-- /pf --> graded probes,
|
|
236
|
+
and <!-- pf:releases[1.3.0].scoreboard.belowStrong|int -->0<!-- /pf --> below strong. It measured engine <!-- pf:releases[1.3.0].scoreboard.engineCommit|short -->7a1f01c0<!-- /pf -->
|
|
237
|
+
([pineforge-engine#347](https://github.com/pineforge-4pass/pineforge-engine/pull/347)'s
|
|
238
|
+
merge), which v1.3.0 equals in behaviour, and this repository at <!-- pf:releases[1.3.0].scoreboard.codegenCommit|short -->3e50082f<!-- /pf -->
|
|
239
|
+
([#177](https://github.com/pineforge-4pass/pineforge-codegen-oss/pull/177)'s
|
|
240
|
+
merge). The pr-gates of the later code changes, #178's receipts and the
|
|
241
|
+
hardening of emitted string values, changed no graded probe, and the
|
|
242
|
+
release's other changes are documentation.
|
|
243
|
+
- `docs/PUBLIC_CONTRACT.md` describes the confirmed-bar and order-shapes
|
|
244
|
+
receipts ([#173](https://github.com/pineforge-4pass/pineforge-codegen-oss/pull/173),
|
|
245
|
+
[#178](https://github.com/pineforge-4pass/pineforge-codegen-oss/pull/178)),
|
|
246
|
+
and the README's License section, `LEGAL.md` and the npm README name the
|
|
247
|
+
PineForge Source License 1.2
|
|
248
|
+
([#177](https://github.com/pineforge-4pass/pineforge-codegen-oss/pull/177)).
|
|
249
|
+
|
|
250
|
+
## 1.2.0 — 2026-10-05
|
|
251
|
+
|
|
252
|
+
A minor release: generated strategy libraries gain the compiled execution
|
|
253
|
+
capability receipt that engine `v1.2.0` adds to the C ABI, every diagnostic
|
|
254
|
+
carries a stable code and named arguments, and the package is licensed under
|
|
255
|
+
the PineForge Source License 1.1. It covers the changes merged to `main` since
|
|
256
|
+
1.1.0:
|
|
257
|
+
[#167](https://github.com/pineforge-4pass/pineforge-codegen-oss/pull/167)
|
|
258
|
+
changes the emitted C++,
|
|
259
|
+
[#166](https://github.com/pineforge-4pass/pineforge-codegen-oss/pull/166)
|
|
260
|
+
adds diagnostic codes to the Python and JSON results and raises a script's
|
|
261
|
+
first error in source order again,
|
|
262
|
+
[#171](https://github.com/pineforge-4pass/pineforge-codegen-oss/pull/171)
|
|
263
|
+
classifies diagnostic codes in linear time, moves to the PineForge Source
|
|
264
|
+
License 1.1 and renders the README's scoreboard, and
|
|
265
|
+
[#168](https://github.com/pineforge-4pass/pineforge-codegen-oss/pull/168)
|
|
266
|
+
replaces the license. Codegen `1.2.0` supports only engine `v1.2.0`. Engine
|
|
267
|
+
`v1.2.0` defines `PF_CAPABILITIES_API_VERSION` (1) and declares two functions
|
|
268
|
+
in `<pineforge/pineforge.h>`
|
|
269
|
+
([pineforge-engine#332](https://github.com/pineforge-4pass/pineforge-engine/pull/332))
|
|
270
|
+
that the C++ of codegen 1.2.0 defines; the pair keeps C ABI version 4 and the
|
|
271
|
+
script ABI epoch `engine_script_run_v19`.
|
|
272
|
+
|
|
273
|
+
### Compatibility and migration
|
|
274
|
+
|
|
275
|
+
- Regenerate C++ with 1.2.0 and relink it against engine `v1.2.0`'s headers
|
|
276
|
+
and `libpineforge.a`. The C++ defines the capability functions only when the
|
|
277
|
+
engine's `pineforge/pineforge.h` defines both `PF_SETTINGS_API_VERSION` and
|
|
278
|
+
`PF_CAPABILITIES_API_VERSION`, as engine `v1.2.0`'s does. Against headers
|
|
279
|
+
without `PF_CAPABILITIES_API_VERSION`, such as engine `v1.1.0`'s, that block
|
|
280
|
+
compiles to nothing and the library has no receipt; this does not make such
|
|
281
|
+
a pair supported. C++ generated by 1.1.0 has no receipt either. Engine
|
|
282
|
+
`v1.2.0`'s live runner warns that it cannot prove a library without a
|
|
283
|
+
receipt eligible, and runs it (see "Compiled execution capabilities").
|
|
284
|
+
- Every generated C++ file changes: it gains the capability block. Beyond
|
|
285
|
+
that, the C++ does not change: for the engine's 325 public corpus sources
|
|
286
|
+
and this repository's 277 gate fixtures, each transpiled in a fresh process,
|
|
287
|
+
1.2.0's C++ with the capability block removed is 1.1.0's C++ byte for byte,
|
|
288
|
+
and the 13 fixtures the gate expects to be refused are refused with the same
|
|
289
|
+
message. A script name spelled `strategy_capabilities_api_version` or
|
|
290
|
+
`strategy_capabilities_receipt` is renamed in the C++ (for example
|
|
291
|
+
`pf_safe_strategy_capabilities_receipt`), so a script cannot shadow the new
|
|
292
|
+
functions; input keys are unaffected.
|
|
293
|
+
- The Python and JSON contract is additive: each `Diagnostic` gains the
|
|
294
|
+
properties `code` and `args`, `pineforge_codegen` exports
|
|
295
|
+
`diagnostics_catalog()` and `render_diagnostic()`, and each JSON diagnostic
|
|
296
|
+
of `gate/glue.py`'s `transpile_json` success and error envelopes gains the
|
|
297
|
+
keys `code` and `args` (see "Diagnostic codes"). No argument, result key or
|
|
298
|
+
envelope is removed or renamed: `transpile()` and `transpile_full()` keep
|
|
299
|
+
their signatures and result keys, the envelopes keep every key they had, and
|
|
300
|
+
each diagnostic keeps its `message`, `hint`, severity and location. One
|
|
301
|
+
result changes: the error raised for a script with errors in more than one
|
|
302
|
+
place (see "First error in source order").
|
|
303
|
+
- Report keys: the engine's Docker harness (`docker/run_json.py`, which the
|
|
304
|
+
`pineforge-release` image runs) is the same file in engine `v1.2.0` as in
|
|
305
|
+
`v1.1.0`, so no report key is added, removed or renamed;
|
|
306
|
+
`metrics.equity.sharpe_tv` and `sortino_tv` (`EQUITY_REPORT_KEYS`) are
|
|
307
|
+
unchanged, and the engine's ADR-0001 keeps serialized report keys as they
|
|
308
|
+
are. A report's fingerprint still differs between 1.1.0 and 1.2.0, since it
|
|
309
|
+
records the engine and codegen versions and the generated C++'s hash, and
|
|
310
|
+
the engine's Pine adapter changes since `v1.1.0` (such as
|
|
311
|
+
[pineforge-engine#330](https://github.com/pineforge-4pass/pineforge-engine/pull/330))
|
|
312
|
+
can change a run's trades.
|
|
313
|
+
- 1.2.0 is the first release under the PineForge Source License 1.1. Releases
|
|
314
|
+
up to and including 1.1.0 keep the license they shipped with (see
|
|
315
|
+
"License").
|
|
316
|
+
|
|
317
|
+
### Compiled execution capabilities
|
|
318
|
+
|
|
319
|
+
From [#167](https://github.com/pineforge-4pass/pineforge-codegen-oss/pull/167):
|
|
320
|
+
|
|
321
|
+
- Built against engine `v1.2.0`, a generated strategy library defines
|
|
322
|
+
`strategy_capabilities_api_version()`, which returns
|
|
323
|
+
`PF_CAPABILITIES_API_VERSION` (1), and `strategy_capabilities_receipt(s,
|
|
324
|
+
json, capacity, required, error, error_capacity)`, which writes the
|
|
325
|
+
strategy's capability receipt. It uses the statuses and the buffer protocol
|
|
326
|
+
of 1.1.0's `strategy_get_effective_settings`: called with a NULL buffer and
|
|
327
|
+
0, it returns `PF_SETTINGS_BUFFER_TOO_SMALL` and the size to allocate, the
|
|
328
|
+
NUL included; a short buffer gets an empty string, never partial JSON; a
|
|
329
|
+
NULL strategy returns `PF_SETTINGS_INVALID_ARGUMENT`; no exception gets
|
|
330
|
+
through. The base C ABI does not change.
|
|
331
|
+
- The receipt is canonical JSON (sorted keys, compact separators) written
|
|
332
|
+
into the C++ when it is generated, not read from a running strategy: every
|
|
333
|
+
handle returns the same bytes, before and after runs and setting changes.
|
|
334
|
+
Version 1 has the keys `version`, `declarations`, `requests`,
|
|
335
|
+
`requirements` and `unresolved`. `declarations` holds the `strategy()`
|
|
336
|
+
values of `calc_on_every_tick`, `calc_on_order_fills`,
|
|
337
|
+
`calc_on_every_history_tick`, `process_orders_on_close`,
|
|
338
|
+
`use_bar_magnifier`, `fill_orders_on_standard_ohlc`,
|
|
339
|
+
`backtest_fill_limits_assumption`, `currency`, `timeframe`,
|
|
340
|
+
`timeframe_gaps` and `dynamic_requests`, Pine's defaults where omitted;
|
|
341
|
+
positional arguments are read in Pine's parameter order. `requests` lists
|
|
342
|
+
each `request.security` and `request.security_lower_tf` site, recorded
|
|
343
|
+
request and request lowered to a run-time stop, with its function, symbol,
|
|
344
|
+
timeframe, lookahead, gaps, Heikin-Ashi flag and feed (`chart`,
|
|
345
|
+
`auxiliary`, `recorded` or `unpinned`). `requirements` says whether the
|
|
346
|
+
script needs other symbols' feeds, an FX curve (a `currency` other than
|
|
347
|
+
`currency.NONE`), recorded series or intrabar persistence (`varip`).
|
|
348
|
+
`unresolved` names what the receipt cannot state as a literal (a nonliteral
|
|
349
|
+
`strategy()` argument, a request's nonliteral timeframe or lookahead, a
|
|
350
|
+
request lowered to a run-time stop) and every use of `barstate.isrealtime`,
|
|
351
|
+
`timenow`, `barstate.islast`, `barstate.islastconfirmedhistory`,
|
|
352
|
+
`last_bar_index` and `last_bar_time`, in plots, labels and tables too. The
|
|
353
|
+
receipt proves declarations only, not that a stream computes what a batch
|
|
354
|
+
run computes.
|
|
355
|
+
- A host reads the receipt before it runs a strategy, to tell whether its
|
|
356
|
+
execution mode can honour what the strategy declares. Engine `v1.2.0`'s
|
|
357
|
+
live runner, `pineforge-live`, reads it before it opens its ledger
|
|
358
|
+
([pineforge-engine#332](https://github.com/pineforge-4pass/pineforge-engine/pull/332))
|
|
359
|
+
and refuses, naming the requirement, intrabar calculation
|
|
360
|
+
(`calc_on_every_tick`, `calc_on_order_fills`, `calc_on_every_history_tick`),
|
|
361
|
+
`process_orders_on_close`, the bar magnifier, standard-OHLC fills, nonzero
|
|
362
|
+
limit-fill verification, a `currency` or a `timeframe` declared in
|
|
363
|
+
`strategy()`, every true requirement, every request whatever its
|
|
364
|
+
timeframe, and every name in `unresolved`. A library without the
|
|
365
|
+
extension, such as one generated by 1.1.0, gets a warning that its
|
|
366
|
+
eligibility cannot be proved, and runs, its requests included. A batch run
|
|
367
|
+
does not read the receipt, and its computation is unchanged. The engine's
|
|
368
|
+
`docs/strategy-capabilities.md` gives the schema and the runner's policy,
|
|
369
|
+
and the
|
|
370
|
+
[public contract](docs/PUBLIC_CONTRACT.md#optional-compiled-execution-capabilities)
|
|
371
|
+
the codegen side.
|
|
372
|
+
|
|
373
|
+
### Diagnostic codes
|
|
374
|
+
|
|
375
|
+
From [#166](https://github.com/pineforge-4pass/pineforge-codegen-oss/pull/166):
|
|
376
|
+
|
|
377
|
+
- Every diagnostic carries a stable `code` (`PF-E1203` for an error,
|
|
378
|
+
`PF-W0412` for a warning) and `args`, the named raw values (identifiers,
|
|
379
|
+
types, keywords, numbers) its English `message` and `hint` were built from:
|
|
380
|
+
in `transpile_full(...)["diagnostics"]`, in `CompileError.diagnostics` and
|
|
381
|
+
in the JSON diagnostics of the `transpile_json` envelopes. They are read off
|
|
382
|
+
the diagnostic's text when first asked for, after the transpile, so the
|
|
383
|
+
emitted C++ does not depend on them; `message` and `hint` keep their text.
|
|
384
|
+
- `diagnostics_catalog()` returns the catalog, and `render_diagnostic(code,
|
|
385
|
+
args)` the English `(message, hint)` a code renders, equal to the
|
|
386
|
+
diagnostic's byte for byte. The catalog (schema
|
|
387
|
+
`pineforge-diagnostics-catalog/v1`, 628 codes) gives each code its
|
|
388
|
+
severity, area, ICU MessageFormat message and hint templates, argument
|
|
389
|
+
kinds and a one-line explanation, so an application can translate a
|
|
390
|
+
diagnostic by its code. It ships in the package as
|
|
391
|
+
`pineforge_codegen/diagnostics_catalog.json`, in
|
|
392
|
+
`@pineforge/codegen-pyodide` as the `./diagnostics_catalog.json` export,
|
|
393
|
+
and with the GitHub release as `diagnostics_catalog-v1.2.0.json`.
|
|
394
|
+
- A code is never removed or reused, and a changed meaning gets a new code
|
|
395
|
+
(`tests/fixtures/diagnostic_codes_pin.json`). See
|
|
396
|
+
[Diagnostic codes](docs/PUBLIC_CONTRACT.md#diagnostic-codes).
|
|
397
|
+
|
|
398
|
+
### First error in source order
|
|
399
|
+
|
|
400
|
+
- 1.1.0's settings metadata read every input's `defval`, `options`,
|
|
401
|
+
`minval`, `maxval` and `step` ahead of the script body, so an error there,
|
|
402
|
+
such as an unknown name in a later input's `minval`, was raised before an
|
|
403
|
+
error on an earlier line. 1.2.0 raises the script's first error in source
|
|
404
|
+
order again, as 1.0.1 did
|
|
405
|
+
([#166](https://github.com/pineforge-4pass/pineforge-codegen-oss/pull/166)).
|
|
406
|
+
The emitted C++ does not change.
|
|
407
|
+
|
|
408
|
+
### Security
|
|
409
|
+
|
|
410
|
+
- Classifying a diagnostic's code no longer stalls on crafted script text
|
|
411
|
+
([#171](https://github.com/pineforge-4pass/pineforge-codegen-oss/pull/171)).
|
|
412
|
+
As #166 merged it, the classifier matched each catalog template as a
|
|
413
|
+
backtracking regular expression over the message and hint, which carry text
|
|
414
|
+
the script spells: 1.8 KB of one template's text took 0.55 s to classify
|
|
415
|
+
and 3.4 KB took 23 s, a denial of service for `transpile_json`, which
|
|
416
|
+
classifies every diagnostic it returns, and for any host that reads
|
|
417
|
+
`code` or `args`. Classification now takes time linear in the text: the
|
|
418
|
+
same text grown to 6.6 MB classifies in milliseconds, with the same codes
|
|
419
|
+
and arguments. No release had the stall: it was on `main` from #166 to
|
|
420
|
+
#171, and 1.1.0 has no diagnostic codes.
|
|
421
|
+
|
|
422
|
+
### License
|
|
423
|
+
|
|
424
|
+
From [#168](https://github.com/pineforge-4pass/pineforge-codegen-oss/pull/168)
|
|
425
|
+
and [#171](https://github.com/pineforge-4pass/pineforge-codegen-oss/pull/171):
|
|
426
|
+
|
|
427
|
+
- 1.2.0 is the first release under the PineForge Source License 1.1, whose
|
|
428
|
+
licensor is pineforge, LLC. Releases up to and including 1.1.0 shipped
|
|
429
|
+
under "PineForge Codegen — License", the PolyForm Noncommercial License
|
|
430
|
+
1.0.0 with PineForge's supplemental sections, and copies of those releases
|
|
431
|
+
keep that license. The PineForge Source License is not a PolyForm license.
|
|
432
|
+
`LICENSE` is the controlling text; `LEGAL.md` summarizes it and is not
|
|
433
|
+
legal advice.
|
|
434
|
+
- The permitted purposes, free of charge, are noncommercial purposes,
|
|
435
|
+
personal uses, use by the noncommercial organizations `LICENSE` lists for
|
|
436
|
+
their teaching, research and other operations, and Personal Trading: a
|
|
437
|
+
natural person's research, development and backtesting of strategies and
|
|
438
|
+
execution of trades for their own account with their own capital, as
|
|
439
|
+
`LICENSE` defines them. Investment Management (managing, advising on or
|
|
440
|
+
trading investment capital, researching, developing or backtesting
|
|
441
|
+
strategies for it, or operating the software for others who do, whoever
|
|
442
|
+
the capital belongs to and whether or not for a fee) is Commercial Use for
|
|
443
|
+
every individual and every organization, noncommercial organizations
|
|
444
|
+
included, unless it is Personal Trading. So is any other use that is not a
|
|
445
|
+
permitted purpose, such as use by, for or on behalf of a company, fund,
|
|
446
|
+
partnership or other organization. Commercial Use needs a commercial
|
|
447
|
+
license from pineforge, LLC (enterprise@pineforge.dev).
|
|
448
|
+
- Distributing copies is not Commercial Use, except that distributing the
|
|
449
|
+
software, changed or not, embedded in or bundled with a product or service
|
|
450
|
+
made available to others is Commercial Use unless it is a permitted
|
|
451
|
+
purpose. That exception is what 1.1 adds to the PineForge Source License
|
|
452
|
+
1.0, which #168 put on `main` and no release carried.
|
|
453
|
+
- `LICENSE` defines Output: the code the software generates, such as the
|
|
454
|
+
C++ it generates from PineScript, and any program or library built from
|
|
455
|
+
it; backtest results, charts, reports and trade signals are not Output.
|
|
456
|
+
- Packaging: the PyPI classifier is `License :: Other/Proprietary License`
|
|
457
|
+
(it was `License :: Free for non-commercial use`), and
|
|
458
|
+
`@pineforge/codegen-pyodide`'s `package.json` says
|
|
459
|
+
`"license": "SEE LICENSE IN LICENSE"` (it said
|
|
460
|
+
`PolyForm-Noncommercial-1.0.0`) and the package contains `LICENSE`.
|
|
461
|
+
|
|
462
|
+
### Documentation
|
|
463
|
+
|
|
464
|
+
- The README's scoreboard of `main` renders from the facts tokens of
|
|
465
|
+
`pineforge-release` at 03b8dcc
|
|
466
|
+
([#171](https://github.com/pineforge-4pass/pineforge-codegen-oss/pull/171)):
|
|
467
|
+
baseline `pineforge-parity-baseline-20261004-engine-6b77f061` (engine
|
|
468
|
+
6b77f061, this repository at 285ac035), 7,970 excellent and 19 strong of
|
|
469
|
+
7,989 graded probes, none below strong.
|
|
470
|
+
Release 1.2.0 is graded on registry baseline
|
|
471
|
+
`pineforge-parity-baseline-20261005-engine-52292db9`: 7,970 excellent and
|
|
472
|
+
19 strong of 7,989 graded probes, none below strong, with engine 52292db9
|
|
473
|
+
([pineforge-engine#339](https://github.com/pineforge-4pass/pineforge-engine/pull/339)'s
|
|
474
|
+
merge), which v1.2.0 equals in behaviour, and this repository at 48e7a13b,
|
|
475
|
+
whose emitted C++ is codegen 1.2.0's: the release's remaining changes are
|
|
476
|
+
documentation.
|
|
477
|
+
- `docs/PUBLIC_CONTRACT.md` describes the capability functions
|
|
478
|
+
([#167](https://github.com/pineforge-4pass/pineforge-codegen-oss/pull/167))
|
|
479
|
+
and diagnostic codes
|
|
480
|
+
([#166](https://github.com/pineforge-4pass/pineforge-codegen-oss/pull/166)).
|
|
481
|
+
The README's License section and `LEGAL.md` name the PineForge Source
|
|
482
|
+
License and pineforge, LLC and give enterprise@pineforge.dev for commercial
|
|
483
|
+
licenses, and `CONTRIBUTING.md` names pineforge, LLC as the party a
|
|
484
|
+
Contributor License Agreement grants rights to
|
|
485
|
+
([#168](https://github.com/pineforge-4pass/pineforge-codegen-oss/pull/168),
|
|
486
|
+
[#171](https://github.com/pineforge-4pass/pineforge-codegen-oss/pull/171)).
|
|
487
|
+
|
|
23
488
|
## 1.1.0 — 2026-10-04
|
|
24
489
|
|
|
25
490
|
A minor release: generated strategy libraries gain the checked settings
|
|
@@ -4,7 +4,7 @@ This is the source-available PineScript v6 to C++ translator. Read the
|
|
|
4
4
|
[license and contribution terms](LEGAL.md) before sending a material change.
|
|
5
5
|
Contributions use the Developer Certificate of Origin: add a `Signed-off-by`
|
|
6
6
|
line with `git commit -s`. Material contributions also require a Contributor
|
|
7
|
-
License Agreement so
|
|
7
|
+
License Agreement so pineforge, LLC can include them in its commercial licenses;
|
|
8
8
|
contact luis@4pass.com.tw before opening a material pull request.
|
|
9
9
|
|
|
10
10
|
## Local setup
|
|
@@ -47,12 +47,14 @@ before treating a run as complete.
|
|
|
47
47
|
|
|
48
48
|
## Engine pairing
|
|
49
49
|
|
|
50
|
-
Codegen `main` is developed and tested against engine `main`. Codegen 1.
|
|
51
|
-
pairs with engine `v1.
|
|
50
|
+
Codegen `main` is developed and tested against engine `main`. Codegen 1.3.0
|
|
51
|
+
pairs with engine `v1.3.0`, the pair the
|
|
52
52
|
[`pineforge-release`](https://github.com/pineforge-4pass/pineforge-release)
|
|
53
|
-
image `1.
|
|
54
|
-
`1.0
|
|
55
|
-
|
|
53
|
+
image `1.3.0` ships, codegen 1.2.0 with engine `v1.2.0`, the pair of the image
|
|
54
|
+
`1.2.0`, codegen 1.1.0 with engine `v1.1.0`, the pair of the image `1.1.0`,
|
|
55
|
+
codegen 1.0.1 with engine `v1.0.1`, the pair of the image `1.0.1`, and codegen
|
|
56
|
+
1.0.0 with engine `v1.0.0`, the pair of the image `1.0.0`. On the
|
|
57
|
+
0.x line the two version lineages are independent:
|
|
56
58
|
the last 0.x release, codegen 0.10.4, pairs with engine `v0.13.1`, the pair
|
|
57
59
|
the `pineforge-release` image `0.1.25` ships.
|
|
58
60
|
|
|
@@ -116,6 +118,11 @@ publishing is a separate release operation.
|
|
|
116
118
|
engine.
|
|
117
119
|
- Keep [CHANGELOG.md](CHANGELOG.md) current for user-visible changes. Its
|
|
118
120
|
release-note policy applies to both stable and prerelease tags.
|
|
121
|
+
- CI clears a pull request from a fork into `main` only when it changes
|
|
122
|
+
documentation or legal text alone (Markdown, `docs/`, `LICENSE`, `NOTICE`).
|
|
123
|
+
A fork's code change does not run in CI here: its `gate` check fails until a
|
|
124
|
+
maintainer pushes the branch to this repository and opens a pull request
|
|
125
|
+
from it, which runs the full gate.
|
|
119
126
|
- The README describes the latest release and becomes the PyPI page of the
|
|
120
127
|
next release: when a version is tagged, update its "Releases and this
|
|
121
128
|
README" section, its engine-pairing table and its release markers.
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# Legal information
|
|
2
|
+
|
|
3
|
+
Summary of licensing, third-party components, and trademarks for `pineforge-codegen`. **Not** legal advice; consult counsel for your use case.
|
|
4
|
+
|
|
5
|
+
## License
|
|
6
|
+
|
|
7
|
+
`pineforge-codegen` is **source-available**, **not** OSI "open source." It is distributed under the **PineForge Source License 1.2** — see [LICENSE](LICENSE), which is the controlling text.
|
|
8
|
+
|
|
9
|
+
- **Noncommercial use** — any noncommercial purpose, and use by a charitable organization, educational institution, public research organization, public safety or health organization, environmental protection organization or government institution for its teaching, research and other operations, is free.
|
|
10
|
+
- **Personal Trading** — free for a natural person to research, develop or backtest strategies and trade their **own** account with their **own** capital. Household, joint and retirement accounts and ordinary margin count as their own; a company's or fund's account does not, even a company they wholly own. An account that a proprietary-trading firm or funded-trader program provides or allocates to them, including a challenge, evaluation or simulated account, does not count as their own either.
|
|
11
|
+
- **Investment management** — managing, advising on or trading investment capital, or researching strategies for it (a friend's, clients' or investors' capital, an endowment, a pension fund, a public fund, a foundation's treasury, or an account a proprietary-trading firm or funded-trader program provides or allocates, including challenge, evaluation and simulated accounts), is **Commercial Use for every individual and every organization**, noncommercial organizations included, except Personal Trading.
|
|
12
|
+
- **Commercial Use** — investment management and any other use that is not free, such as use by or for a company or fund, embedding the software or its output in a product or service for others, or operating a hosted/public-facing service with it, requires a **commercial license** (email **enterprise@pineforge.dev**; the commercial-license store is coming soon).
|
|
13
|
+
|
|
14
|
+
Describe this project as **"source-available"** rather than "open source." The runtime it targets, [`pineforge-engine`](https://github.com/pineforge-4pass/pineforge-engine), is separate and **Apache-2.0**.
|
|
15
|
+
|
|
16
|
+
Releases up to and including 1.1.0 were published under the license text that came with them (the PolyForm Noncommercial License 1.0.0 with a PineForge supplement); copies of those releases keep that license. The PineForge Source License is a separate license and is not a PolyForm license.
|
|
17
|
+
|
|
18
|
+
The PineForge Source License 1.1 replaced 1.0, and 1.2 replaces 1.1, for the code on `main` and in releases from 1.3.0 on. Version 1.1 clarified one point, that distributing the software or its output, changed or not, embedded in or bundled with a product or service made available to others is Commercial Use, not free distribution, unless it is for a permitted purpose. Version 1.2 makes two points explicit: an account a proprietary-trading firm or funded-trader program provides or allocates, including a challenge, evaluation or simulated account, is not a person's own account or capital, so trading it is not Personal Trading; and the capital in such an account, real or simulated, is investment capital, so trading it is investment management, which is Commercial Use. It changes nothing else. Release 1.2.0 was published under 1.1 and keeps that text; 1.3.0 is the first release published under 1.2.
|
|
19
|
+
|
|
20
|
+
## Copyright and licensor
|
|
21
|
+
|
|
22
|
+
The licensor is **pineforge, LLC**, a Delaware limited liability company. It holds the copyright in `pineforge-codegen`; the founder's rights in the software are assigned to it. Commercial licenses are granted by pineforge, LLC.
|
|
23
|
+
|
|
24
|
+
## What this repository is
|
|
25
|
+
|
|
26
|
+
A pure-Python PineScript v6 → C++ transpiler that emits source against the public PineForge engine C-ABI. It implements PineScript v6 from **TradingView's publicly published language documentation**; it does **not** incorporate TradingView proprietary source. Names like "PineScript v6" are used **nominatively** to describe the input language.
|
|
27
|
+
|
|
28
|
+
## Third-party components
|
|
29
|
+
|
|
30
|
+
The transpiler has **no runtime dependencies** (`transpile()` and `transpile_full()` are its supported Python entry points). Development/test extras declared in `pyproject.toml` (`pytest`, etc.) are under their own upstream licenses. The opt-in compile checks invoke a C++ compiler against the separately-licensed Apache-2.0 engine headers; they skip cleanly without an engine checkout.
|
|
31
|
+
|
|
32
|
+
## Trademarks and affiliation
|
|
33
|
+
|
|
34
|
+
**TradingView** and **PineScript** are trademarks of their respective owners. `pineforge-codegen` is **not** affiliated with, endorsed by, or certified by TradingView. References to "PineScript v6" and any compatibility/parity statements are **nominative** and factual — compatibility and technical testing only, not a partnership or certification.
|
|
35
|
+
|
|
36
|
+
## Contributions
|
|
37
|
+
|
|
38
|
+
Contributions are accepted under a Developer Certificate of Origin (`Signed-off-by`). Because this project is **dual-licensed** (source-available + a sold commercial license), material contributions require a Contributor License Agreement granting pineforge, LLC the right to include the contribution in its commercial licenses; otherwise it cannot be accepted. See [CONTRIBUTING.md](CONTRIBUTING.md) (or contact luis@4pass.com.tw) before opening a material PR.
|
|
39
|
+
|
|
40
|
+
## No warranty
|
|
41
|
+
|
|
42
|
+
Provided **"AS IS"**, without warranty of any kind, per the LICENSE's no-warranty / no-liability terms. Transpiler output and any downstream backtest results are **not** investment advice and carry no warranty of trading outcomes.
|