Fix incorrect calculateExitedAssets interface outputs

stakewise · Mar 18, 2024 · ac91863 · ac91863
1 parent 5b93a9c
commit ac91863
Show file tree

Hide file tree

Showing 13 changed files with 40 additions and 40 deletions.
diff --git a/abi/IEthBlocklistErc20Vault.json b/abi/IEthBlocklistErc20Vault.json
@@ -712,17 +712,17 @@
     "outputs": [
       {
         "internalType": "uint256",
-        "name": "leftShares",
+        "name": "leftTickets",
         "type": "uint256"
       },
       {
         "internalType": "uint256",
-        "name": "claimedShares",
+        "name": "exitedTickets",
         "type": "uint256"
       },
       {
         "internalType": "uint256",
-        "name": "claimedAssets",
+        "name": "exitedAssets",
         "type": "uint256"
       }
     ],

diff --git a/abi/IEthBlocklistVault.json b/abi/IEthBlocklistVault.json
@@ -582,17 +582,17 @@
     "outputs": [
       {
         "internalType": "uint256",
-        "name": "leftShares",
+        "name": "leftTickets",
         "type": "uint256"
       },
       {
         "internalType": "uint256",
-        "name": "claimedShares",
+        "name": "exitedTickets",
         "type": "uint256"
       },
       {
         "internalType": "uint256",
-        "name": "claimedAssets",
+        "name": "exitedAssets",
         "type": "uint256"
       }
     ],

diff --git a/abi/IEthErc20Vault.json b/abi/IEthErc20Vault.json
@@ -636,17 +636,17 @@
     "outputs": [
       {
         "internalType": "uint256",
-        "name": "leftShares",
+        "name": "leftTickets",
         "type": "uint256"
       },
       {
         "internalType": "uint256",
-        "name": "claimedShares",
+        "name": "exitedTickets",
         "type": "uint256"
       },
       {
         "internalType": "uint256",
-        "name": "claimedAssets",
+        "name": "exitedAssets",
         "type": "uint256"
       }
     ],

diff --git a/abi/IEthFoxVault.json b/abi/IEthFoxVault.json
@@ -471,17 +471,17 @@
     "outputs": [
       {
         "internalType": "uint256",
-        "name": "leftShares",
+        "name": "leftTickets",
         "type": "uint256"
       },
       {
         "internalType": "uint256",
-        "name": "claimedShares",
+        "name": "exitedTickets",
         "type": "uint256"
       },
       {
         "internalType": "uint256",
-        "name": "claimedAssets",
+        "name": "exitedAssets",
         "type": "uint256"
       }
     ],

diff --git a/abi/IEthGenesisVault.json b/abi/IEthGenesisVault.json
@@ -569,17 +569,17 @@
     "outputs": [
       {
         "internalType": "uint256",
-        "name": "leftShares",
+        "name": "leftTickets",
         "type": "uint256"
       },
       {
         "internalType": "uint256",
-        "name": "claimedShares",
+        "name": "exitedTickets",
         "type": "uint256"
       },
       {
         "internalType": "uint256",
-        "name": "claimedAssets",
+        "name": "exitedAssets",
         "type": "uint256"
       }
     ],

diff --git a/abi/IEthPrivErc20Vault.json b/abi/IEthPrivErc20Vault.json
@@ -680,17 +680,17 @@
     "outputs": [
       {
         "internalType": "uint256",
-        "name": "leftShares",
+        "name": "leftTickets",
         "type": "uint256"
       },
       {
         "internalType": "uint256",
-        "name": "claimedShares",
+        "name": "exitedTickets",
         "type": "uint256"
       },
       {
         "internalType": "uint256",
-        "name": "claimedAssets",
+        "name": "exitedAssets",
         "type": "uint256"
       }
     ],

diff --git a/abi/IEthPrivVault.json b/abi/IEthPrivVault.json
@@ -550,17 +550,17 @@
     "outputs": [
       {
         "internalType": "uint256",
-        "name": "leftShares",
+        "name": "leftTickets",
         "type": "uint256"
       },
       {
         "internalType": "uint256",
-        "name": "claimedShares",
+        "name": "exitedTickets",
         "type": "uint256"
       },
       {
         "internalType": "uint256",
-        "name": "claimedAssets",
+        "name": "exitedAssets",
         "type": "uint256"
       }
     ],

