WrkzCoin Documentation¶

Reference and operator documentation for the WrkzCoin daemon, wallets and RPC surfaces. The source of truth is always the code in wrkzcoin/wrkzcoin; these pages track the development branch.

Start here¶

Binaries¶

The Flutter desktop, mobile and web wallets live under extras/ and are built separately; see Desktop, Mobile and Web Wallets.

Default ports¶

wrkz-wallet-api and wrkz-service share the same default port (SERVICE_DEFAULT_PORT in src/config/CryptoNoteConfig.h). Give one of them a different --port / --bind-port if you run both on one machine.

For AI agents and scripts¶

Every page is published as plain markdown as well as HTML, so a model or a script can read the docs without parsing the rendered site.

Point a coding agent at /llms.txt and let it fetch the pages it needs; paste /llms-full.txt when you want the whole thing in context at once. All three are regenerated on every docs build, so they never lag the site.

They describe the documented behaviour, not your node. Version-specific answers still need Wrkzd --version and the changelog.

Building the documentation¶

These pages are MkDocs Material sources under docs/ in the repository.

pip install -r docs/requirements.txt
mkdocs serve -f docs/mkdocs.yml
mkdocs build -f docs/mkdocs.yml

Every page names the file it documents. When a route, a method handler or a command-line flag changes, update the page that names it in the same change.