@morpho-org/blue-sdk 2.0.0-next.8 → 2.0.0-next.9

package/README.md

@@ -23,7 +23,7 @@
 
 Framework-agnostic package that defines Morpho-related entity classes:
 
-- [**`MarketConfig`**](./src/market/MarketConfig.ts): represents the immutable configuration of a market on Morpho
+- [**`MarketParams`**](./src/market/MarketParams.ts): represents the immutable configuration of a market on Morpho
 - [**`Market`**](./src/market/Market.ts): represents the state of a market on Morpho
 - [**`Token`**](./src/token/Token.ts): represents a ERC20 token
 - [**`User`**](./src/user/User.ts): represents a user of Morpho
@@ -46,12 +46,12 @@ yarn add @morpho-org/blue-sdk
 
 ### Instance of the immutable configuration of a specific market
 
-Leverage the [`MarketConfig`](./src/market/MarketConfig.ts) class to manipulate a given market's immutable configuration:
+Leverage the [`MarketParams`](./src/market/MarketParams.ts) class to manipulate a given market's immutable configuration:
 
 ```typescript
-import { MarketConfig } from "@morpho-org/blue-sdk";
+import { MarketParams } from "@morpho-org/blue-sdk";
 
-const config = new MarketConfig({
+const config = new MarketParams({
   loanToken: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2", // WETH
   collateralToken: "0x7f39C581F595B53c5cb19bD0b3f8dA6c935E2Ca0", // wstETH
   oracle: "0x2a01EB9496094dA03c4E364Def50f5aD1280AD72",
@@ -67,11 +67,11 @@ config.liquidationIncentiveFactor; // e.g. 1_090000000000000000n (109%).
 Leverage the [`Market`](./src/market/Market.ts) class to manipulate a specific market:
 
 ```typescript
