Skip to content

Commit d6ebf12

Browse files
Merge pull request #66 from engineeredsoftware/v33/gate-1-interface-roadmap-opening
V33 Gate 1: Interface Roadmap And Spec Opening
2 parents 21da600 + be2bd58 commit d6ebf12

18 files changed

Lines changed: 1229 additions & 94 deletions

.github/pull_request_template.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
## Title
22

3-
Use the version and gate prefix for gate PRs: `V32 Gate N: Concise Topical Title`.
4-
Use the version and promotion prefix for version promotion PRs: `V32 Canonical Promotion: Concise Topical Title`.
3+
Use the version and gate prefix for gate PRs: `V33 Gate N: Concise Topical Title`.
4+
Use the version and promotion prefix for version promotion PRs: `V33 Canonical Promotion: Concise Topical Title`.
55

66
## Closure
77

.github/workflows/bitcode-canon-quality.yml

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,15 @@ jobs:
119119
node scripts/check-bitcode-spec-family.mjs --version V32 --mode draft --current-target V31
120120
fi
121121
;;
122+
spec:\ V33*|spec:\ v33*)
123+
POINTER="$(cat BITCODE_SPEC.txt)"
124+
if [ "$POINTER" = "V33" ]; then
125+
node scripts/check-bitcode-spec-family.mjs --version V33 --mode promoted --current-target V33
126+
else
127+
node scripts/check-bitcode-spec-family.mjs --version V33 --mode draft --current-target V32
128+
fi
129+
;;
122130
*)
123-
echo "Skipping strict spec-title conformance; title is not a V29/V30/V31/V32 spec change."
131+
echo "Skipping strict spec-title conformance; title is not a V29/V30/V31/V32/V33 spec change."
124132
;;
125133
esac

.github/workflows/bitcode-gate-quality.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,7 @@ jobs:
129129
node scripts/check-bitcode-spec-family.mjs --version V33 --mode draft --current-target V32
130130
fi
131131
node scripts/check-v32-gate10-promotion-readiness.mjs --promotion-mode --skip-branch-check
132+
node scripts/check-v33-gate1-interface-roadmap-opening.mjs --skip-branch-check
132133
else
133134
echo "Unexpected BITCODE_SPEC.txt pointer: $POINTER" >&2
134135
exit 1

BITCODE_SPEC_V33.md

Lines changed: 591 additions & 0 deletions
Large diffs are not rendered by default.

BITCODE_SPEC_V33_DELTA.md

Lines changed: 162 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,162 @@
1+
# Bitcode Spec V33 Delta
2+
3+
## Status
4+
5+
- Version: `V33`
6+
- V33 state: draft target delta opened; interface-depth decisions are being specified over active V32 canon
7+
- Current canonical/latest target: `V32`
8+
- Prior canonical anchor: `BITCODE_SPEC_V32.md`
9+
- Prior generated proof appendix: `BITCODE_SPEC_V32_PROVEN.md`
10+
- Generated structured artifact inventory: draft V33 specifying artifacts `.bitcode/v33-spec-family-report.json` and `.bitcode/v33-canonical-input-report.json`; later V33 gates may add source-safe interface proof artifacts
11+
- Source parity state: Gate 1 opens the V33 parity ledger and checker; source implementation remains gate-scoped
12+
- Spec companion: `BITCODE_SPEC_V33.md`
13+
- Notes companion: `BITCODE_SPEC_V33_NOTES.md`
14+
- Parity companion: `BITCODE_SPEC_V33_PARITY_MATRIX.md`
15+
- Generated proof appendix: `BITCODE_SPEC_V33_PROVEN.md` only after V33 promotion
16+
17+
## Why V33 exists
18+
19+
V32 promoted proof and testing depth across Terminal, Reading, Protocol/BTD, Auxillaries, MCP, ChatGPT App, API, ledger/database/object-storage, browser proof, readiness rehearsal, and promotion automation.
20+
That made the core commercial system more provable.
21+
22+
V33 exists because external enterprise consumers still need a deeper, stable, source-safe interface layer beyond the V28 MCP API and ChatGPT App MVP.
23+
MCP API, ChatGPT App, public API, and package consumers must share package-owned schemas, authorization policies, source-safe examples, compatibility tests, and telemetry/proof replay hooks instead of duplicating Terminal-local behavior.
24+
25+
## Accepted V33 decisions
26+
27+
- V32 remains active canon during V33 drafting.
28+
- V33 gate branches are opened from `version/v33` and merged back only when their gate acceptance criteria are closed.
29+
- V33 owns interface-depth: MCP API, ChatGPT App, public API, interface authorization policy, API schemas, examples, compatibility matrices, source-safe Read license contracts, AssetPack rights contracts, and interface telemetry/proof replay hooks.
30+
- V33 does not reopen BTD supply law, Reading pipeline product law, Exchange product depth, website Conversations product depth, deployment operations depth, or broad telemetry/documentation programs.
31+
- V33 interface contracts must be package-owned before they are exposed by MCP tools, ChatGPT App actions, public API routes, or Terminal handoffs.
32+
- Interface responses must be source-safe before settlement and must fail closed on missing auth, missing wallet capability, missing read license, unpaid protected-source request, stale proof, projection drift, or incompatible schema.
33+
- `InterfaceContractCatalog`, `InterfaceAuthorizationPolicy`, `ReadLicenseInterfaceContract`, `AssetPackRightsInterfaceContract`, `APISchemaCompatibilityMatrix`, and `InterfaceTelemetryProofHook` are the initial V33 contract anchors.
34+
35+
## Explicitly deferred
36+
37+
- V34 owns deployment, host capability, distributed execution, runtime/storage, environment lanes, CI/CD deployment approvals, rollback, upgrades, secret rotation, and repair playbooks beyond interface-owned hooks.
38+
- V35 owns deeper telemetry/documentation programs, dashboards, alert runbooks, public docs breadth, incident response, and operator guides beyond interface-owned proof hooks.
39+
- V36 owns deeper Exchange market behavior.
40+
- V37 owns website Conversations product depth.
41+
- Production-mainnet value-bearing launch remains explicitly blocked until a future promoted canon admits it.
42+
- Bridge chain-of-record implementation remains out of V33.
43+
44+
## Pre-Implementation Sequence
45+
46+
1. Open `version/v33` from promoted `main`.
47+
2. Open `v33/gate-1-interface-roadmap-opening` from `version/v33`.
48+
3. Create the V33 SPEC, DELTA, NOTES, and PARITY family while preserving `BITCODE_SPEC.txt -> V32`.
49+
4. Refresh `SPECIFICATIONS_ROADMAP.md` so V32 is active canon, V33 is draft target, and V34-V37 scopes remain coherent.
50+
5. Retarget gate-quality and canon-quality workflow posture checks to V32 active / V33 draft.
51+
6. Add `check:v33-gate1` and a V33 Gate 1 checker.
52+
7. Define V33 gates, acceptance criteria, carryforward parity rows, and post-V33 roadmap responsibilities.
53+
8. Validate spec family, canonical inputs, canon posture, workflows, roadmap truth, README/docs, and diff hygiene.
54+
9. Push the gate branch and open a pull request to `version/v33`.
55+
56+
## Commit-Body Direction
57+
58+
V33 gate commit bodies should describe the closed gate, specification changes, implementation surfaces, tests, proof commands, and accepted boundaries.
59+
The eventual V33 promotion commit body must name all closed V33 gates, generated interface proof artifacts, source-safe interface contracts, compatibility evidence, and the `BITCODE_SPEC.txt` pointer change from `V32` to `V33`.
60+
It must explicitly defer V34 deployment depth, V35 telemetry/documentation breadth, V36 Exchange depth, V37 Conversations depth, bridge chain-of-record implementation, and value-bearing mainnet launch.
61+
62+
## Gate Delta
63+
64+
### Gate 1: V33 Interface Roadmap And Spec Opening
65+
66+
Gate 1 opens V33 correctly:
67+
68+
- V33 SPEC, DELTA, NOTES, and PARITY files exist.
69+
- `BITCODE_SPEC.txt` remains `V32`.
70+
- README, roadmap, PR template, package docs, and workflows describe V32 active / V33 draft posture.
71+
- `check:v33-gate1` validates branch naming, spec family, notes, parity, roadmap truth, workflow posture, interface-depth vocabulary, and promotion boundaries.
72+
- The V33 gate list is explicit before interface implementation begins.
73+
74+
### Gate 2: Interface Inventory And Contract Catalog
75+
76+
Gate 2 inventories every active and deferred interface surface and creates the package-owned `InterfaceContractCatalog`.
77+
78+
Closure acceptance:
79+
80+
- MCP API, ChatGPT App, public API, Terminal handoff, package consumers, deferred Exchange hooks, and deferred Conversations hooks are enumerated;
81+
- each row names owner package, action/tool/route id, schema id, auth policy, source-safety class, example fixture, validation command, compatibility status, and failure mode;
82+
- deferred surfaces are represented as blocked or planned rows, not hidden confidence.
83+
84+
### Gate 3: MCP API Tool And Registry Contracts
85+
86+
Gate 3 hardens MCP API contracts.
87+
88+
Closure acceptance:
89+
90+
- MCP tool discovery is package-derived and source-safe;
91+
- tool input/output schemas, auth policy, denial states, proof roots, and examples are covered by tests;
92+
- MCP responses do not expose protected source before settlement.
93+
94+
### Gate 4: ChatGPT App Action And Tool Contracts
95+
96+
Gate 4 hardens ChatGPT App contracts.
97+
98+
Closure acceptance:
99+
100+
- ChatGPT App actions use package-owned schemas and source-safe response renderers;
101+
- denied-state readability and repair actions are tested;
102+
- Read, Need, Finding Fits, preview, fee, settlement, and delivery actions match the same contracts used by API and MCP.
103+
104+
### Gate 5: Interface Authorization Policy Fail-Closed
105+
106+
Gate 5 centralizes interface authorization.
107+
108+
Closure acceptance:
109+
110+
- `InterfaceAuthorizationPolicy` covers auth issuer, organization/team/role, wallet capability, read-license posture, AssetPack rights, protected-source disclosure, and repair posture;
111+
- API, MCP, ChatGPT App, and Terminal handoff tests share policy fixtures;
112+
- missing or stale authority fails closed with readable denial.
113+
114+
### Gate 6: Read License And AssetPack Rights Interface Contracts
115+
116+
Gate 6 proves paid/unpaid Reading boundaries across interfaces.
117+
118+
Closure acceptance:
119+
120+
- `ReadLicenseInterfaceContract` covers Read request, reviewed Need, Finding Fits admission, preview, fee quote, license posture, paid/unpaid denial, and proof root;
121+
- `AssetPackRightsInterfaceContract` covers source-safe preview, BTD range/read-right state, BTC settlement, delivery admission, and rights transfer projection;
122+
- pre-settlement protected source remains locked in all interface fixtures.
123+
124+
### Gate 7: API Schemas Examples And Compatibility Matrix
125+
126+
Gate 7 creates the schema compatibility spine.
127+
128+
Closure acceptance:
129+
130+
- `APISchemaCompatibilityMatrix` records schema ids, consumer surfaces, examples, breaking-change policy, compatibility status, fixture paths, and validation commands;
131+
- examples exist for success, denied, blocked, stale, and deferred states;
132+
- versionless API path discipline remains enforced.
133+
134+
### Gate 8: Interface Telemetry And Proof Replay Hooks
135+
136+
Gate 8 binds interface actions to proof replay.
137+
138+
Closure acceptance:
139+
140+
- `InterfaceTelemetryProofHook` records execution id, interface id, action id, request root, response root, ledger/database/object-storage roots, denial or success posture, and replay command;
141+
- hooks are source-safe and do not print secrets, protected prompts, or protected source;
142+
- proof replay joins Terminal, API, MCP, and ChatGPT App activity consistently.
143+
144+
### Gate 9: Interface Consumer UX Regression Proof
145+
146+
Gate 9 proves consumer readability and handoff quality.
147+
148+
Closure acceptance:
149+
150+
- MCP API, ChatGPT App, public API examples, Terminal handoff, and denied states have regression proof;
151+
- source-safe summary, proof roots, repair steps, and fee/rights preview are readable without overexposure;
152+
- interface consumer tests avoid brittle demo-only behavior.
153+
154+
### Gate 10: V33 Promotion Readiness
155+
156+
Gate 10 owns final generated proof, promotion workflow support, and V33 closure.
157+
158+
Closure acceptance:
159+
160+
- V33 promotion checks validate all gate artifacts, interface contracts, compatibility matrices, telemetry proof hooks, and generated proof appendix support;
161+
- promotion workflow can rewrite active V33 / draft V34 posture;
162+
- `version/v33` can be requested into `main` only after all V33 gates close.

