Skip to content

Commit 7c80c51

Browse files
authored
Merge branch 'main' into add-din-info
2 parents ae1a11d + 9182a62 commit 7c80c51

File tree

8 files changed

+11308
-8078
lines changed

8 files changed

+11308
-8078
lines changed

docs/whats-new.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ of the [MetaMask developer page](https://metamask.io/developer/).
1212
## December 2024
1313

1414
- Documented [Swellchain](/services/reference/swellchain) support. ([#1776](https://github.com/MetaMask/metamask-docs/pull/1776))
15-
- Documented [Snap Notifications Expanded View](/snaps/features/notifications/#expanded-view).
15+
- Documented [Snaps notifications expanded view](/snaps/features/notifications/#expanded-view).
1616
([#1774](https://github.com/MetaMask/metamask-docs/pull/1774))
1717
- Documented [`snap_getInterfaceContext`](/snaps/reference/snaps-api/#snap_getinterfacecontext).
1818
([#1772](https://github.com/MetaMask/metamask-docs/pull/1772))

package-lock.json

Lines changed: 11275 additions & 8056 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,12 @@
2929
},
3030
"dependencies": {
3131
"@apidevtools/json-schema-ref-parser": "^11.7.2",
32-
"@docusaurus/core": "^3.5.2",
33-
"@docusaurus/plugin-content-docs": "^3.5.2",
34-
"@docusaurus/plugin-content-pages": "^3.5.2",
35-
"@docusaurus/preset-classic": "^3.5.2",
36-
"@docusaurus/theme-common": "^3.5.2",
37-
"@docusaurus/theme-mermaid": "^3.5.2",
32+
"@docusaurus/core": "^3.7.0",
33+
"@docusaurus/plugin-content-docs": "^3.7.0",
34+
"@docusaurus/plugin-content-pages": "^3.7.0",
35+
"@docusaurus/preset-classic": "^3.7.0",
36+
"@docusaurus/theme-common": "^3.7.0",
37+
"@docusaurus/theme-mermaid": "^3.7.0",
3838
"@intercom/messenger-js-sdk": "^0.0.14",
3939
"@mdx-js/react": "^3.1.0",
4040
"@metamask/design-tokens": "^1.11.1",
@@ -72,11 +72,11 @@
7272
"sass": "^1.80.4"
7373
},
7474
"devDependencies": {
75-
"@docusaurus/eslint-plugin": "^3.5.2",
76-
"@docusaurus/module-type-aliases": "^3.5.2",
77-
"@docusaurus/plugin-client-redirects": "^3.5.2",
78-
"@docusaurus/tsconfig": "^3.5.2",
79-
"@docusaurus/types": "^3.5.2",
75+
"@docusaurus/eslint-plugin": "^3.7.0",
76+
"@docusaurus/module-type-aliases": "^3.7.0",
77+
"@docusaurus/plugin-client-redirects": "^3.7.0",
78+
"@docusaurus/tsconfig": "^3.7.0",
79+
"@docusaurus/types": "^3.7.0",
8080
"@eslint/js": "^8.57.1",
8181
"@tsconfig/docusaurus": "^1.0.5",
8282
"@types/react-alert": "^7.0.6",

snaps/features/custom-ui/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ implementing the following features:
1616
- [Home pages](home-pages.md)
1717
- [Transaction insights](../transaction-insights.md)
1818
- [Signature insights](../signature-insights.md)
19-
- [Notifications (Expanded View)](../notifications.md#expanded-view)
19+
- [Notifications (expanded view)](../notifications.md#expanded-view)
2020

2121
:::note
2222
JSX is supported in the MetaMask extension and Flask version 12 and later.

snaps/features/notifications.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,9 +65,11 @@ Each Snap can trigger up to:
6565

6666
## Expanded view
6767

68-
In-app notifications can include an optional expanded view that will be displayed when the user clicks on the notification. The expanded view includes a title, content, and an optional footer link.
68+
In-app notifications can include an optional expanded view that displays when selected.
69+
The expanded view includes a title, content, and an optional footer link.
6970

70-
The following example displays a notification in MetaMask, with the message "Hello, world!" When the user clicks on the notification, the expanded view displays a page with a title, a paragraph, and a link to the MetaMask Snaps directory:
71+
The following example displays a notification in MetaMask, with the message "Hello, world!"
72+
When the user selects the notification, the expanded view displays a page with a title, a paragraph, and a link to the MetaMask Snaps directory:
7173

7274
```javascript title="index.js"
7375
await snap.request({

snaps/how-to/get-allowlisted.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,11 @@ Always do your own research before installing a Snap.
3232
- Is [published](publish-a-snap.md) to npm.
3333
- Does not impair MetaMask's compliance with laws or regulations.
3434

35+
- Remove any `console` logs, "to-do" comments, and unused permissions or methods.
36+
37+
- Scan your Snap for security vulnerabilities using [Snapper](https://github.com/sayfer-io/Snapper) and
38+
resolve any reported issues.
39+
3540
- If your Snap uses any of the following API methods related to key management, you must provide
3641
evidence of a third-party audit from an approved auditor:
3742

snaps/learn/about-snaps/index.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -69,13 +69,15 @@ For each Snap, the user can:
6969
A Snap can also display a [home page](../../features/custom-ui/home-pages.md) within MetaMask that
7070
the user can access using the Snaps menu.
7171

72-
Other than the settings page and home page, a Snap can
73-
[modify the MetaMask UI](../../features/custom-ui/index.md) only
74-
by displaying [dialogs](../../features/custom-ui/dialogs.md),
75-
[transaction insights](../../reference/entry-points.md#ontransaction), or
76-
[signature insights](../../features/signature-insights.md).
77-
78-
This means that many Snaps must use companion dapps and custom JSON-RPC API methods to
72+
Other than the settings page and home page, a Snap can modify the MetaMask UI by displaying
73+
[custom UI](../../features/custom-ui/index.md) in
74+
[dialogs](../../features/custom-ui/dialogs.md),
75+
[transaction insights](../../features/transaction-insights.md),
76+
[signature insights](../../features/signature-insights.md), and
77+
[notifications (expanded view)](../../features/notifications.md#expanded-view).
78+
An [account management Snap](../../features/custom-evm-accounts/index.md) can also modify the MetaMask UI by leveraging native account UX.
79+
80+
Many Snaps must use companion dapps and custom JSON-RPC API methods to
7981
present data to the user.
8082

8183
:::note

snaps/learn/resources.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,8 @@ View the following Snaps resources in addition to this documentation site.
5555
- [Snaps Simulator](https://metamask.github.io/snaps/snaps-simulator/latest) - A tool for simulating
5656
Snaps in the browser, streamlining the development process. It doesn't support all Snaps features
5757
but can be useful for testing certain features.
58+
- [Snapper](https://github.com/sayfer-io/Snapper) - A tool for detecting security vulnerabilities,
59+
identifying potential issues, and ensuring best coding practices in your Snap.
5860
- [MetaMask Testing Tools](https://hugomrdias.github.io/metamask/) - A collection of tools for
5961
testing MetaMask, MetaMask Flask, and MetaMask Snaps with [Playwright](https://playwright.dev/),
6062
delivered as an npm package that provides a `createFixture` function that returns a `test` and

0 commit comments

Comments
 (0)