Skip to content

README.md

Latest commit

 

History

History
179 lines (125 loc) · 3.98 KB

README.md

File metadata and controls

179 lines (125 loc) · 3.98 KB
Raw

ERC20 Token - Scroll Sepolia

A basic ERC20 token implementation using Foundry, ready for deployment on Scroll Sepolia testnet.

Features

  • ✅ Standard ERC20 implementation (OpenZeppelin)
  • ✅ Minting capability (owner only)
  • ✅ Burning capability
  • ✅ Configurable via environment variables
  • ✅ Full test suite
  • ✅ Deployment & verification scripts

Prerequisites

Quick Start

1. Install Dependencies

forge install foundry-rs/forge-std
forge install OpenZeppelin/openzeppelin-contracts --no-commit

2. Setup Environment

Copy .env.example to .env and fill in your values:

cp .env.example .env

Edit .env with:

  • PRIVATE_KEY: Your wallet private key (without 0x)
  • ETHERSCAN_API_KEY: Get it from Etherscan - works for all chains via API V2
  • Token configuration (optional)

3. Run Tests

forge test -vvv

4. Deploy to Scroll Sepolia

forge script script/Deploy.s.sol --rpc-url scroll_sepolia --broadcast --verify -vvvv

Or using environment variable:

forge script script/Deploy.s.sol --rpc-url $SCROLL_SEPOLIA_RPC_URL --broadcast --verify -vvvv

Project Structure

.
├── src/
│   └── MyToken.sol          # ERC20 token contract
├── script/
│   └── Deploy.s.sol         # Deployment script
├── test/
│   └── MyToken.t.sol        # Test suite
├── foundry.toml             # Foundry configuration
└── .env.example             # Environment template

Token Configuration

Customize your token via .env:

  • TOKEN_NAME: Token name (default: "My Token")
  • TOKEN_SYMBOL: Token symbol (default: "MTK")
  • INITIAL_SUPPLY: Initial supply without decimals (default: 1000000)

Useful Commands

# Build
forge build

# Test
forge test

# Test with gas report
forge test --gas-report

# Format code
forge fmt

# Deploy (without verification)
forge script script/Deploy.s.sol --rpc-url scroll_sepolia --broadcast

# Verify contract (if deployed separately)
forge verify-contract <CONTRACT_ADDRESS> src/MyToken.sol:MyToken --chain-id 534351 --watch

Network Info

Security Notes

  • ⚠️ Never commit your .env file
  • ⚠️ Never share your private key
  • ⚠️ Use a test wallet for testnets
  • ⚠️ Audit your code before mainnet deployment

License

MIT

ERC20 Token - Scroll Sepolia (Español)

Un token ERC20 básico usando Foundry, listo para desplegar en la testnet Scroll Sepolia.

Inicio Rápido

1. Instalar Dependencias

forge install foundry-rs/forge-std
forge install OpenZeppelin/openzeppelin-contracts --no-commit

2. Configurar Entorno

cp .env.example .env

Edita .env con tus valores.

3. Ejecutar Tests

forge test -vvv

4. Desplegar en Scroll Sepolia

forge script script/Deploy.s.sol --rpc-url scroll_sepolia --broadcast --verify -vvvv

Comandos Útiles

forge build          # Compilar
forge test           # Testear
forge fmt            # Formatear código

Información de Red