Important
This repository is outdated and no longer maintained. But we have something better for you!
Head over to this new repository: gated-site-example
The idea is that, once you have got the user's wallet on the server-side, the use cases are not limited to just token-balance checking, you can basically do anything you want.
Important
This repository is referencing the mumbai chain.
Mumbai is deprecated since 08/04/2024, meaning the code in this repository will no longer work out of the box.
You can still use this repository, however you will have to switch any references to mumbai to another chain.
This project demonstrates how you can restrict content on your website to only those users who own a token of your choice (any ERC-20, ERC-721 or ERC-1155).
You can use any token you like regardless if it's deployed using thirdweb or not. However, if the contract wasn't deployed on thirdweb initially, make sure you import the contract on the thirdweb dashboard.
Install the template with thirdweb create
npx thirdweb create --template nft-gated-website- Deploy or import an already deployed token contract on thirdweb dashboard.
- Update the information in the yourDetails.js file to use your contract address and auth domain name.
To run this project, you will need to add the following environment variables to your .env file:
THIRDWEB_AUTH_PRIVATE_KEY=
NEXT_PUBLIC_TEMPLATE_CLIENT_ID=
TW_SECRET_KEY=- Generate your
TW_SECRET_KEYandNEXT_PUBLIC_TEMPLATE_CLIENT_IDvia thirdweb's dashboard. - For
THIRDWEB_AUTH_PRIVATE_KEYexport your wallet private key from your wallet.
Install dependencies:
yarnStart the server:
yarn startUsing Auth, we can verify a user's identity on the server-side, by asking them to sign a message and verify they own the wallet they claim to be, and validating the signature.
When we verified the user's identity on the server-side, we check their wallet to see if they have an NFT from our collection. We can then serve different content and restrict what pages they can access based on their NFT balance.
// This is the chain your dApp will work on.
const activeChain = "mumbai";
function MyApp({ Component, pageProps }) {
return (
<ThirdwebProvider
activeChain={activeChain}
authConfig={{
domain: domainName,
authUrl: "/api/auth",
}}
>
<Head>
<title>NFT Gated Website</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta
name="description"
content="Learn how to use the thirdweb Auth SDK to create an NFT Gated Website"
/>
</Head>
<Component {...pageProps} />
</ThirdwebProvider>
);
}
export default MyApp;Next, we need to create a configuration file that contains our wallet's private key (used to generate messages for users to sign) and our site's domain name:
This file is called auth.config.js and is at the root of the project.
import { ThirdwebAuth } from "@thirdweb-dev/auth/next";
import { PrivateKeyWallet } from "@thirdweb-dev/auth/evm";
import { domainName } from "./const/yourDetails";
export const { ThirdwebAuthHandler, getUser } = ThirdwebAuth({
domain: domainName,
wallet: new PrivateKeyWallet(process.env.THIRDWEB_AUTH_PRIVATE_KEY || ""),
});Finally, we have a catch-all API route called pages/api/auth/[...thirdweb].js, which exports the ThirdwebAuthHandler to manage all of the required auth endpoints like login and logout.
import { ThirdwebAuthHandler } from "../../../auth.config";
export default ThirdwebAuthHandler();To begin with, the user will reach the website with no authentication.
When they try to access the restricted page (the / route), we use getServerSideProps to check two things:
- If the user is currently authenticated (using
getUser). - If the user's wallet balance is greater than
minTokensRequiredprovided inyourDetails.jsof the NFTs in our NFT collection.
If either of these checks is false, we redirect the user to the /login page before they are allowed to access the restricted page.
Let's break that down into steps:
Inside the _app.jsx file, we configure the Auth SDK in the ThirdwebProvider component that wraps our application, allowing us to use the hooks of the SDK throughout our application:
First, we check if this user has already been authenticated.
If this is the first time the user has visited the website, they will not have an access_token cookie.
// This gets called on every request
export async function getServerSideProps(context) {
const user = await getUser(context.req);
if (!user) {
return {
redirect: {
destination: "/login",
permanent: false,
},
};
}
// ...
}If the user is not authenticated, then we don't check the user's wallet balance; we just immediately redirect them to the /login page.
If there is a detected user from getUser, we can then check their balance.
Now we're ready to check the user's wallet balance.
To do this, we have created a utility function called checkBalance that we can use to check the user's balance for a given NFT.
import { isFeatureEnabled } from "@thirdweb-dev/sdk";
import {
contractAddress,
erc1155TokenId,
minimumBalance,
} from "../const/yourDetails";
export default async function checkBalance(sdk, address) {
const contract = await sdk.getContract(
contractAddress // replace this with your contract address
);
let balance;
if (isFeatureEnabled(contract.abi, "ERC1155")) {
balance = await contract.erc1155.balanceOf(address, erc1155TokenId);
} else if (isFeatureEnabled(contract.abi, "ERC721")) {
balance = await contract.erc721.balanceOf(address);
} else if (isFeatureEnabled(contract.abi, "ERC20")) {
balance = (await contract.erc20.balanceOf(address)).value;
return balance.gte((minimumBalance * 1e18).toString());
}
// gte = greater than or equal to
return balance.gte(minimumBalance);
}This function will check the type of contract being used, check the balance accordingly and returns true or false that we can store in a variable:
const hasNft = await checkBalance(sdk, address);Here's our final check, if the user has a balance of 0, then we redirect them to the /login page.
// If they don't have an NFT, redirect them to the login page
if (!hasNft) {
return {
redirect: {
destination: "/login",
permanent: false,
},
};
}If the user gets past these checks, then we allow them to view the restricted page.
// Finally, return the props
return {
props: {},
};We've now successfully restricted access to our home page, now let's explore the /login page.
We use the ConnectWallet component to handle the connection to the user's wallet, signing in, and signing out.
<ConnectWallet />Contributions and feedback are always welcome!
Please visit our open source page for more information.
For help, join the discord or visit our support page.