Guide
API ReferenceSDK Reference

Quickstart

The JustWeb3 Widget is the easiest way to get the best digital identity suite in your dApp.

In under 5 minutes of setup and customization, you can start:

  • Issuing free branded subnames to your userbase

  • Authenticating your users with SIWENS

  • Enabling them to edit and manage their profile in a cryptographically secured way

  • Freeing your dApp from sybil actors with the use of social verifications and ZK-KYC

While we take care of setting up your admin dashboard in the background, to provide you with the best analytics, enabling you to learn about your community and start engaging them via our trusted decentralized mediums.

0. Prerequisites

In order to Integrate the JustWeb3 Widget, your project must run on:

1. Install the JustWeb3 Widget

Install the latest version of the JustWeb3 Widget using your package manager of choice:

npm install @justweb3/widget

2. Create an Account

2.1. Sign Up:

Navigate to the Admin Dashboard and follow the simple sign-up process to create your account.

2.2. Configure ENS Domain:

  • Once your workspace is set up, configure your ENS domain.

  • If you don’t own an ENS domain, you can purchase one during this step.

3. Generate an API Key

After having set up your account, you can now issue an api key:

  • In the dashboard, go to the API Key section.

  • Generate your API key and make sure to save it securely—we won't be able to retrieve it for you later if it’s lost.

Congratulations! You're all set. Now, you can move forward with configuring the widget.

4. Widget Configuration

In your project, import the JustWeb3Provider component and wrap your app with it.

An example set up for a NextJs or a React Vite project, can be found below:

Please note the below example uses RainbowKit. You can replace it with any web3 wallet provider. (WalletConnect, Web3Auth, Privy ...)

'use client';

import "@rainbow-me/rainbowkit/styles.css";
import '@justweb3/widget/styles.css';
import {
  getDefaultConfig,
  getDefaultWallets,
  RainbowKitProvider,
} from "@rainbow-me/rainbowkit";
import {
  argentWallet,
  ledgerWallet,
  trustWallet,
} from "@rainbow-me/rainbowkit/wallets";
import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
import { WagmiProvider } from "wagmi";
import { mainnet, sepolia } from "wagmi/chains";
import {
  JustWeb3Provider,
  JustWeb3ProviderConfig,
  JustWeb3Button,
} from "@justweb3/widget";
import { ConnectButton } from "@rainbow-me/rainbowkit";

export default function Providers({children}: {children: React.ReactNode}) {
 const { wallets } = getDefaultWallets();

  const config = getDefaultConfig({
    appName: "RainbowKit demo",
    projectId: "YOUR_PROJECT_ID",
    wallets: [
      ...wallets,
      {
        groupName: "Other",
        wallets: [argentWallet, trustWallet, ledgerWallet],
      },
    ],
    chains: [mainnet, sepolia],
    ssr: true,
  });

  const justweb3Config: JustWeb3ProviderConfig = {
    config: {
      origin: "http://localhost:3000/",
      domain: "localhost",
      signInTtl: 86400000,
    },
    openOnWalletConnect: true,
    allowedEns: "all",
    logo: "",
    ensDomains: [
      {
        ensDomain: "YOUR ENS DOMAIN",
        apiKey: "YOUR JUSTANAME API KEY",
        chainId: 1,
      },
    ],
    color: {
      primary: "hsl(216, 90%, 58%)",
      background: "hsl(0, 0%, 100%)",
      destructive: "hsl(0, 100%, 50%)",
    },
  };

  const queryClient = new QueryClient();

  return (
    <WagmiProvider config={config}>
      <QueryClientProvider client={queryClient}>
        <RainbowKitProvider>
          <JustWeb3Provider config={justweb3Config}>
            {children}
          </JustWeb3Provider>
        </RainbowKitProvider>
      </QueryClientProvider>
    </WagmiProvider>
  );
};

export default App;

To install the required dependencies, run the following command in your terminal:

npm install wagmi @rainbow-me/rainbowkit @tanstack/react-query

5. You're all set! 🎉

You can find more information on how to customize your widget in the configuration section

Configuration
PreviousOverviewNextOverview

Last updated