36f4842a0f
The deviations from MSF that draft-charlot-moq-wai-packaging-01 listed, and two more the
extended check found, fixed in every writer:
- version: each writer wrote MSF's root version as the number 1; MSF §5.1.1 requires a
string, "draft-01" for draft-ietf-moq-msf-01, which wai-pack, joule-moq-ingest,
joule-moq-remote, joule-moq-interop and joule-moq-web now write. No reader compared it.
The readers of a room's catalogs (the room page, catalogVersionKnown; the gateway's WHEP
session, catalog::version_known) now refuse a version they do not know (MSF §5.1.1),
reading "draft-01" and the number 1, which the room deployed at
wai.transaction.science/room/ (live since 2026-10-19) writes until it is deployed again;
the interop subscriber requires "draft-01", which its own publisher writes.
- the packager's cmaf floor tracks: isLive false and initRef (the floor name), with the
floor's initialization segment inline in initDataList (CMSF §3.1, the field name of
draft-ietf-moq-cmsf-01), after tracks (MSF §5.1.7): moq/catalog.json is RFC 8785
canonical but for that member, written last (packaging §8.4). FloorView carries the
init segment's bytes; pack_verify.py writes the same catalog independently;
catalogs/expected.json names each case's floor by its sequence header OBU and
timescale, from which both write the init segment.
- event timelines: the room page and the remote host wrote "mimetype" for MSF's mimeType,
and no depends (MSF §8.2); they write mimeType and depends [] (the events track is the
only track of its namespace, and MSF §5.2.14 names dependencies in the declaring
track's namespace). live-events §8.1 says so.
- wai-link: the contribution gateway's link track carries WLK1 link records, signed,
chained and verified by live_contribution_verify.py: neither envelopes ("wai") nor JSON
events ("eventtimeline"), and read by a subscriber that verifies a room's tracks. A real
interop surface, so it is defined rather than mapped: live-contribution §5.4 defines
it, moq-streaming-format §3 names it, the registry lists it as a catalog wire
identifier (export regenerated), and the -01 draft defines it in a new §9 (IANA table,
required fields, correspondence). The gateway writes it as before.
The corpus is regenerated by `wai-pack conformance regen` (pack-conformance/ and the
composed package of wai-web/compose); each other writer's test holds a committed sample
(joule-moq-ingest/tests/catalogs/{whip,contribution}.json,
joule-moq-remote/tests/catalogs/host.json, joule-moq-interop/tests/catalogs/wai-receipts.json,
joule-moq-web/e2e/catalogs/room.json), written by its JOULE_MOQ_*_WRITE_CATALOGS=1 run. The
room page's catalog moves into web/room/catalog.js, tested by catalog.test.mjs with the
page's other unit tests.
wai/ietf/catalog_check.py reads every writer's catalogs and, under --strict, holds MSF's
and CMSF's own rules: the version string, a name and isLive on every track, an MSF field
in another case, an event timeline's eventType, mimeType and depends, eventType elsewhere,
a cmaf track's initRef naming an inline initDataList entry that follows tracks; wai-link
tracks are held to the draft's §9. The repository checks run it with --strict. 23
catalogs of 6 writers pass with no note; the self-test plants 43 faults (a numeric
version, a cmaf track without isLive, mimetype and an undefined packaging value among
them) and catches each.
The draft stays -01 (the wire meaning of "wai" is unchanged): Implementation Status says
the deviations are fixed. xml2rfc 3.35.0 renders it with no warning; idnits 2.17.1: 0
errors, 0 flaws, 1 warning (no first-submission date on the datatracker).
Co-Authored-By: Claude Opus 5.5 <[email protected]>
6.8 KiB
WAI packaging for the MOQT Streaming Format
This directory holds draft-charlot-moq-wai-packaging, an Internet-Draft in the IETF's
xml2rfc v3 format, and the check that holds our implementation to it.
What the draft defines
- The packaging value
waiof the MOQT Streaming Format (MSF): every MOQT object of the track is one wholeWAI1envelope (§4.1, §4.2). - Dispatch, per object (§4.3): the envelope's capability, else its fallback, else the object is inert and reported; a capability the track's catalog does not declare is refused; a parameter set is used only once its SHA-256 pin verifies (§4.4).
- The catalog fields of a
waitrack (§5):wai_capabilities,wai_determinism,wai_receipts,wai_receipt_alias,wai_receipts_track,wai_staged,wai_delivery_timeout_msandwai_priors; the fields required per packaging and role; which of MSF's own fields awaitrack carries. - The floor (§6): per object, the envelope's fallback, naming a capability of WAI's
mandatory floor; per track, a floor track of another packaging (
cmaf, for example) in thewaitrack'saltGroup. - Staged tracks (§7): a base and its refinement layers, one track per layer, with the six checks a receiver applies to a stage set.
- The packaging value
wai-receiptsand theWAI_RECEIPTobject property (§8): an Ed25519-signed Merkle commitment to each MOQT group of awaitrack, and how a receiver verifies it. - The packaging value
wai-link(§9): each object one signed record of a contribution link (SRT or RIST), as WAI's live-contribution §6.2 lays it out, with receipts like awaitrack's. The ingest gateway's link track carries it. - IANA (§11): MSF has no registry of packaging values, so the draft asks for no
registration of
wai,wai-receiptsorwai-link(and for one, should such a registry be created); it asks for aWAI_RECEIPTentry in MOQT's "MOQ Properties" registry, using0x3A41from the application range until one is assigned.
The revisions it targets
| Document | Revision | Published |
|---|---|---|
| Media over QUIC Transport (MOQT) | draft-ietf-moq-transport-23 |
2 November 2026 |
| MOQT Streaming Format (MSF) | draft-ietf-moq-msf-01 |
2 June 2026 |
MSF, editor's copy (per-role required fields, packagingMetadata) |
https://moq-wg.github.io/msf/ | 9 November 2026 |
CMSF (the cmaf packaging of the floor tracks) |
draft-ietf-moq-cmsf-01 |
3 June 2026 |
Section numbers the draft cites are those of these revisions. The implementation's MOQT wire
code speaks -22; nothing the draft specifies depends on what changed in -23.
Files
| File | What it is |
|---|---|
draft-charlot-moq-wai-packaging-01.xml |
The current revision's source. |
draft-charlot-moq-wai-packaging-01.txt, .html |
It, rendered by xml2rfc. |
draft-charlot-moq-wai-packaging-00.* |
The previous revision, kept for history. |
catalog_check.py |
The catalogs our packager writes, held to the draft (below). |
nmsf-comment.md |
A comment on draft-herz-moq-nmsf-01, which has since expired. |
Rebuilding
The IETF's tools: xml2rfc (3.35.0 for this revision) from PyPI, and idnits 2.17.1, a shell
script from the 2.17.1 tag of https://github.com/ietf-tools/idnits (it is not on PyPI).
Build on a build host, not on the dev Mac, each download under a timeout:
python3 -m venv /tmp/x2r
timeout 600 /tmp/x2r/bin/pip install xml2rfc
timeout 60 curl -sSfL -o /tmp/x2r/bin/idnits https://raw.githubusercontent.com/ietf-tools/idnits/2.17.1/idnits
chmod +x /tmp/x2r/bin/idnits
cd wai/ietf
/tmp/x2r/bin/xml2rfc --v3 --text --html draft-charlot-moq-wai-packaging-01.xml
/tmp/x2r/bin/idnits draft-charlot-moq-wai-packaging-01.txt
xml2rfc builds with no warning. idnits reports no error and no flaw, and one warning: it "couldn't figure out when the document was first submitted". idnits asks the datatracker for that date, to decide whether the pre-RFC 5378 disclaimer applies (it does only to text first submitted before 10 November 2008); the datatracker has no record of this name, so idnits cannot read one. None of the text predates 2008.
Commit the .xml with the .txt and .html it renders to.
The check against our implementation
python3 -I wai/ietf/catalog_check.py --strict # the committed catalogs, MSF's rules too
python3 -I wai/ietf/catalog_check.py path/to/catalog.json
python3 -I wai/ietf/catalog_check.py --selftest # the planted faults
It reads the catalogs of every catalog writer in this repository: those the packager wrote
(every moq/catalog.json under wai/pack-conformance, which the wai-pack workflow
recomputes from the packager byte for byte, and the composed package's under
wai/wai-web/compose), the stage-set catalog of wai/staged-conformance, and a sample of
each other writer, which that writer's own tests hold it to: the ingest gateway's
(joule-moq-ingest/tests/catalogs/, a WHIP session and a contribution session), the remote
desktop host's (joule-moq-remote/tests/catalogs/), the interop client's
(joule-moq-interop/tests/catalogs/) and the room page's (joule-moq-web/e2e/catalogs/).
Each such test writes its sample again when its JOULE_MOQ_*_WRITE_CATALOGS variable is 1.
It fails on a packaging value that neither MSF, CMSF nor the draft defines, a field on a
wai, wai-receipts or wai-link track that the draft does not define, a field of the
wrong type or range, a receipts track or alias that is missing or shared, a delivery timeout
off a layer track, a layer track in a floor's altGroup, or a stage set that fails one of
the draft's six checks. What MSF itself requires, and CMSF of a cmaf track, is printed as
a note and fails with --strict: the root version the string "draft-01"; a string
name and a boolean isLive on every track; none of MSF's fields spelt in another case
(mimetype); an event timeline's eventType, mimeType "application/json" and
depends, and eventType on no other track; and a cmaf track's initRef naming an
entry of initDataList, whose entries are inline base64 under unique ids and which comes
after tracks. --selftest requires a catalog of every writer, requires them all to pass
under --strict with no note, plants 43 faults in copies of real catalogs, and fails
unless each is caught. The repository checks run the self-test and --strict on every
change.
At this revision every catalog passes under --strict. The departures from MSF that the
previous state of this check noted are fixed in the writers: every publisher wrote
version as the number 1; the packager's cmaf floor tracks carried neither isLive
nor initRef; the room page's and the remote host's event timelines wrote mimetype and
no depends; and the ingest gateway's link track used wai-link, which no document
defined and §9 now does.