chore: migrate testnet network MegaETH Testnet v1 to MegaETH Testnet v2 #38426
+613
−51
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,287 @@ | ||
| import { RpcEndpointType } from '@metamask/network-controller'; | ||
| import { cloneDeep } from 'lodash'; | ||
| import { jest } from '@jest/globals'; | ||
| import { KnownCaipNamespace } from '@metamask/utils'; | ||
| import { | ||
| migrate, | ||
| version, | ||
| MEGAETH_TESTNET_V2_CONFIG, | ||
| MEGAETH_TESTNET_V1_CHAIN_ID, | ||
| type VersionedData, | ||
| } from './184'; | ||
|
|
||
| const VERSION = version; | ||
| const oldVersion = VERSION - 1; | ||
|
|
||
| describe(`migration #${VERSION}`, () => { | ||
| let mockedCaptureException: jest.Mock; | ||
| beforeEach(() => { | ||
| mockedCaptureException = jest.fn(); | ||
| global.sentry = { captureException: mockedCaptureException }; | ||
| }); | ||
|
|
||
| afterEach(() => { | ||
| global.sentry = undefined; | ||
| }); | ||
|
|
||
| it('updates the version metadata', async () => { | ||
| const oldStorage = { | ||
| meta: { version: oldVersion }, | ||
| data: { | ||
| NetworkController: { | ||
| networkConfigurationsByChainId: {}, | ||
| }, | ||
| }, | ||
| }; | ||
|
|
||
| const newStorage = await migrate(oldStorage); | ||
|
|
||
| expect(newStorage.meta).toStrictEqual({ version: VERSION }); | ||
| }); | ||
|
|
||
| const invalidStates = [ | ||
| { | ||
| state: { | ||
| meta: { version: VERSION }, | ||
| data: {}, | ||
| }, | ||
| scenario: 'NetworkController not found', | ||
| }, | ||
| { | ||
| state: { | ||
| meta: { version: VERSION }, | ||
| data: { | ||
| NetworkController: 'invalid', | ||
| }, | ||
| }, | ||
| scenario: 'invalid NetworkController state', | ||
| }, | ||
| { | ||
| state: { | ||
| meta: { version: VERSION }, | ||
| data: { | ||
| NetworkController: {}, | ||
| }, | ||
| }, | ||
| scenario: 'missing networkConfigurationsByChainId property', | ||
| }, | ||
| { | ||
| state: { | ||
| meta: { version: VERSION }, | ||
| data: { | ||
| NetworkController: { | ||
| networkConfigurationsByChainId: 'invalid', | ||
| }, | ||
| }, | ||
| }, | ||
| scenario: 'invalid networkConfigurationsByChainId state', | ||
| }, | ||
| { | ||
| state: { | ||
| meta: { version: VERSION }, | ||
| data: { | ||
| NetworkController: { | ||
| networkConfigurationsByChainId: {}, | ||
| selectedNetworkClientId: 'megaeth-testnet', | ||
| }, | ||
| }, | ||
| }, | ||
| scenario: 'missing NetworkEnablementController', | ||
| }, | ||
| { | ||
| state: { | ||
| meta: { version: VERSION }, | ||
| data: { | ||
| NetworkController: { | ||
| networkConfigurationsByChainId: {}, | ||
| selectedNetworkClientId: 'megaeth-testnet', | ||
| }, | ||
| NetworkEnablementController: 'invalid', | ||
| }, | ||
| }, | ||
| scenario: 'invalid NetworkEnablementController state', | ||
| }, | ||
| { | ||
| state: { | ||
| meta: { version: VERSION }, | ||
| data: { | ||
| NetworkController: { | ||
| networkConfigurationsByChainId: {}, | ||
| selectedNetworkClientId: 'megaeth-testnet', | ||
| }, | ||
| NetworkEnablementController: { | ||
| enabledNetworkMap: 'invalid', | ||
| }, | ||
| }, | ||
| }, | ||
| scenario: 'invalid enabledNetworkMap state', | ||
| }, | ||
| { | ||
| state: { | ||
| meta: { version: VERSION }, | ||
| data: { | ||
| NetworkController: { | ||
| networkConfigurationsByChainId: {}, | ||
| selectedNetworkClientId: 'megaeth-testnet', | ||
| }, | ||
| NetworkEnablementController: { | ||
| enabledNetworkMap: {}, | ||
| }, | ||
| }, | ||
| }, | ||
| scenario: 'missing enabledNetworkMap property', | ||
| }, | ||
| { | ||
| state: { | ||
| meta: { version: VERSION }, | ||
| data: { | ||
| NetworkController: { | ||
| networkConfigurationsByChainId: {}, | ||
| selectedNetworkClientId: 'megaeth-testnet', | ||
| }, | ||
| NetworkEnablementController: { | ||
| enabledNetworkMap: { | ||
| eip155: 'invalid', | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| scenario: 'invalid enabledNetworkMap[eip155] state', | ||
| }, | ||
| ]; | ||
|
|
||
| // @ts-expect-error 'each' function is not recognized by TypeScript types | ||
| it.each(invalidStates)( | ||
| 'should capture exception if $scenario', | ||
| async ({ state }: { errorMessage: string; state: VersionedData }) => { | ||
| const orgState = cloneDeep(state); | ||
|
|
||
| const migratedState = await migrate(state); | ||
|
|
||
| // State should be unchanged | ||
| expect(migratedState).toStrictEqual(orgState); | ||
| expect(mockedCaptureException).toHaveBeenCalledWith(expect.any(Error)); | ||
| }, | ||
| ); | ||
|
|
||
| it('removes the megaeth testnet v1 network configuration and adds the megaeth testnet v2 network configuration', async () => { | ||
| const oldStorage = { | ||
| meta: { version: oldVersion }, | ||
| data: { | ||
| NetworkController: { | ||
| networkConfigurationsByChainId: { | ||
| [MEGAETH_TESTNET_V1_CHAIN_ID]: { | ||
| chainId: MEGAETH_TESTNET_V1_CHAIN_ID, | ||
| name: 'Mega Testnet', | ||
| nativeCurrency: 'MegaETH', | ||
| blockExplorerUrls: ['https://explorer.com'], | ||
| defaultRpcEndpointIndex: 0, | ||
| defaultBlockExplorerUrlIndex: 0, | ||
| rpcEndpoints: [ | ||
| { | ||
| networkClientId: 'megaeth-testnet', | ||
| type: RpcEndpointType.Custom, | ||
| url: 'https://rpc.com', | ||
| }, | ||
| ], | ||
| }, | ||
| }, | ||
| }, | ||
| NetworkEnablementController: { | ||
| enabledNetworkMap: { | ||
| [KnownCaipNamespace.Eip155]: { | ||
| [MEGAETH_TESTNET_V1_CHAIN_ID]: false, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }; | ||
|
|
||
| const expectedStorage = { | ||
| meta: { version: VERSION }, | ||
| data: { | ||
| NetworkController: { | ||
| networkConfigurationsByChainId: { | ||
| [MEGAETH_TESTNET_V2_CONFIG.chainId]: MEGAETH_TESTNET_V2_CONFIG, | ||
| }, | ||
| }, | ||
| NetworkEnablementController: { | ||
| enabledNetworkMap: { | ||
| [KnownCaipNamespace.Eip155]: { | ||
| [MEGAETH_TESTNET_V2_CONFIG.chainId]: false, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }; | ||
|
|
||
| const newStorage = await migrate(oldStorage); | ||
|
|
||
| expect(newStorage).toStrictEqual(expectedStorage); | ||
| }); | ||
|
|
||
| // @ts-expect-error 'each' function is not recognized by TypeScript types | ||
| it.each(['megaeth-testnet', 'random-network-client-id'])( | ||
| 'switchs to mainnet when the selected network client id is in MegaETH Testnet v1 - %s', | ||
| async (selectedNetworkClientId: string) => { | ||
| const oldStorage = { | ||
| meta: { version: oldVersion }, | ||
| data: { | ||
| NetworkController: { | ||
| networkConfigurationsByChainId: { | ||
| [MEGAETH_TESTNET_V1_CHAIN_ID]: { | ||
| chainId: MEGAETH_TESTNET_V1_CHAIN_ID, | ||
| name: 'Mega Testnet', | ||
| nativeCurrency: 'MegaETH', | ||
| blockExplorerUrls: ['https://explorer.com'], | ||
| defaultRpcEndpointIndex: 0, | ||
| defaultBlockExplorerUrlIndex: 0, | ||
| rpcEndpoints: [ | ||
| { | ||
| networkClientId: selectedNetworkClientId, | ||
| type: RpcEndpointType.Custom, | ||
| url: 'https://rpc.com', | ||
| }, | ||
| ], | ||
| }, | ||
| }, | ||
| selectedNetworkClientId, | ||
| }, | ||
| NetworkEnablementController: { | ||
| enabledNetworkMap: { | ||
| [KnownCaipNamespace.Eip155]: { | ||
| [MEGAETH_TESTNET_V1_CHAIN_ID]: false, | ||
| // to simulate the mainnet is not being enabled | ||
| '0x1': false, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }; | ||
|
|
||
| const expectedStorage = { | ||
| meta: { version: VERSION }, | ||
| data: { | ||
| NetworkController: { | ||
| networkConfigurationsByChainId: { | ||
| [MEGAETH_TESTNET_V2_CONFIG.chainId]: MEGAETH_TESTNET_V2_CONFIG, | ||
| }, | ||
| selectedNetworkClientId: 'mainnet', | ||
| }, | ||
| NetworkEnablementController: { | ||
| enabledNetworkMap: { | ||
| [KnownCaipNamespace.Eip155]: { | ||
| [MEGAETH_TESTNET_V2_CONFIG.chainId]: false, | ||
| '0x1': true, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }; | ||
|
|
||
| const newStorage = await migrate(oldStorage); | ||
|
|
||
| expect(newStorage).toStrictEqual(expectedStorage); | ||
| }, | ||
| ); | ||
| }); | ||
stanleyyconsensys marked this conversation as resolved.
Show resolved
Hide resolved
stanleyyconsensys marked this conversation as resolved.
Show resolved
Hide resolved
|
||
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What if someone already has this chain added? Do we need to only add this if the chain is not present? (If the chain is already present, then the migration should take care of fixing it.) Is this something to be concerned about?