Merge pull request #881 from rndquu/feat/view-redeem

feat: add getRedeemCollateralBalance() method
ubiquity · Jan 24, 2024 · ef7fec9 · ef7fec9
2 parents b8ed0c3 + 608289e
commit ef7fec9
Show file tree

Hide file tree

Showing 4 changed files with 71 additions and 3 deletions.
diff --git a/packages/contracts/src/dollar/facets/UbiquityPoolFacet.sol b/packages/contracts/src/dollar/facets/UbiquityPoolFacet.sol
@@ -69,6 +69,18 @@ contract UbiquityPoolFacet is IUbiquityPool, Modifiers {
         return LibUbiquityPool.getDollarPriceUsd();
     }
 
+    /// @inheritdoc IUbiquityPool
+    function getRedeemCollateralBalance(
+        address userAddress,
+        uint256 collateralIndex
+    ) external view returns (uint256) {
+        return
+            LibUbiquityPool.getRedeemCollateralBalance(
+                userAddress,
+                collateralIndex
+            );
+    }
+
     //====================
     // Public functions
     //====================

diff --git a/packages/contracts/src/dollar/interfaces/IUbiquityPool.sol b/packages/contracts/src/dollar/interfaces/IUbiquityPool.sol
@@ -67,6 +67,17 @@ interface IUbiquityPool {
      */
     function getDollarPriceUsd() external view returns (uint256 dollarPriceUsd);
 
+    /**
+     * @notice Returns user's balance available for redemption
+     * @param userAddress User address
+     * @param collateralIndex Collateral token index
+     * @return User's balance available for redemption
+     */
+    function getRedeemCollateralBalance(
+        address userAddress,
+        uint256 collateralIndex
+    ) external view returns (uint256);
+
     //====================
     // Public functions
     //====================

diff --git a/packages/contracts/src/dollar/libraries/LibUbiquityPool.sol b/packages/contracts/src/dollar/libraries/LibUbiquityPool.sol
@@ -310,6 +310,21 @@ library LibUbiquityPool {
             .div(1e18);
     }
 
+    /**
+     * @notice Returns user's balance available for redemption
+     * @param userAddress User address
+     * @param collateralIndex Collateral token index
+     * @return User's balance available for redemption
+     */
+    function getRedeemCollateralBalance(
+        address userAddress,
+        uint256 collateralIndex
+    ) internal view returns (uint256) {
+        UbiquityPoolStorage storage poolStorage = ubiquityPoolStorage();
+        return
+            poolStorage.redeemCollateralBalances[userAddress][collateralIndex];
+    }
+
     //====================
     // Public functions
     //====================
@@ -533,10 +548,9 @@ library LibUbiquityPool {
             // roundId
             int256 answer, // startedAt
             ,
-            uint256 updatedAt,
+            uint256 updatedAt, // answeredInRound
 
-        ) = // answeredInRound
-            priceFeed.latestRoundData();
+        ) = priceFeed.latestRoundData();
 
         // fetch number of decimals in chainlink feed
         uint256 priceFeedDecimals = priceFeed.decimals();

diff --git a/packages/contracts/test/diamond/facets/UbiquityPoolFacet.t.sol b/packages/contracts/test/diamond/facets/UbiquityPoolFacet.t.sol
@@ -268,6 +268,37 @@ contract UbiquityPoolFacetTest is DiamondTestSetup {
         assertEq(dollarPriceUsd, 1_000_000);
     }
 
+    function testGetRedeemCollateralBalance_ShouldReturnRedeemCollateralBalance()
+        public
+    {
+        vm.prank(admin);
+        ubiquityPoolFacet.setPriceThresholds(
+            1000000, // mint threshold
+            1000000 // redeem threshold
+        );
+
+        // user sends 100 collateral tokens and gets 99 Dollars (-1% mint fee)
+        vm.prank(user);
+        ubiquityPoolFacet.mintDollar(
+            0, // collateral index
+            100e18, // Dollar amount
+            99e18, // min amount of Dollars to mint
+            100e18 // max collateral to send
+        );
+
+        // user redeems 99 Dollars for 97.02 (accounts for 2% redemption fee) collateral tokens
+        vm.prank(user);
+        ubiquityPoolFacet.redeemDollar(
+            0, // collateral index
+            99e18, // Dollar amount
+            90e18 // min collateral out
+        );
+
+        uint256 redeemCollateralBalance = ubiquityPoolFacet
+            .getRedeemCollateralBalance(user, 0);
+        assertEq(redeemCollateralBalance, 97.02e18);
+    }
+
     //====================
     // Public functions
     //====================