Brownie x Foundry Template

Template repository for getting started quickly with Brownie and Foundry in one project.

Inspired by hardhat-foundry-template

Getting Started

Click use this template to create a new repository with this repo as the initial state.

Init submodules:

git submodule init && git submodule update

• Use Foundry:

forge install
forge test

• Use Brownie:

brownie test

Features

• Write / run tests with either Brownie or Foundry:

  forge test
  # or
  brownie test
  

• Install libraries with Foundry which work with Brownie:

  1. Install with forge:

  forge install openzeppelin=https://github.com/OpenZeppelin/openzeppelin-contracts

  2. Print foundry remappings:

  forge remappings >> remappings.txt

  3. Update remappings in brownie-config.yaml

• Generate CLI and Python interface to the smart contracts with moonworm. See utils/README.md for more details.