Skip to main content

SDK Overview

TokenOps SDK is a comprehensive TypeScript library designed for token operations on Ethereum and compatible blockchains. It provides a unified interface for vesting contracts, staking mechanisms, airdrops, token distribution, and analytics.

What is TokenOps SDK?​

TokenOps SDK abstracts the complexity of interacting with smart contracts for token operations, providing developers with:

  • Type-safe interfaces for all contract interactions
  • Factory patterns for deploying new contracts
  • Event handling and real-time monitoring
  • Provider abstraction supporting multiple blockchain libraries
  • Comprehensive analytics through integrated API services

Key Features​

🔒 Vesting Contracts (v3)​

Create and manage sophisticated token vesting schedules with linear releases, cliff periods, and milestone-based distributions.

🥩 Staking Contracts (v1)​

Deploy staking pools with configurable rewards, unbonding periods, and tier-based incentives.

🪂 Airdrop System (v2)​

Implement gas-efficient token distributions using Merkle trees with time-based windows and bonus mechanisms.

📤 Token Distribution (Disperse v2)​

Execute bulk token transfers with optimized gas usage and flexible fee structures.

📊 Analytics API​

Access comprehensive analytics, event monitoring, and webhook integrations for all your token operations.

Quick Start​

Get started with TokenOps SDK in under 5 minutes:

npm install tokenops-sdk
import { ViemProviderAdapter, TokenOpsApi } from 'tokenops-sdk';
import { createPublicClient, createWalletClient, http } from 'viem';
import { mainnet } from 'viem/chains';

// Setup provider
const provider = new ViemProviderAdapter(publicClient, walletClient);

// Initialize API
const api = new TokenOpsApi('YOUR_API_KEY');

// Ready to use!

Architecture Overview​

TokenOps SDK is built with modularity and extensibility in mind:

tokenops-sdk/
├── vesting-contracts-v3/    # Token vesting management
├── staking-contracts-v1/    # Staking mechanisms
├── airdrop-v2/             # Merkle-based airdrops
├── disperse-v2/            # Bulk token distribution
├── API/                    # Analytics and monitoring
└── provider/               # Blockchain provider abstraction

Who Should Use This?​

TokenOps SDK is perfect for:

  • DeFi Protocol Developers building token distribution mechanisms
  • Startup Teams implementing employee token vesting
  • DAOs managing governance token distribution
  • Enterprise Teams handling bulk token operations
  • Analytics Platforms tracking token operations

Getting Help​

  • Documentation: Comprehensive guides and API reference
  • Examples: Working code samples for all features
  • Community: Join our Discord for support and discussions
  • GitHub: Report issues and contribute to development

Ready to get started? Head over to Installation to begin your journey with TokenOps SDK.