@morpho-org/blue-sdk 2.1.2 → 2.3.0

package/lib/position/Position.d.ts

@@ -1,4 +1,4 @@
-import { Market, type MaxBorrowOptions, type MaxWithdrawCollateralOptions } from "../market/index.js";
+import { Market, type MaxBorrowOptions, type MaxPositionCapacities, type MaxWithdrawCollateralOptions } from "../market/index.js";
 import type { Address, BigIntish, MarketId } from "../types.js";
 export interface IPosition {
     user: Address;
@@ -98,8 +98,24 @@ export declare class AccrualPosition extends Position implements IAccrualPositio
      * If the collateral price is 0, usage is `MaxUint256`.
      */
     get borrowCapacityUsage(): 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.
+     * @deprecated Use `getBorrowCapacityLimit` instead.
+     */
     get borrowCapacityLimit(): import("../market/Market.js").CapacityLimit | undefined;
+    /**
+     * 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.
+     */
     get withdrawCapacityLimit(): import("../market/Market.js").CapacityLimit;
+    /**
+     * 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.
+     * @deprecated Use `getWithdrawCollateralCapacityLimit` instead.
+     */
     get withdrawCollateralCapacityLimit(): import("../market/Market.js").CapacityLimit | undefined;
     /**
      * Returns a new position derived from this position, whose interest has been accrued up to the given timestamp.
@@ -128,9 +144,11 @@ export declare class AccrualPosition extends Position implements IAccrualPositio
         assets: bigint;
         shares: bigint;
     };
+    getBorrowCapacityLimit(options?: MaxBorrowOptions): import("../market/Market.js").CapacityLimit | undefined;
+    getWithdrawCollateralCapacityLimit(options?: MaxWithdrawCollateralOptions): import("../market/Market.js").CapacityLimit | undefined;
     getRepayCapacityLimit(loanTokenBalance: bigint): import("../market/Market.js").CapacityLimit;
     getMaxCapacities(loanTokenBalance: bigint, collateralTokenBalance: bigint, options?: {
         borrow?: MaxBorrowOptions;
         withdrawCollateral?: MaxWithdrawCollateralOptions;
-    }): import("../market/Market.js").MaxPositionCapacities;
+    }): MaxPositionCapacities;
 }

package/lib/position/Position.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AccrualPosition = exports.Position = void 0;
 const errors_js_1 = require("../errors.js");
 const index_js_1 = require("../market/index.js");
+const MathLib_js_1 = require("../math/MathLib.js");
 class Position {
     /**
      * The user holding this position.
@@ -67,7 +68,10 @@ class AccrualPosition extends Position {
      * `undefined` iff the market's oracle is undefined or reverts.
      */
     get maxBorrowableAssets() {
-        return this.market.getMaxBorrowableAssets(this);
+        const { maxBorrowAssets } = this;
+        if (maxBorrowAssets == null)
+            return;
+        return MathLib_js_1.MathLib.zeroFloorSub(maxBorrowAssets, this.borrowAssets);
     }
     /**
      * The maximum amount of collateral that can be seized in exchange for the outstanding debt.
@@ -128,12 +132,28 @@ class AccrualPosition extends Position {
     get borrowCapacityUsage() {
         return this.market.getBorrowCapacityUsage(this);
     }
+    /**
+     * 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.
+     * @deprecated Use `getBorrowCapacityLimit` instead.
+     */
     get borrowCapacityLimit() {
         return this.market.getBorrowCapacityLimit(this);
     }
+    /**
+     * 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.
+     */
     get withdrawCapacityLimit() {
         return this.market.getWithdrawCapacityLimit(this);
     }
+    /**
+     * 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.
+     * @deprecated Use `getWithdrawCollateralCapacityLimit` instead.
+     */
     get withdrawCollateralCapacityLimit() {
         return this.market.getWithdrawCollateralCapacityLimit(this);
     }
@@ -195,11 +215,30 @@ class AccrualPosition extends Position {
             throw new errors_js_1.BlueErrors.InsufficientPosition(position.user, position.marketId);
         return { position, assets, shares };
     }
+    getBorrowCapacityLimit(options) {
+        return this.market.getBorrowCapacityLimit(this, options);
+    }
+    getWithdrawCollateralCapacityLimit(options) {
+        return this.market.getWithdrawCollateralCapacityLimit(this, options);
+    }
     getRepayCapacityLimit(loanTokenBalance) {
         return this.market.getRepayCapacityLimit(this.borrowShares, loanTokenBalance);
     }
     getMaxCapacities(loanTokenBalance, collateralTokenBalance, options) {
-        return this.market.getMaxCapacities(this, loanTokenBalance, collateralTokenBalance, options);
+        return {
+            supply: {
+                value: loanTokenBalance,
+                limiter: index_js_1.CapacityLimitReason.balance,
+            },
+            withdraw: this.withdrawCapacityLimit,
+            borrow: this.getBorrowCapacityLimit(options?.borrow),
+            repay: this.getRepayCapacityLimit(loanTokenBalance),
+            supplyCollateral: {
+                value: collateralTokenBalance,
+                limiter: index_js_1.CapacityLimitReason.balance,
+            },
+            withdrawCollateral: this.getWithdrawCollateralCapacityLimit(options?.withdrawCollateral),
+        };
     }
 }
 exports.AccrualPosition = AccrualPosition;

