Skip to content

profiles.md

Latest commit

 

History

History
203 lines (136 loc) · 4.2 KB

profiles.md

File metadata and controls

203 lines (136 loc) · 4.2 KB

Understanding Foundry Profiles

Foundry profiles let you manage different configurations for your smart contract development workflow. Think of them like "modes" or "settings" that you can switch between depending on your needs.

What are Profiles?

Profiles in Foundry are named configuration sets that you can use to:

  • optimize for different scenarios (gas, testing, deployment)
  • use different compiler settings
  • configure different testing parameters
  • set up different build environments

Available Profiles in LazerForge

LazerForge comes packaged with several pre-configured profiles:

Default Profile

forge build --profile default
# or simply
forge build

The default profile is used when no profile is specified. It includes:

  • standard compiler settings
  • basic optimization
  • normal testing parameters

Gas Optimization Profile

forge build --profile gas

Use this profile when you want to:

  • optimize your contracts for gas efficiency
  • deploy to production
  • compare gas costs between different implementations

CI Fuzz Testing Profile

forge test --profile CI.fuzz

This profile is designed for CI environments with:

  • increased number of fuzz runs (1024)
  • more thorough testing
  • better coverage

Via-IR Profile

forge build --profile via_ir

Use this profile when:

  • working with complex contracts
  • need to use the via-IR pipeline
  • dealing with large contract sizes

FFI Profile

forge test --profile ffi

For tests that require:

  • Foreign Function Interface (FFI)
  • external process calls
  • system-level interactions

How to Use Profiles

1. Using Command Line Flags

The most common way to use profiles is with the --profile flag:

# Build with gas optimization
forge build --profile gas

# Run tests with CI settings
forge test --profile CI.fuzz

# Deploy with via-IR
forge script script/Deploy.s.sol:DeployScript --profile via_ir

2. Using Environment Variables

You can set a profile for all commands in your current shell:

# Set profile for current shell
export FOUNDRY_PROFILE=gas

3. In Deployment Scripts

When deploying contracts:

# Deploy with gas optimization
forge script script/Deploy.s.sol:DeployScript --profile gas --rpc-url $RPC_URL

# Deploy with via-IR for complex contracts
forge script script/Deploy.s.sol:DeployScript --profile via_ir --rpc-url $RPC_URL

Common Use Cases

Development

# Normal development
forge build
forge test

# When you need gas optimization
forge build --profile gas

Testing

# Quick local tests
forge test

# Thorough fuzz testing
forge test --profile CI.fuzz

Deployment

# Standard deployment
forge script script/Deploy.s.sol:DeployScript --rpc-url $RPC_URL

# Gas-optimized deployment
forge script script/Deploy.s.sol:DeployScript --profile gas --rpc-url $RPC_URL

Creating Your Own Profiles

You can add custom profiles to your foundry.toml:

[profile.custom]
# Your custom settings here
optimizer_runs = 200
fuzz_runs = 500

Any settings not specified within a profile will use the default settings. Make sure to override settings from profile.default with a custom profile when needed.

Best Practices

  1. Use Appropriate Profiles

    • Use gas profile for production deployments
    • Use CI.fuzz for thorough testing
    • Use via_ir for complex contracts

  2. Document Profile Usage

    • Add comments in your foundry.toml
    • Document profile requirements in your README

  3. CI/CD Considerations

    • Use CI.fuzz in your CI pipeline
    • Consider using different profiles for different environments

  4. Development Workflow

    • Start with default profile for development
    • Switch to gas profile before deployment
    • Use via_ir when needed for complex contracts

Profile Inheritance

Profiles can inherit from other profiles using the inherits field. This allows you to build upon existing configurations while adding or overriding specific settings.

[profile.production]
inherits = "default"
optimizer = true
optimizer_runs = 1000

Navigation: