Only return net value
#1939
Merged
Only return net value
#1939
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
iamacook
commented
Sep 20, 2024
Comment on lines
+489
to
+491
| +stakes[0].net_claimable_consensus_rewards! + | ||
| +stakes[1].net_claimable_consensus_rewards! | ||
| ).toString(), |
There was a problem hiding this comment.
These could be summed programatically but this is done to ensure the tests break if any adjustments are made. The same for all other instances.
Pull Request Test Coverage Report for Build 10955690884Details
💛 - Coveralls |
PooyaRaki
reviewed
Sep 20, 2024
| @@ -353,7 +324,10 @@ export class NativeStakingMapper { | |||
| safeAddress: args.safeAddress, | |||
| validatorsPublicKeys: this.splitPublicKeys(publicKeys), | |||
| }); | |||
| return stakes.reduce((acc, stake) => acc + Number(stake.rewards), 0); | |||
| return stakes.reduce((acc, stake) => { | |||
| const netValue = stake.net_claimable_consensus_rewards ?? '0'; | |||
There was a problem hiding this comment.
nit: If net_claimable_consensus_rewards is always expected to be a number, could we update the schema to automatically parse it as such?"
There was a problem hiding this comment.
After discussion, we will keep this as is as schemas don't transform in the project. We will, however, consider this separately.
PooyaRaki
approved these changes
Sep 20, 2024
DenSmolonski
pushed a commit
to Zilliqa/safe-client-gateway
that referenced
this pull request
Oct 24, 2024
Returns the net `value` of validator exit request/withdrawals and removes `rewards`: - Add `net_claimable_consensus_rewards` to `Stake` schema/entity. - Add new query to `KilnApi['getStakes']`. - Remove all instances of `rewards`. - Return value based on new new `net_claimable_consensus_rewards` value. - Update tests accordingly.
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.
Summary
Resolves #1938
We currently return an assumed
valueby number of validators, e.g. 1 x validator = 32 ETH. This does not, however, take into account slashing. The value can be between 31-32 ETH.The
rewardswe return is also historically accumulative. The user can therefore only claim a partial amount of this.After discussion with Kiln, we now have access to a new net value that combines to claimable staked ETH and rewards. This is now returned as the
valueof validator exit request/withdrawals andrewardsremoved. They are combined as we don't show one or the other in the UI.Changes
net_claimable_consensus_rewardstoStakeschema/entity.KilnApi['getStakes'].rewards.net_claimable_consensus_rewardsvalue.