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

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

@@ -16,11 +16,34 @@ export declare const getApyAfterValuesEstimation: (selectedMarket: MorphoBlueMar
     borrowRate: string;
     supplyRate: string;
 }>;
+/**
+*Get reallocatable liquidity and target borrow utilization for a given market
+*@param marketId - The unique key of the market
+*@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
+* @param totalSupply - The total amount supplied
+* @param targetBorrowUtilization - The target borrow utilization
+* @param reallocatableLiquidityAssets - The amount of liquidity that can be reallocated
+* @returns The amount of liquidity to allocate
+*/
 export declare const getLiquidityToAllocate: (amountToBorrow: string, totalBorrow: string, totalSupply: string, targetBorrowUtilization: string, reallocatableLiquidityAssets: string) => string;
+/**
+ * Get the vaults and withdrawals needed to reallocate liquidity for a given amount to borrow
+ * @param marketId - The unique key of the market
+ * @param amountToBorrow - The amount to borrow
+ * @param network - The network number
+ * @returns The vaults and withdrawals needed to reallocate liquidity
+ */
 export declare const getReallocation: (marketId: string, 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 and target borrow utilization for a given market
+*@param marketId - The unique key of the market
+*@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,16 @@ 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
+* @param totalSupply - The total amount supplied
+* @param targetBorrowUtilization - The target borrow utilization
+* @param reallocatableLiquidityAssets - The amount of liquidity that can be reallocated
+* @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,6 +212,13 @@ const getLiquidityToAllocate = (amountToBorrow, totalBorrow, totalSupply, target
     return liquidityToAllocate;
 };
 exports.getLiquidityToAllocate = getLiquidityToAllocate;
+/**
+ * Get the vaults and withdrawals needed to reallocate liquidity for a given amount to borrow
+ * @param marketId - The unique key of the market
+ * @param amountToBorrow - The amount to borrow
+ * @param network - The network number
+ * @returns The vaults and withdrawals needed to reallocate liquidity
+ */
 const getReallocation = (marketId, amountToBorrow, network = common_1.NetworkNumber.Eth) => __awaiter(void 0, void 0, void 0, function* () {
     var _b, _c, _d;
     const response = yield fetch(API_URL, {

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

@@ -16,11 +16,34 @@ export declare const getApyAfterValuesEstimation: (selectedMarket: MorphoBlueMar
     borrowRate: string;
     supplyRate: string;
 }>;
+/**
+*Get reallocatable liquidity and target borrow utilization for a given market
+*@param marketId - The unique key of the market
+*@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
+* @param totalSupply - The total amount supplied
+* @param targetBorrowUtilization - The target borrow utilization
+* @param reallocatableLiquidityAssets - The amount of liquidity that can be reallocated
+* @returns The amount of liquidity to allocate
+*/
 export declare const getLiquidityToAllocate: (amountToBorrow: string, totalBorrow: string, totalSupply: string, targetBorrowUtilization: string, reallocatableLiquidityAssets: string) => string;
+/**
+ * Get the vaults and withdrawals needed to reallocate liquidity for a given amount to borrow
+ * @param marketId - The unique key of the market
+ * @param amountToBorrow - The amount to borrow
+ * @param network - The network number
+ * @returns The vaults and withdrawals needed to reallocate liquidity
+ */
 export declare const getReallocation: (marketId: string, amountToBorrow: string, network?: NetworkNumber) => Promise<{
     vaults: string[];
     withdrawals: (string | string[])[][][];

package/esm/helpers/morphoBlueHelpers/index.js

@@ -155,6 +155,12 @@ const MARKET_QUERY = `
       }
     }
 `;
+/**
+*Get reallocatable liquidity and target borrow utilization for a given market
+*@param marketId - The unique key of the market
+*@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,16 @@ 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
+* @param totalSupply - The total amount supplied
+* @param targetBorrowUtilization - The target borrow utilization
+* @param reallocatableLiquidityAssets - The amount of liquidity that can be reallocated
+* @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,6 +200,13 @@ export const getLiquidityToAllocate = (amountToBorrow, totalBorrow, totalSupply,
     }
     return liquidityToAllocate;
 };
+/**
+ * Get the vaults and withdrawals needed to reallocate liquidity for a given amount to borrow
+ * @param marketId - The unique key of the market
+ * @param amountToBorrow - The amount to borrow
+ * @param network - The network number
+ * @returns The vaults and withdrawals needed to reallocate liquidity
+ */
 export const getReallocation = (marketId, amountToBorrow, network = NetworkNumber.Eth) => __awaiter(void 0, void 0, void 0, function* () {
     var _b, _c, _d;
     const response = yield fetch(API_URL, {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defisaver/positions-sdk",
-  "version": "0.0.183-dev-allocator-6",
+  "version": "0.0.183-dev-allocator-7",
   "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 and target borrow utilization for a given market
+*@param marketId - The unique key of the market
+*@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,16 @@ 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
+* @param totalSupply - The total amount supplied
+* @param targetBorrowUtilization - The target borrow utilization
+* @param reallocatableLiquidityAssets - The amount of liquidity that can be reallocated
+* @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,6 +225,13 @@ export const getLiquidityToAllocate = (amountToBorrow: string, totalBorrow: stri
   return liquidityToAllocate;
 };
 
+/**
+ * Get the vaults and withdrawals needed to reallocate liquidity for a given amount to borrow
+ * @param marketId - The unique key of the market
+ * @param amountToBorrow - The amount to borrow
+ * @param network - The network number
+ * @returns The vaults and withdrawals needed to reallocate liquidity
+ */
 export const getReallocation = async (marketId: string, amountToBorrow: string, network: NetworkNumber = NetworkNumber.Eth) => {
   const response = await fetch(API_URL, {
     method: 'POST',