1
0
mirror of https://github.com/kremalicious/metamask-extension.git synced 2024-11-23 02:10:12 +01:00
metamask-extension/development/build
Mark Stacey cb12cb8f5a
Restore support for Chromium v78 (#17251)
Support has been restored for Chromium v78. Previously the extension
would crash upon startup.

The main incompatibility was the use of ES2020 operators (the optional
chain and nullish coalesce operators) in the libraries
 `@ethereumjs/util` and `superstruct`. This was resolved by transpiling
those libraries.

After fixing that, the extension no longer crashed but the UI refused
to connect. This was because the UI process was not being identified as
an internal process, because the code responsible for checking that was
relying on the `origin` property of `MessageSender` [1] which wasn't
added until Chromium v80. The check has been updated to use the `url`
property instead, which existed in older versions of Chrome.

Lastly, the content security policy was updated to include the default
content security policy alongside the intended modification. Newer
versions of Chrome will merge the configired CSP with the default, but
older versions required it to be explicitly specified. This should not
result in any functional change.

[1]: https://developer.chrome.com/docs/extensions/reference/runtime/#type-MessageSender
2023-01-23 12:36:48 -03:30
..
transforms Remove fenced code in TypeScript files (#16742) 2022-11-30 15:36:34 +01:00
config.js Remove ONBOARDING_V2 flag for release (#16865) 2023-01-13 10:25:01 -06:00
constants.js Add validation to production build script (#15468) 2022-08-19 15:46:18 -02:30
display.js Rationalize build system arguments (#12047) 2021-09-09 12:44:57 -07:00
etc.js Fix invalid build timestamp on certain timezones (#15245) 2022-07-18 15:03:58 -02:30
index.js Update LavaMoat (core/lavapack) (#17061) 2023-01-18 14:35:37 +02:00
manifest.js remove exclusions for mismatched object jsdoc type casing (#15351) 2022-07-27 08:28:05 -05:00
README.md Migrate the build script to yargs (#14836) 2022-06-21 17:37:05 -02:30
sass-compiler.js Add Lavamoat to build system (#9939) 2021-02-22 22:43:29 +08:00
scripts.js Restore support for Chromium v78 (#17251) 2023-01-23 12:36:48 -03:30
static.js Update LavaMoat (core/lavapack) (#17061) 2023-01-18 14:35:37 +02:00
styles.js build: run scss pipelines synchronously (#16301) 2022-11-04 02:28:52 +00:00
task.js Fix build script errors (#15493) 2022-08-06 03:33:35 -04:00
utils.js Revert "Integrate new LavaMoat scuttling protection feature (#16994)" (#17043) 2022-12-22 17:26:53 +02:00

The MetaMask Build System

tl;dr yarn dist for prod, yarn start for local development. Add --build-type flask to build Flask, our canary distribution with more experimental features.

This directory contains the MetaMask build system, which is used to build the MetaMask Extension such that it can be used in a supported browser. From the repository root, the build system entry file is located at ./development/build/index.js.

Several package scripts invoke the build system. For example, yarn start creates a watched development build, and yarn dist creates a production build. Some of these scripts applies lavamoat to the build system, and some do not. For local development, building without lavamoat is faster and therefore preferable.

The build system is not a full-featured CLI, but rather a script that expects some command line arguments and environment variables. For instructions regarding environment variables, see the main repository readme.

Generally speaking, the build system consists of gulp tasks that either manipulate static assets or bundle source files using Browserify. Production-ready zip files are written to the ./builds directory, while "unpacked" extension builds are written to the ./dist directory.

Our JavaScript source files are transformed using Babel, specifically using the babelify Browserify transform. Source file bundling tasks are implemented in the ./development/build/scripts.js.

Locally implemented Browserify transforms, some of which affect how we write JavaScript, are listed and documented here.

Usage

See node ./development/build/index.js --help