BITCODE_SPEC_V33_NOTES.md

Lines changed: 63 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -3,58 +3,83 @@
33
## Status
44

55
- Version: `V33`
6-
- Canonical pointer: `BITCODE_SPEC.txt` -> `V32`
7-
- Active canonical anchor: `BITCODE_SPEC_V32.md`
8-
- Active generated proof appendix: `BITCODE_SPEC_V32_PROVEN.md`
9-
- V33 state: notes-only draft opening
6+
- V33 state: draft target notes opened; interface-depth notes are active for V33 gate work over V32 canon
107
- Current canonical/latest target: `V32`
11-
- Current active draft target: `V33`
12-
- Generated structured artifact inventory: none for V33 yet
13-
- Source parity state: notes-only opening; V33 source parity begins only after the first gate opens implementation.
14-
- Scope: next-version notes for interface, integration, and enterprise shippability depth after V32 provation/testing closure.
8+
- Prior canonical anchor: `BITCODE_SPEC_V32.md`
9+
- Prior generated proof appendix: `BITCODE_SPEC_V32_PROVEN.md`
10+
- Generated structured artifact inventory: draft V33 specifying artifacts `.bitcode/v33-spec-family-report.json` and `.bitcode/v33-canonical-input-report.json`; later V33 gates may add source-safe interface proof artifacts
11+
- Source parity state: Gate 1 opens source parity tracking; implementation begins after roadmap/spec acceptance on scoped gate branches
12+
- Scope: working notes for V33 interface-depth over promoted V32 proof and testing canon
1513

16-
This NOTES file does not promote V33 and does not authorize implementation before a scoped V33 gate branch opens.
14+
## Notes companion rule
1715

18-
## Notes-only draft rule
19-
20-
This file is planning memory only while V32 is canon.
21-
Requirements become binding only when V33 is explicitly opened as the draft-target SPEC family on `version/v33` and then through numbered V33 gate branches.
22-
Any V33 implementation must be gate-scoped, never not first-gate work hidden in a promotion repair branch.
16+
This NOTES file is a working companion to `BITCODE_SPEC_V33.md`.
17+
It records intent, risks, and carryforward reminders, but the SPEC, DELTA, PARITY, source, generated artifacts, and gate checkers carry binding closure.
18+
Notes must never promote V33 by themselves and must never authorize direct work on `main`.
2319

2420
## Concise current-system reading
2521

26-
V32 closes provation, testing, promotion proof generation, deterministic replay, and testnet/mainnet readiness rehearsal posture for the commercial Bitcode system.
27-
V33 begins from that V32 canon and should make the interface and operational integration layers more directly enterprise-shippable without weakening the Bitcoin, GitHub, compute, storage, or build/process boundaries proven by V32.
22+
V32 is active canon.
23+
It proves the commercial system across Terminal, Reading, Protocol/BTD, Auxillaries, MCP, ChatGPT App, API, ledger/database/object-storage, browser proof, readiness rehearsal, and promotion automation.
24+
25+
V33 begins from that canon to deepen commercial interfaces beyond the V28 MVP.
26+
The main question is whether enterprise consumers can operate Bitcode through MCP API, ChatGPT App, public API, and package contracts with the same source-safe law, proof roots, rights boundaries, and repair posture Terminal already exposes.
27+
28+
## Simplified-spec reading rule
29+
30+
Read V33 in this order:
31+
32+
1. `BITCODE_SPEC.txt` to confirm the active pointer is still `V32`.
33+
2. `BITCODE_SPEC_V32.md` and `BITCODE_SPEC_V32_PROVEN.md` for active law and proof base.
34+
3. `BITCODE_SPEC_V33.md` for draft target law.
35+
4. `BITCODE_SPEC_V33_DELTA.md` for what changes from V32 to V33.
36+
5. `BITCODE_SPEC_V33_PARITY_MATRIX.md` for gate and source parity.
37+
6. This NOTES file for constraints, reminders, and deferred work.
38+
39+
Do not read `_legacy/` as active law.
40+
41+
## V33 gate plan
2842

29-
## Deferred from V32
43+
1. Gate 1: V33 Interface Roadmap And Spec Opening.
44+
2. Gate 2: Interface Inventory And Contract Catalog.
45+
3. Gate 3: MCP API Tool And Registry Contracts.
46+
4. Gate 4: ChatGPT App Action And Tool Contracts.
47+
5. Gate 5: Interface Authorization Policy Fail-Closed.
48+
6. Gate 6: Read License And AssetPack Rights Interface Contracts.
49+
7. Gate 7: API Schemas Examples And Compatibility Matrix.
50+
8. Gate 8: Interface Telemetry And Proof Replay Hooks.
51+
9. Gate 9: Interface Consumer UX Regression Proof.
52+
10. Gate 10: V33 Promotion Readiness.
3053

