- Installing WrkzCoin
- Node System Requirements
- Build from Source
- Getting Started Fast
- Daemon DB Compaction
- A note for contributing developers
- Contributing Projects
- Our Discord
To use WrkzCoin, you'll need a way to connect to the network, and a wallet to hold your funds. This software includes those things for you, you can compile it yourself, or you can download the ones that we have compiled for you.
Click here to download: https://latest.wrkz.work
Minimum requirements to run a Wrkzd daemon node:
| Requirement | Pruned Node | Full Node |
|---|---|---|
| Internet | Stable broadband | Stable broadband |
| CPU | 1 core, 1.0 GHz | 1 core, 1.5 GHz |
| RAM | 2 GB | 2 GB |
| Free Disk Space | 30 GB SSD/NVMe | 50 GB SSD/NVMe |
- A pruned node (
--prune) discards raw block and transaction binary data for blocks older than the configured depth (default: 7 days ≈ 10,080 blocks). Block metadata, key images, and transaction indexes are retained for the full chain, so consensus and wallet sync remain functional. - A full node retains raw block and transaction data for the entire blockchain history.
- SSD or NVMe storage is required. HDDs are too slow for RocksDB random I/O and will cause severe sync delays or daemon instability.
- Disk usage grows over time as the chain advances — provision extra headroom.
- RAM shown covers the daemon alone; allow more if also running
wrkz-serviceor a miner on the same machine.
| Data | Pruned Node | Full Node |
|---|---|---|
| Raw block binary data (old blocks) | Removed | Kept |
| Raw transaction binary data (old blocks) | Removed | Kept |
| Raw block/transaction data (recent blocks, within prune depth) | Kept | Kept |
| Block metadata (hash, height, difficulty, timestamp) | Kept for all | Kept for all |
| Transaction indexes (global output indexes) | Kept for all | Kept for all |
| Key images (spent output tracking) | Kept for all | Kept for all |
| Payment ID indexes | Kept for all | Kept for all |
The prune depth controls how many recent blocks keep their raw data. The default is 7 days worth of blocks (--prune-depth can increase this). Use --prune-depth N to retain more history.
Building from source requires at least 4 GB RAM for the compiler (RocksDB and C++20 templates are memory-intensive at compile time).
Build instructions are maintained in:
Everyone starts somewhere. If you're new or returning, you'll probably want to get in sync with the network so you can use your funds. Syncing from your own node is faster than syncing from a remote node. Here are some handy links to get you there as soon as possible.
- Use checkpoints - Checkpoints help your node sync faster, WrkzCoin Checkpoints or via Direct link
- Backup your keys - You can generate a wallet right inside the software, or use this paper wallet generator
- The daemon can compact RocksDB in background while syncing.
- Boot-time background compaction is enabled by default.
- Disable boot compaction with
--skip-boot-compaction. - Check status from daemon console:
compact_db status. - Manual controls:
compact_db startandcompact_db wait.
- Default daemon ZMQ PUB endpoint:
tcp://127.0.0.1:17857 - Start daemon with explicit endpoint:
Wrkzd --zmq-pub tcp://127.0.0.1:17857
- Test subscriber script:
pip install pyzmqpython scripts/zmq_sub_test.py --endpoint tcp://127.0.0.1:17857 --topics hashblock chain_main
Build requirements and static/portable notes are in COMPILE.md.
Hello, and thank you for helping us! Our work makes use of many brilliant projects from other communities who contributed their code which helped us get to where we are now. To make sure we're always doing things the right way, we try to make sure we get the proper license header in every file we modify. By the terms of this project's license, any open source project may use our software, but the licenses may only be appended to, not altered.
See src/config/CryptoNoteConfig.h for an example.
// Copyright (c) 2012-2017, The CryptoNote developers, The Bytecoin developers
// Copyright (c) 2014-2018, The Monero Project
// Copyright (c) 2018-2020, The TurtleCoin Developers
// Copyright (c) 2018-2026, The WrkzCoin Developers
//
// Please see the included LICENSE file for more information.
- WrkzCoin: https://discord.gg/GpHzURM