Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/random-bits-studio/rainbowkit-use-siwe-auth
https://github.com/random-bits-studio/rainbowkit-use-siwe-auth
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/random-bits-studio/rainbowkit-use-siwe-auth
- Owner: random-bits-studio
- License: mit
- Created: 2022-12-06T20:43:12.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-01-26T07:28:05.000Z (almost 2 years ago)
- Last Synced: 2024-11-01T06:19:22.088Z (about 2 months ago)
- Language: TypeScript
- Size: 1.07 MB
- Stars: 11
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# UseSIWE + RainbowKit = ❤️
This package is a [RainbowKit](https://www.rainbowkit.com) authentication
adapter for [UseSIWE](https://github.com/random-bits-studio/use-siwe).This is by far the easiest way to add Sign-In with Ethereum support to your
application!## Table of Contents
- [Installation](#installation)
- [Getting Started](#getting-started)
- [Setup RainbowKit](#setup-rainbowkit)
- [Setup UseSIWE](#setup-usesiwe)
- [Add the UseSIWE authentication adapter](#add-the-usesiwe-authentication-adapter)
- [Check to see if a user is authenticated](#check-to-see-if-a-user-is-authenticated)## Installation
To install `rainbowkit-use-siwe-auth` and it's dependencies run the following
command:```
npm install @randombits/rainbowkit-use-siwe-auth @randombits/use-siwe @rainbow-me/rainbowkit wagmi ethers iron-session
```## Getting Started
### Setup RainbowKit
Follow the instructions on the [RainbowKit Docs](https://www.rainbowkit.com/docs/installation)
to setup Rainbowkit in your app. In the end you should have an `_app.tsx` (if
using [Next.js](https://nextjs.org)) that looks something like this:```
import '@/styles/globals.css'
import '@rainbow-me/rainbowkit/styles.css'
import type { AppProps } from 'next/app'
import {
getDefaultWallets,
RainbowKitProvider,
} from '@rainbow-me/rainbowkit';
import { configureChains, createClient, WagmiConfig } from 'wagmi';
import { mainnet, polygon, optimism, arbitrum } from 'wagmi/chains';
import { publicProvider } from 'wagmi/providers/public';const { chains, provider } = configureChains(
[mainnet, polygon, optimism, arbitrum],
[publicProvider()]
);const { connectors } = getDefaultWallets({
appName: 'My RainbowKit App',
chains
});const wagmiClient = createClient({
autoConnect: true,
connectors,
provider
})export default function App({ Component, pageProps }: AppProps) {
return (
);
}
```...and you should have added a `` somewhere in your application.
### Setup UseSIWE
Follow the **Getting Started** instructions in the
[UseSIWE Docs](https://github.com/random-bits-studio/use-siwe#getting-started)
for configuring Iron Session, Setting up the API routes, and wrapping your app
with ``.Once completed, your application tree should now contain the following:
```
my-project
├── lib
│ └── ironOptions.ts <----
├── package.json
├── pages
│ ├── _app.tsx
│ ├── _document.tsx
│ ├── api
│ │ ├── auth
│ │ │ └── [[...route]].ts <----
│ │ └── hello.ts
│ └── index.tsx
├── public
└── styles
```...and the providers wrapping your application should look like this:
```
export default function App({ Component, pageProps }: AppProps) {
return (
);
}
```### Add the UseSIWE authentication adapter
One more provider and this pyramid is complete! Add the
`RainbowKitUseSiweProvider` inside of the `SiweProvider` so that it contains
the `RainbowKitProvider`. Example below:```
import RainbowKitUseSiweProvider from '@randombits/rainbowkit-use-siwe-auth';export default function App({ Component, pageProps }: AppProps) {
return (
);
}
```**Technically thats it!** Now when you run your app and click on the
`ConnectButton` and connect a wallet, a second modal will pop up asking you to
sign a message to complete the SIWE flow.To learn how to check if a user is authenticated, read on!
### Check to see if a user is authenticated
#### Client-side
Check to see is a user is authenticated with the `useSession` hook from
[UseSiwe](https://github.com/random-bits-studio/use-siwe) like in the example
below:```
import { useSession } from "@randombits/use-siwe";export const AuthCheck = () => {
const { isLoading, authenticated, address } = useSession();if (isLoading) return
Loading...
;
if (!authenticated) returnNot authenticated
;
return{address} is Authenticated
;
};
```#### Server-side
For API routes, wrap your API handler with `withIronSessionApiRoute` and check
to see if `req.session.address` is set. If a user is authenticated,
`req.session.address` will be set to their address, otherwise it will be
`undefined`.```
import ironOptions from '@/lib/ironOptions'
import { withIronSessionApiRoute } from 'iron-session/next/dist'
import type { NextApiHandler } from 'next'const handler: NextApiHandler = (req, res) => {
if (!req.session.address) return res.status(401).send("Unauthorized");
res.status(200).send(`Hello, ${req.session.address}!`);
}export default withIronSessionApiRoute(handler, ironOptions);
```### Taking action on Sign-In and Sign-Out
The `RainbowKitUseSiweProvider` component takes two optional props; `onSignIn`
and `onSignOut`. You may pass a function that will be called after a successful
sign-in or sign-out; for instance to redirect a user to a different page.```
import RainbowKitUseSiweProvider from '@randombits/rainbowkit-use-siwe-auth';
import { useRouter } from 'next/router';export default function App({ Component, pageProps }: AppProps) {
const router = useRouter();
const onSignIn = () => router.push('/dashboard');
const onSignOut = () => router.push('/');return (
);
}
```