Public user documentation for Universe Wallet, the self-custody browser extension for Bitcoin, Dogecoin, Zcash, and Fractal Bitcoin.
Read the documentation: https://bitcoinuniverseio.github.io/docs-wallet
This repository holds the source of that site. The site is the thing to read: it has search, navigation, diagrams, and provenance on every page. Reading the Markdown here works, and you will miss the diagrams.
Beyond the prose manual, the site is a documentation product suite, all derived from the wallet repository's verified artifacts:
- Guided journeys: declarative walkthroughs with per-step goals, checkpoints, failure modes, and reversibility, branching by release and capability, with progress that stays in your browser.
- Safe simulator: the real wallet interface on fixture data in a sandboxed frame: no keys, no network, nothing that can sign.
- Transaction Safety Lab: approval and transaction scenarios generated by the wallet's own view models, with complete static text for every scenario.
- Screen Atlas: every pixel-verified capture with its release, commit, fixture, and privacy review, filterable and deep-linkable.
- Developer Integration Studio: the generated provider contract, a fake provider that reproduces real refusals, the Compatibility Doctor, and a downloadable starter.
- Answer Center: questions answered from these pages only, via the existing Pagefind index.
- Release lens: a header control for the release catalog, appearance (light, dark, OLED black), and click-gated wallet version detection that reads only the version.
- Machine-readable corpus: llms-full.txt, JSON endpoints, per-page Markdown, and a read-only MCP
server (stdio and Streamable HTTP transports) under
mcp-server/. - Offline emergency handbook: a scoped service worker, printable checklists, and honest cache-age banners.
- The published Chrome Web Store build is 1.0.13, from 15 April 2025. This documentation is written against the 1.7.5.8 source tree, which has not been submitted or published. Where the documentation and a reader's wallet disagree, the wallet is correct.
- The committed protocol baseline carries no authorized protocol operations. Read the generated
capability-snapshot.jsonfor the current inventory. Authorization is attached at release time from evidence covering the whole path behind an operation. Nothing here may present an unreleased operation as available.
Both are stated on every relevant page, not buried here.
- No capability claim that does not come from
capability-snapshot.json, which is a copy of the wallet's generated public capability summary. Counts are rendered from it at build time rather than typed into prose, so they cannot drift.npm run check:capability. - No em dash, no emoji, no unverifiable superlative, no filler.
npm run check:copy. - No private hostname, address, credential shape, or full-length example address.
npm run check:public-safety. - Every diagram carries a title and a description, uses no hard-coded colour, and no marker
elements.
npm run check:diagrams. - Every material page carries provenance and a unique description, and the manifest matches the
shared schema.
npm run check:manifest. - Every internal link and anchor resolves, checked by the build itself.
Requires Node 24.
npm ci
npm run dev # local preview at http://localhost:4321/docs-wallet
npm test # every check above
npm run build # static build into dist/, validates linksRefresh the capability snapshot after regenerating it in the wallet repository:
npm run capability:pull| Path | Contents |
|---|---|
src/content/docs/ |
Every page, as Markdown or MDX |
src/components/diagrams/ |
Hand-authored inline SVG diagrams |
src/components/ |
Approval panel, diagram frame, protocol table, provenance footer |
src/styles/theme.css |
The design system, with its intent written down |
scripts/ |
The checks listed above |
capability-snapshot.json |
Generated by the wallet repository. Do not edit by hand. |
docs.manifest.json |
Portal ingestion manifest |
See CONTRIBUTING.md. The short version: an undocumented limitation is a bug in the documentation, and a claim that cannot be verified in the wallet source does not go in.
Report vulnerabilities privately to legal@bitcoinuniverse.io. See SECURITY.md.
Nobody will ever ask for your recovery phrase. Not in an issue, not in a reply, not to help you recover funds.
- Product source: bitcoinuniverseio/wallet
- Every Bitcoin Universe component: docs.bitcoinuniverse.io
Documentation is licensed under CC BY 4.0. Site source code in scripts/,
src/components/, and src/styles/ is MIT, as stated in that file.