dApp staking v3 #1023
dApp staking v3 #1023
Conversation
… into feat/dapp-staking-v3
…apps into feat/dapp-staking-v3
|
Visit the preview URL for this PR (updated for commit 2e6263e): https://astar-apps--pr1023-feat-dapp-staking-v3-hb03lgyi.web.app (expires Mon, 15 Jan 2024 10:55:47 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: dd76fe72958fe2910fef9d53f0b4539b82b849db |
* Prevents UnavailableStakeFunds * rephrase * Prevent tooManyStakedContracts, unclaimedRewardsFromPastPeriods * less logs * unstake Prevents UnstakeAmountTooLarge ZeroAmount Disabled * UnclaimedRewardsFromPastPeriods
* Voting page created * Voting page - part 1 * Vote logic --------- Co-authored-by: impelcrypto <[email protected]>
* vote and dictionary changes * fix value and more * vote checks
| <span> {{ $t('stakingV3.edit') }} </span> | ||
| </div> | ||
| <div class="box--links"> | ||
| <!-- Todo: add links --> |
There was a problem hiding this comment.
Should we add the logic for owner page in this PR? If so, let's add the links
There was a problem hiding this comment.
Let's leave this for the future PR
| </button> | ||
|
|
||
| <div class="column--action"> | ||
| <!-- TODO: add logic --> |
There was a problem hiding this comment.
When and how do we implement the logic here?
There was a problem hiding this comment.
Let's leave this for the future PR
…apps into feat/dapp-staking-v3
…apps into feat/dapp-staking-v3
| * @param senderAddress Address of the request sender. | ||
| * @param successMessage Message to be displayed on the call success. | ||
| */ | ||
| claimUnstakeAndUnlock( |
There was a problem hiding this comment.
I haven't noticed a function that only calls unstake - is this supported?
There was a problem hiding this comment.
It is not supported, since we don't have that feature on the portal.
| * @param unstakeFromAddress Address of the contract to be unstaked from. | ||
| * @param unstakeAmount Amount of tokens to unstake. |
There was a problem hiding this comment.
Is this a typo or the function also does unstake?
There was a problem hiding this comment.
This is magic function which batches a lot of calls, depending what user selected on voting page:
- claim staker and bonus rewards, if any
- locks tokens,
- unstakes tokens in case of nomination transfer
- stakes tokens
I updated the method comment a bit
| if (ledger.staked.era <= era) { | ||
| stakedSum += ledger.staked.voting + ledger.staked.buildAndEarn; | ||
| } | ||
| if (ledger.stakedFuture && ledger.stakedFuture.era <= era) { | ||
| stakedSum += ledger.stakedFuture.voting + ledger.stakedFuture.buildAndEarn; | ||
| } |
There was a problem hiding this comment.
Should this be if & else if perhaps?
The way it is now, if I understand correctly, the staked_future might get included at the same time as the staked.
|
|
||
| // *** 3. Calculate rewards. | ||
| const multiplier = await this.getMultiplier(); | ||
| for (let spanIndex = firstSpanIndex; spanIndex <= lastSpanIndex; spanIndex++) { |
There was a problem hiding this comment.
Instead of using spanIndex+++, you should use this:
/// Maximum length of a single era reward span length entry.
#[pallet::constant]
type EraRewardSpanLength: Get<u32>;Unless I'm mistaken, the current approach will result in many empty reads?
| for (let era = span.firstEra; era <= span.lastEra; era++) { | ||
| const staked = claimableEras.get(era); | ||
| if (staked) { | ||
| const spanIndex = era - span.firstEra; |
There was a problem hiding this comment.
Nothing logically wrong, but the name spanIndex confused me a bit since it's actually just the eraIndex in the span.
| // Unstake tokens | ||
| if (unstakeAmount > BigInt(0)) { | ||
| const unstakeCall = await this.dappStakingRepository.getUnstakeCall( | ||
| unstakeFromAddress, | ||
| Number(ethers.utils.formatEther(unstakeAmount.toString())) | ||
| ); | ||
| calls.push(unstakeCall); | ||
| } |
There was a problem hiding this comment.
Tokens are unstaked if user wants to move staked tokens to some other dApp (nomination transfer)
| // and if stake amount refers to the past period. | ||
| if ( | ||
| info.loyalStaker && | ||
| protocolState && |
There was a problem hiding this comment.
Just out of interest, when can this be null?
There was a problem hiding this comment.
This can happen in very rare case of communication error.
|
|
||
| tierRewards.forEach((tierReward, index) => { | ||
| if (tierReward) { | ||
| const dApp = tierReward?.dapps.find((d) => d.dappId === dapp.id); |
There was a problem hiding this comment.
Not sure if there's a ready function out-of-the-box for JavaScript's Array, but dapps as sorted according to the id, so you could use binary_search to speed this action up.
There was a problem hiding this comment.
Unfortunately, no binary search in JS. I might implement it later. I am sure there are different implementations available on the internet.
find method used here has O(n) complexity.
| private async getMultiplier(): Promise<bigint> { | ||
| const metadata = await this.metadataRepository.getChainMetadata(); | ||
| return BigInt(10 ** metadata.decimals); | ||
| } |
There was a problem hiding this comment.
Dumb question - I noticed this being used in the code but don't understand why it's needed. Could you please explain?
There was a problem hiding this comment.
This is because I didn't find a better way to divide two BigInt numbers. Lets say you have two BigInt numbers a and b and a<b, than a / b = 0.
I modified formula a bit (a * multiplier / b) / multiplier
There was a problem hiding this comment.
Ok, I see!
So for example this:
(((info.staked.voting * multiplier) / periodEndInfo.totalVpStake) *
periodEndInfo.bonusRewardPool) /
multiplier;
is essentially: info.staked.voting * multiplier / periodEndInfo.totalVpStake * periodEndInifo.bonusRewardPool * multiplier
To make it more in line with how backend works, I'd suggest:
info.staked.voting * periodEndInfo.bonusRewardPool / periodEndInfo.totalVpStake
This isn't 100% accurate as runtime does it, but it's very close.
And this way you don't need the multiplier.
* add project icon background * add project icon background to the owner page * update all vote/stake button background * fix app height * move the register button to the assets page * fix assets page container * remove the license section from the project page * made the header scroll * add small dapp header * fix v2 style * remove the register banner from the assets page for now * fix vote page layout * fix vote period background * adjust small header style and heart icon button * update maintenance mode style * update
* add migrate support style * fix lang file
* feat: added useAprV3 * wip: staker rewards * wip: staker rewards (2) * wip: staker rewards (3) * wip: staker rewards (4) * wip: staker rewards (5) * wip: staker rewards (6) * wip: staker rewards (7) * wip: staker rewards (8) * feat: added basic rewards in the voting section * fix: clean up * fix: refactor * feat: added bonus APR * fix: clean up * fix: set the periodsPerCycle from network name temporarily * fix: set the periodsPerCycle from network name temporarily (2)
Pull Request Summary
I know this is a huge PR, please take your time to review functionality and code. Let me know if there are unclear things or weird implementations.
User documentation is on it's way, but use of the feature shuold be strait forward.
Dapp staking v3 UI implementation
Check list