foundry-erc20-factory
v1.0.1
Published
Scaffold a custom ERC-20 token with Foundry. Pick features: burn, tax, reflection, vesting. Tests included.
Maintainers
Readme
foundry-erc20-factory
Scaffold a custom ERC-20 token with Foundry in seconds.
npx foundry-erc20-factoryWhat it does
Interactive CLI that generates a complete Foundry project with a customized ERC-20 token contract, tests, and deployment script.
Interactive prompts
? Token name: MyToken
? Token symbol: MTK
? Initial supply: 1000000000
? Features:
[x] Burnable
[ ] Mintable
[x] Pausable
[x] Transfer tax
[ ] Max wallet
? Deploy chain: BaseGenerated project structure
MyToken/
foundry.toml
src/Token.sol # Your customized ERC-20
test/Token.t.sol # Foundry tests for all selected features
script/Deploy.s.sol # Deployment script
.env.example # Template with PRIVATE_KEY and RPC_URL
.gitignorePrerequisites
- Foundry installed (
curl -L https://foundry.paradigm.xyz | bash && foundryup)
Quick start
npx foundry-erc20-factory
cd MyToken
forge install OpenZeppelin/openzeppelin-contracts
forge build
forge testFeatures
| Feature | Description |
|---------|-------------|
| Burnable | Public burn() function via OpenZeppelin ERC20Burnable |
| Mintable | Owner-only mint() function |
| Pausable | Owner can pause/unpause all transfers |
| Transfer tax | Configurable fee on transfers routed to a fee recipient |
| Max wallet | Anti-whale limit on maximum token balance per address |
Deploy
cp .env.example .env
# Edit .env with your private key and RPC URL
source .env
forge script script/Deploy.s.sol --rpc-url $RPC_URL --broadcast --verifyBuilt by THRYXAGI
