Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document permissions that do not require allowlisting #1310

Merged
merged 6 commits into from
May 20, 2024
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/whats-new.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ of the [MetaMask developer page](https://metamask.io/developer/).

## May 2024

- Updated [Snaps Allowlisting Guide](/snaps/how-to/get-allowlisted.md#open-permissions) with "Open Permissions."
alexandratran marked this conversation as resolved.
Show resolved Hide resolved
- Documented [Snaps transaction insights](/snaps/features/transaction-insights).
([#1304](https://github.com/MetaMask/metamask-docs/pull/1304))
- Documented [Snaps home pages](/snaps/features/custom-ui/home-pages).
Expand Down
30 changes: 26 additions & 4 deletions snaps/how-to/get-allowlisted.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,13 @@ sidebar_position: 8

# Get allowlisted

Once you have built your Snap, tested it, and published it to npm, you can make it available to
MetaMask users.
Once you have built your Snap, tested it, and published it to npm, you can make it available to MetaMask users.

As part of the MetaMask Snaps Open Beta launch, individual Snaps must be put on an allowlist before users can install them.
This means that at this time, only selected, reviewed Snaps can be installed.
If your Snap only uses [open permissions](#open-permissions), it can be installed by anyone on the MetaMask Extension.
However, individual Snaps that use
[protected permissions](#open-permissions)
must be put on an allowlist before users can install them.
This means that at this time, only selected, reviewed Snaps that use protected permissions can be installed.
alexandratran marked this conversation as resolved.
Show resolved Hide resolved
In the future, this system will be opened up.

:::caution Important
Expand Down Expand Up @@ -145,3 +147,23 @@ You can also update any information about your Snap using the form.
For fields that you don't need to update, you can leave them blank or enter "N/A."
When providing the new version to be allowlisted, you should also note whether previous versions of
your Snap should be removed from the allowlist (effectively, replaced with the new version).

## Open Permissions

The following is a list of permissions that do not require allowlisting:

- `endowment:cronjob`
- `endowment:ethereum-provider`
- `endowment:lifecycle-hooks`
- `endowment:page-home`
- `endowment:signature-insight`
- `endowment:transaction-insight`
- `snap_dialog`
- `snap_getLocale`
- `snap_manageState`
- `snap_notify`
alexandratran marked this conversation as resolved.
Show resolved Hide resolved

If your Snap only uses permissions from this list,
it can be installed in the MetaMask extension without inclusion on the allowlist.

Any permissions not on this list are _protected_ permissions and will require allowlisting.
alexandratran marked this conversation as resolved.
Show resolved Hide resolved
Loading