Skip to content
This repository has been archived by the owner on Jan 25, 2022. It is now read-only.

Getting Started

Jump to bottom
Mark Stacey edited this page Jun 10, 2021 · 28 revisions

Front Matter

Platform Support

  • Browser: We currently only support Chromium browsers. Firefox and Opera may or may not work.
  • OS: We currently only support *nix environments. Windows may or may not work.

We will eventually support the same browsers and operating systems as the production MetaMask extension.

Community

You can check out the community Telegram channel here: https://t.me/mmsnaps

Installing the MetaMask Snaps Beta & snaps-cli

Note: Make sure you have nvm installed.

To get started, you'll need to clone and build our special fork of MetaMask:

git clone [email protected]:MetaMask/metamask-snaps-beta.git
cd metamask-snaps-beta
nvm use
yarn install
yarn start

yarn start will auto rebuild MetaMask on any file change. You can then add your custom build to Chrome.

Chrome will auto-reload the extension when it detects a change, but this auto-reload is not perfectly reliable, so you may want to make a habit of navigating to chrome://extensions and clicking the reload icon next to your custom MetaMask:

reload webextension

Running Snap Dapps

Note: Make sure you have nvm installed.

A Snap has a few parts:

  • A normal web front-end
  • A package.json that defines the Snap and its permissions
  • A source file bundle pointed to by package.json

To help you build those bundled files, we have a utility we call snaps-cli.

We recommend you clone that repository, and yarn link it to start:

git clone https://github.com/MetaMask/snaps-cli
cd snaps-cli
nvm use
yarn
yarn build
yarn link

This gives you some tools you can use right away. You can learn more about them by running mm-snap --help.

Let's try out an example. You can find several interesting examples in the examples folder. We'll start with the simplest example, hello-snaps.

cd examples/hello-snaps
mm-snap build
mm-snap serve

This should give you a message Server listening on: http://localhost:8081. That port, and the build target are configured in the snap.config.json file, or command line arguments. You can now visit that address in your browser, and if you have installed your Snap branch of MetaMask correctly, you should be able to:

  1. Click the "Connect" button on the site.
  2. Approve the site's permissions request (which includes the Snap installation!)
  3. Approve the Snap's permissions request (which in this case is permission to show alerts to you, to send its message)
  4. Click the "Send Hello" button to receive a greeting from the Snap.

The permissions the Snap initially requests are configured in its package.json, under the web3Wallet key. This permissions request uses the same schema as an EIP 2255 permissions request. (TypeScript definition)

If you look closely at the index.html file, you'll see that interacting with the Snap required two basic API calls:

And if you look in the index.js file, you can see just how easy it is to add API methods to connected websites from within a Snap.

You can edit the index.js freely, and just run mm-snap build again to rebuild the bundle. (There is also a mm-snap watch command to rebuild automatically.) MetaMask itself doesn't yet auto-detect updates to the Snap, so you'll have to reinstall the Snap when the bundle changes.

For starting your own Snap, you might want to just copy one of the examples to start!

You can test the RPC methods for your snap using inspector-snaps

Because we're in early beta, we still introduce breaking changes to Snap-related functionality from time to time. This page maintains a history of all breaking changes, and what you have to do to keep up.

Clone this wiki locally