Merge branch 'main' into 1566-multichain

# Conflicts:
#	docs/whats-new.md
#	wallet-sidebar.js

Author: alexandratran

.github/CODEOWNERS

@@ -2,22 +2,7 @@
 # so the listed codeowners apply only if there is no later match.
 
 # Default owner for all other files
-* @MetaMask/activation
-
-# Docusaurus configuration
-docusaurus.config.js @MetaMask/activation @MetaMask/tech-writers
-
-# GitHub workflows and templates
-/.github/ @MetaMask/activation @MetaMask/tech-writers
-
-# Static image and video files
-/static/ @MetaMask/activation @MetaMask/tech-writers
-
-# Vercel configuration
-vercel.json @MetaMask/activation @MetaMask/tech-writers
-
-# Sidebar files
-*-sidebar.js @MetaMask/activation @MetaMask/tech-writers
+* @MetaMask/dashboard @MetaMask/tech-writers
 
 # All other Markdown files
 *.md @MetaMask/tech-writers

.github/workflows/dependency_review.yml

@@ -8,7 +8,7 @@ on:
 
 jobs:
   case:
-    name: Check for licences not being allowed
+    name: Check for licenses not being allowed
     runs-on: ubuntu-latest
     strategy:
       matrix:

.github/workflows/trivy-cache.yml

@@ -0,0 +1,19 @@
+---
+name: trivy-cache-db
+
+on:
+  pull_request:
+    branches:
+      - main
+  workflow_dispatch:
+  schedule:
+    - cron: "0 1 * * *"      
+
+jobs:
+  trivy:
+    name: Run trivy scanner
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Trivy Cache
+        uses: ConsenSys/docs-gha/trivy-update-cache@main

CONTRIBUTING.md

@@ -71,9 +71,9 @@ To contribute changes:
 
    > **Notes:**
    >
-   > - All documentation content is located in the `wallet`, `snaps`, `services`, and
+   > - All documentation content is located in the `wallet`, `sdk`, `snaps`, `services`, and
    >   `developer-tools` directories.
