| external | ||
| images | ||
| pgp | ||
| src | ||
| utils | ||
| .gitignore | ||
| .gitmodules | ||
| build.rs | ||
| Cargo.lock | ||
| Cargo.toml | ||
| CHANGELOG.md | ||
| LICENSE | ||
| README.md | ||
WORK IN PROGRESS - ETA: December 25th, 2022
Gupax is a (Windows|macOS|Linux) GUI for mining Monero on P2Pool, using XMRig.
To see a 1-minute video on how to download and run Gupax: click here.
Contents
- What is Monero/P2Pool/XMRig/Gupax?
- How-To
- Simple
- Advanced
- Connections
- Community Monero Nodes
- Build
- FAQ
What is Monero/P2Pool/XMRig/Gupax?
Monero is a secure, private, and untraceable cryptocurrency.
The Monero GUI software lets you run a Monero node (among other things). A Monero node connects you to other peers and lets you download Monero's blockchain.
P2Pool is software that lets you create/join decentralized peer-to-peer Monero mining pools.
P2Pool as a concept was first developed for Bitcoin but was never fully realized due to many limitations. These limitations were fixed when SChernykh rewrote P2Pool from scratch for Monero. P2Pool combines the best of solo mining and traditional pool mining:
- It's decentralized: There's no central server that can be shutdown or pool admin that controls your hashrate
- It's permissionless: It's peer-to-peer so there's no one to decide who can and cannot mine on the pool
- It's trustless: Funds are never in custody, all pool blocks pay out to miners directly and immediately
- 0% transaction fee, 0 payout fee, immediate ~0.0003 XMR minimum payout
XMRig is an optimized miner which mines Monero at higher speeds.
Both Monero and P2Pool have built in miners but XMRig is quite faster than both of them. Due to issues like anti-virus flagging, it is not feasible to integrate XMRig directly into Monero or P2Pool, however, XMRig is still freely available for anyone to download with the caveat being: you have to set it up yourself.
Gupax is a GUI that helps with configuring, updating, and managing P2Pool & XMRig (both originally CLI-only).
Recap:
- XMRig mines to P2Pool which fetchs blocks from a Monero node
- Monero GUI runs the Monero node
- Gupax runs P2Pool/XMRig
By default, though, Gupax will use a Community Monero Node so you don't even have to run your own full Monero node to start mining on P2Pool:
How-To
Video
Text
Simple
Gupax
P2Pool
XMRig
Advanced
Verifying
Command Line
Tor/Arti
Logs
Disk
Swapping P2Pool/XMRig
Gupax
P2Pool
XMRig
Connections
For transparency, here's all the connections Gupax makes:
| Domain | Why | When | Where |
|---|---|---|---|
| https://github.com | Fetching metadata information on packages + download | [Gupax] tab -> Check for updates |
update.rs |
| DNS | DNS connections will usually be handled by your OS (or whatever custom DNS setup you have). If using Tor, DNS requests should be routed through the Tor network automatically | Same as above | Same as above |
| Community Monero Nodes | Connecting to with P2Pool, measuring ping latency | [P2Pool Simple] tab |
node.rs |
Community Monero Nodes
| Name | IP/Domain | RPC Port | ZMQ Port |
|---|---|---|---|
| C3pool | node.c3pool.com | 18081 | 18083 |
| Cake | xmr-node.cakewallet.com | 18081 | 18083 |
| CakeEu | xmr-node-eu.cakewallet.com | 18081 | 18083 |
| CakeUk | xmr-node-uk.cakewallet.com | 18081 | 18083 |
| CakeUs | xmr-node-usa-east.cakewallet.com | 18081 | 18083 |
| Feather1 | selsta1.featherwallet.net | 18081 | 18083 |
| Feather2 | selsta2.featherwallet.net | 18081 | 18083 |
| MajesticBankIs | node.majesticbank.is | 18089 | 18083 |
| MajesticBankSu | node.majesticbank.su | 18089 | 18083 |
| Monerujo | nodex.monerujo.io | 18081 | 18083 |
| Plowsof1 | node.monerodevs.org | 18089 | 18084 |
| Plowsof2 | node2.monerodevs.org | 18089 | 18084 |
| Rino | node.community.rino.io | 18081 | 18083 |
| Seth | node.sethforprivacy.com | 18089 | 18083 |
| SupportXmr | node.supportxmr.com | 18081 | 18083 |
| SupportXmrIr | node.supportxmr.ir | 18089 | 18083 |
| XmrVsBeast | p2pmd.xmrvsbeast.com | 18081 | 18083 |
Build
General Info
You need cargo, Rust's build tool and package manager.
The --release profile in Gupax is set to prefer code performance & small binary sizes over compilation speed (see Cargo.toml). Gupax itself (with all dependencies already built) takes around 1m30s to build (vs 10s on a normal --release) with a Ryzen 5950x.
Linux
You'll need the development versions of libraries like OpenSSL, SQLite, and maybe some other ones already installed on your system. Read the compiler errors to see which ones are missing from your system and search around to see which packages you'll need to install depending on your distro.
After that, run:
cargo build --release
macOS
You'll need Xcode.
On macOS, if you want the binary to have an icon, you must install cargo-bundle and compile with:
cargo bundle --release
This bundles Gupax into a Gupax.app, the way it comes in the pre-built tars for macOS.
Windows
You'll need Visual Studio.
There is a build.rs file in the repo solely for Windows-specific things:
- It sets the icon in
File Explorer - It statically links
VCRUNTIME140.dllinto Gupax (the binary will not be portable without this)
After installing the development tools, run:
cargo build --release
This will build Gupax with the MSVC toolchain (x86_64-pc-windows-msvc). This is the recommended method and is how the pre-compiled release binaries are built.
FAQ
Where are updates downloaded from?
The latest versions are downloaded using the GitHub API.
- Gupax
https://github.com/hinto-janaiyo/gupax - P2Pool
https://github.com/SChernykh/p2pool - XMRig
https://github.com/xmrig/xmrig
GitHub's API blocks request that do not have an HTTP User-Agent header. For privacy, Gupax randomly uses a recent version of a Wget/Curl user-agent.
Can I quit mid-update?
If you started an update, you should let it finish. If the update has been stuck for a long time, it may be worth quitting Gupax. The worst that can happen is that your Gupax/P2Pool/XMRig binaries may be moved/deleted. Those can be easily redownloaded. Your actual Gupax user data (settings, custom nodes, pools, etc) is never touched.
Although Gupax uses a temporary folder (gupax_update_[A-Za-z0-9]) to store temporary downloaded files, there aren't measures in place to revert an upgrade once the file swapping has actually started. If you quit Gupax anytime before the Upgrading packages phase (after metadata, download, extraction), you will technically be safe but this is not recommended as it is risky, especially since these updates can be very fast.
How much memory does Gupax use?
Gupax itself uses around 100-300 megabytes of memory.
Gupax also holds up to 500,000 bytes of log data from P2Pool/XMRig to display in the GUI terminals. These logs are reset once over capacity which takes around 1-2 hours.
Memory usage should never be above 400~ megabytes. If you see Gupax using more than this, please send a bug report.