[Protocol3] Misc small improvements + More tests (#241)

* [Protocol3] WIP: maintenance mode changes

* [Protocol3] WIP: maintenance mode improvements

* [Protocol3] Fixed issue

* [Protocol3] Improved docs

* [Protocol3] Fixed doc

* Update ExchangeMode.sol

* Update ExchangeAdmins.sol

* [Protocol3] Tests + fixes for improved maintenance mode

* [Protocol3] Fixed misc tests

* [Protocol3] Added block version

* [Protocol3] Added support for data compression

* [Protocol3] Removed protocol2-js dependency

* [Protocol3] Fixed misc tests

* [Protocol3] Renamed numElements to blockSize for consistency

* [Protocol3] Optimized onchain decompression

* [Protocol3] Improved LZ compressor + ring data transformation

* [Protocol3] Misc small improvements

* [Protocol3] Improved LZ compressor performance

* [Protocol3] Fixed offchain withdrawal message signing

* [Protocol3] Update ABI

* [Protocol3] Updated generate_keys script for parameter rename

* [Protocol3] Break long lines

* [Protocol3] Misc small improvements + added misc tests

* [Protocol3] Misc improvements/tests for same accounts in requests

* [Protocol3] Fixed test

* [Protocol3] Added reentrancy tests

* [Protocol3] Small refactor

* [Protocol3] Added misc ring settlement/block fee tests

* [Protocol3] Removed 'only' from tests

* [Protocol3] Added transfer tests

* [Protocol3] Fixed testing check

* [Protocol3] Small refactor (burn -> protocol fees)

* [Protocol3] Cleaned up logging

* [Protocol3] Fixed precission error in test check

* [Protocol3] Added some more misc tests

* [Protocol3] Fixed test check for shutdown mode

* [Protocol3] Update backend doc

* [Protocol3] Small refactoring

* [Protocol3] Allow withdrawing the protocol fees directly to pfm

* [Protocol3] Changed createOrUpdateAccount to update the Merkle tree

* [Protocol3] Fixed compile warning

* [Protocol3] Fixed test with AccountContract

Author: Brechtpd

packages/loopring_v3/ABI/version30/AddressUtil.abi

@@ -232,30 +232,24 @@ Order
     validUntil: number,
     maxFeeBips: number,
     buy: number,
-    
+
     feeBips: number,
     rebateBips: number,
 
     signature: Signature,
-
-    # The data in the trade history of tokenS before they are updated
-    tradeHistoryFilled: string,
-    tradeHistoryCancelled: number,
-    tradeHistoryOrderID: number,
 }
 
 class Ring
 {
     orderA: Order,
     orderB: Order,
 
-    minerAccountID: number,
-    feeRecipientAccountID: number,
+    ringMatcherAccountID: number,
     tokenID: number,
     fee: string,
     nonce: number,
 
-    minerSignature: Signature,
+    ringMatcherSignature: Signature,
     dualAuthASignature: Signature,
     dualAuthBSignature: Signature,
 }
@@ -293,7 +287,7 @@ RingSettlement
     balanceUpdateB_M: BalanceUpdate,
     balanceUpdateO_M: BalanceUpdate,
     accountUpdate_M: AccountUpdate,
-    
+
     # Balance update data for protocol fee payments
     balanceUpdateA_P: BalanceUpdate,
     balanceUpdateB_P: BalanceUpdate,
@@ -311,11 +305,11 @@ RingSettlementBlock
 
     # Timestamp used in this block
     timestamp: number,
-    
+
     # Protocol fees used in this block
     protocolTakerFeeBips: number;
     protocolMakerFeeBips: number;
-    
+
     # Protocol fee account update data (account 0)
     accountUpdate_P: AccountUpdate,
 
