@defisaver/positions-sdk 2.1.0 → 2.1.1-dev.0

package/.mocharc.json

@@ -1,4 +1,4 @@
-{
-    "require": "ts-node/register",
-    "extension": ["ts"]
-}
+{
+    "require": "ts-node/register",
+    "extension": ["ts"]
+}

package/.nvmrc

@@ -1 +1 @@
-v20.17.0
+v20.17.0

package/README.md

@@ -1,64 +1,64 @@
-# DeFi Saver Positions SDK
-
-Supported protocols: 
-- [Maker](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/maker)
-- [Spark](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/spark)
-- [CrvUSD](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/curveUsd)
-- [Aave V2](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/aaveV2)
-- [Aave V3](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/aaveV3)
-- [Compound V2](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/compoundV2)
-- [Compound V3](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/compoundV3)
-- [Liquity](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/liquity)
-
-## Setup
-Supported Node version is v10.
-
-- run `npm install` (first time)
-- run `npm run build`
-
-`build` command will generate contracts and build ejs and esm folders
-
-## How to use
-[All available imports](https://github.com/defisaver/defisaver-positions-sdk/blob/main/src/index.ts)
-
-This is a Compound V3 example, and every other protocol is similar
-```js
-import { compoundV3 } from '@defisaver/positions-sdk';
-
-
-// every protocol has market data and user data getters
-const {
-    getCompoundV3MarketsData,
-    getCompoundV3AccountData,
-} = compoundV3;
-
-const provider = 'Your RPC provider';
-
-const user = '0x123...';
-
-const { assetsData } = await getCompoundV3MarketsData(
-    provider, // rpc for the network you are using (note: can be tenderly or any other testnet rpc)
-    1, // network
-    selectedMarket, // market object like in /src/markets/compound/index.ts
-    provider, // this must be mainnet rpc - used for getting prices onchain and calculating apys
-);
-
-const userData = await getCompoundV3AccountData(
-    provider,
-    1, // network
-    userAddress, // EOA or DSProxy
-    '', // proxy address of the user, or just empty string if checking for EOA
-    {
-        selectedMarket, // market object as in /src/markets/compound/index.ts
-        assetsData,
-    }
-);
-```
-
-More examples found [here](https://github.com/defisaver/defisaver-positions-sdk/tree/main/tests)
-
-## Testing
-
-`npm run test` - Run all tests
-
-`npm run test-single --name=your_test_name` - Run single test for specified name e.g. for MyTest.js test name is MyTest
+# DeFi Saver Positions SDK
+
+Supported protocols: 
+- [Maker](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/maker)
+- [Spark](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/spark)
+- [CrvUSD](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/curveUsd)
+- [Aave V2](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/aaveV2)
+- [Aave V3](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/aaveV3)
+- [Compound V2](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/compoundV2)
+- [Compound V3](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/compoundV3)
+- [Liquity](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/liquity)
+
+## Setup
+Supported Node version is v10.
+
+- run `npm install` (first time)
+- run `npm run build`
+
+`build` command will generate contracts and build ejs and esm folders
+
+## How to use
+[All available imports](https://github.com/defisaver/defisaver-positions-sdk/blob/main/src/index.ts)
+
+This is a Compound V3 example, and every other protocol is similar
+```js
+import { compoundV3 } from '@defisaver/positions-sdk';
+
+
+// every protocol has market data and user data getters
+const {
+    getCompoundV3MarketsData,
+    getCompoundV3AccountData,
+} = compoundV3;
+
+const provider = 'Your RPC provider';
+
+const user = '0x123...';
+
+const { assetsData } = await getCompoundV3MarketsData(
+    provider, // rpc for the network you are using (note: can be tenderly or any other testnet rpc)
+    1, // network
+    selectedMarket, // market object like in /src/markets/compound/index.ts
+    provider, // this must be mainnet rpc - used for getting prices onchain and calculating apys
+);
+
+const userData = await getCompoundV3AccountData(
+    provider,
+    1, // network
+    userAddress, // EOA or DSProxy
+    '', // proxy address of the user, or just empty string if checking for EOA
+    {
+        selectedMarket, // market object as in /src/markets/compound/index.ts
+        assetsData,
+    }
+);
+```
+
+More examples found [here](https://github.com/defisaver/defisaver-positions-sdk/tree/main/tests)
+
+## Testing
+
+`npm run test` - Run all tests
+
+`npm run test-single --name=your_test_name` - Run single test for specified name e.g. for MyTest.js test name is MyTest

package/cjs/helpers/morphoBlueHelpers/index.js

@@ -128,73 +128,73 @@ const getApyAfterValuesEstimation = (selectedMarket, actions, provider, network)
 });
 exports.getApyAfterValuesEstimation = getApyAfterValuesEstimation;
 const API_URL = 'https://blue-api.morpho.org/graphql';
-const MARKET_QUERY = `
-  query MarketByUniqueKey($uniqueKey: String!, $chainId: Int!) {
-      marketByUniqueKey(uniqueKey: $uniqueKey, chainId: $chainId) {
-        reallocatableLiquidityAssets
-        targetBorrowUtilization
-        loanAsset {
-          address
-          decimals
-          priceUsd
-        }
-        state {
-          liquidityAssets
-          borrowAssets
-          supplyAssets
-        }
-        publicAllocatorSharedLiquidity {
-          assets
-          vault {
-            address
-            name
-          }
-          allocationMarket {
-            uniqueKey
-            loanAsset {
-              address
-            }
-            collateralAsset {
-              address
-            }
-            irmAddress
-            oracle {
-              address
-            }
-            lltv
-          }
-        }
-        loanAsset {
-          address
-        }
-        collateralAsset {
-          address
-        }
-        oracle {
-          address
-        }
-        irmAddress
-        lltv  
-      }
-    }
+const MARKET_QUERY = `
+  query MarketByUniqueKey($uniqueKey: String!, $chainId: Int!) {
+      marketByUniqueKey(uniqueKey: $uniqueKey, chainId: $chainId) {
+        reallocatableLiquidityAssets
+        targetBorrowUtilization
+        loanAsset {
+          address
+          decimals
+          priceUsd
+        }
+        state {
+          liquidityAssets
+          borrowAssets
+          supplyAssets
+        }
+        publicAllocatorSharedLiquidity {
+          assets
+          vault {
+            address
+            name
+          }
+          allocationMarket {
+            uniqueKey
+            loanAsset {
+              address
+            }
+            collateralAsset {
+              address
+            }
+            irmAddress
+            oracle {
+              address
+            }
+            lltv
+          }
+        }
+        loanAsset {
+          address
+        }
+        collateralAsset {
+          address
+        }
+        oracle {
+          address
+        }
+        irmAddress
+        lltv  
+      }
+    }
 `;
-const REWARDS_QUERY = `
-  query MarketByUniqueKey($uniqueKey: String!, $chainId: Int!) {
-      marketByUniqueKey(uniqueKey: $uniqueKey, chainId: $chainId) {
-      uniqueKey
-      state {
-        rewards {
-          amountPerSuppliedToken
-          supplyApr
-          amountPerBorrowedToken
-          borrowApr
-          asset {
-            address
-          }
-        }
-      }
-    }
-    }
+const REWARDS_QUERY = `
+  query MarketByUniqueKey($uniqueKey: String!, $chainId: Int!) {
+      marketByUniqueKey(uniqueKey: $uniqueKey, chainId: $chainId) {
+      uniqueKey
+      state {
+        rewards {
+          amountPerSuppliedToken
+          supplyApr
+          amountPerBorrowedToken
+          borrowApr
+          asset {
+            address
+          }
+        }
+      }
+    }
+    }
 `;
 /**
  * Get reallocatable liquidity to a given market and target borrow utilization

package/cjs/liquityV2/index.d.ts

@@ -15,6 +15,8 @@ export declare const getLiquityV2UserTroveIds: (provider: EthereumProvider, netw
     }[];
     nextFreeTroveIndex: string;
 }>;
+export declare const calculateDebtInFrontLiquityV2: (markets: Record<LiquityV2Versions, LiquityV2MarketData>, selectedMarket: LiquityV2Versions, allMarketsUnbackedDebts: Record<LiquityV2Versions, string>, interestRateDebtInFront: string) => string;
+export declare const getDebtInFrontForInterestRateIncludingNewDebtLiquityV2: (newDebt: string, markets: Record<LiquityV2Versions, LiquityV2MarketData>, selectedMarket: LiquityV2Versions, provider: Client, network: NetworkNumber, interestRate: string) => Promise<string>;
 export declare const getDebtInFrontForInterestRateLiquityV2: (markets: Record<LiquityV2Versions, LiquityV2MarketData>, selectedMarket: LiquityV2Versions, provider: EthereumProvider, network: NetworkNumber, isLegacy: boolean, interestRate: string, debtInFrontBeingMoved?: string) => Promise<string>;
 export declare const _getLiquityV2TroveData: (provider: Client, network: NetworkNumber, { selectedMarket, assetsData, troveId, allMarketsData, }: {
     selectedMarket: LiquityV2MarketInfo;

package/cjs/liquityV2/index.js

@@ -12,7 +12,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getLiquityV2ClaimableCollateral = exports.getLiquityV2TroveData = exports._getLiquityV2TroveData = exports.getDebtInFrontForInterestRateLiquityV2 = exports.getLiquityV2UserTroveIds = exports._getLiquityV2UserTroveIds = exports.getLiquityV2MarketData = exports._getLiquityV2MarketData = void 0;
+exports.getLiquityV2ClaimableCollateral = exports.getLiquityV2TroveData = exports._getLiquityV2TroveData = exports.getDebtInFrontForInterestRateLiquityV2 = exports.getDebtInFrontForInterestRateIncludingNewDebtLiquityV2 = exports.calculateDebtInFrontLiquityV2 = exports.getLiquityV2UserTroveIds = exports._getLiquityV2UserTroveIds = exports.getLiquityV2MarketData = exports._getLiquityV2MarketData = void 0;
 const decimal_js_1 = __importDefault(require("decimal.js"));
 const tokens_1 = require("@defisaver/tokens");
 const contracts_1 = require("../contracts");
@@ -201,11 +201,39 @@ const getAllMarketsUnbackedDebts = (markets, isLegacy, provider, network) => __a
     return Object.fromEntries(allMarketsUnbackedDebt);
 });
 const calculateDebtInFrontLiquityV2 = (markets, selectedMarket, allMarketsUnbackedDebts, interestRateDebtInFront) => {
+    // Sanity check to avoid division by 0. Very unlikely to ever happen.
+    const selectedMarketTotalBorrow = new decimal_js_1.default(markets[selectedMarket].assetsData[(0, markets_1.LiquityV2Markets)(common_1.NetworkNumber.Eth)[selectedMarket].debtToken].totalBorrow);
+    if (selectedMarketTotalBorrow.eq(0))
+        return new decimal_js_1.default(0).toString();
     const selectedMarketUnbackedDebt = new decimal_js_1.default(allMarketsUnbackedDebts[selectedMarket]);
     const { isLegacy } = (0, markets_1.LiquityV2Markets)(common_1.NetworkNumber.Eth)[selectedMarket];
-    if (selectedMarketUnbackedDebt.eq(0))
-        return interestRateDebtInFront;
-    const amountBeingReedemedOnEachMarket = Object.entries(markets).map(([version, market]) => {
+    const totalUnbackedDebt = Object.values(allMarketsUnbackedDebts).reduce((acc, val) => acc.plus(new decimal_js_1.default(val)), new decimal_js_1.default(0));
+    // When totalUnbackedDebt is 0, redemptions will be proportional with the branch size and not to unbacked debt.
+    // When unbacked debt is 0 for branch, next redemption call won't touch that branch, so in order to estimate total debt in front we will:
+    // - First add up all the unbacked debt from other branches, as that will be the only debt that will be redeemed on the fist redemption call
+    // - Perform split the same way as we would do when totalUnbackedDebt == 0, this would represent the second call to the redemption function
+    if (selectedMarketUnbackedDebt.eq(0)) {
+        // Special case if the branch debt in front is 0, it means that all debt in front is unbacked debt from other branches.
+        if (new decimal_js_1.default(interestRateDebtInFront).eq(0))
+            return totalUnbackedDebt.toString();
+        // Then calculate how much of that estimated amount would go to each branch
+        // Second redemption call - calculate proportional redemption based on updated total debt
+        const amountBeingRedeemedOnEachMarketByTotalBorrow = Object.entries(markets).map(([version, market]) => {
+            const { isLegacy: isLegacyMarket } = (0, markets_1.LiquityV2Markets)(common_1.NetworkNumber.Eth)[version];
+            if (version === selectedMarket && isLegacyMarket !== isLegacy)
+                return new decimal_js_1.default(interestRateDebtInFront);
+            const { assetsData } = market;
+            const { debtToken } = (0, markets_1.LiquityV2Markets)(common_1.NetworkNumber.Eth)[version];
+            // For other markets, subtract their unbacked debt as it will be cleared in first redemption call
+            const marketUnbackedDebt = new decimal_js_1.default(allMarketsUnbackedDebts[version]);
+            const totalBorrow = new decimal_js_1.default(assetsData[debtToken].totalBorrow).sub(marketUnbackedDebt);
+            const amountToRedeem = new decimal_js_1.default(interestRateDebtInFront).mul(totalBorrow).div(selectedMarketTotalBorrow);
+            return decimal_js_1.default.min(amountToRedeem, totalBorrow);
+        });
+        const redemptionAmount = amountBeingRedeemedOnEachMarketByTotalBorrow.reduce((acc, val) => acc.plus(val), new decimal_js_1.default(0));
+        return totalUnbackedDebt.plus(redemptionAmount).toString();
+    }
+    const amountBeingRedeemedOnEachMarketByUnbackedDebt = Object.entries(markets).map(([version, market]) => {
         const { isLegacy: isLegacyMarket } = (0, markets_1.LiquityV2Markets)(common_1.NetworkNumber.Eth)[version];
         if (version === selectedMarket && isLegacyMarket !== isLegacy)
             return new decimal_js_1.default(interestRateDebtInFront);
@@ -213,16 +241,31 @@ const calculateDebtInFrontLiquityV2 = (markets, selectedMarket, allMarketsUnback
         const { debtToken } = (0, markets_1.LiquityV2Markets)(common_1.NetworkNumber.Eth)[version];
         const unbackedDebt = new decimal_js_1.default(allMarketsUnbackedDebts[version]);
         const totalBorrow = new decimal_js_1.default(assetsData[debtToken].totalBorrow);
-        const amountToReedem = new decimal_js_1.default(interestRateDebtInFront).mul(unbackedDebt).div(selectedMarketUnbackedDebt);
-        return decimal_js_1.default.min(amountToReedem, totalBorrow);
+        const amountToRedeem = new decimal_js_1.default(interestRateDebtInFront).mul(unbackedDebt).div(selectedMarketUnbackedDebt);
+        return decimal_js_1.default.min(amountToRedeem, totalBorrow);
     });
-    return amountBeingReedemedOnEachMarket.reduce((acc, val) => acc.plus(val), new decimal_js_1.default(0)).toString();
+    return amountBeingRedeemedOnEachMarketByUnbackedDebt.reduce((acc, val) => acc.plus(val), new decimal_js_1.default(0)).toString();
 };
+exports.calculateDebtInFrontLiquityV2 = calculateDebtInFrontLiquityV2;
+// @dev The amount redeemed on each branch depends on the unbacked debt of every branch (the difference between total borrow and stability pool deposits).
+// When new debt is generated on the selected market, the unbacked debt will increase, resulting in a higher redemption amount on that branch.
+// This function accepts the new debt that's about to be generated (e.g., trove creation) and estimates the debt in front based on the new state.
+const getDebtInFrontForInterestRateIncludingNewDebtLiquityV2 = (newDebt, markets, selectedMarket, provider, network, interestRate) => __awaiter(void 0, void 0, void 0, function* () {
+    const marketsWithNewDebt = structuredClone(markets);
+    const selectedMarketDebtToken = (0, markets_1.LiquityV2Markets)(network)[selectedMarket].debtToken;
+    const currentTotalBorrow = new decimal_js_1.default(marketsWithNewDebt[selectedMarket].assetsData[selectedMarketDebtToken].totalBorrow);
+    marketsWithNewDebt[selectedMarket].assetsData[selectedMarketDebtToken].totalBorrow = currentTotalBorrow.add(newDebt).toString();
+    const { isLegacy } = (0, markets_1.LiquityV2Markets)(common_1.NetworkNumber.Eth)[selectedMarket];
+    const allMarketsUnbackedDebts = yield getAllMarketsUnbackedDebts(marketsWithNewDebt, isLegacy, provider, network);
+    const interestRateDebtInFront = new decimal_js_1.default(yield getDebtInFrontForInterestRateSingleMarketLiquityV2(provider, network, isLegacy, (0, markets_1.LiquityV2Markets)(network)[selectedMarket].marketAddress, interestRate));
+    return (0, exports.calculateDebtInFrontLiquityV2)(marketsWithNewDebt, selectedMarket, allMarketsUnbackedDebts, interestRateDebtInFront.toString());
+});
+exports.getDebtInFrontForInterestRateIncludingNewDebtLiquityV2 = getDebtInFrontForInterestRateIncludingNewDebtLiquityV2;
 const getDebtInFrontLiquityV2 = (markets, selectedMarket, provider, network, viewContract, troveId) => __awaiter(void 0, void 0, void 0, function* () {
     const { isLegacy } = (0, markets_1.LiquityV2Markets)(common_1.NetworkNumber.Eth)[selectedMarket];
     const allMarketsUnbackedDebts = yield getAllMarketsUnbackedDebts(markets, isLegacy, provider, network);
     const interestRateDebtInFront = yield getDebtInFrontForSingleMarketLiquityV2(provider, network, isLegacy, (0, markets_1.LiquityV2Markets)(network)[selectedMarket].marketAddress, troveId);
-    return calculateDebtInFrontLiquityV2(markets, selectedMarket, allMarketsUnbackedDebts, interestRateDebtInFront.toString());
+    return (0, exports.calculateDebtInFrontLiquityV2)(markets, selectedMarket, allMarketsUnbackedDebts, interestRateDebtInFront.toString());
 });
 /**
  * @param markets
@@ -237,7 +280,7 @@ const _getDebtInFrontForInterestRateLiquityV2 = (markets_2, selectedMarket_1, pr
     const allMarketsUnbackedDebts = yield getAllMarketsUnbackedDebts(markets, isLegacy, provider, network);
     const interestRateDebtInFront = new decimal_js_1.default(yield getDebtInFrontForInterestRateSingleMarketLiquityV2(provider, network, isLegacy, (0, markets_1.LiquityV2Markets)(network)[selectedMarket].marketAddress, interestRate))
         .sub(debtInFrontBeingMoved);
-    return calculateDebtInFrontLiquityV2(markets, selectedMarket, allMarketsUnbackedDebts, interestRateDebtInFront.toString());
+    return (0, exports.calculateDebtInFrontLiquityV2)(markets, selectedMarket, allMarketsUnbackedDebts, interestRateDebtInFront.toString());
 });
 const getDebtInFrontForInterestRateLiquityV2 = (markets_2, selectedMarket_1, provider_1, network_1, isLegacy_1, interestRate_1, ...args_1) => __awaiter(void 0, [markets_2, selectedMarket_1, provider_1, network_1, isLegacy_1, interestRate_1, ...args_1], void 0, function* (markets, selectedMarket, provider, network, isLegacy, interestRate, debtInFrontBeingMoved = '0') { return _getDebtInFrontForInterestRateLiquityV2(markets, selectedMarket, (0, viem_1.getViemProvider)(provider, network), network, isLegacy, interestRate, debtInFrontBeingMoved); });
 exports.getDebtInFrontForInterestRateLiquityV2 = getDebtInFrontForInterestRateLiquityV2;

package/esm/helpers/morphoBlueHelpers/index.js

@@ -118,73 +118,73 @@ export const getApyAfterValuesEstimation = (selectedMarket, actions, provider, n
     return { borrowRate, supplyRate };
 });
 const API_URL = 'https://blue-api.morpho.org/graphql';
-const MARKET_QUERY = `
-  query MarketByUniqueKey($uniqueKey: String!, $chainId: Int!) {
-      marketByUniqueKey(uniqueKey: $uniqueKey, chainId: $chainId) {
-        reallocatableLiquidityAssets
-        targetBorrowUtilization
-        loanAsset {
-          address
-          decimals
-          priceUsd
-        }
-        state {
-          liquidityAssets
-          borrowAssets
-          supplyAssets
-        }
-        publicAllocatorSharedLiquidity {
-          assets
-          vault {
-            address
-            name
-          }
-          allocationMarket {
-            uniqueKey
-            loanAsset {
-              address
-            }
-            collateralAsset {
-              address
-            }
-            irmAddress
-            oracle {
-              address
-            }
-            lltv
-          }
-        }
-        loanAsset {
-          address
-        }
-        collateralAsset {
-          address
-        }
-        oracle {
-          address
-        }
-        irmAddress
-        lltv  
-      }
-    }
+const MARKET_QUERY = `
+  query MarketByUniqueKey($uniqueKey: String!, $chainId: Int!) {
+      marketByUniqueKey(uniqueKey: $uniqueKey, chainId: $chainId) {
+        reallocatableLiquidityAssets
+        targetBorrowUtilization
+        loanAsset {
+          address
+          decimals
+          priceUsd
+        }
+        state {
+          liquidityAssets
+          borrowAssets
+          supplyAssets
+        }
+        publicAllocatorSharedLiquidity {
+          assets
+          vault {
+            address
+            name
+          }
+          allocationMarket {
+            uniqueKey
+            loanAsset {
+              address
+            }
+            collateralAsset {
+              address
+            }
+            irmAddress
+            oracle {
+              address
+            }
+            lltv
+          }
+        }
+        loanAsset {
+          address
+        }
+        collateralAsset {
+          address
+        }
+        oracle {
+          address
+        }
+        irmAddress
+        lltv  
+      }
+    }
 `;
-const REWARDS_QUERY = `
-  query MarketByUniqueKey($uniqueKey: String!, $chainId: Int!) {
-      marketByUniqueKey(uniqueKey: $uniqueKey, chainId: $chainId) {
-      uniqueKey
-      state {
-        rewards {
-          amountPerSuppliedToken
-          supplyApr
-          amountPerBorrowedToken
-          borrowApr
-          asset {
-            address
-          }
-        }
-      }
-    }
-    }
+const REWARDS_QUERY = `
+  query MarketByUniqueKey($uniqueKey: String!, $chainId: Int!) {
+      marketByUniqueKey(uniqueKey: $uniqueKey, chainId: $chainId) {
+      uniqueKey
+      state {
+        rewards {
+          amountPerSuppliedToken
+          supplyApr
+          amountPerBorrowedToken
+          borrowApr
+          asset {
+            address
+          }
+        }
+      }
+    }
+    }
 `;
 /**
  * Get reallocatable liquidity to a given market and target borrow utilization

package/esm/liquityV2/index.d.ts

@@ -15,6 +15,8 @@ export declare const getLiquityV2UserTroveIds: (provider: EthereumProvider, netw
     }[];
     nextFreeTroveIndex: string;
 }>;
+export declare const calculateDebtInFrontLiquityV2: (markets: Record<LiquityV2Versions, LiquityV2MarketData>, selectedMarket: LiquityV2Versions, allMarketsUnbackedDebts: Record<LiquityV2Versions, string>, interestRateDebtInFront: string) => string;
+export declare const getDebtInFrontForInterestRateIncludingNewDebtLiquityV2: (newDebt: string, markets: Record<LiquityV2Versions, LiquityV2MarketData>, selectedMarket: LiquityV2Versions, provider: Client, network: NetworkNumber, interestRate: string) => Promise<string>;
 export declare const getDebtInFrontForInterestRateLiquityV2: (markets: Record<LiquityV2Versions, LiquityV2MarketData>, selectedMarket: LiquityV2Versions, provider: EthereumProvider, network: NetworkNumber, isLegacy: boolean, interestRate: string, debtInFrontBeingMoved?: string) => Promise<string>;
 export declare const _getLiquityV2TroveData: (provider: Client, network: NetworkNumber, { selectedMarket, assetsData, troveId, allMarketsData, }: {
     selectedMarket: LiquityV2MarketInfo;

package/esm/liquityV2/index.js

@@ -190,12 +190,40 @@ const getAllMarketsUnbackedDebts = (markets, isLegacy, provider, network) => __a
     })));
     return Object.fromEntries(allMarketsUnbackedDebt);
 });
-const calculateDebtInFrontLiquityV2 = (markets, selectedMarket, allMarketsUnbackedDebts, interestRateDebtInFront) => {
+export const calculateDebtInFrontLiquityV2 = (markets, selectedMarket, allMarketsUnbackedDebts, interestRateDebtInFront) => {
+    // Sanity check to avoid division by 0. Very unlikely to ever happen.
+    const selectedMarketTotalBorrow = new Dec(markets[selectedMarket].assetsData[LiquityV2Markets(NetworkNumber.Eth)[selectedMarket].debtToken].totalBorrow);
+    if (selectedMarketTotalBorrow.eq(0))
+        return new Dec(0).toString();
     const selectedMarketUnbackedDebt = new Dec(allMarketsUnbackedDebts[selectedMarket]);
     const { isLegacy } = LiquityV2Markets(NetworkNumber.Eth)[selectedMarket];
-    if (selectedMarketUnbackedDebt.eq(0))
-        return interestRateDebtInFront;
-    const amountBeingReedemedOnEachMarket = Object.entries(markets).map(([version, market]) => {
+    const totalUnbackedDebt = Object.values(allMarketsUnbackedDebts).reduce((acc, val) => acc.plus(new Dec(val)), new Dec(0));
+    // When totalUnbackedDebt is 0, redemptions will be proportional with the branch size and not to unbacked debt.
+    // When unbacked debt is 0 for branch, next redemption call won't touch that branch, so in order to estimate total debt in front we will:
+    // - First add up all the unbacked debt from other branches, as that will be the only debt that will be redeemed on the fist redemption call
+    // - Perform split the same way as we would do when totalUnbackedDebt == 0, this would represent the second call to the redemption function
+    if (selectedMarketUnbackedDebt.eq(0)) {
+        // Special case if the branch debt in front is 0, it means that all debt in front is unbacked debt from other branches.
+        if (new Dec(interestRateDebtInFront).eq(0))
+            return totalUnbackedDebt.toString();
+        // Then calculate how much of that estimated amount would go to each branch
+        // Second redemption call - calculate proportional redemption based on updated total debt
+        const amountBeingRedeemedOnEachMarketByTotalBorrow = Object.entries(markets).map(([version, market]) => {
+            const { isLegacy: isLegacyMarket } = LiquityV2Markets(NetworkNumber.Eth)[version];
+            if (version === selectedMarket && isLegacyMarket !== isLegacy)
+                return new Dec(interestRateDebtInFront);
+            const { assetsData } = market;
+            const { debtToken } = LiquityV2Markets(NetworkNumber.Eth)[version];
+            // For other markets, subtract their unbacked debt as it will be cleared in first redemption call
+            const marketUnbackedDebt = new Dec(allMarketsUnbackedDebts[version]);
+            const totalBorrow = new Dec(assetsData[debtToken].totalBorrow).sub(marketUnbackedDebt);
+            const amountToRedeem = new Dec(interestRateDebtInFront).mul(totalBorrow).div(selectedMarketTotalBorrow);
+            return Dec.min(amountToRedeem, totalBorrow);
+        });
+        const redemptionAmount = amountBeingRedeemedOnEachMarketByTotalBorrow.reduce((acc, val) => acc.plus(val), new Dec(0));
+        return totalUnbackedDebt.plus(redemptionAmount).toString();
+    }
+    const amountBeingRedeemedOnEachMarketByUnbackedDebt = Object.entries(markets).map(([version, market]) => {
         const { isLegacy: isLegacyMarket } = LiquityV2Markets(NetworkNumber.Eth)[version];
         if (version === selectedMarket && isLegacyMarket !== isLegacy)
             return new Dec(interestRateDebtInFront);
@@ -203,11 +231,24 @@ const calculateDebtInFrontLiquityV2 = (markets, selectedMarket, allMarketsUnback
         const { debtToken } = LiquityV2Markets(NetworkNumber.Eth)[version];
         const unbackedDebt = new Dec(allMarketsUnbackedDebts[version]);
         const totalBorrow = new Dec(assetsData[debtToken].totalBorrow);
-        const amountToReedem = new Dec(interestRateDebtInFront).mul(unbackedDebt).div(selectedMarketUnbackedDebt);
-        return Dec.min(amountToReedem, totalBorrow);
+        const amountToRedeem = new Dec(interestRateDebtInFront).mul(unbackedDebt).div(selectedMarketUnbackedDebt);
+        return Dec.min(amountToRedeem, totalBorrow);
     });
-    return amountBeingReedemedOnEachMarket.reduce((acc, val) => acc.plus(val), new Dec(0)).toString();
+    return amountBeingRedeemedOnEachMarketByUnbackedDebt.reduce((acc, val) => acc.plus(val), new Dec(0)).toString();
 };
+// @dev The amount redeemed on each branch depends on the unbacked debt of every branch (the difference between total borrow and stability pool deposits).
+// When new debt is generated on the selected market, the unbacked debt will increase, resulting in a higher redemption amount on that branch.
+// This function accepts the new debt that's about to be generated (e.g., trove creation) and estimates the debt in front based on the new state.
+export const getDebtInFrontForInterestRateIncludingNewDebtLiquityV2 = (newDebt, markets, selectedMarket, provider, network, interestRate) => __awaiter(void 0, void 0, void 0, function* () {
+    const marketsWithNewDebt = structuredClone(markets);
+    const selectedMarketDebtToken = LiquityV2Markets(network)[selectedMarket].debtToken;
+    const currentTotalBorrow = new Dec(marketsWithNewDebt[selectedMarket].assetsData[selectedMarketDebtToken].totalBorrow);
+    marketsWithNewDebt[selectedMarket].assetsData[selectedMarketDebtToken].totalBorrow = currentTotalBorrow.add(newDebt).toString();
+    const { isLegacy } = LiquityV2Markets(NetworkNumber.Eth)[selectedMarket];
+    const allMarketsUnbackedDebts = yield getAllMarketsUnbackedDebts(marketsWithNewDebt, isLegacy, provider, network);
+    const interestRateDebtInFront = new Dec(yield getDebtInFrontForInterestRateSingleMarketLiquityV2(provider, network, isLegacy, LiquityV2Markets(network)[selectedMarket].marketAddress, interestRate));
+    return calculateDebtInFrontLiquityV2(marketsWithNewDebt, selectedMarket, allMarketsUnbackedDebts, interestRateDebtInFront.toString());
+});
 const getDebtInFrontLiquityV2 = (markets, selectedMarket, provider, network, viewContract, troveId) => __awaiter(void 0, void 0, void 0, function* () {
     const { isLegacy } = LiquityV2Markets(NetworkNumber.Eth)[selectedMarket];
     const allMarketsUnbackedDebts = yield getAllMarketsUnbackedDebts(markets, isLegacy, provider, network);