diff --git a/abi/IEthVault.json b/abi/IEthVault.json
@@ -506,17 +506,17 @@
     "outputs": [
       {
         "internalType": "uint256",
-        "name": "leftShares",
+        "name": "leftTickets",
         "type": "uint256"
       },
       {
         "internalType": "uint256",
-        "name": "claimedShares",
+        "name": "exitedTickets",
         "type": "uint256"
       },
       {
         "internalType": "uint256",
-        "name": "claimedAssets",
+        "name": "exitedAssets",
         "type": "uint256"
       }
     ],

diff --git a/abi/IVaultEnterExit.json b/abi/IVaultEnterExit.json
@@ -288,17 +288,17 @@
     "outputs": [
       {
         "internalType": "uint256",
-        "name": "leftShares",
+        "name": "leftTickets",
         "type": "uint256"
       },
       {
         "internalType": "uint256",
-        "name": "claimedShares",
+        "name": "exitedTickets",
         "type": "uint256"
       },
       {
         "internalType": "uint256",
-        "name": "claimedAssets",
+        "name": "exitedAssets",
         "type": "uint256"
       }
     ],

diff --git a/abi/IVaultEthStaking.json b/abi/IVaultEthStaking.json
@@ -339,17 +339,17 @@
     "outputs": [
       {
         "internalType": "uint256",
-        "name": "leftShares",
+        "name": "leftTickets",
         "type": "uint256"
       },
       {
         "internalType": "uint256",
-        "name": "claimedShares",
+        "name": "exitedTickets",
         "type": "uint256"
       },
       {
         "internalType": "uint256",
-        "name": "claimedAssets",
+        "name": "exitedAssets",
         "type": "uint256"
       }
     ],

diff --git a/abi/IVaultOsToken.json b/abi/IVaultOsToken.json
@@ -455,17 +455,17 @@
     "outputs": [
       {
         "internalType": "uint256",
-        "name": "leftShares",
+        "name": "leftTickets",
         "type": "uint256"
       },
       {
         "internalType": "uint256",
-        "name": "claimedShares",
+        "name": "exitedTickets",
         "type": "uint256"
       },
       {
         "internalType": "uint256",
-        "name": "claimedAssets",
+        "name": "exitedAssets",
         "type": "uint256"
       }
     ],

diff --git a/abi/IVaultToken.json b/abi/IVaultToken.json
@@ -418,17 +418,17 @@
     "outputs": [
       {
         "internalType": "uint256",
-        "name": "leftShares",
+        "name": "leftTickets",
         "type": "uint256"
       },
       {
         "internalType": "uint256",
-        "name": "claimedShares",
+        "name": "exitedTickets",
         "type": "uint256"
       },
       {
         "internalType": "uint256",
-        "name": "claimedAssets",
+        "name": "exitedAssets",
         "type": "uint256"
       }
     ],

diff --git a/contracts/interfaces/IVaultEnterExit.sol b/contracts/interfaces/IVaultEnterExit.sol
@@ -104,16 +104,16 @@ interface IVaultEnterExit is IVaultState {
    * @param timestamp The timestamp when the assets entered the exit queue
    * @param exitQueueIndex The exit queue index at which the shares were burned.
    *        It can be looked up by calling `getExitQueueIndex`. Only relevant for V1 positions, otherwise pass 0.
-   * @return leftShares The number of shares that are still in the queue
-   * @return claimedShares The number of claimed shares
-   * @return claimedAssets The number of claimed assets
+   * @return leftTickets The number of tickets left in the queue
+   * @return exitedTickets The number of tickets that have already exited
+   * @return exitedAssets The number of assets that can be claimed
    */
   function calculateExitedAssets(
     address receiver,
     uint256 positionTicket,
     uint256 timestamp,
     uint256 exitQueueIndex
-  ) external view returns (uint256 leftShares, uint256 claimedShares, uint256 claimedAssets);
+  ) external view returns (uint256 leftTickets, uint256 exitedTickets, uint256 exitedAssets);
 
   /**
    * @notice Claims assets that were withdrawn by the Vault. It can be called only after the `enterExitQueue` call by the `receiver`.