Skip to content

TokenFon Pools Project

What is TokenFon Pools?

TokenFon Pools, developed by Cerratech for TokenFon, is a token distribution system tailored to manage and customize the distribution of tokens or coins within an ecosystem or project. The system provides flexible distribution mechanisms to accommodate various token allocation scenarios and beneficiary requirements.

The platform introduces two distinct types of pools to cater to different distribution needs: Non-Vesting Pools for immediate token claims and Vesting Pools for periodic, scheduled distributions with predefined parameters and calculations.

What Does It Bring?

Core Functionalities

  • Dual Distribution Models: Support for both vesting and non-vesting pools to meet various distribution needs
  • Flexible Token Management: Robust system for customizable token distribution within TokenFon's ecosystem
  • Beneficiary Management: Comprehensive system for handling beneficiary data and distribution operations
  • Transparent Distribution: Secure and transparent token distribution with blockchain-based verification

Technical Capabilities

  • Advanced Calculations: Precise claimable amount calculations using predefined parameters for vesting pools
  • Multi-Pool Support: System designed to handle multiple pools simultaneously through environment configuration
  • Modern UI Integration: Clean interface with wallet and contract interactions through modern frameworks
  • Scalable Architecture: Built to accommodate various distribution schemes within the TokenFon ecosystem

How It Works

Distribution Models

1. Non-Vesting Pools

  • Immediate Claims: Allow beneficiaries to claim their tokens directly from the start of the distribution period
  • Simple Distribution: Straightforward token allocation without time-based restrictions
  • Full Access: Beneficiaries can claim their entire allocated amount immediately when distribution begins

2. Vesting Pools

  • Periodic Distribution: Distribute tokens over time based on predefined schedules
  • Calculated Claims: Use _calculateClaimableAmount function to determine available tokens
  • Parameter-Based: Distribution calculations based on distribution rate and period length
  • Fair Scheduling: Ensures adherence to distribution timeline and prevents early claiming

Architecture Components

Smart Contract System

  • Flexible Initialization: Supports configurable parameters to accommodate different distribution scenarios
  • Beneficiary Management: setClaimableAmounts function for setting and managing beneficiary data
  • Vesting Calculations: _calculateClaimableAmount function ensures precise calculations for vesting pools
  • Distribution Control: Robust contract handling for both vesting and non-vesting distribution operations

User Interface

  • Shadcn Framework: Clean, simple interface developed with modern UI framework
  • TokenFon Branding: Interface customized to align with TokenFon's visual identity
  • Wallet Integration: Supports wallet and contract interactions through wagmi.sh and WalletConnect
  • Multi-Pool Display: Card-based UI allowing users to interact seamlessly with respective pools

Configuration Management

The system uses environment variables for flexible pool management:

  • VITE_POOL_ADDRESSES: Configuration of multiple pool contract addresses
  • VITE_POOL_TYPES: Definition of pool types (vesting vs non-vesting)
  • VITE_POOL_NAMES: User-friendly names for pool identification

Distribution Process

  1. Pool Setup: Configure pool parameters and beneficiary allocations
  2. Contract Deployment: Initialize smart contract with distribution parameters
  3. Beneficiary Registration: Set claimable amounts and beneficiary data
  4. Claim Execution: Users connect wallets and claim available tokens
  5. Calculation Verification: System calculates and verifies claimable amounts
  6. Token Transfer: Smart contract executes secure token distribution

Technical Implementation

Technology Stack

  • Smart Contracts: Solidity for distribution contract development
  • Frontend: React.js with Shadcn/ui framework
  • Wallet Integration: wagmi.sh and WalletConnect for secure wallet interactions
  • Configuration: Environment-based pool management system

Deployment Infrastructure

  • Frontend: Cloudflare Pages for UI deployment

Key Features

  • Modern Framework Selection: Shadcn/ui chosen for clean, efficient UI development
  • Flexible Contract Design: Supports multiple distribution scenarios through configurable parameters
  • Precise Calculations: Advanced algorithms for fair vesting distribution calculations
  • Multi-Pool Architecture: System designed to handle various distribution schemes simultaneously
  • TokenFon Integration: Complete alignment with TokenFon ecosystem and branding

Project Scope & Limitations

Included Features

  • Development of a smart contract to handle vesting and non-vesting distributions
  • Implementation of claim calculation based on distribution rate and period length for vesting pools
  • Creation of a user-friendly UI with shadcn framework, aligned with TokenFon's branding
  • Wallet and contract interaction features using wagmi.sh and WalletConnect
  • Configuration support for multiple pools through environment variables

Excluded Features

  • Integration of advanced analytics or reporting features
  • Support for external chains or networks outside the TokenFon ecosystem
  • Additional security features like multi-factor authentication

Project Assumptions

  • The TokenFon testnet chain remains stable and operational
  • Distribution parameters are clearly defined and provided before contract deployment

This Pools implementation provides TokenFon with a comprehensive, scalable token distribution solution that accommodates both immediate and time-based distribution needs while maintaining security, transparency, and ease of use for all ecosystem participants.