1
0
mirror of https://github.com/kremalicious/metamask-extension.git synced 2024-11-22 01:47:00 +01:00
🦊 Minimalized version of MetaMask for my own personal use.
Go to file
Ariella Vu a87c1750b0
MV3: Update service worker restart logic and keep-alive logic for dapp support (#16075)
* dapp: add debug statements

* dapp: add retry logic [debug]

* dapp: keep SW alive on rpc request

* Revert "dapp: add debug statements"

This reverts commit ea21786f7f66c712eea02405cd68fe925d227ffa.

* dapp: try to set up ext streams asap on reset

* dapp: apply keep alive logic to phishingPageStream

* dapp:put keep-alive logic behind isManifestV3 flag

* Re-activate streams after a period of service worker in-activity

* dapp: rm extra function

* dapp: update phishing onDisconnect

* dapp: fix eslint missing global chrome

* add EXTENSION_MESSAGES const

* use EXTENSION_MESSAGES more generic comment

* update comment

* dapp: clean timeout and interval

* Fix DAPP action replay

* execute DAPP action replay for only MV3

* fix

* fix

* fix

* comment out DAPP action replay code

* fix

* fix

* fix

* scripts/background: use browser polyfill

* Revert "scripts/background: use browser polyfill"

This reverts commit 2ab6234d11b3b11e10dd993d454eeaad63bfc886.

* scripts/background: use browser polyfill

* script/background: check lastError

* dapp: use EXTENSION_MESSAGES

* scripts/background: send ready msg to all tabs

* dapp: update onMessage handler comment and name

* dapp: return values onMessage listener
see: https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/runtime/onMessage#addlistener_syntax

* dapp: mv onMessage listener

* dapp: add onMessage setupPhishingExtStreams

* dapp: rn reset -> destroy streams

* dapp: rn reset -> destroy for phishing streams

* dapp: clean comment

* dapp: rm unused comments
planning to be readded in follow-up PR: #16250

* dapp: onMessage return Promise|undefined

* dapp:clean: add missing undefined return type

* dapp: use new checkForErrorAndLog for Chrome API
handy stackoverflow: https://stackoverflow.com/a/28432087/4053142

* dapp:fix: return tabs.query result

* dapp:eslint: return undefined
fix Expected to return a value at the end of arrow
function.eslintconsistent-return

* background: do not query tabs w/out url

* background: rm Could not establish... catch
- no longer needed after improved tabs query

* dapp:clean: rm unused checkForError... for now...

* dapp: prevent setupExtensionStreams called twice
- calling connect will trigger disconnect and may cause issues
- only setup streams if they are not connected

* dapp: handle onDisconnect lastError
- throwing errors from contentscript will break the dapp, so only warn
- not handling lastError when it's found will also break the dapp

* background: update tabs.query url comment

* background: update tabs.query url comment 2

* dapp: fix SW restart for multi dapp support
- ref: https://stackoverflow.com/a/54686484/4053142

* dapp:clean: rm extra "." from console.warn

* clean: comments for dapp and background

* Adding catch block (#16454)

* fix: FireFox provider injection

* lib/util: fix invalid checkForErrorAndWarn export

* bg: add explanation for tabs.sendMessage catch

* dapp: add browser-runtime.utils

* runtime.utils: add checkForLastErrorAndLog

Co-authored-by: Jyoti Puri <jyotipuri@gmail.com>
Co-authored-by: legobeat <109787230+legobeat@users.noreply.github.com>
2022-11-15 00:18:08 +07:00
.circleci Upgrade geckodriver to latest version, run ci tests with Firefox v106.0.4 (#16383) 2022-11-10 11:16:02 +00:00
.github Revert "ci: temporarily downgrade ubuntu to 20.04" (#16374) 2022-11-07 03:29:01 +00:00
.storybook Remove 3box feature and delete ThreeBoxController (#14571) 2022-10-31 13:50:50 -02:30
app MV3: Update service worker restart logic and keep-alive logic for dapp support (#16075) 2022-11-15 00:18:08 +07:00
development Replaced addresses by the address component on SignTypedData v4 signatures (#16018) 2022-11-10 06:58:34 -03:30
docs refactor sentryHooks object (#16435) 2022-11-09 19:28:32 +00:00
lavamoat [FLASK] snaps-monorepo@0.23.0 (#16394) 2022-11-08 10:31:22 +01:00
patches [FLASK] snaps-monorepo@0.23.0 (#16394) 2022-11-08 10:31:22 +01:00
shared MV3: Update service worker restart logic and keep-alive logic for dapp support (#16075) 2022-11-15 00:18:08 +07:00
test [e2e]: log exceptions when tests fail (#16453) 2022-11-14 08:35:08 -06:00
types Add TypeScript migration dashboard (#13820) 2022-08-09 14:16:08 -06:00
ui [FLASK] Fix an issue with updating snaps that have caveat permissions (#16473) 2022-11-14 11:50:17 +01:00
.depcheckrc.yml upgrade jest (#15642) 2022-08-23 15:13:02 -05:00
.editorconfig Clean EditorConfig file 2019-05-23 07:17:42 -02:30
.eslintrc.babel.js Refactor ESLint config (#13482) 2022-02-28 10:42:09 -07:00
.eslintrc.base.js Remove unnecessary file extensions (#15352) 2022-07-27 14:32:17 -05:00
.eslintrc.js remove customize-gas modal and related code that is no longer used (#16004) 2022-09-28 15:00:57 -05:00
.eslintrc.jsdoc.js remove exclusions for mismatched object jsdoc type casing (#15351) 2022-07-27 08:28:05 -05:00
.eslintrc.node.js Refactor ESLint config (#13482) 2022-02-28 10:42:09 -07:00
.eslintrc.typescript-compat.js Add TypeScript to the linting process (#13495) 2022-03-21 12:54:47 -06:00
.gitattributes Suppress diffs for translation files by default (#13537) 2022-02-10 14:49:47 -07:00
.gitignore Ability to buy tokens with Moonpay (#15924) 2022-09-23 09:38:40 -07:00
.iyarc Remove 3box feature and delete ThreeBoxController (#14571) 2022-10-31 13:50:50 -02:30
.metamaskrc.dist Add entry point for metalabs dapp into metamask home page (#15407) 2022-09-13 08:41:58 -05:00
.mocharc.js Remove related UI code from the app dir (#15384) 2022-09-16 14:05:21 -05:00
.nvmrc Bump minimum Node.js version to 16 (#15131) 2022-07-02 23:32:18 -07:00
.prettierignore Add TypeScript migration dashboard (#13820) 2022-08-09 14:16:08 -06:00
.prettierrc.yml @metamask/eslint config@5.0.0 (#10358) 2021-02-04 10:15:23 -08:00
.yarnrc chore: Adjust trailing whitespace (#15636) 2022-08-24 14:11:49 -05:00
babel.config.js Update Babel and dependencies (#15392) 2022-08-05 10:04:44 -05:00
CHANGELOG.md Add Changelog entry for fix Network form by validating chainId 2022-11-11 16:41:32 +01:00
crowdin.yml Update crowdin.yml (#15910) 2022-09-23 10:26:37 -05:00
jest.config.js Lower coverage requirement (#16087) 2022-10-05 14:21:55 +02:00
jest.stories.config.js Update Jest config to avoid transpiling dependencies (#16068) 2022-10-04 17:58:22 +02:00
LICENSE update email in license (#15948) 2022-09-23 09:41:58 -05:00
nyc.config.js @metamask/eslint config@5.0.0 (#10358) 2021-02-04 10:15:23 -08:00
package.json Merge branch 'master' into master-sync 2022-11-14 10:48:11 +01:00
README.md docs: fix obsolete link of nvm in README.md (#16238) 2022-11-10 08:25:37 -06:00
stylelint.config.js Update ESLint config to v8 (#12886) 2021-12-09 15:36:24 -03:30
tsconfig.json chore: Complete node16 upgrade (#15634) 2022-08-19 22:35:52 +08:00
yarn.lock Upgrade geckodriver to latest version, run ci tests with Firefox v106.0.4 (#16383) 2022-11-10 11:16:02 +00:00

MetaMask Browser Extension

You can find the latest version of MetaMask on our official website. For help using MetaMask, visit our User Support Site.

For general questions, feature requests, or developer questions, visit our Community Forum.

MetaMask supports Firefox, Google Chrome, and Chromium-based browsers. We recommend using the latest available browser version.

For up to the minute news, follow our Twitter or Medium pages.

To learn how to develop MetaMask-compatible applications, visit our Developer Docs.

To learn how to contribute to the MetaMask project itself, visit our Internal Docs.

Building locally

  • Install Node.js version 16
    • If you are using nvm (recommended) running nvm use will automatically choose the right node version for you.
  • Install Yarn
  • Install dependencies: yarn setup (not the usual install command)
  • Copy the .metamaskrc.dist file to .metamaskrc
  • Build the project to the ./dist/ folder with yarn dist.
    • Optionally, you may run yarn start to run dev mode.

Uncompressed builds can be found in /dist, compressed builds can be found in /builds once they're built.

See the build system readme for build system usage information.

Contributing

Development builds

To start a development build (e.g. with logging and file watching) run yarn start.

React and Redux DevTools

To start the React DevTools, run yarn devtools:react with a development build installed in a browser. This will open in a separate window; no browser extension is required.

To start the Redux DevTools Extension:

  • Install the package remotedev-server globally (e.g. yarn global add remotedev-server)
  • Install the Redux Devtools extension.
  • Open the Redux DevTools extension and check the "Use custom (local) server" checkbox in the Remote DevTools Settings, using the default server configuration (host localhost, port 8000, secure connection checkbox unchecked).

Then run the command yarn devtools:redux with a development build installed in a browser. This will enable you to use the Redux DevTools extension to inspect MetaMask.

To create a development build and run both of these tools simultaneously, run yarn start:dev.

Test Dapp

This test site can be used to execute different user flows.

Running Unit Tests and Linting

Run unit tests and the linter with yarn test. To run just unit tests, run yarn test:unit.

You can run the linter by itself with yarn lint, and you can automatically fix some lint problems with yarn lint:fix. You can also run these two commands just on your local changes to save time with yarn lint:changed and yarn lint:changed:fix respectively.

Running E2E Tests

Our e2e test suite can be run on either Firefox or Chrome.

  1. required yarn build:test to create a test build.
  2. run tests, targetting the browser:
  • Firefox e2e tests can be run with yarn test:e2e:firefox.
  • Chrome e2e tests can be run with yarn test:e2e:chrome. The chromedriver package major version must match the major version of your local Chrome installation. If they don't match, update whichever is behind before running Chrome e2e tests.

Running a single e2e test

Single e2e tests can be run with yarn test:e2e:single test/e2e/tests/TEST_NAME.spec.js along with the options below.

--browser             Set the browser used; either 'chrome' or 'firefox'.

--leave-running       Leaves the browser running after a test fails, along with anything else
                      that the test used (ganache, the test dapp, etc.).

--retries             Set how many times the test should be retried upon failure. Default is 0.

An example for running account-details testcase with chrome and leaving the browser open would be: yarn test:e2e:single test/e2e/tests/account-details.spec.js --browser=chrome --leave-running

Changing dependencies

Whenever you change dependencies (adding, removing, or updating, either in package.json or yarn.lock), there are various files that must be kept up-to-date.

  • yarn.lock:
    • Run yarn setup again after your changes to ensure yarn.lock has been properly updated.
    • Run yarn yarn-deduplicate to remove duplicate dependencies from the lockfile.
  • The allow-scripts configuration in package.json
    • Run yarn allow-scripts auto to update the allow-scripts configuration automatically. This config determines whether the package's install/postinstall scripts are allowed to run. Review each new package to determine whether the install script needs to run or not, testing if necessary.
    • Unfortunately, yarn allow-scripts auto will behave inconsistently on different platforms. macOS and Windows users may see extraneous changes relating to optional dependencies.
  • The LavaMoat policy files. The tl;dr is to run yarn lavamoat:auto to update these files, but there can be devils in the details:
    • There are two sets of LavaMoat policy files:
      • The production LavaMoat policy files (lavamoat/browserify/*/policy.json), which are re-generated using yarn lavamoat:background:auto. Add --help for usage.
        • These should be regenerated whenever the production dependencies for the background change.
      • The build system LavaMoat policy file (lavamoat/build-system/policy.json), which is re-generated using yarn lavamoat:build:auto.
        • This should be regenerated whenever the dependencies used by the build system itself change.
    • Whenever you regenerate a policy file, review the changes to determine whether the access granted to each package seems appropriate.
    • Unfortunately, yarn lavamoat:auto will behave inconsistently on different platforms. macOS and Windows users may see extraneous changes relating to optional dependencies.
    • If you keep getting policy failures even after regenerating the policy files, try regenerating the policies after a clean install by doing:
      • rm -rf node_modules/ && yarn setup && yarn lavamoat:auto
    • Keep in mind that any kind of dynamic import or dynamic use of globals may elude LavaMoat's static analysis. Refer to the LavaMoat documentation or ask for help if you run into any issues.

Architecture

Architecture Diagram

Other Docs

Dapp Developer Resources