@morpho-org/blue-sdk 5.16.0 → 5.17.0

package/lib/esm/constants.js

@@ -0,0 +1,21 @@
+import { Time } from "@morpho-org/morpho-ts";
+/**
+ * The liquidation cursor used to calculate the liquidation incentive. Hardcoded to 30%.
+ */
+export const LIQUIDATION_CURSOR = 300000000000000000n;
+/**
+ * The maximum liquidation incentive factor. Hardcoded to 115%.
+ */
+export const MAX_LIQUIDATION_INCENTIVE_FACTOR = 1150000000000000000n;
+/**
+ * The scale of the oracle price. Hardcoded to 1e36.
+ */
+export const ORACLE_PRICE_SCALE = 1000000000000000000000000000000000000n;
+/**
+ * The default slippage tolerance used in the SDK. Hardcoded to 0.03%.
+ */
+export const DEFAULT_SLIPPAGE_TOLERANCE = 300000000000000n;
+/**
+ * The number of seconds in a year.
+ */
+export const SECONDS_PER_YEAR = Time.s.from.y(1n);

package/lib/esm/errors.d.ts

@@ -0,0 +1,101 @@
+import { type Hex } from "viem";
+import type { Address, MarketId } from "./types.js";
+export declare class InvalidMarketParamsError extends Error {
+    readonly data: Hex;
+    constructor(data: Hex);
+}
+export declare class UnknownDataError extends Error {
+}
+export declare class UnknownTokenError extends UnknownDataError {
+    readonly address: Address;
+    constructor(address: Address);
+}
+export declare class UnknownTokenPriceError extends UnknownDataError {
+    readonly address: Address;
+    constructor(address: Address);
+}
+export declare class UnknownMarketParamsError extends UnknownDataError {
+    readonly marketId: MarketId;
+    constructor(marketId: MarketId);
+}
+export declare class UnknownVaultConfigError extends UnknownDataError {
+    readonly vault: Address;
+    constructor(vault: Address);
+}
+export declare class UnsupportedChainIdError extends Error {
+    readonly chainId: number;
+    constructor(chainId: number);
+}
+export declare class UnsupportedPreLiquidationParamsError extends Error {
+    readonly lltv: bigint;
+    constructor(lltv: bigint);
+}
+export declare class UnsupportedVaultV2AdapterError extends Error {
+    readonly address: Address;
+    constructor(address: Address);
+}
+export declare namespace BlueErrors {
+    class AlreadySet extends Error {
+        readonly name: string;
+        readonly value: string;
+        constructor(name: string, value: string);
+    }
+    class InvalidInterestAccrual extends Error {
+        readonly marketId: MarketId;
+        readonly timestamp: bigint;
+        readonly lastUpdate: bigint;
+        constructor(marketId: MarketId, timestamp: bigint, lastUpdate: bigint);
+    }
+    class InconsistentInput extends Error {
+        readonly assets: bigint;
+        readonly shares: bigint;
+        constructor(assets: bigint, shares: bigint);
+    }
+    class InsufficientLiquidity extends Error {
+        readonly marketId: MarketId;
+        constructor(marketId: MarketId);
+    }
+    class UnknownOraclePrice extends Error {
+        readonly marketId: MarketId;
+        constructor(marketId: MarketId);
+    }
+    class InsufficientPosition extends Error {
+        readonly user: Address;
+        readonly marketId: MarketId;
+        constructor(user: Address, marketId: MarketId);
+    }
+    class InsufficientCollateral extends Error {
+        readonly user: Address;
+        readonly marketId: MarketId;
+        constructor(user: Address, marketId: MarketId);
+    }
+    class ExpiredSignature extends Error {
+        readonly deadline: bigint;
+        constructor(deadline: bigint);
+    }
+}
+export declare namespace VaultV2Errors {
+    class InvalidInterestAccrual extends Error {
+        readonly vault: Address;
+        readonly timestamp: bigint;
+        readonly lastUpdate: bigint;
+        constructor(vault: Address, timestamp: bigint, lastUpdate: bigint);
+    }
+    class UnsupportedLiquidityAdapter extends Error {
+        readonly address: Address;
+        constructor(address: Address);
+    }
+}
+export declare class UnknownFactory extends Error {
+    constructor();
+}
+export declare class UnknownOfFactory extends Error {
+    readonly factory: Address;
+    readonly address: Address;
+    constructor(factory: Address, address: Address);
+}
+export interface ErrorClass<E extends Error = Error> {
+    new (...args: any[]): E;
+}
+export declare function _try<T, ErrorClasses extends readonly ErrorClass[] = []>(accessor: () => Promise<T>, ...errorClasses: ErrorClasses): Promise<T | undefined>;
+export declare function _try<T, ErrorClasses extends readonly ErrorClass[] = []>(accessor: () => T, ...errorClasses: ErrorClasses): T | undefined;

package/lib/esm/errors.js

@@ -0,0 +1,192 @@
+import { formatUnits } from "viem";
+export class InvalidMarketParamsError extends Error {
+    data;
+    constructor(data) {
+        super(`cannot decode valid MarketParams from "${data}"`);
+        this.data = data;
+    }
+}
+export class UnknownDataError extends Error {
+}
+export class UnknownTokenError extends UnknownDataError {
+    address;
+    constructor(address) {
+        super(`unknown token ${address}`);
+        this.address = address;
+    }
+}
+export class UnknownTokenPriceError extends UnknownDataError {
+    address;
+    constructor(address) {
+        super(`unknown price of token ${address}`);
+        this.address = address;
+    }
+}
+export class UnknownMarketParamsError extends UnknownDataError {
+    marketId;
+    constructor(marketId) {
+        super(`unknown config for market ${marketId}`);
+        this.marketId = marketId;
+    }
+}
+export class UnknownVaultConfigError extends UnknownDataError {
+    vault;
+    constructor(vault) {
+        super(`unknown config for vault ${vault}`);
+        this.vault = vault;
+    }
+}
+export class UnsupportedChainIdError extends Error {
+    chainId;
+    constructor(chainId) {
+        super(`unsupported chain ${chainId}`);
+        this.chainId = chainId;
+    }
+}
+export class UnsupportedPreLiquidationParamsError extends Error {
+    lltv;
+    constructor(lltv) {
+        super(`unsupported pre liquidation params for lltv ${formatUnits(lltv, 16)}%`);
+        this.lltv = lltv;
+    }
+}
+export class UnsupportedVaultV2AdapterError extends Error {
+    address;
+    constructor(address) {
+        super(`vault v2 adapter "${address}" is not supported`);
+        this.address = address;
+    }
+}
+export var BlueErrors;
+(function (BlueErrors) {
+    class AlreadySet extends Error {
+        name;
+        value;
+        constructor(name, value) {
+            super(`${name} is already set to ${value}`);
+            this.name = name;
+            this.value = value;
+        }
+    }
+    BlueErrors.AlreadySet = AlreadySet;
+    class InvalidInterestAccrual extends Error {
+        marketId;
+        timestamp;
+        lastUpdate;
+        constructor(marketId, timestamp, lastUpdate) {
+            super(`invalid interest accrual on market ${marketId}: accrual timestamp ${timestamp} can't be prior to last update ${lastUpdate}`);
+            this.marketId = marketId;
+            this.timestamp = timestamp;
+            this.lastUpdate = lastUpdate;
+        }
+    }
+    BlueErrors.InvalidInterestAccrual = InvalidInterestAccrual;
+    class InconsistentInput extends Error {
+        assets;
+        shares;
+        constructor(assets, shares) {
+            super(`inconsistent input assets "${assets}" and shares "${shares}"`);
+            this.assets = assets;
+            this.shares = shares;
+        }
+    }
+    BlueErrors.InconsistentInput = InconsistentInput;
+    class InsufficientLiquidity extends Error {
+        marketId;
+        constructor(marketId) {
+            super(`insufficient liquidity on market ${marketId}`);
+            this.marketId = marketId;
+        }
+    }
+    BlueErrors.InsufficientLiquidity = InsufficientLiquidity;
+    class UnknownOraclePrice extends Error {
+        marketId;
+        constructor(marketId) {
+            super(`unknown oracle price of market "${marketId}"`);
+            this.marketId = marketId;
+        }
+    }
+    BlueErrors.UnknownOraclePrice = UnknownOraclePrice;
+    class InsufficientPosition extends Error {
+        user;
+        marketId;
+        constructor(user, marketId) {
+            super(`insufficient position for user ${user} on market ${marketId}`);
+            this.user = user;
+            this.marketId = marketId;
+        }
+    }
+    BlueErrors.InsufficientPosition = InsufficientPosition;
+    class InsufficientCollateral extends Error {
+        user;
+        marketId;
+        constructor(user, marketId) {
+            super(`insufficient collateral for user ${user} on market ${marketId}`);
+            this.user = user;
+            this.marketId = marketId;
+        }
+    }
+    BlueErrors.InsufficientCollateral = InsufficientCollateral;
+    class ExpiredSignature extends Error {
+        deadline;
+        constructor(deadline) {
+            super(`expired signature deadline "${deadline}"`);
+            this.deadline = deadline;
+        }
+    }
+    BlueErrors.ExpiredSignature = ExpiredSignature;
+})(BlueErrors || (BlueErrors = {}));
+export var VaultV2Errors;
+(function (VaultV2Errors) {
+    class InvalidInterestAccrual extends Error {
+        vault;
+        timestamp;
+        lastUpdate;
+        constructor(vault, timestamp, lastUpdate) {
+            super(`invalid interest accrual on vault ${vault}: accrual timestamp ${timestamp} can't be prior to last update ${lastUpdate}`);
+            this.vault = vault;
+            this.timestamp = timestamp;
+            this.lastUpdate = lastUpdate;
+        }
+    }
+    VaultV2Errors.InvalidInterestAccrual = InvalidInterestAccrual;
+    class UnsupportedLiquidityAdapter extends Error {
+        address;
+        constructor(address) {
+            super(`unsupported liquidity adapter "${address}"`);
+            this.address = address;
+        }
+    }
+    VaultV2Errors.UnsupportedLiquidityAdapter = UnsupportedLiquidityAdapter;
+})(VaultV2Errors || (VaultV2Errors = {}));
+export class UnknownFactory extends Error {
+    constructor() {
+        super(`unknown factory`);
+    }
+}
+export class UnknownOfFactory extends Error {
+    factory;
+    address;
+    constructor(factory, address) {
+        super(`address "${address}" is not from the ${factory} factory`);
+        this.factory = factory;
+        this.address = address;
+    }
+}
+export function _try(accessor, ...errorClasses) {
+    const maybeCatchError = (error) => {
+        if (errorClasses.length === 0 ||
+            errorClasses.some((errorClass) => error instanceof errorClass))
+            return;
+        throw error;
+    };
+    try {
+        const res = accessor();
+        if (res instanceof Promise)
+            return res.catch(maybeCatchError);
+        return res;
+    }
+    catch (error) {
+        return maybeCatchError(error);
+    }
+}

