tech

Uniswap V4 Hook简明教程

你听说过Uniswap V4钩子吧？系好安全带，因为我们将踏上一段激动人心的旅程，进入自定义流动性池行为的世界。

Uniswap V4 Hook简明教程
一键发币： SUI | SOL | BNB | ETH | BASE | ARB | OP | POLYGON | AVAX | FTM | OK

嘿，勇敢的DeFi探索者！你听说过这些新奇的Uniswap V4钩子，心想，“我可能也能做一个！”好吧，系好安全带，因为我们将踏上一段激动人心的旅程，进入自定义流动性池行为的世界。别担心，我会做你值得信赖的向导，我们一起踏上这段旅程！

1、设置营地：基础知识

在我们深入代码之前，让我们谈谈这次旅行需要携带的基本装备。你可能会想，“我需要准备什么才能开始？”这是个好问题！这是我们必备的装备：

钩子库：

把它想象成你的瑞士军刀。它包含各种工具来定义你的钩子可以做什么。

  • 包含什么？这个库包含不同钩子标志的常量（如BEFORE_SWAP_FLAG、AFTER_SWAP_FLAG），以及用于验证和调用钩子的函数。
  • 可以做什么？有了它，你可以精确指定你的钩子应该在何时启动。想在交换前做一些事情吗？在添加流动性后呢？这就是你的得力工具箱。

PoolKey和PoolId：

它们就像你的地图和指南针。它们帮助你在广阔的流动性池景观中导航。

  • 是什么？PoolKey是一个唯一标识池的结构体，而PoolId是PoolKey的更高效的气体表示形式。
  • 可以做什么？你可以使用它们来针对特定的池子，检索池信息，或创建带有附加钩子的新池。

货币库：

这是一个通用翻译器，帮助你与原生代币（如ETH）和ERC20代币进行通信。

  • 包含什么？处理代币转移、检查余额以及统一处理原生和ERC20代币的功能。
  • 可以做什么？你可以创建能够无缝处理任何代币类型的钩子，为跨代币交互打开了一扇可能性的大门。

BaseHook合约：

把它看作你的帐篷——一个坚实的基础，让你免受智能合约开发的恶劣环境影响。

  • 是什么？实现了Uniswap V4钩子所需基本结构的抽象合约。
  • 可以做什么？通过继承它，你可以快速开始钩子开发。它处理了大量的样板代码，让你专注于钩子的独特功能。

“等等，”你可能会问，“我真的需要所有这些东西吗？”相信我，每个部分在你的钩子制作冒险中都扮演着至关重要的角色。让我们搭建我们的基地营，看看它们是如何组合在一起的！

2、奠定基础

首先，让我们创建我们的钩子合约。这是我们从头开始的基本结构：

import {BaseHook} from "@uniswap/v4-periphery/contracts/BaseHook.sol";  
import {Hooks} from "@uniswap/v4-core/contracts/libraries/Hooks.sol";  
import {IPoolManager} from "@uniswap/v4-core/contracts/interfaces/IPoolManager.sol";  
import {PoolKey} from "@uniswap/v4-core/contracts/types/PoolKey.sol";  
import {PoolId, PoolIdLibrary} from "@uniswap/v4-core/contracts/types/PoolId.sol";  
import {Currency, CurrencyLibrary} from "@uniswap/v4-core/contracts/types/Currency.sol";  
import {FixedPointMathLib} from "solmate/src/utils/FixedPointMathLib.sol";  

contract MyAwesomeHook is BaseHook {  
    using StateLibrary for IPoolManager;  
    using PoolIdLibrary for PoolKey;  
    using CurrencyLibrary for Currency;  
    using FixedPointMathLib for uint256;  
    constructor(IPoolManager _poolManager) BaseHook(_poolManager) {}  
    // 更多令人兴奋的内容即将揭晓！  
}

让我们分解这些‘using’语句并理解它们的重要性：

  1. using StateLibrary for IPoolManager;：这使得与池状态的高效交互成为可能。它允许你直接在IPoolManager对象上调用StateLibrary函数，简化了查询池流动性和交换数据等操作。
  2. using PoolIdLibrary for PoolKey;：这便于轻松地在PoolKey结构体和PoolId之间进行转换。这对于需要识别特定池的操作至关重要，例如将钩子目标锁定到特定的交易对。
  3. using CurrencyLibrary for Currency;：这一语句增强了你以统一的方式处理不同代币类型的能力。它允许你直接在Currency对象上使用CurrencyLibrary函数，简化了代币转移、余额检查和其他与代币相关的操作。
  4. using FixedPointMathLib for uint256;：这提供了访问精确数学运算的权限，这对DeFi应用至关重要。它允许你对uint256数字执行定点算术运算，这对于准确的价格计算、费用计算和其他金融操作是必不可少的。

