@defisaver/positions-sdk 0.0.183-dev-allocator-6 → 0.0.183-dev-allocator-8

package/cjs/helpers/morphoBlueHelpers/index.d.ts

@@ -16,12 +16,40 @@ export declare const getApyAfterValuesEstimation: (selectedMarket: MorphoBlueMar
     borrowRate: string;
     supplyRate: string;
 }>;
+/**
+ * Get reallocatable liquidity to a given market and target borrow utilization
+ * @param marketId - Unique key of the market liquidity is reallocated to
+ * @param network - The network number
+ * @returns The reallocatable liquidity and target borrow utilization
+*/
 export declare const getReallocatableLiquidity: (marketId: string, network?: NetworkNumber) => Promise<{
     reallocatableLiquidity: string;
     targetBorrowUtilization: string;
 }>;
+/**
+ * Get liquidity to allocate for a given amount to borrow.
+ * First, the function will try to calculate the amount of liquidity to allocate to be able to
+ * hit the target utilization. If it is not possible to allocate enough liquidity to hit the
+ * target utilization, the function will allocate the amount of liquidity needed to be able to
+ * borrow the selected amount.
+ * @param amountToBorrow - The amount to borrow
+ * @param totalBorrow - The total amount borrowed from market
+ * @param totalSupply - The total amount supplied to market
+ * @param targetBorrowUtilization - The target borrow utilization of market
+ * @param reallocatableLiquidityAssets - The amount of liquidity that can be reallocated from other markets
+ * @returns The amount of liquidity to allocate
+*/
 export declare const getLiquidityToAllocate: (amountToBorrow: string, totalBorrow: string, totalSupply: string, targetBorrowUtilization: string, reallocatableLiquidityAssets: string) => string;
