@morpho-org/blue-sdk 1.0.5 → 1.2.0

package/lib/market/Market.d.ts

@@ -1,8 +1,5 @@
-import { BigNumberish, Provider } from "ethers";
-import { ViewOverrides } from "ethers-types/dist/common";
-import { ChainId } from "../chain";
 import { RoundingDirection } from "../maths";
-import { MarketId } from "../types";
+import { BigIntish } from "../types";
 import { MarketConfig } from "./MarketConfig";
 export declare enum CapacityLimitReason {
     liquidity = "Liquidity",
@@ -25,28 +22,19 @@ export interface MaxPositionCapacities {
 }
 export interface InputMarket {
     config: MarketConfig;
-    totalSupplyAssets: BigNumberish;
-    totalBorrowAssets: BigNumberish;
-    totalSupplyShares: BigNumberish;
-    totalBorrowShares: BigNumberish;
-    lastUpdate: BigNumberish;
-    fee: BigNumberish;
-    price: BigNumberish;
-    rateAtTarget?: BigNumberish;
+    totalSupplyAssets: bigint;
+    totalBorrowAssets: bigint;
+    totalSupplyShares: bigint;
+    totalBorrowShares: bigint;
+    lastUpdate: bigint;
+    fee: bigint;
+    price: bigint;
+    rateAtTarget?: bigint;
 }
+/**
+ * Represents a lending market on Morpho Blue.
+ */
 export declare class Market implements InputMarket {
-    static fetchFromId(id: MarketId, runner: {
-        provider: Provider;
-    }, { chainId, overrides, }?: {
-        chainId?: ChainId;
-        overrides?: ViewOverrides;
-    }): Promise<Market>;
-    static fetchFromConfig(config: MarketConfig, runner: {
-        provider: Provider;
-    }, { chainId, overrides, }?: {
-        chainId?: ChainId;
-        overrides?: ViewOverrides;
-    }): Promise<Market>;
     /**
      * The market's config.
      */
@@ -85,72 +73,235 @@ export declare class Market implements InputMarket {
      */
     rateAtTarget?: bigint;
     constructor({ config, totalSupplyAssets, totalBorrowAssets, totalSupplyShares, totalBorrowShares, lastUpdate, fee, price, rateAtTarget, }: InputMarket);
-    get id(): MarketId;
+    /**
+     * The market's hex-encoded id, defined as the hash of the market params.
+     */
+    get id(): import("../types").MarketId;
+    /**
+     * Whether the market satisfies the canonical definition of an idle market (i.e. collateral token is the zero address).
+     */
     get isIdle(): boolean;
     /**
      * @warning Cannot be used to calculate the liquidity available inside a callback,
      * because the balance of Blue may be lower than the market's liquidity due to assets being transferred out prior to the callback.
      */
     get liquidity(): bigint;
+    /**
+     * The market's utilization rate (scaled by WAD).
+     */
     get utilization(): bigint;
+    /**
+     * The market's Annual Percentage Yield (APY) at the IRM's target utilization rate, if applicable (scaled by WAD).
+     */
     get apyAtTarget(): bigint | undefined;
+    /**
+     * Returns the rate at which interest accrued on average for suppliers of this market,
+     * since the last time the market was updated (scaled by WAD).
+     */
     get supplyRate(): bigint;
+    /**
+     * Returns the rate at which interest accrued on average for borrowers of this market,
+     * since the last time the market was updated (scaled by WAD).
+     */
     get borrowRate(): bigint;
+    /**
+     * The market's supply Annual Percentage Yield (APY) (scaled by WAD).
+     */
     get supplyApy(): bigint;
+    /**
+     * The market's borrow Annual Percentage Yield (APY) (scaled by WAD).
+     */
     get borrowApy(): bigint;
-    accrueInterest(timestamp: BigNumberish): Market;
-    getLiquidityToUtilization(utilization: BigNumberish): bigint;
-    getCollateralValue(collateral: BigNumberish): bigint;
-    getMaxBorrowAssets(collateral: BigNumberish): bigint;
+    /**
+     * Returns a new market derived from this market, whose interest has been accrued up to the given timestamp.
+     * @param timestamp The timestamp at which to accrue interest. Must be greater than or equal to `lastUpdate`.
+     */
+    accrueInterest(timestamp: BigIntish): Market;
+    supply(assets: bigint, shares: bigint, timestamp?: bigint): {
+        market: Market;
+        assets: bigint;
+        shares: bigint;
+    };
+    withdraw(assets: bigint, shares: bigint, timestamp?: bigint): {
+        market: Market;
+        assets: bigint;
+        shares: bigint;
+    };
+    borrow(assets: bigint, shares: bigint, timestamp?: bigint): {
+        market: Market;
+        assets: bigint;
+        shares: bigint;
+    };
+    repay(assets: bigint, shares: bigint, timestamp?: bigint): {
+        market: Market;
+        assets: bigint;
+        shares: bigint;
+    };
+    /**
+     * Converts a given amount of supply shares into supply loan assets.
+     * @param shares The amount of shares to convert.
+     * @param rounding The rounding direction to use (defaults to "Down").
+     */
+    toSupplyAssets(shares: bigint, rounding?: RoundingDirection): bigint;
+    /**
+     * Converts a given amount of supply loan assets into supply shares.
+     * @param shares The amount of assets to convert.
+     * @param rounding The rounding direction to use (defaults to "Up").
+     */
+    toSupplyShares(assets: bigint, rounding?: RoundingDirection): bigint;
+    /**
+     * Converts a given amount of borrow shares into borrow loan assets.
+     * @param shares The amount of shares to convert.
+     * @param rounding The rounding direction to use (defaults to "Up").
+     */
+    toBorrowAssets(shares: bigint, rounding?: RoundingDirection): bigint;
+    /**
+     * Converts a given amount of borrow loan assets into borrow shares.
+     * @param shares The amount of assets to convert.
+     * @param rounding The rounding direction to use (defaults to "Down").
+     */
+    toBorrowShares(assets: bigint, rounding?: RoundingDirection): bigint;
+    /**
+     * Returns the liquidity available to borrow until the market reach the given utilization rate.
+     * @param utilization The target utilization rate (scaled by WAD).
+     */
+    getSupplyLiquidityToUtilization(utilization: bigint): BigIntish;
+    /**
+     * Returns the liquidity available to borrow until the market reach the given utilization rate.
+     * @param utilization The target utilization rate (scaled by WAD).
+     */
+    getBorrowLiquidityToUtilization(utilization: bigint): bigint;
+    /**
+     * Returns the value of a given amount of collateral quoted in loan assets.
+     * @param collateral The amount of collateral to quote.
+     */
+    getCollateralValue(collateral: bigint): bigint;
+    /**
+     * Returns the maximum amount of loan assets that can be borrowed given a certain amount of collateral.
+     * @param collateral The amount of collateral to consider.
+     */
+    getMaxBorrowAssets(collateral: bigint): bigint;
+    /**
+     * Returns the maximum amount of loan assets that can be borrowed given a certain borrow position.
+     * @param position The borrow position to consider.
+     */
     getMaxBorrowableAssets(position: {
-        collateral: BigNumberish;
-        borrowShares: BigNumberish;
+        collateral: bigint;
+        borrowShares: bigint;
     }): bigint;
-    getLiquidationSeizedAssets(repaidShares: BigNumberish): bigint;
-    getLiquidationRepaidShares(seizedAssets: BigNumberish): bigint;
+    /**
+     * Returns the amount of collateral that would be seized in a liquidation given a certain amount of repaid shares.
+     * @param repaidShares The amount of shares hypothetically repaid.
+     */
+    getLiquidationSeizedAssets(repaidShares: bigint): bigint;
+    /**
+     * Returns the amount of borrow shares that would be repaid in a liquidation given a certain amount of seized collateral.
+     * @param seizedAssets The amount of collateral hypothetically seized.
+     */
+    getLiquidationRepaidShares(seizedAssets: bigint): bigint;
+    /**
+     * Returns the maximum amount of collateral that is worth being seized in a liquidation given a certain borrow position.
+     * @param position The borrow position to consider.
+     */
     getSeizableCollateral(position: {
-        collateral: BigNumberish;
-        borrowShares: BigNumberish;
+        collateral: bigint;
+        borrowShares: bigint;
     }): bigint;
+    /**
+     * Returns the amount of collateral that can be withdrawn given a certain borrow position.
+     * @param position The borrow position to consider.
+     */
     getWithdrawableCollateral(position: {
-        collateral: BigNumberish;
-        borrowShares: BigNumberish;
+        collateral: bigint;
+        borrowShares: bigint;
     }): bigint;
+    /**
+     * Returns whether a given borrow position is healthy.
+     * @param position The borrow position to check.
+     */
     isHealthy(position: {
-        collateral: BigNumberish;
-        borrowShares: BigNumberish;
+        collateral: bigint;
+        borrowShares: bigint;
     }): boolean;
+    /**
+     * Returns the liquidation price of a given borrow position.
+     * @param position The borrow position to consider.
+     */
     getLiquidationPrice(position: {
-        collateral: BigNumberish;
-        borrowShares: BigNumberish;
+        collateral: bigint;
+        borrowShares: bigint;
     }): bigint | null;
+    /**
+     * Returns the price deviation required for the given borrow position to be unhealthy (scaled by WAD).
+     * @param position The borrow position to consider.
+     */
     getPriceVariationToLiquidation(position: {
-        collateral: BigNumberish;
-        borrowShares: BigNumberish;
+        collateral: bigint;
+        borrowShares: bigint;
     }): bigint | null;
+    /**
+     * Returns the health factor of a given borrow position (scaled by WAD).
+     * @param position The borrow position to consider.
+     */
     getHealthFactor(position: {
-        collateral: BigNumberish;
-        borrowShares: BigNumberish;
+        collateral: bigint;
+        borrowShares: bigint;
     }): bigint | null;
+    /**
+     * Returns the loan-to-value ratio of a given borrow position (scaled by WAD).
+     * @param position The borrow position to consider.
+     */
     getLtv(position: {
-        collateral: BigNumberish;
-        borrowShares: BigNumberish;
+        collateral: bigint;
+        borrowShares: bigint;
     }): bigint | null;
+    /**
+     * Returns the usage ratio of the maximum borrow capacity given a certain borrow position (scaled by WAD).
+     * @param position The borrow position to consider.
+     */
     getBorrowCapacityUsage(position: {
-        collateral: BigNumberish;
-        borrowShares: BigNumberish;
+        collateral: bigint;
+        borrowShares: bigint;
     }): bigint | null;
-    toSupplyAssets(shares: BigNumberish, rounding?: RoundingDirection): bigint;
-    toSupplyShares(assets: BigNumberish, rounding?: RoundingDirection): bigint;
-    toBorrowAssets(shares: BigNumberish, rounding?: RoundingDirection): bigint;
-    toBorrowShares(assets: BigNumberish, rounding?: RoundingDirection): bigint;
-    getBorrowCapacityLimit(collateral: bigint): CapacityLimit;
+    /**
+     * Returns the maximum amount of loan assets that can be borrowed given a certain borrow position
+     * and the reason for the limit.
+     * @param position The borrow position to consider.
+     */
+    getBorrowCapacityLimit({ collateral, borrowShares, }: {
+        collateral: bigint;
+        borrowShares?: bigint;
+    }): CapacityLimit;
+    /**
+     * Returns the maximum amount of loan assets that can be repaid given a certain borrow position
+     * and a balance of loan assets, and the reason for the limit.
+     * @param position The borrow position to consider.
+     */
     getRepayCapacityLimit(borrowShares: bigint, loanTokenBalance: bigint): CapacityLimit;
-    getWithdrawCapacityLimit(supplyShares: bigint): CapacityLimit;
+    /**
+     * Returns the maximum amount of loan assets that can be withdrawn given a certain supply position
+     * and a balance of loan assets, and the reason for the limit.
+     * @param position The supply position to consider.
+     */
+    getWithdrawCapacityLimit({ supplyShares, }: {
+        supplyShares: bigint;
+    }): CapacityLimit;
+    /**
+     * Returns the maximum amount of collateral assets that can be withdrawn given a certain borrow position
+     * and the reason for the limit.
+     * @param position The borrow position to consider.
+     */
     getWithdrawCollateralCapacityLimit(position: {
         collateral: bigint;
         borrowShares: bigint;
     }): CapacityLimit;
+    /**
+     * Returns the maximum capacity for all interactions with Morpho Blue given a certain position
+     * and loan and collateral balances.
+     * @param position The position to consider.
+     * @param loanTokenBalance The balance of loan assets.
+     * @param collateralTokenBalance The balance of collateral assets.
+     */
     getMaxCapacities(position: {
         collateral: bigint;
         supplyShares: bigint;