Update v4-template to use latest version of solc and v4-periphery and v4-core

[johnwhitton]

Overview

v4-template is an invaluable tool for building v4 hooks.
It is part of a broader tool set which includes

• v4-router: A simple and optimized router for swapping on Uniswap V4. ABI inspired by UniswapV2Router02.
• uniswap-hooks: from OpenZeppelin a library of v4 hook functions using solc 0.8.26
  • Uses SwapRouterNoChecks from v4-core
• hookmate: A library for Uniswap v4 hook development. I personally love this as it allows me to use later versions of the solidity compiler rather than being forced to use solc 0.8.26.
  • Provides interfaces for
    • V4PoolManager.sol
    • V4PositionManager.sol
    • V4Router.sol
• v4-template: A template for writing Uniswap v4 Hooks 🦄 from Uniswap Foundation
  • It leverages
    • hookmate which uses v4-router
    • uniswap-hooks which uses SwapRouterNoChecks

A Potential Development Approach

When writing a new protocol. I wanted the following

• The ability to write Solidity using the latest Solidity compiler. At the time of writing solc 0.8.30
• The ability to interact with the latest versions of v4-core and v4-periphery
• Consistent use of a swapRouter for testing, ideally v4-router
• Ability to build upon v4-router to offer additional functionality. In my case I need to support async swaps for swap-based intents.

My approach

Jincubator Repositories

• Fork v4-router
  • Upgrade to use th the latest versions of v4-core and [v4-periphery]
  • Pull Request is here
  • Update to use later versions of v4-periphery and v4-core z0r0z/v4-router#57
    (https://github.com/Uniswap/v4-periphery). This request.
  • Build out an UniIntentSwapV4Router04 to handle processing of intentBased Swaps
• Fork hookmate and use this fork to include the artifact for the UniIntentSwapV4Router04
  • Note there I updated README.md as I walked through the code to improve understanding of how it works.
  • Will ensure the artifacts come from the latest version of v4-core and v4-periphery
• Build out the protocol repository currently private, previous versions here
  • Move v4-core and v4-periphery to higher level gitmodules rather than using hookmate
  • Copy uniswap-hooks contracts as needed and modify the tests to use UniIntentSwapV4Router04
  • Include create3 functionality to ensure that can use the same contract addresses across chains regardless of the salt.

Closing Thoughts

It would great to see a consolidation of the codebases above to use a consistent approach including

• uniswap-hooks using v4-router
• uniswap-hooks using the latest version of Solidity e.g. solc 0.8.30 perhaps by taking advantage of hookmate
• v4-template using the latest versions of v4-core and v4-periphery

Please reach out to me if you want to collaborate on any of the above my contact details can be found at https://github.com/johnwhitton

Reference code

gitmodules

[submodule "lib/forge-std"]
  path = lib/forge-std
  url = https://github.com/foundry-rs/forge-std
[submodule "lib/v4-core"]
  path = lib/v4-core
  url = https://github.com/Uniswap/v4-core
[submodule "lib/v4-periphery"]
  path = lib/v4-periphery
  url = https://github.com/Uniswap/v4-periphery
[submodule "lib/hookmate"]
  path = lib/hookmate
  url = https://github.com/jincubator/hookmate.git
[submodule "lib/the-compact"]
  path = lib/the-compact
  url = https://github.com/jincubator/the-compact
[submodule "lib/solmate"]
  path = lib/solmate
  url = https://github.com/transmissions11/solmate
[submodule "lib/create3-factory"]
  path = lib/create3-factory
  url = https://github.com/jincubator/create3-factory
  

[akshatmittal]

Just seeing this and looks great! Glad you like hookmate, the entire reason for it's existence is because I wanted to write contracts with solc 0.8.30 and I couldn't do it with the current setup.

Do have a few comments to add though:

1. Hookmate is fully dependency-less, which is why it provides a clean v4-router interface. If you were to import v4-router as a submodule, you'll again be stuck with compiler versions. That said, this is ideal. v4-router should NOT change anything, it's already deployed and available, and should be considered "complete" and it continues to work with Uniswap v4 today. This is another reason why an interface is included, but no source.
2. The v4-template is a starting point, so might as well do forge update before you start working! This would bring all dependencies to their latest versions (beware of git pushing you into alpha software, it really does not have good branch management)
3. You have a very specific use case with needing to extend v4-router for your intent based swaps. That is great and you should modify the template according to your needs, this is the ideal outcome. Basically nobody would be using this template as-is and modifications are recommended. (Also, since it's a separate piece, maybe consider forking v4-router separately and working on it in parallel rather than in the same codebase, not always ideal but might work for your workflow)
4. Same applies to create3, it's a good feature but not always and not everywhere, hence it's a decision to include it for developers rather than the template!
5. On consolidation, I think it's not a good idea to consolidate everything in open source. It allows the entire ecosystem to move forward in many ways, otherwise no new ideas would be born. These are also projects maintained by different people so forcing something on them, especially orgs like OZ, is not a good idea.

Also see this comment which I posted a while ago talking about similar things, and as always PRs into both the template and hookmate are always welcome, and I'm looking forward to adding a LOT more into hookmate to support many use cases, as long as they are generalized enough.

All of that considered, I quite like your approach!

[litlife1127-bot]

Great

[Skywalkingzulu1]

@johnwhitton will reach out to your now. I made a pull request that fixes quite a few of these issues on V4 Uniswap contract and also updates to solc v ^ 0.8.30. interested in getting it done.