Skip to content

dehepting/path-dao-token

Repository files navigation

PATH DAO Token

Professional, secure, upgradeable ERC-20 governance token for the PATH DAO.

🎯 Quick Links

Mainnet Deployment:

Status: ✅ Production-ready


📋 Features

  • ERC-20 Standard - Full compliance, works everywhere
  • 100M Hard Cap - Max supply enforced in code
  • Upgradeable (UUPS) - Add features without migration
  • Pausable - Emergency stop mechanism
  • Governance Ready - Built-in voting (ERC20Votes)
  • Role-Based Security - Multi-sig compatible
  • Vesting Support - Team token time-locks
  • Guild.xyz Compatible - Token gating ready

🚀 Quick Start

Prerequisites

node >= 18.0.0
npm >= 9.0.0

Installation

npm install

Environment Setup

cp .env.example .env
# Add your private key and API key to .env

Deploy to Polygon Mainnet

# Update scripts/deploy.js first (see docs/MAINNET_DEPLOYMENT_GUIDE.md)
npx hardhat run scripts/deploy.js --network polygon

📚 Documentation

For Deployment:

For Understanding:

Post-Deployment:


🏗️ Project Structure

path-dao-token/
├── contracts/
│   ├── PATH.sol              # Main token contract
│   └── PATHVesting.sol       # Vesting contract
├── scripts/
│   ├── deploy.js             # Main deployment script
│   ├── deploy-vesting.js     # Vesting deployment
│   └── utils/                # Helper scripts for testing
├── docs/                     # All documentation
├── test/                     # Unit tests (add your own)
└── hardhat.config.js         # Hardhat configuration

🔐 Security

Roles:

  • DEFAULT_ADMIN_ROLE - Controls all roles
  • MINTER_ROLE - Can mint tokens (up to 100M cap)
  • UPGRADER_ROLE - Can upgrade contract
  • PAUSER_ROLE - Can pause/unpause transfers

Mainnet Security:

  • All roles → Gnosis Safe (3-of-5 multi-sig)
  • Hardware wallets recommended for signers
  • 48hr timelock on upgrades (recommended)

📊 Token Distribution

Allocation Amount Status
Treasury 37M Operations, partnerships
Community Rewards 26M Course completions, contributions
Founders 22M Vesting: 6mo cliff, 4yr linear
Early Members 8M Vesting: 1yr cliff, 3yr linear
Liquidity Pool 7M DEX liquidity
Total 100M Hard cap enforced

🛠️ Development

Compile Contracts

npx hardhat compile

Run Tests

npx hardhat test

Deploy to Testnet (Amoy)

npx hardhat run scripts/deploy.js --network amoy

Verify Contract

npx hardhat verify --network polygon YOUR_CONTRACT_ADDRESS

🌐 Networks

Testnet (Amoy):

Mainnet (Polygon):


📞 Resources

Tools:

Documentation:


✅ Pre-Mainnet Checklist

Before deploying to mainnet:

  • Gnosis Safe created with 3-of-5 signers
  • scripts/deploy.js updated (100M mint, Safe addresses)
  • Deployment wallet funded with 10 POL
  • Team aligned on distribution plan
  • Read MAINNET_DEPLOYMENT_GUIDE.md

📝 License

MIT License - See LICENSE file


👥 Team

Built by the PATH DAO community


🔗 Links


Built with ❤️ for the PATH DAO community

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors