m/metamask-extension
1
0
Fork 0
mirror of https://github.com/kremalicious/metamask-extension.git synced 2024-12-23 09:52:26 +01:00
Code
80134137ba
metamask-extension/README.md

94 lines
8.6 KiB
Markdown
Raw Normal View History

readme - fix "plugin" to "extension"
2017-12-16 00:06:06 +01:00
# MetaMask Browser Extension
Add mobile hiring note to README (#7865)
2020-01-20 02:15:49 +01:00
fix: update README to add a missing " " space (#6191)
2019-02-20 18:41:03 +01:00
You can find the latest version of MetaMask on [our official website](https://metamask.io/). For help using MetaMask, visit our [User Support Site](https://metamask.zendesk.com/hc/en-us).
Merge branch 'master' of github.com:MetaMask/metamask-extension into greenkeeper/initial
2017-08-04 00:05:32 +02:00
Fix community links in README (#11289)
2021-06-15 18:23:43 +02:00
For [general questions](https://community.metamask.io/c/learn/26), [feature requests](https://community.metamask.io/c/feature-requests-ideas/13), or [developer questions](https://community.metamask.io/c/developer-questions/11), visit our [Community Forum](https://community.metamask.io/).
Add links to Community Forum to README (#10152) The Community Forum is now linked in the README. The sections for general questions, feature requests, and developer questions are directly linked as well, to help users discover that we want those type of inquiries in the forum from now on instead of on GitHub. Closes #3484
2021-01-06 23:31:15 +01:00
Add browser recommendation to README (#6941) We have recently dropped support for certain older browsers, and we're planning to have a larger conversation soon about which browsers to support going forward. In preparation for this, it might be worth recommending that users use the latest browser version.
2019-08-02 14:59:18 +02:00
MetaMask supports Firefox, Google Chrome, and Chromium-based browsers. We recommend using the latest available browser version.
Update twitter handle (#10503) Because we got `@metamask`!
2021-02-23 18:05:38 +01:00
For up to the minute news, follow our [Twitter](https://twitter.com/metamask) or [Medium](https://medium.com/metamask) pages.
docs(readme): add Greenkeeper badge
2017-07-19 00:41:33 +02:00
Make docs links consistent (#5920) * Make docs links consistent So our various docs pages inter-link consistently per https://github.com/MetaMask/metamask-docs/issues/1 * Add docs links to internal docs page
2018-12-13 01:18:18 +01:00
To learn how to develop MetaMask-compatible applications, visit our [Developer Docs](https://metamask.github.io/metamask-docs/).
Add mission statement v1
2018-05-29 18:27:02 +02:00
Make docs links consistent (#5920) * Make docs links consistent So our various docs pages inter-link consistently per https://github.com/MetaMask/metamask-docs/issues/1 * Add docs links to internal docs page
2018-12-13 01:18:18 +01:00
To learn how to contribute to the MetaMask project itself, visit our [Internal Docs](https://github.com/MetaMask/metamask-extension/tree/develop/docs).
Add developer faq to top of readme
2016-09-10 05:01:27 +02:00
Add simple build instructions (#454)
2016-07-16 03:04:52 +02:00
## Building locally
Update readme to node 14 (#10374) Follows on from the work done to upgrade Node to version 14 https://github.com/MetaMask/metamask-extension/pull/9514
2021-02-04 19:32:17 +01:00
- Install [Node.js](https://nodejs.org) version 14
Update local build instructions
2018-11-21 20:22:35 +01:00
- If you are using [nvm](https://github.com/creationix/nvm#installation) (recommended) running `nvm use` will automatically choose the right node version for you.
Switch from `npm` to `yarn` (#6843) As a solution to the constant lockfile churn issues we've had with `npm`, the project now uses `yarn` to manage dependencies. The `package-lock.json` file has been replaced with `yarn.lock`, which was created using `yarn import`. It should approximate the contents of `package-lock.json` fairly well, though there may be some changes due to deduplication. The codeowners file has been updated to reference this new lockfile. All documentation and npm scripts have been updated to reference `yarn` rather than `npm`. Note that running scripts using `npm run` still works fine, but it seemed better to switch those to `yarn` as well to avoid confusion. The `npm-audit` Bash script has been replaced with `yarn-audit`. The output of `yarn audit` is a bit different than `npm audit` in that it returns a bitmask to describe which severity issues were found. This made it simpler to check the results directly from the Bash script, so the associated `npm-audit-check.js` script was no longer required. The output should be exactly the same, and the information is still sourced from the same place (the npm registry). The new `yarn-audit` script does have an external dependency: `jq`. However, `jq` is already assumed to be present by another CI script, and is present on all CI images we use. `jq` was not added to `package.json` as a dependency because there is no official package on the npm registry, just wrapper scripts. We don't need it anywhere exept on CI anyway. The section in `CONTRIBUTING` about how to develop inside the `node_modules` folder was removed, as the advice was a bit dated, and wasn't specific to this project anyway.
2019-07-30 20:36:23 +02:00
- Install [Yarn](https://yarnpkg.com/en/docs/install)
"yarn setup" - the new way to install your deps (#10379) * deps - run "yarn setup" to install deps * doc - add "yarn setup" to local dev instructions
2021-02-05 16:41:45 +01:00
- Install dependencies: `yarn setup` (not the usual install command)
Use Infura v3 API (#9368) * Use eth-json-rpc-infura@5.0.0 * Use Infura v3 API * Add example .metamaskrc file
2020-09-10 18:16:00 +02:00
- Copy the `.metamaskrc.dist` file to `.metamaskrc`
Include replacement of Infura Project ID in setup (#9390) The setup steps listed in the README now explicitly include replacing the `INFURA_PROJECT_ID` value with your own personal project ID.
2020-09-10 19:29:32 +02:00
- Replace the `INFURA_PROJECT_ID` value with your own personal [Infura Project ID](https://infura.io/docs).
add segment implementation of metametrics (#9382) Co-authored-by: Whymarrh Whitby <whymarrh.whitby@gmail.com> Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2020-09-14 19:04:05 +02:00
- If debugging MetaMetrics, you'll need to add a value for `SEGMENT_WRITE_KEY` [Segment write key](https://segment.com/docs/connections/find-writekey/).
Switch from `npm` to `yarn` (#6843) As a solution to the constant lockfile churn issues we've had with `npm`, the project now uses `yarn` to manage dependencies. The `package-lock.json` file has been replaced with `yarn.lock`, which was created using `yarn import`. It should approximate the contents of `package-lock.json` fairly well, though there may be some changes due to deduplication. The codeowners file has been updated to reference this new lockfile. All documentation and npm scripts have been updated to reference `yarn` rather than `npm`. Note that running scripts using `npm run` still works fine, but it seemed better to switch those to `yarn` as well to avoid confusion. The `npm-audit` Bash script has been replaced with `yarn-audit`. The output of `yarn audit` is a bit different than `npm audit` in that it returns a bitmask to describe which severity issues were found. This made it simpler to check the results directly from the Bash script, so the associated `npm-audit-check.js` script was no longer required. The output should be exactly the same, and the information is still sourced from the same place (the npm registry). The new `yarn-audit` script does have an external dependency: `jq`. However, `jq` is already assumed to be present by another CI script, and is present on all CI images we use. `jq` was not added to `package.json` as a dependency because there is no official package on the npm registry, just wrapper scripts. We don't need it anywhere exept on CI anyway. The section in `CONTRIBUTING` about how to develop inside the `node_modules` folder was removed, as the advice was a bit dated, and wasn't specific to this project anyway.
2019-07-30 20:36:23 +02:00
- Build the project to the `./dist/` folder with `yarn dist`.
Add simple build instructions (#454)
2016-07-16 03:04:52 +02:00
Update commands in README for building locally
2019-06-24 15:03:35 +02:00
Uncompressed builds can be found in `/dist`, compressed builds can be found in `/builds` once they're built.
Store versioned builds in builds folder
2016-07-27 00:35:08 +02:00
Rationalize build system arguments (#12047) This rationalizes how arguments are passed to and parsed by the build system. To accomplish this, everything that isn't an environment variable from `.metamaskrc` or our CI environment is now passed as an argument on the command line. Of such arguments, the `entryTask` is still expected as a positional argument in the first position (i.e. `process.argv[2]`), but everything else must be passed as a named argument. We use `minimist` to parse the arguments, and set defaults to preserve existing behavior. Arguments are parsed in a new function, `parseArgv`, in `development/build/index.js`. They are assigned to environment variables where convenient, and otherwise returned from `parseArgv` to be passed to other functions invoked in the same file. This change is motivated by our previous inconsistent handling of arguments to the build system, which will grow increasingly problematic as the build system grows in complexity. (Which it will very shortly, as we introduce Flask builds.) Miscellaneous changes: - Adds a build system readme at `development/build/README.md` - Removes the `beta` package script. Now, we can instead call: `yarn dist --build-type beta` - Fixes the casing of some log messages and reorders some parameters in the build system
2021-09-09 21:44:57 +02:00
See the [build system readme](./development/build/README.md) for build system usage information.
Add jsdoc gh-pages script
2018-09-12 23:10:06 +02:00
## Contributing
Improve contributor documentation in README (#10509) The contributor documentation in the README has been improved in various ways: * There is now a dedicated section for development builds under 'Contributing', rather than this being under 'Building locally' * Additional unit test and linting commands have been documented * Instructions for running e2e tests have been added * Instructions on how to handle dependency changes have been added, to accommodate recent changes relating to `allow-scripts` and `LavaMoat`.
2021-02-24 16:52:42 +01:00
### Development builds
Added instructions for installing local build
2016-11-22 03:16:45 +01:00
Improve contributor documentation in README (#10509) The contributor documentation in the README has been improved in various ways: * There is now a dedicated section for development builds under 'Contributing', rather than this being under 'Building locally' * Additional unit test and linting commands have been documented * Instructions for running e2e tests have been added * Instructions on how to handle dependency changes have been added, to accommodate recent changes relating to `allow-scripts` and `LavaMoat`.
2021-02-24 16:52:42 +01:00
To start a development build (e.g. with logging and file watching) run `yarn start`.
Break docs up into individual files
2017-06-05 22:55:48 +02:00
Change remote redux devtools url to redux devtools (#12151) Fixes #12149. Although remotedev.io was the official URL for https://github.com/zalmoxisus/remote-redux-devtools, it looks like a phishing/adult website has taken it over. I've replaced the link with the homepage Redux Devtools Extension in the `redux-devtools` monorepo, (same link as on the Chrome extension page) since that has a link to install `remote-redux-devtools` if need be.
2021-09-17 21:41:55 +02:00
To start the [React DevTools](https://github.com/facebook/react-devtools) and [Redux DevTools Extension](https://github.com/reduxjs/redux-devtools/tree/main/extension)
Improve contributor documentation in README (#10509) The contributor documentation in the README has been improved in various ways: * There is now a dedicated section for development builds under 'Contributing', rather than this being under 'Building locally' * Additional unit test and linting commands have been documented * Instructions for running e2e tests have been added * Instructions on how to handle dependency changes have been added, to accommodate recent changes relating to `allow-scripts` and `LavaMoat`.
2021-02-24 16:52:42 +01:00
alongside the app, use `yarn start:dev`.
- React DevTools will open in a separate window; no browser extension is required
- Redux DevTools will need to be installed as a browser extension. Open the Redux Remote Devtools to access Redux state logs. This can be done by either right clicking within the web browser to bring up the context menu, expanding the Redux DevTools panel and clicking Open Remote DevTools OR clicking the Redux DevTools extension icon and clicking Open Remote DevTools.
- You will also need to 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)
Break docs up into individual files
2017-06-05 22:55:48 +02:00
Fix case of password env variable (#12120)
2021-09-21 19:57:24 +02:00
[Test site](https://metamask.github.io/test-dapp/) can be used to execute different user flows.
Improve contributor documentation in README (#10509) The contributor documentation in the README has been improved in various ways: * There is now a dedicated section for development builds under 'Contributing', rather than this being under 'Building locally' * Additional unit test and linting commands have been documented * Instructions for running e2e tests have been added * Instructions on how to handle dependency changes have been added, to accommodate recent changes relating to `allow-scripts` and `LavaMoat`.
2021-02-24 16:52:42 +01:00
### Running Unit Tests and Linting
Simplify Mocha npm scripts (#12313) The npm scripts used to run Mocha scripts have been greatly simplified. As we transition more tests from Mocha to Jest it was becoming increasingly difficult to update the CLI arguments to keep all of these scripts working correctly. This reorganization should make that process much simpler. The base Mocha options are in `.mocharc.js` - all except for the target tests to run. Those are still given via the CLI. There is a second config file specifically for the `test:unit:lax` tests (i.e. the Mocha tests that have no coverage requirements) because it requires a change to the `ignored` configuration property. We can create an additional configuration file for each test script we add that needs further configuration changes. The `test:unit:path` script used to be used to run Mocha tests at a given path. Now that can be done using `yarn mocha` instead, so this script has been removed. The `yarn watch` command has been broken for some time now, so it has been removed as well. Mocha tests can still be run with a file watcher using `yarn mocha --watch <path>` or `yarn test:unit:mocha --watch`. The README has been updated to remove references about the `watch` command that was removed. I considered explaining the other test scripts there as well, but they were difficult to explain I will attempt to update the README after making further simplifications instead.
2021-10-12 14:40:33 +02:00
Run unit tests and the linter with `yarn test`. To run just unit tests, run `yarn test:unit`.
Improve contributor documentation in README (#10509) The contributor documentation in the README has been improved in various ways: * There is now a dedicated section for development builds under 'Contributing', rather than this being under 'Building locally' * Additional unit test and linting commands have been documented * Instructions for running e2e tests have been added * Instructions on how to handle dependency changes have been added, to accommodate recent changes relating to `allow-scripts` and `LavaMoat`.
2021-02-24 16:52:42 +01:00
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. In either case, start by creating a test build by running `yarn build:test`.
Firefox e2e tests can be run with `yarn test:e2e:firefox`.
Chrome e2e tests can be run with `yarn test:e2e:chrome`, but they will only work if you have Chrome v79 installed. Update the `chromedriver` package to a version matching your local Chrome installation to run e2e tests on newer Chrome versions.
### 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.
Add `yarn-deduplicate` step to README (#13004) The instructions for changing dependencies have been updated to include the `yarn yarn-deduplicate` step. This command removes duplicate dependencies in the lockfile where possible while keeping everything in-range, and it's checked in CI in the `test-yarn-dedupe` job that was added in #12737.
2021-12-07 18:31:55 +01:00
* Run `yarn yarn-deduplicate` to remove duplicate dependencies from the lockfile.
Improve contributor documentation in README (#10509) The contributor documentation in the README has been improved in various ways: * There is now a dedicated section for development builds under 'Contributing', rather than this being under 'Building locally' * Additional unit test and linting commands have been documented * Instructions for running e2e tests have been added * Instructions on how to handle dependency changes have been added, to accommodate recent changes relating to `allow-scripts` and `LavaMoat`.
2021-02-24 16:52:42 +01:00
* 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.
Add per-build type LavaMoat policies (#12702) This PR adds one LavaMoat background script policy or each build type. It also renames the build system policy directory from `node` to `build-system` to make its purpose more clear. Each build type has the original `policy-override.json` for `main` builds. The `.prettierignore` file has been updated to match the locations of the new auto-generated policy files. We need to maintain separate policies for each build type because each type will produce different bundles with different internal and external modules. Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-11-15 23:23:46 +01:00
* 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. Continue reading for more information.
* 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`.
* 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.
* 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.
Added instructions for installing local build
2016-11-22 03:16:45 +01:00
Add architecture diagram to readme
2016-06-14 01:53:21 +02:00
## Architecture
[![Architecture Diagram](./docs/architecture.png)][1]
Break docs up into individual files
2017-06-05 22:55:48 +02:00
## Other Docs
Added changelog and deploy docs
2016-03-22 18:43:56 +01:00
Break docs up into individual files
2017-06-05 22:55:48 +02:00
- [How to add custom build to Chrome](./docs/add-to-chrome.md)
- [How to add custom build to Firefox](./docs/add-to-firefox.md)
Document process of adding a new translation
2018-03-09 20:18:43 +01:00
- [How to add a new translation to MetaMask](./docs/translating-guide.md)
Break docs up into individual files
2017-06-05 22:55:48 +02:00
- [Publishing Guide](./docs/publishing.md)
Fix link to TREZOR emulator docs in README
2018-07-20 00:47:22 +02:00
- [How to use the TREZOR emulator](./docs/trezor-emulator.md)
Fix link on root README.md (#7480)
2019-11-20 15:42:36 +01:00
- [How to generate a visualization of this repository's development](./development/gource-viz.sh)
Add architecture diagram to readme
2016-06-14 01:53:21 +02:00
Rename accountManager usages (#6790) Co-Authored-By: Mark Stacey <markjstacey@gmail.com>
2019-07-10 21:01:48 +02:00
[1]: http://www.nomnoml.com/#view/%5B%3Cactor%3Euser%5D%0A%0A%5Bmetamask-ui%7C%0A%20%20%20%5Btools%7C%0A%20%20%20%20%20react%0A%20%20%20%20%20redux%0A%20%20%20%20%20thunk%0A%20%20%20%20%20ethUtils%0A%20%20%20%20%20jazzicon%0A%20%20%20%5D%0A%20%20%20%5Bcomponents%7C%0A%20%20%20%20%20app%0A%20%20%20%20%20account-detail%0A%20%20%20%20%20accounts%0A%20%20%20%20%20locked-screen%0A%20%20%20%20%20restore-vault%0A%20%20%20%20%20identicon%0A%20%20%20%20%20config%0A%20%20%20%20%20info%0A%20%20%20%5D%0A%20%20%20%5Breducers%7C%0A%20%20%20%20%20app%0A%20%20%20%20%20metamask%0A%20%20%20%20%20identities%0A%20%20%20%5D%0A%20%20%20%5Bactions%7C%0A%20%20%20%20%20%5BbackgroundConnection%5D%0A%20%20%20%5D%0A%20%20%20%5Bcomponents%5D%3A-%3E%5Bactions%5D%0A%20%20%20%5Bactions%5D%3A-%3E%5Breducers%5D%0A%20%20%20%5Breducers%5D%3A-%3E%5Bcomponents%5D%0A%5D%0A%0A%5Bweb%20dapp%7C%0A%20%20%5Bui%20code%5D%0A%20%20%5Bweb3%5D%0A%20%20%5Bmetamask-inpage%5D%0A%20%20%0A%20%20%5B%3Cactor%3Eui%20developer%5D%0A%20%20%5Bui%20developer%5D-%3E%5Bui%20code%5D%0A%20%20%5Bui%20code%5D%3C-%3E%5Bweb3%5D%0A%20%20%5Bweb3%5D%3C-%3E%5Bmetamask-inpage%5D%0A%5D%0A%0A%5Bmetamask-background%7C%0A%20%20%5Bprovider-engine%5D%0A%20%20%5Bhooked%20wallet%20subprovider%5D%0A%20%20%5Bid%20store%5D%0A%20%20%0A%20%20%5Bprovider-engine%5D%3C-%3E%5Bhooked%20wallet%20subprovider%5D%0A%20%20%5Bhooked%20wallet%20subprovider%5D%3C-%3E%5Bid%20store%5D%0A%20%20%5Bconfig%20manager%7C%0A%20%20%20%20%5Brpc%20configuration%5D%0A%20%20%20%20%5Bencrypted%20keys%5D%0A%20%20%20%20%5Bwallet%20nicknames%5D%0A%20%20%5D%0A%20%20%0A%20%20%5Bprovider-engine%5D%3C-%5Bconfig%20manager%5D%0A%20%20%5Bid%20store%5D%3C-%3E%5Bconfig%20manager%5D%0A%5D%0A%0A%5Buser%5D%3C-%3E%5Bmetamask-ui%5D%0A%0A%5Buser%5D%3C%3A--%3A%3E%5Bweb%20dapp%5D%0A%0A%5Bmetamask-contentscript%7C%0A%20%20%5Bplugin%20restart%20detector%5D%0A%20%20%5Brpc%20passthrough%5D%0A%5D%0A%0A%5Brpc%20%7C%0A%20%20%5Bethereum%20blockchain%20%7C%0A%20%20%20%20%5Bcontracts%5D%0A%20%20%20%20%5Baccounts%5D%0A%20%20%5D%0A%5D%0A%0A%5Bweb%20dapp%5D%3C%3A--%3A%3E%5Bmetamask-contentscript%5D%0A%5Bmetamask-contentscript%5D%3C-%3E%5Bmetamask-background%5D%0A%5Bmetamask-background%5D%3C-%3E%5Bmetamask-ui%5D%0A%5Bmetamask-background%5D%3C-%3E%5Brpc%5D%0A
Copy Permalink