Skip to main content

Prerequisites

Before you can start using TokenOps SDK, you'll need to set up your development environment and obtain the necessary credentials and access.

Development Environment​

Node.js and Package Manager​

Ensure you have Node.js 18.0.0 or higher installed:

# Check your Node.js version
node --version

# Should output v18.0.0 or higher

If you need to install or upgrade Node.js:

Blockchain Infrastructure​

RPC Provider​

You'll need access to blockchain RPC endpoints. Choose from:

Free Options​

Self-hosted Options​

  • Geth: Full Ethereum node
  • Erigon: Efficient Ethereum node
  • Local Development: Hardhat, Anvil, or Ganache

Example RPC Setup​

// Using Alchemy
const RPC_URL = 'https://eth-mainnet.g.alchemy.com/v2/YOUR_API_KEY';

// Using Infura  
const RPC_URL = 'https://mainnet.infura.io/v3/YOUR_PROJECT_ID';

// Local development
const RPC_URL = 'http://localhost:8545';

Wallet Setup​

Development Wallet​

For development, you'll need a wallet with some test funds:

  1. Install MetaMask browser extension
  2. Create a new wallet or import existing
  3. Switch to testnets (Sepolia, Goerli) for development
  4. Get test ETH from faucets

Programmatic Wallets​

import { privateKeyToAccount } from 'viem/accounts';

// Development only - never use in production
const account = privateKeyToAccount('0x...');

Production Wallet​

For production applications:

  • Hardware Wallets: Ledger, Trezor
  • Multi-sig Wallets: Gnosis Safe, other multi-sig solutions
  • Custodial Solutions: For enterprise applications

API Access​

TokenOps API Key​

To use the analytics and monitoring features:

  1. Visit TokenOps Platform
  2. Create an account
  3. Generate an API key
  4. Store securely in environment variables
# .env file
TOKENOPS_API_KEY=your_api_key_here

Environment Variables​

Set up your environment variables:

.env
# Required
TOKENOPS_API_KEY=your_tokenops_api_key

# Blockchain RPC
ETHEREUM_RPC_URL=your_ethereum_rpc_url
POLYGON_RPC_URL=your_polygon_rpc_url

# Development wallet (testnet only)
PRIVATE_KEY=your_development_private_key

## Network Configuration

### Supported Networks

TokenOps SDK supports all EVM-compatible networks:

| Network | Chain ID | Status |
|---------|----------|--------|
| Ethereum Mainnet | 1 | ✅ Fully Supported |
| Polygon | 137 | ✅ Fully Supported |
| Arbitrum One | 42161 | ✅ Fully Supported |
| Optimism | 10 | ✅ Fully Supported |
| BSC | 56 | ✅ Fully Supported |
| Sepolia (Testnet) | 11155111 | ✅ Fully Supported |



## Testing Environment

### Local Blockchain

For development and testing:

#### Hardhat
```bash
npm install --save-dev hardhat
npx hardhat node

Anvil (from Foundry)​

# Install foundry
curl -L https://foundry.paradigm.xyz | bash
foundryup

# Run local node
anvil

Test Funds​

Get test tokens for development:

Ethereum Testnets​

Other Networks​

Knowledge Prerequisites​

Required Knowledge​

  • JavaScript/TypeScript
  • Blockchain Basics: Accounts, transactions, gas fees
  • Web3 Fundamentals: Wallets, signing, contract interactions
  • Smart Contracts: Understanding of Solidity and EVM
  • DeFi Concepts: Tokens, vesting, staking, airdrops
  • React/Node.js

Security Considerations​

Development Best Practices​

  1. Never commit private keys to version control
  2. Use environment variables for sensitive data
  3. Separate development and production environments
  4. Use testnets for development and testing

Production Security​

  1. Hardware wallets for production operations
  2. Multi-signature wallets for team operations
  3. Audit smart contracts before deployment
  4. Monitor transactions and set up alerts

Verification Checklist​

Before proceeding, ensure you have:

  • Node.js 18+ installed
  • Package manager (npm/yarn/pnpm) available
  • RPC provider access configured
  • Wallet set up with test funds
  • TokenOps API key obtained
  • Environment variables configured

Next Steps​

Once you've completed all prerequisites:

  1. Quick Start - Build your first application
  2. Architecture Overview - Understand the SDK structure
  3. Provider Setup - Configure your blockchain provider

Getting Help​

If you need assistance with prerequisites:

Prerequisites complete? Continue to Quick Start to build your first TokenOps application!