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>
142 lines
4.0 KiB
JSON
142 lines
4.0 KiB
JSON
{
|
|
"$schema": "../schema/test-vector.schema.json",
|
|
"name": "KISS Protocol - Framing",
|
|
"spec_ref": "src/19-kiss-protocol.md",
|
|
"protocol_version": 0,
|
|
"description": "Tests KISS frame encoding including FEND delimiters, byte stuffing (FESC sequences), and type byte encoding.",
|
|
"vectors": [
|
|
{
|
|
"id": "kiss-001",
|
|
"description": "Simple data frame: FEND + type(0x00) + data + FEND",
|
|
"type": "encode_decode",
|
|
"structured": {
|
|
"header": {
|
|
"version": 0,
|
|
"payload_type": "raw_custom",
|
|
"route_type": "flood"
|
|
},
|
|
"path": {
|
|
"hash_size": 1,
|
|
"hash_count": 0,
|
|
"hashes": []
|
|
},
|
|
"payload": {
|
|
"data": "C0 00 DEADBEEF C0"
|
|
}
|
|
},
|
|
"binary": "3D 00 C0 00 DEADBEEF C0",
|
|
"notes": "KISS frame: FEND(C0) + DataFrame(00) + 4 bytes data + FEND(C0). Data contains no special bytes so no escaping needed."
|
|
},
|
|
{
|
|
"id": "kiss-002",
|
|
"description": "Data frame with FEND in data (byte stuffing required)",
|
|
"type": "encode_decode",
|
|
"structured": {
|
|
"header": {
|
|
"version": 0,
|
|
"payload_type": "raw_custom",
|
|
"route_type": "flood"
|
|
},
|
|
"path": {
|
|
"hash_size": 1,
|
|
"hash_count": 0,
|
|
"hashes": []
|
|
},
|
|
"payload": {
|
|
"data": "C0 00 AA DBDC BB C0"
|
|
}
|
|
},
|
|
"binary": "3D 00 C0 00 AA DBDC BB C0",
|
|
"notes": "Data byte 0xC0 escaped as DB DC (FESC TFEND). Original data: AA C0 BB."
|
|
},
|
|
{
|
|
"id": "kiss-003",
|
|
"description": "Data frame with FESC in data (byte stuffing required)",
|
|
"type": "encode_decode",
|
|
"structured": {
|
|
"header": {
|
|
"version": 0,
|
|
"payload_type": "raw_custom",
|
|
"route_type": "flood"
|
|
},
|
|
"path": {
|
|
"hash_size": 1,
|
|
"hash_count": 0,
|
|
"hashes": []
|
|
},
|
|
"payload": {
|
|
"data": "C0 00 AA DBDD BB C0"
|
|
}
|
|
},
|
|
"binary": "3D 00 C0 00 AA DBDD BB C0",
|
|
"notes": "Data byte 0xDB escaped as DB DD (FESC TFESC). Original data: AA DB BB."
|
|
},
|
|
{
|
|
"id": "kiss-004",
|
|
"description": "Data frame with both FEND and FESC in data",
|
|
"type": "encode_decode",
|
|
"structured": {
|
|
"header": {
|
|
"version": 0,
|
|
"payload_type": "raw_custom",
|
|
"route_type": "flood"
|
|
},
|
|
"path": {
|
|
"hash_size": 1,
|
|
"hash_count": 0,
|
|
"hashes": []
|
|
},
|
|
"payload": {
|
|
"data": "C0 00 DBDC DBDD C0"
|
|
}
|
|
},
|
|
"binary": "3D 00 C0 00 DBDC DBDD C0",
|
|
"notes": "Original data: C0 DB. Escaped: DBDC DBDD."
|
|
},
|
|
{
|
|
"id": "kiss-005",
|
|
"description": "SetHardware frame: GetIdentity (sub-cmd 0x01)",
|
|
"type": "encode_decode",
|
|
"structured": {
|
|
"header": {
|
|
"version": 0,
|
|
"payload_type": "raw_custom",
|
|
"route_type": "flood"
|
|
},
|
|
"path": {
|
|
"hash_size": 1,
|
|
"hash_count": 0,
|
|
"hashes": []
|
|
},
|
|
"payload": {
|
|
"data": "C0 06 01 C0"
|
|
}
|
|
},
|
|
"binary": "3D 00 C0 06 01 C0",
|
|
"notes": "KISS frame: FEND + SetHardware(06) + GetIdentity(01) + FEND."
|
|
},
|
|
{
|
|
"id": "kiss-006",
|
|
"description": "SetHardware response: Identity (sub-cmd 0x81) with pubkey",
|
|
"type": "encode_decode",
|
|
"structured": {
|
|
"header": {
|
|
"version": 0,
|
|
"payload_type": "raw_custom",
|
|
"route_type": "flood"
|
|
},
|
|
"path": {
|
|
"hash_size": 1,
|
|
"hash_count": 0,
|
|
"hashes": []
|
|
},
|
|
"payload": {
|
|
"data": "C0 06 81 AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA C0"
|
|
}
|
|
},
|
|
"binary": "3D 00 C0 06 81 AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA C0",
|
|
"notes": "KISS response: FEND + SetHardware(06) + Identity(81) + 32-byte pubkey + FEND."
|
|
}
|
|
]
|
|
}
|