AppKit and WalletKit have arrived. Explore the all-new product stacks.
Learn more
Blog Home
AppKit
|
August 28, 2024
Rohit Ramesh
Rohit Ramesh
How to get started with AppKit on Scroll
Learn how to use AppKit by WalletConnect to enable wallet connections and interact with the Scroll network.

In this tutorial, you will learn how to:

  1. Set up AppKit by WalletConnect.
  2. Configure a wallet connection modal and enable interactions with the Scroll network.

This guide takes approximately 10 minutes to complete.

Let’s get started!

Setup

With AppKit, you can provide seamless wallet connections, including email and social logins, on-ramp functionality, smart accounts, one-click authentication, and wallet notifications, all designed to deliver an exceptional user experience.

In this section, you'll learn how to set up the development environment to use AppKit with Scroll.

For this tutorial, we'll be using Next.js, though you can use any other framework compatible with AppKit.

Note: AppKit is available on eight frameworks, including React, Next.js, Vue, JavaScript, React Native, Flutter, Android, iOS, and Unity.

Now, let’s create a Next app. In order to do so, please run the command given below:

npx create-next-app@latest appkit-example-scroll

The above command creates a Next app and sets the name of the Next app as appkit-example-scroll.

Install AppKit

Now, we need to install AppKit and other dependencies that we need for our app to function as expected. For this tutorial, we will be using wagmi as our preferred Ethereum library. However, you can also use Ethers.

npm install @web3modal/wagmi wagmi viem @tanstack/react-query

You can also use other package managers such as yarn, bun, pnpm, etc.

Create a new project on WalletConnect Cloud

Now, we need to get a project Id from WalletConnect Cloud that we will use to set up AppKit with Wagmi config. Navigate to cloud.walletconnect.com and sign in. If you have not created an account yet, please do so before we proceed.

After you have logged in, please navigate to the “Projects” section of the Cloud and click on “Create Project”.

Now, enter the name for your project and click on “Continue”.

Select the product as “AppKit” and click on “Continue”.

Select the framework as “Next.js” and click on “Create”. WalletConnect Cloud will now create a new project for you which will also generate a project Id.

You will notice that your project was successfully created. On the top left corner, you will be able to find your Project Id. Please copy that as you will need that later.

Build the App using AppKit

Before we build the app, let’s first configure our .env file. On the root level of your code directory, create a new file named .env.

Open that file and create a new variable NEXT_PUBLIC_PROJECT_ID. You will assign the project Id that you copied in the previous step to this environment variable that you just created. This is what it will look like:

NEXT_PUBLIC_PROJECT_ID = <YOUR_PROJECT_ID_HERE>

Note: Please make sure you follow the best practices when you are working with secret keys and other sensitive information. Environment variables that start with NEXT_PUBLIC will be exposed by your app which can be misused by bad actors.

Configure AppKit

On the root level of your code directory, create a new folder named config and within that folder, create a new code file named config/index.tsx. Now, paste the code snippet shared below inside the code file, i.e., config/index.tsx.

import { defaultWagmiConfig } from "@web3modal/wagmi/react/config";
import { cookieStorage, createStorage } from "wagmi";
import { scroll, scrollSepolia } from "wagmi/chains";

// Get projectId from https://cloud.walletconnect.com
export const projectId = process.env.NEXT_PUBLIC_PROJECT_ID;

if (!projectId) throw new Error("Project ID is not defined");

export const metadata = {
  name: "appkit-example-scroll",
  description: "AppKit Example - Scroll",
  url: "https://scrollapp.com", // origin must match your domain & subdomain
  icons: ["https://avatars.githubusercontent.com/u/37784886"]
};

// Create wagmiConfig
const chains = [scroll, scrollSepolia] as const;
export const config = defaultWagmiConfig({
  chains,
  projectId,
  metadata,
  auth: {
    email: true, // default to true
    socials: ['google', 'x', 'github', 'discord', 'apple', 'facebook', 'farcaster'],
    showWallets: true, // default to true
    walletFeatures: true // default to true
  },
  ssr: true,
  storage: createStorage({
    storage: cookieStorage
  })
});

So what's happening in the above code? Let's understand it step-by-step:

  1. First, we need to import the necessary functions from their respective packages.
  2. a. defaultWagmiConfig - this is used to create a WAGMI configuration with sensible defaults. It sets up the connections, chains, and other necessary configurations for our web3 application.
    b. cookieStorage , createStorage - this provides a storage mechanism using cookies and a function to create custom storage solutions (in this case, using cookies).
    c. scroll , scrollSepolia - these are the networks that we want our app to support. Since we want to enable wallet interactions on the Scroll network, we import both Scroll Mainnet and the Sepolia testnet. You can view the complete list of supported chains here.
  3. metadata - This object contains information about our application that will be used by Web3Modal (AppKit). This includes the name of the app, the description, the url and the icons representing our app.
  4. config - This object is created by calling defaultWagmiConfig with various options such as the chains, projectId, metadata, auth, etc.
  5. auth - this sets authentication features for your app.
    a. email - Enables email-based authentication.
    b. socials - Specifies the social login providers available such as Google, Github, X (Twitter), Discord, Apple, Facebook, and Farcaster.
    c. showWallets - this displays the wallet options to the user.
    d. walletFeatures - this allows users to view their balance, send, receive, and buy funds through a clear user interface.

Create the Modal for your app

Now, we need to create a context provider to wrap our application in and initialize Web3Modal (AppKit).

