Finalize v1 platform stack spec pass#2
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the repository’s documentation to move spec.md from “option-preserving planning” to a more build-ready v1 direction by adding a near-top V1 decisions section, a normative v1 contract/API surface, and a Phase 0 compatibility report template; it also aligns the README’s “initial development direction” with that selected v1 path.
Changes:
- Adds a normative V1 Architecture Decisions section and reclassifies non-v1 modes as compatibility-gated or deferred.
- Introduces a detailed V1 Contract/API Surface (structs, events, errors, functions, access rules, transitions, timeout/failure behavior) plus a small platform API mapping.
- Adds a Phase 0 Compatibility Report Template and updates README direction to match the v1 target.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 11 comments.
| File | Description |
|---|---|
| spec.md | Adds explicit v1 architecture decisions; defines a normative v1 contract/API surface and Phase 0 compatibility report template; rephrases previously open-ended sections to v1 + gated modes. |
| README.md | Updates the “Initial development direction” section to reflect the selected v1 mode and Phase 0 next step. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
@copilot review |
|
Review-resolution update for latest head |
Summary
Closes #1
Tests / checks
rg -n "V1 Architecture Decisions|Section 6.7|V1 Contract/API Surface|Phase 0 Compatibility Report Template|Required Transaction Evidence|SDK and Tooling Gaps|Selected v1 target" spec.md README.mdrg -n "Open options|exact storage layout remains open|option-preserving|must support multiple|Token Host generates registry|first supported FOC payer|first product default" spec.md README.mdgit diff --checkBenchmarks
Not applicable: documentation/spec-only change.
Notes
No contracts, coordinator code, SDK changes, or Token Host generation work are implemented in this PR. Smart-account payer, contract treasury payer, user-pays mode, direct browser upload, BYO coordinator, and proof/challenge finalization remain compatibility-gated future modes.