You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The package root resolves to `schemas/v1.1.0/index.json`. That index is the current machine-readable map of every canonical verb schema in the release.
14
+
15
+
## What is normative vs illustrative
16
+
17
+
Normative machine artifacts:
18
+
19
+
-`schemas/v1.1.0/`
20
+
-`schemas/v1.1.0/index.json`
21
+
-`manifest.json`
22
+
23
+
Illustrative conformance fixtures:
24
+
25
+
-`examples/v1.1.0/commercial/<verb>/valid/`
26
+
-`examples/v1.1.0/commercial/<verb>/invalid/`
27
+
28
+
Normative interpretive docs:
29
+
30
+
-`README.md`
31
+
-`SPEC.md`
32
+
-`POLICY.md`
33
+
-`SECURITY_PROVENANCE.md`
34
+
35
+
## Safe consumer path
36
+
37
+
1. Confirm the package version is `1.1.0` and that `manifest.json` reports `status: current`.
38
+
2. Load `schemas/v1.1.0/index.json` and select the request and receipt schema paths you need.
39
+
3. Configure your validator from the flat per-verb schema files under `schemas/v1.1.0/commercial/<verb>/`.
40
+
4. Run checksum verification before mirroring or vendoring artifacts:
41
+
```bash
42
+
npm run validate:integrity
43
+
sha256sum -c checksums.txt
44
+
```
45
+
5. Use `examples/v1.1.0/` as conformance fixtures, not as a substitute for schema requirements.
46
+
47
+
## Choosing between v1.1.0 and v1.0.0
48
+
49
+
Choose `v1.1.0` unless you are maintaining compatibility with an older integration that still depends on the published historical nested `requests/` and `receipts/` paths.
50
+
51
+
-`v1.1.0` is the current canonical flat line.
52
+
-`v1.0.0` is retained legacy for compatibility and audit.
53
+
54
+
Do not teach `v1.0.0` paths as current implementation guidance.
55
+
56
+
## Checksums and provenance
57
+
58
+
The checksum-covered payload for this release is intentionally narrow:
59
+
60
+
-`schemas/v1.1.0/`
61
+
-`examples/v1.1.0/`
62
+
-`manifest.json`
63
+
64
+
`checksums.txt` is the ledger for that payload. It is not itself inside the hashed set. Prose docs remain authoritative for interpretation and release process, but they are outside the checksum boundary.
65
+
66
+
## TypeScript guidance
67
+
68
+
There is no public `examples/v1.1.0/**/ts/` teaching surface in the current release. If a future release restores TypeScript examples, they should be explicitly governed, validated, and documented before they are treated as part of the public implementer surface.
4. Regenerate checksums for the new current line's machine-artifact set.
71
+
4. Draft release notes for the new line before publication.
72
+
5. Regenerate checksums for the new current line's machine-artifact set.
56
73
57
74
For the current line, the canonical path model is flat:
58
75
@@ -61,17 +78,19 @@ For the current line, the canonical path model is flat:
61
78
62
79
## Manual publication follow-up
63
80
64
-
The repository does not automate publication, IPFS pinning, CID capture, or mirror updates. If your release process uses those steps, perform them manually after the new version line has passed validation:
81
+
The repository does not automate publication, GitHub Release publication, IPFS pinning, CID capture, or mirror updates. If your release process uses those steps, perform them manually after the new version line has passed validation:
65
82
66
-
1. Pin the checksum-covered release artifact set to IPFS, if that distribution channel is being used for the release.
67
-
2. Capture resulting CIDs in the external release record if your publication process requires them.
68
-
3. Update commandlayer.org mirrors to match the release paths exactly.
69
-
4. Update any Agent Card schema bindings that reference the superseded version.
83
+
1. Publish the GitHub Release using `releases/v1.1.0.md` or the corresponding new-version draft.
84
+
2. Pin the checksum-covered release artifact set to IPFS, if that distribution channel is being used for the release.
85
+
3. Capture resulting CIDs in the external release record if your publication process requires them.
86
+
4. Update commandlayer.org mirrors to match the release paths exactly.
87
+
5. Update any Agent Card schema bindings that reference the superseded version.
70
88
71
89
## Release hygiene
72
90
73
91
- Keep the current line obvious.
74
92
- Keep legacy lines explicitly marked as legacy.
75
93
- Keep schema paths flat and mirror-safe.
76
94
- Keep checksum scope explicit.
95
+
- Keep GitHub Releases and repository docs in sync.
-**Historical legacy line:**`v1.0.0`, retained under `schemas/v1.0.0/` and `examples/v1.0.0/`
27
+
-**Release note draft for GitHub Releases:**`releases/v1.1.0.md`
27
28
28
29
`v1.1.0` is flat. Its canonical schema URIs are the exact file-mirror paths published under `https://commandlayer.org/schemas/v1.1.0/commercial/<verb>/`.
29
30
@@ -45,6 +46,29 @@ The stack story is singular:
45
46
- Agent Cards point directly at the current commercial schema URIs.
46
47
- Runtimes execute those contracts but do not redefine them.
47
48
49
+
## Integrator quickstart
50
+
51
+
For consumers who need the shortest safe path:
52
+
53
+
1. Install the package and import the current index entrypoint.
2. Treat `schemas/v1.1.0/index.json` as the authoritative map of current schemas and verb inventory.
61
+
3. Prefer `schemas/v1.1.0/commercial/<verb>/<verb>.request.schema.json` and `...receipt.schema.json` directly for validator configuration.
62
+
4. Verify the machine-artifact set before mirroring or vendoring:
63
+
```bash
64
+
npm run validate:integrity
65
+
sha256sum -c checksums.txt
66
+
```
67
+
5. Ignore `v1.0.0` unless you are maintaining compatibility with historical nested paths.
68
+
6. Treat schemas and `manifest.json` as normative machine artifacts. Treat examples as illustrative conformance fixtures. Treat prose docs as normative interpretation and release-process guidance.
69
+
70
+
A longer external-consumer workflow lives in `INTEGRATOR.md`.
71
+
48
72
## Commercial execution model
49
73
50
74
Protocol-Commercial is x402-first.
@@ -86,13 +110,13 @@ The verbs use those layers intentionally:
86
110
87
111
## Verb set
88
112
89
-
| Verb | Purpose |
90
-
| --- | --- |
91
-
|`authorize`| Reserve payment authority before capture or settlement |
92
-
|`checkout`| Finalize an order and request commercial capture |
93
-
|`purchase`| Complete a one-step paid commercial action |
94
-
|`ship`| Advance commercial fulfillment state for a settled checkout or purchase |
95
-
|`verify`| Verify a commercial receipt, settlement, payment, or shipment target |
113
+
| Verb | Purpose | Teaching note |
114
+
| --- | --- | --- |
115
+
|`authorize`| Reserve payment authority before capture or settlement | Teaches pre-capture approval, denial, and authorization evidence |
116
+
|`checkout`| Finalize an order and request commercial capture | Teaches negotiated session state, amount binding, and settlement outcomes |
117
+
|`purchase`| Complete a one-step paid commercial action | Teaches direct payment input without a separate checkout negotiation round |
118
+
|`ship`| Advance commercial fulfillment state for a settled checkout or purchase | Teaches how fulfillment references upstream commercial settlement without replaying payment semantics |
119
+
|`verify`| Verify a commercial receipt, settlement, payment, or shipment target | Teaches evidence-based attestation and inconclusive vs failed outcomes |
Protocol-Commercial v1.1.0 does **not** use a current-line `_shared/` tree. Every v1.1.0 request and receipt schema is self-contained, flat, and mirror-safe.
130
155
156
+
Current-line example governance is equally explicit:
157
+
158
+
-`valid/` contains illustrative conforming request and receipt fixtures.
159
+
-`invalid/` contains isolated negative fixtures intended to fail validation cleanly.
160
+
- No `examples/v1.1.0/**/ts/` tree is currently part of the public release surface.
161
+
131
162
## Scope boundaries
132
163
133
164
This repository defines:
@@ -201,7 +232,6 @@ sha256sum -c checksums.txt
201
232
-`npm run validate` runs the full validation suite for the current release line.
202
233
-`npm run validate:schemas` checks current-line metadata, schema identity, layout, and manifest/index alignment expectations.
203
234
-`npm run validate:examples` validates every current-line JSON valid and invalid example against the canonical schemas.
204
-
- Current-line TypeScript example directories are intentionally excluded from the authoritative teaching surface; do not add `examples/v1.1.0/**/ts/` back without adding explicit validation and release governance for them.
205
235
-`npm run validate:integrity` verifies the checksum file scope and hash coverage for the current release artifact set.
@@ -211,12 +241,26 @@ Agent Cards v1.1.0 should bind directly to the current flat commercial schema UR
211
241
212
242
Protocol-Commons and Protocol-Commercial therefore tell one coherent story:
213
243
244
+
- Commons defines base actions.
245
+
- Commercial defines monetized overlays.
246
+
- Agent Cards point at the current flat commercial schema paths.
247
+
- Legacy nested v1.0.0 paths remain published only for compatibility.
248
+
249
+
## Checksum boundary and provenance summary
250
+
214
251
The v1.1.0 checksum-covered machine-artifact set is intentionally limited to:
215
252
216
253
-`schemas/v1.1.0/`
217
254
-`examples/v1.1.0/`
218
255
-`manifest.json`
219
256
220
-
`checksums.txt` is the generated hash ledger for that machine-artifact set; it describes that surface but is not itself part of the hashed payload. Release-defining prose docs such as `README.md`, `SPEC.md`, `POLICY.md`, `SECURITY_PROVENANCE.md`, and `ONBOARDING.md` are authoritative guidance, but they are outside the checksum surface unless the tooling is expanded deliberately in a later release.
257
+
`checksums.txt` is the generated hash ledger for that machine-artifact set; it describes that surface but is not itself part of the hashed payload. Release-defining prose docs such as `README.md`, `SPEC.md`, `POLICY.md`, `SECURITY_PROVENANCE.md`, `INTEGRATOR.md`, and `ONBOARDING.md` are authoritative guidance, but they are outside the checksum surface unless the tooling is expanded deliberately in a later release.
258
+
259
+
For external verification, the minimal path is:
221
260
222
-
After any mutation to the checksum-covered set, regenerate `checksums.txt` and repin any release bundle that depends on those artifacts.
261
+
1. Install or vendor the package.
262
+
2. Inspect `manifest.json` to confirm the current line is `v1.1.0`.
263
+
3. Validate checksum coverage with `npm run validate:integrity`.
264
+
4. Verify local file hashes with `sha256sum -c checksums.txt`.
265
+
5. Load `schemas/v1.1.0/index.json` and bind validators from the listed request and receipt schema paths.
266
+
6. Ignore `v1.0.0` unless compatibility requires the historical line.
0 commit comments