MetaMask

MetaMask is a mobile web browser 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.

MetaMask Mobile

Building locally

The code is built using React-Native and running code locally requires a Mac or Linux OS.

Install Node.js version 10 (latest stable) and yarn@1 (latest)
- If you are using nvm (recommended) running nvm use will automatically choose the right node version for you.
Before starting, you need to install React Native dependencies:
- MacOs
- Linux
Now clone this repo and then install all our dependencies.

cd metamask-mobile
yarn install

Rename the .*.env.example files (remove the .example) in the root of the project and fill in the appropriate values for each key.
Running the app on Android:

You will need the secret-tool (a part of libsecret-tools package on Debian/Ubuntu based distributions) binary on your machine. You'll also want to have the android SDK; the easiest way to do that is by installing Android Studio. Additionally, you'll need to install the Google Play Licencing Library via the SDK Manager in Android Studio.

yarn start:android

Running the app on iOS:

yarn start:ios

Running tests:

Unit test:

yarn test:unit

E2E Tests (iOS)

yarn test:e2e:ios

E2E Tests (Android)

yarn test:e2e:android

Architecture

To get a better understanding of the internal architecture of this app take a look at this diagram

Troubleshooting

Visit Troubleshooting for React Native

License

MetaMask Mobile is an exciting development for our team and our ecosystem. We've always been proud to offer the MetaMask browser extension under the MIT open source software license. We are still working through licensing considerations for the mobile application in light of a new delivery medium and our business goals. We are exploring many models, all with a significant open component, but we have not made any final decisions.

The source code for this beta is currently viewable under the below copyright. A license to use the mobile version will be distributed along with the mobile application. We believe it is important for our users to be able inspect and verify our code for trustworthiness, but we also wish to preserve our licensing options until we're certain what is best for MetaMask, our community, and our ecosystem. If you have any questions or comments, we would really appreciate hearing your feedback – you can reach us at mobile@metamask.io

You are granted a limited non-exclusive license to inspect and study the code in this repository. There is no associated right to reproduction granted under this license except where reproduction is necessary for inspection and study of the code. You may not otherwise reproduce, distribute, modify or create derivative works of the code without our prior consent. All other rights are expressly reserved.