Alpha Points Documentation

This directory contains comprehensive documentation for the Alpha Points protocol, including system architecture, feature documentation, and technical specifications for the investor data room.

Documentation Structure

🏗️ Architecture

System architecture diagrams and technology stack

• System Architecture Diagram: Complete Mermaid diagram with High-Level, Mid-Level, and Low-Level architecture views
• Technology Stack: Comprehensive breakdown of all technologies, versions, and dependencies across the entire system
• Architecture Overview: Detailed explanation of the three-tier architecture and key technologies

📊 Features

Detailed feature documentation and system mechanics

• Alpha Points Mechanics: Complete guide to how Alpha Points work, including balance management, point types, and earning mechanisms
• Rewards Engine Model: Comprehensive documentation of the entire rewards engine architecture and distribution model
• Features Overview: Summary of all features with getting started guides

Quick Navigation

For Investors

• Architecture Overview: High-level system architecture and technology choices
• Technology Stack: Complete technical foundation and scalability considerations
• Features Summary: Key features and value propositions

For Partners

• Rewards Engine Model: Partner ecosystem and revenue sharing (70/20/10 split)
• TVL-Backed Quotas: Collateral-based minting rights and quota management
• Partner Integration Guide: Getting started with partner onboarding

For Developers

• Alpha Points Mechanics: Technical details of point earning, spending, and balance management
• Smart Contract Architecture: Complete system component relationships
• Integration Guide: SDK integration and development setup

For Users

• User Guide: How to earn points, claim perks, and optimize strategy
• System Overview: Understanding the Alpha Points ecosystem

System Overview

What is Alpha Points?

Alpha Points is a comprehensive blockchain-based rewards protocol built on Sui, enabling partners to create sustainable reward mechanisms through TVL-backed quotas, automated revenue sharing, and dynamic growth loops.

Key Features

🏦 TVL-Backed Partner System

• Partners deposit SUI/USDC as collateral
• Receive minting quotas based on Total Value Locked (TVL)
• Daily throttling: 3% of TVL value per day maximum
• Lifetime limits: 1,000 points per USDC of collateral

Architecture Highlights

Three-Tier Architecture

1. High-Level: Client applications, blockchain infrastructure, external services
2. Mid-Level: Frontend systems, partner systems, smart contract layers
3. Low-Level: Detailed components, hooks, contract specifics, transaction flows

Modern Tech Stack

• Frontend: React 18 + TypeScript + Vite
• Blockchain: Sui Move smart contracts (2024.alpha edition)
• Integration: @mysten/sui SDK v1.30.1
• Styling: Tailwind CSS + Headless UI
• State Management: React Query + Context API

Smart Contract Modules (Active V2/V3)

• admin_v2.move: Protocol governance with multi-sig and timelock controls
• ledger_v2.move: Fixed point accounting with proper APY calculations
• partner_v3.move: USDC-backed partner vaults with DeFi integration
• generation_manager_v2.move: Partner action registration and quota management
• perk_manager_v2.move: Points redemption marketplace with USDC payouts
• oracle_v2.move: Multi-source price feeds (Pyth + CoinGecko)
• integration_v2.move: User-facing entry points and safety checks

Economic Model

Value Alignment

• Users: Earn points through staking, activities, and engagement
• Partners: Generate revenue through perk creation and TVL growth
• Protocol: Sustainable tokenomics with built-in growth mechanisms

Risk Management

• Collateral protection with appropriate LTV ratios
• Daily throttling prevents rapid dilution
• Oracle security with price feed validation
• Emergency controls and pause mechanisms

Implementation Status

✅ Production Ready

• Core ledger and balance management
• Partner onboarding and quota systems
• Perk creation and claiming mechanisms
• Revenue distribution and TVL growth
• Oracle integration and price feeds

🔄 Active Development

• Enhanced analytics and monitoring
• Volatility hedge system
• Advanced partner features
• Governance and compliance tools

Getting Started

Documentation Path

1. Start with Architecture: Understand the system design and technology choices
2. Review Features: Deep dive into specific mechanics and capabilities
3. Choose Your Role: Follow role-specific getting started guides
4. Implement: Use technical references and integration guides

Key Resources

• Mermaid Architecture Diagram: Visual system overview
• Technology Stack Breakdown: Complete technical specifications
• Alpha Points Mechanics: Core system functionality
• Rewards Engine Model: Complete business logic

Technical Constants

• 1 USD = 1,000 Alpha Points: Base conversion rate
• SUI Price: ~$3.28 = 3,280 Alpha Points (testnet rate)
• Partner Quota: 1,000 points per USDC of collateral
• Daily Throttle: 3% of TVL value per day
• Revenue Split: 90% producer / 10% platform

Code References

All documentation is based on actual smart contract implementation. Key reference files:

• sources/admin_v2.move: Protocol governance and configuration management
• sources/ledger_v2.move: Fixed point mechanics and balance management
• sources/partner_v3.move: USDC-backed partner system with DeFi integration
• sources/generation_manager_v2.move: Partner integration infrastructure
• sources/perk_manager_v2.move: Points redemption and revenue distribution
• sources/oracle_v2.move: Multi-source price feeds and validation
• sources/integration_v2.move: User-facing entry points and safety checks

Note: All .disabled modules are legacy V1 implementations kept for reference only.

This documentation provides comprehensive coverage of the Alpha Points protocol for investors, partners, developers, and users alike.