feat: hints in modals for Beacon and WC #2338
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
@dianasavvatina made a first pass with several nits/suggestions. Will make another after these are addressed. Also, opened #2339 which would complement this (great) effort to improve UX! |
There was a problem hiding this comment.
Made some suggestions.
@dianasavvatina I asked the L1 team to answer some of the doubts regarding unstaked tez. That should help clarify the information for tooltips, and will take that into account for a second round!
This is much welcome UX progress 🚀
| export const Hints: Record<SignPage, HintData> = { | ||
| TezSignPage: { | ||
| header: | ||
| "A confirmation takes 1 block (10 seconds). The transaction becomes final and irreversible after 2 blocks (20 seconds).", |
There was a problem hiding this comment.
| "A confirmation takes 1 block (10 seconds). The transaction becomes final and irreversible after 2 blocks (20 seconds).", | |
| "A confirmation takes 1 block (8 seconds). The transaction becomes final and irreversible after 2 blocks (16 seconds).", |
| header: | ||
| "A confirmation takes 1 block (10 seconds). The transaction becomes final and irreversible after 2 blocks (20 seconds).", | ||
| description: | ||
| "A confirmation means that the block is confirmed by the network but the operation can still be canceled in the unlikely case of a crypto attack. Finality means that the operation is irreversible.", |
There was a problem hiding this comment.
| "A confirmation means that the block is confirmed by the network but the operation can still be canceled in the unlikely case of a crypto attack. Finality means that the operation is irreversible.", | |
| "A confirmation means that the block is confirmed by the network but the operation can still be cancelled due to chain reorganizations. Finality means that the operation is irreversible.", |
Attack is incorrect here. With Tenderbake, you can have a alternative heads scenario, where a block payload proposal generated on (levl n, round k+1) is not confirmed and the chosen chain is a block on (level n+1, usually round 0) which is a succesor of (level n, round k (or earlier)).
This might just happen out of slow consensus/ degraded health / network congestion scenarios -- which they don't necessarily entail an attack.
| "A confirmation takes 1 block (10 seconds). The transaction becomes final and irreversible after 2 blocks (20 seconds).", | ||
| description: | ||
| "A confirmation means that the block is confirmed by the network but the operation can still be canceled in the unlikely case of a crypto attack. Finality means that the operation is irreversible.", | ||
| }, |
| DelegationSignPage: { | ||
| header: "It takes 4 cycles (~6 days) to start receiving delegation rewards.", | ||
| description: | ||
| "Delegation rewards are distributed every 2 cycles (~3 days). Ensure that the delegation fee offered by the baker is less than 100%; otherwise, you will not receive rewards. Delegation means that all your funds are delegated to one baker. The funds are still spendable, and you can cancel or change the delegation at any time.", |
There was a problem hiding this comment.
| "Delegation rewards are distributed every 2 cycles (~3 days). Ensure that the delegation fee offered by the baker is less than 100%; otherwise, you will not receive rewards. Delegation means that all your funds are delegated to one baker. The funds are still spendable, and you can cancel or change the delegation at any time.", | |
| "Bakers usually distribute delegation rewards every cycle (~2.8 days). Ensure that the delegation fee offered by the baker is less than 100%; otherwise, you might not receive rewards. Delegation means that all your funds are delegated to one baker. The funds are still spendable, and you can cancel or change the delegation at any time.", |
Delegation rewards are allocated to the baker during the cycle, they usually pay them a number of cycles in delay. This is not mandated by the protocol. Bakers might pool rewards and pay them each k cycles, for instance
| }, | ||
| UndelegationSignPage: { | ||
| header: | ||
| "Immediately stops delegation and initiates unstaking. Restoring delegation rewards takes 4 cycles (~6 days). Unstaking takes 4 cycles (~10 days).", |
There was a problem hiding this comment.
| "Immediately stops delegation and initiates unstaking. Restoring delegation rewards takes 4 cycles (~6 days). Unstaking takes 4 cycles (~10 days).", | |
| "Immediately stops delegation and initiates unstaking. Restoring delegation rewards takes 4 cycles (~10 days). After 4 cycles (~10 days), unstaked tez can be finalized and made avaialable", |
I need to confirm the math for the unstakes and delegation.
Also notice that in the case of a change of baker, any current liquid balance will be delegated to the new baker, but unstaked tez will keep being delegated to the old one. This is a bit of a corner case where funds end. delegated to two bakers on an overlap of a few cycles . Which is a headache. And not something you want to add to hint :)
There was a problem hiding this comment.
we can create a web page (maybe it already exists) and link it from the hint. Then we can explain all in details including corner cases
| "A confirmation takes 1 block (10 seconds). The transaction becomes final and irreversible after 2 blocks (20 seconds).", | ||
| description: | ||
| "A confirmation means that the block is confirmed by the network but the operation can still be canceled in the unlikely case of a crypto attack. Finality means that the operation is irreversible.", | ||
| }, |
| }, | ||
| StakeSignPage: { | ||
| header: | ||
| "Your balance will be reduced by the staked amount. You will start receiving rewards within 1 cycle (~3 days) max.", |
There was a problem hiding this comment.
| "Your balance will be reduced by the staked amount. You will start receiving rewards within 1 cycle (~3 days) max.", | |
| "Your available balance will be reduced by the amount staked. You will start accruing staking rewards within 1 cycle (~3 days) max. Note that staking rewards are compounded on your staked balance", |
| header: | ||
| "Your balance will be reduced by the staked amount. You will start receiving rewards within 1 cycle (~3 days) max.", | ||
| description: | ||
| "By staking, your balance will be automatically reduced by the staked amount. Rewards are calculated and sent to your balance automatically every time your delegated baker produces a new block and at the end of each cycle (~3 days). If you decide to cancel staking, it will take approximately 4 cycles (~10 days) to unlock your funds and return them to your balance.", |
There was a problem hiding this comment.
| "By staking, your balance will be automatically reduced by the staked amount. Rewards are calculated and sent to your balance automatically every time your delegated baker produces a new block and at the end of each cycle (~3 days). If you decide to cancel staking, it will take approximately 4 cycles (~10 days) to unlock your funds and return them to your balance.", | |
| "By staking, the chosen amount will automatically deducted from your available balance. Rewards are allocated to your staked balance automatically every time your chosen baker produces a new block and at the end of each cycle (~3 days). If you decide to cancel staking, it will take approximately 4 cycles (~10 days) to unlock your funds before you can make them available.", |
| header: "Finalizing unstake takes 1 block (10 seconds).", | ||
| description: | ||
| "Finalizing unstake is a process that takes 1 block (10 seconds) to complete. After finalizing unstake, your funds will be returned to your balance. You can then stake them again or spend them.", | ||
| }, |
| header: "Unstaking takes 4 cycles (~10 days) to complete.", | ||
| description: | ||
| "Unstaking is a process that takes approximately 4 cycles (~10 days) to complete. During this time, your funds are locked, and you will not receive rewards. After the unstaking process is complete, you need to finalize unstaking, after which your funds will be returned to your balance.", |
There was a problem hiding this comment.
| header: "Unstaking takes 4 cycles (~10 days) to complete.", | |
| description: | |
| "Unstaking is a process that takes approximately 4 cycles (~10 days) to complete. During this time, your funds are locked, and you will not receive rewards. After the unstaking process is complete, you need to finalize unstaking, after which your funds will be returned to your balance.", | |
| header: "Unstaking takes 4 cycles (~10 days) to complete.", | |
| description: | |
| "Unstaking is a process that takes at least 4 cycles (~10 days) to complete. During this time, your funds are locked, and you will not receive staking rewards. After 4 cycles, you need to finalize unstaked tez in order to make these funds available.", |
There was a problem hiding this comment.
This file should be part of packages, as the contents (hints) will be common among web/desktop and other platforms.
|
Updated based on this example: 
|
Proposed changes
Umami modals for both Beacon and WalletConnect should be more helpful.
A user can easily make a mistake or hesitate confirming a transaction without understanding of the consequences of the operation.
Task: UMA-1034
Types of changes
Steps to reproduce
Other operations are covered in #2340
Screenshots
Add the screenshots of how the app used to look like and how it looks now
Checklist