SC4053 - Blockchain Technology Project — _🃏 BONK

🃏 BONK is short for Bid On Non-fungible Kavel (Kavel is Dutch for "lot")

• Bid On: Participate in an auction to place bids.
• Non-fungible: Referring to unique, indivisible items that are verified on the blockchain (like NFTs).
• Kavel: A Dutch word meaning "lot" or "parcel," representing each unique auction item.

Together, BONK is your gateway to secure, transparent and fair decentralized dutch auctions. This dApp (decentralised application) empowers users to participate in secure, trust-less bidding—where every bid counts and decentralisation is at the core.

Dutch auctions decentralised to bid smart and own fast.

• 🌐 dApp
• ✨ Presentation / Preview

Getting Started

Pre-requisites

Running in a Container

• Docker
• Dev Container extension (VSCode)

Running Locally

• PNPM

🛠️ Installation and Set Up

1. Clone repository

   git clone git@github.com:crystalcheong/bonk.git
   cd bonk

2. Duplicate .env.example to create .env file

   cp -n packages/service/.env.example packages/service/.env
   cp -n apps/web/.env.example apps/web/.env

3. Install dependencies

   pnpm i

4. Start the application

   pnpm run dev

Tip

Copy the Hardhat generated network accounts, for testing in localhost

4. In a new terminal tab, deploy smart contracts

   cd ./packages/service
   pnpm run deploy:local

   Once deployed, update apps/web/.env,
   

   VITE_BONK_AUCTION_INITIATOR_ADDRESS=<auction-initiator-address>

5. Regenerate ABI

   cd ../../apps/web
   pnpm run generate

Deployment

1. Deploy to Sepolia testnet on Alchemy

1. Set the following variables in packages/service/.env:

SEPOLIA_GATEWAY_URL=https://eth-sepolia.g.alchemy.com/v2/<alchemy-api-key>
SEPOLIA_PRIVATE_KEY=<metamask-private-key>

2. Open a new terminal tab in the serivce packge

cd packages/service

3. Compile and test the smart contracts

pnpm run build
pnpm run test

4. Deploy to Sepolia testnet

pnpm run deploy:sepolia

2. Host web application on Vercel

1. Set the following variables in apps/web/.env:

VITE_ALCHEMY_API_KEY=<alchemy-api-key>
VITE_BONK_AUCTION_INITIATOR_ADDRESS=<deployed-auction-initiator-address>

2. Open a new terminal tab in the web packge

cd apps/web

3. Build the project and generate the ABI Hooks

pnpm run build
pnpm run generate

4. Deploy to Vercel

Project Structure

Frontend (apps/web)
Built on TypeScript with React and Vite bundling. Wagmi dependency to manage wallet connections, fully type-safe interactions with the RPC, and to generate ABI directly from the deployed contract address.

Smart Contracts (packages/service)
containing our Solidity smart contracts, test scripts and typings generated with Typechain that the frontend references directly

How the Contracts Work

AuctionInitiator
This contract allows anyone to create a new auction. It tracks all auctions created by different users, acting as the starting point for every new auction process.

AuctionMarket
This contract handles the auction mechanics. It manages the bidding process, tracks token commitments, calculates clearing prices, and distributes tokens at the end of the auction. Essentially, it’s the heart of the auction operation.

AuctionToken
This is where the custom ERC-20 token for the auction is defined. It manages token transfers, tracks balances, mints new tokens, and burns unsold tokens to maintain supply integrity.

Team Members

• Crystal Cheong Yu Qing (U2121134A)
• Seah Kai Heng (U2021104L)
• Nguyen Ngoc Minh Nghia (U2120213H)

---

This repository is submitted as a project work for Nanyang Technological University's SC4053 - Blockchain Technology course.