[Protocol3] rename ProtocolFeeManager to ProtocolFeeVault (#250)

dong77 · web-flow · commit 38aeaa9e6295 · 2019-07-03T14:01:07.000+08:00
diff --git a/packages/loopring_v3/ABI/version30/ILoopringV3.abi b/packages/loopring_v3/ABI/version30/ILoopringV3.abi
diff --git a/packages/loopring_v3/contracts/iface/ILoopringV3.sol b/packages/loopring_v3/contracts/iface/ILoopringV3.sol
@@ -60,8 +60,8 @@ contract ILoopringV3
         uint            time
     );
 
-    event ProtocolFeeManagerUpdated(
-        address payable pfm
+    event ProtocolFeeVaultUpdated(
+        address payable protocolFeeVault
     );
 
     // == Public Variables ==
@@ -95,7 +95,7 @@ contract ILoopringV3
     uint    public targetProtocolTakerFeeStake;
     uint    public targetProtocolMakerFeeStake;
 
-    address payable public pfm;
+    address payable public protocolFeeVault;
 
     // == Public Functions ==
     /// @dev Update the global exchange settings.
@@ -137,8 +137,8 @@ contract ILoopringV3
     ///
     ///      Warning: this new address will be used by existing and
     ///      new Loopring exchanges.
-    function setProtocolFeeManager(
-        address payable _pfm
+    function setProtocolFeeVault(
+        address payable _protocolFeeVault
         )
         external;
 
diff --git a/packages/loopring_v3/contracts/iface/IProtocolFeeVault.sol b/packages/loopring_v3/contracts/iface/IProtocolFeeVault.sol
@@ -17,7 +17,7 @@
 pragma solidity 0.5.7;
 
 
-/// @title IProtocolFeeManager
+/// @title IProtocolFeeVault
 /// @dev This smart contract manages the distribution of protocol fees.
 /// Tokens other than LRC will be auctioned off for LRC using Oedax. The owner
 /// of this smart contract will also have the option to withdraw non-LRC tokens
@@ -26,7 +26,7 @@ pragma solidity 0.5.7;
 /// For LRC token, 70% of them can be withdrawn to the UserStakingPool contract
 /// to reward LRC stakers; 15% of them can be withdrawn to the Loopring DAO,
 /// and the remaining 15% can be burned to reduce LRC's total supply.
-contract IProtocolFeeManager
+contract IProtocolFeeVault
 {
     uint public constant REWARD_PERCENTAGE      = 70;
     uint public constant DAO_PERDENTAGE         = 20;
diff --git a/packages/loopring_v3/contracts/iface/IUserStakingPool.sol b/packages/loopring_v3/contracts/iface/IUserStakingPool.sol
@@ -29,17 +29,17 @@ contract IUserStakingPool
     uint public constant AUCTION_DURATION       = 7  days;
 
     address public lrcAddress;
-    address public pfmAddress; // ProtocolFeeManager address
+    address public protocolFeeVaultAddress;
 
     uint    public numAddresses;
 
     event LRCStaked       (address user,  uint amount);
     event LRCWithdrawn    (address user,  uint amount);
     event LRCRewarded     (address user,  uint amount);
 
-    /// @dev Set a new IProtocolFeeManager address, only callable by the owner.
-    /// @param _pfmAddress The new IProtocolFeeManager address.
-    function setProtocolFeeManager(address _pfmAddress)
+    /// @dev Set a new IProtocolFeeVault address, only callable by the owner.
+    /// @param _protocolFeeVaultAddress The new IProtocolFeeVault address.
+    function setProtocolFeeVault(address _protocolFeeVaultAddress)
         external
         ;
 
diff --git a/packages/loopring_v3/contracts/impl/LoopringV3.sol b/packages/loopring_v3/contracts/impl/LoopringV3.sol
@@ -38,7 +38,7 @@ contract LoopringV3 is ILoopringV3, Claimable
 
     // -- Constructor --
     constructor(
-        address payable _pfm,
+        address payable _protocolFeeVault,
         address _lrcAddress,
         address _wethAddress,
         address _blockVerifierAddress,
@@ -54,11 +54,11 @@ contract LoopringV3 is ILoopringV3, Claimable
         )
         public
     {
-        require(address(0) != _pfm, "ZERO_ADDRESS");
+        require(address(0) != _protocolFeeVault, "ZERO_ADDRESS");
         require(address(0) != _lrcAddress, "ZERO_ADDRESS");
         require(address(0) != _wethAddress, "ZERO_ADDRESS");
 
-        pfm = _pfm;
+        protocolFeeVault = _protocolFeeVault;
         lrcAddress = _lrcAddress;
         wethAddress = _wethAddress;
 
@@ -127,16 +127,16 @@ contract LoopringV3 is ILoopringV3, Claimable
         emit SettingsUpdated(now);
     }
 
-    function setProtocolFeeManager(
-        address payable _pfm
+    function setProtocolFeeVault(
+        address payable _protocolFeeVault
         )
         external
         onlyOwner
     {
-        require(_pfm != address(0), "ZERO_ADDRESS");
-        pfm = _pfm;
+        require(_protocolFeeVault != address(0), "ZERO_ADDRESS");
+        protocolFeeVault = _protocolFeeVault;
 
-        emit ProtocolFeeManagerUpdated(pfm);
+        emit ProtocolFeeVaultUpdated(protocolFeeVault);
     }
 
     function createExchange(
diff --git a/packages/loopring_v3/contracts/impl/ProtocolFeeVault.sol b/packages/loopring_v3/contracts/impl/ProtocolFeeVault.sol
@@ -16,7 +16,7 @@
 */
 pragma solidity 0.5.7;
 
-import "../iface/IProtocolFeeManager.sol";
+import "../iface/IProtocolFeeVault.sol";
 
 import "..//lib/Claimable.sol";
 import "../lib/BurnableERC20.sol";
@@ -68,7 +68,7 @@ contract IAuction {
 
 /// @title An Implementation of IUserStakingPool.
 /// @author Daniel Wang - <daniel@loopring.org>
-contract ProtocolFeeManager is IProtocolFeeManager, Claimable
+contract ProtocolFeeVault is IProtocolFeeVault, Claimable
 {
     uint public constant MIN_ETHER_TO_KEEP = 1 ether;
     using ERC20SafeTransfer for address;
diff --git a/packages/loopring_v3/contracts/impl/UserStakingPool.sol b/packages/loopring_v3/contracts/impl/UserStakingPool.sol
@@ -17,7 +17,7 @@
 pragma solidity 0.5.7;
 
 import "../iface/IUserStakingPool.sol";
-import "../iface/IProtocolFeeManager.sol";
+import "../iface/IProtocolFeeVault.sol";
 
 import "..//lib/Claimable.sol";
 import "../lib/ERC20SafeTransfer.sol";
@@ -55,12 +55,12 @@ contract UserStakingPool is IUserStakingPool, Claimable
         lrcAddress = _lrcAddress;
     }
 
-    function setProtocolFeeManager(address _pfmAddress)
+    function setProtocolFeeVault(address _protocolFeeVaultAddress)
         external
         onlyOwner
     {
-        require(_pfmAddress != address(0), "ZERO_ADDRESS");
-        pfmAddress = _pfmAddress;
+        require(_protocolFeeVaultAddress != address(0), "ZERO_ADDRESS");
+        protocolFeeVaultAddress = _protocolFeeVaultAddress;
     }
 
     function getTotalStaking()
@@ -174,7 +174,7 @@ contract UserStakingPool is IUserStakingPool, Claimable
 
         (totalPoints, userPoints, claimedAmount) = userOutstandingReward(msg.sender);
 
-        IProtocolFeeManager(pfmAddress).claim(claimedAmount);
+        IProtocolFeeVault(protocolFeeVaultAddress).claim(claimedAmount);
 
         total.stake = total.stake.add(claimedAmount);
         total.claimedReward = total.claimedReward.add(claimedAmount);
@@ -223,7 +223,7 @@ contract UserStakingPool is IUserStakingPool, Claimable
         userPoints = user.stake.mul(now.sub(user.claimedAt));
 
         if (totalPoints != 0 && userPoints != 0) {
-            (, , , , , , , outstandindReward) = IProtocolFeeManager(pfmAddress).getLRCFeeStats();
+            (, , , , , , , outstandindReward) = IProtocolFeeVault(protocolFeeVaultAddress).getLRCFeeStats();
             outstandindReward = outstandindReward.mul(userPoints) / totalPoints;
         }
     }
diff --git a/packages/loopring_v3/contracts/impl/libexchange/ExchangeWithdrawals.sol b/packages/loopring_v3/contracts/impl/libexchange/ExchangeWithdrawals.sol
@@ -380,7 +380,7 @@ library ExchangeWithdrawals
         requestedBlock.blockFeeWithdrawn = true;
 
         // Burn part of the fee by sending it to the protocol fee manager
-        S.loopring.pfm().transferETH(feeAmountToBurn, gasleft());
+        S.loopring.protocolFeeVault().transferETH(feeAmountToBurn, gasleft());
         // Transfer the fee to the operator
         feeRecipient.transferETH(feeAmountToOperator, gasleft());
 
@@ -472,7 +472,7 @@ library ExchangeWithdrawals
         // If we're withdrawing from the protocol fee account sent the tokens
         // directly to the protocol fee manager
         if (accountID == 0) {
-            to = S.loopring.pfm();
+            to = S.loopring.protocolFeeVault();
         }
 
         address token = S.getTokenAddress(tokenID);
diff --git a/packages/loopring_v3/package.json b/packages/loopring_v3/package.json
@@ -49,7 +49,7 @@
     "ganache-cli": "6.4.3",
     "mocha": "^5.2.0",
     "node": "^10.15.3",
-    "npm": "^6.9.0",
+    "npm": "^6.9.2",
     "npm-watch": "^0.6.0",
     "solidity-coverage": "^0.5.11",
     "solium": "^1.2.4",
diff --git a/packages/loopring_v3/test/testExchangeBlocks.ts b/packages/loopring_v3/test/testExchangeBlocks.ts
@@ -39,16 +39,16 @@ contract("Exchange", (accounts: string[]) => {
   const withdrawBlockFeeChecked = async (blockIdx: number, operator: string, totalBlockFee: BN,
                                          expectedBlockFee: BN, allowedDelta: BN = new BN(0)) => {
     const token = "ETH";
-    const pfm = await loopring.pfm();
+    const protocolFeeVault = await loopring.protocolFeeVault();
     const balanceOperatorBefore = await exchangeTestUtil.getOnchainBalance(operator, token);
     const balanceContractBefore = await exchangeTestUtil.getOnchainBalance(exchange.address, token);
-    const balanceBurnedBefore = await exchangeTestUtil.getOnchainBalance(pfm, token);
+    const balanceBurnedBefore = await exchangeTestUtil.getOnchainBalance(protocolFeeVault, token);
 
     await exchange.withdrawBlockFee(blockIdx, operator, {from: operator, gasPrice: 0});
 
     const balanceOperatorAfter = await exchangeTestUtil.getOnchainBalance(operator, token);
     const balanceContractAfter = await exchangeTestUtil.getOnchainBalance(exchange.address, token);
-    const balanceBurnedAfter = await exchangeTestUtil.getOnchainBalance(pfm, token);
+    const balanceBurnedAfter = await exchangeTestUtil.getOnchainBalance(protocolFeeVault, token);
 
     const expectedBurned = totalBlockFee.sub(expectedBlockFee);
 
diff --git a/packages/loopring_v3/test/testExchangeDepositWithdraw.ts b/packages/loopring_v3/test/testExchangeDepositWithdraw.ts
@@ -141,7 +141,7 @@ contract("Exchange", (accounts: string[]) => {
   const withdrawOnceChecked = async (blockIdx: number, slotIdx: number,
                                      accountID: number, token: string,
                                      owner: string, expectedAmount: BN) => {
-    const recipient = (accountID === 0) ? await loopring.pfm() : owner;
+    const recipient = (accountID === 0) ? await loopring.protocolFeeVault() : owner;
     const balanceOwnerBefore = await exchangeTestUtil.getOnchainBalance(recipient, token);
     const balanceContractBefore = await exchangeTestUtil.getOnchainBalance(exchange.address, token);
 
diff --git a/packages/loopring_v3/test/testExchangeUtil.ts b/packages/loopring_v3/test/testExchangeUtil.ts
@@ -54,7 +54,7 @@ export class ExchangeTestUtil {
   public blockVerifier: any;
   public lzDecompressor: any;
 
-  public pfmAddress: string;
+  public protocolFeeVaultAddress: string;
   public lrcAddress: string;
   public wethAddress: string;
 
@@ -148,8 +148,8 @@ export class ExchangeTestUtil {
       {from: this.testContext.deployer},
     );
 
-    this.pfmAddress = this.testContext.deployer;
-    await this.loopringV3.setProtocolFeeManager(this.pfmAddress);
+    this.protocolFeeVaultAddress = this.testContext.deployer;
+    await this.loopringV3.setProtocolFeeVault(this.protocolFeeVaultAddress);
 
     for (let i = 0; i < this.MAX_NUM_EXCHANGES; i++) {
       const rings: RingInfo[] = [];
diff --git a/packages/loopring_v3/test/testExchangeWithdrawalMode.ts b/packages/loopring_v3/test/testExchangeWithdrawalMode.ts
@@ -31,7 +31,7 @@ contract("Exchange", (accounts: string[]) => {
 
   const withdrawFromMerkleTreeChecked = async (owner: string, token: string,
                                                expectedAmount: BN) => {
-    const recipient = (owner === constants.zeroAddress) ? await loopring.pfm() : owner;
+    const recipient = (owner === constants.zeroAddress) ? await loopring.protocolFeeVault() : owner;
     const balanceBefore = await exchangeTestUtil.getOnchainBalance(recipient, token);
     await exchangeTestUtil.withdrawFromMerkleTree(owner, token);
     const balanceAfter = await exchangeTestUtil.getOnchainBalance(recipient, token);
diff --git a/packages/loopring_v3/test/testLoopring.ts b/packages/loopring_v3/test/testLoopring.ts
@@ -127,14 +127,14 @@ contract("Loopring", (accounts: string[]) => {
 
   describe("Owner", () => {
     it("should be able to set the protocol fee manager", async () => {
-      const pfmBefore = await loopring.pfm();
-      const newPfm = exchangeTestUtil.testContext.orderOwners[2];
-      assert(newPfm !== pfmBefore);
+      const protocolFeeVaultBefore = await loopring.protocolFeeVault();
+      const newProtocolFeeVault = exchangeTestUtil.testContext.orderOwners[2];
+      assert(newProtocolFeeVault !== protocolFeeVaultBefore);
 
-      await loopring.setProtocolFeeManager(newPfm);
+      await loopring.setProtocolFeeVault(newProtocolFeeVault);
 
-      const pfmAfter = await loopring.pfm();
-      assert(newPfm === pfmAfter, "new pfm should be set");
+      const protocolFeeVaultAfter = await loopring.protocolFeeVault();
+      assert(newProtocolFeeVault === protocolFeeVaultAfter, "new protocolFeeVault should be set");
     });
   });
 
@@ -191,9 +191,9 @@ contract("Loopring", (accounts: string[]) => {
     });
 
     it("should not be able to set the protocol fee manager", async () => {
-      const newPfm = exchangeTestUtil.testContext.orderOwners[3];
+      const newProtocolFeeVault = exchangeTestUtil.testContext.orderOwners[3];
       await expectThrow(
-        loopring.setProtocolFeeManager(newPfm, {from: exchangeTestUtil.exchangeOperator}),
+        loopring.setProtocolFeeVault(newProtocolFeeVault, {from: exchangeTestUtil.exchangeOperator}),
         "UNAUTHORIZED",
       );
     });
