removed some mixed grammar stuff

will move all grammar and formatting to another pr.(when this pr is merged)
This commit is contained in:
cheese 2024-11-08 16:50:45 +01:00
parent 185dfee29a
commit 2830a95b09
3 changed files with 27 additions and 26 deletions

View file

@ -39,7 +39,7 @@ The field node from ImgXmrig needs to be moved to PubXvbApi. This value must be
## **Updates**
A new option in Gupaxx tab advanced will enable bundled updates.
The binary included of Gupaxx will have default value for bundled updates depending if it is coming from the standalone or the bundled release.
The binary included of gupaxx will have default value for bundled updates depending if it is coming from the standalone or the bundled release.
Updates from Gupaxx will do the following differently from upstream:
- Check if using bundled or standalone with state. Update only Gupaxx binary if the latter or xmrig and p2pool from bundle version if the former.

View file

@ -3,7 +3,7 @@
**Theses are only ideas, everything here is still to be decided and only thoughts for now.**
Some ideas could be done in a matter of hours, some could take months.
## **more Decentralized**
## **More Decentralized**
### 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 get github free.
We can use [Radicle](https://radicle.xyz/) to get Gupaxx on a p2p collaboration stack.
@ -15,17 +15,17 @@ To get rid of integrating nodes list, we can include a crawler like monero.fail
If we want Gupaxx to help user mine in the most decentralized way, we should offer them to run a monero node.
This would be optional and would check if the requirement are fulfilled before enabling the button to do so.
## **more User friendly**
## **More User friendly**
### Website
Build a website like [gupax.io](https://gupax.io) to have a more user frendly presentation and installation method.
Having a website, we can detect the architecture and OS of the visitor and give him the right archive to download.
Having a website, we can detect the architecture and os of the visitor and give him 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.
If Gupaxx could create a wallet and put the primary address in p2pool tab automaticcly, 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 automaticcly 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.
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.
@ -38,7 +38,7 @@ To reduce the time to get the first shares. No need to wait for the monero node
#### 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".
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
@ -57,25 +57,25 @@ Add repository/AUR for Gupaxx and a status of packaging distro/version on the RE
### Minimum requirement
Add on README a table with minimum hardware/software requirements.
### Add more target
Gupaxx could add support for Linux ARM64 since both P2Pool and XMRig can compile on this target.
Gupaxx could add support for linux arm64 since p2pool and xmrig can compile on this target.
### Refactor size of text
Gupax/x 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.
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.
## **More Powerful**
### Optimization for XMRig
### Optimization for xmrig
#### Add automatic options
On Linux, we can activate 1GB pages after detecting CPU flags. We can also add cpu affinity option.
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.
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.
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
@ -89,9 +89,9 @@ 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
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.
@ -100,12 +100,12 @@ The user can sometime better know the right decision from his HR than the algo t
[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.
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.
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, binairies released should have the same checksum if recompiled without code change.
To remove necessary trust, binairies 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.

View file

@ -12,14 +12,14 @@ If HR is enough to probably always have at least one share in the (WP), the spar
**Hero mode**: entirely given to the XvB node regardless of sHR.
## **How**
>PPLNS window size (PWS): API P2pool pplnsWindowSize [^1]
PPLNS window size (PWS): API P2pool pplnsWindowSize [^1]
p2pool difficulty(PD): API P2pool sidechainDifficulty [^1]
mHR: minimum required HR to stay in WP = PD / (PWS*10) [^2]
Because it is probabilities, a buffer will be put in place for the required HR for P2Pool and mHR for round type to allow some margin of errors.
Because it is probabilities, a buffer will be put in place for the required HR for p2pool and mHR for round type to allow some margin of errors.
The mHR needs to be refreshed periodically because it can change with the difficulty changing. (PWS should not change).
Calculation is made in % of time that will go to P2Pool and to XvB, depending if mining on mini or main side chain.
Calculation is made in % of time that will go to p2pool and to XvB, depending if mining on mini or main side chain.
Every ten minutes, the algorithm will decide how next 10 minutes will be distributed depending on default or hero mode.
## **Manage with outside HashRate**
@ -27,7 +27,7 @@ If miners outside the Gupaxx instance are mining on P2Pool for the same address,
To solve this issue, it will look at the sidechain estimated HR (eHR) from status command of P2Pool. It is an estimation based on passed discovered shares, their difficulty, the number of blocks between them etc...
This eHR will be retrieved at the same interval as the algorithm.
This estimated external HR(eHR) minus the local HR sent to P2Pool will be removed from the mHR.
This estimated external HR(eHR) minus the local HR sent to p2pool will be removed from the mHR.
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.
@ -40,9 +40,9 @@ 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.
for ten minutes, 4 are required to be put on p2pool.
**Default mode**: 9 minutes are given to P2Pool and one for XvB.
**Default mode**: 9 minutes are given to p2pool and one for XvB.
Because after giving 4mn to P2Pool to meet mHR, he still have ~5kH/s to spare.
The first round type (Donor round) need 1kH/s and second round type (VIP Donor) need 10kH/s.
5kH/s is enough for the Donor Round but not enough for the VIP Donor.
@ -57,6 +57,7 @@ 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.
@ -90,7 +91,7 @@ Or to return back to p2pool
"tls": false,
```
The HTTP API of XMRig requires to give a full config.
The HTTP API of xmrig requires to give a full config.
The current config will be requested, modified and sent back.
[^1]: https://p2pool.io/mini/api/pool/stats