-   > - If you add a new documentation page, edit `wallet-sidebar.js`, `snaps-sidebar.js`,
+   > - If you add a new documentation page, edit `wallet-sidebar.js`, `sdk-sidebar.js`, `snaps-sidebar.js`,
    >   `services-sidebar.js`, or `dashboard-sidebar.js` to add the page to the
    >   [sidebar](https://docs-template.consensys.io/create/configure-docusaurus#sidebar).
    > - If you delete, rename, or move a documentation file, add a
@@ -120,7 +120,7 @@ Refer to the [Consensys documentation style guide](https://docs-template.consens
 
 ## Add images
 
-All images are located in the `wallet/assets`, `snaps/assets`, `services/images`, and
+All images are located in the `wallet/assets`, `sdk/_assets`, `snaps/assets`, `services/images`, and
 `developer-tools/images` directories.
 When adding a new image, such as a screenshot or diagram, make sure the image has a white or
 `#1b1b1d` color background in order for it to be compatible with the site's light and dark modes.

LICENSE-MIT

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 MetaMask
+Copyright (c) 2018-2025 MetaMask
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

developer-tools/dashboard/get-started/create-api.md

@@ -13,14 +13,14 @@ Based on your plan, Infura allows for the following amount of API keys:
 - Developer plan - Allows up to five API keys.
 - Team plans and higher - No limit on the number of API keys.
 
-For more information, see to the [Infura pricing page](https://www.infura.io/pricing).
+For more information, see the [Infura pricing page](https://www.infura.io/pricing).
 
 :::
 
 Infura allows you to enable multiple network endpoints and expansion APIs for your API key. If calls are
 made to a disabled network or service, then all requests to that network or service will fail.
 
-To keep your account secure and cost effective, add only the necessary endpoints, as some have usage
+To keep your account secure and cost-effective, add only the necessary endpoints, as some have usage
 limits or charges based on request volume.
 
 To create an API key:

developer-tools/dashboard/how-to/credit-usage.md

@@ -5,7 +5,7 @@ description: View your Infura credit usage stats.
 # View credit usage
 
 You can view your daily credit usage in relation to your daily credit quota limit. Daily credit usage
-counts are reset everyday at 00:00 UTC for all customers.
+counts are reset every day at 00:00 UTC for all customers.
 
 Select **View Usage** from the **Daily Credit Usage** section on the dashboard, or select
 the **Usage** tab from the **Settings** > **Billing** dropdown.

developer-tools/dashboard/how-to/secure-an-api/set-rate-limits.md

@@ -26,3 +26,19 @@ Set rate limiting in the API key's **Settings** tab **Key Credit Limits** sectio
     credits per day in integers, for example, 20000. The value `0` means default limits are applied.
 
     When the number of used credits reach this limit, all requests will be rejected until the next day (00:00 UTC).
+
+If you exceed the specified limits, you'll receive a JSON response with an
+[HTTP error status code `429`](/services/reference/ethereum/json-rpc-methods#http-errors). For example:
+
+```json
+{
+  "jsonrpc": "2.0",
+  "id": 1,
+  "error": {
+    "code": 429,
+    "event": -33300,
+    "message": "Too Many Requests",
+    "details": "You have surpassed your user-defined key throughput limit setting. To make more requests with this key, review key setting configurations."
+  }
+}
+```

docs/whats-new.md

@@ -9,13 +9,30 @@ The latest major MetaMask documentation updates are listed by the month they wer
 For a comprehensive list of recent product changes, visit the "Release Notes" section at the bottom
 of the [MetaMask developer page](https://metamask.io/developer/).
 
-## November 2024
+## January 2025
 
 - Documented Multichain API [guide](/wallet/how-to/manage-networks/use-multichain),
   [concept](/wallet/concepts/multichain-api), and [reference](/wallet/reference/multichain-api).
   ([#1621](https://github.com/MetaMask/metamask-docs/pull/1621))
+- Documented [`eth_simulateV1`](/services/reference/ethereum/json-rpc-methods/eth_simulatev1). ([#1798](https://github.com/MetaMask/metamask-docs/pull/1798))
+- Added new [MetaMask SDK documentation section](/sdk).
+  ([#1766](https://github.com/MetaMask/metamask-docs/pull/1766))
+- Documented Snaps [`Banner`](/snaps/features/custom-ui/#banner), [`Container`](/snaps/features/custom-ui/#container), [`Footer`](/snaps/features/custom-ui/#footer), [`Skeleton`](/snaps/features/custom-ui/#skeleton), and [`Value`](/snaps/features/custom-ui/#value) UI components.
+  ([#1835](https://github.com/MetaMask/metamask-docs/pull/1835))
+
+## December 2024
+
+- Documented [Swellchain](/services/reference/swellchain) support. ([#1776](https://github.com/MetaMask/metamask-docs/pull/1776))
+- Documented [Snaps notifications expanded view](/snaps/features/notifications/#expanded-view). 
+  ([#1774](https://github.com/MetaMask/metamask-docs/pull/1774))
+- Documented [`snap_getInterfaceContext`](/snaps/reference/snaps-api/#snap_getinterfacecontext).
+  ([#1772](https://github.com/MetaMask/metamask-docs/pull/1772))
+
+## November 2024
+
+- Documented [updated error responses](/services/reference/ethereum/json-rpc-methods) when rate-limiting Infura JSON-RPC API calls. ([#1749](https://github.com/MetaMask/metamask-docs/pull/1749))
 - Documented [Unichain Sepolia](/services/reference/unichain) support. ([#1725](https://github.com/MetaMask/metamask-docs/pull/1725))
-- Updated Snaps [Custom UI documentation](/snaps/features/custom-ui/) for MetaMask Extension version 12.6.
+- Updated Snaps [custom UI documentation](/snaps/features/custom-ui/) for MetaMask Extension version 12.6.
   ([#1715](https://github.com/MetaMask/metamask-docs/pull/1715))
 - Added tutorial for
   [creating a simple Starknet dapp](/wallet/how-to/use-non-evm-networks/starknet/create-a-simple-starknet-dapp).
@@ -29,7 +46,7 @@ of the [MetaMask developer page](https://metamask.io/developer/).
   ([#1509](https://github.com/MetaMask/metamask-docs/pull/1509))
 - Documented [Scroll](/services/reference/scroll) support.
   ([#1641](https://github.com/MetaMask/metamask-docs/pull/1641))
-- Updated [Wallet landing page](/wallet) and added [Connect to MetaMask](/wallet/connect) section
+- Updated [Wallet landing page](/wallet) and added [Connect to MetaMask](/wallet/how-to/connect) section
   with SDK, third-party libraries, and Wallet API connection options.
   ([#1494](https://github.com/MetaMask/metamask-docs/pull/1494))
 - Documented [`snap_getPreferences`](/snaps/reference/snaps-api/#snap_getpreferences).
@@ -52,7 +69,7 @@ of the [MetaMask developer page](https://metamask.io/developer/).
   ([#1540](https://github.com/MetaMask/metamask-docs/pull/1540))
 - Documented [Snaps user-defined components](/snaps/features/custom-ui/user-defined-components).
   ([#1557](https://github.com/MetaMask/metamask-docs/pull/1557))
-- Updated [Android SDK documentation](/wallet/connect/metamask-sdk/mobile/android) with convenience
+- Updated [Android SDK documentation](/sdk) with convenience
   methods and examples using coroutines.
   ([#1546](https://github.com/MetaMask/metamask-docs/pull/1546))
 - Documented [Infura's credit pricing model](/services/get-started/pricing).
@@ -77,12 +94,12 @@ of the [MetaMask developer page](https://metamask.io/developer/).
 
 ## June 2024
 
-- Documented [Snaps custom UI with JSX](/snaps/features/custom-ui/with-jsx).
+- Documented [Snaps custom UI with JSX](/snaps/features/custom-ui).
   ([#1348](https://github.com/MetaMask/metamask-docs/pull/1348))
 - Updated [React dapp with global state tutorial](/wallet/tutorials/react-dapp-global-state) with
   instructions for EIP-6963.
   ([#1330](https://github.com/MetaMask/metamask-docs/pull/1330))
-- Documented that the Gas API can be [called without an API key secret](/services/gas-api/api-reference). ([#1346](https://github.com/MetaMask/metamask-docs/pull/1346))
+- Documented that the Gas API can be [called without an API key secret](/services/reference/gas-api). ([#1346](https://github.com/MetaMask/metamask-docs/pull/1346))
 - Updated [Snaps resources](/snaps/learn/resources) and added a new section "Snaps for developers." ([#1329](https://github.com/MetaMask/metamask-docs/pull/1329))
 - Documented [how to allow automatic connections to a Snap](/snaps/how-to/allow-automatic-connections).
   ([#1322](https://github.com/MetaMask/metamask-docs/pull/1322))
@@ -116,7 +133,7 @@ of the [MetaMask developer page](https://metamask.io/developer/).
 - Documented [Snaps notifications](/snaps/features/notifications).
   ([#1292](https://github.com/MetaMask/metamask-docs/pull/1292))
 - Moved Snaps-specific Wallet API methods from the
-  [Wallet JSON-RPC API reference](/wallet/reference/json-rpc-api) to the
+  [Wallet JSON-RPC API reference](/wallet/reference/json-rpc-methods) to the
   [Snaps reference](/snaps/reference/wallet-api-for-snaps).
   ([#1286](https://github.com/MetaMask/metamask-docs/pull/1286))
 - Documented [Snaps `onKeyringRequest` entry point](/snaps/reference/entry-points/#onkeyringrequest).
@@ -129,7 +146,7 @@ of the [MetaMask developer page](https://metamask.io/developer/).
   ([#1274](https://github.com/MetaMask/metamask-docs/pull/1274))
 - Documented [Snaps cron jobs](/snaps/features/cron-jobs).
   ([#1271](https://github.com/MetaMask/metamask-docs/pull/1271))
-- Updated [how to connect to MetaMask](/wallet/connect/wallet-api) with vanilla TypeScript and React
+- Updated [how to connect to MetaMask](/wallet/how-to/connect) with vanilla TypeScript and React
   TypeScript instructions.
   ([#1247](https://github.com/MetaMask/metamask-docs/pull/1247))
 
@@ -148,7 +165,7 @@ of the [MetaMask developer page](https://metamask.io/developer/).
 - Documented [Snap-defined timeouts](/snaps/reference/permissions/#snap-defined-timeouts).
   ([#1224](https://github.com/MetaMask/metamask-docs/pull/1224) and
   [#1227](https://github.com/MetaMask/metamask-docs/pull/1227))
-- Restructured Wallet documentation to emphasize [connecting using EIP-6963](/wallet/connect/wallet-api).
+- Restructured Wallet documentation to emphasize [connecting using EIP-6963](/wallet/how-to/connect).
   ([#1214](https://github.com/MetaMask/metamask-docs/pull/1214))
 - Documented [Snaps custom name resolution](/snaps/features/custom-name-resolution).
   ([#924](https://github.com/MetaMask/metamask-docs/pull/924))
@@ -160,9 +177,9 @@ of the [MetaMask developer page](https://metamask.io/developer/).
   ([#1209](https://github.com/MetaMask/metamask-docs/pull/1209) and
   [#1225](https://github.com/MetaMask/metamask-docs/pull/1225))
 - Removed "Flask" label from [Snaps home pages](/snaps/reference/entry-points/#onhomepage) and
-  [`snap_getLocale`](/snaps/reference/snaps-api/#snap_getlocale).
+  [`snap_getLocale`](/snaps/reference/snaps-api/#snap_getlocale-deprecated).
   ([#1204](https://github.com/MetaMask/metamask-docs/pull/1204))
-- Restructured [SDK documentation](/wallet/how-to/use-sdk) to de-emphasize it as a recommended method.
+- Restructured [SDK documentation](/sdk) to de-emphasize it as a recommended method.
   ([#1200](https://github.com/MetaMask/metamask-docs/pull/1200) and
   [#1230](https://github.com/MetaMask/metamask-docs/pull/1230))
 - Deprecated the following [provider API](/wallet/reference/provider-api) elements:
@@ -177,7 +194,7 @@ of the [MetaMask developer page](https://metamask.io/developer/).
   ([#1178](https://github.com/MetaMask/metamask-docs/pull/1178))
 - Improved and restructured the [Snaps Keyring API reference](/snaps/reference/keyring-api).
   ([#1170](https://github.com/MetaMask/metamask-docs/pull/1170))
-- Documented [how to connect and sign using the Unity SDK](/wallet/how-to/use-sdk/gaming/unity/connect-and-sign).
+- Documented [how to connect and sign using the Unity SDK](/sdk).
   ([#1023](https://github.com/MetaMask/metamask-docs/pull/1023))
 
 ## February 2024
@@ -199,7 +216,7 @@ of the [MetaMask developer page](https://metamask.io/developer/).
 - Restructured and improved [Wallet documentation](/wallet) and introduced "Wallet API" terminology.
   ([#1114](https://github.com/MetaMask/metamask-docs/pull/1114) and
   [#1125](https://github.com/MetaMask/metamask-docs/pull/1125))
-- Documented [how to detect multiple wallets using EIP-6963](/wallet/connect/wallet-api).
+- Documented [how to detect multiple wallets using EIP-6963](/wallet/how-to/connect).
   ([#1094](https://github.com/MetaMask/metamask-docs/pull/1094))
 - Documented [how to communicate errors in Snaps](/snaps/how-to/communicate-errors).
   ([#1117](https://github.com/MetaMask/metamask-docs/pull/1117))

docusaurus.config.js

@@ -153,18 +153,29 @@ const config = {
         },
         sidebarItemsGenerator: async function ({ defaultSidebarItemsGenerator, ...args }) {
           const sidebarItems = await defaultSidebarItemsGenerator(args);
-          const dymanicItems = await fetchAndGenerateDynamicSidebarItems(
+          const dynamicItems = await fetchAndGenerateDynamicSidebarItems(
             MM_RPC_URL,
             MM_REF_PATH,
             NETWORK_NAMES.metamask
           )
           if (args.item.dirName === "reference/json-rpc-methods") {
-            return [...sidebarItems, ...dymanicItems]
+            return [...sidebarItems, ...dynamicItems]
           }
           return sidebarItems;
         }
       },
     ],
+    [
+      "@docusaurus/plugin-content-docs",
+      {
+        id: "sdk",
+        path: "sdk",
+        routeBasePath: "sdk",
+        editUrl: "https://github.com/MetaMask/metamask-docs/edit/main/",
+        sidebarPath: require.resolve("./sdk-sidebar.js"),
+        breadcrumbs: false,
+      },
+    ],
     "./src/plugins/plugin-json-rpc.ts",
     isProd
       ? [
@@ -192,9 +203,13 @@ const config = {
           width: 150,
         },
         items: [
+          {
+            to: "sdk",
+            label: "SDK",
+          },
           {
             to: "wallet",
-            label: "Wallet",
+            label: "Wallet API",
           },
           {
             to: "snaps",
@@ -258,6 +273,10 @@ const config = {
           {
             title: "Documentation",
             items: [
+              {
+                label: "SDK",
+                to: "/sdk",
+              },
               {
                 label: "Wallet",
                 to: "/wallet",
@@ -283,6 +302,10 @@ const config = {
                 label: "Documentation GitHub",
                 href: "https://github.com/MetaMask/metamask-docs",
               },
+              {
+                label: "MetaMask Mobile GitHub",
+                href: "https://github.com/MetaMask/metamask-mobile",
+              },
               {
                 label: "MetaMask wallet GitHub",
                 href: "https://github.com/MetaMask/metamask-extension/",
@@ -350,7 +373,7 @@ const config = {
         appId: "AWX4QVM59R",
 
         // Public API key: it is safe to commit it
-        apiKey: "6095a25a6824bfa909fa0692e6847ec4",
+        apiKey: "861f327c200a8eab62a28ee1396f90de",
 
         indexName: "mm--v2-staging",