Uniswap v4 is a new automated market maker protocol that provides extensibility and customizability to pools. v4-periphery hosts the logic that builds on top of the core pool logic like hook contracts, position managers, and even possibly libraries needed for integrations. The v4-periphery contracts in this repository are still in development and further periphery contracts have not yet been built.
If you’re interested in contributing please see the contribution guidelines!
contracts/
----hooks/
----examples/
| GeomeanOracle.sol
| LimitOrder.sol
| TWAMM.sol
| VolatilityOracle.sol
----libraries/
| Oracle.sol
BaseHook.sol
test/To showcase the power of hooks, this repository provides some interesting examples in the /hooks/examples/ folder. Note that none of the contracts in this repository are fully production-ready, and the final design for some of the example hooks could look different.
Eventually, some hooks that have been audited and are considered production-ready will be placed in the root hooks folder. Not all hooks will be safe or valuable to users. This repository will maintain a limited set of hook contracts. Even a well-designed and audited hook contract may not be accepted in this repo.
To utilize the contracts and deploy to a local testnet, you can install the code in your repo with forge:
forge install https://github.com/Uniswap/v4-peripheryIf you are building hooks, it may be useful to inherit from the BaseHook contract:
import {BaseHook} from 'v4-periphery/contracts/BaseHook.sol';
contract CoolHook is BaseHook {
// Override the hook callbacks you want on your hook
function beforeAddLiquidity(
address,
IPoolManager.PoolKey calldata key,
IPoolManager.ModifyLiquidityParams calldata params
) external override poolManagerOnly returns (bytes4) {
// hook logic
return BaseHook.beforeAddLiquidity.selector;
}
}
The license for Uniswap V4 Periphery is the GNU General Public License (GPL 2.0), see LICENSE.
