Protocol Documentation
Tokenops has a comprehensive suite of smart contracts designed for token operations, distribution, and management. Our protocol provides secure, efficient, and flexible solutions for token airdrops, batch distributions, staking mechanisms, and vesting schedules.
- Token Airdrops with Merkle tree verification
- Token Disperse for multiple recipients
- Staking Systems with flexible reward mechanisms
- Vesting Contracts with various unlock schedules
⚡ Protocol Features
🪂 Airdrop System
Merkle tree-based token distribution system with staking integration. Supports both ERC20 and native tokens with configurable fees and bonus rewards.
Key Features:- Gas-efficient Merkle proof verification
- Claim-and-stake functionality
- Flexible fee structures
- Time-based distribution windows
💸 Disperse Protocol
Batch distribution of cryptocurrencies to multiple recipients in a single transaction. Supports both ETH and ERC20 tokens with customizable fee structures.
Key Features:- Batch transfers to multiple addresses
- Gas and token-based fee options
- Factory deployment pattern
- Emergency controls and safety mechanisms
🥩 Staking Contracts
Comprehensive staking system with multiple reward models and withdrawal mechanisms. Supports both immediate and unbonding staking with configurable parameters.
Key Features:- Flexible reward calculation models
- Unbonding periods with fixed APY
- Whitelist and tier management
- Role-based access control
🔒 Vesting System
Token vesting with various unlock schedules and governance capabilities. Supports linear, cliff, and milestone-based vesting with voting power delegation.
Key Features:- Multiple vesting schedule types
- Governance token voting integration
- Native and ERC20 token support
- Milestone-based achievement vesting
🚀 TokenOps SDK
📦 TypeScript SDK
TokenOps SDK is a comprehensive TypeScript library that abstracts the complexity of interacting with our smart contracts. Get started with token operations in minutes, not hours.
Key Features:- Type-safe interfaces for all contract interactions
- Factory patterns for easy contract deployment
- Provider abstraction supporting multiple blockchain libraries
- Comprehensive analytics through integrated API services
- Event handling and real-time monitoring
🌐 Deployment Information
📋 Contract Addresses
Find all deployed contract addresses across different networks. Currently deployed on testnets with mainnet deployments coming soon.
Available Networks:- Ethereum Sepolia (Testnet)
- Mainnet deployments - Coming Soon
🔧 Getting Started
For Developers
- Choose Your Use Case: Select the appropriate TokenOps module based on your needs
- Review Documentation: Each module has comprehensive API documentation
- Test on Sepolia: Use our deployed testnet contracts for development
- Deploy Custom Contracts: Use our factory contracts for custom deployments
For Integrators
- Understand the Architecture: Review the factory pattern and fee structures
- Implement Error Handling: Use our standardized error types
- Test Thoroughly: Validate all operations before mainnet deployment
- Monitor Events: Use contract events for tracking operations
🛡️ Security Features
- Battle-Tested Contracts: Audited and extensively tested
- Role-Based Access Control: Granular permission management
- Reentrancy Protection: Secure against common attack vectors
- Input Validation: Comprehensive parameter checking
- Emergency Controls: Owner-controlled emergency functions
📖 Documentation Structure
Our documentation is organized into focused sections:
- SDK - TypeScript SDK for easy integration
- Airdrop - Merkle tree distributions with staking
- Disperse - Batch token distributions
- Staking - Staking contracts and rewards
- Vesting - Token vesting and governance
- Deployment Addresses - Contract addresses
Each section includes:
- Complete API reference
- Usage examples
- Security considerations
- Gas optimization tips
- Error handling guides
Ready to start building with TokenOps? Choose your module above and dive into the comprehensive documentation!