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.3 KiB
JSON
128 lines
3.3 KiB
JSON
{
|
|
"$schema": "../../schema/test-vector.schema.json",
|
|
"name": "Framing - Minimal Valid Packets",
|
|
"spec_ref": "src/01-wire-format.md",
|
|
"protocol_version": 0,
|
|
"description": "Tests the smallest valid packets for each route type. A valid packet must have at least header(1) + path_len(1) + payload(1+) bytes, plus 4 bytes for transport codes if applicable.",
|
|
"vectors": [
|
|
{
|
|
"id": "min-001",
|
|
"description": "Minimal FLOOD packet: 3 bytes (header + path_len + 1-byte payload)",
|
|
"type": "encode_decode",
|
|
"structured": {
|
|
"header": {
|
|
"version": 0,
|
|
"payload_type": "raw_custom",
|
|
"route_type": "flood"
|
|
},
|
|
"path": {
|
|
"hash_size": 1,
|
|
"hash_count": 0,
|
|
"hashes": []
|
|
},
|
|
"payload": {
|
|
"data": "FF"
|
|
}
|
|
},
|
|
"binary": "3D 00 FF",
|
|
"notes": "Smallest valid FLOOD packet: 3 bytes total."
|
|
},
|
|
{
|
|
"id": "min-002",
|
|
"description": "Minimal DIRECT packet: 3 bytes",
|
|
"type": "encode_decode",
|
|
"structured": {
|
|
"header": {
|
|
"version": 0,
|
|
"payload_type": "raw_custom",
|
|
"route_type": "direct"
|
|
},
|
|
"path": {
|
|
"hash_size": 1,
|
|
"hash_count": 0,
|
|
"hashes": []
|
|
},
|
|
"payload": {
|
|
"data": "FF"
|
|
}
|
|
},
|
|
"binary": "3E 00 FF",
|
|
"notes": "Smallest valid DIRECT packet: 3 bytes total."
|
|
},
|
|
{
|
|
"id": "min-003",
|
|
"description": "Minimal TRANSPORT_FLOOD packet: 7 bytes (header + 4 transport + path_len + 1-byte payload)",
|
|
"type": "encode_decode",
|
|
"structured": {
|
|
"header": {
|
|
"version": 0,
|
|
"payload_type": "raw_custom",
|
|
"route_type": "transport_flood"
|
|
},
|
|
"transport_codes": [
|
|
0,
|
|
0
|
|
],
|
|
"path": {
|
|
"hash_size": 1,
|
|
"hash_count": 0,
|
|
"hashes": []
|
|
},
|
|
"payload": {
|
|
"data": "FF"
|
|
}
|
|
},
|
|
"binary": "3C 0000 0000 00 FF",
|
|
"notes": "Smallest valid TRANSPORT_FLOOD packet: 7 bytes total."
|
|
},
|
|
{
|
|
"id": "min-004",
|
|
"description": "Minimal TRANSPORT_DIRECT packet: 7 bytes",
|
|
"type": "encode_decode",
|
|
"structured": {
|
|
"header": {
|
|
"version": 0,
|
|
"payload_type": "raw_custom",
|
|
"route_type": "transport_direct"
|
|
},
|
|
"transport_codes": [
|
|
0,
|
|
0
|
|
],
|
|
"path": {
|
|
"hash_size": 1,
|
|
"hash_count": 0,
|
|
"hashes": []
|
|
},
|
|
"payload": {
|
|
"data": "FF"
|
|
}
|
|
},
|
|
"binary": "3F 0000 0000 00 FF",
|
|
"notes": "Smallest valid TRANSPORT_DIRECT packet: 7 bytes total."
|
|
},
|
|
{
|
|
"id": "min-005",
|
|
"description": "Minimal ACK via FLOOD: 6 bytes (header + path_len + 4-byte CRC)",
|
|
"type": "encode_decode",
|
|
"structured": {
|
|
"header": {
|
|
"version": 0,
|
|
"payload_type": "ack",
|
|
"route_type": "flood"
|
|
},
|
|
"path": {
|
|
"hash_size": 1,
|
|
"hash_count": 0,
|
|
"hashes": []
|
|
},
|
|
"payload": {
|
|
"ack_crc": "00000000"
|
|
}
|
|
},
|
|
"binary": "0D 00 00000000",
|
|
"notes": "ACK with zero CRC. 6 bytes total."
|
|
}
|
|
]
|
|
}
|