@morpho-org/blue-sdk 2.0.0-test.1 → 2.0.0

package/lib/holding/Holding.d.ts

@@ -1,4 +1,4 @@
-import { Address } from "../types";
+import type { Address, BigIntish } from "../types.js";
 export declare const ERC20_ALLOWANCE_RECIPIENTS: readonly ["morpho", "permit2", "bundler"];
 export declare const PERMIT2_ALLOWANCE_RECIPIENTS: readonly ["morpho", "bundler"];
 export type Erc20AllowanceRecipient = (typeof ERC20_ALLOWANCE_RECIPIENTS)[number];
@@ -8,20 +8,25 @@ export interface Permit2Allowance {
     expiration: bigint;
     nonce: bigint;
 }
-export interface InputHolding {
+export interface IPermit2Allowance {
+    amount: BigIntish;
+    expiration: BigIntish;
+    nonce: BigIntish;
+}
+export interface IHolding {
     user: Address;
     token: Address;
     erc20Allowances: {
         [key in Erc20AllowanceRecipient]: bigint;
     };
     permit2Allowances: {
-        [key in Permit2AllowanceRecipient]: Permit2Allowance;
+        [key in Permit2AllowanceRecipient]: IPermit2Allowance;
     };
     erc2612Nonce?: bigint;
     canTransfer?: boolean;
     balance: bigint;
 }
-export declare class Holding implements InputHolding {
+export declare class Holding implements IHolding {
     /**
      * The user of this holding.
      */
@@ -55,5 +60,5 @@ export declare class Holding implements InputHolding {
      * `undefined` if the token does not support ERC-2612.
      */
     erc2612Nonce?: bigint;
-    constructor({ user, token, erc20Allowances, permit2Allowances, balance, erc2612Nonce, canTransfer, }: InputHolding);
+    constructor({ user, token, erc20Allowances, permit2Allowances, balance, erc2612Nonce, canTransfer, }: IHolding);
 }

package/lib/holding/Holding.js

@@ -2,7 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Holding = exports.PERMIT2_ALLOWANCE_RECIPIENTS = exports.ERC20_ALLOWANCE_RECIPIENTS = void 0;
 const morpho_ts_1 = require("@morpho-org/morpho-ts");
-const addresses_1 = require("../addresses");
 exports.ERC20_ALLOWANCE_RECIPIENTS = [
     "morpho",
     "permit2",
@@ -42,16 +41,27 @@ class Holding {
      * `undefined` if the token does not support ERC-2612.
      */
     erc2612Nonce;
-    constructor({ user, token, erc20Allowances, permit2Allowances, balance, erc2612Nonce, canTransfer = true, }) {
+    constructor({ user, token, erc20Allowances, permit2Allowances, balance, erc2612Nonce, canTransfer, }) {
         this.user = user;
         this.token = token;
         this.balance = balance;
-        this.canTransfer = token === addresses_1.NATIVE_ADDRESS || canTransfer;
+        this.canTransfer = canTransfer;
         this.erc20Allowances = (0, morpho_ts_1.fromEntries)((0, morpho_ts_1.entries)(erc20Allowances).map(([address, allowance]) => [
             address,
             allowance,
         ]));
-        this.permit2Allowances = permit2Allowances;
+        this.permit2Allowances = {
+            morpho: {
+                amount: BigInt(permit2Allowances.morpho.amount),
+                expiration: BigInt(permit2Allowances.morpho.expiration),
+                nonce: BigInt(permit2Allowances.morpho.nonce),
+            },
+            bundler: {
+                amount: BigInt(permit2Allowances.bundler.amount),
+                expiration: BigInt(permit2Allowances.bundler.expiration),
+                nonce: BigInt(permit2Allowances.bundler.nonce),
+            },
+        };
         if (erc2612Nonce != null)
             this.erc2612Nonce = erc2612Nonce;
     }

package/lib/holding/index.d.ts

@@ -1,2 +1,2 @@
-export * from "./Holding";
-export * from "./AssetBalances";
+export * from "./Holding.js";
+export * from "./AssetBalances.js";

package/lib/holding/index.js

@@ -14,5 +14,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./Holding"), exports);
-__exportStar(require("./AssetBalances"), exports);
+__exportStar(require("./Holding.js"), exports);
+__exportStar(require("./AssetBalances.js"), exports);

package/lib/index.d.ts

@@ -1,25 +1,12 @@
-export * from "./addresses";
-export * from "./constants";
-export * from "./errors";
-export * from "./market";
-export * from "./chain";
-export * from "./token";
-export * from "./types";
-export * from "./maths";
-export * from "./user";
-export * from "./holding";
-export * from "./position";
-export * from "./helpers";
-export * from "./vault";
-export * as constants from "./constants";
-export * as errors from "./errors";
-export * as market from "./market";
-export * as chain from "./chain";
-export * as token from "./token";
-export * as position from "./position";
-export * as holding from "./holding";
-export * as types from "./types";
-export * as maths from "./maths";
-export * as user from "./user";
-export * as helpers from "./helpers";
-export * as vault from "./vault";
+export * from "./addresses.js";
+export * from "./constants.js";
+export * from "./errors.js";
+export * from "./market/index.js";
+export * from "./chain.js";
+export * from "./token/index.js";
+export * from "./types.js";
+export * from "./math/index.js";
+export * from "./user/index.js";
+export * from "./holding/index.js";
+export * from "./position/index.js";
+export * from "./vault/index.js";

package/lib/index.js

@@ -10,45 +10,19 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
 }));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.vault = exports.helpers = exports.user = exports.maths = exports.types = exports.holding = exports.position = exports.token = exports.chain = exports.market = exports.errors = exports.constants = void 0;
-__exportStar(require("./addresses"), exports);
-__exportStar(require("./constants"), exports);
-__exportStar(require("./errors"), exports);
-__exportStar(require("./market"), exports);
-__exportStar(require("./chain"), exports);
-__exportStar(require("./token"), exports);
-__exportStar(require("./types"), exports);
-__exportStar(require("./maths"), exports);
-__exportStar(require("./user"), exports);
-__exportStar(require("./holding"), exports);
-__exportStar(require("./position"), exports);
-__exportStar(require("./helpers"), exports);
-__exportStar(require("./vault"), exports);
-exports.constants = __importStar(require("./constants"));
-exports.errors = __importStar(require("./errors"));
-exports.market = __importStar(require("./market"));
-exports.chain = __importStar(require("./chain"));
-exports.token = __importStar(require("./token"));
-exports.position = __importStar(require("./position"));
-exports.holding = __importStar(require("./holding"));
-exports.types = __importStar(require("./types"));
-exports.maths = __importStar(require("./maths"));
-exports.user = __importStar(require("./user"));
-exports.helpers = __importStar(require("./helpers"));
-exports.vault = __importStar(require("./vault"));
+__exportStar(require("./addresses.js"), exports);
+__exportStar(require("./constants.js"), exports);
+__exportStar(require("./errors.js"), exports);
+__exportStar(require("./market/index.js"), exports);
+__exportStar(require("./chain.js"), exports);
+__exportStar(require("./token/index.js"), exports);
+__exportStar(require("./types.js"), exports);
+__exportStar(require("./math/index.js"), exports);
+__exportStar(require("./user/index.js"), exports);
+__exportStar(require("./holding/index.js"), exports);
+__exportStar(require("./position/index.js"), exports);
+__exportStar(require("./vault/index.js"), exports);

package/lib/market/Market.d.ts

@@ -1,6 +1,6 @@
-import { RoundingDirection } from "../maths";
-import { BigIntish } from "../types";
-import { MarketConfig } from "./MarketConfig";
+import { type RoundingDirection } from "../math/index.js";
+import type { BigIntish } from "../types.js";
+import type { MarketParams } from "./MarketParams.js";
 export declare enum CapacityLimitReason {
     liquidity = "Liquidity",
     balance = "Balance",
@@ -21,30 +21,30 @@ export interface MaxWithdrawCollateralOptions {
 export interface MaxPositionCapacities {
     supply: CapacityLimit;
     withdraw: CapacityLimit;
-    borrow: CapacityLimit;
+    borrow: CapacityLimit | undefined;
     repay: CapacityLimit;
     supplyCollateral: CapacityLimit;
-    withdrawCollateral: CapacityLimit;
+    withdrawCollateral: CapacityLimit | undefined;
 }
-export interface InputMarket {
-    config: MarketConfig;
+export interface IMarket {
+    params: MarketParams;
     totalSupplyAssets: bigint;
     totalBorrowAssets: bigint;
     totalSupplyShares: bigint;
     totalBorrowShares: bigint;
     lastUpdate: bigint;
     fee: bigint;
-    price: bigint;
+    price?: bigint;
     rateAtTarget?: bigint;
 }
 /**
  * Represents a lending market on Morpho Blue.
  */
-export declare class Market implements InputMarket {
+export declare class Market implements IMarket {
     /**
-     * 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.
      */
@@ -71,18 +71,19 @@ export declare class Market implements InputMarket {
     fee: bigint;
     /**
      * The price as returned by the market's oracle.
+     * `undefined` if the oracle is undefined or reverts.
      */
-    price: bigint;
+    price?: bigint;
     /**
      * If the market uses the Adaptive Curve IRM, the rate at target utilization.
      * 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, }: IMarket);
     /**
      * The market's hex-encoded id, defined as the hash of the market params.
      */
-    get id(): import("../types").MarketId;
+    get id(): import("../types.js").MarketId;
     /**
      * Whether the market satisfies the canonical definition of an idle market (i.e. collateral token is the zero address).
      */
@@ -101,21 +102,21 @@ export declare class Market implements InputMarket {
      */
     get apyAtTarget(): bigint | undefined;
     /**
-     * Returns the rate at which interest accrued on average for suppliers of this market,
+     * Returns the rate at which interest accrued 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,
+     * Returns the rate at which interest accrued 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).
+     * The market's supply-side Annual Percentage Yield (APY) (scaled by WAD).
      */
     get supplyApy(): bigint;
     /**
-     * The market's borrow Annual Percentage Yield (APY) (scaled by WAD).
+     * The market's borrow-side Annual Percentage Yield (APY) (scaled by WAD).
      */
     get borrowApy(): bigint;
     /**
@@ -189,57 +190,65 @@ export declare class Market implements InputMarket {
     getRepayToUtilization(utilization: bigint): bigint;
     /**
      * Returns the value of a given amount of collateral quoted in loan assets.
+     * `undefined` iff the market's oracle is undefined or reverts.
      * @param collateral The amount of collateral to quote.
      */
-    getCollateralValue(collateral: bigint): bigint;
+    getCollateralValue(collateral: bigint): bigint | undefined;
     /**
      * Returns the maximum debt allowed given a certain amount of collateral.
+     * `undefined` iff the market's oracle is undefined or reverts.
      * To calculate the amount of loan assets that can be borrowed, use `getMaxBorrowableAssets`.
      * @param collateral The amount of collateral to consider.
      */
-    getMaxBorrowAssets(collateral: bigint, { maxLtv }?: MaxBorrowOptions): bigint;
+    getMaxBorrowAssets(collateral: bigint, { maxLtv }?: MaxBorrowOptions): bigint | undefined;
     /**
      * Returns the maximum amount of loan assets that can be borrowed given a certain borrow position.
+     * `undefined` iff the market's oracle is undefined or reverts.
      * @param position The borrow position to consider.
      */
     getMaxBorrowableAssets(position: {
         collateral: bigint;
         borrowShares: bigint;
-    }): bigint;
+    }): bigint | undefined;
     /**
      * Returns the amount of collateral that would be seized in a liquidation given a certain amount of repaid shares.
+     * `undefined` iff the market's oracle is undefined or reverts.
      * @param repaidShares The amount of shares hypothetically repaid.
      */
-    getLiquidationSeizedAssets(repaidShares: bigint): bigint;
+    getLiquidationSeizedAssets(repaidShares: bigint): bigint | undefined;
     /**
      * Returns the amount of borrow shares that would be repaid in a liquidation given a certain amount of seized collateral.
+     * `undefined` iff the market's oracle is undefined or reverts.
      * @param seizedAssets The amount of collateral hypothetically seized.
      */
-    getLiquidationRepaidShares(seizedAssets: bigint): bigint;
+    getLiquidationRepaidShares(seizedAssets: bigint): bigint | undefined;
     /**
      * Returns the maximum amount of collateral that is worth being seized in a liquidation given a certain borrow position.
+     * `undefined` iff the market's oracle is undefined or reverts.
      * @param position The borrow position to consider.
      */
     getSeizableCollateral(position: {
         collateral: bigint;
         borrowShares: bigint;
-    }): bigint;
+    }): bigint | undefined;
     /**
      * Returns the amount of collateral that can be withdrawn given a certain borrow position.
+     * `undefined` iff the market's oracle is undefined or reverts.
      * @param position The borrow position to consider.
      */
     getWithdrawableCollateral(position: {
         collateral: bigint;
         borrowShares: bigint;
-    }, { maxLtv }?: MaxWithdrawCollateralOptions): bigint;
+    }, { maxLtv }?: MaxWithdrawCollateralOptions): bigint | undefined;
     /**
      * Returns whether a given borrow position is healthy.
+     * `undefined` iff the market's oracle is undefined or reverts.
      * @param position The borrow position to check.
      */
     isHealthy(position: {
         collateral: bigint;
         borrowShares: bigint;
-    }): boolean;
+    }): boolean | undefined;
     /**
      * Returns the liquidation price of a given borrow position.
      * @param position The borrow position to consider.
@@ -249,13 +258,16 @@ export declare class Market implements InputMarket {
         borrowShares: bigint;
     }): bigint | null;
     /**
-     * Returns the price deviation required for the given borrow position to be unhealthy (scaled by WAD).
+     * Returns the price variation required for the given position to reach its liquidation threshold (scaled by WAD).
+     * Negative when healthy (the price needs to drop x%), positive when unhealthy (the price needs to soar x%).
+     * Returns `undefined` iff the market's price is undefined.
+     * Returns null if the position is not a borrow.
      * @param position The borrow position to consider.
      */
-    getPriceVariationToLiquidation(position: {
+    getPriceVariationToLiquidationPrice(position: {
         collateral: bigint;
         borrowShares: bigint;
-    }): bigint | null;
+    }): bigint | null | undefined;
     /**
      * Returns the health factor of a given borrow position (scaled by WAD).
      * @param position The borrow position to consider.
@@ -263,7 +275,7 @@ export declare class Market implements InputMarket {
     getHealthFactor(position: {
         collateral: bigint;
         borrowShares: bigint;
-    }): bigint | null;
+    }): bigint | null | undefined;
     /**
      * Returns the loan-to-value ratio of a given borrow position (scaled by WAD).
      * @param position The borrow position to consider.
@@ -271,7 +283,7 @@ export declare class Market implements InputMarket {
     getLtv(position: {
         collateral: bigint;
         borrowShares: bigint;
-    }): bigint | null;
+    }): bigint | null | undefined;
     /**
      * Returns the usage ratio of the maximum borrow capacity given a certain borrow position (scaled by WAD).
      * @param position The borrow position to consider.
@@ -279,16 +291,17 @@ export declare class Market implements InputMarket {
     getBorrowCapacityUsage(position: {
         collateral: bigint;
         borrowShares: bigint;
-    }): bigint | null;
+    }): bigint | undefined;
     /**
      * Returns the maximum amount of loan assets that can be borrowed given a certain borrow position
      * and the reason for the limit.
+     * Returns `undefined` iff the market's price is undefined.
      * @param position The borrow position to consider.
      */
     getBorrowCapacityLimit({ collateral, borrowShares, }: {
         collateral: bigint;
         borrowShares?: bigint;
-    }, options?: MaxBorrowOptions): CapacityLimit;
+    }, options?: MaxBorrowOptions): CapacityLimit | undefined;
     /**
      * 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.
@@ -306,12 +319,13 @@ export declare class Market implements InputMarket {
     /**
      * Returns the maximum amount of collateral assets that can be withdrawn given a certain borrow position
      * and the reason for the limit.
+     * Returns `undefined` iff the market's price is undefined.
      * @param position The borrow position to consider.
      */
     getWithdrawCollateralCapacityLimit(position: {
         collateral: bigint;
         borrowShares: bigint;
-    }, options?: MaxWithdrawCollateralOptions): CapacityLimit;
+    }, options?: MaxWithdrawCollateralOptions): CapacityLimit | undefined;
     /**
      * Returns the maximum capacity for all interactions with Morpho Blue given a certain position
      * and loan and collateral balances.