Skip to content

Repository files navigation

$LERF Logo

$LERF Rewards Hub

A gamified Web3 reward ecosystem built by Boomchainlab
๐Ÿ”— Live: slerfearn.boomchainlab.com


๐Ÿš€ Overview

The $LERF Rewards Hub is a next-generation Web3 platform that transforms on-chain engagement into tokenized rewards. Powered by the $LERF token and designed with Next.js, the platform gamifies blockchain interactions through missions, staking, trading, and micro-tasks.


๐ŸŽฏ Features

  • ๐ŸŽฎ Gamified Rewards System โ€” Complete daily/weekly quests to earn $LERF
  • ๐Ÿ’ฐ Multi-Chain Staking โ€” Stake across Ethereum, BSC, Arbitrum, Solana
  • ๐Ÿงฉ Cooldown Micro-Tasks โ€” Auto-refreshed tasks every 5 minutes
  • ๐Ÿค– Activity Farming โ€” Integrated tools and bots for on-chain actions
  • ๐Ÿ”„ Auto-Staking โ€” Earnings reinvested via smart contracts
  • ๐ŸŒ‰ Cross-Chain Liquidity โ€” Manage LPs across major networks
  • ๐ŸฆŠ Multi-Wallet Connect โ€” MetaMask, Phantom, WalletConnect & more
  • ๐Ÿง‘โ€๐Ÿ’ป GitHub Rewards โ€” Link contributions to earn tokens
  • ๐Ÿ“ˆ Trading Interface โ€” Charts, swap, and orderbook for $LERF

๐Ÿงช Tech Stack

Layer Stack
Frontend Next.js 15, TailwindCSS, shadcn/ui
Web3 wagmi, viem, WalletConnect, ethers.js
Backend Node.js, Next.js API Routes
Database PostgreSQL, Drizzle ORM
Auth Replit OAuth, Wallet Auth
CI/CD Vercel, Railway, Docker

๐Ÿง‘โ€๐Ÿ’ป Getting Started

Prerequisites

  • Node.js 18+
  • PostgreSQL
  • WalletConnect & Infura project IDs

Installation

git clone https://github.com/BoomchainLabs/slerfearn.git
cd slerfearn
npm install
cp .env.example .env
# Edit .env with your secrets
npm run db:push
npm run dev

# Install dependencies
npm install

# Set up environment variables
cp .env.example .env
# Edit .env with your configuration

# Set up the database
npm run db:push

# Start the development server
npm run dev

Environment Variables

Create a .env file in the root directory and add the following variables:

# Database
DATABASE_URL=postgresql://username:password@localhost:5432/lerf_rewards_hub

# Authentication
NEXTAUTH_SECRET=your_nextauth_secret_key

# Web3 Configuration
WALLET_CONNECT_PROJECT_ID=your_walletconnect_project_id
INFURA_PROJECT_ID=your_infura_project_id

# GitHub OAuth (for GitHub integration)
GITHUB_CLIENT_ID=your_github_oauth_client_id
GITHUB_CLIENT_SECRET=your_github_oauth_client_secret

# Token Contract Addresses
LERF_TOKEN_CONTRACT_ETH=0x...
LERF_TOKEN_CONTRACT_SOLANA=...
LERF_TOKEN_CONTRACT_BSC=0x...

# API Keys
COINGECKO_API_KEY=your_coingecko_api_key
MORALIS_API_KEY=your_moralis_api_key

Deployment

Vercel Deployment

  1. Push your code to GitHub
  2. Connect your repository to Vercel
  3. Add environment variables in Vercel dashboard
  4. Deploy automatically
npm run build
vercel --prod

Railway Deployment

  1. Connect your GitHub repository to Railway
  2. Add PostgreSQL service
  3. Configure environment variables
  4. Deploy both frontend and backend services

Docker Deployment

# Build the Docker image
docker build -t lerf-rewards-hub .

# Run with environment variables
docker run -p 3000:3000 --env-file .env lerf-rewards-hub

API Documentation

Authentication Endpoints

  • POST /api/auth/signin - Sign in with wallet
  • POST /api/auth/signout - Sign out user
  • GET /api/auth/session - Get current session

Rewards Endpoints

  • GET /api/rewards/balance - Get userโ€™s $LERF token balance
  • POST /api/rewards/claim - Claim daily/weekly rewards
  • GET /api/rewards/missions - Get available missions
  • POST /api/rewards/complete-mission - Complete a mission

Staking Endpoints

  • POST /api/staking/stake - Stake tokens
  • POST /api/staking/unstake - Unstake tokens
  • GET /api/staking/pools - Get available staking pools
  • GET /api/staking/user-stakes - Get userโ€™s staking positions

Trading Endpoints

  • GET /api/trading/price - Get current $LERF token price
  • GET /api/trading/chart - Get price chart data
  • POST /api/trading/swap - Execute token swap
  • GET /api/trading/orderbook - Get order book data

Smart Contracts

$LERF Token Contract

  • Ethereum: 0x... (Replace with actual contract address)
  • Solana: ... (Replace with actual program ID)
  • BSC: 0x... (Replace with actual contract address)
  • Arbitrum: 0x... (Replace with actual contract address)

Staking Contracts

  • Auto-Staking Pool: 0x...
  • Multi-Chain Bridge: 0x...
  • Rewards Distributor: 0x...

Contributing

We welcome contributions from the community! Please read our Contributing Guidelines before submitting pull requests.

Development Workflow

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/your-feature
  3. Make your changes and commit: git commit -m 'Add your feature'
  4. Push to the branch: git push origin feature/your-feature
  5. Submit a pull request

Code Style

  • Use ESLint and Prettier for code formatting
  • Follow React best practices
  • Write unit tests for new features
  • Document your code with JSDoc comments

Testing

# Run unit tests
npm run test

# Run integration tests
npm run test:integration

# Run end-to-end tests
npm run test:e2e

# Generate coverage report
npm run test:coverage

Security

  • All smart contract interactions are audited
  • User funds are secured through multi-signature wallets
  • Regular security assessments and penetration testing
  • Bug bounty program available

For security issues, please email: security@boomchainlab.com

Roadmap

Q1 2024

  • Launch mainnet version
  • Add more staking pools
  • Implement cross-chain bridges
  • Mobile app development

Q2 2024

  • NFT rewards integration
  • DAO governance features
  • Advanced trading tools
  • Institutional features

Q3 2024

  • Layer 2 integration
  • DeFi protocol partnerships
  • Advanced analytics dashboard
  • API marketplace

Community

License

MIT ยฉ Boomchainlab


Disclaimer: This project involves cryptocurrency and DeFi protocols. Please do your own research and understand the risks before participating. Never invest more than you can afford to lose.

Releases

Packages

Used by

Contributors

Languages