vtx.foundation draft d03

Definitions

The machine-readable definitions of VTX 1: CDDL for every frame, JSON Schemas for the text form and the application interface, examples that must pass and examples that must fail, and the validator that checks all of them. Where a document and the definitions disagree, the definitions decide, and the document is fixed.

── 01 ──

Download

file
vtx-definitions-1-d03.tar.gz
size
923,510 bytes, 293 files
sha-256
284e95590c888bbcbce209e85149277e230bb2a67f618ed7c30fdb39890bc06e (.sha256)
draft
core d03; each extension's draft is in ext/registry.json
licence
MIT
── 02 ──

Contents

PathWhat it defines
vtx-wire-1.cddlThe CBOR payload of every frame of the core, per channel (RFC 8610)
vtx-ops-1.schema.jsonOne line of the text form: every scene op (JSON Schema 2020-12)
vtx-intent-1.schema.jsonOne intent, client to application
vtx-app-1.schema.jsonAny line an application writes on the application interface
vtx-app-events-1.schema.jsonAny line the server writes to an application
examples/Valid and invalid op streams, intents, application sessions, glyph resources and test vectors
ext/Each extension's CDDL, schemas and examples, the combined files and the registry
hosts/The Wayland Host 1 and RDP Bridge 1 bindings with their logs
tools/The validator and the generators of schemas, vectors and examples
── 03 ──

What the validator proves

Run python3 tools/validate.py after pip install -r requirements.txt. On the published bundle it passes 2564 checks and fails none; this site is only built when it does. For the core, it checks in this order:

  1. Both JSON Schemas are valid JSON Schema 2020-12.
  2. Every line of examples/valid/*.jsonl passes vtx-ops-1 (intents.jsonl: vtx-intent-1), and each valid op stream also passes the scene rules of wire spec Section 7 (parents exist, components sit in a region, ...).
  3. Every line of examples/invalid/schema-violations.jsonl fails vtx-ops-1; every line of examples/invalid/scene-rules.jsonl passes the schema but breaks a scene rule; every line of examples/invalid/intents.jsonl fails.
  4. vtx-wire-1.cddl parses, accepts a sample of every payload kind (including UPDATE frames built from the example streams), and rejects malformed samples.
  5. Glyph resources referenced by the examples exist and match their hash.
  6. QUIC varints round-trip, and the CREDIT frame bytes match Section 3.
  7. Core session traces (examples/traces/) follow Sections 3 to 6 and 14: every valid trace replays through tools/core_trace.py, and every case in examples/traces/invalid/traces.jsonl fails for its stated reason.

It then runs the same kinds of checks for every extension and both host bindings: their schemas and CDDL, their valid and broken traces, and the vectors they publish.