Configuration

Complete guide to configuring your Dop-Stick environment

Compiler Settings

Configure the Solidity compiler options and optimization settings

compiler?: {
    version?: string;              // Solidity version
    name?: string;                 // 'hardhat', 'foundry', 'truffle'
    compileCommand?: string;       // e.g., 'npx hardhat compile'
    skip?: boolean;                // Skip compilation
    optimization?: {
        enabled?: boolean;
        runs?: number;
    }
}

Mode & Paths

Set the operation mode and configure essential file paths

mode?: 'basic' | 'strict' | 'auto-pilot-beta' | 'copilot-beta'

paths: {
    upgrades: string;      // Required: Path to upgrade definitions
    typechain?: string;    // TypeChain output directory
    contracts?: string;    // Solidity contracts directory
    artifacts?: string;    // Compiled artifacts directory
    cache?: string;        // Cache directory
    reports?: string;      // Reports output directory
}

Security Settings

Configure security validations and checks

security?: {
    ownershipValidation?: boolean;
    selectorCollisionCheck?: boolean;
    facetAddressValidation?: boolean;
    estimateGasBeforeUpgrade?: boolean;
    verifyContracts?: boolean;
}

Gas & Performance

Optimize gas usage and parallel execution settings

gas?: {
    maxRetries?: number;
    maxFeePerGas?: string;
    maxPriorityFeePerGas?: string;
}

parallelization?: {
    enabled?: boolean;
    maxConcurrent?: number;
}

Retry & Error Handling

Configure retry behavior and error handling strategies

retry?: {
    enabled?: boolean;
    maxRetries?: number;
    retryDelay?: number;
    exponentialBackoff?: boolean;
    maxDelay?: number;
}

Contract Verification

Configure contract verification settings for Etherscan and Sourcify

verification?: {
    enabled?: boolean;
    etherscan?: {
        apiKey: string;
        delay?: number;
    }
    sourcify?: {
        enabled: boolean;
    }
}