gupaxx/TODO_XMRvsBeast.md

# TODO

# Bounty

[XvB Bounty](https://bounties.monero.social/posts/105)

*These todos are not all part of the bounty.*

- [x] upgrade deps
- [x] separate logic in smaller modules
- [x] new tab XvB
  - [x] logo
  - [x] link to website
  - [x] link and message hovering explaining registration and needs to read the rules.
  - [x] token input
  - [x] hero checkbox
    - [x] without restart of xvb (next decision of algo)
  - [x] log section
    - [x] state of XvB process
    - [x] selected XvB node
    - [x] algorithm decisions info
    - [x] timestamp
  - [x] private stats
      - [x] from XvB API (fails, average 1h and 24h)
      - [x] round type in
      - [x] win or loose
  - [x] indicator of mining round and time left.
  - [x] new process for XvB
    - [x] update preferred XvB node based on ping and backup 
      - [x] fix: xmrig will not do anything if node is not responding. Need to parse output of xmrig for error and update nodes.
    - [x] status process XvB
    - [x] status process XMRig node in real time.
    - [x] public information from [API](https://xmrvsbeast.com/p2pool/stats)
    - [x] stop, start, restart buttons
    - [x] button to autostart
    - [x] distribute hashrate conforming to the algorithm.
      - [x] check every 10 minutes average Xmrig HR of last 15 minutes
      - [x] fast startup (check 10s first decision then 1m second decision)
      - [x] take into account outside HR
        - [x] mining on p2pool
        - [x] mining on XvB
      - [x] ask Xmrig to mine on p2pool
        - [x] generate token for xmrig
        - [x] enable xmrig with remote access control
      - [x] check if at least a share in pplns Window
      - [x] calculate spared HR
      - [x] calculate time to be spared
        - [x] with hero option
        - [x] without hero option, to give minimum to be in most accessible round type
      - [x] sleep 10mn less time to spare then ask Xmrig to mine on XvB node
    - [x] output log to console in XvB tab
- [x] fix some overlapping from upstream
- [x] edit metadata of project
  - [x] adapt README for XvB 
    - [x] beta release
    - [x] stable release
  - [ ] video tutorial to set up XvB Tab
  - [x] adapt doc for new code
  - [x] cargo package metadata
  - [x] pgp signatures
  - [x] rename reference of gupax name to gupaxx
  - [x] replace AppImage with a desktop file
- [x] fix clippy
- [x] optimizations
  - [x] benchmarks table render only what is visible
  - [x] console output render only what is visible
    - [x] remove arti
    - [x] replace hyper with reqwest
- [x] better organize new code
- [x] merge commits from upstream
- [x] tests for new function 
  - [x] time calculated by algorithm 
- [x] better automatization with utils for releases
- [x] pre-release
  - [x] feedback
- [x] release
feat: add TODO for bounty XvB 2024-02-28 12:34:06 +00:00			`# TODO`

			`# Bounty`

			`[XvB Bounty](https://bounties.monero.social/posts/105)`

feat: maj TODO 2024-03-22 10:23:28 +00:00			`These todos are not all part of the bounty.`

feat: add TODO for bounty XvB 2024-02-28 12:34:06 +00:00			`- [x] upgrade deps`
feat: maj TODO 2024-03-03 07:43:48 +00:00			`- [x] separate logic in smaller modules`
feat: add TODO for bounty XvB 2024-02-28 12:34:06 +00:00			`- [x] new tab XvB`
			`- [x] logo`
			`- [x] link to website`
fix: maj TODO 2024-03-14 23:36:13 +00:00			`- [x] link and message hovering explaining registration and needs to read the rules.`
feat: console for log, input token field, better logic for running XvB process 2024-03-12 22:26:08 +00:00			`- [x] token input`
fix: maj TODO 2024-03-14 23:36:13 +00:00			`- [x] hero checkbox`
feat: beta release 0.1.6 2024-04-02 15:08:14 +00:00			`- [x] without restart of xvb (next decision of algo)`
feat: finish XvB Tab with private stats and better log output fix: color code status feat: reload automaticcly XvB process if p2pool is off/online feat: add all 5 private stat in a pretty way outside of console feat: begin to use readable to replace human.rs feat: function to verify if share is in current window feat: maj TODO feat: Maj TODO 2024-03-15 20:40:27 +00:00			`- [x] log section`
feat: console for log, input token field, better logic for running XvB process 2024-03-12 22:26:08 +00:00			`- [x] state of XvB process`
feat: output of console info about algorithm and node selection fix: HR symbol private stats (subject to change) feat: output to XvB tab console information for algorithm decision feat: output to XvB tab console information for node selection feat: maj TODO 2024-03-18 11:31:37 +00:00			`- [x] selected XvB node`
			`- [x] algorithm decisions info`
feat: add timestamp to console ouput XvB fix: move code for output on console to a single function. 2024-03-19 14:31:13 +00:00			`- [x] timestamp`
fix: maj TODO 2024-03-14 23:36:13 +00:00			`- [x] private stats`
feat: output of console info about algorithm and node selection fix: HR symbol private stats (subject to change) feat: output to XvB tab console information for algorithm decision feat: output to XvB tab console information for node selection feat: maj TODO 2024-03-18 11:31:37 +00:00			`- [x] from XvB API (fails, average 1h and 24h)`
feat: finish XvB Tab with private stats and better log output fix: color code status feat: reload automaticcly XvB process if p2pool is off/online feat: add all 5 private stat in a pretty way outside of console feat: begin to use readable to replace human.rs feat: function to verify if share is in current window feat: maj TODO feat: Maj TODO 2024-03-15 20:40:27 +00:00			`- [x] round type in`
			`- [x] win or loose`
feat: beta release 0.1.6 2024-04-02 15:08:14 +00:00			`- [x] indicator of mining round and time left.`
feat: maj TODO 2024-03-17 00:26:48 +00:00			`- [x] new process for XvB`
feat: manage selection and fallback nodes of XvB feat: ping, select nodes of XvB process feat: reload config of xmrig to fallback to backup node fix: status of xmrig node used in real time feat: src readme technical differences with upstream 2024-03-18 10:26:03 +00:00			`- [x] update preferred XvB node based on ping and backup`
			`- [x] fix: xmrig will not do anything if node is not responding. Need to parse output of xmrig for error and update nodes.`
feat: manage XvB like a new process feat: maj TODO fix: use Vec2 instead of separating height and witdh as args in functions feat: status of XvB process feat: button to autostart XvB process into Gupax Tab feat: autostart XvB if button is checked feat: buttons to start/stop/restart XvB process in XvB Tab feat: check token and address inputs before allowing to start XvB feat: add description to buttons when hovering fix: adjust test feat: function to verify if token exist on XvB API clippy auto and manual fix 2024-03-12 11:25:34 +00:00			`- [x] status process XvB`
feat: manage selection and fallback nodes of XvB feat: ping, select nodes of XvB process feat: reload config of xmrig to fallback to backup node fix: status of xmrig node used in real time feat: src readme technical differences with upstream 2024-03-18 10:26:03 +00:00			`- [x] status process XMRig node in real time.`
feat: manage XvB like a new process feat: maj TODO fix: use Vec2 instead of separating height and witdh as args in functions feat: status of XvB process feat: button to autostart XvB process into Gupax Tab feat: autostart XvB if button is checked feat: buttons to start/stop/restart XvB process in XvB Tab feat: check token and address inputs before allowing to start XvB feat: add description to buttons when hovering fix: adjust test feat: function to verify if token exist on XvB API clippy auto and manual fix 2024-03-12 11:25:34 +00:00			`- [x] public information from [API](https://xmrvsbeast.com/p2pool/stats)`
			`- [x] stop, start, restart buttons`
			`- [x] button to autostart`
feat: maj TODO 2024-03-17 00:26:48 +00:00			`- [x] distribute hashrate conforming to the algorithm.`
feat: maj TODO algo and NOTES Algo 2024-03-16 15:42:32 +00:00			`- [x] check every 10 minutes average Xmrig HR of last 15 minutes`
feat: beta release 0.1.6 2024-04-02 15:08:14 +00:00			`- [x] fast startup (check 10s first decision then 1m second decision)`
feat: beta release 0.1.3 feat: take into account external HR for p2pool and XvB fix: retrograde to xmrig 6.20.1 to fix issue with xmrig stats showing only 1/4h later 2024-03-27 19:30:20 +00:00			`- [x] take into account outside HR`
			`- [x] mining on p2pool`
			`- [x] mining on XvB`
feat: maj TODO 2024-03-17 00:26:48 +00:00			`- [x] ask Xmrig to mine on p2pool`
feat: enable xmrig with remote control and token, generate token 2024-03-16 15:43:51 +00:00			`- [x] generate token for xmrig`
			`- [x] enable xmrig with remote access control`
feat: maj TODO algo and NOTES Algo 2024-03-16 15:42:32 +00:00			`- [x] check if at least a share in pplns Window`
feat: maj TODO 2024-03-17 00:26:48 +00:00			`- [x] calculate spared HR`
			`- [x] calculate time to be spared`
			`- [x] with hero option`
			`- [x] without hero option, to give minimum to be in most accessible round type`
			`- [x] sleep 10mn less time to spare then ask Xmrig to mine on XvB node`
feat: console for log, input token field, better logic for running XvB process 2024-03-12 22:26:08 +00:00			`- [x] output log to console in XvB tab`
fix: Ui overlapping for small screen 2024-03-21 11:27:52 +00:00			`- [x] fix some overlapping from upstream`
feat: update TODO 2024-04-08 12:27:48 +00:00			`- [x] edit metadata of project`
			`- [x] adapt README for XvB`
feat: release of beta feat: images for README feat: update README for beta feat: update skel directories feat: update CHANGELOG feat: upgrade deps feat: add DIFFERENCES markdown file feat: update TODO 2024-03-24 12:07:52 +00:00			`- [x] beta release`
feat: update TODO 2024-04-08 12:27:48 +00:00			`- [x] stable release`
feat: optmize console output to render only what is visible egui TextEdit::multiligne will render everything. Use show_rows insteead of show_viewport for AreaScroll to fix this. 2024-03-23 15:41:29 +00:00			`- [ ] video tutorial to set up XvB Tab`
feat: update doc and README 2024-04-03 16:41:29 +00:00			`- [x] adapt doc for new code`
feat: update cargo metadata 2024-03-23 16:27:14 +00:00			`- [x] cargo package metadata`
feat: add pgp signature 2024-03-23 16:30:21 +00:00			`- [x] pgp signatures`
feat: rename gupax name references to gupaxx 2024-03-23 16:45:15 +00:00			`- [x] rename reference of gupax name to gupaxx`
feat: update doc and README 2024-04-03 16:41:29 +00:00			`- [x] replace AppImage with a desktop file`
fix: all clippy warnings 2024-03-21 18:35:02 +00:00			`- [x] fix clippy`
feat: better automatization utils for releases 2024-04-03 09:41:53 +00:00			`- [x] optimizations`
fix: Benchmarks table, incorrect header visual when scrolling. Use the newer widget Table from egui_extra. Wrap it into a AreaScroll to get horizontal scrolling. 2024-03-22 07:02:36 +00:00			`- [x] benchmarks table render only what is visible`
feat: optmize console output to render only what is visible egui TextEdit::multiligne will render everything. Use show_rows insteead of show_viewport for AreaScroll to fix this. 2024-03-23 15:41:29 +00:00			`- [x] console output render only what is visible`
feat: remove arti (remove tor support for now) An old version of arti is used and takes 1/3 of dependences. Using arti as a binary to create a socks proxy and make hyper stable use it would be much better. 2024-03-23 16:04:01 +00:00			`- [x] remove arti`
feat: beta release 0.1.6 2024-04-02 15:08:14 +00:00			`- [x] replace hyper with reqwest`
			`- [x] better organize new code`
feat: maj TODO 2024-03-22 10:23:28 +00:00			`- [x] merge commits from upstream`
feat: beta release 0.1.6 2024-04-02 15:08:14 +00:00			`- [x] tests for new function`
fix: calcul of time given for XvB and add test for algorithm. 2024-03-24 11:25:43 +00:00			`- [x] time calculated by algorithm`
feat: better automatization utils for releases 2024-04-03 09:41:53 +00:00			`- [x] better automatization with utils for releases`
feat: release of beta feat: images for README feat: update README for beta feat: update skel directories feat: update CHANGELOG feat: upgrade deps feat: add DIFFERENCES markdown file feat: update TODO 2024-03-24 12:07:52 +00:00			`- [x] pre-release`
feat: update TODO 2024-04-08 12:27:48 +00:00			`- [x] feedback`
			`- [x] release`