Foundry-mock-generator NPM

Foundry Mock Generator is the solidity mocking library. It's a plugin for foundry that can be used to create mock Solidity contracts able to mock variables and external calls.

Features

Get rid of your folder of "mock" contracts and just use foundry.
Keep your tests simple with a easy mock functions.
Mock up external calls and variables in a beautiful and orderly fashion.

Installation

You can install the tool via yarn:

yarn add foundry-mock-generator@<latest-canary>

Add a running script on your package.json

"mock-gen": "node node_modules/foundry-mock-generator/dist/run.js mock-gen"

Basic Usage

To generate the mock contracts all you have to do is run:

yarn mock-gen --contractsDir <path/to/contracts> --outDir <path/to/foundry/out> --genDir <path/to/generate/contracts>

Note: --genDir default path is solidity/test/mock-contracts

1) To use the mock contracts in your tests just import them.

import { MockMyContractName } from '/path/to/mock-contracts/MockMyContractName.sol'

2) To mock a function or variable e.g.:

/// Deploy mock contract
mock_myContract = new MockMyContractname(...);
/// Mock myFuncName function, when called with `arg1`, `arg2` to return `return1`
mock_myContract.mock_myFuncName(arg1, arg2, return1);
/// Mock myVarName variable, to return `return1`
mock_myContract.mock_myVarName(return1);