A specification, with its reference implementation, for how a browser resolves web3 names: which naming system an address belongs to (Handshake, ICANN DNS, IPFS, Arweave, ENS, Nostr, DID, Tor and others), how it is resolved, and what was verified on the way. The code is the resolution layer of the Wildroot browser.
Status: draft for public comment. Not endorsed by any standards body.
SPEC.md holds the shared model (terminology, trust states, Fast
and Private modes). Each part after that has its own file:
Supporting documents:
REFERENCES.md: every standard cited, and what it is used for.DEVIATIONS.md: departures from cited standards, open questions and open design decisions.DIVERGENCE.md: where the private path and the fast path differ.REVIEW.md: open review findings.
REFERENCES.md and DEVIATIONS.md are generated from the per-chapter files
with npm run docs.
Requires Node.js 20 or later and Python 3. Some tests start a local nameserver
(tests/fixtures/resolver/nsd.py) over frozen signed zones; the rest use
scripted fakes. The tests do not depend on public services.
npm ci
npm test
npm run lint
npm run docs:checkSPEC.md the shared model
namespaces/<ns>/ one chapter: SPEC.md, DEVIATIONS.md, REFERENCES.md, and src/ and tests/ if it has code
src/, tests/ the Handshake modules and the modules several chapters share
scripts/ test runner, documentation generator, browser parity check
reviews/ dated review records
The modules are copies of the Wildroot browser's. npm run parity fails if
the browser checkout is absent, so an unchecked run cannot look successful. It compares
them with a browser checkout at ../browser (or $WILDROOT). The browser
source is not public, so without that checkout the command reports that
nothing was checked and exits with a nonzero status.
Wildroot, Web3 name resolution: a specification, version 0.10.0. https://github.com/wildroot-io/wildroot-web3-resolution
The code (src/, namespaces/*/src/ and the tests) is Apache-2.0
(LICENSE). The documents are CC-BY-4.0
(LICENSE-SPEC). Corrections are welcome; see
CONTRIBUTING.md.