🚌 The Praise Board

A decentralized tipping board on Ethereum Sepolia.
Support community heroes like Ifeoma — who maintains your city's bus timetables for free — with instant, fee-free ETH tips. Every tip is recorded permanently on-chain.

---

✨ Features

• 🦊 MetaMask / WalletConnect integration via RainbowKit
• ⚡ Instant ETH tips with short appreciation notes
• 📜 Fully on-chain supporter wall — zero databases, zero middlemen
• 🔄 Real-time updates via contract events
• 👑 Owner withdrawal for Ifeoma to claim her tips
• 🌐 ENS-ready address display (shortened + Etherscan links)
• 📱 Responsive design — works on mobile and desktop
• 🎨 Premium dark-mode UI with glassmorphism and animations

---

🏗️ Architecture

blockchain_proj/
├── contracts/
│   └── PraiseBoard.sol         # Ownable Solidity contract
├── scripts/
│   └── deploy.ts               # Hardhat deploy script
├── test/
│   └── PraiseBoard.test.ts     # Full test suite (13 tests)
├── frontend/
│   ├── src/
│   │   ├── abis/PraiseBoard.ts # Contract ABI (typed)
│   │   ├── config/wagmi.ts     # Wagmi + RainbowKit config
│   │   ├── hooks/
│   │   │   ├── usePraiseBoard.ts   # Contract interactions
│   │   │   └── useWalletState.ts   # Wallet / network state
│   │   ├── components/
│   │   │   ├── ConnectButton.tsx   # Wallet connect
│   │   │   ├── NetworkGuard.tsx    # Wrong network banner
│   │   │   ├── TipForm.tsx         # Send tip UI
│   │   │   ├── SupporterWall.tsx   # Live on-chain feed
│   │   │   └── WithdrawButton.tsx  # Owner withdraw panel
│   │   ├── App.tsx
│   │   └── main.tsx
│   └── index.html
├── hardhat.config.ts
├── .env.example
└── README.md

---

🛠️ Tech Stack

Layer	Technology
Smart Contract	Solidity 0.8.24, OpenZeppelin 5.x
Dev Framework	Hardhat 2.x + TypeScript
Blockchain	Ethereum Sepolia
RPC	QuickNode
Frontend	React 18, Vite 5, TypeScript
Web3 Client	wagmi 2.x + viem 2.x
Wallet UI	RainbowKit 2.x
State	TanStack React Query 5
Styling	Vanilla CSS (dark glassmorphism)

---

📋 Contract Details

Property	Value
Contract Name	PraiseBoard
Network	Ethereum Sepolia (chainId: 11155111)
Contract Address	0x___FILL_AFTER_DEPLOYMENT___
Deploy Tx Hash	0x___FILL_AFTER_DEPLOYMENT___
Solidity	^0.8.24
License	MIT

---

🚀 Deployment Instructions

Prerequisites

• Node.js 18+
• A funded Sepolia wallet (get test ETH at sepoliafaucet.com)
• QuickNode Sepolia RPC URL

1. Clone & install

git clone https://github.com/Harshad710/praise-board.git
cd blockchain_proj
npm install

2. Set environment variables

cp .env.example .env

Edit .env:

QUICKNODE_URL=https://your-endpoint.quiknode.pro/your-key/
PRIVATE_KEY=your_deployer_private_key

3. Compile the contract

npx hardhat compile

4. Run tests

npx hardhat test

5. Deploy to Sepolia

npx hardhat run scripts/deploy.ts --network sepolia

Copy the printed contract address.

6. (Optional) Verify on Etherscan

npx hardhat verify --network sepolia <CONTRACT_ADDRESS>

---

💻 Running the Frontend Locally

1. Install frontend dependencies

cd frontend
npm install

2. Set frontend environment variables

cp .env.example .env

Edit frontend/.env:

VITE_CONTRACT_ADDRESS=0xYourDeployedContractAddress
VITE_QUICKNODE_URL=https://your-endpoint.quiknode.pro/your-key/
VITE_WALLETCONNECT_PROJECT_ID=your_walletconnect_project_id

Note: Get a free WalletConnect project ID at cloud.walletconnect.com

3. Start the dev server

npm run dev

Open http://localhost:5173

---

🌍 Environment Variables

Root (Hardhat)

Variable	Required	Description
QUICKNODE_URL	Yes	QuickNode Sepolia RPC endpoint URL
PRIVATE_KEY	Yes	Deployer wallet private key

Frontend (frontend/.env)

Variable	Required	Description
VITE_CONTRACT_ADDRESS	Yes	Deployed PraiseBoard contract address
VITE_QUICKNODE_URL	Yes	QuickNode Sepolia RPC for frontend
VITE_WALLETCONNECT_PROJECT_ID	Yes	WalletConnect project ID

---

📸 Screenshots

[Add screenshots after running the frontend]

• Home page with connect prompt
• Connected wallet + tip form
• Pending transaction state
• Success state with Etherscan link
• Supporter wall with tips

---

✅ Acceptance Criteria Checklist

• Connect MetaMask / WalletConnect
• Send ETH tip with short note
• Note capped at 200 bytes on-chain + client-side validation
• Tip recorded on-chain (Tip[] struct array)
• NewTip event emitted on each tip
• Supporter wall reads ONLY from blockchain (no database)
• Live wall refresh on new tip (event listener + refetch)
• Supporter wall sorted newest-first
• Owner withdraw function
• Wrong network detection + one-click switch to Sepolia
• Wallet not installed error handling
• User rejected transaction error handling
• Insufficient funds error handling
• Zero ETH tip rejected (ZeroTipNotAllowed custom error)
• Long note rejected (NoteTooLong custom error)
• Pending transaction state (spinner + Etherscan link)
• Success state with confirmation
• Hardhat tests: 13 passing tests
• TypeScript throughout
• ESLint + Prettier configured
• Checks-Effects-Interactions pattern in contract
• OpenZeppelin Ownable inherited
• Custom errors (no require strings)
• getAllTips() view function
• Responsive design (mobile + desktop)

---

🧪 Test Results

PraiseBoard
  Deployment
    ✓ should set the deployer as the owner
    ✓ should start with zero tips
  receiveTip
    ✓ should accept a valid tip and emit NewTip event
    ✓ should store the sender address correctly
    ✓ should store the amount correctly
    ✓ should store the note correctly
    ✓ should store a non-zero timestamp
    ✓ should reject a zero-ETH tip with ZeroTipNotAllowed
    ✓ should reject a note longer than 200 bytes with NoteTooLong
    ✓ should accept a note of exactly 200 bytes
    ✓ should accumulate multiple tips from different senders
  getAllTips
    ✓ should return an empty array when no tips have been sent
    ✓ should return all tips in correct order
  withdraw
    ✓ should allow the owner to withdraw all funds
    ✓ should reject withdrawal from a non-owner account
    ✓ should reject withdrawal when balance is zero

16 passing

---

🔒 Security Notes

• Custom errors used throughout (no revert strings) — gas efficient
• Checks-Effects-Interactions pattern in receiveTip and withdraw
• onlyOwner modifier from OpenZeppelin guards withdrawal
• Note length capped at 200 bytes on-chain
• Zero-value tips rejected with custom error
• Pull-over-push withdrawal pattern — no automatic transfers to external addresses

---

📄 License

MIT