Replace NetworksChainId constant with ChainId
#1354
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
Gudahtt
force-pushed
the
replace-network-chain-ids
branch
2 times, most recently
from
d4daa70
to
7c32737
Compare
Gudahtt
force-pushed
the
replace-network-chain-ids
branch
3 times, most recently
from
c5f2464
to
23e4122
Compare
Gudahtt
commented
May 9, 2023
| controller.setProviderType(NetworkType.rpc), | ||
| ).rejects.toThrow( | ||
| 'rpcUrl must be provided for custom RPC endpoints', | ||
| 'chainId must be provided for custom RPC endpoints', |
There was a problem hiding this comment.
This changed because NetworksChainId had an empty string for the RPC network type, causing it to pass chain ID validation but fail rpcUrl validation. Now it fails chain ID validation instead because that entry wasn't brought along to the ChainId constant.
Gudahtt
force-pushed
the
replace-network-chain-ids
branch
from
23e4122
to
f1e9d69
Compare
The constant `NetworksChainId` was ambiguous in whether it referred to network or chain Ids, and it didn't match our enum naming conventions. It was also undocumented, and unclear in which networks it was intended to contain. It has been replaced with a `ChainId` constant with documentation and a clear scope (built-in networks). A `BuiltInNetworks` enum has been added as well to make that more clear. Relates to #1209
Gudahtt
force-pushed
the
replace-network-chain-ids
branch
from
f1e9d69
to
397220a
Compare
mcmire
approved these changes
May 9, 2023
mcmire
previously approved these changes
May 9, 2023
MajorLift
pushed a commit
that referenced
this pull request
Oct 11, 2023
* Replace `NetworksChainId` constant with `ChainId` The constant `NetworksChainId` was ambiguous in whether it referred to network or chain Ids, and it didn't match our enum naming conventions. It was also undocumented, and unclear in which networks it was intended to contain. It has been replaced with a `ChainId` constant with documentation and a clear scope (built-in networks). A `BuiltInNetworks` enum has been added as well to make that more clear. Relates to #1209 * Rename BuiltInNetwork to BuiltInNetworkName
MajorLift
pushed a commit
that referenced
this pull request
Oct 11, 2023
* Replace `NetworksChainId` constant with `ChainId` The constant `NetworksChainId` was ambiguous in whether it referred to network or chain Ids, and it didn't match our enum naming conventions. It was also undocumented, and unclear in which networks it was intended to contain. It has been replaced with a `ChainId` constant with documentation and a clear scope (built-in networks). A `BuiltInNetworks` enum has been added as well to make that more clear. Relates to #1209 * Rename BuiltInNetwork to BuiltInNetworkName
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.
Description
The constant
NetworksChainIdwas ambiguous in whether it referred to network or chain Ids, and it didn't match our enum naming conventions. It was also undocumented, and unclear in which networks it was intended to contain.It has been replaced with a
ChainIdconstant with documentation and a clear scope (built-in networks). ABuiltInNetworksenum has been added as well to make that more clear.Changes
@metamask/controller-utilsNetworksChainIdconstant withChainIdBuiltInNetworkandChainIdReferences
Relates to #1209
Checklist