Skip to content

MystenLabs/BugPub

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

"The Bug Pub": Web3's First On-Chain Bug Bounty Platform

Welcome to the Bug Pub, a place to reward the right kind of attention.

Bug Pub provides a fully Web3 Bug Bounty Audit Platform for Publishing Bug Bounties and Audits.

Users now have a web3-native service for managing and participating in bug bounties and publishing security-related research / audits on packages

All Bug bounty operations are managed and interfaced via the Sui Blockchain.

Bug Pub is currently in prototype stages, and can be found here: bug-pub.vercel.app

Overview

high-level flow

Actors + Actions

Bounty Owner

Create Bounty

create-bounty

  • Lists their smart contract package on the platform with associated bounty reward
  • Generates a Proof of Audit (PoA) NFT for auditer who can use it to submit a higher rated audit (e.g. blue checkmark)
  • Sets list of Bounty Verifiers and Bounty Moderators

Reward Audits

distribute-rewards

  • Distribute Rewards for Audits

Security Researchers / Auditors

create-audit-with-ai

  • Creates Security Audits Identifying Vulnerabilities in smart contracts and codebases in scope of the bounty
  • Collects rewards for publishing their audits

Bounty Verifiers

  • Verify Package Bounty Audits
  • Attest Audit is an accurate package analysis report for the package + associated bounty and scope
  • Optionally Rewarded with percentage of Bounty Amount if passes Verification (Opt-In)

Bounty Moderators

  • Escalates Quality Content
  • Deletes scam, spam, and unsafe audits

Informed Consumers

  • Can access audits for smart contracts to make informed decisions
  • Rate audits by casting upvote/downvote

Technologies Used

Web3

Sui Blockchain: Backend Orchestrator for Bug Pub

Sui Blockchain serves as the primary orchestration layer for Bug Pub services, content, and user interactions.

Bug Pub services are written as Move Packages (smart contracts)

Move is the programming language of the Sui Blockchain. It's ease-of-use, modularity, and security features provide an ideal substrate to build secure, scalable, and reactive web3 applications.

ZkLogin: Allowing Web2 Seamless Access to Web3

ZkLogin provides a Web2 Friendly User Login for Web3 Services (like Bug Pub). More information can be found at the offical ZkLogin Docs and ZkLogin Research Paper

Walrus Storage: Web3 Storage for Bug Pub

Walrus is a decentralized storage solution. Bug Pub uses Walrus to store large artifacts not able to be stored on the Sui Blockchain.

Web2

  • NextJS
  • Vercel

Project Structure

The project is structured into two main directories:

  • app/: Contains the front-end code.
  • move/: Includes the smart contracts written in Sui Move.
  • setup/: Includes helper functionality for publishing Move Contract