Quick-start · implementer / developer
Goal: build against the standard and stay byte-compatible with the reference cores.
The contract
- Payload schema (JSON Schema 2020-12) and the JSON-LD context.
- Canonicalization is RFC 8785 (JCS); the integrity hash is SHA-256 over the canonical bytes. This is the anti-fork keystone - two conformant implementations MUST produce byte-identical canonical JSON and the same hash.
- The conformance vectors are the oracle: canonical bytes, hashes, golden embedded PDFs, negatives, and a differential-fuzz corpus. Reproduce them exactly.
Reference implementations
Published packages (openom-core on PyPI, openom-js on npm) are on the
way; until then, install from a clone of the repo:
pip install -e core # Python: embed/read/inspect/extract/validate
npm install ./js # TypeScript: byte-parity with the Python core
Validation model
Two tiers: schema errors block; consistency warnings never block; market truth is out of scope forever. See the code catalog for every code and its requirement clause.