-import { Market } from "@morpho-org/blue-sdk";
+import { Market, MarketParams } from "@morpho-org/blue-sdk";
 import { Time } from "@morpho-org/morpho-ts";
 
 const market = new Market({
-  config: new MarketConfig({
+  config: new MarketParams({
     loanToken: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2", // WETH
     collateralToken: "0x7f39C581F595B53c5cb19bD0b3f8dA6c935E2Ca0", // wstETH
     oracle: "0x2a01EB9496094dA03c4E364Def50f5aD1280AD72",

package/lib/errors.d.ts

@@ -9,7 +9,7 @@ export declare class UnknownTokenPriceError extends UnknownDataError {
     readonly address: Address;
     constructor(address: Address);
 }
-export declare class UnknownMarketConfigError extends UnknownDataError {
+export declare class UnknownMarketParamsError extends UnknownDataError {
     readonly marketId: MarketId;
     constructor(marketId: MarketId);
 }

package/lib/errors.js

@@ -14,7 +14,7 @@ export class UnknownTokenPriceError extends UnknownDataError {
         this.address = address;
     }
 }
-export class UnknownMarketConfigError extends UnknownDataError {
+export class UnknownMarketParamsError extends UnknownDataError {
     marketId;
     constructor(marketId) {
         super(`unknown config for market ${marketId}`);

package/lib/market/Market.d.ts

@@ -1,6 +1,6 @@
 import { type RoundingDirection } from "../math/index.js";
 import type { BigIntish } from "../types.js";
-import type { MarketConfig } from "./MarketConfig.js";
+import type { MarketParams } from "./MarketParams.js";
 export declare enum CapacityLimitReason {
     liquidity = "Liquidity",
     balance = "Balance",
@@ -27,7 +27,7 @@ export interface MaxPositionCapacities {
     withdrawCollateral: CapacityLimit;
 }
 export interface InputMarket {
-    config: MarketConfig;
+    params: MarketParams;
     totalSupplyAssets: bigint;
     totalBorrowAssets: bigint;
     totalSupplyShares: bigint;
@@ -42,9 +42,9 @@ export interface InputMarket {
  */
 export declare class Market implements InputMarket {
     /**
-     * The market's config.
+     * The market's params.
      */
-    readonly config: MarketConfig;
+    readonly params: MarketParams;
     /**
      * The amount of loan assets supplied in total on the market.
      */
@@ -78,7 +78,7 @@ export declare class Market implements InputMarket {
      * Undefined otherwise.
      */
     rateAtTarget?: bigint;
-    constructor({ config, totalSupplyAssets, totalBorrowAssets, totalSupplyShares, totalBorrowShares, lastUpdate, fee, price, rateAtTarget, }: InputMarket);
+    constructor({ params, totalSupplyAssets, totalBorrowAssets, totalSupplyShares, totalBorrowShares, lastUpdate, fee, price, rateAtTarget, }: InputMarket);
     /**
      * The market's hex-encoded id, defined as the hash of the market params.
      */

package/lib/market/Market.js

@@ -15,9 +15,9 @@ export var CapacityLimitReason;
  */
 export class Market {
     /**
-     * The market's config.
+     * The market's params.
      */
-    config;
+    params;
     /**
      * The amount of loan assets supplied in total on the market.
      */
@@ -51,8 +51,8 @@ export class Market {
      * Undefined otherwise.
      */
     rateAtTarget;
-    constructor({ config, totalSupplyAssets, totalBorrowAssets, totalSupplyShares, totalBorrowShares, lastUpdate, fee, price, rateAtTarget, }) {
-        this.config = config;
+    constructor({ params, totalSupplyAssets, totalBorrowAssets, totalSupplyShares, totalBorrowShares, lastUpdate, fee, price, rateAtTarget, }) {
+        this.params = params;
         this.totalSupplyAssets = totalSupplyAssets;
         this.totalBorrowAssets = totalBorrowAssets;
         this.totalSupplyShares = totalSupplyShares;
@@ -67,13 +67,13 @@ export class Market {
      * The market's hex-encoded id, defined as the hash of the market params.
      */
     get id() {
-        return this.config.id;
+        return this.params.id;
     }
     /**
      * Whether the market satisfies the canonical definition of an idle market (i.e. collateral token is the zero address).
      */
     get isIdle() {
-        return this.config.collateralToken === ZERO_ADDRESS;
+        return this.params.collateralToken === ZERO_ADDRESS;
     }
     /**
      * @warning Cannot be used to calculate the liquidity available inside a callback,
@@ -276,9 +276,9 @@ export class Market {
      * To calculate the amount of loan assets that can be borrowed, use `getMaxBorrowableAssets`.
      * @param collateral The amount of collateral to consider.
      */
-    getMaxBorrowAssets(collateral, { maxLtv = this.config.lltv } = {}) {
+    getMaxBorrowAssets(collateral, { maxLtv = this.params.lltv } = {}) {
         return MarketUtils.getMaxBorrowAssets(collateral, this, {
-            lltv: MathLib.min(maxLtv, this.config.lltv),
+            lltv: MathLib.min(maxLtv, this.params.lltv),
         });
     }
     /**
@@ -286,36 +286,36 @@ export class Market {
      * @param position The borrow position to consider.
      */
     getMaxBorrowableAssets(position) {
-        return MarketUtils.getMaxBorrowableAssets(position, this, this.config);
+        return MarketUtils.getMaxBorrowableAssets(position, this, this.params);
     }
     /**
      * 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) {
-        return MarketUtils.getLiquidationSeizedAssets(repaidShares, this, this.config);
+        return MarketUtils.getLiquidationSeizedAssets(repaidShares, this, this.params);
     }
     /**
      * 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) {
-        return MarketUtils.getLiquidationRepaidShares(seizedAssets, this, this.config);
+        return MarketUtils.getLiquidationRepaidShares(seizedAssets, this, this.params);
     }
     /**
      * 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) {
-        return MarketUtils.getSeizableCollateral(position, this, this.config);
+        return MarketUtils.getSeizableCollateral(position, this, this.params);
     }
     /**
      * Returns the amount of collateral that can be withdrawn given a certain borrow position.
      * @param position The borrow position to consider.
      */
-    getWithdrawableCollateral(position, { maxLtv = this.config.lltv } = {}) {
+    getWithdrawableCollateral(position, { maxLtv = this.params.lltv } = {}) {
         return MarketUtils.getWithdrawableCollateral(position, this, {
-            lltv: MathLib.min(maxLtv, this.config.lltv),
+            lltv: MathLib.min(maxLtv, this.params.lltv),
         });
     }
     /**
@@ -323,14 +323,14 @@ export class Market {
      * @param position The borrow position to check.
      */
     isHealthy(position) {
-        return MarketUtils.isHealthy(position, this, this.config);
+        return MarketUtils.isHealthy(position, this, this.params);
     }
     /**
      * Returns the liquidation price of a given borrow position.
      * @param position The borrow position to consider.
      */
     getLiquidationPrice(position) {
-        return MarketUtils.getLiquidationPrice(position, this, this.config);
+        return MarketUtils.getLiquidationPrice(position, this, this.params);
     }
     /**
      * Returns the price variation required for the given position to reach its liquidation threshold (scaled by WAD).
@@ -339,14 +339,14 @@ export class Market {
      * @param position The borrow position to consider.
      */
     getPriceVariationToLiquidationPrice(position) {
-        return MarketUtils.getPriceVariationToLiquidationPrice(position, this, this.config);
+        return MarketUtils.getPriceVariationToLiquidationPrice(position, this, this.params);
     }
     /**
      * Returns the health factor of a given borrow position (scaled by WAD).
      * @param position The borrow position to consider.
      */
     getHealthFactor(position) {
-        return MarketUtils.getHealthFactor(position, this, this.config);
+        return MarketUtils.getHealthFactor(position, this, this.params);
     }
     /**
      * Returns the loan-to-value ratio of a given borrow position (scaled by WAD).
@@ -360,7 +360,7 @@ export class Market {
      * @param position The borrow position to consider.
      */
     getBorrowCapacityUsage(position) {
-        return MarketUtils.getBorrowCapacityUsage(position, this, this.config);
+        return MarketUtils.getBorrowCapacityUsage(position, this, this.params);
     }
     /**
      * Returns the maximum amount of loan assets that can be borrowed given a certain borrow position

package/lib/market/{MarketConfig.d.ts → MarketParams.d.ts}

@@ -1,5 +1,5 @@
 import type { Address, BigIntish, MarketId } from "../types.js";
-export interface MarketParams {
+export interface InputMarketParams {
     loanToken: Address;
     collateralToken: Address;
     oracle: Address;
@@ -9,17 +9,17 @@ export interface MarketParams {
 /**
  * Represents a market's configuration (also called market params).
  */
-export declare class MarketConfig implements MarketParams {
+export declare class MarketParams implements InputMarketParams {
     private static readonly _CACHE;
     /**
      * Returns the previously cached market config for the given id, if any.
-     * @throws {UnknownMarketConfigError} If no market config is cached.
+     * @throws {UnknownMarketParamsError} If no market config is cached.
      */
-    static get(id: MarketId): MarketConfig;
+    static get(id: MarketId): MarketParams;
     /**
      * Returns the canonical idle market configuration for the given loan token.
      */
-    static idle(token: Address): MarketConfig;
+    static idle(token: Address): MarketParams;
     /**
      * The market's collateral token address.
      */
@@ -48,5 +48,5 @@ export declare class MarketConfig implements MarketParams {
      * The market's liquidation incentive factor.
      */
     readonly liquidationIncentiveFactor: bigint;
-    constructor(params: MarketParams);
+    constructor(params: InputMarketParams);
 }

package/lib/market/{MarketConfig.js → MarketParams.js}

@@ -1,26 +1,26 @@
 import { ZERO_ADDRESS } from "@morpho-org/morpho-ts";
-import { UnknownMarketConfigError } from "../errors.js";
+import { UnknownMarketParamsError } from "../errors.js";
 import { MarketUtils } from "./MarketUtils.js";
 /**
  * Represents a market's configuration (also called market params).
  */
-export class MarketConfig {
+export class MarketParams {
     static _CACHE = {};
     /**
      * Returns the previously cached market config for the given id, if any.
-     * @throws {UnknownMarketConfigError} If no market config is cached.
+     * @throws {UnknownMarketParamsError} If no market config is cached.
      */
     static get(id) {
-        const marketConfig = MarketConfig._CACHE[id];
-        if (!marketConfig)
-            throw new UnknownMarketConfigError(id);
-        return marketConfig;
+        const marketParams = MarketParams._CACHE[id];
+        if (!marketParams)
+            throw new UnknownMarketParamsError(id);
+        return marketParams;
     }
     /**
      * Returns the canonical idle market configuration for the given loan token.
      */
     static idle(token) {
-        return new MarketConfig({
+        return new MarketParams({
             collateralToken: ZERO_ADDRESS,
             loanToken: token,
             oracle: ZERO_ADDRESS,
@@ -68,6 +68,6 @@ export class MarketConfig {
         this.id = MarketUtils.getMarketId(params);
         this.liquidationIncentiveFactor =
             MarketUtils.getLiquidationIncentiveFactor(params);
-        MarketConfig._CACHE[this.id] = this;
+        MarketParams._CACHE[this.id] = this;
     }
 }

package/lib/market/MarketUtils.d.ts

@@ -1,6 +1,6 @@
 import { type RoundingDirection } from "../math/index.js";
 import type { BigIntish, MarketId } from "../types.js";
-import type { MarketParams } from "./MarketConfig.js";
+import type { InputMarketParams } from "./MarketParams.js";
 /**
  * Namespace of utility functions to ease market-related calculations.
  */
@@ -9,7 +9,7 @@ export declare namespace MarketUtils {
      * Returns the id of a market based on its params.
      * @param market The market params.
      */
-    function getMarketId(market: MarketParams): MarketId;
+    function getMarketId(market: InputMarketParams): MarketId;
     /**
      * Returns the liquidation incentive factor for a given market params.
      * @param config The market params.
@@ -110,7 +110,7 @@ export declare namespace MarketUtils {
         totalBorrowAssets: BigIntish;
         totalBorrowShares: BigIntish;
         price: BigIntish;
-    }, marketConfig: {
+    }, marketParams: {
         lltv: BigIntish;
     }): bigint;
     function getLiquidationSeizedAssets(repaidShares: BigIntish, market: {
@@ -154,7 +154,7 @@ export declare namespace MarketUtils {
         totalBorrowAssets: BigIntish;
         totalBorrowShares: BigIntish;
         price: BigIntish;
-    }, marketConfig: {
+    }, marketParams: {
         lltv: BigIntish;
     }): boolean;
     /**
@@ -168,7 +168,7 @@ export declare namespace MarketUtils {
     }, market: {
         totalBorrowAssets: BigIntish;
         totalBorrowShares: BigIntish;
-    }, marketConfig: {
+    }, marketParams: {
         lltv: BigIntish;
     }): bigint | null;
     /**
@@ -183,7 +183,7 @@ export declare namespace MarketUtils {
         totalBorrowAssets: BigIntish;
         totalBorrowShares: BigIntish;
         price: BigIntish;
-    }, marketConfig: {
+    }, marketParams: {
         lltv: BigIntish;
     }): bigint | null;
     function getHealthFactor({ collateral, borrowShares, }: {
@@ -193,7 +193,7 @@ export declare namespace MarketUtils {
         totalBorrowAssets: BigIntish;
         totalBorrowShares: BigIntish;
         price: BigIntish;
-    }, marketConfig: {
+    }, marketParams: {
         lltv: BigIntish;
     }): bigint | null;
     function getLtv({ collateral, borrowShares, }: {
@@ -211,7 +211,7 @@ export declare namespace MarketUtils {
         totalBorrowAssets: BigIntish;
         totalBorrowShares: BigIntish;
         price: BigIntish;
-    }, marketConfig: {
+    }, marketParams: {
         lltv: BigIntish;
     }): bigint | null;
     function toSupplyAssets(shares: BigIntish, market: {

package/lib/market/MarketUtils.js

@@ -140,8 +140,8 @@ export var MarketUtils;
         return MathLib.wMulDown(getCollateralValue(collateral, market), lltv);
     }
     MarketUtils.getMaxBorrowAssets = getMaxBorrowAssets;
-    function getMaxBorrowableAssets({ collateral, borrowShares, }, market, marketConfig) {
-        return MathLib.zeroFloorSub(getMaxBorrowAssets(collateral, market, marketConfig), toBorrowAssets(borrowShares, market));
+    function getMaxBorrowableAssets({ collateral, borrowShares, }, market, marketParams) {
+        return MathLib.zeroFloorSub(getMaxBorrowAssets(collateral, market, marketParams), toBorrowAssets(borrowShares, market));
     }
     MarketUtils.getMaxBorrowableAssets = getMaxBorrowableAssets;
     function getLiquidationSeizedAssets(repaidShares, market, config) {
@@ -169,8 +169,8 @@ export var MarketUtils;
         return MathLib.zeroFloorSub(collateral, MathLib.wDivUp(MathLib.mulDivUp(toBorrowAssets(borrowShares, market), ORACLE_PRICE_SCALE, market.price), lltv));
     }
     MarketUtils.getWithdrawableCollateral = getWithdrawableCollateral;
-    function isHealthy({ collateral, borrowShares, }, market, marketConfig) {
-        return (getMaxBorrowAssets(collateral, market, marketConfig) >=
+    function isHealthy({ collateral, borrowShares, }, market, marketParams) {
+        return (getMaxBorrowAssets(collateral, market, marketParams) >=
             toBorrowAssets(borrowShares, market));
     }
     MarketUtils.isHealthy = isHealthy;
@@ -179,12 +179,12 @@ export var MarketUtils;
      * that set the user's position to be liquidatable.
      * Returns null if the position is not a borrow.
      */
-    function getLiquidationPrice({ collateral, borrowShares, }, market, marketConfig) {
+    function getLiquidationPrice({ collateral, borrowShares, }, market, marketParams) {
         borrowShares = BigInt(borrowShares);
         market.totalBorrowShares = BigInt(market.totalBorrowShares);
         if (borrowShares === 0n || market.totalBorrowShares === 0n)
             return null;
-        const collateralPower = getCollateralPower(collateral, marketConfig);
+        const collateralPower = getCollateralPower(collateral, marketParams);
         if (collateralPower === 0n)
             return MathLib.MAX_UINT_256;
         const borrowAssets = toBorrowAssets(borrowShares, market);
@@ -196,17 +196,17 @@ export var MarketUtils;
      * Negative when healthy (the price needs to drop x%), positive when unhealthy (the price needs to soar x%).
      * Returns null if the position is not a borrow.
      */
-    function getPriceVariationToLiquidationPrice(position, market, marketConfig) {
+    function getPriceVariationToLiquidationPrice(position, market, marketParams) {
         market.price = BigInt(market.price);
         if (market.price === 0n)
             return null;
-        const liquidationPrice = getLiquidationPrice(position, market, marketConfig);
+        const liquidationPrice = getLiquidationPrice(position, market, marketParams);
         if (liquidationPrice == null)
             return null;
         return MathLib.wDivUp(liquidationPrice, market.price) - MathLib.WAD;
     }
     MarketUtils.getPriceVariationToLiquidationPrice = getPriceVariationToLiquidationPrice;
-    function getHealthFactor({ collateral, borrowShares, }, market, marketConfig) {
+    function getHealthFactor({ collateral, borrowShares, }, market, marketParams) {
         borrowShares = BigInt(borrowShares);
         market.totalBorrowShares = BigInt(market.totalBorrowShares);
         if (borrowShares === 0n || market.totalBorrowShares === 0n)
@@ -214,7 +214,7 @@ export var MarketUtils;
         const borrowAssets = toBorrowAssets(borrowShares, market);
         if (borrowAssets === 0n)
             return MathLib.MAX_UINT_256;
-        const maxBorrowAssets = getMaxBorrowAssets(collateral, market, marketConfig);
+        const maxBorrowAssets = getMaxBorrowAssets(collateral, market, marketParams);
         return MathLib.wDivDown(maxBorrowAssets, borrowAssets);
     }
     MarketUtils.getHealthFactor = getHealthFactor;
@@ -229,8 +229,8 @@ export var MarketUtils;
         return MathLib.wDivUp(toBorrowAssets(borrowShares, market), collateralValue);
     }
     MarketUtils.getLtv = getLtv;
-    function getBorrowCapacityUsage(position, market, marketConfig) {
-        const hf = getHealthFactor(position, market, marketConfig);
+    function getBorrowCapacityUsage(position, market, marketParams) {
+        const hf = getHealthFactor(position, market, marketParams);
         if (hf === null)
             return null;
         if (hf === 0n)

package/lib/market/index.d.ts

@@ -1,3 +1,3 @@
 export * from "./MarketUtils.js";
-export * from "./MarketConfig.js";
+export * from "./MarketParams.js";
 export * from "./Market.js";

package/lib/market/index.js

@@ -1,3 +1,3 @@
 export * from "./MarketUtils.js";
-export * from "./MarketConfig.js";
+export * from "./MarketParams.js";
 export * from "./Market.js";

package/lib/vault/Vault.js

@@ -118,7 +118,7 @@ export class AccrualVault extends Vault {
         ]));
         this.collateralAllocations = new Map();
         for (const { marketId, position } of this.allocations.values()) {
-            const address = position.market.config.collateralToken;
+            const address = position.market.params.collateralToken;
             let exposure = this.collateralAllocations.get(address);
             if (!exposure)
                 this.collateralAllocations.set(address, (exposure = {
@@ -128,8 +128,8 @@ export class AccrualVault extends Vault {
                     markets: new Set(),
                     proportion: 0n,
                 }));
-            exposure.lltvs.add(position.market.config.lltv);
-            exposure.oracles.add(position.market.config.oracle);
+            exposure.lltvs.add(position.market.params.lltv);
+            exposure.oracles.add(position.market.params.oracle);
             exposure.markets.add(marketId);
             exposure.proportion += this.getAllocationProportion(marketId);
         }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@morpho-org/blue-sdk",
   "description": "Framework-agnostic package that defines Morpho-related entity classes (such as `Market`, `Token`, `Vault`).",
-  "version": "2.0.0-next.8",
+  "version": "2.0.0-next.9",
   "author": "Morpho Association <contact@morpho.org>",
   "contributors": [
     "Rubilmax <rmilon@gmail.com>"