AdvertisementRemove ads, dark theme, and more with Premium

MetaMask is a mobile wallet that provides easy access to websites that use the Ethereum blockchain.

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 codebase, visit our Contributor Docs.

• Architecture
• Expo Development Environment Setup
• Native Development Environment Setup
• Build Troubleshooting
• E2E Testing
• Debugging
• Performance
• Release Build Profiling
• Storybook
• Miscellaneous
• E2E Testing Segment Events
• Reassure Performance Testing (pilot)

Expo is the fastest way to start developing. With the Expo framework, developers don't need to compile the native side of the application as before, hence no need for any native environment setup, developers only need to download a precompiled development build and run the javascript bundler. The development build will then connect with the bundler to load the javascript code.

Install node, yarn v3 and watchman.

git clone git@github.com:MetaMask/metamask-mobile.git &&  cd metamask-mobile

yarn setup:expo

yarn watch

• Expo development builds are hosted in Runway buckets and are made available to all contributors through the public bucket links below. A new build is generated every time a PR is merged into the main branch.

• For Android:

  • Download and install an .apk file from this Runway bucket onto your Android device or emulator.

• For iOS:

  • Physical device
    • Your test device needs to first be registered with our Apple developer account.
    • Once registered, download and install an .ipa file from this Runway bucket onto your device.
  • Simulator
    • Download and install an .app file from this Runway bucket onto your simulator.
    • Note: Our .app files are zipped and hosted under Additional Artifacts in the bucket. Since this hosting additional artifacts in public buckets is a relatively new feature, contributors may find that some builds are missing additional artifacts. Under the hood, these are usually associated with failed or aborted Bitrise builds. We are working with the Runway team to better filter out these builds and are subject to change in the future.

If on a simulator:

• use the initial expo screen that appears when starting the development to choose the bundler url
• OR press "a" for Android or "i" for iOS on the terminal where the bundler is running

If on a physical device:

• Use the camera app to scan the QR code presented by the bundler running on the terminal

That's it! This will work for any javascript development, if you need to develop or modify native code please see the next section.

If developing or modifying native code or installing any library that introduces or uses native code, it is not possible to use an Expo precompiled development build as you need to compile the native side of the application again. To do so, please follow the steps stated in this section.

Before running the app for native development, make sure your development environment has all the required tools. Several of these tools (ie Node and Ruby) may require specific versions in order to successfully build the app.

Setup your development environment

Clone the project

git clone git@github.com:MetaMask/metamask-mobile.git &&  cd metamask-mobile

MetaMask uses Firebase Cloud Messaging (FCM) to enable app communications. To integrate FCM, you'll need configuration files for both iOS and Android platforms.

1. Grab the .js.env file from 1Password, ask around for the correct vault. This file contains the GOOGLE_SERVICES_B64_ANDROID and GOOGLE_SERVICES_B64_IOS secrets that will be used to generate the relevant configuration files for IOS/Android.
2. Install and run & start the application as documented below.

As an external contributor, you need to provide your own Firebase project configuration files:

• GoogleService-Info.plist (iOS)
• google-services.json (Android)

1. Create a Free Firebase Project
   • Set up a Firebase project in the Firebase Console.
   • Configure the project with a client package name matching io.metamask (IMPORTANT).
2. Add Configuration Files
   • Create/Update the google-services.json and GoogleService-Info.plist files in:
   • android/app/google-services.json (for Android)
   • ios/GoogleServices/GoogleService-Info.plist directory (for iOS)
3. Create the correct base64 environments variables.

# Generate Android Base64 Version of Google Services export GOOGLE_SERVICES_B64_ANDROID="$(base64 -w0 -i ./android/app/google-services.json)" && echo "export GOOGLE_SERVICES_B64_ANDROID="$GOOGLE_SERVICES_B64_ANDROID"" | tee -a .js.env  # Generate IOS Base64 Version of Google Services export GOOGLE_SERVICES_B64_IOS="$(base64 -w0 -i ./ios/GoogleServices/GoogleService-Info.plist)" && echo "export GOOGLE_SERVICES_B64_IOS="$GOOGLE_SERVICES_B64_IOS"" | tee -a .js.env

[!CAUTION]

In case you don't provide your own Firebase project config file or run the steps above, you will face the error No matching client found for package name 'io.metamask'.

In case of any doubt, please follow the instructions in the link below to get your Firebase project config file. Firebase Project Quickstart

yarn setup

Not the usual install command, this will run scripts and a lengthy postinstall flow

Run Metro bundler

yarn watch

Like a local server for the app

Run on a iOS device

yarn start:ios

Run on an Android device

yarn start:android

This project uses Husky to run pre-commit hooks that automatically format and lint your code before commits. The pre-commit hook runs lint-staged which executes:

• Prettier - Code formatting for *.{js,jsx,ts,tsx,json,feature} files
• ESLint - Linting and auto-fixing for *.{js,jsx,ts,tsx} files

If you need to disable Husky pre-commit hooks temporarily (e.g., for emergency commits or debugging), you have several options:

git commit --no-verify -m "your commit message"

# Disable for current session export HUSKY=0 git commit -m "your commit message"  # Or disable for a single command HUSKY=0 git commit -m "your commit message"

Note: While these methods allow you to bypass the pre-commit hooks, remember that the CI/CD pipeline will still run linting checks. It's recommended to fix linting issues before pushing your changes to avoid build failures.