Skip to content

Latest commit

 

History

History
163 lines (129 loc) · 7.1 KB

readme.md

File metadata and controls

163 lines (129 loc) · 7.1 KB

本节作者：@愚指导

这一讲将会实现 Pool 合约中的手续费收取的逻辑。

简介

手续费收取除了需要考虑从用户手中扣除手续费外，还要考虑如何按照 LP 贡献的流动性来分配手续费收益。

首先我们需要在 Pool 合约中定义两个变量：

/// @inheritdoc IPool
uint256 public override feeGrowthGlobal0X128;
/// @inheritdoc IPool
uint256 public override feeGrowthGlobal1X128;

它们代表了从池子创建以来累计收取到的手续费，为什么需要记录这两个值呢？因为 LP 是可以随时提取手续费的，而且每个 LP 提取的时间不一样，所以 LP 提取手续费时我们需要计算出他历史累计的手续费收益。

具体值的计算上 feeGrowthGlobal0X128 和 feeGrowthGlobal1X128 是通过手续费乘以 FixedPoint128.Q128（2 的 96 次方），然后除以流动性数量得到的。和上一讲课程中的交易类似，乘以 FixedPoint128.Q128 是为了避免精度问题，最终 LP 提取手续费时会计算回实际的 token 数量。

开发

完整的代码在 demo-contract/contracts/wtfswap/Pool.sol 中。

如简介中所说，在 Pool.sol 中需要添加如下定义：

/// @inheritdoc IPool
uint256 public override feeGrowthGlobal0X128;
/// @inheritdoc IPool
uint256 public override feeGrowthGlobal1X128;

我们在 Position 中也需要添加 feeGrowthInside0LastX128 和 feeGrowthInside1LastX128，它代表了 LP 上次提取手续费时的全局手续费收益，这样当 LP 提取手续费时我们就可以和池子累计的手续费收益来做计算算出他可以提取的收益了。

struct Position {
    // 该 Position 拥有的流动性
    uint128 liquidity;
    // 可提取的 token0 数量
    uint128 tokensOwed0;
    // 可提取的 token1 数量
    uint128 tokensOwed1;
    // 上次提取手续费时的 feeGrowthGlobal0X128
+   uint256 feeGrowthInside0LastX128;
    // 上次提取手续费是的 feeGrowthGlobal1X128
+   uint256 feeGrowthInside1LastX128;
}

比如如果池子的 feeGrowthGlobal0X128 是 100，LP 提取手续费时的 Position 中 feeGrowthInside0LastX128 也是 100，那么说明 LP 没有新的可以提取的手续费。

接下来让我们实现具体的逻辑，首先我们在 swap 方法中更新每次交易后的手续费数值：

// 计算手续费
state.feeGrowthGlobalX128 += FullMath.mulDiv(
    state.feeAmount,
    FixedPoint128.Q128,
    liquidity
);

// 更新手续费相关信息
if (zeroForOne) {
    feeGrowthGlobal0X128 = state.feeGrowthGlobalX128;
} else {
    feeGrowthGlobal1X128 = state.feeGrowthGlobalX128;
}

其中 FullMath.mulDiv 方法接收三个参数，结果返回第一个参数和第二个参数的乘积再除以第三个参数。

然后在 _modifyPosition 中补充相关逻辑，每次 LP 调用 mint 或者 burn 方法时更新头寸（Position）中的 tokensOwed0 和 tokensOwed1，将之前累计的手续费记录上，并重新开始记录手续费。