package/lib/token/Eip5267Domain.d.ts

@@ -0,0 +1,55 @@
+import type { Address } from "../types.js";
+export declare const EIP_712_FIELDS: readonly ["name", "version", "chainId", "verifyingContract", "salt"];
+export type Eip712Field = (typeof EIP_712_FIELDS)[number];
+export interface IEip5267Domain {
+    fields: `0x${string}`;
+    name: string;
+    version: string;
+    chainId: bigint;
+    verifyingContract: Address;
+    salt: `0x${string}`;
+    extensions: readonly bigint[];
+}
+export declare class Eip5267Domain implements IEip5267Domain {
+    /**
+     * A bit map where bit i is set to 1 if and only if domain field i is present (0 ≤ i ≤ 4).
+     * Bits are read from least significant to most significant, and fields are indexed in the order that is specified by EIP-712, identical to the order in which they are listed in the function type.
+     */
+    readonly fields: `0x${string}`;
+    /**
+     * The user readable name of signing domain, i.e. the name of the DApp or the protocol.
+     */
+    readonly name: string;
+    /**
+     * The current major version of the signing domain.
+     * Signatures from different versions are not compatible.
+     */
+    readonly version: string;
+    /**
+     * The EIP-155 chain id.
+     */
+    readonly chainId: bigint;
+    /**
+     * The address of the contract that will verify the EIP-712 signature.
+     */
+    readonly verifyingContract: `0x${string}`;
+    /**
+     * A disambiguating salt for the protocol.
+     * This can be used as a domain separator of last resort.
+     */
+    readonly salt: `0x${string}`;
+    /**
+     * A list of EIP numbers, each of which MUST refer to an EIP that extends EIP-712 with new domain fields, along with a method to obtain the value for those fields, and potentially conditions for inclusion.
+     * The value of fields does not affect their inclusion.
+     */
+    readonly extensions: readonly bigint[];
+    readonly eip712Domain: {
+        name?: string | undefined;
+        chainId?: number | undefined;
+        version?: string | undefined;
+        verifyingContract?: `0x${string}` | undefined;
+        salt?: `0x${string}` | undefined;
+    };
+    constructor({ fields, name, version, chainId, verifyingContract, salt, extensions, }: IEip5267Domain);
+    private asEip712Domain;
+}