这些‘using’语句对于编写高效、可读且气优化的钩子代码至关重要。它们提供了语法糖，使你在处理这些复杂的DeFi概念时能够编写更直观的代码。

3、声明你的意图

接下来，我们需要告诉Uniswap我们的钩子可以做什么。这就像填写露营活动的许可：

function getHookPermissions() public pure override returns (Hooks.Permissions memory) {  
    return Hooks.Permissions({  
        beforeInitialize: false,  
        afterInitialize: false,  
        beforeAddLiquidity: false,  
        afterAddLiquidity: false,  
        beforeRemoveLiquidity: false,  
        afterRemoveLiquidity: false,  
        beforeSwap: false,  
        afterSwap: false,  
        beforeDonate: false,  
        afterDonate: false,  
        beforeSwapReturnDelta: false,  
        afterSwapReturnDelta: false,  
        afterAddLiquidityReturnDelta: false,  
        afterRemoveLiquidityReturnDelta: false  
    });  
}

你可能会挠头想，“等等，我们需要这个函数吗？我以为Uniswap会根据合约地址自动确定哪些钩子要使用。”

没错，你很聪明！Uniswap确实会根据合约地址确定要调用哪些钩子。“getHookPermissions()”函数更像是为我们人类提供的“视觉辅助”。它帮助开发者（比如我们）快速看到钩子应该做什么，而无需深入分析地址细节。

你可能会想，“那么，我是否应该实现这个函数？”答案是肯定的！虽然这对Uniswap的操作不是严格必要的，但它对其他开发者（包括未来的你自己）非常有帮助。

要使用一个钩子，你需要将相应的权限设置为true。例如，如果你想让钩子在交换前后做一些事情，你应该将beforeSwap和afterSwap设置为true。

Uniswap如何从合约地址读取这些权限的复杂性是一个有趣的话题，但那就像高级野外生存技巧——我们将在另一次探险中探讨。现在，让我们专注于建立我们的基本营地！

4、添加你的特殊调料

现在到了有趣的部分——让我们添加一些自定义行为！我们将实现beforeSwap函数：

function beforeSwap(address sender, PoolKey calldata key, IPoolManager.SwapParams calldata params, bytes calldata data)  
    external  
    override  
    returns (bytes4)  
{  
    // 你的魔法在这里！  
    console.log("哦，一个交换即将发生来自", sender);  

    // 不要忘记这部分！  
    return BaseHook.beforeSwap.selector;  
}

“那个return语句有什么特别的？”你可能会问？好眼力！那是我们在告诉Uniswap，“是的，我们做了我们的事情，你可以继续了。”

5、试运行

恭喜，勇敢的开发者！你刚刚创建了你的第一个Uniswap V4钩子。但是，你怎么实际使用它呢？好问题！

  1. 将你的钩子合约部署到区块链上。
  2. 在创建新的流动性池时，你可以在其中指定你的钩子地址。
  3. 现在，每当有人尝试在这个池子里交换时，你的beforeSwap函数就会运行！

6、重要考虑事项

在我们结束这次冒险之前，让我们讨论一下在开发钩子时需要记住的一些重要事项。即使在早期阶段，意识到潜在的陷阱和安全风险也是至关重要的：

  1. 气体效率：在以太坊世界里，每项计算都会消耗气体。注意你的钩子的复杂度。低效的代码可能会使你的钩子使用起来过于昂贵。
  2. 重入风险：如果你的钩子与外部合约交互，请警惕重入攻击。始终遵循检查-效果-交互模式。
  3. 访问控制：确保钩子中的敏感函数只能由授权地址调用。Uniswap V4提供了一些内置保护措施，但仍然需要保持警惕。
  4. 状态管理：记住，钩子被设计为在调用之间无状态的。如果需要维护状态，请小心谨慎，并考虑其对气体成本和潜在攻击向量的影响。
  5. 小数精度：在处理代币金额和价格时，请格外小心小数精度。舍入错误可能导致财务计算的重大问题。
  6. 测试：在各种场景下彻底测试你的钩子。Uniswap提供了一个测试框架——在考虑部署到主网之前要广泛使用。
  7. 可升级性：考虑你的钩子是否需要可升级性。如果是，请仔细实施升级模式，以免引入漏洞。
  8. MEV意识：意识到复杂的参与者可能会尝试利用你的钩子进行MEV（矿工可提取价值）。设计你的钩子时请考虑到这一点。
  9. 可组合性：你的钩子可能会与其他DeFi协议交互。始终考虑更大的生态系统及其潜在的意外交互。
  10. 审计：对于任何计划投入生产的钩子，专业审计是必须的。即使是看起来简单的代码也可能隐藏着漏洞。