31-
The following work was intentionally deferred from V32 because V32 focused on provation/testing closure and canonical promotion mechanics:
54+
## Interface-depth notes
3255

33-
- Bitcoin production-mainnet settlement enablement beyond V32's blocked rehearsal posture;
34-
- GitHub delivery and review ergonomics beyond the V32 source-safe proof surfaces;
35-
- compute execution provider hardening where long-running pipeline hosts, retries, and pushed completion events need production contracts;
36-
- storage retention, replay, and customer-facing evidence lifecycle policies beyond generated proof artifacts;
37-
- build/process automation that keeps version gates, promotion proofs, and deployment proofs green without ad hoc repair;
38-
- enterprise interface depth for non-terminal consumers after V32 validated source-safe canon and proof generation.
56+
- MCP API and ChatGPT App are commercial interfaces, not demonstration surfaces.
57+
- Public API route shapes must be versionless in source paths and package-owned in schemas.
58+
- Interfaces must use Protocol/BTD/Reading primitives instead of recreating Terminal-only JSON shapes.
59+
- Source-safe preview is admissible before settlement; protected AssetPack source is not.
60+
- Denied states must be readable and repairable, not generic errors.
61+
- Compatibility rows should be generated where possible and checked in CI.
62+
- Examples must cover success, denied, blocked, stale, deferred, unpaid, and paid states without protected source leakage.
3963

40-
## Candidate V33 workstreams
64+
## Carryforward from V32
4165

42-
V33 candidate workstreams should be ordered into explicit gates before implementation:
66+
V33 inherits these V32 truths:
4367

44-
- MCP API maturation beyond the V28 MVP for registry-derived AssetPack range, read-right, wallet, fee, journal, reconciliation, proof, and operational actions;
45-
- ChatGPT App maturation beyond the V28 MVP as the first integratable chatbot application interface;
46-
- non-Auxillaries non-website application interfaces that must ship commercially, primarily API and chatbot-app consumers;
47-
- interface authorization, policy checks, and fail-closed read/license behavior over V27/V28 registry truths;
48-
- API packaging, schemas, examples, compatibility rules, and contract tests;
49-
- interface-specific MCP and ChatGPT App QA, including route/action discovery, denied-state readability, and proof-root surfacing;
50-
- handoff of hosting, distributed execution, CI/CD, broad deployment operations, telemetry depth, and public documentation to V34 and V35.
68+
- `ReadNeedComprehensionSynthesis` and `ReadFitsFindingSynthesis` are the active Reading pipelines.
69+
- agents are PTRR agents;
70+
- PTRR sub-steps are ThricifiedGenerations;
71+
- source-safe AssetPack preview remains separate from paid full-source delivery;
72+
- BTC fee, BTD read/right transfer, ledger truth, database projection, object-storage delivery, and PR delivery remain synchronized but distinct;
73+
- staging-testnet and production-mainnet remain separate operational lanes;
74+
- production-mainnet value-bearing launch is not admitted by V33 opening.
5175

52-
## Non-goals during V33 opening
76+
## Explicit deferrals
5377

54-
V33 deepens commercial interface surfaces beyond the V28 MVP.
55-
It should not reopen V27 tokenomics law, replace V32 provation/testing depth, or absorb V34 deployment and V35 telemetry/documentation work except for narrow interface-owned hooks.
78+
- V34 owns deployment, host capability, distributed execution, runtime/storage, deployment approvals, rollback, upgrades, secret rotation, and repair playbooks.
79+
- V35 owns broad telemetry/documentation, public docs, dashboards, runbooks, incident response, operator guides, and rollout material.
80+
- V36 owns deeper Exchange.
81+
- V37 owns website Conversations.
5682

5783
## Return To V32
5884

59-
Do not start V33 implementation during V32 promotion repair.
60-
Record API, MCP, ChatGPT App, customer integration, deployment, telemetry, and documentation gaps beyond V32 as future V33 inputs until `version/v33` and its first gate branch are opened.
85+
If V33 work threatens active protocol law, protected-source boundaries, BTD settlement invariants, or generated proof stability, return to V32 canon and write the conflict as a V33 gate blocker instead of silently changing source behavior.

0 commit comments

Comments
 (0)