From cc237348e26bb62aa3b29de865e963c20bfacd8e Mon Sep 17 00:00:00 2001 From: Alex Date: Fri, 17 Mar 2023 17:43:51 -0500 Subject: [PATCH] cleanup --- .../assets-controllers/src/NftController.ts | 3 +- .../src/NftDetectionController.test.ts | 38 +++++++++---------- .../src/NftDetectionController.ts | 5 +-- .../src/TokenDetectionController.test.ts | 8 +--- .../src/TokensController.test.ts | 6 +-- .../src/TokensController.ts | 3 +- packages/controller-utils/src/constants.ts | 1 - .../src/KeyringController.test.ts | 4 +- .../src/TransactionController.ts | 8 +++- packages/transaction-controller/src/utils.ts | 4 +- 10 files changed, 37 insertions(+), 43 deletions(-) diff --git a/packages/assets-controllers/src/NftController.ts b/packages/assets-controllers/src/NftController.ts index 5829db103a0..f3f4b295b98 100644 --- a/packages/assets-controllers/src/NftController.ts +++ b/packages/assets-controllers/src/NftController.ts @@ -14,7 +14,6 @@ import { toChecksumHexAddress, BNToHex, fetchWithErrorHandling, - MAINNET, IPFS_DEFAULT_GATEWAY_URL, ERC721, ERC1155, @@ -911,7 +910,7 @@ export class NftController extends BaseController { ) { super(config, state); this.defaultConfig = { - networkType: MAINNET, + networkType: NetworkType.mainnet, selectedAddress: '', chainId: '', ipfsGateway: IPFS_DEFAULT_GATEWAY_URL, diff --git a/packages/assets-controllers/src/NftDetectionController.test.ts b/packages/assets-controllers/src/NftDetectionController.test.ts index 47dfce17a19..eb5a07eee9e 100644 --- a/packages/assets-controllers/src/NftDetectionController.test.ts +++ b/packages/assets-controllers/src/NftDetectionController.test.ts @@ -1,14 +1,12 @@ import * as sinon from 'sinon'; import nock from 'nock'; import { PreferencesController } from '@metamask/preferences-controller'; -import { OPENSEA_PROXY_URL } from '@metamask/controller-utils'; +import { OPENSEA_PROXY_URL, NetworkType } from '@metamask/controller-utils'; import { NftController } from './NftController'; import { AssetsContractController } from './AssetsContractController'; import { NftDetectionController } from './NftDetectionController'; const DEFAULT_INTERVAL = 180000; -const MAINNET = 'mainnet'; -const GOERLI = 'goerli'; describe('NftDetectionController', () => { let nftDetection: NftDetectionController; @@ -236,9 +234,9 @@ describe('NftDetectionController', () => { }); it('should detect mainnet correctly', () => { - nftDetection.configure({ networkType: MAINNET }); + nftDetection.configure({ networkType: NetworkType.mainnet }); expect(nftDetection.isMainnet()).toStrictEqual(true); - nftDetection.configure({ networkType: GOERLI }); + nftDetection.configure({ networkType: NetworkType.goerli }); expect(nftDetection.isMainnet()).toStrictEqual(false); }); @@ -258,7 +256,7 @@ describe('NftDetectionController', () => { addNft: nftController.addNft.bind(nftController), getNftState: () => nftController.state, }, - { interval: 10, networkType: GOERLI }, + { interval: 10, networkType: NetworkType.goerli }, ); expect(mockNfts.called).toBe(false); resolve(''); @@ -269,12 +267,12 @@ describe('NftDetectionController', () => { const selectedAddress = '0x1'; nftDetection.configure({ - networkType: MAINNET, + networkType: NetworkType.mainnet, selectedAddress, }); nftController.configure({ - networkType: MAINNET, + networkType: NetworkType.mainnet, selectedAddress, }); const { chainId } = nftDetection.config; @@ -299,7 +297,7 @@ describe('NftDetectionController', () => { it('should detect, add NFTs and do nor remove not detected NFTs correctly', async () => { const selectedAddress = '0x1'; nftDetection.configure({ - networkType: MAINNET, + networkType: NetworkType.mainnet, selectedAddress, }); nftController.configure({ selectedAddress }); @@ -348,7 +346,7 @@ describe('NftDetectionController', () => { it('should not autodetect NFTs that exist in the ignoreList', async () => { const selectedAddress = '0x2'; nftDetection.configure({ - networkType: MAINNET, + networkType: NetworkType.mainnet, selectedAddress: '0x2', }); nftController.configure({ selectedAddress }); @@ -375,7 +373,7 @@ describe('NftDetectionController', () => { it('should not detect and add NFTs if there is no selectedAddress', async () => { const selectedAddress = ''; nftDetection.configure({ - networkType: MAINNET, + networkType: NetworkType.mainnet, selectedAddress, }); const { chainId } = nftDetection.config; @@ -386,7 +384,7 @@ describe('NftDetectionController', () => { it('should not detect and add NFTs to the wrong selectedAddress', async () => { nftDetection.configure({ - networkType: MAINNET, + networkType: NetworkType.mainnet, selectedAddress: '0x9', }); const { chainId } = nftDetection.config; @@ -409,7 +407,7 @@ describe('NftDetectionController', () => { preferences.setUseNftDetection(false); const selectedAddress = '0x9'; nftDetection.configure({ - networkType: MAINNET, + networkType: NetworkType.mainnet, selectedAddress, }); const { chainId } = nftController.config; @@ -423,7 +421,7 @@ describe('NftDetectionController', () => { preferences.setOpenSeaEnabled(false); const selectedAddress = '0x9'; nftDetection.configure({ - networkType: MAINNET, + networkType: NetworkType.mainnet, selectedAddress, }); const { chainId } = nftController.config; @@ -492,12 +490,12 @@ describe('NftDetectionController', () => { const selectedAddress = '0x1'; nftDetection.configure({ selectedAddress, - networkType: MAINNET, + networkType: NetworkType.mainnet, }); nftController.configure({ selectedAddress, - networkType: MAINNET, + networkType: NetworkType.mainnet, }); const { chainId } = nftDetection.config; @@ -660,12 +658,12 @@ describe('NftDetectionController', () => { }); nftDetection.configure({ - networkType: MAINNET, + networkType: NetworkType.mainnet, selectedAddress, }); nftController.configure({ - networkType: MAINNET, + networkType: NetworkType.mainnet, selectedAddress, }); @@ -698,12 +696,12 @@ describe('NftDetectionController', () => { .replyWithError(new Error('UNEXPECTED ERROR')); nftDetection.configure({ - networkType: MAINNET, + networkType: NetworkType.mainnet, selectedAddress, }); nftController.configure({ - networkType: MAINNET, + networkType: NetworkType.mainnet, selectedAddress, }); diff --git a/packages/assets-controllers/src/NftDetectionController.ts b/packages/assets-controllers/src/NftDetectionController.ts index 38937cd3886..a113e1c6dd5 100644 --- a/packages/assets-controllers/src/NftDetectionController.ts +++ b/packages/assets-controllers/src/NftDetectionController.ts @@ -6,7 +6,6 @@ import { import type { NetworkState } from '@metamask/network-controller'; import type { PreferencesState } from '@metamask/preferences-controller'; import { - MAINNET, OPENSEA_PROXY_URL, OPENSEA_API_URL, NetworkType, @@ -240,7 +239,7 @@ export class NftDetectionController extends BaseController< super(config, state); this.defaultConfig = { interval: DEFAULT_INTERVAL, - networkType: MAINNET, + networkType: NetworkType.mainnet, chainId: '1', selectedAddress: '', disabled: true, @@ -320,7 +319,7 @@ export class NftDetectionController extends BaseController< * * @returns Whether current network is mainnet. */ - isMainnet = (): boolean => this.config.networkType === MAINNET; + isMainnet = (): boolean => this.config.networkType === NetworkType.mainnet; /** * Triggers asset ERC721 token auto detection on mainnet. Any newly detected NFTs are diff --git a/packages/assets-controllers/src/TokenDetectionController.test.ts b/packages/assets-controllers/src/TokenDetectionController.test.ts index 88684d80d07..ee6bb493ab9 100644 --- a/packages/assets-controllers/src/TokenDetectionController.test.ts +++ b/packages/assets-controllers/src/TokenDetectionController.test.ts @@ -8,11 +8,7 @@ import { NetworkState, ProviderConfig, } from '@metamask/network-controller'; -import { - NetworksChainId, - MAINNET, - NetworkType, -} from '@metamask/controller-utils'; +import { NetworksChainId, NetworkType } from '@metamask/controller-utils'; import { PreferencesController } from '@metamask/preferences-controller'; import { ControllerMessenger } from '@metamask/base-controller'; import { TokensController } from './TokensController'; @@ -142,7 +138,7 @@ describe('TokenDetectionController', () => { }; const mainnet = { chainId: NetworksChainId.mainnet, - type: MAINNET as NetworkType, + type: NetworkType.mainnet, }; beforeEach(async () => { diff --git a/packages/assets-controllers/src/TokensController.test.ts b/packages/assets-controllers/src/TokensController.test.ts index 833d1676006..19facec1a98 100644 --- a/packages/assets-controllers/src/TokensController.test.ts +++ b/packages/assets-controllers/src/TokensController.test.ts @@ -2,7 +2,7 @@ import * as sinon from 'sinon'; import nock from 'nock'; import contractMaps from '@metamask/contract-metadata'; import { PreferencesController } from '@metamask/preferences-controller'; -import { NetworksChainId } from '@metamask/controller-utils'; +import { NetworksChainId, NetworkType } from '@metamask/controller-utils'; import { NetworkState, ProviderConfig, @@ -27,8 +27,8 @@ const stubCreateEthers = (ctrl: TokensController, res: boolean) => { }); }; -const SEPOLIA = { chainId: '11155111', type: 'sepolia' as const }; -const GOERLI = { chainId: '5', type: 'goerli' as const }; +const SEPOLIA = { chainId: '11155111', type: NetworkType.sepolia }; +const GOERLI = { chainId: '5', type: NetworkType.goerli }; describe('TokensController', () => { let tokensController: TokensController; diff --git a/packages/assets-controllers/src/TokensController.ts b/packages/assets-controllers/src/TokensController.ts index 62d5b28f5a3..47d25831c09 100644 --- a/packages/assets-controllers/src/TokensController.ts +++ b/packages/assets-controllers/src/TokensController.ts @@ -16,7 +16,6 @@ import type { NetworkState } from '@metamask/network-controller'; import { NetworkType, toChecksumHexAddress, - MAINNET, ERC721_INTERFACE_ID, } from '@metamask/controller-utils'; import type { Token } from './TokenRatesController'; @@ -206,7 +205,7 @@ export class TokensController extends BaseController< super(config, state); this.defaultConfig = { - networkType: MAINNET, + networkType: NetworkType.mainnet, selectedAddress: '', chainId: '', provider: undefined, diff --git a/packages/controller-utils/src/constants.ts b/packages/controller-utils/src/constants.ts index 90df5981f35..310af9e9d4d 100644 --- a/packages/controller-utils/src/constants.ts +++ b/packages/controller-utils/src/constants.ts @@ -1,6 +1,5 @@ import { NetworkType } from './types'; -export const MAINNET = 'mainnet'; export const RPC = 'rpc'; export const FALL_BACK_VS_CURRENCY = 'ETH'; export const IPFS_DEFAULT_GATEWAY_URL = 'https://cloudflare-ipfs.com/ipfs/'; diff --git a/packages/keyring-controller/src/KeyringController.test.ts b/packages/keyring-controller/src/KeyringController.test.ts index 2a2acc45c5f..0b4cc171eea 100644 --- a/packages/keyring-controller/src/KeyringController.test.ts +++ b/packages/keyring-controller/src/KeyringController.test.ts @@ -11,7 +11,7 @@ import { MetaMaskKeyring as QRKeyring } from '@keystonehq/metamask-airgapped-key import { CryptoHDKey, ETHSignature } from '@keystonehq/bc-ur-registry-eth'; import * as uuid from 'uuid'; import { PreferencesController } from '@metamask/preferences-controller'; -import { MAINNET } from '@metamask/controller-utils'; +import { NetworkType } from '@metamask/controller-utils'; import { keyringBuilderFactory } from '@metamask/eth-keyring-controller'; import MockEncryptor from '../tests/mocks/mockEncryptor'; import { @@ -991,7 +991,7 @@ describe('KeyringController', () => { }, { common: Common.forCustomChain( - MAINNET, + NetworkType.mainnet, { name: 'goerli', chainId: parseInt('5'), diff --git a/packages/transaction-controller/src/TransactionController.ts b/packages/transaction-controller/src/TransactionController.ts index 762f16208e1..8020fc76054 100644 --- a/packages/transaction-controller/src/TransactionController.ts +++ b/packages/transaction-controller/src/TransactionController.ts @@ -20,7 +20,7 @@ import { safelyExecute, isSmartContractCode, query, - MAINNET, + NetworkType, RPC, } from '@metamask/controller-utils'; import { @@ -603,7 +603,11 @@ export class TransactionController extends BaseController< networkId: parseInt(networkId, undefined), }; - return Common.forCustomChain(MAINNET, customChainParams, HARDFORK); + return Common.forCustomChain( + NetworkType.mainnet, + customChainParams, + HARDFORK, + ); } /** diff --git a/packages/transaction-controller/src/utils.ts b/packages/transaction-controller/src/utils.ts index bf79199f749..c6d6560fe7f 100644 --- a/packages/transaction-controller/src/utils.ts +++ b/packages/transaction-controller/src/utils.ts @@ -1,6 +1,6 @@ import { addHexPrefix, isHexString } from 'ethereumjs-util'; import { - MAINNET, + NetworkType, convertHexToDecimal, handleFetch, isValidHexAddress, @@ -41,7 +41,7 @@ export function getEtherscanApiUrl( urlParams: any, ): string { let etherscanSubdomain = 'api'; - if (networkType !== MAINNET) { + if (networkType !== NetworkType.mainnet) { etherscanSubdomain = `api-${networkType}`; } const apiUrl = `https://${etherscanSubdomain}.etherscan.io`;