@@ -594,8 +588,7 @@ Order
 
 Ring
 {
-    minerAccountID: number,
-    feeRecipientAccountID: number,
+    ringMatcherAccountID: number,
     tokenID: number,
     fee: string,
     orderA: Order,

packages/loopring_v3/ABI/version30/IExchange.abi

@@ -177,11 +177,25 @@ contract IExchange
 
     /// @dev Submit an onchain request to create a new account for msg.sender or
     ///      update its existing account by replacing its trading public key.
+    ///      The total fee in ETH that the user needs to pay is:
+    ///          depositFee +
+    ///          (isAccountNew ? accountCreationFee : 0) +
+    ///          (isAccountUpdated ? accountUpdateFee : 0)
+    ///      If the user sends too much ETH the surplus is immediatly sent back.
+    ///
+    ///      Note that after such an operation, it will take the operator some
+    ///      time (no more than MAX_AGE_REQUEST_UNTIL_FORCED) to process the request
+    ///      and create or update the offchain account.
+    ///
+    ///      Calling this method with a different trading public key will effectively
+    ///      cancel all existing orders within MAX_AGE_REQUEST_UNTIL_FORCED.
+    ///
     /// @param  pubKeyX The first part of the account's trading EdDSA public key
     /// @param  pubKeyY The second part of the account's trading EdDSA public key.
     ///                 Note that pubkeyX and pubKeyY cannot be both `1`.
     /// @return accountID The account's ID
     /// @return isAccountNew True if this account is newly created, false if the account existed
+    /// @return isAccountUpdated True if this account was updated, false otherwise
     function createOrUpdateAccount(
         uint pubKeyX,
         uint pubKeyY
@@ -190,7 +204,8 @@ contract IExchange
         payable
         returns (
             uint24 accountID,
-            bool   isAccountNew
+            bool   isAccountNew,
+            bool   isAccountUpdated
         );
 
     // -- Balances --
@@ -560,10 +575,16 @@ contract IExchange
         );
 
     /// @dev Deposit Ether or ERC20 tokens to the sender's account.
-    ///      This function will create a new account if such no account exists
+    ///      This function will create a new account if no account exists
     ///      for msg.sender, or update the existing account with the given trading
     ///      public key when the account exists.
     ///
+    ///      The total fee in ETH that the user needs to pay is:
+    ///          depositFee +
+    ///          (isAccountNew ? accountCreationFee : 0) +
+    ///          (isAccountUpdated ? accountUpdateFee : 0)
+    ///      If the user sends too much ETH the surplus is immediatly sent back.
+    ///
     ///      Note that after such an operation, it will take the operator some
     ///      time (no more than MAX_AGE_REQUEST_UNTIL_FORCED) to process the request
     ///      and create the deposit to the offchain account.
@@ -577,6 +598,7 @@ contract IExchange
     /// @param  amount The amount of tokens to deposit
     /// @return accountID The id of the account
     /// @return isAccountNew True if this account is newly created, false if the account existed
+    /// @return isAccountUpdated True if this account was updated, false otherwise
     function updateAccountAndDeposit(
         uint    pubKeyX,
         uint    pubKeyY,
@@ -587,15 +609,19 @@ contract IExchange
         payable
         returns (
             uint24 accountID,
-            bool   isAccountNew
+            bool   isAccountNew,
+            bool   isAccountUpdated
         );
 
     /// @dev Deposit Ether or ERC20 tokens to the sender's account.
     ///
+    ///      The total fee in ETH that the user needs to pay is 'depositFee'.
+    ///      If the user sends too much ETH the surplus is immediatly sent back.
+    ///
     ///      Note that after such an operation, it will take the operator some
     ///      time (no more than MAX_AGE_REQUEST_UNTIL_FORCED) to process the request
     ///      and create the deposit to the offchain account.
-    ////
+    ///
     ///      Warning: the DEX UI should warn their users not to deposit more than 2^96 - 1
     ///               tokens in total. If that happens, the user may lose token.
     ///               This token balance upper limit, however, is large enought for most scenarios.
@@ -611,6 +637,9 @@ contract IExchange
 
     /// @dev Deposit Ether or ERC20 tokens to a recipient account.
     ///
+    ///      The total fee in ETH that the user needs to pay is 'depositFee'.
+    ///      If the user sends too much ETH the surplus is immediatly sent back.
+    ///
     ///      Note that after such an operation, it will take the operator some
     ///      time (no more than MAX_AGE_REQUEST_UNTIL_FORCED) to process the request
     ///      and create the deposit to the offchain account.
@@ -664,15 +693,19 @@ contract IExchange
             uint32  timestamp
         );
 
-    // Set the large value for amount to withdraw the complete balance
     /// @dev Submit an onchain request to withdraw Ether or ERC20 tokens. To withdraw
     ///      all the balance, use a very large number for `amount`.
     ///
+    ///      Only the owner of the account can request a withdrawal.
+    ///
+    ///      The total fee in ETH that the user needs to pay is 'withdrawalFee'.
+    ///      If the user sends too much ETH the surplus is immediatly sent back.
+    ///
     ///      Note that after such an operation, it will take the operator some
     ///      time (no more than MAX_AGE_REQUEST_UNTIL_FORCED) to process the request
     ///      and create the deposit to the offchain account.
     ///
-    /// @param tokenAddress The adderss of the token, use `0x0` for Ether.
+    /// @param tokenAddress The address of the token, use `0x0` for Ether.
     /// @param amount The amount of tokens to deposit
     function withdraw(
         address tokenAddress,
@@ -681,6 +714,22 @@ contract IExchange
         external
         payable;
 
+    /// @dev Submit an onchain request to withdraw Ether or ERC20 tokens from the
+    ///      protocol fees account. The complete balance is always withdrawn.
+    ///
+    ///      Anyone can request a withdrawal of the protocol fees.
+    ///
+    ///      Note that after such an operation, it will take the operator some
+    ///      time (no more than MAX_AGE_REQUEST_UNTIL_FORCED) to process the request
+    ///      and create the deposit to the offchain account.
+    ///
+    /// @param tokenAddress The address of the token, use `0x0` for Ether.
+    function withdrawProtocolFees(
+        address tokenAddress
+        )
+        external
+        payable;
+
     /// @dev Allows an account owner to withdraw his funds using the balances stored
     ///      in the merkle tree. The funds will be sent to the owner of the acount.
     ///

packages/loopring_v3/ABI/version30/ILoopringV3.abi

@@ -60,6 +60,10 @@ contract ILoopringV3
         uint            time
     );
 
+    event ProtocolFeeManagerUpdated(
+        address payable pfm
+    );
+
     // == Public Variables ==
     struct Exchange
     {
@@ -91,6 +95,8 @@ contract ILoopringV3
     uint    public targetProtocolTakerFeeStake;
     uint    public targetProtocolMakerFeeStake;
 
+    address payable public pfm;
+
     // == Public Functions ==
     /// @dev Update the global exchange settings.
     ///      This function can only be called by the owner of this contract.
@@ -126,6 +132,16 @@ contract ILoopringV3
         )
         external;
 
+    /// @dev Update the protocol fee manager.
+    ///      This function can only be called by the owner of this contract.
+    ///
+    ///      Warning: this new address will be used by existing and
+    ///      new Loopring exchanges.
+    function setProtocolFeeManager(
+        address payable _pfm
+        )
+        external;
+
     /// @dev Create a new exchange. msg.sender will become the owner of the new exchange.
     /// @param  operator The operator address of the exchange who will be responsible for
     ///         submitting blocks and proofs.
@@ -230,16 +246,6 @@ contract ILoopringV3
         )
         external;
 
