Refactor

Author: lbeder

packages/v3/contracts/pools/PoolCollection.sol

@@ -43,8 +43,8 @@ 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;
+    uint8 private constant TRADING_STATUS_UPDATE_OWNER = 0;
+    uint8 private constant TRADING_STATUS_UPDATE_MIN_LIQUIDITY = 1;
 
     // withdrawal-related input data
     struct PoolWithdrawalParams {
@@ -261,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: TRADING_ENABLED_BY_OWNER });
+        emit TradingEnabled({ pool: reserveToken, newStatus: false, reason: TRADING_STATUS_UPDATE_OWNER });
 
         emit TradingFeePPMUpdated({ pool: reserveToken, prevFeePPM: 0, newFeePPM: newPool.tradingFeePPM });
         emit DepositingEnabled({ pool: reserveToken, newStatus: newPool.depositingEnabled });
@@ -348,7 +348,7 @@ contract PoolCollection is IPoolCollection, OwnedUpgradeable, ReentrancyGuardUpg
 
         poolData.tradingEnabled = status;
 
-        emit TradingEnabled({ pool: pool, newStatus: status, reason: TRADING_ENABLED_BY_OWNER });
+        emit TradingEnabled({ pool: pool, newStatus: status, reason: TRADING_STATUS_UPDATE_OWNER });
     }
 
     /**
@@ -461,7 +461,7 @@ contract PoolCollection is IPoolCollection, OwnedUpgradeable, ReentrancyGuardUpg
                 poolData.liquidity.networkTokenTradingLiquidity.add(depositParams.baseTokenDeltaAmount) >=
                 minLiquidityForTrading
             ) {
-                emit TradingEnabled({ pool: pool, newStatus: true, reason: TRADING_ENABLED_BY_MINIMUM_LIQUIDITY });
+                emit TradingEnabled({ pool: pool, newStatus: true, reason: TRADING_STATUS_UPDATE_MIN_LIQUIDITY });
             }
         }
 
@@ -691,11 +691,7 @@ contract PoolCollection is IPoolCollection, OwnedUpgradeable, ReentrancyGuardUpg
             bool currEnabled = networkTokenCurrTradingLiquidity >= minLiquidityForTrading;
             bool newEnabled = networkTokenNewTradingLiquidity >= minLiquidityForTrading;
             if (newEnabled != currEnabled) {
-                emit TradingEnabled({
-                    pool: pool,
-                    newStatus: newEnabled,
-                    reason: TRADING_ENABLED_BY_MINIMUM_LIQUIDITY
-                });
+                emit TradingEnabled({ pool: pool, newStatus: newEnabled, reason: TRADING_STATUS_UPDATE_MIN_LIQUIDITY });
             }
         }
     }

packages/v3/test/pools/PoolCollection.ts

@@ -19,8 +19,8 @@ describe('PoolCollection', () => {
     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;
+    const TRADING_STATUS_UPDATE_OWNER = 0;
+    const TRADING_STATUS_UPDATE_MIN_LIQUIDITY = 1;
 
     let deployer: SignerWithAddress;
     let nonOwner: SignerWithAddress;
@@ -190,7 +190,7 @@ describe('PoolCollection', () => {
                         .withArgs(reserveToken.address, BigNumber.from(0), pool.tradingFeePPM);
                     await expect(res)
                         .to.emit(poolCollection, 'TradingEnabled')
-                        .withArgs(reserveToken.address, false, TRADING_ENABLED_BY_OWNER);
+                        .withArgs(reserveToken.address, false, TRADING_STATUS_UPDATE_OWNER);
                     await expect(res)
                         .to.emit(poolCollection, 'DepositingEnabled')
                         .withArgs(reserveToken.address, pool.depositingEnabled);
@@ -404,7 +404,7 @@ describe('PoolCollection', () => {
                 const res = await poolCollection.enableTrading(reserveToken.address, false);
                 await expect(res)
                     .to.emit(poolCollection, 'TradingEnabled')
-                    .withArgs(reserveToken.address, false, TRADING_ENABLED_BY_OWNER);
+                    .withArgs(reserveToken.address, false, TRADING_STATUS_UPDATE_OWNER);
 
                 pool = await poolCollection.poolData(reserveToken.address);
                 ({ tradingEnabled } = pool);
@@ -413,7 +413,7 @@ describe('PoolCollection', () => {
                 const res2 = await poolCollection.enableTrading(reserveToken.address, true);
                 await expect(res2)
                     .to.emit(poolCollection, 'TradingEnabled')
-                    .withArgs(reserveToken.address, true, TRADING_ENABLED_BY_OWNER);
+                    .withArgs(reserveToken.address, true, TRADING_STATUS_UPDATE_OWNER);
 
                 pool = await poolCollection.poolData(reserveToken.address);
                 ({ tradingEnabled } = pool);
@@ -998,7 +998,7 @@ describe('PoolCollection', () => {
                         ) {
                             await expect(res)
                                 .to.emit(poolCollection, 'TradingEnabled')
-                                .withArgs(reserveToken.address, true, TRADING_ENABLED_BY_MINIMUM_LIQUIDITY);
+                                .withArgs(reserveToken.address, true, TRADING_STATUS_UPDATE_MIN_LIQUIDITY);
                         }
 
                         let rate;