# WrkzCoin Documentation

> Daemon RPC, wallet RPC, and operator guides for WrkzCoin

Documentation for the WrkzCoin daemon, wallets and RPC surfaces.
Generated from the docs sources; the code in the repository is always
the source of truth. Every page below is also available as raw
markdown by appending `.md` to its URL.

## Overview

- [Home](https://docs.wrkz.work/index.md): Reference and operator documentation for the WrkzCoin daemon, wallets and RPC surfaces.
- [Community](https://docs.wrkz.work/community.md): Where to ask a question, report a bug, and follow releases - and which of those channels is the right one for what you have.

## Node Operator

- [Running a Node](https://docs.wrkz.work/guides/running-daemon.md): The daemon binary is Wrkzd.
- [Configuration Reference](https://docs.wrkz.work/guides/daemon-configuration.md): Every Wrkzd command-line option, with the default the binary compiles in.
- [Console Commands](https://docs.wrkz.work/guides/console-commands.md): Commands available at the daemon's interactive console, and — identically — in a session opened with Wrkzd attach against a node already running.
- [Networking](https://docs.wrkz.work/guides/networking.md): How Wrkzd binds, who it talks to, and how it finds peers.
- [Local IPC and Console](https://docs.wrkz.work/guides/ipc-and-console.md): Every listener that speaks HTTP can also be served over an AF_UNIX socket instead of, or alongside, a TCP port.
- [Notification Hooks](https://docs.wrkz.work/guides/notify-hooks.md): Monero-style push hooks, so a service learns about a block or a transaction without polling.
- [Lite Nodes](https://docs.wrkz.work/guides/lite-node.md): A lite node stores full block data only from a chosen height upward.
- [Lite Node Snapshots](https://docs.wrkz.work/guides/lite-snapshots.md): A lite node still downloads every block from 0 to its lite height H to build the indexes it keeps below it — hours of work for data that is then mostly discarded.
- [Solo Mining](https://docs.wrkz.work/guides/solo-mining.md): Wrkzd can hand work straight to a mining program, so solo mining needs no pool and no bridge.
- [Security Hardening](https://docs.wrkz.work/guides/security-hardening.md): What to lock down before a node, wallet API or wallet service is reachable by anybody but you, and why each control matters.
- [Rate Limits and Performance](https://docs.wrkz.work/guides/rate-limits-and-performance.md): The knobs that decide how much work one client can ask a node for, and how much of that work the node has to redo.

## Daemon RPC

- [Overview](https://docs.wrkz.work/daemon-rpc/overview.md): What the daemon serves, on which listeners, and which options control them.
- [Auth and Security](https://docs.wrkz.work/daemon-rpc/auth-and-security.md): How the daemon authenticates an RPC caller and what it does to one that asks for too much.
- [JSON-RPC Methods](https://docs.wrkz.work/daemon-rpc/json-rpc.md): Every method the daemon answers on /json_rpc, with the RPC mode each needs and a worked example.
- [HTTP Endpoints](https://docs.wrkz.work/daemon-rpc/http-endpoints.md): Every non-JSON-RPC route the daemon serves, including the wallet sync endpoints and their optional fields.
- [Cookbook](https://docs.wrkz.work/guides/daemon-rpc-cookbook.md): Working curl recipes for the daemon RPC, in the order an integration usually needs them.

## Wallet API RPC

- [Overview](https://docs.wrkz.work/wallet-api/overview.md): What wrkz-wallet-api exposes and how a client is expected to drive it.
- [Running Wallet API](https://docs.wrkz.work/guides/running-wallet-api.md): wrkz-wallet-api serves the HTTP wallet API described in Endpoints.
- [Auth and Security](https://docs.wrkz.work/wallet-api/auth-and-security.md): How wrkz-wallet-api authenticates callers, and the wallet-state and view-only rules the middleware enforces before a handler runs.
- [Endpoints](https://docs.wrkz.work/wallet-api/endpoints.md): Every route wrkz-wallet-api serves, by method, with a worked request for each.
- [Cookbook](https://docs.wrkz.work/guides/wallet-api-cookbook.md): A complete working sequence against the wallet API, from creating a wallet to sending from it and closing it again.

## Wallet Service JSON-RPC

- [Overview](https://docs.wrkz.work/wallet-service-json-rpc/overview.md): The legacy payment-service RPC served by wrkz-service: its envelope, its options, and how it differs from the wallet API.
- [Methods](https://docs.wrkz.work/wallet-service-json-rpc/methods.md): Every method wrkz-service answers, with an example payload for each.

## Wallets

- [Wallet CLI](https://docs.wrkz.work/guides/wallet-cli.md): This project's interactive wallet CLI binary is wrkz-wallet.
- [Wallet CLI Command Reference](https://docs.wrkz.work/guides/cli-command-reference.md): Every command wrkz-wallet accepts, grouped by the menu it appears in.
- [Desktop, Mobile and Web Wallets](https://docs.wrkz.work/guides/wallet-apps.md): Three graphical wallets live under extras/ in the repository.
- [Encrypted Payment IDs](https://docs.wrkz.work/guides/encrypted-payment-ids.md): Short payment IDs are encrypted so that only the sender and the receiver can read them.
- [Transaction PoW Server](https://docs.wrkz.work/guides/txpow-server.md): Every WrkzCoin transaction carries a small proof of work: the wallet appends a nonce to the transaction extra and searches until the cn_upx hash of the unsigned transaction prefix meets a difficulty derived from the …

## Building and Tools

- [Building from Source](https://docs.wrkz.work/guides/building.md): Builds the daemon and the CLI binaries: Wrkzd, wrkz-wallet, wrkz-wallet-api, wrkz-service, wrkz-txpow-server, miner, cryptotest and wallet-upgrader.
- [Building the Wallet Apps](https://docs.wrkz.work/guides/building-wallet-apps.md): The desktop, mobile and web wallets are Flutter apps that call wallet_capi — the wallet backend compiled as a shared library — through FFI, or through WebAssembly in the browser.
- [The Miner App](https://docs.wrkz.work/guides/miner.md): miner is the bundled reference CPU miner.
- [Other Tools](https://docs.wrkz.work/guides/other-tools.md): Smaller binaries, scripts and components that ship with the repository.

## Reference

- [Network Parameters](https://docs.wrkz.work/guides/network-parameters.md): Consensus constants and the heights they change at.
- [Wallet Error Codes](https://docs.wrkz.work/guides/error-codes.md): Every wallet surface built on walletbackend reports failures with the same numeric code: wrkz-wallet-api returns it as errorCode in the response body, wrkz-service as the JSON-RPC error code, wrkz-wallet prints the …

## Changelog

- [Daemon](https://docs.wrkz.work/changelog/daemon.md): Changes to Wrkzd — consensus, P2P, storage, the RPC surface and the console — that an operator or an RPC integrator has to know about.
- [Wallet API](https://docs.wrkz.work/changelog/wallet-api.md): Changes to wrkz-wallet-api and the wallet backend it shares with wrkz-wallet, wrkz-service and the desktop, mobile and web wallets.