SafeTickets

Final project during Alyra blockchain developer training.

This is a simple NFT marketplace.

NFT's are images and information about physical tickets of passed concert tickets.

The targetted users are concert tickets collectors like Stevie Dixon.

Table of Contents

• Features
• Demo
  • Video
  • Dapp
  • Contracts on OpenSea and Sepolia
• Contracts architecture
  • Contracts
  • Diagrams
  • Contracts deployment
• Coverage & security
  • Coverage
  • Slither
• Stack
  • Smart Contracts
  • File upload
  • Front
  • CI/CD
• Dapp
• Important issues
• Run the app locally
  • Run front
  • Run blockchain
  • Deploy

Features

As a user I can:

• Authenticate with Rainbowkit
• Create a collection of tickets (rock, rap, whatever)
• Create a ticket draft within a collection with info (opensea standard) :
  • uploaded image (IPFS)
  • concert name
  • venue
  • date
  • type (= "rareness"; gold|category1|floor)
• Mint a ticket draft within a collection
• Remove a ticket draft
• Set a minted ticket on sale
• Set and update a minted, on sale, ticket's price
• Set a minted ticket "off" sale
• Buy a minted, on sale, price > 0 ticket
• See tickets I bought
• Withdraw my balance on marketplace (after having sold at least one ticket)
• See events of marketplace

Demo

Video

YouTube link

Dapp

If application is deployed it should be here: https://safe-tickets.vercel.app

Contracts on OpenSea and Sepolia

• SafeTickets.sol on Opensea
• SafeTickets.sol on Etherscan
• Markeplace.sol on Etherscan
• UserCollectionFactory.sol on Etherscan
• UserCollection.sol on Etherscan

Contracts architecture

Contracts

Oppenzeppelin contracts dependency:

• ReentrancyGuard
• IERC721Receiver
• ERC721Enumerable
• ERC721URIStorage
• Clones

Description

• UserCollection:
  • original and "to be cloned" user collection.
  • legacy function withdraw (at first I wanted the Collection wich is the owner of the minted tickets to receive the ETH then the user withdraw ETH per collection, it's an unnecessarily cumbersome and complex process.)
  • initialize function to initialize collection name
  • other functions from this contract to be called by Marketplace (approveBuyer, transferTicket)
• UserCollectionFactory:
  • simply clone UserCollection and initialize it
• Marketplace:
  • does the on sale and pricing operation
  • does the buying and transfering operations
  • allow user to withdraw funds on contract
• SafeTickets:
  • mainly the "real" NFT collection

Diagrams

Contract architecture

Mint process

Contracts deployment

• UserCollection & SafeTickets dont take constructor args
• Marketplace needs:
  • SafeTickets address
• UserCollectionFactory needs:
  • UserCollection address
  • SafeTickets address
  • Marketplace address

Coverage & security

Coverage

A coverage screen 08-04-24 15:00.

Slither

Slither does not pass, some warnings are from Openzeppelin contracts. Other need a timely refacto. Here is a screen of Slither report launched within a GitHub workflow action.

Stack

Smart Contracts

• Solidity
• Hardhat
• Slither
• Sepolia

File upload

• IPFS, Pinata

Front

• Wagmi, Viem, Rainbowkit, NextJS
• Chakra-UI
• localStorage

CI/CD

• Hardhat tests (+ Mocha & Chai)
• GitHub actions
• Slither
• Vercel

Dapp

• should be mostly responsive
• handle empty states
  • no buyings
  • no ticket on sale
• use serverless functions to get data from blockchain in app/api/*

Important issues

• Better contract DocGen
• Better transaction confirmation UX
• Fix all Slither fixable warnings

Run the app locally

Run front

cd ./frontend
yarn install
touch .env.local
yarn run dev

.env.local:

NEXT_PUBLIC_NETWORK=hardhat
NEXT_PUBLIC_ENABLE_TESTNETS=true
NEXT_PUBLIC_EVENT_BLOCK_NUMBER=0
NEXT_PUBLIC_WALLET_CONNECT_PROJECT_ID={REPLACE}
NEXT_PUBLIC_PINATA_GATEWAY_URL={REPLACE}
PINATA_JWT={REPLACE}
// hardhat local invariable addresses:
NEXT_PUBLIC_MARKETPLACE_CONTRACT_ADDRESS="0x9fE46736679d2D9a65F0992F2272dE9f3c7fa6e0"
NEXT_PUBLIC_SAFE_TICKETS_CONTRACT_ADDRESS="0xe7f1725E7734CE288F8367e1Bb143E90bb3F0512"
NEXT_PUBLIC_USER_COLLECTION_CONTRACT_ADDRESS="0x5FbDB2315678afecb367f032d93F642f64180aa3"
NEXT_PUBLIC_USER_COLLECTION_FACTORY_CONTRACT_ADDRESS="0xCf7Ed3AccA5a467e9e704C703E8D87F634fB0Fc9"

Run blockchain

cd ./blockchain
touch .env
yarn install

yarn hardhat node --network hardhat

.env

LOCAL=true
INFURA_PK={REPLACE}
ETHERSCAN_API_KEY={REPLACE}
INFURA_URL={REPLACE}
WALLET_PK={REPLACE}
ALCHEMY_URL={REPLACE}

Deploy

yarn hardhat run scripts/deploy.js --network localhost

to Sepolia

yarn hardhat run scripts/deploy.js --network sepolia

local "seed" script (local)

yarn hardhat run scripts/createCollection.js --network localhost