-    /// @dev Withdraw
-    /// @param exchangeId The id of the exchange to withdraw the fees from
-    /// @param tokenAddress The token to withdraw the fees for
-    function withdrawProtocolFees(
-        uint exchangeId,
-        address tokenAddress
-        )
-        external
-        payable;
-
     /// @dev Get the protocol fee values for an exchange.
     /// @param exchangeId The id of the exchange
     /// @param onchainDataAvailability True if the exchange has on-chain
@@ -254,25 +260,7 @@ contract ILoopringV3
         view
         returns (uint8 takerFeeBips, uint8 makerFeeBips);
 
-    /// @dev Withdraw all non-LRC fees (called the Burn) to the designated address.
-    ///      LRC fees have been burned already thanks to the new LRC contract's burn function;
-    ///      All non-LRC fees will be auctioned off for LRC by the Looprong Foundation, the
-    ///      purchased LRC will also be publicly burned.
-    ///
-    ///      In the future, all non-LRC fees will be auctioned off in a fully decentralized
-    ///      fashion using Loopring's Oedax (Open-Ended Dutch Auction eXchange) protocol.
-    ///      For more details, please see:
-    ///      https://medium.com/loopring-protocol/oedax-looprings-open-ended-dutch-auction-exchange-model-d92cebbd3667
-    ///
-    /// @param  token The address of the token. Use 0x0 for Ether.
-    /// @param  recipient The address to receive the tokens.
-    function withdrawTheBurn(
-        address token,
-        address payable recipient
-        )
-        external;
-
-    /// @dev Allow ETH to be sent directly to this contract (for burning)
+    /// @dev Allow ETH to be sent directly to this contract (to collect the protocol fees)
     function()
         external
         payable;