/ScanSecure

Project for diplome dev web, in Alyra School

Primary LanguageJavaScriptApache License 2.0Apache-2.0

ScanSecure

Information

This project was realized during the buterin session of the Alyra school, in order to certify the diploma (or not 😅). It was delivered in 2 weeks, which was a real challenge. It was very instructive, despite a certain frustration at not being able to go further into the application's functionalities due to lack of time.

I hope you like the architecture, I've spent a bit of time on it to try and get the structure as clean as possible.

Enjoy 🎉

Video Présentation

Lien vers la vidéo

Website Demo (Vercel)

Lien vers la demo

Install

git clone https://github.com/xdrkush/ScanSecure.git
cd ScanSecure.git
yarn

Run

DApp

💡 Tip: More Information commands in package.json or docs

Dev
yarn dapp:dev
Build
yarn dapp:build
Start
yarn dapp:start

Contract

!!! | information commands in package.json or doc (npx hardhat ... -> in ./packages/hardhat-project)

Test
yarn sc:test
Coverage
yarn sc:coverage
Deploy (local)
yarn sc:deploy:local
Deploy (Sepolia)
yarn sc:deploy:sepolia

Script

⚠️ Warning: Warning with uncomment all

Dev
yarn script:dev
Start
yarn script:start

UserStories

Objectives: dApp for creating/selling tickets in NFT form

Roles: Ux Visitor (VI), Whitelisted (WL), Creator (CR), Admin (ADM):

  • Ux (VI) can register in a whitelist
  • The ux (VI) can request certification (CR) with a message (onchain)
  • The ux (ADM) can certify certification requests
  • The ux (CR) can create event(s)
  • The ux (CR) can create ticket collections (nft) for its events
  • The ux (WL) can obtain tickets proposed by a creator
  • The ux (CR) can verify/consume the ticket for stamping

Ideas for improvement:

  • Marketplace: Ticket sales between Uxs, ...
  • USDT: Link ticket sales in USDT, ...
  • DAO: Votes for certified users, ...

Lexicon:

  • Ux: User
  • dApp: Decentralized application

Contracts

This repository contains a set of smart contracts for the ScanSecure application.

Contracts Overview

ERC20 Token Contract - TetherToken.sol

A simulator ERC20 (USDT) for ScanSecure. This contract is used to simulate a USDT token within the application.

ERC1155 Token Contract - ScanSecureERC1155.sol

An ERC1155 token contract that allows the creation and management of event tickets.

Library Contract - LibFees.sol

A library contract providing a function to calculate fees based on a given price.

Library Contract - ScanSecureLibStorage.sol

A library contract containing various data structures and enums used in the ScanSecure application.

Contract - ScanSecure.sol

The main contract of the ScanSecure application. It serves as the entry point for the application and is responsible for managing access and user certification.

Contract - ScanSecureAccess.sol

A contract that extends the ScanSecureStorage contract and provides functions for user registration and certification.

Contract - ScanSecureStorage.sol

A contract that extends the ScanSecureLibStorage contract and provides storage for events, members, and tickets.

Contract - ScanSecureTicketManager.sol

A contract that extends the ScanSecureAccess contract and provides ticket management functionalities, including ticket creation, purchase, and consumption.

Contract Relationships

The diagram below shows the data relationships between the main contracts in the ScanSecure application.

graph TD

    subgraph "External Contracts"
        J[TetherToken]
    end


    subgraph Contracts
        A[ScanSecure]
        B[ScanSecureStore]
        C[ScanSecureAccess]
        D[ScanSecureStorage]
        E[ScanSecureTicketManager]
        I[ScanSecureERC1155]
        H[ScanSecureLibStorage]
    end

    subgraph Libraries
        F[Roles]
        G[LibFees]
    end
    
    A -->|extends| B
    A -->|use| F
    B -->|extends| E
    B -->|use| F
    E -->|extends| C
    C -->|extends| D
    C -->|use| G
    D -->|extends| H
    D -->|extends| I
    D -->|use| G
    D -->|use| J
    

    style A fill:#a9f,stroke:#333,stroke-width:2px
    style B fill:#a9f,stroke:#333,stroke-width:2px
    style C fill:#a9f,stroke:#333,stroke-width:2px
    style D fill:#a9f,stroke:#333,stroke-width:2px
    style E fill:#a9f,stroke:#333,stroke-width:2px
    style F fill:#a9f,stroke:#333,stroke-width:2px
    style G fill:#a9f,stroke:#333,stroke-width:2px
    style H fill:#a9f,stroke:#333,stroke-width:2px
    style I fill:#a9f,stroke:#333,stroke-width:2px
    style J fill:#a9f,stroke:#333,stroke-width:2px
Loading

Data Relationships

The diagram below shows the data relationships within the ScanSecureStorage contract:

classDiagram
    class ScanSecureStorage {
        + usdtToken : ERC20
        + ScErc1155 : ScanSecureERC1155
        + firstOwner : address
        + events : Event[]
        + members : mapping(address => User)
        + ticketsValidity : mapping(uint => mapping(uint => Ticket))
        + eventLastId : uint
        + totalMembers : uint
    }
Loading

Structure of data Relationships

The diagram below shows the structure of data relationships within the ScanSecureStorage contract:

classDiagram
    class User {
        + pseudo : string
        + status : CertificationStatus
    }

    class Event {
        + title : string
        + limitTickets : uint
        + totalSold : uint
        + author : address
        + status : EventStatus
    }

    class Ticket {
        + price : uint
        + owner : address
        + status : TicketStatus
    }

    enum CertificationStatus
    enum EventStatus
    enum TicketStatus
Loading

Roles

MEMBER_ROLE=0x829b824e2329e205435d941c9f13baf578548505283d29261236d8e6596d4636 CREATOR_ROLE=0x828634d95e775031b9ff576b159a8509d3053581a8c9c4d7d86899e0afcd882f ADMIN_ROLE=0xa49807205ce4d355092ef5a8a18f56e8913cf4a201fbe287825b095693c21775

Docs

💡 Tip: I may have forgotten some.

Multiple doc for Front:

##### Multiple doc for Back:

Multiple doc for Environment:

Address dev hardhat

📝 Note: provided by hardhat

Account #0: 0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266 (10000 ETH)

Private Key: 0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80

Account #1: 0x70997970C51812dc3A010C7d01b50e0d17dc79C8 (10000 ETH)

Private Key: 0x59c6995e998f97a5a0044966f0945389dc9e86dae88c7a8412f4603b6b78690d

Account #2: 0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC (10000 ETH)

Private Key: 0x5de4111afa1a4b94908f83103eb1f1706367c2e68ca870fc3fb9a804cdab365a

Account #3: 0x90F79bf6EB2c4f870365E785982E1f101E93b906 (10000 ETH)

Private Key: 0x7c852118294e51e653712a81e05800f419141751be58f605c371e15141b007a6

By xDrKush