package/lib/esm/holding/AssetBalances.d.ts

@@ -0,0 +1,48 @@
+import type { Token } from "../token/Token.js";
+export type PeripheralBalanceType = "base" | "wrapped" | "staked-wrapped" | "vault" | "wrapped-vault" | "unwrapped-staked-wrapped";
+/**
+ * Represents the balance of a requested token and the balance quoted in the corresponding source token:
+ * ```{
+ *  type: "staked-wrapped",
+ *  srcToken: ETH,
+ *  srcAmount: 1 ETH,
+ *  dstAmount: 1.2 wstETH
+ * }```
+ */
+export interface PeripheralBalance {
+    /**
+     * The type of balance conversion.
+     */
+    type: PeripheralBalanceType;
+    /**
+     * The source token held corresponding to the type of balance conversion.
+     */
+    srcToken: Token;
+    /**
+     * The source amount of source token held.
+     */
+    srcAmount: bigint;
+    /**
+     * The corresponding amount of token held after conversion of the whole balance `srcAmount`.
+     */
+    dstAmount: bigint;
+}
+export interface IAssetBalances extends Omit<PeripheralBalance, "type"> {
+}
+export declare class AssetBalances {
+    /**
+     * The total balance of all types of related tokens.
+     */
+    total: bigint;
+    /**
+     * The balance of each type of related tokens and the corresponding underlying balance.
+     */
+    allocations: {
+        base: PeripheralBalance;
+    } & {
+        [T in Exclude<PeripheralBalanceType, "base">]?: PeripheralBalance;
+    };
+    constructor(balance: IAssetBalances);
+    add(balance: PeripheralBalance): this;
+    sub(balance: PeripheralBalance): this;
+}

package/lib/esm/holding/AssetBalances.js

@@ -0,0 +1,38 @@
+export class AssetBalances {
+    /**
+     * The total balance of all types of related tokens.
+     */
+    total;
+    /**
+     * The balance of each type of related tokens and the corresponding underlying balance.
+     */
+    allocations;
+    constructor(balance) {
+        this.total = balance.dstAmount;
+        this.allocations = {
+            base: { ...balance, type: "base" },
+        };
+    }
+    add(balance) {
+        this.total += balance.dstAmount;
+        const allocation = (this.allocations[balance.type] ??= {
+            ...balance,
+            srcAmount: 0n,
+            dstAmount: 0n,
+        });
+        allocation.srcAmount += balance.srcAmount;
+        allocation.dstAmount += balance.dstAmount;
+        return this;
+    }
+    sub(balance) {
+        this.total -= balance.dstAmount;
+        const allocation = (this.allocations[balance.type] ??= {
+            ...balance,
+            srcAmount: 0n,
+            dstAmount: 0n,
+        });
+        allocation.srcAmount -= balance.srcAmount;
+        allocation.dstAmount -= balance.dstAmount;
+        return this;
+    }
+}

