Ecosystem/gupaxx
1
0
Fork 0
mirror of https://github.com/Cyrix126/gupaxx.git synced 2025-04-23 23:08:11 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

removed grammar

Browse source 
will move to different pr
This commit is contained in:
cheese 2024-11-08 16:26:26 +01:00
parent 04d358f8a5
commit 185dfee29a
4 changed files with 20 additions and 20 deletions

2
ARCHITECTURE.md
View file

@ -29,7 +29,7 @@ This document explains how the source code is organized. Everything differing fr
|component| Gupaxx related features, like updates and nodes.
## **Technical differences of column XMRig in Status Tab process sub-menu with upstream Gupax**
## **Technical differences of column XMRig in Status Tab process sub menu with upstream Gupax**
Status of process for XMRig use for some information an image of data when the process started.
The node of xmrig in upstream can not change without a restart of the process. In this fork, the node used by XMRig needs to be updated without restart (using the config HTTP API of XMRig).

32
IDEAS.md
View file

@ -1,13 +1,13 @@
# **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.
Some ideas could be done in a matter of hours, some could take months.
## **Making Gupaxx 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 be github free.
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.
The code, issues and PR could then also be synchronized with Github.
The code, issues and PR could 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
@ -15,16 +15,16 @@ 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.
## **Making Gupaxx more User friendly**
## **more User friendly**
### 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.
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.
### 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.
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.
It could be an option to ask at first start.
### Setup Guide
@ -47,26 +47,26 @@ To notify the user that content is present in the bottom, an arrow pointing down
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
#### Better default
[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.
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 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.
### 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.
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.
### 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.
## **Making Gupaxx more Powerful**
## **More Powerful**
### Optimization for XMRig
#### Add automatic options
On Linux, we can activate 1GB pages after detecting CPU flags. We can also add cpu affinity option.
@ -91,7 +91,7 @@ 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.
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.
@ -105,8 +105,8 @@ Gupaxx could offer this XMRig-instance and control it like it was a normal XMRig
## **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).
To remove (un)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.
### Check signature of updates with Gupaxx

2
NOTES_ALGORITHM.md
View file

@ -10,6 +10,7 @@ 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]
@ -21,7 +22,6 @@ The mHR needs to be refreshed periodically because it can change with the diffic
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**
If miners outside the Gupaxx instance are mining on P2Pool for the same address, Gupaxx will send too much on P2Pool because it doesn't take extra HR outside his control into account.
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...

4
README.md
View file

@ -38,14 +38,14 @@ For a detailed explanation of Gupax, see the [README](https://github.com/hinto-j
2. Extract
3. Launch Gupaxx
Next steps can be seen in this video tutorial:
Next steps can be seen in this video tutorial.
https://github.com/Cyrix126/gupaxx/assets/58007246/610cbfea-fd97-4150-95ed-9c8a7ef5ba94
4. Input your Monero address in the `P2Pool` tab
5. Register the same address on [XMRvsBeast](https://xmrvsbeast.com)
5. Register your same address on [XMRvsBeast](https://xmrvsbeast.com)
6. Input the token received in the XvB Tab
6. Start P2Pool
7. Start XMRig