Setup

For users looking to interact with the canonical Uniswap v4 PositionManager, v4-periphery is a required dependency

Currently, developing with Uniswap v4 requires foundry

Quickstart

Use v4-template, which has pre-configured dependencies and tests for Uniswap v4

Clone the repository made from v4-template

git clone https://github.com/<your_username>/<your_repo>

Install dependencies

forge install

---

Manual Setup

After cloning the repository, and installing foundry, developers can manually set up their Uniswap v4 environment:

1. Initialize a foundry project

   forge init . --force

2. Install dependencies

   forge install uniswap/v4-core
   forge install uniswap/v4-periphery

3. Set the remappings.txt to:

   @uniswap/v4-core/=lib/v4-core/
   forge-gas-snapshot/=lib/v4-core/lib/forge-gas-snapshot/src/
   forge-std/=lib/v4-core/lib/forge-std/src/
   permit2/=lib/v4-periphery/lib/permit2/
   solmate/=lib/v4-core/lib/solmate/
   v4-core/=lib/v4-core/
   v4-periphery/=lib/v4-periphery/