forge-fhevm

A forge library to run Zama's fhevm

Dependencies

package.json

"dependencies": {
    "fhevm-core-contracts": "^0.6.1",
    "@openzeppelin/contracts": "^5.1.0",
    "@openzeppelin/contracts-upgradeable": "^5.1.0",
}

foundry.toml

[profile.default]
solc = "0.8.24"
evm_version = "cancun"
src = "src"
out = "out"
test = "test"
cache_path = "cache"
fs_permissions = [{ access = "read", path = "./node_modules/fhevm-core-contracts/artifacts"}, { access = "read", path = "./out"}]
libs = ["dependencies", "node-modules"]
remappings= [
    "forge-std/=dependencies/forge-std-1.9.3/",
    "forge-fhevm/=dependencies/forge-fhevm-0.6.2/",
    "forge-fhevm-config/=dependencies/forge-fhevm-0.6.2/configs/sepolia/",
    "fhevm/=dependencies/forge-fhevm-0.6.2/src/libs/fhevm-debug/"
]

[dependencies]
forge-std = "1.9.3"
forge-fhevm = { version = "0.6.2", git = "https://github.com/0xalexbel/forge-fhevm.git" }

[soldeer]
remappings_version = false
remappings_generate = false
remappings_regenerate = false
remappings_prefix = ""
remappings_location = "config"

Development

Dev env using sepolia addresses

# restore .env
cp ./env.sepolia ./.env

# restore foundry.toml
cp ./foundry.toml.sepolia ./foundry.toml

# restore remappings.txt (for vscode)
cp ./remappings.txt.sepolia ./remappings.txt

Dev env using ffhevm default addresses

# restore .env
cp ./env.default ./.env

# restore foundry.toml
cp ./foundry.toml.default ./foundry.toml

# restore remappings.txt (for vscode)
cp ./remappings.txt.default ./remappings.txt

Install+Test

# install dependencies
forge soldeer install

# install dependencies (fhevm-core-contracts + openzeppelin)
npm install

# run tests
forge test

Tests

Tests are failing in the following situations:

# Transient storage is cleared between two consecutive calls therefore ACL permissions are always reset.
forge test --isolate

# Transient storage is cleared between two consecutive calls therefore ACL permissions are always reset.
forge test --gas-report

See foundry-rs/foundry#7499 (comment) for more information.