mirror of
https://github.com/kremalicious/metamask-extension.git
synced 2024-12-23 09:52:26 +01:00
73a7ce9e39
Adds a new flag, `--apply-lavamoat`, to the main build script. The flag controls whether LavaMoat is actually applied to the output of the build process. The flag defaults to `true`, but we explicitly set it to `false` in the `start` package script. Meanwhile, the `start:lavamoat` script is modified such that it applies LavaMoat to the build output in development mode, but it no longer runs the build process itself under LavaMoat as there aren't very compelling reasons to do so. This change is motivated by the fact that development builds do not have their own dedicated LavaMoat policies, which causes development builds to fail since #14537. The downside of this change is that LavaMoat-related failures will not be detected when running `yarn start`. @kumavis has plans for fixing this problem in a future major version of the `@lavamoat` suite.
Development
Several files which are needed for developing on MetaMask.
Usually each file or directory contains information about its scope / usage.
Segment
Debugging with the Mock Segment API
To start the Mock Segment API:
- Add/replace the
SEGMENT_HOSTandSEGMENT_WRITE_KEYvariables in.metamaskrcSEGMENT_HOST='http://localhost:9090' SEGMENT_WRITE_KEY='FAKE' - Build the project to the
./dist/folder withyarn dist - Run the Mock Segment API from the command line
node development/mock-segment.js
Events triggered whilst using the extension will be logged to the console of the Mock Segment API.
More information on the API and its usage can be found here.
Debugging in Segment
To debug in a production Segment environment:
- Create a free account on Segment
- Create a New Workspace
- Add a Source (Node.js)
- Copy the
Write Keyfrom the API Keys section under Settings - Add/replace the
SEGMENT_HOSTandSEGMENT_WRITE_KEYvariables in.metamaskrcSEGMENT_HOST='https://api.segment.io' SEGMENT_WRITE_KEY='COPIED_WRITE_KEY' - Build the project to the
./dist/folder withyarn dist
Events triggered whilst using the extension will be displayed in Segment's Debugger.
Debugging Segment requests in MetaMask
To opt in to MetaMetrics;
- Unlock the extension
- Open the Account menu
- Click the
Settingsmenu item - Click the
Security & Privacymenu item - Toggle the
Participate in MetaMetricsmenu option to theONposition
You can inspect the requests in the Network tab of your browser's Developer Tools (background.html)
by filtering for POST requests to /v1/batch. The full url will be http://localhost:9090/v1/batch
or https://api.segment.io/v1/batch respectively.