Skip to main content

JavaScript + Wagmi (recommended)

Get started with MetaMask SDK in a JavaScript and Wagmi dapp.

You can use the quickstart template, which automatically sets up the SDK with a Next.js and Wagmi dapp. You can also manually set up the SDK in an existing dapp.


Quickstart

Features

  • Wallet connection - Connect to the MetaMask wallet seamlessly.
  • Network switching - Switch between Ethereum networks like Linea Sepolia, Linea, and Mainnet.
  • Interactive UI - Responsive design with interactive cards guiding users.
  • Modular components - Easy-to-understand and customizable components.

Set up using a template​

  1. Download the template from the SDK examples repository:

    git clone https://github.com/metamask/metamask-sdk-examples.git

  2. Navigate into the quickstart example:

    cd metamask-sdk-examples/examples/quickstart/

  3. Install dependencies:

    pnpm install

  4. Run the project:

    pnpm dev

You've successfully set up MetaMask SDK with Wagmi. You can now add your own functionality.

Set up manually​

1. Install the SDK​

Install MetaMask SDK along with its peer dependencies to an existing React project:

pnpm install @metamask/sdk wagmi viem@2.x @tanstack/react-query

2. Import required dependencies​

In the root of your project, import the required dependencies:

import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
import { http, WagmiProvider, createConfig } from "wagmi";
import { mainnet, linea, lineaSepolia } from "wagmi/chains";
import { metaMask } from "wagmi/connectors";

3. Configure your project​

Set up your configuration with the desired chains and connectors. For example:

const config = createConfig({
  ssr: true, // Make sure to enable this for server-side rendering (SSR) applications.
  chains: [mainnet, linea, lineaSepolia],
  connectors: [metaMask()],
  transports: {
    [mainnet.id]: http(),
    [linea.id]: http(),
    [lineaSepolia.id]: http(),
  },
});

4. Set up providers​

Wrap your application with the necessary providers:

const client = new QueryClient();

const App = () => {
  return (
    <WagmiProvider config={config}>
      <QueryClientProvider client={client}>
        <Component {...pageProps} />
      </QueryClientProvider>
    </WagmiProvider>
  );
}

5. Add the connect button​

Add the wallet connect and disconnect buttons to your application:

import { useAccount, useConnect, useDisconnect } from "wagmi"

export const ConnectButton = () => {
  const { address } = useAccount()
  const { connectors, connect } = useConnect()
  const { disconnect } = useDisconnect()

  return (
    <div>
      {address ? (
        <button onClick={() => disconnect()}>Disconnect</button>
      ) : (
        connectors.map((connector) => (
          <button key={connector.uid} onClick={() => connect({ connector })}>
            {connector.name}
          </button>
        ))
      )}
    </div>
  )
}

Once you've added the connect button, you can test your dapp by running npm run dev or pnpm run dev or yarn dev. It should work with the MetaMask browser extension installed or MetaMask Mobile.

Production readiness​

tip

For production deployments, it's important to use reliable RPC providers instead of public nodes. We recommend using services like MetaMask Developer to ensure better reliability and performance.

You can configure your RPC endpoints in the Wagmi configuration as follows:

const config = createConfig({
  // ... other config options
  transports: {
    [mainnet.id]: http("https://mainnet.infura.io/v3/<YOUR-API-KEY>"),
    [sepolia.id]: http("https://sepolia.infura.io/v3/<YOUR-API-KEY>"),
  },
});

Sign up to MetaMask Developer for a free account and get your API key.

Add your own functionality​

After completing the basic setup, you can follow these guides to add your own functionality:

More examples​

See the metamask-sdk-examples GitHub repository for more examples.