记住，在DeFi中，你通常处理的是真实的价值。代码中的一个小错误可能会导致严重的财务损失。总是偏向于谨慎行事，并不断学习最佳的安全实践。

7、结束语

祝贺你！你刚刚迈出了进入Uniswap V4钩子世界的重大一步。让我们回顾一下你所完成的内容：

  1. 你已经设置了Uniswap V4钩子合约的基本结构。
  2. 你了解了支持这些钩子的基本库和组件。
  3. 你实现了getHookPermissions()函数，这对于定义钩子的能力至关重要。
  4. 你创建了一个简单的beforeSwap函数作为钩子逻辑的起点。

为了帮助你快速起步，这里有一个完整的模板供你制作第一个Uniswap V4钩子。你可以将其复制粘贴到你的开发环境中作为起点：

// SPDX-License-Identifier: MIT  
pragma solidity ^0.8.19;  

import {BaseHook} from "@uniswap/v4-periphery/contracts/BaseHook.sol";  
import {Hooks} from "@uniswap/v4-core/contracts/libraries/Hooks.sol";  
import {IPoolManager} from "@uniswap/v4-core/contracts/interfaces/IPoolManager.sol";  
import {PoolKey} from "@uniswap/v4-core/contracts/types/PoolKey.sol";  
import {PoolId, PoolIdLibrary} from "@uniswap/v4-core/contracts/types/PoolId.sol";  
import {Currency, CurrencyLibrary} from "@uniswap/v4-core/contracts/types/Currency.sol";  
import {FixedPointMathLib} from "solmate/src/utils/FixedPointMathLib.sol";  

contract MyAwesomeHook is BaseHook {  
    using PoolIdLibrary for PoolKey;  
    using CurrencyLibrary for Currency;  
    using FixedPointMathLib for uint256;  

    constructor(IPoolManager _poolManager) BaseHook(_poolManager) {}  

    function getHookPermissions() public pure override returns (Hooks.Permissions memory) {  
        return Hooks.Permissions({  
            beforeInitialize: false,  
            afterInitialize: false,  
            beforeAddLiquidity: false,  
            afterAddLiquidity: false,  
            beforeRemoveLiquidity: false,  
            afterRemoveLiquidity: false,  
            beforeSwap: true,  
            afterSwap: false,  
            beforeDonate: false,  
            afterDonate: false,  
            beforeSwapReturnDelta: false,  
            afterSwapReturnDelta: false,  
            afterAddLiquidityReturnDelta: false,  
            afterRemoveLiquidityReturnDelta: false  
        });  
    }  

    function beforeSwap(address sender, PoolKey calldata key, IPoolManager.SwapParams calldata params, bytes calldata data)  
        external  
        override  
        returns (bytes4)  
    {  
        // 你的自定义逻辑在这里  
        console.log("交换由", sender, "发起");  

        return BaseHook.beforeSwap.selector;  
    }  
}

此模板包含了所有必要的导入、基本合约结构以及一个简单的beforeSwap钩子实现。你可以根据需要修改和扩展它，以探索更复杂的钩子行为。

从这里开始，可能性是无限的：

  • 你可以扩展beforeSwap函数。
  • 你可以探索其他钩子函数，如afterSwap或beforeAddLiquidity，以影响交易的不同方面。
  • 你可以深入研究我们介绍的库，以创建与池和代币更复杂的交互。

Uniswap V4生态系统属于你去探索和塑造。你的下一步可能会引领去中心化金融的下一个重大突破！

那么，你接下来会构建什么呢？

原文链接：How to Start your First Uniswap V4 Hook: Essentials, Libraries, and Risks

DefiPlot翻译整理，转载请标明出处

免责声明：本站资源仅用于学习目的，也不应被视为投资建议，读者在采取任何行动之前应自行研究并对自己的决定承担全部责任。
通过 NowPayments 打赏

Read next