Once the Snap is published to NPM and reviewed by the MetaMask Snaps team, it will be manually added to the Snaps registry to be allowlisted. All allowlisted snaps will be displayed in the Official MetaMask Snaps Directory . To add a Snap to this registry, please provide the following information by **completing this form** with the following information:
- Snap name - The name of your Snap. This must match the
proposedName field in the Snap manifest file. You cannot use these words in the name: "MetaMask," "Snap," "Meta," or "Mask."
- Snap builder name and URL - The company, project, or personal site for your brand, where users can learn more about you.
- Snap website URL - A website where users can interact with your Snap. If your Snap does not require a website to be used, you can leave this blank. If your Snap works with multiple websites, you can include the URLs of additional websites in the long description, but this URL should be an official website designed to interact with your Snap.
- Snap short description - A one or two sentence description of your Snap. Try not to say "is a MetaMask Snap" – users already know this!
- Snap long description - A description of your Snap's features and how to use them. You can use line breaks, lists, and URLs. You cannot use HTML. If applicable, describe quick steps to onboard and use the Snap. For example: After installing the Snap, visit the companion dapp at https://voyager-snap.linea.build to connect an account and track your Linea Voyage progress.
- GitHub repository and npm package URLs - The public GitHub repo that hosts your Snap's source code, and the npm package of your published Snap. If your Snap's source code is hosted on a different site, such as GitLab, you can link to that instead.
- Snap version number to be allowlisted - The Snap version number as specified in
package.json and snap.manifest.json. Make sure that the version numbers match and that the Snap has been built with the correct shasum.
- Snap auditor and audit report - A PDF or URL of the required audit report, if your Snap uses one or more of the key management API methods. If your Snap doesn't require an audit, leave this field blank. Note: The audit report will be made public. You can ask your auditor to publish the report on their website and provide the link to us.
- Customer support details - Customer support information to ensure a smooth user experience for your Snap. This allows MetaMask to escalate any issues that a user might encounter with your Snap. The escalation contact will be kept confidential within MetaMask, and the rest of the information will be public. You must provide an escalation contact and at least one other customer support item.
- Images - Screenshots or promotional images to help users get an idea of what your Snap can do. Here's your opportunity to provide compelling previews of your Snap!
- Demo video - A video walking through how to use your Snap. This will help MetaMask review your Snap, and might also be used by the MetaMask marketing team.
I need to make some changes in my Snap. Do I need to get it audited again?
No, for any incremental changes in Snaps, please reach out to us. MetaMask Snap team can review and approve the new version.
For any no-code changes, like Snap description, change in support contact, etc. please reach out to us.