function _modifyPosition(
    ModifyPositionParams memory params
) private returns (int256 amount0, int256 amount1) {
    // 通过新增的流动性计算 amount0 和 amount1
    // 参考 UniswapV3 的代码

    amount0 = SqrtPriceMath.getAmount0Delta(
        sqrtPriceX96,
        TickMath.getSqrtPriceAtTick(tickUpper),
        params.liquidityDelta
    );

    amount1 = SqrtPriceMath.getAmount1Delta(
        TickMath.getSqrtPriceAtTick(tickLower),
        sqrtPriceX96,
        params.liquidityDelta
    );
    Position storage position = positions[params.owner];

+    // 提取手续费，计算从上一次提取到当前的手续费
+    uint128 tokensOwed0 = uint128(
+        FullMath.mulDiv(
+            feeGrowthGlobal0X128 - position.feeGrowthInside0LastX128,
+            position.liquidity,
+            FixedPoint128.Q128
+        )
+    );
+    uint128 tokensOwed1 = uint128(
+        FullMath.mulDiv(
+            feeGrowthGlobal1X128 - position.feeGrowthInside1LastX128,
+            position.liquidity,
+            FixedPoint128.Q128
+        )
+    );
+
+    // 更新提取手续费的记录，同步到当前最新的 feeGrowthGlobal0X128，代表都提取完了
+    position.feeGrowthInside0LastX128 = feeGrowthGlobal0X128;
+    position.feeGrowthInside1LastX128 = feeGrowthGlobal1X128;
+    // 把可以提取的手续费记录到 tokensOwed0 和 tokensOwed1 中
+    // LP 可以通过 collect 来最终提取到用户自己账户上
+    if (tokensOwed0 > 0 || tokensOwed1 > 0) {
+        position.tokensOwed0 += tokensOwed0;
+        position.tokensOwed1 += tokensOwed1;
+    }

    // 修改 liquidity
    liquidity = LiquidityMath.addDelta(liquidity, params.liquidityDelta);
    position.liquidity = LiquidityMath.addDelta(
        position.liquidity,
        params.liquidityDelta
    );
}

在上面代码中，我们通过 FullMath.mulDiv 计算最终可以提取的手续费，因为计算的时候乘了 FixedPoint128.Q128，所以在这里需要除 FixedPoint128.Q128。

这样，当 LP 调用 collect 方法时，就可以将 Position 中的 tokensOwed0 和 tokensOwed1 转给用户了。

有一点提一下，为什么我们是在 burn 或者 mint 调用的 _modifyPosition 中计算手续费，而不是在用户 swap 的时候就把每个池子应该收到的手续费都记录上呢？因为一个池子中的流动性可能会很多，如果在交易的时候记录的话会产生大量的运算，会导致 Gas 太高。在这个计算中，LP 持有的流动性算是 LP 的“持股”份额，通过“持股”（Share）来计算 Token 也是很多 Defi 场景都会用到的方法。

合约测试

我们尝试继续在上一讲课程中的 test/wtfswap/Pool.ts 的 swap 样例中补充测试代码：

// 提取流动性，调用 burn 方法
await testLP.write.burn([liquidityDelta, pool.address]);
// 查看当前 token 数量
expect(await token0.read.balanceOf([testLP.address])).to.equal(
  99995000161384542080378486215n
);
// 提取 token
await testLP.write.collect([testLP.address, pool.address]);
// 判断 token 是否返回给 testLP，并且大于原来的数量，因为收到了手续费，并且有交易换入了 token0
// 初始的 token0 是 const initBalanceValue = 100000000000n * 10n ** 18n;
expect(await token0.read.balanceOf([testLP.address])).to.equal(
  100000000099999999999999999998n
);

仔细看上面的测试样例你会发现，LP 的 token 0 的数量从原来的 100000000000n * 10n ** 18n 变成了 (100000000000n + 100n) * 10n ** 18n;（不完全相等，计算上会因为取整问题有一点点损耗）。因为中间的交易换入了 100n * 10n ** 18n 的 token0，其中包含了手续费。

至此，我们完成了全部 Pool 合约逻辑的开发。🎉

完整的代码你可以在 这里 查看，完整的测试代码你也可以在 这里 查看。需要注意的是，在实际的项目中，你应该书写更加完整的测试样例。