Files
dragonx/README.md
DanS c05134e77e Compliant rebrand: legal compliance, code audit, and documentation (Phases 0-3)
Phase 0 - Legal Compliance:
- COPYING: Add DragonX copyright, preserve all upstream attributions
- AUTHORS: Add DragonX developers section
- LICENSE: Restore standard FSF GPLv3 text (fix GNU→GENERAL error)
- Add DragonX copyright headers to all 21 modified source files
- contrib/debian/copyright: Add DragonX attribution
- README.md: Add GPLv3 Section 5(a) attribution section

Phase 1 - init.cpp Cleanup:
- PID file: hushd.pid → dragonxd.pid
- Shutdown thread: hush-shutoff → dragonx-shutoff
- Debug message: stopping HUSH → stopping DragonX

Phase 2 - HUSH3/ishush3 Code Audit:
- Rename ishush3 → isdragonx across ~15 source files
- Update "HUSH3" chain-identity checks to "DRAGONX" in consensus,
  difficulty, notarization, devtax, and RPC code
- Intentionally preserve cross-chain "HUSH3" refs (gateway, notary dest)
- Build verified: all three binaries compile cleanly

Phase 3 - Documentation:
- README.md: Full rewrite with DragonX chain params, build instructions
- Man pages: Create dragonxd.1, dragonx-cli.1, dragonx-tx.1 (v1.0.0)
- Doc files: Add beefy-DRAGONX.conf, dragonxd-systemd.md, dragonxd.service
- Init scripts: Create dragonxd.{conf,init,openrc,openrcconf,service}
- Debian packaging: Update control, changelog, install, manpages, examples
- Update doc/init.md and contrib/init/README.md
2026-03-03 19:01:24 -06:00

108 lines
2.5 KiB
Markdown

# DragonX
DragonX is a privacy-focused cryptocurrency full node using RandomX proof-of-work.
All transactions are shielded (z-to-z) by default, providing strong on-chain privacy.
| | |
|---|---|
| **Algorithm** | RandomX (CPU-mineable) |
| **Block time** | 36 seconds |
| **Block reward** | 3 DRAGONX |
| **Halving** | Every 3,500,000 blocks |
| **Privacy** | All transactions shielded (`-ac_private=1`) |
| **P2P port** | 21768 |
| **RPC port** | 21769 |
## Build on Debian or Ubuntu
```sh
# Install build dependencies
sudo apt-get install build-essential pkg-config libc6-dev m4 g++-multilib \
autoconf libtool ncurses-dev unzip git zlib1g-dev wget \
bsdmainutils automake curl unzip libsodium-dev cmake
# Clone the repo
git clone https://git.dragonx.is/DragonX/dragonx
cd dragonx
# Build (uses ~2GB RAM per -j thread)
./build.sh -j3
```
## Build on Arch
```sh
sudo pacman -S gcc libsodium lib32-zlib unzip wget git python rust curl autoconf cmake
git clone https://git.dragonx.is/DragonX/dragonx
cd dragonx
./build.sh -j3
```
## Build on Fedora
```sh
sudo dnf install make automake gcc gcc-c++ kernel-devel cmake libtool ncurses-devel patch -y
git clone https://git.dragonx.is/DragonX/dragonx
cd dragonx
./build.sh -j3
```
## Build on macOS
```sh
sudo port update && sudo port upgrade outdated
sudo port install qt5
git clone https://git.dragonx.is/DragonX/dragonx
cd dragonx
./build.sh -j3
```
## Cross-compile for Windows (on Linux)
```sh
sudo apt-get install \
build-essential pkg-config libc6-dev m4 g++-multilib libdb++-dev \
autoconf libtool ncurses-dev unzip git zip \
zlib1g-dev wget bsdmainutils automake mingw-w64 cmake libsodium-dev
git clone https://git.dragonx.is/DragonX/dragonx
cd dragonx
./util/build-win.sh -j$(nproc)
```
## Running
```sh
# Start the daemon
./src/dragonxd
# In another terminal, interact via CLI
./src/dragonx-cli getinfo
./src/dragonx-cli z_getnewaddress
```
Data directory: `~/.hush/DRAGONX/`
Config file: `~/.hush/DRAGONX/DRAGONX.conf`
## Mining
DragonX uses the RandomX algorithm and is CPU-mineable. Point any RandomX-compatible
miner (e.g. XMRig) at a DragonX stratum pool, or solo-mine with:
```sh
./src/dragonxd -gen -genproclimit=$(nproc) -mineraddress=<your_zaddr>
```
## Attribution
DragonX is a fork of the [Hush Full Node](https://hush.is).
Based on code from Zcash, Komodo, and Bitcoin Core.
Licensed under GPLv3 — see [COPYING](COPYING) and [LICENSE](LICENSE).
## License
For license information see the file [COPYING](COPYING).