Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mandeepsinghmar/project_course_thirdweb


https://github.com/mandeepsinghmar/project_course_thirdweb

Last synced: about 1 month ago
JSON representation

Awesome Lists containing this project

README 

        
# NFT Gated Website



This project demonstrates how you can restrict content on your website to only those users who own an NFT from your collection.



We use an [Edition Drop](https://portal.thirdweb.com/pre-built-contracts/edition-drop) contract to enable users to claim one of the NFTs, and serve users

the restricted content if they have at least one of the NFTs claimed.



## Tools:



- [React SDK](https://docs.thirdweb.com/react): To access the connected wallet, switch the user's network, and claim an NFT from our Edition Drop collection.

- [Auth](https://portal.thirdweb.com/building-web3-apps/authenticating-users): To ask users to sign a message and verify they own the wallet they claim to be, while on the server-side.



## Using This Template



Create a project using this example:



```bash

npx thirdweb create --template nft-gated-website

```



- Create an [Edition Drop](https://thirdweb.com/contracts/new/pre-built/drop/edition-drop) contract using the dashboard.

- Update the information in the [yourDetails.js](./const/yourDetails.js) file to use your contract address and auth domain name.

- Add your wallet's private key as an environment variable in a `.env.local` file called `PRIVATE_KEY`:



```text title=".env.local"

THIRDWEB_AUTH_PRIVATE_KEY=your-wallet-private-key

```



## How It Works



Using [Auth](https://portal.thirdweb.com/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.



```jsx

function MyApp({ Component, pageProps }) {

  return (

    

      

    

  );

}



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.



```jsx

import { ThirdwebAuth } from "@thirdweb-dev/auth/next";

import { domainName } from "./const/yourDetails";



export const { ThirdwebAuthHandler, getUser } = ThirdwebAuth({

  privateKey: process.env.THIRDWEB_AUTH_PRIVATE_KEY || "",

  domain: domainName,

});

```



Finally, we have a [catch-all API route](https://nextjs.org/docs/api-routes/dynamic-api-routes#catch-all-api-routes) called `pages/api/auth/[...thirdweb].js`, which exports the `ThirdwebAuthHandler` to manage all of the required auth endpoints like `login` and `logout`.



```jsx

import { ThirdwebAuthHandler } from "../../../auth.config";



export default ThirdwebAuthHandler();

```



## Restricting Access



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](https://nextjs.org/docs/basic-features/data-fetching/get-server-side-props) to check two things:



1. If the user is currently authenticated (using `getUser`).

2. If the user's wallet balance is greater than `0` of 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:



### Setting Up the Auth SDK



Inside the [\_app.jsx](./pages/_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:



### Checking For Authentication Token



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.



```js

// 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.



### Checking Wallet Balance



Now we're ready to check the user's wallet balance.



To do this, we have created a utility function called [checkBalance](./util/checkBalance.js) that we can use to check the user's balance for a given NFT.



```js

import { contractAddress } from "../const/yourDetails";



export default async function checkBalance(sdk, address) {

  const editionDrop = sdk.getEditionDrop(

    contractAddress // replace this with your contract address

  );



  // Here, "0" is checking the balance of token ID 0.

  const balance = await editionDrop.balanceOf(address, 0);



  // gt = greater than

  return balance.gt(0);

}

```



This function returns true or false that we can store in a variable:



```js

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.



```js

// 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.



```js

// Finally, return the props

return {

  props: {},

};

```



## Signing In



We've now successfully restricted access to our home page, now let's explore the `/login` page.



First, we ask the user to connect their wallet with our `useMetaMask` hook:



```js

const connectWithMetamask = useMetamask();



// ...



 connectWithMetamask()}>Connect Wallet;

```



Once an `address` is detected from the `useAddress` hook, we show them the `Sign In` button:



```js

{

  address ? (

    <>

      Sign In

    >

  ) : (

    <>

       connectWithMetamask()}>Connect Wallet

    >

  );

}

```



The `Sign In` button calls the `login` function that we're importing from the Auth SDK:



```jsx

const login = useLogin();

```



Inside the [\_app.jsx](./page/_app.jsx) file, we configured the redirect users to the `/` route after they successfully sign in:



```jsx

function MyApp({ Component, pageProps }) {

  return (

    

      

    

  );

}



export default MyApp;

```



Once the user has authenticated (signed the message), they are redirected to the home page `/`, and the `getServersideProps` logic runs again. Checking to see if they have an NFT balance greater than `0`.



### Sign Out



Finally, on the home page, we have a `Sign Out` button for the user, which calls the `logout` function that we imported from the Auth SDK, and sends the user back to the `/login` route.



```jsx

const logout = useLogout();

```



## Join our Discord!



For any questions, suggestions, join our discord at [https://discord.gg/thirdweb](https://discord.gg/thirdweb).