From e8b1f007bd663ae0252259dac3bdd6004a79fbc8 Mon Sep 17 00:00:00 2001 From: Cyrix126 Date: Sat, 15 Jun 2024 14:44:26 +0200 Subject: [PATCH] feat: add ideas and explain technical implementation description of cli --- IDEAS.md | 8 ++++++++ NOTES_CLI.md | 12 +++++++++--- 2 files changed, 17 insertions(+), 3 deletions(-) diff --git a/IDEAS.md b/IDEAS.md index 262d595..d8a823b 100644 --- a/IDEAS.md +++ b/IDEAS.md @@ -42,6 +42,7 @@ On linux, we can activate 1GB pages after detecting cpu flags. We can also add c #### 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. ### CLI for Algorithm +started by [Cyrix126](https://github.com/Cyrix126) For advanced users, a CLI could be made to use the algorithm without a GUI It would allow the user to do automation and installation on headless environment and save a few HR from the Gupaxx process. This CLI would still offer a way to the user to pass options to xmrig and to start his p2pool server or to use another one already running. @@ -56,7 +57,14 @@ Right now, the algorithm estimate the eHR with the estimation made by the p2pool The algorithm could instead watch the stats from the stratum server, which is exact but would take into account only miners which are pointed to it. Miners using the cli xmrig could point their miners to the p2pool instance of Gupaxx, or have an identical option if they are using the CLI of the algorithm. 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. +### External P2Pool instance +started by [Cyrix126](https://github.com/Cyrix126) +To use multiple Gupaxx instance with only one p2pool instance, the user must be able to set an external p2pool instance instead of running one. +### Manually set HR for XvB algo +started 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. ## Trust-less ## Builds diff --git a/NOTES_CLI.md b/NOTES_CLI.md index e51bcde..4294602 100644 --- a/NOTES_CLI.md +++ b/NOTES_CLI.md @@ -13,17 +13,16 @@ ## Launch args - XVB token - XMR address -- p2pool address:port - optional: hero -- optional: xmrig custom additional args - optional: quiet algo - optional: quiet xmrig - optional: path of xmrig +- optional: path of p2pool or p2pool address:port Example: ``` -gupaxx --cli --token xxxxx --address xxxxx --hero --p2pool="127.0.0.1:3333" --xmrig-add-args="--xxx --xxx" -t 8 -q --path-xmrig="/path/to/xmrig-binary" +gupaxx --cli --token xxxxx --address xxxxx --hero --p2pool="127.0.0.1:3333" -t 8 -q --path-xmrig="/path/to/xmrig-binary" ``` ## Commands @@ -48,3 +47,10 @@ You are not the winner The cli args are managed by [clap](https://docs.rs/clap). The code for managing current args from upstream will be replaced to use this crate. + +The cli mode is enabled by passing the argument cli. +It will autostart xmrig/xvb processes. +p2pool process will be started if no address is given in args. +Otherwise, it will watch p2pool data and mine on it. + +Each argument can be omitted if it's present in the state file.