Skip to content
Draft
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
0b79037
SDK new structure PoC
alexandratran Sep 23, 2025
44a6248
edits
alexandratran Sep 24, 2025
f234baf
remove custom reference component
alexandratran Sep 24, 2025
f331654
edits
alexandratran Sep 25, 2025
e2f4b8b
Merge branch 'main' into sdk-new-structure
alexandratran Sep 30, 2025
ef20ee1
fix links, update redirects, "metamask wallet sdk"
alexandratran Sep 30, 2025
39b9b16
Merge branch 'main' into sdk-new-structure
alexandratran Oct 16, 2025
905d9a8
add simplified api reference with two examples
alexandratran Oct 18, 2025
549887c
missing files
alexandratran Oct 18, 2025
1b97b2c
Merge branch 'main' into sdk-new-structure
alexandratran Oct 20, 2025
bb103fb
remove starknet docs
alexandratran Oct 21, 2025
8216d8b
copy over solana docs
alexandratran Oct 21, 2025
34aed2c
Merge branch 'main' into sdk-new-structure
alexandratran Oct 22, 2025
d64e8a4
Merge branch 'main' into sdk-new-structure
alexandratran Oct 23, 2025
e02092a
Update terminology and restructure EVM docs
alexandratran Oct 23, 2025
956c09a
fix broken links
alexandratran Oct 23, 2025
86d2dfc
Merge branch 'main' into sdk-new-structure
alexandratran Nov 4, 2025
f70f940
fix broken links
alexandratran Nov 4, 2025
e1e0008
Add/update Solana Wallet Adapter docs (#2443)
alexandratran Nov 7, 2025
37a4d06
Merge branch 'main' into sdk-new-structure
alexandratran Nov 10, 2025
30d0439
Update mobile products menu
alexandratran Nov 10, 2025
3db005f
Update MM Connect EVM JS code samples with potential new usage (#2454)
alexandratran Nov 12, 2025
d122361
Merge branch 'main' into sdk-new-structure
alexandratran Nov 13, 2025
360383d
Remove ParserOpenRPC component and replace usage in Linea services
alexandratran Nov 14, 2025
98476fe
Merge branch 'main' into sdk-new-structure
alexandratran Nov 18, 2025
c04fb6d
fix broken link
alexandratran Nov 18, 2025
b034e01
Add more multichain info (#2479)
alexandratran Nov 18, 2025
77bb9a9
Merge branch 'main' into sdk-new-structure
alexandratran Nov 27, 2025
b4716d6
Enhance JS section {WIP} (#2450)
shahbaz17 Nov 27, 2025
2a6e4ab
Add view & wagmi options
shahbaz17 Nov 27, 2025
6cf2880
Merge branch 'main' into sdk-new-structure
alexandratran Nov 28, 2025
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
Prev Previous commit
Next Next commit
edits
  • Loading branch information
alexandratran committed Sep 24, 2025
commit 44a62485b0c0ba1b9614ba9c3a6df5994985645a
18 changes: 15 additions & 3 deletions sdk-sidebar.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,21 @@

/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sdkSidebar = {
multichain: [
overview: [
'index',
'about',
{
type: 'category',
label: 'Reference',
collapsible: false,
collapsed: false,
items: [
'reference/sdk-options',
],
},
],
multichain: [
'multichain/index',
{
type: 'category',
label: 'Guides',
Expand All @@ -12,6 +25,7 @@ const sdkSidebar = {
items: [
'multichain/connect/guides/connect-to-multichain',
'multichain/connect/guides/send-transactions',
'multichain/connect/guides/connector-libraries',
],
},
{
Expand Down Expand Up @@ -125,7 +139,6 @@ const sdkSidebar = {
collapsible: false,
collapsed: false,
items: [
'evm/connect/reference/sdk-options',
'evm/connect/reference/sdk-methods',
'evm/connect/reference/provider-api',
{
Expand All @@ -141,7 +154,6 @@ const sdkSidebar = {
],
solana: [
'solana/index',
'solana/connect/wallet-standard',
],
starknet: [
'starknet/index',
Expand Down
26 changes: 26 additions & 0 deletions sdk/about.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# About the SDK

## Architecture

## Supported platforms

With MetaMask SDK, you can connect your dapp to MetaMask in the following ways:

- **Desktop web dapps** - Automatically connect to the MetaMask extension, or connect to the MetaMask mobile app using a QR code.
- **Mobile dapps** - The SDK generates a deeplink that takes users directly to the MetaMask mobile app.

The following table expands on the SDK's connection methods:

| Dapp location | User wallet location | Connection method | MetaMask SDK | Other SDKs |
|---------------|-------------|------------------|--------------------------|--------------------------|
| Desktop web | Wallet browser extension | Automatic connection via browser extension | Supported | Supported |
| Desktop web | Wallet mobile app | QR code scan with wallet mobile app | Supported | Limited |
| Mobile browser | Wallet mobile app | Deeplink directly to wallet mobile app | Supported | Limited |
| Mobile dapp | Wallet mobile app | Deeplink directly to wallet mobile app | Supported | Limited |

<br />

:::tip
For a better user experience on mobile, it's important to use reliable RPC providers instead of public nodes.
We recommend using services like [MetaMask Developer](https://developer.metamask.io/) to ensure better reliability and performance.
:::
1 change: 0 additions & 1 deletion sdk/evm/connect/index.md

This file was deleted.

45 changes: 42 additions & 3 deletions sdk/evm/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,47 @@
sidebar_label: Introduction
---

# MetaMask SDK for EVM networks
import CardList from '@site/src/components/CardList'

## MM Connect
# Connect to EVM networks

## MM Pay
## Supported platforms and libraries

MetaMask SDK is available in a variety of ways to make integration as easy as possible.
You can access it directly via npm, through popular developer libraries like Wagmi, or as part of popular convenience libraries.

<CardList
items={[
{
href: '/sdk/connect/javascript-wagmi',
title: 'JavaScript + Wagmi (recommended)',
description: 'Use the CLI or template to set up the SDK in a Next.js and Wagmi dapp.',
},
{
href: '/sdk/connect/javascript',
title: 'JavaScript',
description: 'Set up the SDK in a JavaScript dapp.',
},
{
href: '/sdk/connect/react-native',
title: 'React Native',
description: 'Set up the SDK in a React Native or Expo dapp.',
},
{
href: '/sdk/connect/javascript-dynamic',
title: 'Dynamic SDK',
description: 'Use the CLI or template to set up Dynamic SDK in a Next.js dapp. Use MetaMask SDK features with Dynamic.',
},
{
href: '/sdk/connect/javascript-web3auth',
title: 'Web3Auth SDK',
description: 'Use the CLI or template to set up Web3Auth SDK in a Next.js dapp. Use MetaMask SDK features with Web3Auth.',
},
{
href: 'https://onboard.blocknative.com',
title: 'Web3-Onboard',
description: 'Use SDK features with Web3-Onboard.',
buttonIcon: 'external-arrow',
}
]}
/>
84 changes: 25 additions & 59 deletions sdk/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,81 +4,47 @@ description: Introduction page for MetaMask SDK documentation.
keywords: [connect, sdk, integrate, dapp]
---

import Button from '@site/src/components/elements/buttons/button'
import CardList from '@site/src/components/CardList'

# Seamlessly connect to MetaMask using the SDK

MetaMask SDK enables a fast, reliable, and seamless connection from your dapp to the MetaMask extension and MetaMask mobile app.
With the SDK, you can easily onboard users and interact with their accounts on desktop or mobile, across all EVM networks.

<p align="center">
<Button
as="a"
href="/sdk/connect/javascript-wagmi"
label="Get started with the SDK"
icon="arrow-right"
style={{
'--button-color-hover': 'var(--general-black)',
'--button-text-color-hover': 'var(--general-white)',
}}
/>
</p>

## Why use the SDK?

MetaMask SDK gives your dapp a powerful upgrade:

- **Cross-platform, cross-browser support** - One integration covers both desktop and mobile, all major browsers, and the MetaMask mobile app—streamlining your user onboarding and eliminating edge cases.
- **Mobile connection that just works** - Say goodbye to clunky "open in in-app browser" flows.
The SDK enables a native connection from any mobile browser (Safari, Chrome, etc.) directly to the MetaMask mobile app, using secure deeplinking and session management.
- **Production-ready, battle-tested** - MetaMask SDK is used in high-volume dapps across DeFi, NFTs, gaming, and more—ensuring stability, speed, and a smooth developer experience.
- **Multichain-ready by design** - Today, the SDK supports all EVM networks.
Coming soon: Seamless connection to non-EVM chains like Solana and Bitcoin.
Futureproof your dapp with a single integration.

## Supported platforms and libraries

MetaMask SDK is available in a variety of ways to make integration as easy as possible.
You can access it directly via npm, through popular developer libraries like Wagmi, or as part of popular convenience libraries.
With the SDK, you can easily onboard users and interact with their accounts on desktop or mobile.
Get started with the following networks:

<CardList
items={[
{
href: '/sdk/connect/javascript-wagmi',
title: 'JavaScript + Wagmi (recommended)',
description: 'Use the CLI or template to set up the SDK in a Next.js and Wagmi dapp.',
href: '/sdk/multichain',
title: 'Multichain',
description: 'Connect to multiple ecosystems at the same time.',
},
{
href: '/sdk/connect/javascript',
title: 'JavaScript',
description: 'Set up the SDK in a JavaScript dapp.',
href: '/sdk/evm',
title: 'EVM networks',
description: 'Connect to Ethereum and other EVM networks.',
},
{
href: '/sdk/connect/javascript-dynamic',
title: 'Dynamic SDK',
description: 'Use the CLI or template to set up Dynamic SDK in a Next.js dapp. Use MetaMask SDK features with Dynamic.',
href: '/sdk/solana',
title: 'Solana',
description: 'Connect to Solana.',
},
{
href: '/sdk/connect/javascript-web3auth',
title: 'Web3Auth SDK',
description: 'Use the CLI or template to set up Web3Auth SDK in a Next.js dapp. Use MetaMask SDK features with Web3Auth.',
},
{
href: '/sdk/connect/react-native',
title: 'React Native',
description: 'Set up the SDK in a React Native or Expo dapp.',
},
{
href: 'https://onboard.blocknative.com',
title: 'Web3-Onboard',
description: 'Use SDK features with Web3-Onboard.',
buttonIcon: 'external-arrow',
href: '/sdk/starknet',
title: 'Starknet',
description: 'Connect to Starknet.',
}
]}
/>

:::tip Build embedded wallet experiences that work seamlessly with MetaMask
Introducing our latest [Embedded Wallets SDK](connect/javascript-web3auth.md) (Web3Auth), you can now onboard users
instantly and design seamless onchain experiences with social logins, passkeys and more.
:::
## Why use the SDK?

MetaMask SDK gives your dapp a powerful upgrade:

- **Cross-platform, cross-browser support** - One integration covers both desktop and mobile, all major browsers, and the MetaMask mobile app—streamlining your user onboarding and eliminating edge cases.
- **Mobile connection that just works** - Say goodbye to clunky "open in in-app browser" flows.
The SDK enables a native connection from any mobile browser (Safari, Chrome, etc.) directly to the MetaMask mobile app, using secure deeplinking and session management.
- **Production-ready, battle-tested** - MetaMask SDK is used in high-volume dapps across DeFi, NFTs, gaming, and more—ensuring stability, speed, and a smooth developer experience.
- **Multichain by design** - Today, the SDK supports all EVM networks and Solana.
Coming soon: Seamless connection to more ecosystems like Bitcoin and Tron.
Futureproof your dapp with a single integration.
2 changes: 1 addition & 1 deletion sdk/multichain/connect/guides/connect-to-multichain.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# Connect to multiple chains
# Connect to EVM and Solana
1 change: 1 addition & 0 deletions sdk/multichain/connect/guides/connector-libraries.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Connector library guide
6 changes: 5 additions & 1 deletion sdk/multichain/connect/guides/send-transactions.md
Original file line number Diff line number Diff line change
@@ -1 +1,5 @@
# Send multichain transactions
---
sidebar_label: Send transactions
---

# Send transactions to EVM and Solana
1 change: 0 additions & 1 deletion sdk/multichain/connect/index.md

This file was deleted.

6 changes: 6 additions & 0 deletions sdk/multichain/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
sidebar_label: Introduction
---

# Connect to multiple ecosystems

1 change: 0 additions & 1 deletion sdk/solana/connect/index.md

This file was deleted.

33 changes: 0 additions & 33 deletions sdk/solana/connect/wallet-standard.md

This file was deleted.

30 changes: 29 additions & 1 deletion sdk/solana/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,32 @@
sidebar_label: Introduction
---

# MetaMask SDK for Solana
# Connect to Solana

[Solana](https://solana.com/) is a high-performance network that provides fast transaction speeds and low fees.
You can interact with users' Solana accounts in MetaMask using the [Wallet Standard](#wallet-standard) or [third-party libraries](#third-party-libraries) for Solana dapps.

:::note Supported Solana networks
MetaMask supports Solana Mainnet.
Solana Devnet is only supported on [MetaMask Flask](/snaps/get-started/install-flask).
After adding Solana to MetaMask Flask, [show test networks](https://support.metamask.io/configure/networks/how-to-view-testnets-in-metamask/) to view Solana Devnet.
:::

## Wallet Standard

MetaMask implements the [Wallet Standard](https://github.com/wallet-standard/wallet-standard), so MetaMask is supported out-of-the-box for Solana dapps that use the Wallet Standard or that integrate Solana's [Wallet Adapter](https://github.com/anza-xyz/wallet-adapter/blob/master/APP.md).

Learn more in Solana's [Interact With Wallets](https://solana.com/developers/courses/intro-to-solana/interact-with-wallets) documentation.

:::note
With the Wallet Standard, MetaMask does not appear as a connection option for users that don't already have MetaMask installed.
Ask the MetaMask team on [Discord](https://discord.gg/consensys) if you need support for a custom integration.
:::

## Third-party libraries

Several third-party libraries for Solana dapps detect and handle MetaMask out-of-the-box, including:

- [Dynamic](https://docs.dynamic.xyz/introduction/welcome)
- [Privy](https://docs.privy.io/welcome)
- [Reown](https://docs.reown.com/overview)
4 changes: 2 additions & 2 deletions sdk/starknet/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ sidebar_label: Introduction
description: Interact with users' Starknet accounts in MetaMask.
---

# Starknet
# Connect to Starknet

[Starknet](https://www.starknet.io/) is a non-EVM Layer 2 network.
[Starknet](https://www.starknet.io/) is a Layer 2 network.
You can interact with users' Starknet accounts in MetaMask by connecting to the
[Starknet Snap](https://snaps.metamask.io/snap/npm/consensys/starknet-snap/).
You can use the [`get-starknet`](https://github.com/starknet-io/get-starknet) library or the
Expand Down
10 changes: 6 additions & 4 deletions src/components/CustomReferencePage/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,12 @@ function transformItems(items, dynamicItems) {
if (newItem.href.endsWith('/index')) {
newItem.href = newItem.href.slice(0, -5)
}
if (newItem.href === '/') {
newItem.href = '/sdk/'
} else {
newItem.href = `/sdk${newItem.href}`
if (!newItem.href.startsWith('/sdk')) {
if (newItem.href === '/') {
newItem.href = '/sdk/'
} else {
newItem.href = `/sdk${newItem.href}`
}
}
}
return newItem
Expand Down
Loading
Loading