go-ffi

ctb-go-ffi

A lightweight binary for utilities accessed via forge's ffi cheatcode in the contracts-bedrock test suite.

├── go-ffi
│   ├── bin: `go-ffi`'s binary
│   ├── trie: Utility for generating random merkle trie roots / inclusion proofs
│   └── diff-testing: Utility for differential testing Solidity implementations against their respective Go implementations.

Usage

To build, run pnpm build:go-ffi from this directory or the contract-bedrock package.

In a Forge Test

To use go-ffi in a forge test, simply invoke the binary via the vm.ffi cheatcode.

function myFFITest() public {
    string[] memory commands = new string[](3);
    commands[0] = "./scripts/go-ffi/go-ffi";
    commands[1] = "trie";
    commands[2] = "valid";
    bytes memory result = vm.ffi(commands);

    // Do something with the result of the command
}

Available Modes

There are two modes available in go-ffi: diff and trie. Each are present as a subcommand to the go-ffi binary, with their own set of variants.

diff

Note Variant required for diff mode.

trie

Note Variant required for trie mode.