Skip to content

docs: fix BaseHook import path and setup instructions for v4 hooks #1116

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
VishnuKMi wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: fix BaseHook import path and setup instructions for v4 hooks #1116

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions docs/contracts/v4/quickstart/hooks/setup.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Set Up Local Environment
sidebar_position: 0
---

Before writing the hook let's first have a local environment properly configured e.g. deploying pool manager, utility routers and test tokens.
Before writing the hook let's first have a local environment properly configured e.g. deploying pool manager, utility routers and test tokens.

At the end of this guide a development environment will be set up to be used to build the rest of the examples in the Guides section of the docs.

Expand Down Expand Up @@ -33,7 +33,7 @@ In the following sections, let's walk through the steps to create the same envir

### Setting up Foundry

First thing is to set up a new Foundry project.
First thing is to set up a new Foundry project.

If there is no Foundry installed - follow the [Foundry Book](https://book.getfoundry.sh/getting-started/installation) for installation.

Expand All @@ -47,7 +47,7 @@ cd counter-hook
Then install the Uniswap `v4-core` and `v4-periphery` contracts as dependencies:

```bash
forge install Uniswap/v4-core && forge install Uniswap/v4-periphery
forge install Uniswap/v4-core && forge install Uniswap/v4-periphery && forge install OpenZeppelin/uniswap-hooks
```

Next, set up the remappings so that the shorthand syntax for importing contracts from the dependencies work nicely:
Expand All @@ -60,6 +60,7 @@ forge remappings > remappings.txt

```
@uniswap/v4-core/=lib/v4-core/
@openzeppelin/uniswap-hooks/=lib/uniswap-hooks/
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/
Expand All @@ -74,7 +75,7 @@ After that, remove the default Counter contract and its associated test and scri
rm ./**/Counter*.sol
```

Finally, since v4 uses transient storage which is only available after Ethereum's cancun hard fork and on Solidity versions >= 0.8.24 - some config must be set in `foundry.toml` config file.
Finally, since v4 uses transient storage which is only available after Ethereum's cancun hard fork and on Solidity versions >= 0.8.24 - some config must be set in `foundry.toml` config file.

To do that, add the following lines to `foundry.toml`:

Expand All @@ -96,7 +97,7 @@ To confirm that the environment is configured correctly let's write a basic Coun
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.24;

import {BaseHook} from "v4-periphery/src/utils/BaseHook.sol";
import {BaseHook} from "@openzeppelin/uniswap-hooks/src/base/BaseHook.sol";

import {Hooks} from "v4-core/src/libraries/Hooks.sol";
import {IPoolManager} from "v4-core/src/interfaces/IPoolManager.sol";
Expand Down