Skip to content

Commit

Permalink
fix: add link onboarding document in snap allowlist (#1510)
Browse files Browse the repository at this point in the history
* fix: add link onboarding document in snap allowlist

* Move onboarding form to quickstart and prerequisites

---------

Co-authored-by: Alexandra Tran <[email protected]>
  • Loading branch information
khanti42 and alexandratran authored Sep 4, 2024
1 parent 7a1c308 commit 50bb8f7
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 26 deletions.
2 changes: 2 additions & 0 deletions snaps/get-started/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,8 @@ You've now successfully connected, installed, interacted with, and customized yo

## Next steps

- Fill out the [Snap Builders Onboarding Form](https://feedback.metamask.io/snaps-onboarding) to
allow the MetaMask Snaps team to engage with you and provide support as you begin to develop your Snap.
- To learn more about the Snaps system, review [fundamental Snaps concepts](/snaps/learn/about-snaps)
and try the [Snaps tutorials](/snaps/learn/tutorials).
- To implement specific features and use cases, see the [Snaps feature guides](/snaps/features).
Expand Down
54 changes: 28 additions & 26 deletions snaps/how-to/get-allowlisted.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,32 +22,34 @@ Always do your own research before installing a Snap.

## Prerequisites

To be added to the allowlist, a Snap must:

- Have publicly available source code.
You don't need to publish your code with an open source license, but users should be able to read
the source code of the Snap package.
- Be [published](publish-a-snap.md) to npm.
- Not impair our compliance with laws or regulations.

Furthermore, if your Snap uses any of the following API methods related to key management, you must provide
evidence of a third-party audit from an approved auditor:

- [`snap_getBip32Entropy`](../reference/snaps-api.md#snap_getbip32entropy)
- [`snap_getBip32PublicKey`](../reference/snaps-api.md#snap_getbip32publickey)
- [`snap_getBip44Entropy`](../reference/snaps-api.md#snap_getbip44entropy)
- [`snap_getEntropy`](../reference/snaps-api.md#snap_getentropy)
- [`snap_manageAccounts`](../reference/snaps-api.md#snap_manageaccounts)

The audit must cover the Snap source code that is to run within the Snaps system, and any modules
used for key management.
You must provide the commit that was audited and the commit that has any fixes documented in the
audit report.

:::info
A list of approved third-party auditors and details about the audit process are available on the
[MetaMask Snaps Builder Engagement Program](https://consensys.notion.site/Audit-process-1acbc67819dc4631b7a3d6c664e387a3).
:::
- Ensure you have filled out the [Snap Builders Onboarding Form](https://feedback.metamask.io/snaps-onboarding).

- Ensure that your Snap:

- Has publicly available source code.
You don't need to publish your code with an open source license, but users should be able to read
the source code of the Snap package.
- Is [published](publish-a-snap.md) to npm.
- Does not impair MetaMask's compliance with laws or regulations.

- If your Snap uses any of the following API methods related to key management, you must provide
evidence of a third-party audit from an approved auditor:

- [`snap_getBip32Entropy`](../reference/snaps-api.md#snap_getbip32entropy)
- [`snap_getBip32PublicKey`](../reference/snaps-api.md#snap_getbip32publickey)
- [`snap_getBip44Entropy`](../reference/snaps-api.md#snap_getbip44entropy)
- [`snap_getEntropy`](../reference/snaps-api.md#snap_getentropy)
- [`snap_manageAccounts`](../reference/snaps-api.md#snap_manageaccounts)

The audit must cover the Snap source code that is to run within the Snaps system, and any modules
used for key management.
You must provide the commit that was audited and the commit that has any fixes documented in the
audit report.

:::info
A list of approved third-party auditors and details about the audit process are available on the
[MetaMask Snaps Builder Engagement Program](https://consensys.notion.site/Audit-process-1acbc67819dc4631b7a3d6c664e387a3).
:::

## Steps

Expand Down

0 comments on commit 50bb8f7

Please sign in to comment.