mirror of
https://github.com/Cyrix126/gupaxx.git
synced 2024-12-23 07:09:23 +00:00
79b0361152
There was a deadlock happening between the [Helper]'s [gui_api_p2pool] and the GUI's [gui_api_p2pool], since the locking order was different. The watchdog loop locking order was fixed as well. This was a pain to track down, better than a data race... I guess. Oh and keyboard shortcuts were added in this commit too. Comment from code: // The ordering of these locks is _very_ important. They MUST be in sync // with how the main GUI thread locks stuff or a deadlock will occur // given enough time. They will eventually both want to lock the [Arc<Mutex>] // the other thread is already locking. Yes, I figured this out the hard way, // hence the vast amount of debug!() messages. // // Example of different order (BAD!): // // GUI Main -> locks [p2pool] first // Helper -> locks [gui_api_p2pool] first // GUI Status Tab -> trys to lock [gui_api_p2pool] -> CAN'T // Helper -> trys to lock [p2pool] -> CAN'T // // These two threads are now in a deadlock because both // are trying to access locks the other one already has. // // The locking order here must be in the same chronological // order as the main GUI thread (top to bottom).
202 lines
7.7 KiB
Markdown
202 lines
7.7 KiB
Markdown
# WORK IN PROGRESS - ETA: December 25th, 2022
|
|
|
|
Gupax is a (Windows|macOS|Linux) GUI for mining [**Monero**](https://github.com/monero-project/monero) on [**P2Pool**](https://github.com/SChernykh/p2pool), using [**XMRig**](https://github.com/xmrig/xmrig).
|
|
|
|
**To see a 1-minute video on how to download and run Gupax: [click here.](#Video)**
|
|
|
|
## Contents
|
|
* [What is Monero/P2Pool/XMRig/Gupax?](#what-is-monero-p2pool-xmrig-and-gupax)
|
|
* [How-To](#How-To)
|
|
- [Video](#Video)
|
|
- [Text](#Text)
|
|
- [Simple](#Simple)
|
|
- [Gupax](#Gupax)
|
|
- [P2Pool](#P2Pool)
|
|
- [XMRig](#XMRig)
|
|
- [Advanced](#Advanced)
|
|
- [Verifying](#Verifying)
|
|
- [Command Line](#Command-Line)
|
|
- [Tor/Arti](#TorArti)
|
|
- [Logs](#Logs)
|
|
- [Disk](#Disk)
|
|
- [Swapping P2Pool/XMRig](#Swapping-P2PoolXMRig)
|
|
- [Gupax](#Gupax)
|
|
- [P2Pool](#P2Pool)
|
|
- [XMRig](#XMRig)
|
|
- [Connections](#Connections)
|
|
* [Community Monero Nodes](#community-monero-nodes)
|
|
* [Build](#Build)
|
|
- [General Info](#General-Info)
|
|
- [Linux](#Linux)
|
|
- [macOS](#macOS)
|
|
- [Windows](#Windows)
|
|
* [FAQ](#FAQ)
|
|
|
|
## What is Monero/P2Pool/XMRig/Gupax?
|
|
**Monero** is a secure, private, and untraceable cryptocurrency.
|
|
|
|
The **[Monero GUI](https://github.com/monero-project/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](https://en.wikipedia.org/wiki/Blockchain).
|
|
|
|
***[More info here.](https://github.com/monero-project/monero)***
|
|
|
|
---
|
|
|
|
**P2Pool** is software that lets you create/join **decentralized peer-to-peer Monero mining pools.**
|
|
|
|
P2Pool as a concept was [first developed for Bitcoin](https://en.bitcoin.it/wiki/P2Pool) but was [never fully realized](https://github.com/p2pool/p2pool) 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**
|
|
|
|
***[More info here.](https://github.com/SChernykh/p2pool)***
|
|
|
|
---
|
|
|
|
**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](https://github.com/monero-project/monero-gui/pull/3829#issuecomment-1018191461), 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.
|
|
|
|
***[More info here.](https://github.com/xmrig/xmrig)***
|
|
|
|
---
|
|
|
|
**Gupax** is a GUI that helps with configuring, updating, and managing P2Pool & XMRig (both originally CLI-only).
|
|
|
|
***Recap:***
|
|
1. **XMRig** mines to **P2Pool** which fetchs blocks from a **Monero node**
|
|
2. **Monero GUI** runs the ***Monero node***
|
|
3. **Gupax** runs ***P2Pool/XMRig***
|
|
|
|
|
|
|
|
With Monero GUI managing the Monero node on one side and Gupax managing P2Pool/XMRig on the other, it is (hopefully) very easy for anyone to start mining Monero at **max hashrate in a decentralized, permissionless, and trustless manner**.
|
|
|
|
## 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`](https://github.com/hinto-janaiyo/gupax/blob/main/src/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*](https://tpo.pages.torproject.net/core/doc/rust/arti/) 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`](https://github.com/hinto-janaiyo/gupax/blob/main/src/node.rs) |
|
|
|
|
## Community Monero Nodes
|
|
| Name | IP/Domain | RPC Port |
|
|
|----------------|----------------------------------|----------|
|
|
| C3pool | node.c3pool.com | 18081 |
|
|
| Cake | xmr-node.cakewallet.com | 18081 |
|
|
| CakeEu | xmr-node-eu.cakewallet.com | 18081 |
|
|
| CakeUk | xmr-node-uk.cakewallet.com | 18081 |
|
|
| CakeUs | xmr-node-usa-east.cakewallet.com | 18081 |
|
|
| Feather1 | selsta1.featherwallet.net | 18081 |
|
|
| Feather2 | selsta2.featherwallet.net | 18081 |
|
|
| MajesticBankIs | node.majesticbank.is | 18089 |
|
|
| MajesticBankSu | node.majesticbank.su | 18089 |
|
|
| Monerujo | nodex.monerujo.io | 18081 |
|
|
| Plowsof1 | node.monerodevs.org | 18089 |
|
|
| Plowsof2 | node2.monerodevs.org | 18089 |
|
|
| Rino | node.community.rino.io | 18081 |
|
|
| Seth | node.sethforprivacy.com | 18089 |
|
|
| Singapore | singapore.node.xmr | 18081 |
|
|
| SupportXmr | node.supportxmr.com | 18081 |
|
|
| SupportXmrIr | node.supportxmr.ir | 18089 |
|
|
| XmrVsBeast | p2pmd.xmrvsbeast.com | 18081 |
|
|
|
|
*Note: Plowsof1 & Plowsof2 have ZMQ port on 18084, the rest are 18083*
|
|
|
|
## Build
|
|
### General Info
|
|
You need [`cargo`](https://www.rust-lang.org/learn/get-started), 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`](https://github.com/hinto-janaiyo/gupax/blob/main/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`](https://developer.apple.com/xcode/).
|
|
|
|
On macOS, if you want the binary to have an icon, you must install [`cargo-bundle`](https://github.com/burtonageo/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`](https://learn.microsoft.com/en-us/windows/dev-environment/rust/setup).
|
|
|
|
There is a `build.rs` file in the repo solely for Windows-specific things:
|
|
1. It sets the icon in `File Explorer`
|
|
2. It statically links `VCRUNTIME140.dll` into 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
|