Use networkClientId in AssetsContractController #1638
Merged
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
jiexi
changed the title
shanejonas
reviewed
Sep 8, 2023
| @@ -93,6 +94,7 @@ export class AssetsContractController extends BaseController< | |||
| chainId: initialChainId, | |||
| onPreferencesStateChange, | |||
| onNetworkStateChange, | |||
| getNetworkClientById, | |||
There was a problem hiding this comment.
I was thinking about how many controllers will need to do this, maybe we should expose this method over the controller messenger so that the order of creation of the controllers doesn't matter.
There was a problem hiding this comment.
Did you want to apply this pattern to the other controllers in core? If so, can we address this in a separate PR?
There was a problem hiding this comment.
will do as part of this PR
There was a problem hiding this comment.
AssetsContractController is V1 BaseController. So will have to follow this dependency injection pattern for now still
EDIT: exposing getNetworkClientById action from NetworkController in this PR
adonesky1
reviewed
Sep 12, 2023
adonesky1
reviewed
Sep 12, 2023
adonesky1
reviewed
Sep 12, 2023
packages/assets-controllers/src/AssetsContractController.test.ts
Outdated
Show resolved
Hide resolved
adonesky1
reviewed
Sep 12, 2023
packages/assets-controllers/src/AssetsContractControllerWithNetworkClientId.test.ts
Show resolved
Hide resolved
adonesky1
reviewed
Sep 12, 2023
packages/assets-controllers/src/AssetsContractControllerWithNetworkClientId.test.ts
Outdated
Show resolved
Hide resolved
adonesky1
previously approved these changes
Sep 12, 2023
adonesky1
approved these changes
Sep 13, 2023
adonesky1
deleted the
jl/mmp-1021/multichain-v1-assets-contract-controller
branch
Merged
MajorLift
pushed a commit
that referenced
this pull request
Oct 11, 2023
## Explanation `AssetsContractController` currently relies on the proxied provider and `onNetworkStateChange` listener to ensure it is performing checks against the correct network. As part of multichain efforts, we want to decouple this controller from the notion of a single active network. We do this by adding an optional `networkClientId` argument to each of the external facing methods. This arg is used to resolve to a `NetworkClient` from the `NetworkController` when set. <!-- Thanks for your contribution! Take a moment to answer these questions so that reviewers have the information they need to properly understand your changes: * What is the current state of things and why does it need to change? * What is the solution your changes offer and how does it work? * Are there any changes whose purpose might not obvious to those unfamiliar with the domain? * 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 * Fixes [mmp-1021](MetaMask/MetaMask-planning#1021) <!-- Are there any issues that this pull request is tied to? Are there other links that reviewers should consult to understand these changes better? For example: * Fixes #12345 * Related to #67890 --> ## Changelog <!-- If you're making any consumer-facing changes, list those changes here as if you were updating a changelog, using the template below as a guide. (CATEGORY is one of BREAKING, ADDED, CHANGED, DEPRECATED, REMOVED, or FIXED. For security-related issues, follow the Security Advisory process.) Please take care to name the exact pieces of the API you've added or changed (e.g. types, interfaces, functions, or methods). If there are any breaking changes, make sure to offer a solution for consumers to follow once they upgrade to the changes. Finally, if you're only making changes to development scripts or tests, you may replace the template below with "None". --> ### `@metamask/network-controller` - **ADDED**: `NetworkController` exposes `getNetworkClientById()` in a `NetworkController:getNetworkClientById` action ### `@metamask/assets-controllers` - **ADDED**: `AssetsContractController` constructor options requires `getNetworkClientById` - **CHANGED**: `AssetsContractController.getERC20BalanceOf()` accepts optional `networkClientId` - **CHANGED**: `AssetsContractController.getERC20TokenDecimals()` accepts optional `networkClientId` - **CHANGED**: `AssetsContractController.getERC20TokenName()` accepts optional `networkClientId` - **CHANGED**: `AssetsContractController.getERC721NftTokenId()` accepts optional `networkClientId` - **CHANGED**: `AssetsContractController.getTokenStandardAndDetails()` accepts optional `networkClientId` - **CHANGED**: `AssetsContractController.getERC721TokenURI()` accepts optional `networkClientId` - **CHANGED**: `AssetsContractController.getERC721AssetName()` accepts optional `networkClientId` - **CHANGED**: `AssetsContractController.getERC721AssetSymbol()` accepts optional `networkClientId` - **CHANGED**: `AssetsContractController.getERC721OwnerOf()` accepts optional `networkClientId` - **CHANGED**: `AssetsContractController.getERC1155TokenURI()` accepts optional `networkClientId` - **CHANGED**: `AssetsContractController.getERC1155BalanceOf()` accepts optional `networkClientId` - **CHANGED**: `AssetsContractController.transferSingleERC1155()` accepts optional `networkClientId` - **CHANGED**: `AssetsContractController.getBalancesInSingleCall()` accepts optional `networkClientId` ## Checklist - [x] I've updated the test suite for new or updated code as appropriate - [x] I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate - [x] I've highlighted breaking changes using the "BREAKING" category above as appropriate --------- Co-authored-by: Alex Donesky <adonesky@gmail.com>
MajorLift
pushed a commit
that referenced
this pull request
Oct 11, 2023
## Explanation `AssetsContractController` currently relies on the proxied provider and `onNetworkStateChange` listener to ensure it is performing checks against the correct network. As part of multichain efforts, we want to decouple this controller from the notion of a single active network. We do this by adding an optional `networkClientId` argument to each of the external facing methods. This arg is used to resolve to a `NetworkClient` from the `NetworkController` when set. <!-- Thanks for your contribution! Take a moment to answer these questions so that reviewers have the information they need to properly understand your changes: * What is the current state of things and why does it need to change? * What is the solution your changes offer and how does it work? * Are there any changes whose purpose might not obvious to those unfamiliar with the domain? * 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 * Fixes [mmp-1021](MetaMask/MetaMask-planning#1021) <!-- Are there any issues that this pull request is tied to? Are there other links that reviewers should consult to understand these changes better? For example: * Fixes #12345 * Related to #67890 --> ## Changelog <!-- If you're making any consumer-facing changes, list those changes here as if you were updating a changelog, using the template below as a guide. (CATEGORY is one of BREAKING, ADDED, CHANGED, DEPRECATED, REMOVED, or FIXED. For security-related issues, follow the Security Advisory process.) Please take care to name the exact pieces of the API you've added or changed (e.g. types, interfaces, functions, or methods). If there are any breaking changes, make sure to offer a solution for consumers to follow once they upgrade to the changes. Finally, if you're only making changes to development scripts or tests, you may replace the template below with "None". --> ### `@metamask/network-controller` - **ADDED**: `NetworkController` exposes `getNetworkClientById()` in a `NetworkController:getNetworkClientById` action ### `@metamask/assets-controllers` - **ADDED**: `AssetsContractController` constructor options requires `getNetworkClientById` - **CHANGED**: `AssetsContractController.getERC20BalanceOf()` accepts optional `networkClientId` - **CHANGED**: `AssetsContractController.getERC20TokenDecimals()` accepts optional `networkClientId` - **CHANGED**: `AssetsContractController.getERC20TokenName()` accepts optional `networkClientId` - **CHANGED**: `AssetsContractController.getERC721NftTokenId()` accepts optional `networkClientId` - **CHANGED**: `AssetsContractController.getTokenStandardAndDetails()` accepts optional `networkClientId` - **CHANGED**: `AssetsContractController.getERC721TokenURI()` accepts optional `networkClientId` - **CHANGED**: `AssetsContractController.getERC721AssetName()` accepts optional `networkClientId` - **CHANGED**: `AssetsContractController.getERC721AssetSymbol()` accepts optional `networkClientId` - **CHANGED**: `AssetsContractController.getERC721OwnerOf()` accepts optional `networkClientId` - **CHANGED**: `AssetsContractController.getERC1155TokenURI()` accepts optional `networkClientId` - **CHANGED**: `AssetsContractController.getERC1155BalanceOf()` accepts optional `networkClientId` - **CHANGED**: `AssetsContractController.transferSingleERC1155()` accepts optional `networkClientId` - **CHANGED**: `AssetsContractController.getBalancesInSingleCall()` accepts optional `networkClientId` ## Checklist - [x] I've updated the test suite for new or updated code as appropriate - [x] I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate - [x] I've highlighted breaking changes using the "BREAKING" category above as appropriate --------- Co-authored-by: Alex Donesky <adonesky@gmail.com>
tommasini
added a commit
that referenced
this pull request
Mar 20, 2024
…Preferences Controller of the controllers 77 version for being able to build, also change tsconfigbuild json to only build assets controllers
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
AssetsContractControllercurrently relies on the proxied provider andonNetworkStateChangelistener to ensure it is performing checks against the correct network. As part of multichain efforts, we want to decouple this controller from the notion of a single active network. We do this by adding an optionalnetworkClientIdargument to each of the external facing methods. This arg is used to resolve to aNetworkClientfrom theNetworkControllerwhen set.References
Changelog
@metamask/network-controllerNetworkControllerexposesgetNetworkClientById()in aNetworkController:getNetworkClientByIdaction@metamask/assets-controllersAssetsContractControllerconstructor options requiresgetNetworkClientByIdAssetsContractController.getERC20BalanceOf()accepts optionalnetworkClientIdAssetsContractController.getERC20TokenDecimals()accepts optionalnetworkClientIdAssetsContractController.getERC20TokenName()accepts optionalnetworkClientIdAssetsContractController.getERC721NftTokenId()accepts optionalnetworkClientIdAssetsContractController.getTokenStandardAndDetails()accepts optionalnetworkClientIdAssetsContractController.getERC721TokenURI()accepts optionalnetworkClientIdAssetsContractController.getERC721AssetName()accepts optionalnetworkClientIdAssetsContractController.getERC721AssetSymbol()accepts optionalnetworkClientIdAssetsContractController.getERC721OwnerOf()accepts optionalnetworkClientIdAssetsContractController.getERC1155TokenURI()accepts optionalnetworkClientIdAssetsContractController.getERC1155BalanceOf()accepts optionalnetworkClientIdAssetsContractController.transferSingleERC1155()accepts optionalnetworkClientIdAssetsContractController.getBalancesInSingleCall()accepts optionalnetworkClientIdChecklist