STAKE-817 Show Staked ETH position in mobile homepage along with other tokens #4879
+679
−11
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
…troller - add SupportedStakedBalanceNetworks enum to assetsUtils.ts - add AssetsContractController->getStakedBalanceForChain to support stakewise contract balance calls - add ability to includeStakedAssets in AccountTrackerController class options which returns staked balances along with native balance on refresh/sync
nickewansmith
force-pushed
the
STAKE-817-fe-show-staked-eth-position-in-homepage-along-with-other-tokens
branch
from
359007a
to
4d90470
Compare
amitabh94
reviewed
Oct 31, 2024
| ); | ||
| }); | ||
|
|
||
| it('should update staked balance when includeStakedAssets and multi-account is enabled', async () => { |
There was a problem hiding this comment.
This feature is not currently enabled in production but allows all accounts to get balances refreshed and not just the currently selected account. I added a test here to make sure that the staked balance feature is compatible.
| const multiplier = exchangeRateDenominator; | ||
| const userShares = await contract.getShares(address); | ||
|
|
||
| // convert shares to assets only if address shares > 0 else return default balance |
There was a problem hiding this comment.
Do we need to calculate exchange rate here or can we directly get assets from convertToAssets function ?
There was a problem hiding this comment.
Hm, you're right we don't really need to get the rate here. Thx will make that change!
nickewansmith
force-pushed
the
STAKE-817-fe-show-staked-eth-position-in-homepage-along-with-other-tokens
branch
from
d6c3ee7
to
a60a14b
Compare
…epage-along-with-other-tokens
…epage-along-with-other-tokens
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.
Explanation
What is the current state of things and why does it need to change?
metamask-mobileapp using theassets-controllersto get information about account token balances. We need to be able to support getting a new type of asset on mainnet and holesky chains, Staked Ethereum, which is not a token but represents the amount of ETH staked using our products.What is the solution your changes offer and how does it work?
AssetContractControllerwith a new method,getStakedBalanceForChain, which gets staked ethereum balances per account from the Stakewise vault contract. We update the AccountTrackerController with options toincludeStakedAssetsand to add agetStakedBalanceForChainmethod.AssetContractController.getStakedBalanceForChaintogetStakedBalanceForChainoption property inmetamask-mobilecode and then setincludeStakingAssetsoption to the boolean feature flag for ETH Staking on Mobile.balanceand now, if enabled thestakedBalanceas well.Are there any changes whose purpose might not obvious to those unfamiliar with the domain?
stakedBalanceif not on a supported network, and so return undefined vs defaulting to zero hex. If there is an error and we are on a supported network, we want to default to zero hex.If your primary goal was to update one package but you found you had to update another one along the way, why did you do so?
If you had to upgrade a dependency, why did you do so?
References
Are there any issues that this pull request is tied to?
Are there other links that reviewers should consult to understand these changes better?
metamask-mobilewith patched[email protected]-> Pending WIPAre there client or consumer pull requests to adopt any breaking changes?
Changelog
@metamask/assets-controllersADDED: AssetsContractController.getStakedBalanceForChain method to get staked ethereum balance for an address
ADDED: AccountTrackerController options
includeStakedEthereumandgetStakedBalanceForChainfor turning on staked balance functionality and providing a method to do soChecklist