package/lib/token/Eip5267Domain.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Eip5267Domain = exports.EIP_712_FIELDS = void 0;
+exports.EIP_712_FIELDS = [
+    "name",
+    "version",
+    "chainId",
+    "verifyingContract",
+    "salt",
+];
+class Eip5267Domain {
+    /**
+     * A bit map where bit i is set to 1 if and only if domain field i is present (0 ≤ i ≤ 4).
+     * Bits are read from least significant to most significant, and fields are indexed in the order that is specified by EIP-712, identical to the order in which they are listed in the function type.
+     */
+    fields;
+    /**
+     * The user readable name of signing domain, i.e. the name of the DApp or the protocol.
+     */
+    name;
+    /**
+     * The current major version of the signing domain.
+     * Signatures from different versions are not compatible.
+     */
+    version;
+    /**
+     * The EIP-155 chain id.
+     */
+    chainId;
+    /**
+     * The address of the contract that will verify the EIP-712 signature.
+     */
+    verifyingContract;
+    /**
+     * A disambiguating salt for the protocol.
+     * This can be used as a domain separator of last resort.
+     */
+    salt;
+    /**
+     * A list of EIP numbers, each of which MUST refer to an EIP that extends EIP-712 with new domain fields, along with a method to obtain the value for those fields, and potentially conditions for inclusion.
+     * The value of fields does not affect their inclusion.
+     */
+    extensions;
+    eip712Domain;
+    constructor({ fields, name, version, chainId, verifyingContract, salt, extensions, }) {
+        this.fields = fields;
+        this.name = name;
+        this.version = version;
+        this.chainId = chainId;
+        this.verifyingContract = verifyingContract;
+        this.salt = salt;
+        this.extensions = extensions;
+        this.eip712Domain = this.asEip712Domain();
+    }
+    asEip712Domain() {
+        const fields = BigInt(this.fields);
+        return exports.EIP_712_FIELDS.reduce((acc, field, i) => {
+            if (fields & (2n ** BigInt(i))) {
+                // @ts-expect-error Typescript doesn't infer value type based on field.
+                acc[field] =
+                    field === "chainId"
+                        ? // Signature does not correspond if chainId is a bigint.
+                            Number(this.chainId)
+                        : this[field];
+            }
+            return acc;
+        }, {});
+    }
+}
+exports.Eip5267Domain = Eip5267Domain;

package/lib/token/Token.d.ts

@@ -1,12 +1,14 @@
 import { type ChainId } from "../chain.js";
 import { type RoundingDirection } from "../math/index.js";
 import type { Address, BigIntish } from "../types.js";
