Skip to content

README.md

Latest commit

 

History

History
288 lines (213 loc) · 11.1 KB

README.md

File metadata and controls

288 lines (213 loc) · 11.1 KB

CKBoost - Gamified Community Engagement Platform

Important

This project is currently under active development as part of the Nervos Community Catalyst initiative and is not yet ready for production use.

A purpose-built open-source gamified engagement platform for the CKB ecosystem, designed to transform community engagement from scattered, ad-hoc efforts into a structured, rewarding, and measurable system that drives participation, incentivizes real contributions, and encourages ecosystem growth.

🎯 Mission

CKBoost directly supports the goals of the Nervos Community Catalyst initiative by providing the technical backbone for:

  • Structured Engagement: Transform random community efforts into organized campaigns with clear goals
  • Verifiable Contributions: Implement "proof of participation" for all types of community activities
  • Fair Rewards: Distribute on-chain rewards transparently based on actual contributions
  • Ecosystem Growth: Drive both off-chain engagement and on-chain activity through gamification

🌟 Overview

CKBoost addresses key challenges in community management:

  • Inclusive Participation: Reward community members who don't have directly transferable skills for formal tracks
  • Synergized Effort: Coordinate community action across social media, off-chain, and on-chain platforms
  • Fun & Incentivized: Create enthusiasm for participation through gamification and rewards
  • On-Chain Activity: Leverage CKB features and encourage more blockchain interaction

Key Features

  • Campaign & Quest Management: Multi-task campaigns with detailed quests, success metrics, and fully funded reward pools
  • On-Chain Points & Badges: All achievements tracked via dedicated UDT for transparent rewards
  • Gamification Elements: Streak bonuses, difficulty multipliers, dynamic leaderboards, and badge milestones
  • Anti-Sybil Verification: Flexible verification starting with manual Telegram proof, expanding to DID/KYC
  • Community Tipping: Peer recognition system with democratic approval flow and automated payouts
  • Comprehensive Dashboards: Tools for campaign creators, admins, and reviewers to monitor progress

🏗️ Project Structure

CKBoost/
├── dapp/                    # Next.js frontend application
│   ├── app/                 # App Router pages and layouts
│   ├── components/          # Reusable UI components
│   ├── lib/                 # Business logic and data management
│   │   ├── types/           # TypeScript type definitions
│   │   ├── mock/            # Development mock data
│   │   ├── ckb/             # Blockchain integration layer
│   │   ├── providers/       # React context providers
│   │   └── services/        # Data service abstraction
│   └── ...                  # Standard Next.js structure
├── contracts/               # Smart contracts (Rust)
│   ├── contracts/           # Individual contract implementations
│   │   ├── ckboost-campaign-type/    # Campaign management logic
│   │   ├── ckboost-campaign-lock/    # Secure fund vaults
│   │   ├── ckboost-protocol-type/    # Governance & minting
│   │   ├── ckboost-protocol-lock/    # Protocol governance
│   │   ├── ckboost-user-type/        # Verification & bindings
│   │   └── ckboost-shared/           # Common utilities
│   └── tests/               # Integration tests
├── docs/                    # Documentation and specifications
│   ├── recipes/             # Transaction skeleton definitions
│   └── *.prd.txt           # Product requirements documents
└── schemas/                 # Molecule schema definitions

🚀 Getting Started

Prerequisites

  • Node.js 18+ with pnpm
  • Rust toolchain for contract development
  • CKB Node for blockchain interaction (development/testnet)

Quick Start

  1. Clone the repository

    git clone https://github.com/Alive24/CKBoost.git
cd CKBoost

  2. Start the frontend application

    cd dapp
pnpm install
pnpm dev

    The application will be available at http://localhost:3000

  3. Build smart contracts (optional for frontend development)

    cd contracts
make build

🛠️ Technical Architecture

Decentralized Design Philosophy

CKBoost implements a new pattern of decentralization for dApps:

  • Anyone-Can-Host Backend: All backend services use open-source Cloudflare Workers that anyone can deploy
  • Trustless Operation: No reliance on any single, centralized operator
  • Community Infrastructure: Campaign sponsors and community members can host their own services
  • Resilient Network: Multiple interoperable services instead of single points of failure

Technology Stack

Frontend (dApp)

  • Framework: Next.js 15 with App Router
  • Styling: Tailwind CSS with shadcn/ui components
  • State Management: React Context with CKB CCC integration
  • Wallet Integration: @ckb-ccc/connector-react for universal wallet support
  • Data Layer: Abstracted service layer supporting mock and blockchain data

Smart Contracts

  • ckboost-protocol-type: Governance & Points UDT minting
  • ckboost-protocol-lock: Protocol governance and treasury management
  • ckboost-campaign-type: Campaign logic and quest management
  • ckboost-campaign-lock: Secure vaults for campaign funds
  • ckboost-user-type: Submission, verification, and social bindings

