Other Tools¶

Smaller binaries, scripts and components that ship with the repository. Each one is small enough not to need a page of its own, but none of them are documented anywhere else.

wallet-upgrader¶

Converts an old wallet container file to the current format. Only needed when wrkz-wallet refuses a file with 6 UNSUPPORTED_WALLET_FILE_FORMAT_VERSION.

wallet-upgrader --wallet-file old.wallet --password "wallet-pass"

Run with neither flag it prompts for the filename interactively, and offers to add the .wallet extension when the file lacks it. Give both flags for a non-interactive upgrade — the extension prompt is skipped in that case, so the file is upgraded under whatever name you passed.

Back the file up first. The upgrade rewrites the container in place, and a wallet written in the newer format cannot be opened by an older binary.

cryptotest¶

Hash-function and crypto self-test. See The Miner App.

Block explorer¶

extras/explorer is a static block explorer UI — HTML, CSS and JavaScript, no build step and no server-side component. It is served by an ordinary web server while the daemon runs separately.

The daemon must run in explorer mode, which is what registers the f_* JSON-RPC methods and /queryblocksdetailed:

Wrkzd --daemon-mode explorer --enable-cors

By default the page expects the daemon RPC at /api, so the usual production layout is nginx serving the static files and reverse-proxying /api to the daemon — which also avoids CORS entirely, making --enable-cors unnecessary. For local work, any static file server will do:

cd extras/explorer
python -m http.server 8080

Checkpoints¶

Checkpoints let a syncing node skip proof-of-work and ring-signature verification below the last one, which is most of what makes a first sync take hours rather than days. The daemon ships with compiled-in checkpoints and also accepts a CSV file:

Wrkzd --load-checkpoints checkpoints.csv

The format is one height,hash line per checkpoint:

0,877e55b4e902b9bf4c9e0a7c16440f449339d56679c49d62261ae5c92596a6ce
1,93bb1fd850d9e904ca810cdb57935b6df45cd75fc3a86358a421e126c1ae7b51

Published checkpoints are at checkpoints.wrkz.work (direct CSV).

Generating your own¶

scripts/checkpoints/gen_checkpoints.sh walks a synced daemon over RPC and writes the file:

./gen_checkpoints.sh -H 127.0.0.1 -p 17856 -o checkpoints.csv

The --confirmations default exists so a checkpoint is never written for a block that could still be reorganised away.

wallet_capi — the embedder C API¶

The desktop, mobile and web wallets do not talk to wrkz-wallet-api over HTTP; they link wallet_capi, the wallet backend built as a shared library, and call it through FFI (or WebAssembly). It exposes around 70 wallet_* functions covering the whole wallet lifecycle, and returns the same error codes as every other surface, with wallet_error_code_to_string to render them.

Two entry points worth knowing:

• wallet_set_tx_pow_server(host, port, ssl) — point the backend at a transaction PoW server. An empty host turns it off. The WASM bridge exposes the same call as setTxPowServer.
• wallet_capi_api_version / wallet_capi_version_string — check what a loaded library actually is before calling into it.

There is no generated reference for this API yet; src/walletcapi/wallet_capi.cpp is the source of truth, and Building the Wallet Apps covers producing the library.

ZMQ subscriber test script¶

scripts/zmq_sub_test.py is a working subscriber for the daemon's ZMQ publisher — the quickest way to confirm a build has ZeroMQ compiled in and that events are actually flowing.

Build and packaging scripts¶

See Building from Source for how these fit together.