[Web][UMA-1034] hints in modals for Beacon and WC #2338
+139
−32
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
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! |
germanD
suggested changes
Jan 24, 2025
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.
Suggested change
| "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.
Suggested change
| "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.
Comment on lines
27
to
30
| "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.
Suggested change
| "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.
Suggested change
| "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
Comment on lines
44
to
47
| "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.
Suggested change
| "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.
Suggested change
| "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.", |
Comment on lines
60
to
63
| 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.", | ||
| }, |
Comment on lines
55
to
57
| 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.
Suggested change
| 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: 
|
dianasavvatina
force-pushed
the
hints
branch
from
34c48a0 to
840c6b1
Compare
dianasavvatina
changed the title
dianasavvatina
force-pushed
the
hints
branch
from
840c6b1 to
55615b6
Compare
9 tasks
germanD
approved these changes
Feb 14, 2025
There was a problem hiding this comment.
@dianasavvatina LGTM modulo remarks. Depending on the space, some hints and modals can be expanded. But this is imho enough for the current iteration
packages/core/src/Constants/Hints.ts
Outdated
| const basicOperationDescription = undefined; | ||
|
|
||
| const finalizationConsequences = | ||
| "Finalized funds are returned to your balance, allowing you to spend them or stake them again to earn rewards. Delegation rewards for these funds stop once they are finalized."; |
There was a problem hiding this comment.
Delegation rewards for these funds stop once they are finalized.
This is incorrect. Both spendable and unstaked balances are delegated. So moving from one to the other doesn't affect delegations.
Suggested change
| "Finalized funds are returned to your balance, allowing you to spend them or stake them again to earn rewards. Delegation rewards for these funds stop once they are finalized."; | |
| "Finalizing unstaked funds makes them available on your spendable balance. They can now be spent or staken again to earn more rewards."; |
packages/core/src/Constants/Hints.ts
Outdated
|
|
||
| const finalizationConsequences = | ||
| "Finalized funds are returned to your balance, allowing you to spend them or stake them again to earn rewards. Delegation rewards for these funds stop once they are finalized."; | ||
| const unstakingConsequences = `The unstaking process takes 4 cycles (~10 days) to unlock your staked funds, making them finalizable on request. You will receive delegation rewards for finalizable funds. ${finalizationConsequences}`; |
There was a problem hiding this comment.
Suggested change
| const unstakingConsequences = `The unstaking process takes 4 cycles (~10 days) to unlock your staked funds, making them finalizable on request. You will receive delegation rewards for finalizable funds. ${finalizationConsequences}`; | |
| const unstakingConsequences = `Unstaked tez immediately stop accruing staking rewards, but sill give rights to delegation rewards. Unstaked tez remain locked for up to 4 cycles (~11 days), after which they can be finalized on request. ${finalizationConsequences}`; |
If we wanted to be less contrieved : an unstake request on cycle n because finalizable at the beginning of cycle n+4. This means we need to wait at least 3 full cycles, and up to 4.
See the diagram here
https://docs.tezos.com/using/staking#staking-periods-and-delays
packages/core/src/Constants/Hints.ts
Outdated
| description: basicOperationDescription, | ||
| }, | ||
| DelegationSignPage: { | ||
| header: "It takes 2 cycles (~6 days) to start receiving delegation rewards.", |
There was a problem hiding this comment.
Suggested change
| header: "It takes 2 cycles (~6 days) to start receiving delegation rewards.", | |
| header: "It takes at least 3 full cycles (~9 days) to start receiving delegation rewards. The actual delay will depend on your chosen baker payout strategy", |
It takes at least 2 full cycles + we need to wait until the end of the cycles to get rewards:
- user delegates on cycle n.
- delegation is taken into account for cycle n+3, and delegation rewards are allocated to the baker during the cycle
- at the beginning of cycle n+4, baker can pay the rewards for the previous cycle,
Note that many bakers pay delegation rewards with further delays. This is off protocols
packages/core/src/Constants/Hints.ts
Outdated
| description: `Undelegation takes effect immediately. However, you will still receive delegation rewards for the current and the next 2 cycles, as baking rights are computed 2 cycles in advance. By undelegating, you also initiate the unstaking process if you have staked. ${unstakingConsequences}`, | ||
| }, | ||
| StakeSignPage: { | ||
| header: "You will start receiving rewards within 1 cycle (~3 days).", |
There was a problem hiding this comment.
Suggested change
| header: "You will start receiving rewards within 1 cycle (~3 days).", | |
| header: "You will start receiving rewards immediately (within the current cycle)", |
You can earn rewards from the same next block.
packages/core/src/Constants/Hints.ts
Outdated
| }, | ||
| StakeSignPage: { | ||
| header: "You will start receiving rewards within 1 cycle (~3 days).", | ||
| description: `Your spendable balance will be reduced by the amount staked. You will start accruing staking rewards within 1 cycle (~3 days). Staking rewards are compounded on your staked balance. You can cancel staking any time. ${unstakingConsequences}`, |
There was a problem hiding this comment.
Suggested change
| description: `Your spendable balance will be reduced by the amount staked. You will start accruing staking rewards within 1 cycle (~3 days). Staking rewards are compounded on your staked balance. You can cancel staking any time. ${unstakingConsequences}`, | |
| description: `Your spendable balance will be reduced by the amount staked. You will start accruing staking rewards immediately (within the current cycle). Staking rewards are compounded on your staked balance. You can cancel staking any time. ${unstakingConsequences}`, |
packages/core/src/Constants/Hints.ts
Outdated
| description: `Your spendable balance will be reduced by the amount staked. You will start accruing staking rewards within 1 cycle (~3 days). Staking rewards are compounded on your staked balance. You can cancel staking any time. ${unstakingConsequences}`, | ||
| }, | ||
| UnstakeSignPage: { | ||
| header: "Takes at least 4 cycles (~10 days) to complete.", |
There was a problem hiding this comment.
Suggested change
| header: "Takes at least 4 cycles (~10 days) to complete.", | |
| header: "Unstake request take effect immediately, but funds remain frozen for up to 4 cycles (~10 days)", |
dianasavvatina
force-pushed
the
hints
branch
from
55615b6 to
1257fc6
Compare
dianasavvatina
force-pushed
the
hints
branch
from
1257fc6 to
d0eb610
Compare
dianasavvatina
force-pushed
the
hints
branch
from
d0eb610 to
c81ca4b
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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