mirror of
https://github.com/Cyrix126/gupaxx.git
synced 2025-04-06 14:37:29 +00:00
deleted space if there was a header in between.
This commit is contained in:
cheese
parent
22720ca23a
commit
04d358f8a5
4 changed files with 1 additions and 67 deletions
|
|
@ -1,30 +1,23 @@
|
|||
# Differences with upstream [Gupax](https://github.com/hinto-janai/gupax)
|
||||
|
||||
## **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.
|
||||
It was only for updates.
|
||||
If you want Gupaxx to update by tor, you can torify it when launching.
|
||||
|
||||
## **Technical Debt**
|
||||
|
||||
All dependencies are upgraded to last possible version, even when there is a breaking change (code of Gupaxx is modified for that).
|
||||
|
||||
## **Bugfixes** (visuals and performances)
|
||||
|
||||
The rendering of Tabs has been modified so that the minimum stated size of the window is capable to show everything. In Upstream middles panels often overlap on the bottom.
|
||||
|
||||
The rendering of the benchmark table and of console outputs were calculating every line at the same time. Now it only renders what you see. It is a significant improvement for your processor, and you can feel the difference if it is not very powerful.
|
||||
|
|
@ -34,5 +27,4 @@ Updates from Gupaxx do not retrieve XMRig and P2Pool from upstream anymore, but
|
|||
It also allows advanced users to use your their own version of P2Pool and XMRig.The standalone version of Gupaxx will not replace them.
|
||||
|
||||
## **Security**
|
||||
|
||||
With the upgrade of dependencies, cargo audit shows no more warnings for Gupaxx. (instead of 5 vulnerabilities and 4 allowed warnings for Gupax.)
|
||||
|
|
|
|||
39
IDEAS.md
39
IDEAS.md
|
|
@ -1,6 +1,5 @@
|
|||
# **IDEAS for the future of Gupaxx**
|
||||
|
||||
|
||||
**Theses are only ideas, everything here is still to be decided and only thoughts for now.**
|
||||
Note: Some ideas could be done in a matter of hours, some could take months.
|
||||
|
||||
|
|
@ -8,11 +7,9 @@ Note: Some ideas could be done in a matter of hours, some could take months.
|
|||
### Synchronize source code repository on p2p network
|
||||
Github is proprietary. If Gupaxx aims to be free software, it should not be only available on this proprietary platform and we should explore options to be github free.
|
||||
We can use [Radicle](https://radicle.xyz/) to get Gupaxx on a p2p collaboration stack.
|
||||
> The code, issues and PR could then also be synchronized with Github.
|
||||
|
||||
The code, issues and PR could then also be synchronized with Github.
|
||||
### Integrate a P2Pool compatible Nodes crawler
|
||||
To get rid of integrating nodes list, we can include a crawler like monero.fail inside Gupaxx.
|
||||
|
||||
### Integrate a Monero Node
|
||||
[Done](https://github.com/Cyrix126/releases/tag/v1.5.0)
|
||||
If we want Gupaxx to help user mine in the most decentralized way, we should offer them to run a monero node.
|
||||
|
|
@ -22,68 +19,50 @@ This would be optional and would check if the requirement are fulfilled before e
|
|||
### Website
|
||||
Creating a website like [gupax.io](https://gupax.io) to have a more user friendly presentation and installation method.
|
||||
Having a website, we can detect the architecture and OS of the visitor and give them the right archive to download.
|
||||
|
||||
### Generated wallet
|
||||
If Gupaxx could create a wallet and put the primary address in P2Pool tab automatically, it would remove a manual step for the user.
|
||||
It could be an option to ask at first start.
|
||||
The user could access this wallet on the same computer with the official GUI wallet. A password would be needed and a button could be added to show the seedphrase.
|
||||
|
||||
### Auto register to XvB
|
||||
If Gupaxx could register the user automatically to the raffle, it would remove a manual step for the user.
|
||||
Automatic registration could be done to prevent spam by checking if the registered address is in P2Pool window or by giving a small HR to XvB.
|
||||
It could be an option to ask at first start.
|
||||
|
||||
### Setup Guide
|
||||
At first start, a guide could ask the user what it intends to do with Gupaxx (create node, create wallet, use XMRig-Proxy, participate in raffle...) and do the setup for him and show him what it must do manually. An option to skip this guide would be present for advanced users.
|
||||
|
||||
### Very noob mode
|
||||
At first start, a mode is suggested for very noob users. It would only shows the seed phrase of the wallet generated and configure all options for the user.
|
||||
|
||||
### Use remote node while syncing local node
|
||||
To reduce the time to get the first shares. No need to wait for the monero node to be synced.
|
||||
|
||||
|
||||
### **Better UI**
|
||||
#### Set fixed font size, do not resize with size of window
|
||||
Setting a fixed font size will allow to use the space fully and having a UI more adapted to screens. Option to set the size of the font will be included.
|
||||
|
||||
#### Do not re-ask password if not needed
|
||||
On Linux, Do not re-ask for sudo to start XMRig when the user can use sudo without a password. It can happen if visudo has been configured to do so or if there is a delay specified in /etc/sudoers with "timestamp_timeout".
|
||||
|
||||
#### Allow resize of consoles
|
||||
So users can view more or less output as they need.
|
||||
|
||||
#### Scrolling arrows
|
||||
To notify the user that content is present in the bottom, an arrow pointing downside will appear.
|
||||
|
||||
#### Friendlier custom args
|
||||
For custom command arguments, some args are required. To help the user not make any errors, theses args must be prefilled. The user will need to enable a checkbox to apply the custom command arguments. A button reset will replace the text fields by only the required fields.
|
||||
|
||||
#### Allow to hide status column
|
||||
Status columns can take together lots of space and user can use only a number of them. Allows to hide/restore them with button on the bottom on the columns for each one.
|
||||
|
||||
#### Better defaults
|
||||
[Done](https://github.com/Cyrix126/gupaxx/commit/6cb767a342bec2df3358b10826a1ec1dee57fc76) and [Done](https://github.com/Cyrix126/gupaxx/commit/a102bdbee2e4c0bc8785f9e638d3e54958d79489)
|
||||
Reduce in/out peers, remote nodes by default
|
||||
|
||||
|
||||
## **Making Gupaxx Support more environments**
|
||||
### Packaging
|
||||
Add repository/AUR for Gupaxx and a status of packaging distro/version on the README.
|
||||
|
||||
### Minimum requirement
|
||||
Add a table with minimum hardware/software requirements to the README.
|
||||
|
||||
### Add more target
|
||||
Gupaxx could add support for Linux ARM64 since both P2Pool and XMRig can compile on this target.
|
||||
|
||||
### Refactor size of text
|
||||
Gupaxx currently resize texts/widgets based on the window size. Instead, the text/widget size should be decided by the OS/config, scroll bar should be used when there is not enough space. It will allow to use Gupaxx on different ratio of screen.
|
||||
|
||||
### CLI for Algorithm
|
||||
A simple script or a small binary could be made to reproduce the algorithm who would take args for every other needed programs.
|
||||
This script would need arguments to know how to control XMRig/XMRig-Proxy and where to watch P2Pool data plus the XvB token and XMR address.
|
||||
|
||||
### Web UI
|
||||
To be able to control and watch Gupaxx from another device, a daemon mode could be built with a web UI front-end.
|
||||
|
||||
|
|
@ -91,43 +70,32 @@ To be able to control and watch Gupaxx from another device, a daemon mode could
|
|||
### Optimization for XMRig
|
||||
#### Add automatic options
|
||||
On Linux, we can activate 1GB pages after detecting CPU flags. We can also add cpu affinity option.
|
||||
|
||||
#### Manual optimizations
|
||||
On the XMRig tab, inform users about manual optimizations that Gupaxx can't control. For example, disabling hyper-threading in BIOS is recommended.
|
||||
|
||||
### Watch Stratum Data instead of estimate.
|
||||
Right now, the algorithm estimate the eHR with the estimation made by the P2Pool instance which is calculating from passed shares.
|
||||
The algorithm could instead watch the stats from the stratum server, which is more precise but would take into account only miners which are pointed to it.
|
||||
The algorithm would still check the estimation made by the P2Pool instance of Gupaxx and warn the user if it seems there is too much difference between the data of the stratum server and the one of P2Pool. It could prevent the user to forget to configure a miner to the stratum P2Pool.
|
||||
Could also be an option in advanced tab of XvB warning the user that he should point all his miners to the P2Pool instance of Gupaxx to take them into account.
|
||||
It can be a checkbox into advanced option of XvB to use the stratum data.
|
||||
|
||||
### Automatic sending of funds
|
||||
A way to automatically send funds of mining to a wallet address or multiple wallet addresses by setting a minimum amount and % with time frequency or setting a fixed amount and priority.
|
||||
|
||||
### Wait for sync to start of XMRig
|
||||
If P2Pool/node is not yet synced, XMRig can slower them and mine for nothing if it start at the same time. We don't want to prevent the user to start XMRig without P2Pool, so XMRig could start later only if P2Pool is auto started.
|
||||
|
||||
### Systray icon
|
||||
Enable a way to put Gupaxx in background, managing it with a systray icon.
|
||||
|
||||
### Auto-Launch
|
||||
Option to launch Gupaxx at startup
|
||||
|
||||
### API of Algorithm
|
||||
To make the Algorithm controllable outside of Gupaxx.
|
||||
|
||||
### Graphs history of HR
|
||||
The user could see how the HR was given on P2Pool and XvB.
|
||||
|
||||
### Update XMRig benchmark from Gupaxx
|
||||
To have the latest benchmark from XMRig, but still including one by default. Also automates the inclusion on release.
|
||||
|
||||
### Manually set HR for XvB algo
|
||||
Done by [Sina](https://github.com/mostafaei2002) [PR](https://github.com/Cyrix126/gupaxx/pull/11)
|
||||
An advanced tab on XvB tab with multiple tools to set the HR manually.
|
||||
The user can sometime better know the right decision from his HR than the algo that will take more time to get everything right, specially if resources are changing.
|
||||
|
||||
### Integrate XMRig-Proxy
|
||||
[Done](https://github.com/Cyrix126/gupaxx/releases/tag/v1.2.0)
|
||||
The algorithm of distribution of HR can't control HR outside of his instance.
|
||||
|
|
@ -135,23 +103,18 @@ It must estimate external HR, which can be approximative.
|
|||
If a user control multiples miners, it could connect all of them to a XMRig-Proxy instance.
|
||||
Gupaxx could offer this XMRig-instance and control it like it was a normal XMRig instance.
|
||||
|
||||
|
||||
## **Trust-less Builds**
|
||||
### Reproducible builds
|
||||
To remove (un)necessary trust, binaries released should have the same checksum if recompiled without code change.
|
||||
See [This](https://reproducible-builds.org).
|
||||
|
||||
### Release changes notes preview
|
||||
Show the summuray of what will change between releases before updating to newer release.
|
||||
|
||||
### Check signature of updates with Gupaxx
|
||||
let the build in updater of Gupaxx check the signature of the release to confirm that the releases has been signed by the right key.
|
||||
|
||||
|
||||
## **Donation**
|
||||
### Donation transparency
|
||||
So that user can see how much is given to this project and make their own opinion of it if enough donations have been given or not, the history of donation should be made visible with the viewkey available.
|
||||
|
||||
|
||||
## **XvB**
|
||||
keeping track of participation history in rounds and automatically showing results in the XvB tab.
|
||||
|
|
|
|||
|
|
@ -2,7 +2,6 @@
|
|||
**Draft**
|
||||
|
||||
# **Algorithm of distribution of Hashrate between P2pool and XvB**
|
||||
|
||||
## **Objective**
|
||||
If the Hashrate (HR) is not enough to probably always have at least one share in the window PPLNS (WP), the HR will never be redirected to XvB node but always stay on P2Pool node.
|
||||
|
||||
|
|
@ -11,8 +10,6 @@ If no share is acquired, all HR will stay on P2Pool node until there is one.
|
|||
If HR is enough to probably always have at least one share in the (WP), the spare HR will be:
|
||||
**Default mode**: in part given to XvB node to be in the most possible round type and keep in P2Pool the rest of HR that will not impact the type of round (sHR for spared HR).
|
||||
**Hero mode**: entirely given to the XvB node regardless of sHR.
|
||||
|
||||
|
||||
## **How**
|
||||
>PPLNS window size (PWS): API P2pool pplnsWindowSize [^1]
|
||||
p2pool difficulty(PD): API P2pool sidechainDifficulty [^1]
|
||||
|
|
@ -35,16 +32,12 @@ This estimated external HR(eHR) minus the local HR sent to P2Pool will be remove
|
|||
If miners outside the Gupaxx instance are mining on XvB for the same address, Gupaxx will maybe send too much (more than enough for the round) or too less (could have been in better round) on XvB.
|
||||
To solve this second issue, it will remove from the required HR to get to rounds the average HR sent to XvB (retrieved by XvB API) minus what he is sending of its own.
|
||||
|
||||
|
||||
## **Examples**
|
||||
PWS = 2160
|
||||
PD = 85.5M
|
||||
|
||||
### Example 1: the poor
|
||||
Miner has 2kH/s on Gupaxx.
|
||||
|
||||
HR never goes on XvB, because the minimum required to have a share in WP is 4kH/s based on PD and PWS values.
|
||||
|
||||
### Example 2: the modest
|
||||
Miner has 10kH/s on Gupaxx
|
||||
for ten minutes, 4 are required to be put on P2Pool.
|
||||
|
|
@ -56,7 +49,6 @@ The first round type (Donor round) need 1kH/s and second round type (VIP Donor)
|
|||
So 1kH/s is given to XvB node so that the miner participate in the Donor round.
|
||||
|
||||
**Hero mode**: 4 minutes are given to P2Pool and 6 for XvB.
|
||||
|
||||
### Example 3: the hardworker
|
||||
Miner has 5kH/s on Gupaxx
|
||||
He also have one remote miner that mines 2kH/s on P2Pool and another one 8kH/s on XvB
|
||||
|
|
@ -65,29 +57,21 @@ He also have one remote miner that mines 2kH/s on P2Pool and another one 8kH/s o
|
|||
Because to have at still one share per window, gupaxx need to complete the already existent HR on P2Pool with 4 minutes (2kH/s). But after that, it still have 6 minutes spared (3kH/s) when only 4 minutes are needed to gain the better round of vip donor (10kH/s). So it will send only the necessary 4 minutes to XvB and give the 2 minutes not needed to P2Pool.
|
||||
|
||||
**Hero mode**: 4 minutes are given to P2Pool and 6 for XvB.
|
||||
|
||||
|
||||
## **Technical Implementation**
|
||||
|
||||
### Knowing if a share is in PW
|
||||
P2Pool node (PN) local API show only found shares and not current.
|
||||
Gupaxx process will check frequently the output of the P2Pool command "status" without impacting the console output of the P2Pool tab to get the current shares.
|
||||
|
||||
### know oHR on P2Pool
|
||||
Gupaxx watch for sidechain HR for his address on the output of status command of P2Pool in a way that do not disturb the output of console in the UI.
|
||||
|
||||
### know oHR on XvB
|
||||
Gupaxx receive this data from XvB API.
|
||||
|
||||
### Knowing the HR generated by Gupaxx
|
||||
Gupaxx will simply watch the values retrieved by XMRig process.
|
||||
|
||||
### Switching HR from P2Pool node to XvB node
|
||||
The mHR is calculated depending on the sidechain the P2Pool is mining on.
|
||||
The XvB process will check every ten minutes the last 15 minutes average HR and decide when to switch (in seconds) for the ten next minutes. (first P2Pool then XvB).
|
||||
*Need to see the time for XMRig takes to set the new settings by API.*
|
||||
When the time to switch arrives, XvB process will send a request to XMRig to change the node used.
|
||||
|
||||
### Modification of config of XMRig
|
||||
The following 4 attributes must be applied to XMRig config when mining to XvB node.
|
||||
|
||||
|
|
|
|||
|
|
@ -59,13 +59,10 @@ It will send by default just enough to get to the highest round or, if hero mode
|
|||
|
||||
## **XvB Tab**
|
||||
|
||||
|
||||
### Console of XvB
|
||||
The output of the console will show useful information on the status of the XvB process and the decision of the algorithm for every 10 minutes.
|
||||
|
||||
### Token input
|
||||
When you registered your XMR payout address, you should have received a token. Please enter this token here.
|
||||
|
||||
### Account stats
|
||||
Account stats about your address on XMRvsBeast can be found here after the process is started with your token provided.
|
||||
|
||||
|
|
@ -87,10 +84,8 @@ There is currently no plan to upstream the changes as the owner of Gupax said he
|
|||
|
||||
## **Troubleshooting**
|
||||
If you have any issue, feel free to ask for support in the [xmrvsbeast matrix room](#xmrvsbeast:monero.social) [](https://matrix.to/#/#xmrvsbeast:monero.social) or you can also just [open an issue](https://github.com/Cyrix126/gupaxx/issues/new/choose) in this repo. You can also contact me through [email](mailto:gupaxx@baermail.fr).
|
||||
|
||||
### Windows
|
||||
You must add an exception to your antivirus for the directory where gupaxx is executed. Follow the step for Windows Only that start at 30 seconds in this [video](https://user-images.githubusercontent.com/101352116/207978455-6ffdc0cc-204c-4594-9a2f-e10c505745bc.mp4).
|
||||
|
||||
### Mac OSX
|
||||
You must remove Gupaxx app from quarantine with following command:
|
||||
*If you have put Gupaxx.app in your Applications*
|
||||
|
|
|
|||
Loading…
Reference in a new issue