Merge pull request #50 from wildcat-finance/delete-pending-batch-on-closure

Delete pending batch on closure - resolves #48

Author: d1ll0n

src/market/WildcatMarket.sol

@@ -254,6 +254,26 @@ contract WildcatMarket is
         availableLiquidity -= normalizedAmountPaid;
         _withdrawalData.batches[expiry] = batch;
       }
+
+      // Remove the pending batch to ensure new withdrawals are not
+      // added to it after the market is closed.
+      state.pendingWithdrawalExpiry = 0;
+      emit_WithdrawalBatchExpired(
+        expiry,
+        batch.scaledTotalAmount,
+        batch.scaledAmountBurned,
+        batch.normalizedAmountPaid
+      );
+      emit_WithdrawalBatchClosed(expiry);
+
+      // If the batch expiry is at the time of the market's closure, create
+      // a new empty batch that expires in one second to ensure new batches
+      // aren't created after the market is closed with the same expiry.
+      if (expiry == block.timestamp) {
+        uint32 newExpiry = expiry + 1;
+        emit_WithdrawalBatchCreated(newExpiry);
+        state.pendingWithdrawalExpiry = newExpiry;
+      }
     }
 
     uint256 numBatches = _withdrawalData.unpaidBatches.length();

src/market/WildcatMarketWithdrawals.sol