-export declare const getReallocation: (marketId: string, amountToBorrow: string, network?: NetworkNumber) => Promise<{
+/**
+ * Get the vaults and withdrawals needed to reallocate liquidity for a given amount to borrow.
+ * Amount to be reallocated is calculated in `getLiquidityToAllocate`
+ * @param market - The market data
+ * @param assetsData - The assets data
+ * @param amountToBorrow - Amount being borrowed (not the amount being reallocated)
+ * @param network - The network number
+ * @returns The vaults and withdrawals needed to reallocate liquidity
+ */
+export declare const getReallocation: (market: MorphoBlueMarketData, assetsData: MorphoBlueAssetsData, amountToBorrow: string, network?: NetworkNumber) => Promise<{
     vaults: string[];
     withdrawals: (string | string[])[][][];
 }>;

package/cjs/helpers/morphoBlueHelpers/index.js

@@ -165,6 +165,12 @@ const MARKET_QUERY = `
       }
     }
 `;
+/**
+ * Get reallocatable liquidity to a given market and target borrow utilization
+ * @param marketId - Unique key of the market liquidity is reallocated to
+ * @param network - The network number
+ * @returns The reallocatable liquidity and target borrow utilization
+*/
 const getReallocatableLiquidity = (marketId, network = common_1.NetworkNumber.Eth) => __awaiter(void 0, void 0, void 0, function* () {
     var _a;
     const response = yield fetch(API_URL, {
@@ -182,6 +188,19 @@ const getReallocatableLiquidity = (marketId, network = common_1.NetworkNumber.Et
     return { reallocatableLiquidity: marketData.reallocatableLiquidityAssets, targetBorrowUtilization: marketData.targetBorrowUtilization };
 });
 exports.getReallocatableLiquidity = getReallocatableLiquidity;
+/**
+ * Get liquidity to allocate for a given amount to borrow.
+ * First, the function will try to calculate the amount of liquidity to allocate to be able to
+ * hit the target utilization. If it is not possible to allocate enough liquidity to hit the
+ * target utilization, the function will allocate the amount of liquidity needed to be able to
+ * borrow the selected amount.
+ * @param amountToBorrow - The amount to borrow
+ * @param totalBorrow - The total amount borrowed from market
+ * @param totalSupply - The total amount supplied to market
+ * @param targetBorrowUtilization - The target borrow utilization of market
+ * @param reallocatableLiquidityAssets - The amount of liquidity that can be reallocated from other markets
+ * @returns The amount of liquidity to allocate
+*/
 const getLiquidityToAllocate = (amountToBorrow, totalBorrow, totalSupply, targetBorrowUtilization, reallocatableLiquidityAssets) => {
     const newTotalBorrowAssets = new decimal_js_1.default(totalBorrow).add(amountToBorrow).toString();
     const leftToBorrow = new decimal_js_1.default(totalSupply).sub(totalBorrow).toString();
@@ -196,8 +215,18 @@ const getLiquidityToAllocate = (amountToBorrow, totalBorrow, totalSupply, target
     return liquidityToAllocate;
 };
 exports.getLiquidityToAllocate = getLiquidityToAllocate;
-const getReallocation = (marketId, amountToBorrow, network = common_1.NetworkNumber.Eth) => __awaiter(void 0, void 0, void 0, function* () {
+/**
+ * Get the vaults and withdrawals needed to reallocate liquidity for a given amount to borrow.
+ * Amount to be reallocated is calculated in `getLiquidityToAllocate`
+ * @param market - The market data
+ * @param assetsData - The assets data
+ * @param amountToBorrow - Amount being borrowed (not the amount being reallocated)
+ * @param network - The network number
+ * @returns The vaults and withdrawals needed to reallocate liquidity
+ */
+const getReallocation = (market, assetsData, amountToBorrow, network = common_1.NetworkNumber.Eth) => __awaiter(void 0, void 0, void 0, function* () {
     var _b, _c, _d;
+    const { marketId, loanToken } = market;
     const response = yield fetch(API_URL, {
         method: 'POST',
         headers: { 'Content-Type': 'application/json' },
@@ -210,12 +239,16 @@ const getReallocation = (marketId, amountToBorrow, network = common_1.NetworkNum
     const marketData = (_b = data === null || data === void 0 ? void 0 : data.data) === null || _b === void 0 ? void 0 : _b.marketByUniqueKey;
     if (!marketData)
         throw new Error('Market data not found');
-    const newTotalBorrowAssets = new decimal_js_1.default(marketData.state.borrowAssets).add(amountToBorrow).toString();
-    const newUtil = new decimal_js_1.default(newTotalBorrowAssets).div(marketData.state.supplyAssets).toString();
+    const loanAssetInfo = (0, tokens_1.getAssetInfoByAddress)(loanToken, network);
+    const { totalBorrow, totalSupply } = assetsData[loanAssetInfo.symbol] || { totalBorrow: '0', totalSupply: '0' };
+    const totalBorrowWei = (0, tokens_1.assetAmountInWei)(totalBorrow, loanToken);
+    const totalSupplyWei = (0, tokens_1.assetAmountInWei)(totalSupply, loanToken);
+    const newTotalBorrowAssets = new decimal_js_1.default(totalBorrowWei).add(amountToBorrow).toString();
+    const newUtil = new decimal_js_1.default(newTotalBorrowAssets).div(totalSupplyWei).toString();
     const newUtilScaled = new decimal_js_1.default(newUtil).mul(1e18).toString();
     if (new decimal_js_1.default(newUtilScaled).lt(marketData.targetBorrowUtilization))
         return { vaults: [], withdrawals: [] };
-    const liquidityToAllocate = (0, exports.getLiquidityToAllocate)(amountToBorrow, marketData.state.borrowAssets, marketData.state.supplyAssets, marketData.targetBorrowUtilization, marketData.reallocatableLiquidityAssets);
+    const liquidityToAllocate = (0, exports.getLiquidityToAllocate)(amountToBorrow, totalBorrowWei, totalSupplyWei, marketData.targetBorrowUtilization, marketData.reallocatableLiquidityAssets);
     const vaultTotalAssets = marketData.publicAllocatorSharedLiquidity.reduce((acc, item) => {
         const vaultAddress = item.vault.address;
         acc[vaultAddress] = new decimal_js_1.default(acc[vaultAddress] || '0').add(item.assets).toString();

package/esm/helpers/morphoBlueHelpers/index.d.ts

@@ -16,12 +16,40 @@ export declare const getApyAfterValuesEstimation: (selectedMarket: MorphoBlueMar
     borrowRate: string;
     supplyRate: string;
 }>;
+/**
+ * Get reallocatable liquidity to a given market and target borrow utilization
+ * @param marketId - Unique key of the market liquidity is reallocated to
+ * @param network - The network number
+ * @returns The reallocatable liquidity and target borrow utilization
+*/
 export declare const getReallocatableLiquidity: (marketId: string, network?: NetworkNumber) => Promise<{
     reallocatableLiquidity: string;
     targetBorrowUtilization: string;
 }>;
+/**
+ * Get liquidity to allocate for a given amount to borrow.
+ * First, the function will try to calculate the amount of liquidity to allocate to be able to
+ * hit the target utilization. If it is not possible to allocate enough liquidity to hit the
+ * target utilization, the function will allocate the amount of liquidity needed to be able to
+ * borrow the selected amount.
+ * @param amountToBorrow - The amount to borrow
+ * @param totalBorrow - The total amount borrowed from market
+ * @param totalSupply - The total amount supplied to market
+ * @param targetBorrowUtilization - The target borrow utilization of market
+ * @param reallocatableLiquidityAssets - The amount of liquidity that can be reallocated from other markets
+ * @returns The amount of liquidity to allocate
+*/
 export declare const getLiquidityToAllocate: (amountToBorrow: string, totalBorrow: string, totalSupply: string, targetBorrowUtilization: string, reallocatableLiquidityAssets: string) => string;
-export declare const getReallocation: (marketId: string, amountToBorrow: string, network?: NetworkNumber) => Promise<{
+/**
+ * Get the vaults and withdrawals needed to reallocate liquidity for a given amount to borrow.
+ * Amount to be reallocated is calculated in `getLiquidityToAllocate`
+ * @param market - The market data
+ * @param assetsData - The assets data
+ * @param amountToBorrow - Amount being borrowed (not the amount being reallocated)
+ * @param network - The network number
+ * @returns The vaults and withdrawals needed to reallocate liquidity
+ */
+export declare const getReallocation: (market: MorphoBlueMarketData, assetsData: MorphoBlueAssetsData, amountToBorrow: string, network?: NetworkNumber) => Promise<{
     vaults: string[];
     withdrawals: (string | string[])[][][];
 }>;

package/esm/helpers/morphoBlueHelpers/index.js

@@ -8,7 +8,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import Dec from 'decimal.js';
-import { assetAmountInWei } from '@defisaver/tokens';
+import { assetAmountInWei, getAssetInfoByAddress } from '@defisaver/tokens';
 import { calcLeverageLiqPrice, getAssetsTotal, isLeveragedPos } from '../../moneymarket';
 import { calculateNetApy } from '../../staking';
 import { NetworkNumber } from '../../types/common';
@@ -155,6 +155,12 @@ const MARKET_QUERY = `
       }
     }
 `;
+/**
+ * Get reallocatable liquidity to a given market and target borrow utilization
+ * @param marketId - Unique key of the market liquidity is reallocated to
+ * @param network - The network number
+ * @returns The reallocatable liquidity and target borrow utilization
+*/
 export const getReallocatableLiquidity = (marketId, network = NetworkNumber.Eth) => __awaiter(void 0, void 0, void 0, function* () {
     var _a;
     const response = yield fetch(API_URL, {
@@ -171,6 +177,19 @@ export const getReallocatableLiquidity = (marketId, network = NetworkNumber.Eth)
         throw new Error('Market data not found');
     return { reallocatableLiquidity: marketData.reallocatableLiquidityAssets, targetBorrowUtilization: marketData.targetBorrowUtilization };
 });
+/**
+ * Get liquidity to allocate for a given amount to borrow.
+ * First, the function will try to calculate the amount of liquidity to allocate to be able to
+ * hit the target utilization. If it is not possible to allocate enough liquidity to hit the
+ * target utilization, the function will allocate the amount of liquidity needed to be able to
+ * borrow the selected amount.
+ * @param amountToBorrow - The amount to borrow
+ * @param totalBorrow - The total amount borrowed from market
+ * @param totalSupply - The total amount supplied to market
+ * @param targetBorrowUtilization - The target borrow utilization of market
+ * @param reallocatableLiquidityAssets - The amount of liquidity that can be reallocated from other markets
+ * @returns The amount of liquidity to allocate
+*/
 export const getLiquidityToAllocate = (amountToBorrow, totalBorrow, totalSupply, targetBorrowUtilization, reallocatableLiquidityAssets) => {
     const newTotalBorrowAssets = new Dec(totalBorrow).add(amountToBorrow).toString();
     const leftToBorrow = new Dec(totalSupply).sub(totalBorrow).toString();
@@ -184,8 +203,18 @@ export const getLiquidityToAllocate = (amountToBorrow, totalBorrow, totalSupply,
     }
     return liquidityToAllocate;
 };
-export const getReallocation = (marketId, amountToBorrow, network = NetworkNumber.Eth) => __awaiter(void 0, void 0, void 0, function* () {
+/**
+ * Get the vaults and withdrawals needed to reallocate liquidity for a given amount to borrow.
+ * Amount to be reallocated is calculated in `getLiquidityToAllocate`
+ * @param market - The market data
+ * @param assetsData - The assets data
+ * @param amountToBorrow - Amount being borrowed (not the amount being reallocated)
+ * @param network - The network number
+ * @returns The vaults and withdrawals needed to reallocate liquidity
+ */
+export const getReallocation = (market, assetsData, amountToBorrow, network = NetworkNumber.Eth) => __awaiter(void 0, void 0, void 0, function* () {
     var _b, _c, _d;
+    const { marketId, loanToken } = market;
     const response = yield fetch(API_URL, {
         method: 'POST',
         headers: { 'Content-Type': 'application/json' },
@@ -198,12 +227,16 @@ export const getReallocation = (marketId, amountToBorrow, network = NetworkNumbe
     const marketData = (_b = data === null || data === void 0 ? void 0 : data.data) === null || _b === void 0 ? void 0 : _b.marketByUniqueKey;
     if (!marketData)
         throw new Error('Market data not found');
-    const newTotalBorrowAssets = new Dec(marketData.state.borrowAssets).add(amountToBorrow).toString();
-    const newUtil = new Dec(newTotalBorrowAssets).div(marketData.state.supplyAssets).toString();
+    const loanAssetInfo = getAssetInfoByAddress(loanToken, network);
+    const { totalBorrow, totalSupply } = assetsData[loanAssetInfo.symbol] || { totalBorrow: '0', totalSupply: '0' };
+    const totalBorrowWei = assetAmountInWei(totalBorrow, loanToken);
+    const totalSupplyWei = assetAmountInWei(totalSupply, loanToken);
+    const newTotalBorrowAssets = new Dec(totalBorrowWei).add(amountToBorrow).toString();
+    const newUtil = new Dec(newTotalBorrowAssets).div(totalSupplyWei).toString();
     const newUtilScaled = new Dec(newUtil).mul(1e18).toString();
     if (new Dec(newUtilScaled).lt(marketData.targetBorrowUtilization))
         return { vaults: [], withdrawals: [] };
-    const liquidityToAllocate = getLiquidityToAllocate(amountToBorrow, marketData.state.borrowAssets, marketData.state.supplyAssets, marketData.targetBorrowUtilization, marketData.reallocatableLiquidityAssets);
+    const liquidityToAllocate = getLiquidityToAllocate(amountToBorrow, totalBorrowWei, totalSupplyWei, marketData.targetBorrowUtilization, marketData.reallocatableLiquidityAssets);
     const vaultTotalAssets = marketData.publicAllocatorSharedLiquidity.reduce((acc, item) => {
         const vaultAddress = item.vault.address;
         acc[vaultAddress] = new Dec(acc[vaultAddress] || '0').add(item.assets).toString();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defisaver/positions-sdk",
-  "version": "0.0.183-dev-allocator-6",
+  "version": "0.0.183-dev-allocator-8",
   "description": "",
   "main": "./cjs/index.js",
   "module": "./esm/index.js",

package/src/helpers/morphoBlueHelpers/index.ts

@@ -176,6 +176,12 @@ const MARKET_QUERY = `
     }
 `;
 
+/**
+ * Get reallocatable liquidity to a given market and target borrow utilization
+ * @param marketId - Unique key of the market liquidity is reallocated to
+ * @param network - The network number
+ * @returns The reallocatable liquidity and target borrow utilization
+*/
 export const getReallocatableLiquidity = async (marketId: string, network: NetworkNumber = NetworkNumber.Eth): Promise<{ reallocatableLiquidity: string, targetBorrowUtilization: string }> => {
   const response = await fetch(API_URL, {
     method: 'POST',
@@ -194,6 +200,19 @@ export const getReallocatableLiquidity = async (marketId: string, network: Netwo
   return { reallocatableLiquidity: marketData.reallocatableLiquidityAssets, targetBorrowUtilization: marketData.targetBorrowUtilization };
 };
 
+/**
+ * Get liquidity to allocate for a given amount to borrow.
+ * First, the function will try to calculate the amount of liquidity to allocate to be able to
+ * hit the target utilization. If it is not possible to allocate enough liquidity to hit the
+ * target utilization, the function will allocate the amount of liquidity needed to be able to
+ * borrow the selected amount.
+ * @param amountToBorrow - The amount to borrow
+ * @param totalBorrow - The total amount borrowed from market
+ * @param totalSupply - The total amount supplied to market
+ * @param targetBorrowUtilization - The target borrow utilization of market
+ * @param reallocatableLiquidityAssets - The amount of liquidity that can be reallocated from other markets
+ * @returns The amount of liquidity to allocate
+*/
 export const getLiquidityToAllocate = (amountToBorrow: string, totalBorrow: string, totalSupply: string, targetBorrowUtilization: string, reallocatableLiquidityAssets: string) => {
   const newTotalBorrowAssets = new Dec(totalBorrow).add(amountToBorrow).toString();
   const leftToBorrow = new Dec(totalSupply).sub(totalBorrow).toString();
@@ -209,7 +228,17 @@ export const getLiquidityToAllocate = (amountToBorrow: string, totalBorrow: stri
   return liquidityToAllocate;
 };
 
-export const getReallocation = async (marketId: string, amountToBorrow: string, network: NetworkNumber = NetworkNumber.Eth) => {
+/**
+ * Get the vaults and withdrawals needed to reallocate liquidity for a given amount to borrow.
+ * Amount to be reallocated is calculated in `getLiquidityToAllocate`
+ * @param market - The market data
+ * @param assetsData - The assets data
+ * @param amountToBorrow - Amount being borrowed (not the amount being reallocated)
+ * @param network - The network number
+ * @returns The vaults and withdrawals needed to reallocate liquidity
+ */
+export const getReallocation = async (market: MorphoBlueMarketData, assetsData: MorphoBlueAssetsData, amountToBorrow: string, network: NetworkNumber = NetworkNumber.Eth) => {
+  const { marketId, loanToken } = market;
   const response = await fetch(API_URL, {
     method: 'POST',
     headers: { 'Content-Type': 'application/json' },
@@ -224,14 +253,19 @@ export const getReallocation = async (marketId: string, amountToBorrow: string,
 
   if (!marketData) throw new Error('Market data not found');
 
-  const newTotalBorrowAssets = new Dec(marketData.state.borrowAssets).add(amountToBorrow).toString();
+  const loanAssetInfo = getAssetInfoByAddress(loanToken, network);
+  const { totalBorrow, totalSupply } = assetsData[loanAssetInfo.symbol] || { totalBorrow: '0', totalSupply: '0' };
+  const totalBorrowWei = assetAmountInWei(totalBorrow!, loanToken);
+  const totalSupplyWei = assetAmountInWei(totalSupply!, loanToken);
 
-  const newUtil = new Dec(newTotalBorrowAssets).div(marketData.state.supplyAssets).toString();
+  const newTotalBorrowAssets = new Dec(totalBorrowWei).add(amountToBorrow).toString();
+
+  const newUtil = new Dec(newTotalBorrowAssets).div(totalSupplyWei).toString();
   const newUtilScaled = new Dec(newUtil).mul(1e18).toString();
 
   if (new Dec(newUtilScaled).lt(marketData.targetBorrowUtilization)) return { vaults: [], withdrawals: [] };
 
-  const liquidityToAllocate = getLiquidityToAllocate(amountToBorrow, marketData.state.borrowAssets, marketData.state.supplyAssets, marketData.targetBorrowUtilization, marketData.reallocatableLiquidityAssets);
+  const liquidityToAllocate = getLiquidityToAllocate(amountToBorrow, totalBorrowWei, totalSupplyWei, marketData.targetBorrowUtilization, marketData.reallocatableLiquidityAssets);
 
   const vaultTotalAssets = marketData.publicAllocatorSharedLiquidity.reduce(
     (acc: Record<string, string>, item: MorphoBluePublicAllocatorItem) => {
@@ -288,4 +322,4 @@ export const getReallocation = async (marketId: string, amountToBorrow: string,
     vaults,
     withdrawals,
   };
-};
+};