package/lib/esm/holding/Holding.d.ts

@@ -0,0 +1,63 @@
+import type { Address, BigIntish } from "../types.js";
+export declare const ERC20_ALLOWANCE_RECIPIENTS: readonly ["morpho", "permit2", "bundler3.generalAdapter1"];
+export type Erc20AllowanceRecipient = (typeof ERC20_ALLOWANCE_RECIPIENTS)[number];
+export interface Permit2Allowance {
+    amount: bigint;
+    expiration: bigint;
+    nonce: bigint;
+}
+export interface IPermit2Allowance {
+    amount: BigIntish;
+    expiration: BigIntish;
+    nonce: BigIntish;
+}
+export interface IHolding {
+    user: Address;
+    token: Address;
+    erc20Allowances: {
+        [key in Erc20AllowanceRecipient]: bigint;
+    };
+    permit2BundlerAllowance: IPermit2Allowance;
+    erc2612Nonce?: bigint;
+    canTransfer?: boolean;
+    balance: bigint;
+}
+export declare class Holding implements IHolding {
+    /**
+     * The user of this holding.
+     */
+    readonly user: Address;
+    /**
+     * The token in which this holding is denominated.
+     */
+    readonly token: Address;
+    /**
+     * Whether the user is allowed to transfer this holding's balance.
+     */
+    canTransfer?: boolean;
+    /**
+     * ERC20 allowance for this token from the user to the allowance recipient.
+     */
+    readonly erc20Allowances: {
+        [key in Erc20AllowanceRecipient]: bigint;
+    };
+    /**
+     * Permit2 allowance for this token from the user to the allowance recipient.
+     */
+    readonly permit2BundlerAllowance: Permit2Allowance;
+    /**
+     * ERC-2612 Permit nonce of the user for this token.
+     * `undefined` if the token does not support ERC-2612.
+     */
+    erc2612Nonce?: bigint;
+    /**
+     * Allows to customize the setter behavior in child classes.
+     */
+    protected _balance: bigint;
+    constructor({ user, token, erc20Allowances, permit2BundlerAllowance, balance, erc2612Nonce, canTransfer, }: IHolding);
+    /**
+     * The balance of the user for this token.
+     */
+    get balance(): bigint;
+    set balance(value: bigint);
+}

package/lib/esm/holding/Holding.js

@@ -0,0 +1,63 @@
+import { entries, fromEntries } from "@morpho-org/morpho-ts";
+export const ERC20_ALLOWANCE_RECIPIENTS = [
+    "morpho",
+    "permit2",
+    "bundler3.generalAdapter1",
+];
+export class Holding {
+    /**
+     * The user of this holding.
+     */
+    user;
+    /**
+     * The token in which this holding is denominated.
+     */
+    token;
+    /**
+     * Whether the user is allowed to transfer this holding's balance.
+     */
+    canTransfer;
+    /**
+     * ERC20 allowance for this token from the user to the allowance recipient.
+     */
+    erc20Allowances;
+    /**
+     * Permit2 allowance for this token from the user to the allowance recipient.
+     */
+    permit2BundlerAllowance;
+    /**
+     * ERC-2612 Permit nonce of the user for this token.
+     * `undefined` if the token does not support ERC-2612.
+     */
+    erc2612Nonce;
+    /**
+     * Allows to customize the setter behavior in child classes.
+     */
+    _balance;
+    constructor({ user, token, erc20Allowances, permit2BundlerAllowance, balance, erc2612Nonce, canTransfer, }) {
+        this.user = user;
+        this.token = token;
+        this._balance = balance;
+        this.canTransfer = canTransfer;
+        this.erc20Allowances = fromEntries(entries(erc20Allowances).map(([address, allowance]) => [
+            address,
+            allowance,
+        ]));
+        this.permit2BundlerAllowance = {
+            amount: BigInt(permit2BundlerAllowance.amount),
+            expiration: BigInt(permit2BundlerAllowance.expiration),
+            nonce: BigInt(permit2BundlerAllowance.nonce),
+        };
+        if (erc2612Nonce != null)
+            this.erc2612Nonce = erc2612Nonce;
+    }
+    /**
+     * The balance of the user for this token.
+     */
+    get balance() {
+        return this._balance;
+    }
+    set balance(value) {
+        this._balance = value;
+    }
+}

package/lib/esm/holding/index.d.ts

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

package/lib/esm/holding/index.js

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

package/lib/esm/index.d.ts

@@ -0,0 +1,14 @@
+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";
+export * from "./preLiquidation.js";
+export * from "./utils.js";

package/lib/esm/index.js

@@ -0,0 +1,14 @@
+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";
+export * from "./preLiquidation.js";
+export * from "./utils.js";