Sismo Connect - Onchain Sample Project Repository

This repository aims at providing simple examples on how to integrate Sismo Connect onchain while allowing you to test the integration locally as easily as possible.

Usage

Prerequisites

Node.js >= 18.15.0 (Latest LTS version)
Yarn
Foundry
Metamask installed in your browser

Clone the repository

# clone the repository
git clone https://github.com/sismo-core/sismo-connect-onchain-sample-project.git
cd sismo-connect-onchain-sample-project

Install dependencies

# install frontend / backend dependencies
yarn

# install contract dependencies with Forge
foundryup
forge install

Launch your local fork by forking Mumbai with Anvil

In a new terminal:

# start a local blockchain with mumbai fork
yarn anvil
# this triggers this anvil command behind the scene
# `anvil --fork-url https://rpc.ankr.com/polygon_mumbai`

Start your local Next.js app

In a new terminal:

# this will start your Next.js app
# the frontend is available on http://localhost:3000/
# it deploys the contracts on the local blockchain
yarn dev

The frontend is now available on http://localhost:3000/ and the contracts have been deployed on your local blockchain. You can now experiment the user flow by going to your local frontend http://localhost:3000/. If you wish to see the frontend code, you can go to the src/pages folder. The contracts code is in the contracts folder.

Be eligible for the airdrop

As you will see, the app showcase simple examples on how to create gated airdrops with Sismo Connect. To be eligible for the airdrops, you just need to add your address in ./config.ts:

// Replace with your address to become eligible for the airdrops
export const yourAddress = "0x855193BCbdbD346B423FF830b507CBf90ecCc90B"; // <--- Replace with your address

...

After changing the config file, you don't need to restart the app nor restart anvil, just refresh the page on the frontend and you are good to go.

ℹ️ You will be able to mint each airdrop only once with the same eligible address. If you wish to test the airdrop flow multiple times, you will need to change your eligible address or manually deploy again the contracts with the following command:

# this will deploy the contracts again on your local fork
yarn deploy-local

Important note

The interaction with the fork network can become quite unstable if you stop the yarn anvil command at some point or if you already use the sample app before. If so:

keep the local anvil node running,
make sure to delete your activity tab for the fork network in Metamask by going to "Settings > Advanced > Clear activity tab data" when connected to the fork network.
relaunch the anvil node and the application

Run contract tests

sismoConnectVerifier contracts are currently deployed on Goerli and Mumbai. You can find the deployed addresses here. You can then run tests on a local fork network to test your contracts.

## Run fork tests with goerli
forge test --fork-url https://rpc.ankr.com/eth_goerli

## Run fork tests with mumbai
forge test --fork-url https://rpc.ankr.com/polygon_mumbai

# you can aslo use the rpc url you want by passing an environment variable
forge test --fork-url $RPC_URL

⚠️ Important note

If you deployed your contracts on testnets (Goerli or Mumbai) and want to test it, you need to keep the devMode enabled but remove the devGroups.

DevMode allows Sismo Connect to redirect you to the Developer Data Vault (a special Data Vault used only for development)