chore: remove usages of NetworkController:getState in EarnController #6153
Conversation
This file contains hidden or 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
|
@metamaskbot publish-preview |
ameliejyc
changed the title
|
Preview builds have been published. See these instructions for more information about preview builds. Expand for full list of packages and versions. |
ameliejyc
changed the title
ameliejyc
changed the title
ameliejyc
force-pushed
the
TAT-1264-mobile-remove-usage-s-of-global-chain-id-in-earn-experiences
branch
from
243e64f to
8886aa1
Compare
ameliejyc
commented
Jul 21, 2025
ameliejyc
force-pushed
the
TAT-1264-mobile-remove-usage-s-of-global-chain-id-in-earn-experiences
branch
from
8886aa1 to
6a9a827
Compare
|
@metamaskbot publish-preview |
|
Preview builds have been published. See these instructions for more information about preview builds. Expand for full list of packages and versions. |
ameliejyc
force-pushed
the
TAT-1264-mobile-remove-usage-s-of-global-chain-id-in-earn-experiences
branch
from
7853624 to
d05158e
Compare
|
@metamaskbot publish-preview |
|
Preview builds have been published. See these instructions for more information about preview builds. Expand for full list of packages and versions. |
7 tasks
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
salimtb
reviewed
Jul 23, 2025
…in-id-in-earn-experiences
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
nickewansmith
requested changes
Jul 23, 2025
There was a problem hiding this comment.
LGTM 👍🏽, we may need some more coverage on the constants file @ameliejyc
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
mcmire
reviewed
Jul 23, 2025
|
|
||
| readonly #env: EarnEnvironments; | ||
|
|
||
| constructor({ | ||
| messenger, | ||
| state = {}, | ||
| addTransactionFn, | ||
| selectedNetworkClientId, |
There was a problem hiding this comment.
Hmm, we may have followed this pattern in the past, but this will require that NetworkController be initialized before EarnController. We are trying to eliminate dependencies on controllers like this and make it so that it doesn't matter which order controllers are initialized, they will "just work".
I was going to suggest that we make selectedNetworkClientId optional, then add an init method where we pull the selected network via NetworkController:getState. But that's a bit similar to what we were doing before, and access to NetworkController:getState seems to be getting removed in this PR. The PR description claims that this is due to removing reliance on the global network, but selectedNetworkClientId is the global network. So I'm a bit confused on what this change in particular achieves. Are we also trying to increase performance?
There was a problem hiding this comment.
Hey @mcmire,
The main objective here is to remove the direct dependency on the globalNetwork selector, which currently relies on NetworkController.state.selectedNetworkClientId.
Instead of accessing the network directly from the NetworkController, we want to pass selectedNetworkClientId as a parameter to the EarnController constructor during initialization.
For now, since the globalNetwork selector is still in place on mobile, it will continue to be used. But in the upcoming PR, once it's removed, we’ll update the initialization to pass the enabledNetwork value instead.
So on the client side, the initialization will look like this:
new EarnController({
...,
selectedNetworkClientId: Engine.context.NetworkController.state.selectedNetworkClientId,
...
})
Passing the network value from the client has two main benefits:
- It allows us to easily swap or override the value as needed.
- It eliminates the tight coupling with NetworkController.selectedNetworkClientId, improving modularity and flexibility.
There was a problem hiding this comment.
Okay, thanks for the context. How will enabled networks work on mobile? Will multiple enabled networks be allowed like on extension or will only one be allowed?
Also, you mention that this eliminates the tight coupling to NetworkController.selectedNetworkClientId, however, it seems that we are still listening to networkDidChange below, so we are still coupled to the global network. Do we have plans to change that down the road as well?
There was a problem hiding this comment.
Since we're still getting the selectedNetworkClientId from the NetworkController, this doesn't seem to change how coupled this is with the NetworkController at all. I don't follow how this makes it easier to swap or override the value either - do you mean in a test? The messenger class was designed to be easily used in tests for mocking external code.
There was a problem hiding this comment.
@mcmire This is just the initial step. The next phase will involve listening to events from the new NetworkEnablementController and dropping the dependency on networkDidChange. That said, the related PR is still under review and the controller hasn’t been published yet.
On mobile, the enabled network behavior will align with the extension.
There was a problem hiding this comment.
@Gudahtt Hmm, I’m not sure I fully follow. Currently, we’re still using selectedNetworkClientId from the NetworkController and passing it in param because the global network selector hasn’t been removed on mobile yet. Once that’s done, we’ll update this value directly from the mobile UI codebase at the initialisation.
There was a problem hiding this comment.
My point was that if you are passing selectedNetworkClientId from the NetworkController to the EarnController, doing so via a constructor parameter is not less coupled than doing so through the messenger, it's equally coupled. The goals you stated above are not achieved by this PR.
But that was before I heard about your intention to pass in a network client ID from UI state. I can see how this might be a step towards the goals you referenced even if it doesn't achieve them alone. This makes a bit more sense with that context, at least if there is some obstacle to implementing the network enablement controller on mobile (otherwise why not go straight to using that?).
… to refreshPooledStakingVaultDailyApys
|
@metamaskbot publish-preview |
|
Preview builds have been published. See these instructions for more information about preview builds. Expand for full list of packages and versions. |
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
mcmire
reviewed
Jul 23, 2025
There was a problem hiding this comment.
Bug: Redundant API Calls in Loop
The refreshEarnEligibility method is called redundantly inside the refreshPooledStakingData loop for each supported chain. As eligibility is a global, account-specific property (a compliance check against an address blocklist) and the method is chain-agnostic, this leads to unnecessary duplicate API calls and potential race conditions. It should be called once outside the loop.
packages/earn-controller/src/EarnController.ts#L650-L671
core/packages/earn-controller/src/EarnController.ts
Lines 650 to 671 in c209037
Was this report helpful? Give feedback by reacting with 👍 or 👎
nickewansmith
previously approved these changes
Jul 23, 2025
|
@metamaskbot publish-preview |
|
Preview builds have been published. See these instructions for more information about preview builds. Expand for full list of packages and versions. |
|
@metamaskbot publish-preview |
|
Preview builds have been published. See these instructions for more information about preview builds. Expand for full list of packages and versions. |
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
The Global Network Selector is being removed and these changes for the EarnController ensure that we are not relying on global state via
NetworkController:getState. Instead, information required such as the selected network client ID or chain ID is passed in contextually.NetworkController:getState. Instead:selectedNetworkClientIdto be passed in when constructed and it is used ininitializeSDK.chainIdparameter with fallback to Ethereum Mainnet used in Pooled Staking data calls:refreshPooledStakingVaultApyAverages,refreshPooledStakingVaultDailyApys,refreshPooledStakingVaultMetadataandrefreshPooledStakeschainIdparameter required in all Lending transaction calls:executeLendingTokenApprove,executeLendingWithdrawandexecuteLendingDepositchainIdparameter required in Lending data calls:getLendingMarketDailyApysAndAveragesandgetLendingPositionHistory. The other Lending data fetches do not require a chainId.NetworkController:networkDidChangerather thanNetworkController:stateChangeas this is a more granular and less frequent event to listen to.References
Checklist