On the root level of your code directory, create a new folder named context and within that folder, create a new code file named context/index.tsx. Now, paste the code snippet shared below inside the code file, i.e., context/index.tsx.

"use client";

import React, { ReactNode } from "react";
import { config, projectId, metadata } from "@/config";
import { createWeb3Modal } from "@web3modal/wagmi/react";
import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
import { State, WagmiProvider } from "wagmi";

// Setup queryClient
const queryClient = new QueryClient();

if (!projectId) throw new Error("Project ID is not defined");

// Create modal
createWeb3Modal({
  metadata,
  wagmiConfig: config,
  projectId,
  enableAnalytics: true, // Optional - defaults to your Cloud configuration
  enableOnramp: true, // Optional - false as default
  themeMode: "light", // By default - set to user system settings
  themeVariables: {
    "--w3m-font-family": "Verdana", // Base font family
    "--w3m-border-radius-master": "2px",
    "--w3m-z-index": 1
  }
});

export default function Web3ModalProvider({ children, initialState }: { children: ReactNode; initialState?: State }) {
  return (
    <WagmiProvider config={config} initialState={initialState}>
      <QueryClientProvider client={queryClient}>{children}</QueryClientProvider>
    </WagmiProvider>
  );
}

Let’s understand what is happening in the above code:

  1. First, we import the necessary functions from their respective packages. After this, we need to create the modal component for our app.
  2. createWeb3Modal - this is called to initialize the Web3Modal component, which handles the user interface for connecting to blockchain wallets. The function is configured with various options, such as the app's metadata, theming, and enabling features like analytics and onramp services.
  3. The Web3ModalProvider function is used to wrap its children components in two key providers, they are:
    a. WagmiProvider - Provides blockchain and wallet connection context to the app.
    b. QueryClientProvider - Provides the React Query context for managing server-state data.

Now, let’s create the layout for our app. In app/layout.tsx, remove the existing code and paste the code snippet given below.

import type { Metadata } from "next";
import { Inter } from "next/font/google";
import "./globals.css";

const inter = Inter({ subsets: ["latin"] });

import { headers } from "next/headers"; // added
import { cookieToInitialState } from "wagmi"; // added
import { config } from "@/config"; // added
import Web3ModalProvider from "@/context"; // added

export const metadata: Metadata = {
  title: "AppKit + Scroll - Example App",
  description: "Powered by WalletConnect"
};

export default function RootLayout({
  children
}: Readonly<{
  children: React.ReactNode;
}>) {
  const initialState = cookieToInitialState(config, headers().get("cookie")); // added
  return (
    <html lang="en">
      <body className={inter.className}>
        <Web3ModalProvider initialState={initialState}>{children}</Web3ModalProvider>
      </body>
    </html>
  );
}

Create the UI for your app

For our app to have the UI with which your users can interact, you need to set a simple UI and configure the modal. Since, we have already set up Web3Modal (AppKit), you can use <w3m-button> which will serve as a “Connect Wallet” button or you can build your own custom button using the hooks that AppKit provides.

Open the app/page.tsx file and remove the existing boilerplate code, and then replace it with the code snippet given below.

"use client";
import { useAccount } from "wagmi";

export default function Home() {
  const { isConnected } = useAccount();

  return (
    <main className="min-h-screen px-8 py-0 pb-12 flex-1 flex flex-col items-center">
      <header className="w-full py-4 flex justify-between items-center">
        <div className="flex items-center">
          <img src="/walletconnect.png" alt="logo" className="w-10 h-10 mr-2" />
          <div className="hidden sm:inline text-xl font-bold">WalletConnect - AppKit + Scroll</div>
        </div>
      </header>
      <h2 className="my-8 text-2xl font-bold leading-snug text-center">Examples</h2>
      <div className="max-w-4xl">
        <div className="grid bg-white border border-gray-200 rounded-lg overflow-hidden shadow-sm">
          <h3 className="text-sm font-semibold bg-gray-100 p-2 text-center">Connect to Scroll</h3>
          <div className="flex justify-center items-center p-4">
          <w3m-button />
          </div>
        </div> 
        <br></br>
        {isConnected && (
          <div className="grid bg-white border border-gray-200 rounded-lg overflow-hidden shadow-sm">
            <h3 className="text-sm font-semibold bg-gray-100 p-2 text-center">Network selection button</h3>
            <div className="flex justify-center items-center p-4">
              <w3m-network-button />
            </div>
          </div>
        )}
      </div>
    </main>
  );
}

The code above uses the AppKit (Web3Modal) configuration to provide two buttons: one for users to connect their wallet to the app, and another to allow users to switch networks.

You can now run the app and test it out. In order to do so, run the command given below.

npm run dev

Note: If you are using alternative package managers, you can try either of these commands - yarn dev, or pnpm dev, or bun dev.

Conclusion

And that’s it! You have now learned how to create a simple app using AppKit that allows users to connect their wallet and interact with the Scroll network.

You can view the complete code repository below.

https://github.com/rohit-710/appkit-scroll

What's Next?

If you're wondering how to use WalletConnect for various use cases and build apps with great UX, feel free to check out our other blogs below.

https://walletconnect.com/blog

Need help?

For support, please join the official WalletConnect Discord Server.

Recommended Articles
AppKit, WalletKit | May 29, 2024

Read more
alt=""
AppKit | December 15, 2023

Read more
AppKit | July 4, 2024

Read more
More articles
alt=""

Build what's next.
Build with WalletConnect.

Get started

Subscribe to our newsletter

© 2024 WalletConnect, Inc.