From 10b63c6b27b65a131c5d62c6b3b5376a6194467f Mon Sep 17 00:00:00 2001 From: Cyrix126 Date: Fri, 28 Jun 2024 11:06:14 +0200 Subject: [PATCH] feat: update doc for xmrig-proxy --- DIFFERENCES.md | 8 +++++++- NOTES_XMRIG-PROXY.md | 26 +++----------------------- 2 files changed, 10 insertions(+), 24 deletions(-) diff --git a/DIFFERENCES.md b/DIFFERENCES.md index 422e926..671ab71 100644 --- a/DIFFERENCES.md +++ b/DIFFERENCES.md @@ -1,12 +1,18 @@ # Differences with upstream [Gupax](https://github.com/hinto-janai/gupax) -## Integration of the XvB Raffle +## Added functionalities + +### Integration of the XvB Raffle A new fancy tab to apply an algorithm of distribution of HR to xmrig (see [NOTES_ALGORITHM](NOTES_ALGORITHMS)) with your token from XvB. This tab also includes a console output to let you track if everything is working and what are the decision of the algorithm, and show you personal stats from XvB. A new column in Status Tab to see public stats from the raffle. +### Xmrig-Proxy + +You can now point all your external miners and get all the juicy stats in Gupaxx. XvB algorithm is able to control Xmrig-Proxy when it is enabled. + ## Removed functionality Updates by tor. The version of the crate used was outdated, plagued with security concerns and bloated the binary. diff --git a/NOTES_XMRIG-PROXY.md b/NOTES_XMRIG-PROXY.md index 208fca0..703de88 100644 --- a/NOTES_XMRIG-PROXY.md +++ b/NOTES_XMRIG-PROXY.md @@ -10,31 +10,11 @@ Allows a user to point his miners on the Gupaxx instance. ## UI implementation -It is not useful to someone who have only one miner, so it needs to be manually enabled. - - -Tab to start Xmrig-Proxy, interact with console output and give custom options. -Message on Xmrig tab indicating xmrig is automatically redirected to it. -Local ip will be displayed. -Button to fetch public ip to know at which one to point miner at. - -Status column of xmrig is replaced by xmrig-proxy when it is enabled. -Xmrig-proxy will display stats for each miners. +New Tab to start Xmrig-Proxy, interact with console output, give custom options, select a pool from the pool list. +New process column in Status Tab for Xmrig-Proxy. ## Technical implementation xmrig-proxy will mine on p2pool instead of xmrig. When xmrig-proxy is enabled, xmrig is automatically redirected to it instead of p2pool. -XvB algo will check if xmrig-proxy is enabled and watch/control his data instead. - -## TODO - -- [x] State -- [x] Helper thread -- [x] impl Helper -- [x] UI -- [x] interaction with xmrig -- [ ] advanced tls, keep alive, ip port -- [ ] info about ip and firewall -- [ ] status tab -- [ ] interaction with xvb +XvB algo will check if xmrig-proxy is enabled and watch/control his data instead of xmrig.