Add UserEjected event to FoxVault

stakewise · Mar 5, 2024 · cc392d2 · cc392d2
1 parent 397a60e
commit cc392d2
Show file tree

Hide file tree

Showing 5 changed files with 32 additions and 3 deletions.
diff --git a/abi/IEthFoxVault.json b/abi/IEthFoxVault.json
@@ -311,6 +311,25 @@
     "name": "Redeemed",
     "type": "event"
   },
+  {
+    "anonymous": false,
+    "inputs": [
+      {
+        "indexed": false,
+        "internalType": "address",
+        "name": "user",
+        "type": "address"
+      },
+      {
+        "indexed": false,
+        "internalType": "uint256",
+        "name": "shares",
+        "type": "uint256"
+      }
+    ],
+    "name": "UserEjected",
+    "type": "event"
+  },
   {
     "anonymous": false,
     "inputs": [

diff --git a/contracts/interfaces/IEthFoxVault.sol b/contracts/interfaces/IEthFoxVault.sol
@@ -31,6 +31,13 @@ interface IEthFoxVault is
   IVaultBlocklist,
   IMulticall
 {
+  /**
+   * @notice Event emitted when a user is ejected from the Vault
+   * @param user The address of the user
+   * @param shares The amount of shares ejected
+   */
+  event UserEjected(address user, uint256 shares);
+
   /**
    * @dev Struct for initializing the EthFoxVault contract
    * @param admin The address of the Vault admin

diff --git a/contracts/vaults/ethereum/custom/EthFoxVault.sol b/contracts/vaults/ethereum/custom/EthFoxVault.sol
@@ -100,6 +100,7 @@ contract EthFoxVault is
       // redeem user shares
       _redeem(user, userShares, user);
     }
+    emit UserEjected(user, userShares);
   }
 
   /**

diff --git a/test/EthFoxVault.spec.ts b/test/EthFoxVault.spec.ts
@@ -229,6 +229,7 @@ describe('EthFoxVault', () => {
       await expect(tx)
         .to.emit(vault, 'Redeemed')
         .withArgs(sender.address, sender.address, senderAssets, senderShares)
+      await expect(tx).to.emit(vault, 'UserEjected').withArgs(sender.address, senderShares)
       expect(await vault.getShares(sender.address)).to.eq(0)
       await snapshotGasCost(tx)
     })
@@ -245,6 +246,7 @@ describe('EthFoxVault', () => {
       await expect(tx)
         .to.emit(vault, 'ExitQueueEntered')
         .withArgs(sender.address, sender.address, positionTicket, senderShares)
+      await expect(tx).to.emit(vault, 'UserEjected').withArgs(sender.address, senderShares)
       expect(await vault.getShares(sender.address)).to.eq(0)
       await snapshotGasCost(tx)
     })

diff --git a/test/__snapshots__/EthFoxVault.spec.ts.snap b/test/__snapshots__/EthFoxVault.spec.ts.snap
@@ -31,21 +31,21 @@ Object {
 exports[`EthFoxVault ejecting user blocklist manager can eject all of the user assets for collateralized vault 1`] = `
 Object {
   "calldataByteLength": 36,
-  "gasUsed": 112108,
+  "gasUsed": 113416,
 }
 `;
 
 exports[`EthFoxVault ejecting user blocklist manager can eject all of the user assets for not collateralized vault 1`] = `
 Object {
   "calldataByteLength": 36,
-  "gasUsed": 83278,
+  "gasUsed": 84597,
 }
 `;
 
 exports[`EthFoxVault ejecting user does not fail for user with no vault shares 1`] = `
 Object {
   "calldataByteLength": 36,
-  "gasUsed": 55808,
+  "gasUsed": 55813,
 }
 `;
-Original file line number
+Diff line change
@@ Expand Up / @@ -100,6 +100,7 @@ contract EthFoxVault is @@
           // redeem user shares
           _redeem(user, userShares, user);
         }
+        emit UserEjected(user, userShares);
       }
       /**
@@ Expand Down @@