Various SDK doc fixes (#2195)

alexandratran · web-flow · commit bd17d742a147 · 2025-08-05T19:15:13.000-07:00
* Various SDK doc fixes

* add SDK methods reference

* add isInitialized()

* minor fix
diff --git a/sdk-sidebar.js b/sdk-sidebar.js
@@ -32,17 +32,8 @@ const sidebar = {
         'guides/handle-transactions',
         'guides/interact-with-contracts',
         'guides/use-deeplinks',
-        {
-          type: 'category',
-          label: 'Advanced',
-          collapsible: true,
-          collapsed: true,
-          items: [
-            'guides/advanced/connect-and-sign',
-            'guides/advanced/batch-requests',
-            'guides/advanced/production-readiness',
-          ],
-        },
+        'guides/batch-requests',
+        'guides/production-readiness',
       ],
     },
     {
@@ -61,6 +52,7 @@ const sidebar = {
         'reference/llm-prompt',
         'reference/supported-platforms',
         'reference/sdk-options',
+        'reference/sdk-methods',
       ],
     },
   ],
diff --git a/sdk/connect/react-native.md b/sdk/connect/react-native.md
@@ -176,7 +176,7 @@ For example:
 import { useSDK } from "@metamask/sdk-react"
 
 function App() {
-  const { connect, disconnect, account, chainId, ethereum } = useSDK()
+  const { connect, terminate, account, chainId, ethereum } = useSDK()
 
   // Connect to MetaMask
   const connectWallet = async () => {
@@ -196,7 +196,7 @@ function App() {
 
   // Disconnect wallet
   const disconnectWallet = async () => {
-    await disconnect()
+    await terminate()
   }
 
   return (
diff --git a/sdk/guides/advanced/connect-and-sign.md b/sdk/guides/advanced/connect-and-sign.md
diff --git a/sdk/guides/authenticate-users.md b/sdk/guides/authenticate-users.md
@@ -1,6 +1,7 @@
 ---
 description: Authenticate users with the SDK in your Wagmi or Vanilla JavaScript dapp.
-toc_max_heading_level: 2
+keywords: [SDK, Wagmi, JavaScript, authenticate, connect, sign, accounts, wallet, dapp]
+toc_max_heading_level: 3
 ---
 
 # Authenticate users
@@ -11,6 +12,7 @@ With the SDK, you can:
 
 - **Connect users' wallets** to your dapp.
 - **Access user accounts** (addresses).
+- [**Connect and sign**](#connect-and-sign) in a single user interaction.
 - **Handle connection states** (connected/disconnected).
 - **Listen for account changes** in real time.
 - **Manage wallet sessions** (connect/disconnect).
@@ -125,6 +127,15 @@ async function connectWallet() {
   }
 }
 
+// Disconnect wallet
+async function disconnectWallet() {
+  try {
+    await MMSDK.terminate()
+  } catch (err) {
+    console.error("Error with disconnecting:", err)
+  }
+}
+
 // Handle account changes
 provider.on("accountsChanged", (accounts) => {
   if (accounts.length === 0) {
@@ -151,6 +162,43 @@ Display connect and disconnect buttons in HTML:
 </div>
 ```
 
+### Connect and sign
+
+If you're not using Wagmi, you can access MetaMask SDK's [`connectAndSign`](../reference/sdk-methods.md#connectandsign) method,
+which requests wallet access and signs the message in a single user interaction.
+For example:
+
+```js
+import { MetaMaskSDK } from "@metamask/sdk"
+
+const MMSDK = new MetaMaskSDK()
+const provider = MMSDK.getProvider()
+
+async function handleConnectAndSign() {
+  try {
+    const signature = await MMSDK.connectAndSign({ msg: "Hello in one go!" })
+    console.log("Signature:", signature)
+  } catch (err) {
+    console.error("Error with connectAndSign:", err)
+  }
+}
+
+document
+  .getElementById("connectSignBtn")
+  .addEventListener("click", handleConnectAndSign)
+```
+
+The following HTML displays a **Connect & Sign** button:
+
+```html
+<button id="connectSignBtn">Connect & Sign</button>
+```
+
+:::tip
+This one-step flow is unique to MetaMask SDK's `connectAndSign` method.
+It's not part of Wagmi or other wallet libraries.
+:::
+
 ## Best practices
 
 Follow these best practices when authenticating users.
diff --git a/sdk/guides/batch-requests.md b/sdk/guides/batch-requests.md
@@ -1,5 +1,6 @@
 ---
 description: Batch multiple JSON-RPC requests using MetaMask SDK or Wagmi.
+keywords: [SDK, Wagmi, batch, JSON-RPC, RPC, requests, methods, dapp]
 ---
 
 # Batch requests
diff --git a/sdk/guides/handle-transactions.md b/sdk/guides/handle-transactions.md
@@ -1,5 +1,6 @@
 ---
 description: Handle transactions with the SDK in your Wagmi or Vanilla JavaScript dapp.
+keywords: [SDK, Wagmi, JavaScript, send, transaction, transactions, status, estimate, gas, dapp]
 toc_max_heading_level: 2
 ---
 
diff --git a/sdk/guides/interact-with-contracts.md b/sdk/guides/interact-with-contracts.md
@@ -1,5 +1,6 @@
 ---
 description: Interact with contracts with the SDK in your Wagmi or Vanilla JavaScript dapp.
+keywords: [SDK, Wagmi, JavaScript, read, write, smart, contract, contracts, dapp]
 sidebar_label: Interact with contracts
 toc_max_heading_level: 2
 ---
diff --git a/sdk/guides/manage-networks.md b/sdk/guides/manage-networks.md
@@ -1,5 +1,6 @@
 ---
 description: Manage networks with the SDK in your Wagmi or Vanilla JavaScript dapp.
+keywords: [SDK, Wagmi, JavaScript, detect, switch, add, network, networks, dapp]
 toc_max_heading_level: 2
 ---
 
diff --git a/sdk/guides/production-readiness.md b/sdk/guides/production-readiness.md
@@ -1,5 +1,6 @@
 ---
 description: MetaMask-specific production readiness checklist for dapps using MetaMask SDK.
+keywords: [SDK, production, readiness, checklist, compatibility, errors, dapp]
 toc_max_heading_level: 2
 ---
 
diff --git a/sdk/guides/use-deeplinks.md b/sdk/guides/use-deeplinks.md
@@ -1,5 +1,6 @@
 ---
-description: Use deeplinks to connect to users' mobile wallets.
+description: Use deeplinks to connect to users' MetaMask mobile wallets.
+keywords: [SDK, deeplink, deeplinks, mobile, dapp]
 toc_max_heading_level: 2
 ---
 
diff --git a/sdk/reference/llm-prompt.md b/sdk/reference/llm-prompt.md
@@ -1,5 +1,6 @@
 ---
 description: Context about MetaMask SDK that can be provided to an LLM.
+keywords: [SDK, LLM, intro, context, integration, dapp]
 ---
 
 # LLM prompt
diff --git a/sdk/reference/sdk-methods.md b/sdk/reference/sdk-methods.md
@@ -0,0 +1,123 @@
+---
+description: Methods reference for MetaMask SDK.
+keywords: [SDK, method, methods, dapp]
+toc_max_heading_level: 2
+---
+
+# SDK methods
+
+MetaMask SDK provides several convenience methods for connecting to and interacting with MetaMask, including the following.
+
+## `connect`
+
+Connects to MetaMask and requests account access.
+
+### Returns
+
+A promise that resolves to an array of account addresses.
+
+### Example
+
+```javascript
+const accounts = await sdk.connect();
+console.log("Connected accounts:", accounts);
+```
+
+## `connectAndSign`
+
+Connects to MetaMask and signs a message in a single operation.
+
+### Parameters
+
+- `msg`: `string` - The message to sign.
+
+### Returns
+
+A promise that resolves to the signature of the signed message.
+
+### Example
+
+```javascript
+const signature = await sdk.connectAndSign({ 
+  msg: "Hello from my dapp!" 
+});
+console.log("Signature:", signature);
+```
+
+## `connectWith`
+
+Connects to MetaMask and executes a specific [JSON-RPC method](/wallet/reference/json-rpc-methods).
+
+### Parameters
+
+- `rpc`: `object` - The RPC method to execute.
+  - `method`: `string` - The RPC method name.
+  - `params`: `any[]` - The parameters for the RPC method.
+
+### Returns
+
+A promise that resolves to the result of the RPC call.
+
+### Example
+
+```javascript
+const result = await sdk.connectWith({
+  rpc: {
+    method: "eth_getBalance",
+    params: ["0x742d35Cc6634C0532925a3b8D4C9db96C4b4d8b6", "latest"]
+  }
+});
+console.log("Balance:", result);
+```
+
+## `getProvider`
+
+Returns the active Ethereum provider object.
+
+### Returns
+
+The active provider, or undefined if no provider is found.
+
+### Example
+
+```javascript
+const provider = sdk.getProvider();
+if (provider) {
+  // Use the provider for RPC calls
+  const accounts = await provider.request({
+    method: "eth_requestAccounts"
+  });
+}
+```
+
+## `isInitialized`
+
+Checks if the SDK has been initialized.
+
+### Returns
+
+`True` if the SDK is initialized, `false` otherwise.
+
+### Example
+
+```javascript
+if (sdk.isInitialized()) {
+  console.log("SDK is ready to use");
+}
+```
+
+## `terminate`
+
+Terminates the MetaMask connection, switching back to the injected provider if connected via extension.
+
+:::note
+The `disconnect()` SDK method is deprecated.
+Use `terminate()` instead.
+:::
+
+### Example
+
+```javascript
+await sdk.terminate();
+console.log("Connection terminated");
+```
diff --git a/sdk/reference/sdk-options.md b/sdk/reference/sdk-options.md
diff --git a/sdk/reference/supported-platforms.md b/sdk/reference/supported-platforms.md
diff --git a/sdk/tutorials/create-wallet-ai-agent.md b/sdk/tutorials/create-wallet-ai-agent.md
diff --git a/vercel.json b/vercel.json
