1
0
mirror of https://github.com/kremalicious/metamask-extension.git synced 2024-12-23 09:52:26 +01:00
metamask-extension/development
Mark Stacey 925a19fa4a Revert "Merge pull request #14912 from MetaMask/Version-v10.16.0"
This reverts commit f09ab88891, reversing
changes made to effc761e0e.

This is being temporarily reverted to make it easier to release an
urgent fix for v10.15.1.
2022-06-28 10:41:47 -02:30
..
build Revert "Merge pull request #14912 from MetaMask/Version-v10.16.0" 2022-06-28 10:41:47 -02:30
highlights
lib Derive version suffix from build type and version (#13895) 2022-03-22 20:41:01 -07:00
states
announcer.js
chromereload.js
create-static-server.js
empty.js
generate-lavamoat-policies.sh Run main, flask and beta in sequence in generate-lavamoat-policies.sh (#14470) 2022-04-19 13:38:51 -02:30
generate-migration.sh
gource-viz.sh
jest.config.js Revert "Merge pull request #14912 from MetaMask/Version-v10.16.0" 2022-06-28 10:41:47 -02:30
metamaskbot-build-announce.js Update metamaskbot-build-announce.js (#14320) 2022-03-31 16:11:59 -10:00
missing-locale-strings.js
mock-3box.js
mock-segment.js
README.md Docs - segment metrics (#14435) 2022-04-19 16:15:41 +01:00
run-ganache.sh
sentry-publish.js Automate the Flask release process (#13898) 2022-03-22 19:55:51 -07:00
sentry-upload-artifacts.sh Automate the Flask release process (#13898) 2022-03-22 19:55:51 -07:00
shellcheck.sh
show-deps-install-scripts.js
source-map-explorer.sh
sourcemap-validator.js Use externally hosted phishing warning page 2022-05-16 14:40:50 -02:30
static-server.js
stream-flat-map.js
verify-locale-strings.js

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_HOST and SEGMENT_WRITE_KEY variables in .metamaskrc
    SEGMENT_HOST='http://localhost:9090'
    SEGMENT_WRITE_KEY='FAKE'
    
  • Build the project to the ./dist/ folder with yarn 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 Key from the API Keys section under Settings
  • Add/replace the SEGMENT_HOST and SEGMENT_WRITE_KEY variables in .metamaskrc
    SEGMENT_HOST='https://api.segment.io'
    SEGMENT_WRITE_KEY='COPIED_WRITE_KEY'
    
  • Build the project to the ./dist/ folder with yarn 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 Settings menu item
  • Click the Security & Privacy menu item
  • Toggle the Participate in MetaMetrics menu option to the ON position

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.