+import type { Eip5267Domain } from "./Eip5267Domain.js";
 export interface IToken {
     address: Address;
     name?: string;
     symbol?: string;
     decimals?: BigIntish;
     price?: BigIntish;
+    eip5267Domain?: Eip5267Domain;
 }
 export declare class Token implements IToken {
     static native(chainId: ChainId): Token;
@@ -26,11 +28,15 @@ export declare class Token implements IToken {
      * The token's number of decimals. Defaults to 0.
      */
     readonly decimals: number;
+    /**
+     * The eip712 domain of the token if it can be directly queried onchain
+     */
+    readonly eip5267Domain?: Eip5267Domain;
     /**
      * Price of the token in USD (scaled by WAD).
      */
     price?: bigint;
-    constructor({ address, name, symbol, decimals, price }: IToken);
+    constructor({ address, name, symbol, decimals, price, eip5267Domain, }: IToken);
     /**
      * Quotes an amount in USD (scaled by WAD) in this token.
      * Returns `undefined` iff the token's price is undefined.

package/lib/token/Token.js

@@ -25,15 +25,20 @@ class Token {
      * The token's number of decimals. Defaults to 0.
      */
     decimals;
+    /**
+     * The eip712 domain of the token if it can be directly queried onchain
+     */
+    eip5267Domain;
     /**
      * Price of the token in USD (scaled by WAD).
      */
     price;
-    constructor({ address, name, symbol, decimals = 0, price }) {
+    constructor({ address, name, symbol, decimals = 0, price, eip5267Domain, }) {
         this.address = address;
         this.name = name;
         this.symbol = symbol;
         this.decimals = Number(decimals);
+        this.eip5267Domain = eip5267Domain;
         if (price != null)
             this.price = BigInt(price);
     }

package/lib/token/index.d.ts

@@ -3,3 +3,4 @@ export * from "./WrappedToken.js";
 export * from "./ConstantWrappedToken.js";
 export * from "./ExchangeRateWrappedToken.js";
 export * from "./VaultToken.js";
+export * from "./Eip5267Domain.js";

package/lib/token/index.js

@@ -19,3 +19,4 @@ __exportStar(require("./WrappedToken.js"), exports);
 __exportStar(require("./ConstantWrappedToken.js"), exports);
 __exportStar(require("./ExchangeRateWrappedToken.js"), exports);
 __exportStar(require("./VaultToken.js"), exports);
+__exportStar(require("./Eip5267Domain.js"), exports);

package/lib/vault/Vault.d.ts

@@ -38,6 +38,7 @@ export interface IVault extends IVaultConfig {
     totalSupply: bigint;
     totalAssets: bigint;
     lastTotalAssets: bigint;
+    lostAssets?: bigint;
     publicAllocatorConfig?: VaultPublicAllocatorConfig;
 }
 export declare class Vault extends VaultToken implements IVault {
@@ -101,11 +102,16 @@ export declare class Vault extends VaultToken implements IVault {
      * The MetaMorpho vault's last total assets used to calculate performance fees.
      */
     lastTotalAssets: bigint;
+    /**
+     * The MetaMorpho vault's lost assets due to realized bad debt.
+     * Only defined for MetaMorpho V1.1 vaults.
+     */
+    lostAssets?: bigint;
     /**
      * The MetaMorpho vault's public allocator configuration.
      */
     publicAllocatorConfig?: VaultPublicAllocatorConfig;
-    constructor({ curator, owner, guardian, publicAllocatorConfig, fee, feeRecipient, skimRecipient, pendingTimelock, pendingGuardian, pendingOwner, timelock, supplyQueue, withdrawQueue, totalSupply, totalAssets, lastTotalAssets, ...config }: IVault);
+    constructor({ curator, owner, guardian, publicAllocatorConfig, fee, feeRecipient, skimRecipient, pendingTimelock, pendingGuardian, pendingOwner, timelock, supplyQueue, withdrawQueue, totalSupply, totalAssets, lastTotalAssets, lostAssets, ...config }: IVault);
     /**
      * The amount of interest in assets accrued since the last interaction with the vault.
      */

package/lib/vault/Vault.js

@@ -58,11 +58,16 @@ class Vault extends index_js_3.VaultToken {
      * The MetaMorpho vault's last total assets used to calculate performance fees.
      */
     lastTotalAssets;
+    /**
+     * The MetaMorpho vault's lost assets due to realized bad debt.
+     * Only defined for MetaMorpho V1.1 vaults.
+     */
+    lostAssets;
     /**
      * The MetaMorpho vault's public allocator configuration.
      */
     publicAllocatorConfig;
-    constructor({ curator, owner, guardian, publicAllocatorConfig, fee, feeRecipient, skimRecipient, pendingTimelock, pendingGuardian, pendingOwner, timelock, supplyQueue, withdrawQueue, totalSupply, totalAssets, lastTotalAssets, ...config }) {
+    constructor({ curator, owner, guardian, publicAllocatorConfig, fee, feeRecipient, skimRecipient, pendingTimelock, pendingGuardian, pendingOwner, timelock, supplyQueue, withdrawQueue, totalSupply, totalAssets, lastTotalAssets, lostAssets, ...config }) {
         super(config, { totalAssets, totalSupply });
         this.curator = curator;
         this.owner = owner;
@@ -80,6 +85,7 @@ class Vault extends index_js_3.VaultToken {
         this.supplyQueue = supplyQueue;
         this.withdrawQueue = withdrawQueue;
         this.lastTotalAssets = lastTotalAssets;
+        this.lostAssets = lostAssets;
         this.publicAllocatorConfig = publicAllocatorConfig;
     }
     /**
@@ -214,6 +220,10 @@ class AccrualVault extends Vault {
                 position: position.accrueInterest(timestamp),
             };
         }));
+        if (vault.lostAssets != null) {
+            vault.lostAssets += index_js_2.MathLib.max(vault.lastTotalAssets - vault.lostAssets - vault.totalAssets, 0n);
+            vault.totalAssets += vault.lostAssets;
+        }
         const feeAssets = index_js_2.MathLib.wMulDown(vault.totalInterest, vault.fee);
         vault.totalAssets -= feeAssets;
         const feeShares = vault.toShares(feeAssets, "Down");

package/lib/vault/VaultConfig.d.ts

@@ -1,21 +1,19 @@
-import type { ChainId } from "../chain.js";
+import { type IToken, Token } from "../token/Token.js";
 import type { Address, BigIntish } from "../types.js";
-export interface IVaultConfig {
-    address: Address;
+export interface IVaultConfig extends Omit<IToken, "decimals"> {
     decimalsOffset: BigIntish;
-    symbol: string;
-    name: string;
     asset: Address;
 }
-export declare class VaultConfig implements IVaultConfig {
+export declare class VaultConfig extends Token implements IVaultConfig {
+    /**
+     * @deprecated Kept for backward compatibility.
+     */
     readonly chainId?: number | undefined;
-    protected static readonly _CACHE: Record<number, Record<Address, VaultConfig>>;
-    static get(address: Address, chainId: ChainId): VaultConfig;
-    readonly address: Address;
-    readonly decimals: number;
     readonly decimalsOffset: bigint;
-    readonly symbol: string;
-    readonly name: string;
-    readonly asset: Address;
-    constructor({ address, decimalsOffset, symbol, name, asset }: IVaultConfig, chainId?: number | undefined);
+    readonly asset: `0x${string}`;
+    constructor({ decimalsOffset, asset, ...config }: IVaultConfig, 
+    /**
+     * @deprecated Kept for backward compatibility.
+     */
+    chainId?: number | undefined);
 }

package/lib/vault/VaultConfig.js

@@ -1,32 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VaultConfig = void 0;
-const errors_js_1 = require("../errors.js");
-class VaultConfig {
+const Token_js_1 = require("../token/Token.js");
+class VaultConfig extends Token_js_1.Token {
     chainId;
-    static _CACHE = {};
-    static get(address, chainId) {
-        const config = VaultConfig._CACHE[chainId]?.[address];
-        if (!config)
-            throw new errors_js_1.UnknownVaultConfigError(address);
-        return config;
-    }
-    address;
-    decimals;
     decimalsOffset;
-    symbol;
-    name;
     asset;
-    constructor({ address, decimalsOffset, symbol, name, asset }, chainId) {
+    constructor({ decimalsOffset, asset, ...config }, 
+    /**
+     * @deprecated Kept for backward compatibility.
+     */
+    chainId) {
+        super({ ...config, decimals: 18 });
         this.chainId = chainId;
-        this.address = address;
-        this.decimals = 18;
         this.decimalsOffset = BigInt(decimalsOffset);
-        this.symbol = symbol;
-        this.name = name;
         this.asset = asset;
-        if (chainId != null)
-            (VaultConfig._CACHE[chainId] ??= {})[address] = this;
     }
 }
 exports.VaultConfig = VaultConfig;

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.1.2",
+  "version": "2.3.0",
   "author": "Morpho Association <contact@morpho.org>",
   "contributors": [
     "Rubilmax <rmilon@gmail.com>"
@@ -28,7 +28,7 @@
     "viem": "^2.22.2",
     "vitest": "^2.1.8",
     "@morpho-org/morpho-ts": "^2.0.0",
-    "@morpho-org/test": "^2.0.2"
+    "@morpho-org/test": "^2.0.3"
   },
   "scripts": {
     "prepublish": "$npm_execpath build",