BuildProof v2

🔍 Smart Contract Security Verifier tool

Instantly verify and analyze the security of any smart contract on the blockchain with our advanced verification engines.

---

✨ What is BuildProof

BuildProof is a comprehensive builder platform that combines smart contract verification with collaborative tools for blockchain developers. It provides a complete ecosystem for builders to work together, earn reputation, and manage projects securely.

🔍 Core Features

1. Smart Contract Verification

• Paste any contract address for instant security analysis
• Real-time vulnerability detection
• Gas efficiency analysis
• Industry compliance checks

2. Builder Bountie

• Create and manage blockchain development bounties
• Submit work with IPFS proof verification
• Automatic payment distribution
• 2.5% platform fee

3. Builder Reputation onchain

• On-chain reputation tracking system
• Skill endorsements from peers
• Achievement badges and credentials
• Authorized issuer management

4. Builder Teams

• Form collaborative teams for projects
• Custom reward share distribution
• Automatic payment splitting
• Track team statistics and earnings

5. Builder Escrow

• Milestone-based payment security
• Client approval workflow
• Dispute resolution system
• Protection for both parties

💡 Why Use BuildProof?

• Stay Safe: Avoid scam contracts and malicious code
• Save Money: Don't lose funds to poorly written contracts
• Quick Analysis: Get results in seconds, not hours
• Easy to Use: Just paste an address - no technical knowledge required
• Always Free: Complete security analysis at no cost

🎯 **Perfect Fo this set of users **

• Crypto Investors: Verify tokens before buying
• DeFi Users: Check protocols before depositing funds
• NFT Collectors: Analyze NFT contracts before minting
• Developers: Quick security audits during development
• Anyone: Who wants to stay safe in crypto

---

🚀 Quick Start

🌐 Use Online (Easiest)

Just visit our website and start verifying contracts immediately - no installation required!

💻 Run Locally

Want to run BuildProof on your own computer? Here's how:

1. Download the code:

git clone https://github.com/Thedongraphix/BuildProof.git
cd BuildProof

2. Install requirements:

npm install

3. Start the app:

npm run dev

4. Open in browser: Go to http://localhost:3000 and start verifying contracts!

---

📁 Project Structure

BuildProof/
├── contracts/              # Smart contracts (Solidity)
│   ├── BuilderBounty.sol   # Bounty management system
│   ├── BuilderReputation.sol # Reputation tracking
│   ├── BuilderTeams.sol    # Team collaboration
│   ├── BuilderEscrow.sol   # Milestone escrow
│   ├── ContractRegistry.sol # Contract registry
│   └── Counter.sol         # Example contract
├── src/                    # Next.js frontend application
│   ├── app/               # App Router pages and layouts
│   │   ├── globals.css    # Global styles and theme
│   │   ├── layout.tsx     # Root layout component
│   │   └── page.tsx       # Homepage component
│   ├── components/        # Reusable UI components
│   │   └── ui/           # shadcn/ui component library
│   └── lib/              # Utility functions and helpers
├── test/                  # Smart contract tests
├── script/               # Deployment and utility scripts
├── lib/                  # Foundry dependencies (git submodules)
│   ├── forge-std/        # Foundry standard library
│   └── openzeppelin-contracts/ # OpenZeppelin contracts
├── .github/workflows/    # CI/CD pipeline configuration
├── foundry.toml         # Foundry configuration
├── tailwind.config.ts   # Tailwind CSS configuration
└── package.json         # Node.js dependencies and scripts

---

🛠️ Development Commands

Smart Contract Development

# Compile contracts
forge build

# Run tests
forge test

# Run tests with detailed output
forge test -vvv

# Generate gas report
forge test --gas-report

# Check code coverage
forge coverage

# Format code
forge fmt

# Deploy to local network
forge script script/Deploy.s.sol --rpc-url http://localhost:8545 --broadcast

# Deploy to testnet
forge script script/Deploy.s.sol --rpc-url $SEPOLIA_RPC_URL --broadcast --verify

Frontend Development

# Start development server
npm run dev

# Build for production
npm run build

# Start production server
npm run start

# Run linter
npm run lint

---

🎨 Design System

Color Palette

