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
This commit is contained in:
209
README.md
209
README.md
@@ -1,196 +1,107 @@
|
||||
<p align="center">
|
||||
<img src="doc/hush/hush0.png">
|
||||
</p>
|
||||
# DragonX
|
||||
|
||||
<h3>
|
||||
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.
|
||||
|
||||
| Introduction | Install | Compile | FAQ | Documentation |
|
||||
| :---: | :---: | :---: | :---: | :---: |
|
||||
| [What is Hush?](#what-is-hush) | [Windows 10 - Video Tutorial](#install-on-windows-10) | [Build on Debian or Ubuntu](#build-on-debian-or-ubuntu) | [Where can I buy Hush?](#where-can-i-buy-hush) | [Cross compiling Windows binaries](#windows-cross-compiled-on-linux)
|
||||
| [Why not GitHub?](#banned-by-github) | [Build on Mac](#build-on-mac) | [Build on Arch](#build-on-arch) | [Can I mine with CPU or GPU?](#can-i-mine-with-cpu-or-gpu) | [Hush DevOps for pools and CEXs](https://git.hush.is/hush/docs/src/branch/master/advanced/devops.md)
|
||||
| [What is HushChat?](#what-is-hushchat) | [Debian and Ubuntu](#installing-hush-binaries) | [Build on Fedora](#build-on-fedora) | [Claiming funds from old Hush wallets](https://git.hush.is/hush/hush3/src/branch/master/doc/OLD_WALLETS.md) | [Earn Hush bounty](#earn-hush-bounty)
|
||||
| [What is SilentDagon?](#what-is-silentdagon) | [Raspberry Pi](#install-on-arm-architecture) | [Build on Ubuntu 16.04 or older](#building-on-ubuntu-16-04-and-older-systems) | [Where can I spend Hush?](#where-can-i-spend-hush) | [Cross compiling from amd64 to arm64](https://git.hush.is/hush/docs/src/branch/master/advanced/cross-compile-hush-full-node-to-aarch64-with-docker.md)
|
||||
| | |
|
||||
|---|---|
|
||||
| **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 |
|
||||
|
||||
</h3>
|
||||
|
||||
# What is Hush?
|
||||
|
||||
Hush implements Extreme Privacy via blockchain tech. We have our own
|
||||
genesis block. We are not a chain fork (copy) of another coin. We are based on
|
||||
Bitcoin code, with sophisticated zero-knowledge mathematics added for privacy.
|
||||
This keeps your transaction metadata private!
|
||||
|
||||
# What is this repository?
|
||||
|
||||
This software is the Hush node and command-line client. It downloads and stores
|
||||
the entire history of Hush transactions; depending on the speed of your
|
||||
computer and network connection, it will likely take a few hours at least, but
|
||||
some people report full nodes syncing in less than 1.5 hours.
|
||||
|
||||
# Banned by GitHub
|
||||
|
||||
In working on this release, Duke Leto was suspended from Github, which gave Hush developers
|
||||
the impetus to completely leave that racist and censorship-loving platform. Hush now has it's own [git.hush.is](https://git.hush.is/hush) Gitea instance,
|
||||
because we will not be silenced by Microsoft. All Hush software will be released from git.hush.is and hush.is, downloads from any other
|
||||
domains should be assumed to be backdoored.
|
||||
|
||||
**Hush is unfinished and highly experimental.** Use at your own risk! Just like Bitcoin.
|
||||
|
||||
# Build on Debian or Ubuntu
|
||||
## Build on Debian or Ubuntu
|
||||
|
||||
```sh
|
||||
# install build dependencies
|
||||
# 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 nano libsodium-dev cmake
|
||||
# clone git repo
|
||||
git clone https://git.hush.is/hush/hush3
|
||||
cd hush3
|
||||
# Build
|
||||
# This uses 3 build processes, you need 2GB of RAM for each.
|
||||
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
|
||||
```
|
||||
Video Tutorial: https://videos.hush.is/videos/how-to-install-on-linux
|
||||
|
||||
# Build on Arch
|
||||
## Build on Arch
|
||||
|
||||
```sh
|
||||
# install build dependencies
|
||||
sudo pacman -S gcc libsodium lib32-zlib unzip wget git python rust curl autoconf cmake
|
||||
# clone git repo
|
||||
git clone https://git.hush.is/hush/hush3
|
||||
cd hush3
|
||||
# Build
|
||||
# This uses 3 build processes, you need 2GB of RAM for each.
|
||||
|
||||
git clone https://git.dragonx.is/DragonX/dragonx
|
||||
cd dragonx
|
||||
./build.sh -j3
|
||||
```
|
||||
|
||||
# Build on Fedora
|
||||
## Build on Fedora
|
||||
|
||||
```sh
|
||||
# install build dependencies
|
||||
sudo dnf install make automake gcc gcc-c++ kernel-devel cmake libtool ncurses-devel patch -y
|
||||
# clone git repo
|
||||
git clone https://git.hush.is/hush/hush3
|
||||
cd hush3
|
||||
# Build
|
||||
# This uses 3 build processes, you need 2GB of RAM for each.
|
||||
|
||||
git clone https://git.dragonx.is/DragonX/dragonx
|
||||
cd dragonx
|
||||
./build.sh -j3
|
||||
```
|
||||
|
||||
# Install on Windows 10
|
||||
## Build on macOS
|
||||
|
||||
Video Tutorial: https://videos.hush.is/videos/how-to-install-on-windows
|
||||
|
||||
# Install on ARM Architecture
|
||||
|
||||
Use this if you have a Raspberry Pi or similar computer. Currently, any ARMv7 machine will not be able to build this repo, because the underlying tech (zcash and the zksnark library) do not support that instruction set. This also means that old RaspberryPi devices will not work, unless they have a newer ARMv8-based Raspberry Pi. Raspberry Pi 4 and newer are known to work.
|
||||
|
||||
1. [Download the latest Debian package with the AARCH64 designation from the releases page](https://git.hush.is/hush/hush3/releases).
|
||||
1. Install the Debian package, substituting "VERSION-NUMBER" for the version you have downloaded: `sudo dpkg -i hush-VERSION-NUMBER-aarch64.deb`.
|
||||
1. Run with: `hushd`.
|
||||
|
||||
If you would like to compile this for ARM yourself, then please refer to the [Cross compiling a Hush full node daemon from AMD64 to ARM64(aarch64) CPU architecture with Docker](https://git.hush.is/jahway603/hush-docs/src/branch/master/advanced/cross-compile-hush-full-node-to-aarch64-with-docker.md) documentation to do that.
|
||||
|
||||
# Building On Ubuntu 16.04 and older systems
|
||||
|
||||
Some older compilers may not be able to compile modern code, such as gcc 5.4 which comes with Ubuntu 16.04 by default. Here is how to install gcc 7 on Ubuntu 16.04. Run these commands as root:
|
||||
|
||||
```
|
||||
add-apt-repository ppa:ubuntu-toolchain-r/test && \
|
||||
apt update && \
|
||||
apt-get install -y gcc-7 g++-7 && \
|
||||
update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-7 60 && \
|
||||
update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-7 60
|
||||
```
|
||||
|
||||
# Build on Mac
|
||||
|
||||
```
|
||||
sudo port update
|
||||
sudo port upgrade outdated
|
||||
```sh
|
||||
sudo port update && sudo port upgrade outdated
|
||||
sudo port install qt5
|
||||
|
||||
# clone git repo
|
||||
git clone https://git.hush.is/hush/hush3
|
||||
cd hush3
|
||||
# Build
|
||||
# This uses 3 build processes, you need 2GB of RAM for each.
|
||||
git clone https://git.dragonx.is/DragonX/dragonx
|
||||
cd dragonx
|
||||
./build.sh -j3
|
||||
```
|
||||
|
||||
# Installing Hush binaries
|
||||
## Cross-compile for Windows (on Linux)
|
||||
|
||||
1. [Download the release](https://git.hush.is/hush/hush3/releases) with a .deb file extension.
|
||||
1. Install the Debian package, substituting "VERSION-NUMBER" for the version you have downloaded: `sudo dpkg -i hush-VERSION-NUMBER-amd64.deb`.
|
||||
1. Run with: `hushd`.
|
||||
|
||||
# Windows (cross-compiled on Linux)
|
||||
Get dependencies:
|
||||
```ssh
|
||||
```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)
|
||||
```
|
||||
|
||||
Downloading Git source repo, building and running Hush:
|
||||
## Running
|
||||
|
||||
```sh
|
||||
# pull
|
||||
git clone https://git.hush.is/hush/hush3
|
||||
cd hush3
|
||||
# Build
|
||||
./util/build-win.sh -j$(nproc)
|
||||
# Run a HUSH node
|
||||
./src/hushd
|
||||
# Start the daemon
|
||||
./src/dragonxd
|
||||
|
||||
# In another terminal, interact via CLI
|
||||
./src/dragonx-cli getinfo
|
||||
./src/dragonx-cli z_getnewaddress
|
||||
```
|
||||
|
||||
# Official Explorers
|
||||
Data directory: `~/.hush/DRAGONX/`
|
||||
Config file: `~/.hush/DRAGONX/DRAGONX.conf`
|
||||
|
||||
The links for the Official Hush explorers:
|
||||
* [explorer.hush.is](https://explorer.hush.is)
|
||||
## Mining
|
||||
|
||||
# What is SilentDragon?
|
||||
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:
|
||||
|
||||
* [SilentDragon](https://git.hush.is/hush/SilentDragon) is a desktop wallet for HUSH full node.<br>
|
||||
* [SilentDragonLite](https://git.hush.is/hush/SilentDragonLite) is a desktop wallet that does not require you to download the full blockchain.
|
||||
* [SilentDragonAndroid](https://git.hush.is/hush/SilentDragonAndroid) is a wallet for Android devices.
|
||||
* [SilentDragonPaper](https://git.hush.is/hush/SilentDragonPaper) is a paper wallet generator that can be run completely offline.
|
||||
```sh
|
||||
./src/dragonxd -gen -genproclimit=$(nproc) -mineraddress=<your_zaddr>
|
||||
```
|
||||
|
||||
# What is HushChat?
|
||||
## Attribution
|
||||
|
||||
HushChat is a protocol inspired by the design of Signal Protocol, it uses many of the same cryptography and ideas, but does not actually use any code from Signal. Signal requires phone numbers and is a centralized service. HushChat is completely anonymous and decentralized and requires absolutely no metadata be given to any centralized third parties.
|
||||
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).
|
||||
|
||||
# Can I mine with CPU or GPU?
|
||||
|
||||
Hush cannot be efficiently mined with CPU or GPU, only ASIC mining is recommended. HUSH uses Equihash (200,9) algo, as does Zcash, Horizen or Komodo.
|
||||
|
||||
# Where can I buy Hush?
|
||||
|
||||
1. https://nonkyc.io/market/HUSH_BTC
|
||||
1. https://tradeogre.com/exchange/BTC-HUSH
|
||||
|
||||
# Where can I spend Hush?
|
||||
|
||||
AgoraX market: https://agorax.is
|
||||
|
||||
# Earn Hush bounty
|
||||
|
||||
Developers can earn bounty by fixing bugs or solving feature requests listed in `Issues->Label`:
|
||||
- https://git.hush.is/hush/hush3/issues
|
||||
- https://git.hush.is/hush/SilentDragon/issues
|
||||
- https://git.hush.is/hush/SilentDragonLite/issues
|
||||
|
||||

|
||||
|
||||
# Support and Socials
|
||||
|
||||
* Telegram: [https://hush.is/tg](https://hush.is/tg)
|
||||
* Matrix: [https://hush.is/matrix](https://hush.is/matrix)
|
||||
* Twitter: [https://hush.is/twitter](https://hush.is/twitter)
|
||||
* PeerTube [https://hush.is/peertube](https://hush.is/peertube)
|
||||
|
||||
# License
|
||||
## License
|
||||
|
||||
For license information see the file [COPYING](COPYING).
|
||||
|
||||
Reference in New Issue
Block a user