BugHunter Quick-Start Guide: Automate Your Solidity Security Reviews in Minutes
When it comes to securing smart contracts, especially in blockchain and Web3 ecosystems, thorough security review is a must. Bug Hunter streamlines this process by offering an intuitive submission flow.
In this guide, weβll walk you through the entire Bug Hunter journey, from signing up to tracking your reviewβs progress.
π Step 1: Sign Up or Log Inβ
Start your journey at the Bug Hunter login page. You can sign in with:
- GitHub
New to the platform? Click βSign upβ to register with just a few clicks.
π Step 2: Dashboard Overviewβ
Once logged in, youβre directed to the Dashboard. It offers options to:
- Submit a new project
- Monitor ongoing reviews
- View completed reviews
- Manage your profile
Click βSubmitβ under "Start a New Security Review" to begin.
π Step 3: Submit Project for Reviewβ
The submission process is divided into 5 clear steps:
π Step 1: Project Informationβ
Choose your input method:
- GitHub Repository
- ZIP File
Then, provide:
- Project Name
- Optional Description
π Step 2: GitHub Repositoryβ
Enter:
- Repository URL
- Select a Branch
- Choose a Commit
The platform validates the repo and loads your data automatically.
π Step 3: Define Review Scopeβ
Select the scope of the security review:
- Full Project β for a complete security review.
- Select Files β if only certain files need reviewing
π Step 4: Upload Documentationβ
Include:
- GitBook links
- Project website
- Markdown or PDF files
This documentation helps Bug Hunter understand your project better.
Step 5: Final Reviewβ
Review all your input:
- Project info
- Repo & commit hash
- Review scope
- Documentation
Once satisfied, click Submit.
π’ Submission Success & Review Processβ
After submission, youβll see a green success message confirming everything went through.
π Track Review Progressβ
Navigate to Ongoing Reviews to track your submission. The review progresses through the following stages:
β³ Queuedβ
Your project is awaiting review.
π In Reviewβ
The security review is underway.
Click on your project to see review details:
- Status
- Description
- Repo link & commit
- Scope
- Documentation links
You can also view the review report once itβs completed.
β Completed Reviewsβ
Once the review process is complete, your project will appear in the Completed Reviews section of the dashboard. From here, you can:
- View the final review report
- Share findings with your team or community
π§ Final Thoughtsβ
Bug Hunter delivers a seamless experience for developers seeking professional security reviews. With intuitive UI, GitHub integration, and transparent review status updates, itβs a powerful tool for bringing security into the design phase in early stages.
By using Bug Hunter, you're taking a crucial step toward trust, reliability, and security in your project.