rainbowkit-siwe-next-auth

Sign-In with Ethereum and NextAuth.js authentication adapter for RainbowKit.

This package is designed to work with the official Sign-In with Ethereum boilerplate for NextAuth.js.

Usage

Set up Sign-In with Ethereum and NextAuth.js

If you haven't already, first set up your Next.js project with the official Sign-In with Ethereum boilerplate for NextAuth.js.

Install

Install the @merkletrade/rainbowkit-siwe-next-auth package and its peer dependency, ethers.

npm install @merkletrade/rainbowkit-siwe-next-auth siwe@^2 ethers@^5

Note: siwe requires the ethers peer dependency, while wagmi now relies on the alternative viem.

Set up the provider

In your App component, import RainbowKitSiweNextAuthProvider.

import { RainbowKitSiweNextAuthProvider } from '@merkletrade/rainbowkit-siwe-next-auth';

Wrap RainbowKitProvider with RainbowKitSiweNextAuthProvider, ensuring it's nested within NextAuth's SessionProvider so that it has access to the session.

import { RainbowKitSiweNextAuthProvider } from '@merkletrade/rainbowkit-siwe-next-auth';
import { RainbowKitProvider } from '@merkletrade/rainbowkit';
import { SessionProvider } from 'next-auth/react';
import type { Session } from 'next-auth';
import { AppProps } from 'next/app';
import { WagmiConfig } from 'wagmi';

export default function App({
  Component,
  pageProps,
}: AppProps<{
  session: Session;
}>) {
  return (
    <WagmiConfig {...etc}>
      <SessionProvider refetchInterval={0} session={pageProps.session}>
        <RainbowKitSiweNextAuthProvider>
          <RainbowKitProvider {...etc}>
            <Component {...pageProps} />
          </RainbowKitProvider>
        </RainbowKitSiweNextAuthProvider>
      </SessionProvider>
    </WagmiConfig>
  );
}

With RainbowKitSiweNextAuthProvider in place, your users will now be prompted to authenticate by signing a message once they've connected their wallet.

Customize the SIWE message options

You can customize the SIWE message options by passing a function to the getSiweMessageOptions prop on RainbowKitSiweNextAuthProvider.

This function will be called whenever a new message is created. Options returned from this function will be merged with the defaults.

import {
  RainbowKitSiweNextAuthProvider,
  GetSiweMessageOptions,
} from '@merkletrade/rainbowkit-siwe-next-auth';

const getSiweMessageOptions: GetSiweMessageOptions = () => ({
  statement: 'Sign in to my RainbowKit app',
});

<RainbowKitSiweNextAuthProvider getSiweMessageOptions={getSiweMessageOptions}>
  ...
</RainbowKitSiweNextAuthProvider>;

Access the session server-side

You can access the session token with NextAuth's getToken function imported from next-auth/jwt. If the user has successfully authenticated, the session token's sub property (the "subject" of the token, i.e. the user) will be the user's address.

You can also pass down the resolved session object from the server via getServerSideProps so that NextAuth doesn't need to resolve it again on the client.

For example:

import { GetServerSideProps, InferGetServerSidePropsType } from 'next';
import { getSession } from 'next-auth/react';
import { getToken } from 'next-auth/jwt';
import React from 'react';

export const getServerSideProps: GetServerSideProps = async context => {
  const session = await getSession(context);
  const token = await getToken({ req: context.req });

  const address = token?.sub ?? null;
  // If you have a value for "address" here, your
  // server knows the user is authenticated.

  // You can then pass any data you want
  // to the page component here.
  return {
    props: {
      address,
      session,
    },
  };
};

type AuthenticatedPageProps = InferGetServerSidePropsType<
  typeof getServerSideProps
>;

export default function AuthenticatedPage({ address }: AuthenticatedPageProps) {
  return address ? (
    <h1>Authenticated as {address}</h1>
  ) : (
    <h1>Unauthenticated</h1>
  );
}

For more information about managing the session, you can refer to the following documentation:

• Next.js authentication guide
• NextAuth.js documentation

Contributing

Please follow our contributing guidelines.

License

Licensed under the MIT License, Copyright © 2022-present Rainbow.

See LICENSE for more information.