@@ -235,10 +235,7 @@ contract WildcatMarketWithdrawals is WildcatMarketBase {
     uint baseCalldataSize
   ) internal returns (uint256) {
     WithdrawalBatch memory batch = _withdrawalData.batches[expiry];
-    // If the market is closed, allow withdrawal prior to expiry.
-    if (expiry >= block.timestamp && !state.isClosed) {
-      revert_WithdrawalBatchNotExpired();
-    }
+    if (expiry == state.pendingWithdrawalExpiry) revert_WithdrawalBatchNotExpired();
 
     AccountWithdrawalStatus storage status = _withdrawalData.accountStatuses[expiry][
       accountAddress

test/helpers/ExpectedStateTracker.sol

@@ -322,20 +322,21 @@ contract ExpectedStateTracker is Test, IMarketEventsAndErrors {
     address accountAddress,
     uint256 normalizedAmount
   ) internal returns (uint32 expiry, uint104 scaledAmount) {
-    return _trackQueueWithdrawal(
-      state,
-      accountAddress,
-      normalizedAmount,
-      registerExpectationsStandin,
-      0
-    );
+    return
+      _trackQueueWithdrawal(
+        state,
+        accountAddress,
+        normalizedAmount,
+        registerExpectationsStandin,
+        0
+      );
   }
 
   function _trackQueueWithdrawal(
     MarketState memory state,
     address accountAddress,
     uint256 normalizedAmount,
-    function (uint, bool) internal registerHookExpectations,
+    function(uint, bool) internal registerHookExpectations,
     uint registerHookExpectationsInput
   ) internal returns (uint32 expiry, uint104 scaledAmount) {
     scaledAmount = state.scaleAmount(normalizedAmount).toUint104();
@@ -476,6 +477,27 @@ contract ExpectedStateTracker is Test, IMarketEventsAndErrors {
         availableLiquidity -= normalizedAmountPaid;
         _withdrawalData.batches[expiry] = batch;
       }
+      state.pendingWithdrawalExpiry = 0;
+      if (expectEvents) {
+        vm.expectEmit(address(market));
+        emit WithdrawalBatchExpired(
+          expiry,
+          batch.scaledTotalAmount,
+          batch.scaledAmountBurned,
+          batch.normalizedAmountPaid
+        );
+        vm.expectEmit(address(market));
+        emit WithdrawalBatchClosed(expiry);
+      }
+
+      if (expiry == block.timestamp) {
+        uint32 newExpiry = expiry + 1;
+        if (expectEvents) {
+          vm.expectEmit(address(market));
+          emit WithdrawalBatchCreated(newExpiry);
+        }
+        state.pendingWithdrawalExpiry = newExpiry;
+      }
     }
 
     uint256 numBatches = _withdrawalData.unpaidBatches.length();
@@ -605,7 +627,7 @@ contract ExpectedStateTracker is Test, IMarketEventsAndErrors {
       return 0;
     }
     uint104 scaledAmountBurned = uint104(MathUtils.min(scaledAvailableLiquidity, scaledAmountOwed));
-    normalizedAmountPaid =  MathUtils.mulDiv(scaledAmountBurned, state.scaleFactor, RAY).toUint128();
+    normalizedAmountPaid = MathUtils.mulDiv(scaledAmountBurned, state.scaleFactor, RAY).toUint128();
 
     batch.scaledAmountBurned += scaledAmountBurned;
     batch.normalizedAmountPaid += normalizedAmountPaid;

test/market/WildcatMarket.t.sol

@@ -284,6 +284,7 @@ contract WildcatMarketTest is BaseMarketTest {
     state.isClosed = true;
     state.reserveRatioBips = 10000;
     state.timeDelinquent = 0;
+    state.pendingWithdrawalExpiry = 0;
     updateState(state);
     market.closeMarket();
     assertEq(market.getUnpaidBatchExpiries().length, 0);
@@ -401,7 +402,6 @@ contract WildcatMarketTest is BaseMarketTest {
     safeStopPrank();
   }
 
-
   function test_deposit_DepositBelowMinimum() external {
     parameters.minimumDeposit = 101;
     setUpContracts(false);

test/market/WildcatMarketWithdrawals.t.sol

@@ -161,7 +161,6 @@ contract WithdrawalsTest is BaseMarketTest {
     _requestWithdrawal(alice, withdrawalAmount);
   }
 
-
   /* -------------------------------------------------------------------------- */
   /*                              queueFullWithdrawal()                             */
   /* -------------------------------------------------------------------------- */
@@ -200,16 +199,8 @@ contract WithdrawalsTest is BaseMarketTest {
     uint256 userBalance1,
     uint256 userBalance2
   ) external asAccount(alice) {
-    userBalance1 = bound(
-      userBalance1,
-      2,
-      DefaultMaximumSupply / 2
-    );
-    userBalance2 = bound(
-      userBalance2,
-      2,
-      DefaultMaximumSupply - userBalance1
-    );
+    userBalance1 = bound(userBalance1, 2, DefaultMaximumSupply / 2);
+    userBalance2 = bound(userBalance2, 2, DefaultMaximumSupply - userBalance1);
     _deposit(alice, userBalance1);
     _deposit(bob, userBalance2);
     _requestFullWithdrawal(alice);
@@ -226,9 +217,7 @@ contract WithdrawalsTest is BaseMarketTest {
     );
   }
 
-  function test_queueFullWithdrawal_BurnAll(
-    uint128 userBalance
-  ) external asAccount(alice) {
+  function test_queueFullWithdrawal_BurnAll(uint128 userBalance) external asAccount(alice) {
     userBalance = uint128(bound(userBalance, 2, DefaultMaximumSupply));
     _deposit(alice, userBalance);
     _requestFullWithdrawal(alice);
@@ -280,9 +269,7 @@ contract WithdrawalsTest is BaseMarketTest {
     );
   }
 
-  function test_queueFullWithdrawal(
-    uint128 userBalance
-  ) external asAccount(alice) {
+  function test_queueFullWithdrawal(uint128 userBalance) external asAccount(alice) {
     userBalance = uint128(bound(userBalance, 2, DefaultMaximumSupply));
     _deposit(alice, userBalance);
     _requestFullWithdrawal(alice);
@@ -347,7 +334,7 @@ contract WithdrawalsTest is BaseMarketTest {
     uint32 expiry = uint32(block.timestamp + parameters.withdrawalBatchDuration);
     _closeMarket();
     fastForward(parameters.withdrawalBatchDuration + 1);
-    _trackExecuteWithdrawal(pendingState(), expiry, alice, 1e18,  false);
+    _trackExecuteWithdrawal(pendingState(), expiry, alice, 1e18, false);
     vm.prank(alice);
     market.executeWithdrawal(alice, expiry);
   }
@@ -357,7 +344,7 @@ contract WithdrawalsTest is BaseMarketTest {
     _requestWithdrawal(alice, 1e18);
     uint32 expiry = uint32(block.timestamp + parameters.withdrawalBatchDuration);
     _closeMarket();
-    _trackExecuteWithdrawal(pendingState(), expiry, alice, 1e18,  false);
+    _trackExecuteWithdrawal(pendingState(), expiry, alice, 1e18, false);
     vm.prank(alice);
     market.executeWithdrawal(alice, expiry);
   }
@@ -533,8 +520,7 @@ contract WithdrawalsTest is BaseMarketTest {
     market.repayAndProcessUnpaidWithdrawalBatches(0, 1);
 
     uint scaledAvailableLiquidity = state.scaleAmount(feesAccruedOnWithdrawal);
-    uint normalizedAmountPaid = MathUtils
-    .mulDiv(scaledAvailableLiquidity, state.scaleFactor, RAY);
+    uint normalizedAmountPaid = MathUtils.mulDiv(scaledAvailableLiquidity, state.scaleFactor, RAY);
     _checkBatch(expiry, 1e18, 1e18, 1e18 + normalizedAmountPaid);
     assertEq(market.getUnpaidBatchExpiries().length, 0);
     _checkState();
@@ -792,7 +778,7 @@ contract WithdrawalsTest is BaseMarketTest {
     _depositBorrowWithdraw(alice, 1e18, 8e17, 1e18);
     uint32 expiry = uint32(block.timestamp + parameters.withdrawalBatchDuration);
     asset.mint(address(market), 8e17);
-    fastForward( parameters.withdrawalBatchDuration + 1);
+    fastForward(parameters.withdrawalBatchDuration + 1);
     market.updateState();
   }
 }