Skip to content

Latest commit

 

History

History
145 lines (99 loc) · 5.13 KB

README.md

File metadata and controls

145 lines (99 loc) · 5.13 KB

Recon - Smart Contract Fuzzing Extension

Recon Logo

Seamless integration of Foundry, Medusa, and Echidna for smart contract testing

Features • Installation • Getting Started • Usage • Configuration • Troubleshooting • License

Features

The Recon extension is a VS Code extension that streamlines smart contract testing by providing:

  • One-click setup: Automatically install and configure Chimera templates
  • Integrated fuzzing: Run Echidna and Medusa directly from VS Code
  • Contract explorer: Browse and select target contracts and functions
  • Fuzzer integration: Quick access to fuzzing tools directly through the extension
  • Coverage visualization: View and analyze code coverage from fuzzers
  • Test generation: Generate Foundry unit tests from call sequences that break properties found by the fuzzer
  • Mock/TargetFunctions generation: Easily create mock contracts and target functions for testing
  • CodeLens integration: Run tests and modify function behaviors directly in the editor

Installation

Prerequisites

  • Visual Studio Code 1.88.0 or higher
  • Foundry toolchain (forge, cast, anvil)
  • Echidna (optional)
  • Medusa (optional)

Install from VS Code Marketplace

Official Link: https://marketplace.visualstudio.com/items?itemName=Recon-Fuzz.recon

  1. Open VS Code
  2. Go to Extensions (Ctrl+Shift+X)
  3. Search for "Recon"
  4. Click "Install"

Manual Installation

  1. Download the .vsix file from the latest release
  2. In VS Code, go to Extensions
  3. Click the "..." menu and select "Install from VSIX..."
  4. Select the downloaded file

Getting Started

  1. Open a Foundry project in VS Code
  2. Click on the Recon icon in the activity bar
  3. In the Cockpit view, click "Scaffold" to set up a project using the create-chimera-app template
  4. Select target contracts and functions in the Contracts view
  5. Run Echidna or Medusa from the status bar or Cockpit view

Usage

Scaffolding a Project

The "Scaffold" button in the Recon Cockpit view will:

  • Install Chimera as a Foundry submodule dependency
  • Update remappings.txt with the necessary dependency remappings
  • Create template files in the test/recon directory
  • Configure your project for fuzzing

Selecting Target Contracts and Functions

In the Contracts view you can:

  1. Enable the contracts you want to test
  2. For each contract, select the functions to include in the generated TargetFunctions contract
  3. Configure function properties:
    • Actor: Regular user or admin
    • Mode: Normal execution, expected failure, or catch exceptions

Running Fuzzers

  • Use the status bar buttons for quick access to Echidna and Medusa
  • Set the default fuzzer and configuration in the Cockpit view
  • View live fuzzing progress in the output panel

Viewing Coverage

After running a fuzzer with coverage enabled:

  1. Go to the Coverage Reports view
  2. Select a coverage report to view
  3. Click the external icon to open the report in a browser view
  4. Use the "Clean up Coverage Report" command for better readability

Generating Mocks

Right-click on a contract's JSON artifact (located in the out/ directory by default) or Solidity file and select "Generate Solidity Mock" to create a mock implementation of the contract.

Configuration

Recon can be configured through VS Code settings:

General Settings

  • recon.defaultFuzzer: Choose between Echidna and Medusa
  • recon.showAllFiles: Show or hide test and library files in the Contracts view
  • recon.foundryConfigPath: Path to foundry.toml (relative to workspace root)

Echidna Settings

  • recon.echidna.mode: Configure testing mode (assertion, property, etc.)
  • recon.echidna.testLimit: Maximum number of test cases to run
  • recon.echidna.workers: Number of parallel workers

Medusa Settings

  • recon.medusa.testLimit: Maximum number of test cases to run
  • recon.medusa.workers: Number of parallel workers

Forge Settings

  • recon.forge.buildArgs: Additional arguments for forge build
  • recon.forge.testVerbosity: Verbosity level for forge test output

Troubleshooting

Common Issues

  • Fuzzer not found: Ensure Echidna/Medusa are installed and in your PATH
  • Compilation errors: Run forge build manually to identify issues
  • No contracts showing: Check if out/ directory exists with compiled contracts

License

https://www.gnu.org/licenses/old-licenses/gpl-2.0.txt