Bridging private computation and public liquidity with Fully Homomorphic Encryption in Uniswap v4 Hooks.
- The example hook Counter.sol demonstrates basic FHE computation in the
beforeSwap(),afterSwap(),_beforeAddLiquidity()and_beforeRemoveLiquidity()hooks. It simply adds encrypted '1' to the counter in each hook. - The test template Counter.t.sol preconfigures the v4 pool manager, test FHE-enabled tokens and test liquidity.
Updating to v4-template:latest
This template is actively maintained -- you can update the v4 dependencies, scripts, and helpers:
git remote add template https://github.com/marronjo/fhe-hook-template
git fetch template
git merge template/main <BRANCH> --allow-unrelated-historiesEnsure that you have correctly installed Foundry (Forge) Stable. You can update Foundry by running:
foundryup
v4-template appears to be incompatible with Foundry Nightly. See foundry announcements to revert back to the stable build
requires foundry
#use node for dependencies
npm install
forge test --via-irOther than writing unit tests (recommended!), you can only deploy & test hooks on anvil
# start anvil, a local EVM chain
anvil
# in a new terminal
forge script script/Anvil.s.sol \
--rpc-url http://localhost:8545 \
--private-key 0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80 \
--broadcastSee script/ for hook deployment, pool creation, liquidity provision, and swapping.
When installing dependencies with forge install, Github may throw a Permission Denied error
Typically caused by missing Github SSH keys, and can be resolved by following the steps here
Or adding the keys to your ssh-agent, if you have already uploaded SSH keys
Some versions of Foundry may limit contract code size to ~25kb, which could prevent local tests to fail. You can resolve this by setting the code-size-limit flag
anvil --code-size-limit 40000
Hook deployment failures are caused by incorrect flags or incorrect salt mining
- Verify the flags are in agreement:
getHookCalls()returns the correct flagsflagsprovided toHookMiner.find(...)
- Verify salt mining is correct:
- In forge test: the deployer for:
new Hook{salt: salt}(...)andHookMiner.find(deployer, ...)are the same. This will beaddress(this). If usingvm.prank, the deployer will be the pranking address - In forge script: the deployer must be the CREATE2 Proxy:
0x4e59b44847b379578588920cA78FbF26c0B4956C- If anvil does not have the CREATE2 deployer, your foundry may be out of date. You can update it with
foundryup
- If anvil does not have the CREATE2 deployer, your foundry may be out of date. You can update it with
- In forge test: the deployer for:
Fhenix 🔒
Uniswap 🦄