swaitsandClaude Opus 4.7
d785e35919
Set up the protocol spec as an mdBook and add a GitHub Actions workflow that builds it on every push/PR and deploys to GitHub Pages on main. The repo is now both a machine-readable corpus and a browsable, searchable site. Structure changes (one-time, mechanical): - Rename the spec source directory from `spec/` to `src/` to match mdBook's default convention. All 21 chapter files move; their internal relative cross-links are unchanged. - Add `src/SUMMARY.md` as the mdBook table of contents, grouping chapters under Wire Format, Payloads, Cryptography & Identity, and Routing & Higher-Layer Protocols. - Add `book.toml` at repo root: title, author, search enabled, fold enabled, edit-on-GitHub links, navy theme. - Add `.github/workflows/mdbook.yml`: build on push + PR, deploy on push to main only (configure-pages + upload-pages-artifact + deploy-pages from actions/). - Add `/book/` to .gitignore. Reference updates so the old path is fully retired: - Every `spec_ref` in `corpus/**/*.json` rewritten from `spec/` to `src/` (54 files). - Schema description text and example path in `corpus/schema/test-vector.schema.json`. - `README.md`: prominent link to the published site near the top; "What's Here" updated for the new layout. - `CONTRIBUTING.md`: spec-editing instructions point at `src/` and note the SUMMARY.md requirement. - `CLAUDE.md`: directory-layout notes updated. CHANGELOG.md historical entries intentionally keep their `spec/` paths since those record what the paths were at the time of those commits. After this lands, the user needs to enable GitHub Pages in repo settings with source = "GitHub Actions" (one-time, manual). The workflow will then publish to https://swaits.github.io/meshcore-spec/ on every push to main. Verified locally: `mdbook build` produces a clean book/ tree with all 21 chapters rendered and the SUMMARY-driven sidebar populated. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
128 lines
3.4 KiB
JSON
128 lines
3.4 KiB
JSON
{
|
|
"$schema": "../../schema/test-vector.schema.json",
|
|
"name": "Trace Payload - Basic",
|
|
"spec_ref": "src/10-payload-trace.md",
|
|
"protocol_version": 0,
|
|
"description": "Tests the basic 9-byte TRACE payload structure: tag(4) + auth_code(4) + flags(1).",
|
|
"vectors": [
|
|
{
|
|
"id": "trc-001",
|
|
"description": "Basic trace with tag=1, auth_code=2, flags=0",
|
|
"type": "encode_decode",
|
|
"structured": {
|
|
"header": {
|
|
"version": 0,
|
|
"payload_type": "trace",
|
|
"route_type": "flood"
|
|
},
|
|
"path": {
|
|
"hash_size": 1,
|
|
"hash_count": 0,
|
|
"hashes": []
|
|
},
|
|
"payload": {
|
|
"tag": 1,
|
|
"auth_code": 2,
|
|
"flags": 0
|
|
}
|
|
},
|
|
"binary": "25 00 01000000 02000000 00",
|
|
"notes": "tag=1 LE=01000000, auth_code=2 LE=02000000, flags=0."
|
|
},
|
|
{
|
|
"id": "trc-002",
|
|
"description": "Trace with large tag and auth_code values",
|
|
"type": "encode_decode",
|
|
"structured": {
|
|
"header": {
|
|
"version": 0,
|
|
"payload_type": "trace",
|
|
"route_type": "flood"
|
|
},
|
|
"path": {
|
|
"hash_size": 1,
|
|
"hash_count": 0,
|
|
"hashes": []
|
|
},
|
|
"payload": {
|
|
"tag": 4294967295,
|
|
"auth_code": 305419896,
|
|
"flags": 0
|
|
}
|
|
},
|
|
"binary": "25 00 FFFFFFFF 78563412 00",
|
|
"notes": "tag=0xFFFFFFFF, auth_code=0x12345678 LE=78563412."
|
|
},
|
|
{
|
|
"id": "trc-003",
|
|
"description": "Trace with flags indicating 1-byte path hash size (flags & 0x03 = 0)",
|
|
"type": "encode_decode",
|
|
"structured": {
|
|
"header": {
|
|
"version": 0,
|
|
"payload_type": "trace",
|
|
"route_type": "flood"
|
|
},
|
|
"path": {
|
|
"hash_size": 1,
|
|
"hash_count": 0,
|
|
"hashes": []
|
|
},
|
|
"payload": {
|
|
"tag": 100,
|
|
"auth_code": 200,
|
|
"flags": 0
|
|
}
|
|
},
|
|
"binary": "25 00 64000000 C8000000 00",
|
|
"notes": "flags=0: path_hash_size = 1 << (0 & 3) = 1 byte."
|
|
},
|
|
{
|
|
"id": "trc-004",
|
|
"description": "Trace with flags indicating 2-byte path hash size (flags & 0x03 = 1)",
|
|
"type": "encode_decode",
|
|
"structured": {
|
|
"header": {
|
|
"version": 0,
|
|
"payload_type": "trace",
|
|
"route_type": "flood"
|
|
},
|
|
"path": {
|
|
"hash_size": 1,
|
|
"hash_count": 0,
|
|
"hashes": []
|
|
},
|
|
"payload": {
|
|
"tag": 100,
|
|
"auth_code": 200,
|
|
"flags": 1
|
|
}
|
|
},
|
|
"binary": "25 00 64000000 C8000000 01",
|
|
"notes": "flags=1: path_hash_size = 1 << (1 & 3) = 2 bytes."
|
|
},
|
|
{
|
|
"id": "trc-005",
|
|
"description": "Trace sent via direct routing with path hashes appended to payload",
|
|
"type": "encode_decode",
|
|
"structured": {
|
|
"header": {
|
|
"version": 0,
|
|
"payload_type": "trace",
|
|
"route_type": "direct"
|
|
},
|
|
"path": {
|
|
"hash_size": 1,
|
|
"hash_count": 0,
|
|
"hashes": []
|
|
},
|
|
"payload": {
|
|
"data": "01000000 02000000 00 AABBCC"
|
|
}
|
|
},
|
|
"binary": "26 00 01000000 02000000 00 AABBCC",
|
|
"notes": "Header 0x26 = TRACE(9)+DIRECT(2). path_len=0 (path field used for SNR). Payload: 9-byte header + 3 path hash bytes. Using raw payload since the appended hashes are semantically part of the trace."
|
|
}
|
|
]
|
|
}
|