Skip to main content

Developer Command

Developer utilities and helpers for EVVM contract development.

Command​

./evvm developer [options]

Description​

The developer command provides utilities for EVVM developers working with smart contracts. It includes tools for generating interfaces, running tests, and other development workflows.

info

This command is primarily intended for EVVM core developers and advanced users who need to work with contract interfaces or modify EVVM contracts.

Options​

--makeInterface, -i​

Generate Solidity interfaces for EVVM contracts.

  • Type: boolean
  • Default: false
  • Usage: ./evvm developer --makeInterface

This option:

  1. Prompts to select a contract (Core, NameService, P2PSwap, Staking, Estimator, Treasury, TreasuryExternalChainStation, TreasuryHostChainStation, or All)
  2. Uses cast interface to generate Solidity interface files
  3. Replaces SPDX license headers with EVVM-NONCOMMERCIAL-1.0
  4. Renames interfaces with I prefix (e.g., ICore.sol)
  5. Saves to ./lib/evvm/testnet/src/interfaces/

--runTest, -t​

Run the test suite for EVVM contracts with configurable filters.

  • Type: boolean
  • Default: false
  • Usage: ./evvm developer --runTest

This option:

  1. Prompts to select a contract to test
  2. Prompts for test type:
    • Unit correct - Tests for expected successful operations
    • Unit revert - Tests for expected revert conditions
    • Fuzzing - Property-based fuzz tests
    • Full test suite - All test types combined
  3. Prompts for output format:
    • Markdown - Saves results as .md file
    • JSON - Saves results as .json file
    • None - Terminal output only
  4. Runs forge test with --summary --detailed --gas-report -vvv and appropriate --match-contract filters
  5. Saves results to ./lib/evvm/testnet/output/testResults/ with timestamp

Usage Examples​

Generate Contract Interfaces​

./evvm developer --makeInterface

This command will:

  • Read compiled contract artifacts
  • Generate interface files for all EVVM contracts
  • Save interfaces to the appropriate directory

Output:

Generating contract interfaces...
✓ ICore.sol
✓ INameService.sol
✓ IStaking.sol
✓ IEstimator.sol
✓ ITreasury.sol
✓ IP2PSwap.sol

Interfaces generated successfully!

Use Cases​

For Integration Developers​

Generate interfaces to:

  • Build external contracts that interact with EVVM
  • Create mock contracts for testing
  • Ensure type-safe contract interactions

For Core Developers​

Generate interfaces to:

  • Update contract interfaces after modifications
  • Maintain consistency across contracts
  • Document public contract APIs

Usage Examples​

Interactive Mode​

Run without flags for interactive menu:

./evvm developer

This shows options:

Select an action:
  🭬 Generate Contract Interfaces
    Run Full Test Suite
    exit

Generate Contract Interfaces​

./evvm developer --makeInterface

Run Tests​

./evvm developer --runTest
  • deploy - Deploy EVVM contracts
  • help - Display all CLI commands

Examples​

Complete Development Workflow​

  1. Generate interfaces:

    ./evvm developer --makeInterface

  2. Deploy to local testnet:

    ./evvm deploy --skipInputConfig

  3. Test integration:

    # Use generated interfaces in your test contracts

Prerequisites​

Before using developer commands:

  • Foundry - Required for contract compilation
  • Bun - Required for CLI execution
  • Compiled contracts - Run forge build before generating interfaces

Troubleshooting​

Contracts Not Compiled​

If interface generation fails:

Error: No compiled contracts found

Solution: Compile contracts first:

forge build

Permission Issues​

If file writing fails:

Solution: Ensure you have write permissions in the project directory.

Best Practices​

  1. Regenerate after changes: Always regenerate interfaces after modifying contracts
  2. Version control: Commit generated interfaces to version control
  3. Testing: Use generated interfaces in test contracts for type safety
  4. Documentation: Interfaces serve as contract API documentation