chore: cleanup (#10)

antoncoding · web-flow · commit 0d53aa8c0fcc · 2023-06-29T17:29:29.000+08:00
* chore: cleanup

* chore: add tests

* chore: coverage for process manager data

* docs: readme
diff --git a/README.md b/README.md
@@ -0,0 +1,27 @@
+# Lyra Matching Contracts 
+
+[![codecov](https://codecov.io/gh/lyra-finance/v2-matching/branch/master/graph/badge.svg?token=ZhHkpl1UGB)](https://codecov.io/gh/lyra-finance/v2-matching)
+
+This repository contains a set of smart contracts designed to enable sequential matching by our back-end on [v2 protocol](https://github.com/lyra-finance/v2-core). The contracts facilitate the execution of transactions based on a trusted keeper (`trade-executor`), while giving user full custody of funds.
+
+
+## Main components:
+
+`Matching`: Process signed orders and additional "actionData" from the orderbook, ensuring whitelisted modules can execute actions within specified rules. Inherits `OrderVerifier` and `SubAccountManager`
+
+Other Modules: contract that take ownership of user's subAccounts from the matching contract, and then execute accordingly base on what users signed.
+
+For detailed information about the contracts, modules, and installation instructions, please refer to [Notion](https://www.notion.so/lyra-finance/Matching-59db600914334665ba7179c1f03ac6c2).
+
+## Building and Testing:
+
+```shell
+forge build
+```
+
+Run tests
+
+```shell
+forge test
+```
+
diff --git a/src/Matching.sol b/src/Matching.sol
@@ -1,8 +1,6 @@
 // SPDX-License-Identifier: UNLICENSED
 pragma solidity ^0.8.13;
 
-import "forge-std/console2.sol";
-
 // inherited
 import {OrderVerifier} from "./OrderVerifier.sol";
 import {IMatching} from "./interfaces/IMatching.sol";
@@ -23,7 +21,7 @@ contract Matching is IMatching, OrderVerifier {
   constructor(ISubAccounts _accounts) OrderVerifier(_accounts) {}
 
   ////////////////////////////
-  //  Onwer-only Functions  //
+  //  Owner-only Functions  //
   ////////////////////////////
 
   /**
@@ -47,14 +45,13 @@ contract Matching is IMatching, OrderVerifier {
 
   function verifyAndMatch(SignedOrder[] memory orders, bytes memory actionData) public onlyTradeExecutor {
     IMatchingModule module = orders[0].module;
-    _verifyModule(module);
+
+    if (!allowedModules[address(module)]) revert M_OnlyAllowedModule();
 
     IMatchingModule.VerifiedOrder[] memory verifiedOrders = new IMatchingModule.VerifiedOrder[](orders.length);
     for (uint i = 0; i < orders.length; i++) {
       verifiedOrders[i] = _verifyOrder(orders[i]);
-      if (orders[i].module != module) {
-        revert M_MismatchedModule();
-      }
+      if (orders[i].module != module) revert M_MismatchedModule();
     }
     _submitModuleAction(module, verifiedOrders, actionData);
   }
@@ -63,6 +60,10 @@ contract Matching is IMatching, OrderVerifier {
   //  Internal Functions  //
   //////////////////////////
 
+  /**
+   * @notice sent array of signed actions to the module contract
+   * @dev expect the module to transfer the ownership back to Matching.sol at the end
+   */
   function _submitModuleAction(
     IMatchingModule module,
     IMatchingModule.VerifiedOrder[] memory orders,
@@ -98,12 +99,6 @@ contract Matching is IMatching, OrderVerifier {
     }
   }
 
-  function _verifyModule(IMatchingModule module) internal view {
-    if (!allowedModules[address(module)]) {
-      revert M_OnlyAllowedModule();
-    }
-  }
-
   ///////////////
   // Modifiers //
   ///////////////
diff --git a/src/modules/BaseModule.sol b/src/modules/BaseModule.sol
@@ -6,7 +6,6 @@ import {IBaseModule} from "../interfaces/IBaseModule.sol";
 
 // Interfaces
 import {ISubAccounts} from "v2-core/src/interfaces/ISubAccounts.sol";
-import {IMatchingModule} from "../interfaces/IMatchingModule.sol";
 import {IMatching} from "../interfaces/IMatching.sol";
 
 abstract contract BaseModule is IBaseModule {
diff --git a/src/modules/DepositModule.sol b/src/modules/DepositModule.sol
@@ -1,8 +1,6 @@
 // SPDX-License-Identifier: UNLICENSED
 pragma solidity ^0.8.13;
 
-import "forge-std/console2.sol";
-
 // Inherited
 import {BaseModule} from "./BaseModule.sol";
 import {IDepositModule} from "../interfaces/IDepositModule.sol";
diff --git a/src/modules/TradeModule.sol b/src/modules/TradeModule.sol
@@ -16,11 +16,9 @@ import {ITradeModule} from "../interfaces/ITradeModule.sol";
 // Interfaces
 import {IBaseManager} from "v2-core/src/interfaces/IBaseManager.sol";
 import {IDataReceiver} from "v2-core/src/interfaces/IDataReceiver.sol";
-import {IMatchingModule} from "../interfaces/IMatchingModule.sol";
 import {ISubAccounts} from "v2-core/src/interfaces/ISubAccounts.sol";
 import {IAsset} from "v2-core/src/interfaces/IAsset.sol";
 import {IPerpAsset} from "v2-core/src/interfaces/IPerpAsset.sol";
-import {SignedMath} from "openzeppelin/utils/math/SignedMath.sol";
 import {IMatching} from "../interfaces/IMatching.sol";
 
 contract TradeModule is ITradeModule, BaseModule, Ownable2Step {
@@ -52,10 +50,16 @@ contract TradeModule is ITradeModule, BaseModule, Ownable2Step {
   // Admin //
   ///////////
 
+  /**
+   * @dev set fee recipient account
+   */
   function setFeeRecipient(uint _feeRecipient) external onlyOwner {
     feeRecipient = _feeRecipient;
   }
 
+  /**
+   * @dev set perp asset mapping
+   */
   function setPerpAsset(IPerpAsset _perpAsset, bool isPerp) external onlyOwner {
     isPerpAsset[_perpAsset] = isPerp;
   }
@@ -220,6 +224,9 @@ contract TradeModule is ITradeModule, BaseModule, Ownable2Step {
     });
   }
 
+  /**
+   * @dev send data to IDataReceiver contracts. Can be used to update oracles before pairing trades
+   */
   function _processManagerData(bytes memory managerData) internal {
     if (managerData.length == 0) return;
     IBaseManager.ManagerData[] memory managerDatas = abi.decode(managerData, (IBaseManager.ManagerData[]));
diff --git a/src/modules/TransferModule.sol b/src/modules/TransferModule.sol
@@ -2,15 +2,13 @@
 pragma solidity ^0.8.13;
 
 // Inherited
-import {Ownable2Step} from "openzeppelin/access/Ownable2Step.sol";
 import {BaseModule} from "./BaseModule.sol";
 import {ITransferModule} from "../interfaces/ITransferModule.sol";
 
 // Interfaces
 import {ISubAccounts} from "v2-core/src/interfaces/ISubAccounts.sol";
 import {IManager} from "v2-core/src/interfaces/IManager.sol";
 import {IAsset} from "v2-core/src/interfaces/IAsset.sol";
-import {IMatchingModule} from "../interfaces/IMatchingModule.sol";
 import {IMatching} from "../interfaces/IMatching.sol";
 
 // Handles transferring assets from one subaccount to another
diff --git a/test/MatchingBasic.t.sol b/test/MatchingBasic.t.sol
@@ -40,4 +40,15 @@ contract MatchingBasicTest is MatchingBase {
     vm.expectRevert(IMatching.M_AccountNotReturned.selector);
     _verifyAndMatch(orders, "");
   }
+
+  function testCannotExecuteActionsForDifferentModules() public {
+    BadModule badModule = new BadModule();
+
+    IOrderVerifier.SignedOrder[] memory orders = new IOrderVerifier.SignedOrder[](2);
+    orders[0] = _createFullSignedOrder(camAcc, 0, address(depositModule), "", block.timestamp + 1 days, cam, cam, camPk);
+    orders[1] = _createFullSignedOrder(camAcc, 0, address(badModule), "", block.timestamp + 1 days, cam, cam, camPk);
+
+    vm.expectRevert(IMatching.M_MismatchedModule.selector);
+    _verifyAndMatch(orders, "");
+  }
 }
diff --git a/test/mock/MockDataReceiver.sol b/test/mock/MockDataReceiver.sol
@@ -0,0 +1,13 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.13;
+
+import {IDataReceiver} from "v2-core/src/interfaces/IDataReceiver.sol";
+import {MockFeeds} from "v2-core/test/shared/mocks/MockFeeds.sol";
+
+contract MockDataReceiver is IDataReceiver {
+  // update mocked feed
+  function acceptData(bytes memory data) external {
+    (address mockedFeed, uint price) = abi.decode(data, (address, uint));
+    MockFeeds(mockedFeed).setSpot(price, 1e18);
+  }
+}
diff --git a/test/modules/Trade.t.sol b/test/modules/Trade.t.sol
@@ -1,14 +1,12 @@
 // SPDX-License-Identifier: UNLICENSED
 pragma solidity ^0.8.18;
 
-import "forge-std/Test.sol";
-
 import {MatchingBase} from "test/shared/MatchingBase.t.sol";
 import {IOrderVerifier} from "src/interfaces/IOrderVerifier.sol";
-import {IERC20BasedAsset} from "v2-core/src/interfaces/IERC20BasedAsset.sol";
-import {IManager} from "v2-core/src/interfaces/IManager.sol";
-import {IERC20Metadata} from "openzeppelin/token/ERC20/extensions/IERC20Metadata.sol";
 import {TradeModule, ITradeModule} from "src/modules/TradeModule.sol";
+import {IPerpAsset} from "v2-core/src/interfaces/IPerpAsset.sol";
+import {IBaseManager} from "v2-core/src/interfaces/IBaseManager.sol";
+import {MockDataReceiver} from "../mock/MockDataReceiver.sol";
 
 contract TradeModuleTest is MatchingBase {
   // Test trading
@@ -18,6 +16,21 @@ contract TradeModuleTest is MatchingBase {
   //  - mismatch of signed orders and trade data
   //  - cannot trade if the order is expired
 
+  function testSetFeeRecipient() public {
+    uint newAcc = subAccounts.createAccount(cam, pmrm);
+    tradeModule.setFeeRecipient(newAcc);
+    assertEq(tradeModule.feeRecipient(), newAcc);
+  }
+
+  function testSetIsPerp() public {
+    tradeModule.setPerpAsset(IPerpAsset(address(this)), true);
+    assertEq(tradeModule.isPerpAsset(IPerpAsset(address(this))), true);
+  }
+
+  ////////////////////////
+  //     Test Trades    //
+  ////////////////////////
+
   function testTrade() public {
     IOrderVerifier.SignedOrder[] memory orders = _getDefaultOrders();
     _verifyAndMatch(orders, _createMatchedTrade(camAcc, dougAcc, 1e18, 78e18, 0, 0));
@@ -327,6 +340,35 @@ contract TradeModuleTest is MatchingBase {
     assertEq(subAccounts.getBalance(dougAcc, mockPerp, 0), -1e18);
   }
 
+  function testCanUpdateSpotAndThenTrade() public {
+    MockDataReceiver mockedUpdater = new MockDataReceiver();
+    uint newPrice = 2000;
+
+    // use the default orders
+    IOrderVerifier.SignedOrder[] memory orders = _getDefaultOrders();
+
+    // fill in default fill details
+    ITradeModule.FillDetails[] memory fills = new ITradeModule.FillDetails[](1);
+    fills[0] = ITradeModule.FillDetails({filledAccount: dougAcc, amountFilled: 1e18, price: 78e18, fee: 0});
+
+    // the data that should be processed before trade
+    IBaseManager.ManagerData[] memory managerDatas = new IBaseManager.ManagerData[](1);
+    bytes memory receiverData = abi.encode(address(feed), newPrice);
+    managerDatas[0] = IBaseManager.ManagerData(address(mockedUpdater), receiverData);
+    bytes memory finalManagerData = abi.encode(managerDatas);
+
+    ITradeModule.ActionData memory actionData =
+      ITradeModule.ActionData({takerAccount: camAcc, takerFee: 0, fillDetails: fills, managerData: finalManagerData});
+
+    bytes memory matchData = abi.encode(actionData);
+
+    _verifyAndMatch(orders, matchData);
+
+    (uint newSpot,) = feed.getSpot();
+    assertEq(newSpot, newPrice);
+  }
+
+  /// @dev return order of 2: [0: cam (taker)], [1: doug (maker)]
   function _getDefaultOrders() internal returns (IOrderVerifier.SignedOrder[] memory) {
     IOrderVerifier.SignedOrder[] memory orders = new IOrderVerifier.SignedOrder[](2);
 
