mirror of
https://github.com/kremalicious/metamask-extension.git
synced 2024-11-22 09:57:02 +01:00
89cec5335f
This commit fulfills a long-standing desire to get the extension using the same network controller as mobile by removing NetworkController from this repo and replacing it with NetworkController from the `@metamask/network-controller` package. The new version of NetworkController is different the old one in a few ways: - The new controller inherits from BaseControllerV2, so the `state` property is used to access the state instead of `store.getState()`. All references of the latter have been replaced with the former. - As the new controller no longer has a `store` property, it cannot be subscribed to; the controller takes a messenger which can be subscribed to instead. There were various places within MetamaskController where the old way of subscribing has been replaced with the new way. In addition, DetectTokensController has been updated to take a messenger object so that it can listen for NetworkController state changes. - The state of the new controller is not updatable from the outside. This affected BackupController, which dumps state from NetworkController (among other controllers), but also loads the same state into NetworkController on import. A method `loadBackup` has been added to NetworkController to facilitate this use case, and BackupController is now using this method instead of attempting to call `update` on NetworkController. - The new controller does not have a `getCurrentChainId` method; instead, the chain ID can be read from the provider config in state. This affected MmiController. (MmiController was also updated to read custom networks from the new network controller instead of the preferences controller). - The default network that the new controller is set to is always Mainnet (previously it could be either localhost or Goerli in test mode, depending on environment variables). This has been addressed by feeding the NetworkController initial state using the old logic, so this should not apply.
390 lines
12 KiB
JavaScript
390 lines
12 KiB
JavaScript
const path = require('path');
|
|
|
|
const { version: reactVersion } = require('react/package.json');
|
|
|
|
module.exports = {
|
|
root: true,
|
|
// Suggested addition from the storybook 6.5 update
|
|
extends: ['plugin:storybook/recommended'],
|
|
// Ignore files which are also in .prettierignore
|
|
ignorePatterns: [
|
|
'app/vendor/**',
|
|
'builds/**/*',
|
|
'development/chromereload.js',
|
|
'development/charts/**',
|
|
'development/ts-migration-dashboard/build/**',
|
|
'dist/**/*',
|
|
'node_modules/**/*',
|
|
'storybook-build/**/*',
|
|
'jest-coverage/**/*',
|
|
'coverage/**/*',
|
|
],
|
|
overrides: [
|
|
/**
|
|
* == Modules ==
|
|
*
|
|
* The first two sections here, which cover module syntax, are mutually
|
|
* exclusive: the set of files covered between them may NOT overlap. This is
|
|
* because we do not allow a file to use two different styles for specifying
|
|
* imports and exports (however theoretically possible it may be).
|
|
*/
|
|
{
|
|
/**
|
|
* Modules (CommonJS module syntax)
|
|
*
|
|
* This is code that uses `require()` and `module.exports` to import and
|
|
* export other modules.
|
|
*/
|
|
files: [
|
|
'.eslintrc.js',
|
|
'.eslintrc.*.js',
|
|
'.mocharc.js',
|
|
'*.config.js',
|
|
'development/**/*.js',
|
|
'test/e2e/**/*.js',
|
|
'test/helpers/*.js',
|
|
'test/lib/wait-until-called.js',
|
|
'test/run-unit-tests.js',
|
|
'test/merge-coverage.js',
|
|
],
|
|
extends: [
|
|
path.resolve(__dirname, '.eslintrc.base.js'),
|
|
path.resolve(__dirname, '.eslintrc.node.js'),
|
|
path.resolve(__dirname, '.eslintrc.babel.js'),
|
|
path.resolve(__dirname, '.eslintrc.typescript-compat.js'),
|
|
],
|
|
settings: {
|
|
'import/resolver': {
|
|
// When determining the location of a `require()` call, use Node's
|
|
// resolution algorithm, then fall back to TypeScript's. This allows
|
|
// TypeScript files (which Node's algorithm doesn't recognize) to be
|
|
// imported from JavaScript files, while also preventing issues when
|
|
// using packages like `prop-types` (where we would otherwise get "No
|
|
// default export found in imported module 'prop-types'" from
|
|
// TypeScript because imports work differently there).
|
|
node: {},
|
|
typescript: {
|
|
// Always try to resolve types under `<root>/@types` directory even
|
|
// it doesn't contain any source code, like `@types/unist`
|
|
alwaysTryTypes: true,
|
|
},
|
|
},
|
|
},
|
|
},
|
|
/**
|
|
* Modules (ES module syntax)
|
|
*
|
|
* This is code that explicitly uses `import`/`export` instead of
|
|
* `require`/`module.exports`.
|
|
*/
|
|
{
|
|
files: [
|
|
'app/**/*.js',
|
|
'shared/**/*.js',
|
|
'shared/**/*.ts',
|
|
'ui/**/*.js',
|
|
'**/*.test.js',
|
|
'test/lib/**/*.js',
|
|
'test/mocks/**/*.js',
|
|
'test/jest/**/*.js',
|
|
'test/stub/**/*.js',
|
|
'test/unit-global/**/*.js',
|
|
],
|
|
// TODO: Convert these files to modern JS
|
|
excludedFiles: ['test/lib/wait-until-called.js'],
|
|
extends: [
|
|
path.resolve(__dirname, '.eslintrc.base.js'),
|
|
path.resolve(__dirname, '.eslintrc.node.js'),
|
|
path.resolve(__dirname, '.eslintrc.babel.js'),
|
|
path.resolve(__dirname, '.eslintrc.typescript-compat.js'),
|
|
],
|
|
parserOptions: {
|
|
sourceType: 'module',
|
|
},
|
|
settings: {
|
|
'import/resolver': {
|
|
// When determining the location of an `import`, use Node's resolution
|
|
// algorithm, then fall back to TypeScript's. This allows TypeScript
|
|
// files (which Node's algorithm doesn't recognize) to be imported
|
|
// from JavaScript files, while also preventing issues when using
|
|
// packages like `prop-types` (where we would otherwise get "No
|
|
// default export found in imported module 'prop-types'" from
|
|
// TypeScript because imports work differently there).
|
|
node: {},
|
|
typescript: {
|
|
// Always try to resolve types under `<root>/@types` directory even
|
|
// it doesn't contain any source code, like `@types/unist`
|
|
alwaysTryTypes: true,
|
|
},
|
|
},
|
|
},
|
|
},
|
|
/**
|
|
* TypeScript files
|
|
*/
|
|
{
|
|
files: ['*.{ts,tsx}'],
|
|
extends: [
|
|
path.resolve(__dirname, '.eslintrc.base.js'),
|
|
'@metamask/eslint-config-typescript',
|
|
path.resolve(__dirname, '.eslintrc.typescript-compat.js'),
|
|
],
|
|
rules: {
|
|
// Turn these off, as it's recommended by typescript-eslint.
|
|
// See: <https://typescript-eslint.io/docs/linting/troubleshooting#eslint-plugin-import>
|
|
'import/named': 'off',
|
|
'import/namespace': 'off',
|
|
'import/default': 'off',
|
|
'import/no-named-as-default-member': 'off',
|
|
// Disabled due to incompatibility with Record<string, unknown>.
|
|
// See: <https://github.com/Microsoft/TypeScript/issues/15300#issuecomment-702872440>
|
|
'@typescript-eslint/consistent-type-definitions': 'off',
|
|
// Modified to include the 'ignoreRestSiblings' option.
|
|
// TODO: Migrate this rule change back into `@metamask/eslint-config`
|
|
'@typescript-eslint/no-unused-vars': [
|
|
'error',
|
|
{
|
|
vars: 'all',
|
|
args: 'all',
|
|
argsIgnorePattern: '[_]+',
|
|
ignoreRestSiblings: true,
|
|
},
|
|
],
|
|
},
|
|
settings: {
|
|
'import/resolver': {
|
|
// When determining the location of an `import`, prefer TypeScript's
|
|
// resolution algorithm. Note that due to how we've configured
|
|
// TypeScript in `tsconfig.json`, we are able to import JavaScript
|
|
// files from TypeScript files.
|
|
typescript: {
|
|
// Always try to resolve types under `<root>/@types` directory even
|
|
// it doesn't contain any source code, like `@types/unist`
|
|
alwaysTryTypes: true,
|
|
},
|
|
},
|
|
},
|
|
},
|
|
{
|
|
files: ['*.d.ts'],
|
|
parserOptions: {
|
|
sourceType: 'script',
|
|
},
|
|
},
|
|
/**
|
|
* == Everything else ==
|
|
*
|
|
* The sections from here on out may overlap with each other in various
|
|
* ways depending on their function.
|
|
*/
|
|
|
|
/**
|
|
* React-specific code
|
|
*
|
|
* Code in this category contains JSX and hence needs to be run through the
|
|
* React plugin.
|
|
*/
|
|
{
|
|
files: [
|
|
'test/lib/render-helpers.js',
|
|
'test/jest/rendering.js',
|
|
'ui/**/*.js',
|
|
],
|
|
extends: ['plugin:react/recommended', 'plugin:react-hooks/recommended'],
|
|
parserOptions: {
|
|
ecmaFeatures: {
|
|
jsx: true,
|
|
},
|
|
},
|
|
plugins: ['react'],
|
|
rules: {
|
|
'react/no-unused-prop-types': 'error',
|
|
'react/no-unused-state': 'error',
|
|
'react/jsx-boolean-value': 'error',
|
|
'react/jsx-curly-brace-presence': [
|
|
'error',
|
|
{
|
|
props: 'never',
|
|
children: 'never',
|
|
},
|
|
],
|
|
'react/no-deprecated': 'error',
|
|
'react/default-props-match-prop-types': 'error',
|
|
'react/jsx-no-duplicate-props': 'error',
|
|
},
|
|
settings: {
|
|
react: {
|
|
// If this is set to 'detect', ESLint will import React in order to
|
|
// find its version. Because we run ESLint in the build system under
|
|
// LavaMoat, this means that detecting the React version requires a
|
|
// LavaMoat policy for all of React, in the build system. That's a
|
|
// no-go, so we grab it from React's package.json.
|
|
version: reactVersion,
|
|
},
|
|
},
|
|
},
|
|
/**
|
|
* Mocha tests
|
|
*
|
|
* These are files that make use of globals and syntax introduced by the
|
|
* Mocha library.
|
|
*/
|
|
{
|
|
files: [
|
|
'**/*.test.js',
|
|
'test/lib/wait-until-called.js',
|
|
'test/e2e/**/*.spec.js',
|
|
],
|
|
excludedFiles: [
|
|
'app/scripts/controllers/app-state.test.js',
|
|
'app/scripts/controllers/mmi-controller.test.js',
|
|
'app/scripts/controllers/permissions/**/*.test.js',
|
|
'app/scripts/lib/**/*.test.js',
|
|
'app/scripts/migrations/*.test.js',
|
|
'app/scripts/platforms/*.test.js',
|
|
'development/**/*.test.js',
|
|
'shared/**/*.test.js',
|
|
'ui/**/*.test.js',
|
|
'ui/__mocks__/*.js',
|
|
],
|
|
extends: ['@metamask/eslint-config-mocha'],
|
|
rules: {
|
|
// In Mocha tests, it is common to use `this` to store values or do
|
|
// things like force the test to fail.
|
|
'@babel/no-invalid-this': 'off',
|
|
'mocha/no-setup-in-describe': 'off',
|
|
},
|
|
},
|
|
/**
|
|
* Jest tests
|
|
*
|
|
* These are files that make use of globals and syntax introduced by the
|
|
* Jest library. The files in this section should match the Mocha excludedFiles section.
|
|
*/
|
|
{
|
|
files: [
|
|
'**/__snapshots__/*.snap',
|
|
'app/scripts/controllers/app-state.test.js',
|
|
'app/scripts/controllers/mmi-controller.test.js',
|
|
'app/scripts/controllers/permissions/**/*.test.js',
|
|
'app/scripts/lib/**/*.test.js',
|
|
'app/scripts/migrations/*.test.js',
|
|
'app/scripts/platforms/*.test.js',
|
|
'development/**/*.test.js',
|
|
'shared/**/*.test.js',
|
|
'shared/**/*.test.ts',
|
|
'test/helpers/*.js',
|
|
'test/jest/*.js',
|
|
'ui/**/*.test.js',
|
|
'ui/__mocks__/*.js',
|
|
'shared/lib/error-utils.test.js',
|
|
],
|
|
extends: ['@metamask/eslint-config-jest'],
|
|
parserOptions: {
|
|
sourceType: 'module',
|
|
},
|
|
rules: {
|
|
'import/unambiguous': 'off',
|
|
'import/named': 'off',
|
|
'jest/no-large-snapshots': [
|
|
'error',
|
|
{
|
|
maxSize: 50,
|
|
inlineMaxSize: 50,
|
|
},
|
|
],
|
|
'jest/no-restricted-matchers': 'off',
|
|
|
|
/**
|
|
* jest/prefer-to-be is a new rule that was disabled to reduce churn
|
|
* when upgrading eslint. It should be considered for use and enabled
|
|
* in a future PR if agreeable.
|
|
*/
|
|
'jest/prefer-to-be': 'off',
|
|
|
|
/**
|
|
* jest/lowercase-name was renamed to jest/prefer-lowercase-title this
|
|
* change was made to essentially retain the same state as the original
|
|
* eslint-config-jest until it is updated. At which point the following
|
|
* two lines can be deleted.
|
|
*/
|
|
'jest/lowercase-name': 'off',
|
|
'jest/prefer-lowercase-title': [
|
|
'error',
|
|
{
|
|
ignore: ['describe'],
|
|
},
|
|
],
|
|
},
|
|
},
|
|
/**
|
|
* Migrations
|
|
*/
|
|
{
|
|
files: ['app/scripts/migrations/*.js', '**/*.stories.js'],
|
|
rules: {
|
|
'import/no-anonymous-default-export': [
|
|
'error',
|
|
{
|
|
allowObject: true,
|
|
},
|
|
],
|
|
},
|
|
},
|
|
/**
|
|
* Executables and related files
|
|
*
|
|
* These are files that run in a Node context. They are either designed to
|
|
* run as executables (in which case they will have a shebang at the top) or
|
|
* are dependencies of executables (in which case they may use
|
|
* `process.exit` to exit).
|
|
*/
|
|
{
|
|
files: [
|
|
'development/**/*.js',
|
|
'test/e2e/benchmark.js',
|
|
'test/helpers/setup-helper.js',
|
|
'test/run-unit-tests.js',
|
|
'test/merge-coverage.js',
|
|
],
|
|
rules: {
|
|
'node/no-process-exit': 'off',
|
|
'node/shebang': 'off',
|
|
},
|
|
},
|
|
/**
|
|
* Lockdown files
|
|
*/
|
|
{
|
|
files: [
|
|
'app/scripts/lockdown-run.js',
|
|
'app/scripts/lockdown-more.js',
|
|
'test/helpers/protect-intrinsics-helpers.js',
|
|
'test/unit-global/protect-intrinsics.test.js',
|
|
],
|
|
globals: {
|
|
harden: 'readonly',
|
|
Compartment: 'readonly',
|
|
},
|
|
},
|
|
{
|
|
files: ['app/scripts/lockdown-run.js', 'app/scripts/lockdown-more.js'],
|
|
parserOptions: {
|
|
sourceType: 'script',
|
|
},
|
|
},
|
|
{
|
|
files: ['ui/pages/settings/*.js'],
|
|
rules: {
|
|
'sort-keys': [
|
|
'error',
|
|
'asc',
|
|
{
|
|
natural: true,
|
|
},
|
|
],
|
|
},
|
|
},
|
|
],
|
|
};
|