Merge branch 'master' into plugin-fee

audits/README.md

@@ -2,9 +2,9 @@
 
 | Module | Auditor | Report | Auditor publication |
 |  :---------------- | :---------------- | :------: | ----: |
-| Core | [MixBytes](https://mixbytes.io/) | [report](https://github.com/cryptoalgebra/Algebra/blob/3cd27234278a956fafcb8249242ec413eaecc25c/audits/Core_audit_report_MixBytes.pdf) | [MixBytes repository](https://github.com/mixbytes/audits_public/blob/master/Algebra%20Finance/Core/Algebra%20Finance%20Core%20Security%20Audit%20Report.pdf) |
-| Farming | [MixBytes](https://mixbytes.io/) | [report](https://github.com/cryptoalgebra/Algebra/blob/3cd27234278a956fafcb8249242ec413eaecc25c/audits/Farming_Plugin_report_MixBytes.pdf) | [MixBytes repository](https://github.com/mixbytes/audits_public/blob/master/Algebra%20Finance/Farmings/Algebra%20Farmings%20Security%20Audit%20Report.pdf)  |
-| Base plugin | [MixBytes](https://mixbytes.io/) | [report](https://github.com/cryptoalgebra/Algebra/blob/3cd27234278a956fafcb8249242ec413eaecc25c/audits/Farming_Plugin_report_MixBytes.pdf) | [MixBytes repository](https://github.com/mixbytes/audits_public/blob/master/Algebra%20Finance/Plugins/Algebra%20Plugins%20Security%20Audit%20Report.pdf)  |
+| Core | [MixBytes](https://mixbytes.io/) | [report](Core_audit_report_MixBytes.pdf) | [MixBytes repository](https://github.com/mixbytes/audits_public/blob/master/Algebra%20Finance/Core/Algebra%20Finance%20Core%20Security%20Audit%20Report.pdf) |
+| Farming | [MixBytes](https://mixbytes.io/) | [report](Farming_Plugin_report_MixBytes.pdf) | [MixBytes repository](https://github.com/mixbytes/audits_public/blob/master/Algebra%20Finance/Farmings/Algebra%20Farmings%20Security%20Audit%20Report.pdf)  |
+| Base plugin | [MixBytes](https://mixbytes.io/) | [report](Base_Plugin_report_MixBytes.pdf) | [MixBytes repository](https://github.com/mixbytes/audits_public/blob/master/Algebra%20Finance/Plugins/Algebra%20Plugins%20Security%20Audit%20Report.pdf)  |
 | Entire protocol, bug hunting | [Riley Holterhus](https://www.rileyholterhus.com/) | [report](https://github.com/cryptoalgebra/Algebra/blob/dev/audits/Riley_Holterhus_Algebra_Integral.pdf) |  |
 | Entire protocol | [Paladin](https://paladinsec.co/) | [report](Algebra_Paladin_report.pdf) |  |
 | Custom Pools | [Bailsec](https://bailsec.io/) | [report](Bailsec_Algebra_Integral_Update_Audit_differential_Report.pdf) |  |

src/farming/contracts/FarmingCenter.sol

@@ -84,7 +84,7 @@ contract FarmingCenter is IFarmingCenter, IPositionFollower, Multicall {
     bytes32 _eternalIncentiveId = deposits[tokenId];
     if (_eternalIncentiveId != bytes32(0)) {
       address tokenOwner = nonfungiblePositionManager.ownerOf(tokenId);
-      (, , , , , , uint128 liquidity, , , , ) = nonfungiblePositionManager.positions(tokenId);
+      (, , , , , , , uint128 liquidity, , , , ) = nonfungiblePositionManager.positions(tokenId);
 
       IncentiveKey memory key = incentiveKeys[_eternalIncentiveId];
 
@@ -140,6 +140,9 @@ contract FarmingCenter is IFarmingCenter, IPositionFollower, Multicall {
     require(msg.sender == address(eternalFarming), 'Only farming can call this');
     require(virtualPool != address(0), 'Zero address as virtual pool');
     pool = IAlgebraPool(plugin.pool());
-    require(address(pool) == PoolAddress.computeAddress(algebraPoolDeployer, PoolAddress.PoolKey(pool.token0(), pool.token1())), 'Invalid pool');
+    require(
+      address(pool) == PoolAddress.computeAddress(algebraPoolDeployer, PoolAddress.PoolKey(address(0), pool.token0(), pool.token1())),
+      'Invalid pool'
+    );
   }
 }

src/farming/contracts/libraries/NFTPositionInfo.sol

@@ -22,8 +22,11 @@ library NFTPositionInfo {
   ) internal view returns (IAlgebraPool pool, int24 tickLower, int24 tickUpper, uint128 liquidity) {
     address token0;
     address token1;
-    (, , token0, token1, tickLower, tickUpper, liquidity, , , , ) = nonfungiblePositionManager.positions(tokenId);
+    address pluginDeployer;
+    (, , token0, token1, pluginDeployer, tickLower, tickUpper, liquidity, , , , ) = nonfungiblePositionManager.positions(tokenId);
 
-    pool = IAlgebraPool(PoolAddress.computeAddress(address(deployer), PoolAddress.PoolKey({token0: token0, token1: token1})));
+    pool = IAlgebraPool(
+      PoolAddress.computeAddress(address(deployer), PoolAddress.PoolKey({deployer: pluginDeployer, token0: token0, token1: token1}))
+    );
   }
 }

src/farming/test/helpers/index.ts

@@ -1,5 +1,5 @@
 import { Wallet, MaxUint256, Interface } from 'ethers';
-import { blockTimestamp, BNe18, FeeAmount, getCurrentTick, maxGas, encodePath, arrayWrap, getMinTick, getMaxTick } from '../shared/index';
+import { blockTimestamp, BNe18, FeeAmount, getCurrentTick, maxGas, encodePath, arrayWrap, getMinTick, getMaxTick, ZERO_ADDRESS } from '../shared/index';
 import _ from 'lodash';
 import { TestERC20, INonfungiblePositionManager, AlgebraEternalFarming, IAlgebraPool, TestIncentiveId, FarmingCenter } from '../../typechain';
 import abi from '../../artifacts/contracts/farmings/EternalVirtualPool.sol/EternalVirtualPool.json';
@@ -343,7 +343,7 @@ export class HelperCommands {
       const erc20Helper = new ERC20Helper();
       await erc20Helper.ensureBalancesAndApprovals(actor, [tok0, tok1], amountIn, await this.router.getAddress());
 
-      const path = encodePath(MAKE_TICK_GO_UP ? [tok1Address, tok0Address] : [tok0Address, tok1Address]);
+      const path = encodePath(MAKE_TICK_GO_UP ? [tok1Address, ZERO_ADDRESS, tok0Address] : [tok0Address, ZERO_ADDRESS, tok1Address]);
 
       await this.router.connect(actor).exactInput(
         {
@@ -410,6 +410,7 @@ export class HelperCommands {
         deadline: MaxUint256,
         tokenIn: zto ? tok0Address : tok1Address,
         tokenOut: zto ? tok1Address : tok0Address,
+        deployer: ZERO_ADDRESS,
         amountIn: 2n ** 128n - 1n,
         amountOutMinimum: 0,
         limitSqrtPrice: priceAtTarget,

src/farming/test/shared/fixtures.ts

@@ -31,7 +31,7 @@ import {
   TestIncentiveId,
   FarmingCenter,
 } from '../../typechain';
-import { FeeAmount, encodePriceSqrt, MAX_GAS_LIMIT } from '../shared';
+import { FeeAmount, encodePriceSqrt, MAX_GAS_LIMIT, ZERO_ADDRESS } from '../shared';
 import { ActorFixture } from './actors';
 import { IBasePluginV1Factory, IAlgebraBasePluginV1 } from '@cryptoalgebra/integral-base-plugin/typechain';
 
@@ -182,6 +182,7 @@ export const mintPosition = async (
       {
         token0: mintParams.token0,
         token1: mintParams.token1,
+        deployer: ZERO_ADDRESS,
         tickLower: mintParams.tickLower,
         tickUpper: mintParams.tickUpper,
         recipient: mintParams.recipient,
@@ -272,9 +273,9 @@ export const algebraFixture: () => Promise<AlgebraFixtureType> = async () => {
 
   const fee = FeeAmount.MEDIUM;
 
-  await nft.createAndInitializePoolIfNecessary(tokens[0], tokens[1], encodePriceSqrt(1, 1));
+  await nft.createAndInitializePoolIfNecessary(tokens[0], tokens[1], ZERO_ADDRESS, encodePriceSqrt(1, 1));
 
-  await nft.createAndInitializePoolIfNecessary(tokens[1], tokens[2], encodePriceSqrt(1, 1));
+  await nft.createAndInitializePoolIfNecessary(tokens[1], tokens[2], ZERO_ADDRESS, encodePriceSqrt(1, 1));
 
   const pool01 = await factory.poolByPair(tokens[0], tokens[1]);
 

src/farming/test/unit/EternalFarms.spec.ts

@@ -1898,7 +1898,7 @@ describe('unit/EternalFarms', () => {
 
         await erc20Helper.ensureBalancesAndApprovals(lpUser0, [token0, token1], amountDesired, await context.nft.getAddress());
 
-        await context.nft.createAndInitializePoolIfNecessary(token0, token1, encodePriceSqrt(1, 1));
+        await context.nft.createAndInitializePoolIfNecessary(token0, token1, ZERO_ADDRESS, encodePriceSqrt(1, 1));
 
         const poolAddress = await context.factory.poolByPair(token0, token1);
 
@@ -1958,6 +1958,7 @@ describe('unit/EternalFarms', () => {
         const swapData = {
           tokenIn: tokenReentrant,
           tokenOut: context.token1,
+          deployer: ZERO_ADDRESS,
           amountIn: 10,
           amountOutMinimum: 0,
           recipient: lpUser0.address,

src/farming/test/unit/__snapshots__/EternalFarms.spec.ts.snap

@@ -2,6 +2,6 @@
 
 exports[`unit/EternalFarms #claimReward when requesting the full amount has gas cost [ @skip-on-coverage ] 1`] = `60772`;
 
-exports[`unit/EternalFarms #enterFarming works and has gas cost [ @skip-on-coverage ] 1`] = `494839`;
+exports[`unit/EternalFarms #enterFarming works and has gas cost [ @skip-on-coverage ] 1`] = `498891`;
 
-exports[`unit/EternalFarms #exitFarming after end time works and has gas cost [ @skip-on-coverage ] 1`] = `169695`;
+exports[`unit/EternalFarms #exitFarming after end time works and has gas cost [ @skip-on-coverage ] 1`] = `171745`;

src/periphery/contracts/NonfungiblePositionManager.sol

@@ -108,6 +108,7 @@ contract NonfungiblePositionManager is
             address operator,
             address token0,
             address token1,
+            address deployer,
             int24 tickLower,
             int24 tickUpper,
             uint128 liquidity,
@@ -130,6 +131,7 @@ contract NonfungiblePositionManager is
             position.operator,
             poolKey.token0,
             poolKey.token1,
+            poolKey.deployer,
             tickLower,
             tickUpper,
             liquidity,
@@ -156,6 +158,7 @@ contract NonfungiblePositionManager is
             AddLiquidityParams({
                 token0: params.token0,
                 token1: params.token1,
+                deployer: params.deployer,
                 recipient: address(this),
                 tickLower: params.tickLower,
                 tickUpper: params.tickUpper,
@@ -178,7 +181,7 @@ contract NonfungiblePositionManager is
         // idempotent set
         uint80 poolId = _cachePoolKey(
             address(pool),
-            PoolAddress.PoolKey({token0: params.token0, token1: params.token1})
+            PoolAddress.PoolKey({deployer: params.deployer, token0: params.token0, token1: params.token1})
         );
 
         _positions[tokenId] = Position({
@@ -268,6 +271,7 @@ contract NonfungiblePositionManager is
             AddLiquidityParams({
                 token0: poolKey.token0,
                 token1: poolKey.token1,
+                deployer: poolKey.deployer,
                 tickLower: tickLower,
                 tickUpper: tickUpper,
                 amount0Desired: params.amount0Desired,
@@ -409,7 +413,7 @@ contract NonfungiblePositionManager is
     /// @inheritdoc INonfungiblePositionManager
     function burn(uint256 tokenId) external payable override isAuthorizedForToken(tokenId) {
         Position storage position = _positions[tokenId];
-        require(position.liquidity | position.tokensOwed0 | position.tokensOwed1 == 0, 'Not cleared');
+        require(position.liquidity | position.tokensOwed0 | position.tokensOwed1 == 0);
 
         delete _positions[tokenId];
         delete tokenFarmedIn[tokenId];
@@ -424,7 +428,7 @@ contract NonfungiblePositionManager is
     ) external payable override isAuthorizedForToken(tokenId) {
         address newValue;
         if (approve) {
-            require(farmingAddress == farmingCenter, 'Invalid farming address');
+            require(farmingAddress == farmingCenter);
             newValue = farmingAddress;
         }
         farmingApprovals[tokenId] = newValue;
@@ -450,7 +454,6 @@ contract NonfungiblePositionManager is
     function setFarmingCenter(address newFarmingCenter) external override {
         require(IAlgebraFactory(factory).hasRoleOrOwner(NONFUNGIBLE_POSITION_MANAGER_ADMINISTRATOR_ROLE, msg.sender));
         farmingCenter = newFarmingCenter;
-        emit FarmingCenter(newFarmingCenter);
     }
 
     /// @inheritdoc IERC721Metadata

src/periphery/contracts/NonfungibleTokenPositionDescriptor.sol

@@ -66,14 +66,25 @@ contract NonfungibleTokenPositionDescriptor is INonfungibleTokenPositionDescript
         INonfungiblePositionManager positionManager,
         uint256 tokenId
     ) external view override returns (string memory) {
-        (, , address token0, address token1, int24 tickLower, int24 tickUpper, , , , , ) = positionManager.positions(
-            tokenId
-        );
+        (
+            ,
+            ,
+            address token0,
+            address token1,
+            address deployer,
+            int24 tickLower,
+            int24 tickUpper,
+            ,
+            ,
+            ,
+            ,
+
+        ) = positionManager.positions(tokenId);
 
         IAlgebraPool pool = IAlgebraPool(
             PoolAddress.computeAddress(
                 positionManager.poolDeployer(),
-                PoolAddress.PoolKey({token0: token0, token1: token1})
+                PoolAddress.PoolKey({deployer: deployer, token0: token0, token1: token1})
             )
         );