Conformance

Version
r8.1a / v0
Licence
CC-BY-4.0
Formats
HTML

What each specification asks of an implementation, and how to run the published test suite.

#Handoff v0

A conforming verifier reproduces, for every fixture, the expectations that section 15 of the specification lists: the result, the code at the matching level, and the time bounds and detect classes where a fixture gives them.

The check, stop and order rules of the verification algorithm in section 10 bind every conforming verifier, whether or not a fixture shows them.

Conformance to revision r8.1a means sections 1 to 15. Operating the profile weio-ed25519-only/1 is a separate statement.

Conformance fixtures

#Run the suite

The fixtures are plain JSON files, one per case, each with its inputs and the expected result. Anyone may run them against any implementation.

In a browser: open the verifier page and choose Run all 270. The fixtures load from this site, are checked against SHA256SUMS.txt, and run in the page.

With Node:

curl -fsSO https://weio.ai/verify/kit/handoff-verify.mjs
node handoff-verify.mjs conformance https://weio.ai/spec/handoff/v0/fixtures/

The runner fetches MANIFEST.json and SHA256SUMS.txt, checks the SHA-256 of every file, runs every case, and prints one line per case and a total.

Give it a local copy of the fixtures directory instead of the URL to run it offline. It exits 0 only when every case matches.

To test your own verifier, give it each fixture's inputs and compare its answer with the expected result, as section 15 describes.

The full code lists show what the reference reports. A verifier that differs there can still conform.

The published kit reproduces the expected result for all 270 cases.

#Registry

An implementation of the registry API answers every request and error that the OpenAPI file and the registry endpoints page define.

#Gateways

A gateway reads the manifest, performs the join contract, hands the joiner a receipt that validates against the receipt schema, and shows the required lines.

Back to the documents