@defisaver/positions-sdk 2.1.4 → 2.1.6-dev-debt-in-front

package/esm/liquityV2/index.d.ts

@@ -23,6 +23,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);

package/esm/types/curveUsd.d.ts

@@ -109,4 +109,6 @@ export interface CrvUSDUserData {
     userBands: UserBandData[];
     loanExists: boolean;
     borrowRate?: string;
+    collateralPrice: string;
+    collRatio: string;
 }

package/package.json

@@ -1,47 +1,47 @@
-{
-  "name": "@defisaver/positions-sdk",
-  "version": "2.1.4",
-  "description": "",
-  "main": "./cjs/index.js",
-  "module": "./esm/index.js",
-  "types": "./esm/index.d.ts",
-  "scripts": {
-    "build:esm": "rm -rf esm && tsc -p tsconfig.esm.json",
-    "build:cjs": "rm -rf cjs && tsc -p tsconfig.cjs.json",
-    "build": "npm run lint && npm run build:cjs && npm run build:esm",
-    "dev": "tsc -p tsconfig.json --watch",
-    "lint": "eslint src/ --fix",
-    "lint-check": "eslint src/",
-    "test": "mocha tests/*",
-    "test-single": "mocha ./tests/$npm_config_name.ts",
-    "test:debugger": "mocha --inspect-brk tests/*",
-    "version-bump": "git commit -am \"Version bump to $(npm version patch | cut -c 2-)\""
-  },
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
-  "dependencies": {
-    "@defisaver/tokens": "^1.7.1",
-    "@types/lodash": "^4.17.15",
-    "@types/memoizee": "^0.4.12",
-    "decimal.js": "^10.6.0",
-    "lodash": "^4.17.21",
-    "memoizee": "^0.4.17",
-    "viem": "^2.31.4"
-  },
-  "devDependencies": {
-    "@defisaver/eslint-config": "^1.0.1",
-    "@metamask/eth-json-rpc-middleware": "^15.0.1",
-    "@metamask/eth-json-rpc-provider": "^4.1.6",
-    "@types/chai": "^5.0.0",
-    "@types/mocha": "^10.0.9",
-    "chai": "^4.3.8",
-    "dotenv": "^16.3.1",
-    "eslint": "^8.49.0",
-    "eslint-plugin-import": "^2.31.0",
-    "mocha": "^10.2.0",
-    "nock": "^14.0.0",
-    "ts-node": "^10.9.2",
-    "typescript": "^5.2.2"
-  }
-}
+{
+  "name": "@defisaver/positions-sdk",
+  "version": "2.1.6-dev-debt-in-front",
+  "description": "",
+  "main": "./cjs/index.js",
+  "module": "./esm/index.js",
+  "types": "./esm/index.d.ts",
+  "scripts": {
+    "build:esm": "rm -rf esm && tsc -p tsconfig.esm.json",
+    "build:cjs": "rm -rf cjs && tsc -p tsconfig.cjs.json",
+    "build": "npm run lint && npm run build:cjs && npm run build:esm",
+    "dev": "tsc -p tsconfig.json --watch",
+    "lint": "eslint src/ --fix",
+    "lint-check": "eslint src/",
+    "test": "mocha tests/*",
+    "test-single": "mocha ./tests/$npm_config_name.ts",
+    "test:debugger": "mocha --inspect-brk tests/*",
+    "version-bump": "git commit -am \"Version bump to $(npm version patch | cut -c 2-)\""
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "@defisaver/tokens": "^1.7.5",
+    "@types/lodash": "^4.17.15",
+    "@types/memoizee": "^0.4.12",
+    "decimal.js": "^10.6.0",
+    "lodash": "^4.17.21",
+    "memoizee": "^0.4.17",
+    "viem": "^2.31.4"
+  },
+  "devDependencies": {
+    "@defisaver/eslint-config": "^1.0.1",
+    "@metamask/eth-json-rpc-middleware": "^15.0.1",
+    "@metamask/eth-json-rpc-provider": "^4.1.6",
+    "@types/chai": "^5.0.0",
+    "@types/mocha": "^10.0.9",
+    "chai": "^4.3.8",
+    "dotenv": "^16.3.1",
+    "eslint": "^8.49.0",
+    "eslint-plugin-import": "^2.31.0",
+    "mocha": "^10.2.0",
+    "nock": "^14.0.0",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.2.2"
+  }
+}