Refactor

Author: lbeder

packages/v3/contracts/pools/PoolCollection.sol

@@ -42,6 +42,10 @@ contract PoolCollection is IPoolCollection, OwnedUpgradeable, ReentrancyGuardUpg
 
     uint32 private constant DEFAULT_TRADING_FEE_PPM = 2000; // 0.2%
 
+    // trading enabling/disabling reasons
+    uint8 private constant TRADING_ENABLED_BY_OWNER = 0;
+    uint8 private constant TRADING_ENABLED_BY_MINIMUM_LIQUIDITY = 1;
+
     // withdrawal-related input data
     struct PoolWithdrawalParams {
         uint256 networkTokenAvgTradingLiquidity;
@@ -101,15 +105,10 @@ contract PoolCollection is IPoolCollection, OwnedUpgradeable, ReentrancyGuardUpg
      */
     event TradingFeePPMUpdated(IReserveToken indexed pool, uint32 prevFeePPM, uint32 newFeePPM);
 
-    enum TradingEnablingReason {
-        Owner,
-        MinmumLiquidity
-    }
-
     /**
      * @dev triggered when trading in a specific pool is enabled/disabled
      */
-    event TradingEnabled(IReserveToken indexed pool, bool newStatus, TradingEnablingReason reason);
+    event TradingEnabled(IReserveToken indexed pool, bool newStatus, uint8 reason);
 
     /**
      * @dev triggered when depositing to a specific pool is enabled/disabled
@@ -262,7 +261,7 @@ contract PoolCollection is IPoolCollection, OwnedUpgradeable, ReentrancyGuardUpg
 
         // although the owner-controlled flag is set to true, we want to emphasize that the trading in a newly created
         // pool is disabled
-        emit TradingEnabled({ pool: reserveToken, newStatus: false, reason: TradingEnablingReason.Owner });
+        emit TradingEnabled({ pool: reserveToken, newStatus: false, reason: TRADING_ENABLED_BY_OWNER });
 
         emit TradingFeePPMUpdated({ pool: reserveToken, prevFeePPM: 0, newFeePPM: newPool.tradingFeePPM });
         emit DepositingEnabled({ pool: reserveToken, newStatus: newPool.depositingEnabled });
@@ -349,7 +348,7 @@ contract PoolCollection is IPoolCollection, OwnedUpgradeable, ReentrancyGuardUpg
 
         poolData.tradingEnabled = status;
 
-        emit TradingEnabled({ pool: pool, newStatus: status, reason: TradingEnablingReason.Owner });
+        emit TradingEnabled({ pool: pool, newStatus: status, reason: TRADING_ENABLED_BY_OWNER });
     }
 
     /**
@@ -462,7 +461,7 @@ contract PoolCollection is IPoolCollection, OwnedUpgradeable, ReentrancyGuardUpg
                 poolData.liquidity.networkTokenTradingLiquidity.add(depositParams.baseTokenDeltaAmount) >=
                 minLiquidityForTrading
             ) {
-                emit TradingEnabled({ pool: pool, newStatus: true, reason: TradingEnablingReason.MinmumLiquidity });
+                emit TradingEnabled({ pool: pool, newStatus: true, reason: TRADING_ENABLED_BY_MINIMUM_LIQUIDITY });
             }
         }
 
@@ -695,7 +694,7 @@ contract PoolCollection is IPoolCollection, OwnedUpgradeable, ReentrancyGuardUpg
                 emit TradingEnabled({
                     pool: pool,
                     newStatus: newEnabled,
-                    reason: TradingEnablingReason.MinmumLiquidity
+                    reason: TRADING_ENABLED_BY_MINIMUM_LIQUIDITY
                 });
             }
         }

packages/v3/test/pools/PoolCollection.ts

@@ -13,17 +13,15 @@ import { ethers } from 'hardhat';
 import path from 'path';
 
 describe('PoolCollection', () => {
-    enum TradingEnablingReason {
-        Owner = 0,
-        MinLiquidity = 1
-    }
-
     const DEFAULT_TRADING_FEE_PPM = BigNumber.from(2000);
     const POOL_TYPE = BigNumber.from(1);
     const SYMBOL = 'TKN';
     const MIN_LIQUIDITY_FOR_TRADING = toWei(BigNumber.from(100_000));
     const INITIAL_RATE = { n: BigNumber.from(1), d: BigNumber.from(2) };
 
+    const TRADING_ENABLED_BY_OWNER = 0;
+    const TRADING_ENABLED_BY_MINIMUM_LIQUIDITY = 1;
+
     let deployer: SignerWithAddress;
     let nonOwner: SignerWithAddress;
 
@@ -192,7 +190,7 @@ describe('PoolCollection', () => {
                         .withArgs(reserveToken.address, BigNumber.from(0), pool.tradingFeePPM);
                     await expect(res)
                         .to.emit(poolCollection, 'TradingEnabled')
-                        .withArgs(reserveToken.address, false, TradingEnablingReason.Owner);
+                        .withArgs(reserveToken.address, false, TRADING_ENABLED_BY_OWNER);
                     await expect(res)
                         .to.emit(poolCollection, 'DepositingEnabled')
                         .withArgs(reserveToken.address, pool.depositingEnabled);
@@ -406,7 +404,7 @@ describe('PoolCollection', () => {
                 const res = await poolCollection.enableTrading(reserveToken.address, false);
                 await expect(res)
                     .to.emit(poolCollection, 'TradingEnabled')
-                    .withArgs(reserveToken.address, false, TradingEnablingReason.Owner);
+                    .withArgs(reserveToken.address, false, TRADING_ENABLED_BY_OWNER);
 
                 pool = await poolCollection.poolData(reserveToken.address);
                 ({ tradingEnabled } = pool);
@@ -415,7 +413,7 @@ describe('PoolCollection', () => {
                 const res2 = await poolCollection.enableTrading(reserveToken.address, true);
                 await expect(res2)
                     .to.emit(poolCollection, 'TradingEnabled')
-                    .withArgs(reserveToken.address, true, TradingEnablingReason.Owner);
+                    .withArgs(reserveToken.address, true, TRADING_ENABLED_BY_OWNER);
 
                 pool = await poolCollection.poolData(reserveToken.address);
                 ({ tradingEnabled } = pool);
@@ -1000,7 +998,7 @@ describe('PoolCollection', () => {
                         ) {
                             await expect(res)
                                 .to.emit(poolCollection, 'TradingEnabled')
-                                .withArgs(reserveToken.address, true, TradingEnablingReason.MinLiquidity);
+                                .withArgs(reserveToken.address, true, TRADING_ENABLED_BY_MINIMUM_LIQUIDITY);
                         }
 
                         let rate;