Auth with NFT

Info about the project

This is my Final Project to complete my bootcamp at Alchemy University.

My idea is to create a simple login page with NFT with the following steps:

• The User has to request to be added to the Whitelist
• If the admin accepts the request of the user, he is going to add the address inside the Whitelist contract
• Now the user can mint the NFT to get the token to website.

The User address is saved on a Google Sheet file, the admin has to insert it manually inside the Whitelist contract through write contract functions on Etherscan. When the User tries to mint the NFT, the Login NFT contract is going to communicate with the Whitelist contract to check if the User can mint.

Deployed Demo

Demo: here

If you request to access to the Whitelist, send me a mail to falcon.andrea88@gmail.com with your wallet and I'm going to add it to the contract.

Contract Whitelist: here

Contract Login NFT: here

Opensea NFT collection: here

Getting Started

Run the application

Run the commands for install packages and run the env:

# Copy env.example file
cp .env.example .env

# Install packages
npm install

# Run dev env
npm run dev

Open http://localhost:3000 with your browser to see the result.

Compile .env file

• NEXT_PUBLIC_NETWORK_CHAINID and NEXT_PUBLIC_NETWORK_CHAINNAME are used to front-end check to verify if the User is using the right chain
• PRIVATE_KEY is your MetaMask private key (here a guide to see how to export the key)
• NETWORK_RPC RPC link to connect to the chain, you can get a free subscription on Alchemy
• JWT_SECRET is a random string used as the secret for the JWT
• ETHERSCAN_KEY is the API key created on Etherscan to validate the contracts

Create and config the Google Sheets file to store addresses

1. Create project and API on Google Cloud Console
2. Download the API Key in JSON format and get private key and client email and put inside the .env file inside GOOGLE_SHEETS_PRIVATE_KEY, GOOGLE_SHEETS_CLIENT_EMAIL and GOOGLE_DRIVE_SPREADSHEET variables
3. Create a Sheet file on your Drive and get the ID of the sheet from the URL and put inside the .env file
4. The script read/write only in column A

Deploy contracts

The project was created to work on the Goerli network, but with some updates, you can move to Mainnet Chain.

Deploy the contracts with the command:

npx hardhat run scripts/deploy.js --network goerli

Get the contract address and add them to .env file (NEXT_PUBLIC_WHITELIST_ADDRESS and NEXT_PUBLIC_LOGIN_NFT_ADDRESS), and verify the contracts with the commands:

npx hardhat verify --network goerli [NEXT_PUBLIC_WHITELIST_ADDRESS]
npx hardhat verify --network goerli [NEXT_PUBLIC_LOGIN_NFT_ADDRESS]

Set the Whitelist address on the Login NFT contract

You have to insert the Whitelist contract address inside the Login NFT contract.

You can do this with the write function setWhitelistAddress through Goerli Etherscan connecting to the Login NFT contract address.

Run tests

You can run the tests on the command:

npx hardhat test