docs: fix BaseHook import path and setup instructions for v4 hooks#1116
Open
VishnuKMi wants to merge 1 commit intoUniswap:mainfrom
Open
docs: fix BaseHook import path and setup instructions for v4 hooks#1116VishnuKMi wants to merge 1 commit intoUniswap:mainfrom
VishnuKMi wants to merge 1 commit intoUniswap:mainfrom
Conversation
|
@VishnuKMi is attempting to deploy a commit to the Uniswap Team on Vercel. A member of the Team first needs to authorize it. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR updates the local environment setup guide for Uniswap v4 hooks to fix a broken BaseHook import. The documentation currently references BaseHook from v4-periphery, which is no longer available and causes compilation failures.
The guide now installs and references the official v4-hooks-public repository and updates remappings and import paths accordingly.
This ensures developers can successfully follow the setup instructions and compile the example hook contract without errors.
Type(s) of changes
Motivation for PR
Following the current documentation results in a missing dependency error because BaseHook is no longer present in v4-periphery. This breaks the onboarding flow for developers trying to build hooks.
This PR restores a working setup path using the official hooks repository from openzeppelin and prevents confusion during initial environment configuration.
How Has This Been Tested?
forge buildApplicable screenshots
N/A — documentation change only.
Follow-up PR
None planned. Happy to adjust based on maintainer feedback.