Decentralized API Services

  • Infrastructure: Open-source Cloudflare Workers
  • Hosting: By campaign sponsors and community members
  • Purpose: Indexing, proof validation, and coordination

Data Storage Strategy

  • Critical State: CKB Cell data for all on-chain states
  • Non-Critical Data: Anyone-can-host Neon storage for submissions
  • Performance: Local cache for fee optimization

📋 Core User Flows

Campaign Creation Flow

Define quests → Fund campaign → Set proof requirements → Get admin approval → Launch → Monitor submissions → Distribute rewards

Contributor Flow

Connect wallet → Browse campaigns → Complete tasks → Submit proof → Pass verification → Claim rewards → Earn badges & ranking

Tipping Flow

Propose tip → Receive 5 peer approvals → Automated treasury payout → Permanent profile record

Admin Flow

Identity verification → Campaign sponsor verification → Campaign approval → Base campaign creation

🎮 Example Campaign Types

  • AMA Boost: Points for questions, shares, and Nervos discussion amplification
  • Knowledge Boost: Share and summarize Knowledge Base articles
  • On-Chain Quests: Lock CKB for iCKB, add DEX liquidity, interact with DeFi
  • Community Governance: Engage with proposals and provide feedback

🔐 Security & Risk Management

Security Measures

  • Escrow Protection: Campaign lock scripts protect all escrowed assets
  • Multi-Signature: Support for high-value campaign management
  • Time Locks: Campaign duration enforcement and deadline management
  • Gradual Rollout: Small initial contract funds with progressive scaling

Anti-Sybil Protection

  • Locked Rewards: Rewards remain locked until verification passes
  • Multi-Method Verification: Telegram, DID, KYC, and manual review options
  • Reputation System: Build trust through consistent participation

📈 Development Roadmap

Milestone 1: Foundation & Core MVP (~Month 1)

  • ✅ Next.js scaffold with CCC wallet integration
  • ✅ Visual and interaction prototyping
  • 🔄 Smart contract development for core scripts
  • 🔄 Campaign & quest creation flows
  • 🔄 Points UDT and reward distribution

Milestone 2: Advanced Features (~Month 2)

  • 📅 Expanded verification methods
  • 📅 Leaderboards and user profiles
  • 📅 Gamification features (streaks, multipliers, badges)
  • 📅 Tipping system with peer approvals
  • 📅 Admin dashboard and analytics

Milestone 3: Launch Preparation (~Month 3)

  • 📅 Deploy test campaigns with real users
  • 📅 Automated on-chain verification
  • 📅 Documentation and onboarding guides
  • 📅 Final testing and optimization
  • 📅 Community feedback integration

💰 Funding

This project is funded by the CKB Community Fund DAO:

  • Total Grant: $20,000 USD
  • Payment Structure: 10% upfront, 90% across 3 milestones
  • Timeline: 3 months from commencement
  • Purpose: Support design, development, and deployment of CKBoost

🤝 Contributing

We welcome contributions from the community! Here's how you can help:

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/amazing-feature
  3. Make your changes following the coding standards
  4. Add tests for new functionality
  5. Submit a pull request with clear description

Development Standards

  • TypeScript: Strict type checking enabled
  • Code Quality: ESLint/Prettier for formatting
  • Commits: Conventional commit format
  • Testing: High coverage for critical paths

📚 Documentation

For Users

  • Campaign Creation Guide: How to launch engaging campaigns
  • Quest Participation: How to complete quests and earn rewards
  • Verification Guide: Understanding identity requirements
  • Tipping System: How to recognize exceptional contributions

For Developers

  • Architecture Overview: Understanding the decentralized design
  • Contract Interface: Smart contract specifications
  • API Documentation: Decentralized service APIs
  • Integration Guide: Adding CKBoost to your project

Key Resources

Utilities

Size Analysis

cargo bloat --release --target riscv64imac-unknown-none-elf --crates --package ckboost-campaign-type

🌐 Deployment

Netlify Frontend

# Automatic deployment on push to main branch
git push origin main

Decentralized Services

# Deploy your own Cloudflare Worker instance
cd services
wrangler deploy

Smart Contracts

cd contracts
make deploy-testnet    # Deploy to CKB testnet
make deploy-mainnet    # Deploy to CKB mainnet

🆘 Support & Community

🙏 Acknowledgments

  • Nervos Community Catalyst for sponsoring this initiative
  • CKB Community Fund DAO for funding support
  • Nervos Foundation for the innovative CKB blockchain
  • Community Contributors who make this project possible

📄 License

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

Built with ❤️ by Alive24 for the Nervos Community