feat(market): split update function

Now we have a public part that emits `PublicUpdate` event and private part that replaces all internal calls of previously public `update` function.
overlay-market · May 14, 2024 · 2996e66 · 2996e66
1 parent 94fa241
commit 2996e66
Show file tree

Hide file tree

Showing 2 changed files with 43 additions and 4 deletions.
diff --git a/contracts/OverlayV1Market.sol b/contracts/OverlayV1Market.sol
@@ -146,6 +146,10 @@ contract OverlayV1Market is IOverlayV1Market, Pausable {
     /// @param newDpUpperLimit new value for dpUpperLimit
     event CacheRiskCalc(uint256 newDpUpperLimit);
 
+    /// @param oiLong oiLong after public update
+    /// @param oiShort oiShort after public update
+    event PublicUpdate(uint256 oiLong, uint256 oiShort);
+
     constructor() {
         (address _ov, address _feed, address _factory) =
             IOverlayV1Deployer(msg.sender).parameters();
@@ -207,7 +211,7 @@ contract OverlayV1Market is IOverlayV1Market, Pausable {
         // avoids stack too deep
         {
             // call to update before any effects
-            Oracle.Data memory data = update();
+            Oracle.Data memory data = _update();
 
             // calculate notional, oi, and trading fees. fees charged on notional
             // and added to collateral transferred in
@@ -313,7 +317,7 @@ contract OverlayV1Market is IOverlayV1Market, Pausable {
         // avoids stack too deep
         {
             // call to update before any effects
-            Oracle.Data memory data = update();
+            Oracle.Data memory data = _update();
 
             // check position exists
             pos = positions.get(msg.sender, positionId);
@@ -431,7 +435,7 @@ contract OverlayV1Market is IOverlayV1Market, Pausable {
             require(pos.exists(), "OVV1:!position");
 
             // call to update before any effects
-            Oracle.Data memory data = update();
+            Oracle.Data memory data = _update();
 
             // cache for gas savings
             uint256 oiTotalOnSide = pos.isLong ? oiLong : oiShort;
@@ -511,7 +515,12 @@ contract OverlayV1Market is IOverlayV1Market, Pausable {
 
     /// @dev updates market: pays funding and fetches freshest data from feed
     /// @dev update is called every time market is interacted with
-    function update() public whenNotPaused returns (Oracle.Data memory) {
+    function update() external returns (Oracle.Data memory data) {
+        data = _update();
+        emit PublicUpdate(oiLong, oiShort);
+    }
+
+    function _update() private whenNotPaused returns (Oracle.Data memory) {
         // pay funding for time elasped since last interaction w market
         _payFunding();
 

diff --git a/tests/OverlayV1Market.t.sol b/tests/OverlayV1Market.t.sol
@@ -171,4 +171,34 @@ contract MarketTest is Test {
 
         assertEq(ov.balanceOf(address(market)), 0);
     }
+
+    event PublicUpdate(uint256 oiLong, uint256 oiShort);
+
+    function testUpdate() public {
+        vm.startPrank(USER);
+
+        ov.approve(address(market), type(uint256).max);
+        market.build(1e18, 1e18, true, type(uint256).max);
+
+        uint256 oiLong = market.oiLong();
+        uint256 oiShort = market.oiShort();
+        uint256 timeElapsed = block.timestamp - market.timestampUpdateLast();
+        bool isLongOverweight = oiLong > oiShort;
+        uint256 oiOverweight = isLongOverweight ? oiLong : oiShort;
+        uint256 oiUnderweight = isLongOverweight ? oiShort : oiLong;
+
+        (oiOverweight, oiUnderweight) =
+            market.oiAfterFunding(oiOverweight, oiUnderweight, timeElapsed);
+        uint256 newoiLong = isLongOverweight ? oiOverweight : oiUnderweight;
+        uint256 newoiShort = isLongOverweight ? oiUnderweight : oiOverweight;
+
+        vm.expectEmit(false, false, false, true);
+        emit PublicUpdate(newoiLong, newoiShort);
+        market.update();
+
+        vm.stopPrank();
+
+        assertEq(market.oiLong(), newoiLong);
+        assertEq(market.oiShort(), newoiShort);
+    }
 }