• Primary: Blue (#3B82F6) - Used for primary actions and highlights
• Background: Dark Navy (#0A0F1C) - Main background color
• Surface: Gray-900 with transparency - Card and component backgrounds
• Text: Light colors with proper contrast ratios for accessibility

Typography

• Font Family: Geist Sans & Geist Mono (optimized for web)
• Scale: Responsive typography scale following modern design principles

Components

• Buttons: Multiple variants with hover states and animations
• Cards: Glass-morphism effect with backdrop blur
• Navigation: Sticky header with smooth transitions

---

🔧 Configuration

Environment Variables

Create a .env file in the root directory:

# RPC URLs
MAINNET_RPC_URL=https://mainnet.infura.io/v3/YOUR_INFURA_KEY
SEPOLIA_RPC_URL=https://sepolia.infura.io/v3/YOUR_INFURA_KEY
POLYGON_RPC_URL=https://polygon-mainnet.infura.io/v3/YOUR_INFURA_KEY
ARBITRUM_RPC_URL=https://arbitrum-mainnet.infura.io/v3/YOUR_INFURA_KEY

# Explorer API Keys
ETHERSCAN_API_KEY=your_etherscan_api_key
POLYGONSCAN_API_KEY=your_polygonscan_api_key
ARBISCAN_API_KEY=your_arbiscan_api_key

# Private Keys (DO NOT COMMIT REAL KEYS)
PRIVATE_KEY=your_private_key_here
DEPLOYER_PRIVATE_KEY=your_deployer_private_key_here

Network Configuration

The project supports multiple networks out of the box:

• Local: Anvil (development)
• Testnet: Sepolia, Goerli
• Mainnet: Ethereum, Polygon, Arbitrum

---

🧪 Testing

Smart Contract Tests

# Run all tests
forge test

# Run specific test file
forge test --match-path test/Counter.t.sol

# Run with gas reporting
forge test --gas-report

# Run with coverage
forge coverage --report lcov

Frontend Tests

# Run Jest tests (when configured)
npm test

# Run E2E tests (when configured)
npm run test:e2e

---

🚀 Deployment

Deploy to Celo Sepolia Testnet

Step 1: Add Celo Sepolia to MetaMask

Network Name: Celo Sepolia Testnet
RPC URL: https://1rpc.io/celo/sepolia
Chain ID: 11142220
Currency: CELO
Explorer: https://celo-sepolia.blockscout.com

Step 2: Get Test Tokens

• Faucet 1: https://faucet.celo.org/celo-sepolia
• Faucet 2: https://cloud.google.com/application/web3/faucet/celo/sepolia

Step 3: Configure Private Key

# Edit .env file
nano .env

# Add your private key (without 0x prefix)
PRIVATE_KEY=your_private_key_here

Step 4: Install Dependencies

forge install
npm install

Step 5: Compile & Test

forge build
forge test

Step 6: Deploy

# Method 1: Using forge script (recommended for complex deployments)
forge script script/DeployCelo.s.sol --rpc-url celo-sepolia --broadcast

# Method 2: Using forge create (simpler, direct deployment)
forge create --rpc-url celo-sepolia --private-key $PRIVATE_KEY src/contracts/Counter.sol:Counter

Step 7: Interact with Deployed Contract

# Read contract state
cast call YOUR_CONTRACT_ADDRESS "number()" --rpc-url celo-sepolia

# Write to contract
cast send YOUR_CONTRACT_ADDRESS "increment()" --rpc-url celo-sepolia --private-key $PRIVATE_KEY

Step 8: Connect Frontend

npm run dev
# Open http://localhost:3000
# Connect wallet and select Celo Sepolia

Local Deployment

# Start Anvil
anvil

# Deploy contracts
forge script script/Deploy.s.sol --rpc-url http://localhost:8545 --broadcast

Production Deployment

Smart Contracts

• Use multi-signature wallets for contract ownership
• Implement timelock contracts for critical functions
• Conduct thorough security audits before mainnet deployment

Frontend

• Deploy to Vercel, Netlify, or similar platforms
• Configure environment variables in deployment platform
• Set up custom domain and SSL certificates

---

🛡️ Security

Best Practices Implemented

• OpenZeppelin Standards: Using battle-tested contract libraries
• Static Analysis: Integrated Slither analysis in CI/CD
• Access Control: Proper role-based access control patterns
• Input Validation: Comprehensive input sanitization
• Reentrancy Protection: Guards against common attack vectors

Security Checklist

• All contracts audited by security professionals
• Multi-signature wallet implementation for admin functions
• Timelock contracts for critical operations
• Bug bounty program established
• Emergency pause mechanisms implemented

---

🤝 Contributing

We welcome contributions from the community! Please follow these steps:

1. Fork the repository
2. Create a feature branch: git checkout -b feature/amazing-feature
3. Make your changes: Follow the coding standards and add tests
4. Commit your changes: Use conventional commit messages
5. Push to the branch: git push origin feature/amazing-feature
6. Open a Pull Request: Provide a clear description of your changes

Development Standards

• Write comprehensive tests for all new features
• Follow Solidity and TypeScript best practices
• Ensure all CI/CD checks pass
• Update documentation for any API changes

---

📚 Resources

Documentation

• Foundry Book - Comprehensive Foundry documentation
• OpenZeppelin Docs - Smart contract security patterns
• Next.js Documentation - Frontend framework guide
• Tailwind CSS - Utility-first CSS framework

Community

• Discord Server - Join our developer community
• Twitter - Follow for updates and announcements
• Blog - Technical articles and tutorials

---

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

---

🙏 Acknowledgments

• OpenZeppelin for providing secure smart contract standards
• Foundry team for the excellent development framework
• Next.js team for the powerful React framework
• Tailwind CSS for the utility-first CSS framework
• Radix UI for accessible component primitives

---

Built with ❤️ by the BuildProof team

GitHub • Documentation • Community • Contributing