feat: helper function for calculating debt-in-front

liquity · Aug 28, 2024 · 99b8b00 · 99b8b00
1 parent 351a849
commit 99b8b00
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 0 deletions.
diff --git a/contracts/src/Interfaces/IMultiTroveGetter.sol b/contracts/src/Interfaces/IMultiTroveGetter.sol
@@ -18,8 +18,18 @@ interface IMultiTroveGetter {
         uint256 snapshotBoldDebt;
     }
 
+    struct DebtPerInterestRate {
+        uint256 interestRate;
+        uint256 debt;
+    }
+
     function getMultipleSortedTroves(uint256 _collIndex, int256 _startIdx, uint256 _count)
         external
         view
         returns (CombinedTroveData[] memory _troves);
+
+    function getDebtPerInterestRateAscending(uint256 _collIndex, uint256 _startId, uint256 _maxIterations)
+        external
+        view
+        returns (DebtPerInterestRate[] memory, uint256 currId);
 }
diff --git a/contracts/src/MultiTroveGetter.sol b/contracts/src/MultiTroveGetter.sol
@@ -4,6 +4,7 @@ pragma solidity 0.8.18;
 
 import "./Interfaces/ICollateralRegistry.sol";
 import "./Interfaces/IMultiTroveGetter.sol";
+import "./Types/BatchId.sol";
 
 /*  Helper contract for grabbing Trove data for the front end. Not part of the core Liquity system. */
 contract MultiTroveGetter is IMultiTroveGetter {
@@ -112,4 +113,28 @@ contract MultiTroveGetter is IMultiTroveGetter {
             currentTroveId = _sortedTroves.getPrev(currentTroveId);
         }
     }
+
+    function getDebtPerInterestRateAscending(uint256 _collIndex, uint256 _startId, uint256 _maxIterations)
+        external
+        view
+        returns (DebtPerInterestRate[] memory data, uint256 currId)
+    {
+        ITroveManager troveManager = collateralRegistry.getTroveManager(_collIndex);
+        require(address(troveManager) != address(0), "Invalid collateral index");
+
+        ISortedTroves sortedTroves = troveManager.sortedTroves();
+        assert(address(sortedTroves) != address(0));
+
+        data = new DebtPerInterestRate[](_maxIterations);
+        currId = _startId;
+
+        for (uint256 i = 0; i < _maxIterations; ++i) {
+            currId = sortedTroves.getPrev(currId);
+            if (currId == 0) break;
+
+            LatestTroveData memory trove = troveManager.getLatestTroveData(currId);
+            data[i].interestRate = trove.annualInterestRate;
+            data[i].debt = trove.entireDebt;
+        }
+    }
 }