Welcome to Sulaunch’s developer documentation!

SuLaunch is an ENS491/492 project offered at the Sabanci University as a graduation project. The main aim of this project is to introduce Blockchain technology to CS enthusiasts and wants to explore new technology.

This project aims to create the foundation for the utilization of blockchain technology in Sabanci University through an utility token (SUC) deployed on one of the EVM compatible blockchains. The main priority is to provide a fundraising platform for students to propose their projects and distribute their project’s tokens for funds via the auction mechanism provided by our system. The process will be as basic as possible for users to use blockchain technology, most of the key features of our project will be automated through the smart contracts and the backend server.

One of the key points of this part of the project is to protect the ideas of the project proposers as in the real world, fundraising can be vulnerable to the theft of ideas. The project provides a hybrid solution where both traditional databases and a blockchain are utilized to provide a safety measure. This is achieved through saving the hash of the project details in the blockchain and commercialized versions of the project details in the database. This lets users be able to show the ownership of the document through their wallet and the logs in the blockchain by our web application during the applying process.

The motivation for the project lies in the safety of the project’s owner’s rights, decentralization of the funding mechanisms around the schools, and providing a solid foundation for the later blockchain use cases which can be utilized through SUC.

This is a code documentation for developers. Since it is about how the platform works, It is recommended that you read the User Documentation first.

Contents

• Setup Guide

Backend

• Constants
  • ContractConstants
  • MessageConstants
  • ProjectStatusConstants
  • UserPermissionRoleConstants
  • UserRoleConstants
• Data Context
  • DataSets
  • Database Connection Configuration
  • Logging Configuration
• Data Transfer Objects

Controllers

• Controllers Introduction
• Authentication Controller
• Event Debug Controller
• User Controller
• Project Controller

Models

• Projects
• Project permission
• Rating
• User

Request

• Project Permission Request
• Project Request
• User Login Request
• User Register Request

Response

• Service Response

Services

• Authentication Service
• Chain Interaction Service
• IPFS Interaction Service

DTOS

• Admin Change Event
• Auction Finished Event
• AuctionStartedEvent
• Bid Submission Event
• Claim Tokens Event
• Create Auction Event
• Dutch Auction Bid Event
• Hash To Project
• Project
• Project Evaluation Event
• Project Register Event
• Project Template
• Token Creation Event
• User
• Vote Delegate Event
• Vote Event

Frontend

• HomeNew Component
• The ProjectList Component
• The CreateTokens Component
• CreateAuction Component
• Auctions Component
• Project Component
• Auction Component
• Profile Page Component
• NotAuthorized Component
• Viewer Component
• Admin Component
• About Component
• UserNotVerified Component
• UserVerified Component
• Apply Component
• HowToUse Component