Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

task(tui): improve tui UX feedback #577

Merged
merged 13 commits into from
Oct 25, 2022

Conversation

ffakenz
Copy link
Contributor

@ffakenz ffakenz commented Oct 21, 2022

Fixes #531

Summary

🍭 Refactor the feedback panel to be able to switch between two modes:

  • Full [H]istory
  • [S]hort Feedback

🍭 Full [H]istory Mode:

  • provides the user with a fullscreen view that renders a full history of feedback logs.
  • this mode hides the user from the normal dialog panel but it does not prevent the user from continuing to interact with the state through commands.
  • this panel is composed of a set of widgets, each containing a chunk of a feedback message.
  • because of the above, this view has the possibility to scroll Up (<) and Down (>).

image

🍭 [S]hort Feedback Mode:

  • provides the user with a single-line view of the last feedback.
  • this mode does not hide the user from the normal dialog panel, thus the user can continue to observe the state interactions.
  • this view is a single text widget that overflows the screen.
  • because of the above, this view has the possibility to scroll Left (<) and Right (>).

image

Extras

🍭 Add demo persistent state files to .gitignore

🍭 Fix with-out-docker demo docs on launching hydra-tui and multiple persistence hydra-nodes

To check before merging:

  • CHANGELOG is up to date
  • Updated documentation

@github-actions
Copy link

github-actions bot commented Oct 21, 2022

Transactions Costs

Sizes and execution budgets for Hydra protocol transactions. Note that unlisted parameters are currently using arbitrary values and results are not fully deterministic and comparable to previous runs.

Metadata
Generated at 2022-10-25 07:45:08.609063319 UTC
Max. memory units 14000000
Max. CPU units 10000000000
Max. tx size (kB) 16384

Cost of Init Transaction

Parties Tx size % max Mem % max CPU Min fee ₳
1 4832 11.40 4.53 0.49
2 5037 13.58 5.38 0.52
3 5247 13.79 5.41 0.53
5 5652 20.04 7.88 0.62
10 6678 27.35 10.63 0.74
45 13853 98.50 38.09 1.83

Cost of Commit Transaction

Currently only one UTxO per commit allowed (this is about to change soon)

UTxO Tx size % max Mem % max CPU Min fee ₳
1 5771 19.92 8.05 0.62

Cost of CollectCom Transaction

Parties Tx size % max Mem % max CPU Min fee ₳
1 13058 20.68 8.29 0.95
2 13450 37.34 15.12 1.15
3 13702 54.84 22.38 1.36
4 14095 77.90 31.95 1.63
5 14238 98.81 40.68 1.87

Cost of Close Transaction

Parties Tx size % max Mem % max CPU Min fee ₳
1 9327 8.19 3.36 0.65
2 9498 8.97 3.81 0.67
3 9657 9.75 4.27 0.68
5 10020 11.70 5.32 0.72
10 10847 15.65 7.60 0.81
30 14219 32.63 17.16 1.16
64 15613 38.69 14.66 1.26

Cost of Contest Transaction

Parties Tx size % max Mem % max CPU Min fee ₳
1 9362 8.56 3.49 0.66
2 9493 8.94 3.79 0.67
3 9693 10.16 4.42 0.69
5 9988 11.28 5.15 0.72
10 10851 15.81 7.65 0.81
30 14227 32.79 17.21 1.17
43 16373 42.83 23.05 1.38

Cost of Abort Transaction

Some variation because of random mixture of still initial and already committed outputs.

Parties Tx size % max Mem % max CPU Min fee ₳
1 13494 22.50 9.35 0.99
2 13743 36.46 15.22 1.16
3 13927 52.72 22.50 1.35
4 14037 69.26 29.66 1.54

Cost of FanOut Transaction

Involves spending head output and burning head tokens. Uses ada-only UTxO for better comparability.

UTxO Tx size % max Mem % max CPU Min fee ₳
1 13421 9.88 4.31 0.85
2 13456 11.70 5.31 0.88
3 13559 13.30 6.22 0.90
5 13629 16.64 8.10 0.94
10 13743 23.57 12.23 1.03
50 15313 85.26 47.74 1.86
60 15538 99.74 56.26 2.05

@github-actions
Copy link

github-actions bot commented Oct 21, 2022

Test Results

264 tests  ±0   258 ✔️ ±0   16m 55s ⏱️ + 2m 7s
  93 suites ±0       6 💤 ±0 
    5 files   ±0       0 ±0 

Results for commit 04fc7dd. ± Comparison against base commit 6239924.

♻️ This comment has been updated with latest results.

@ffakenz ffakenz marked this pull request as ready for review October 21, 2022 16:16
@ffakenz ffakenz force-pushed the task/tui_improve_feedback_on_l1_post_tx_fail branch 3 times, most recently from 22b9a2e to bce5255 Compare October 24, 2022 10:55
@ffakenz ffakenz changed the title task(tui): improve feedback on l1 post tx fail task(tui): improve tui UX feedback Oct 25, 2022
@ffakenz ffakenz force-pushed the task/tui_improve_feedback_on_l1_post_tx_fail branch from bce5255 to 04fc7dd Compare October 25, 2022 07:29
@ffakenz ffakenz merged commit 9e04989 into master Oct 25, 2022
@ffakenz ffakenz deleted the task/tui_improve_feedback_on_l1_post_tx_fail branch October 25, 2022 08:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Better error reporting in the TUI when transaction posting fails on chain
2 participants