@morpho-org/blue-sdk 1.0.2 → 1.0.4

package/lib/helpers/locale.d.ts

@@ -0,0 +1,36 @@
+type LocaleSymbols = {
+    decimalSymbol: string;
+    groupSymbol: string;
+    locale: string;
+};
+export type LocaleParts = LocaleSymbols & {
+    value: string;
+};
+/**
+ * @returns the locale symbols for the given locale defaulting to en-US
+ */
+export declare const getLocaleSymbols: (locale: string) => LocaleSymbols;
+/**
+ * @returns the effective browser locale
+ */
+export declare const getEffectiveLocale: () => string;
+/**
+ * @returns the value as a string with the given locale symbols
+ * @param numStr the number as a string in the "from" locale (e.g. "1,2345.6" for en-US)
+ * @param from the locale the numStr is in (e.g. "en-US")
+ * @param to the locale to convert to (e.g. "fr-FR")
+ */
+export declare const convertNumStrToLocal: (numStr: string, from: string, to: string) => string;
+/**
+ * @returns the value as a string in the effective browser locale
+ * @param numStr the number as a string in the effective browser locale (e.g. "1,2345.6" for en-US)
+ * @param to the locale to use (e.g. "fr-FR")
+ */
+export declare const convertNumStrFromEffectiveTo: (numStr: string, to: string) => string;
+/**
+ * @returns the value as a string with the given locale symbols either from the given locale or the effective browser locale
+ * @param numStr the number as a string in english format (e.g. "1,2345.6")
+ * @param locale optional - the locale to use (e.g. "fr-FR")
+ */
+export declare const getEnUSNumberToLocalParts: (numStr: string, locale?: string) => LocaleParts;
+export {};

package/lib/helpers/locale.js

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getEnUSNumberToLocalParts = exports.convertNumStrFromEffectiveTo = exports.convertNumStrToLocal = exports.getEffectiveLocale = exports.getLocaleSymbols = void 0;
+const _convertEnNumStrToLocale = (numStr, localSymbols) => {
+    return numStr
+        .replaceAll(",", "#TEMP#")
+        .replaceAll(".", localSymbols.decimalSymbol)
+        .replaceAll("#TEMP#", localSymbols.groupSymbol);
+};
+/**
+ * @returns the locale symbols for the given locale defaulting to en-US
+ */
+const getLocaleSymbols = (locale) => {
+    let formatter;
+    const formatterOptions = {
+        useGrouping: true,
+        maximumFractionDigits: 1,
+        minimumFractionDigits: 1,
+    };
+    try {
+        formatter = new Intl.NumberFormat(locale, formatterOptions);
+    }
+    catch {
+        formatter = new Intl.NumberFormat("en-US", formatterOptions);
+    }
+    const parts = formatter.formatToParts(12345.6);
+    const decimalSymbol = parts.find((part) => part.type === "decimal").value;
+    const groupSymbol = parts.find((part) => part.type === "group").value;
+    return { decimalSymbol, groupSymbol, locale };
+};
+exports.getLocaleSymbols = getLocaleSymbols;
+/**
+ * @returns the effective browser locale
+ */
+const getEffectiveLocale = () => {
+    if (typeof window !== "undefined") {
+        try {
+            const locale = navigator?.language || document?.documentElement?.lang || "en-US";
+            new Intl.NumberFormat(locale);
+            return locale;
+        }
+        catch (e) {
+            return "en-US";
+        }
+    }
+    return "en-US";
+};
+exports.getEffectiveLocale = getEffectiveLocale;
+/**
+ * @returns the value as a string with the given locale symbols
+ * @param numStr the number as a string in the "from" locale (e.g. "1,2345.6" for en-US)
+ * @param from the locale the numStr is in (e.g. "en-US")
+ * @param to the locale to convert to (e.g. "fr-FR")
+ */
+const convertNumStrToLocal = (numStr, from, to) => {
+    const fromSymbols = (0, exports.getLocaleSymbols)(from);
+    const toSymbols = (0, exports.getLocaleSymbols)(to);
+    return numStr
+        .replaceAll(fromSymbols.groupSymbol, "#GROUP#")
+        .replaceAll(fromSymbols.decimalSymbol, "#DECIMAL#")
+        .replaceAll("#GROUP#", toSymbols.groupSymbol)
+        .replaceAll("#DECIMAL#", toSymbols.decimalSymbol);
+};
+exports.convertNumStrToLocal = convertNumStrToLocal;
+/**
+ * @returns the value as a string in the effective browser locale
+ * @param numStr the number as a string in the effective browser locale (e.g. "1,2345.6" for en-US)
+ * @param to the locale to use (e.g. "fr-FR")
+ */
+const convertNumStrFromEffectiveTo = (numStr, to) => {
+    const from = (0, exports.getEffectiveLocale)();
+    return (0, exports.convertNumStrToLocal)(numStr, from, to);
+};
+exports.convertNumStrFromEffectiveTo = convertNumStrFromEffectiveTo;
+/**
+ * @returns the value as a string with the given locale symbols either from the given locale or the effective browser locale
+ * @param numStr the number as a string in english format (e.g. "1,2345.6")
+ * @param locale optional - the locale to use (e.g. "fr-FR")
+ */
+const getEnUSNumberToLocalParts = (numStr, locale) => {
+    const _locale = locale || (0, exports.getEffectiveLocale)();
+    const localSymbols = (0, exports.getLocaleSymbols)(_locale);
+    const value = _convertEnNumStrToLocale(numStr, localSymbols);
+    return { ...localSymbols, value };
+};
+exports.getEnUSNumberToLocalParts = getEnUSNumberToLocalParts;

package/lib/holding/Holding.d.ts

@@ -0,0 +1,60 @@
+import { BigNumberish } from "ethers";
+import { Address } from "../types";
+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];
+export type Permit2AllowanceRecipient = (typeof PERMIT2_ALLOWANCE_RECIPIENTS)[number];
+export interface Permit2Allowance {
+    amount: bigint;
+    expiration: bigint;
+    nonce: bigint;
+}
+export interface InputHolding {
+    user: Address;
+    token: Address;
+    erc20Allowances: {
+        [key in Erc20AllowanceRecipient]: BigNumberish;
+    };
+    permit2Allowances: {
+        [key in Permit2AllowanceRecipient]: Permit2Allowance;
+    };
+    erc2612Nonce?: BigNumberish;
+    canTransfer?: boolean;
+    balance: BigNumberish;
+}
+export declare class Holding implements InputHolding {
+    /**
+     * The user of this holding.
+     */
+    readonly user: Address;
+    /**
+     * The token in which this holding is denominated.
+     */
+    readonly token: Address;
+    /**
+     * The balance of the user for this token.
+     */
+    balance: bigint;
+    /**
+     * 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 permit2Allowances: {
+        [key in Permit2AllowanceRecipient]: Permit2Allowance;
+    };
+    /**
+     * ERC-2612 Permit nonce of the user for this token.
+     * `undefined` if the token does not support ERC-2612.
+     */
+    erc2612Nonce?: bigint;
+    constructor({ user, token, erc20Allowances, permit2Allowances, balance, erc2612Nonce, canTransfer, }: InputHolding);
+}

package/lib/holding/Holding.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Holding = exports.PERMIT2_ALLOWANCE_RECIPIENTS = exports.ERC20_ALLOWANCE_RECIPIENTS = void 0;
+const ethers_1 = require("ethers");
+const morpho_ts_1 = require("@morpho-org/morpho-ts");
+const addresses_1 = require("../addresses");
+exports.ERC20_ALLOWANCE_RECIPIENTS = [
+    "morpho",
+    "permit2",
+    "bundler",
+];
+exports.PERMIT2_ALLOWANCE_RECIPIENTS = [
+    "morpho",
+    "bundler",
+];
+class Holding {
+    constructor({ user, token, erc20Allowances, permit2Allowances, balance, erc2612Nonce, canTransfer = true, }) {
+        this.user = user;
+        this.token = token;
+        this.balance = (0, ethers_1.toBigInt)(balance);
+        this.canTransfer = token === addresses_1.NATIVE_ADDRESS || canTransfer;
+        this.erc20Allowances = (0, morpho_ts_1.fromEntries)((0, morpho_ts_1.entries)(erc20Allowances).map(([address, allowance]) => [
+            address,
+            (0, ethers_1.toBigInt)(allowance),
+        ]));
+        this.permit2Allowances = permit2Allowances;
+        if (erc2612Nonce != null)
+            this.erc2612Nonce = (0, ethers_1.toBigInt)(erc2612Nonce);
+    }
+}
+exports.Holding = Holding;

package/lib/holding/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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);

package/{src/index.ts → lib/index.d.ts}

@@ -15,7 +15,6 @@ export * from "./position";
 export * from "./helpers";
 export * from "./ethers";
 export * from "./vault";
-
 export * as evm from "./evm";
 export * as constants from "./constants";
 export * as errors from "./errors";

package/lib/index.js

@@ -0,0 +1,62 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    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.ethers = exports.helpers = exports.user = exports.signatures = exports.notifications = exports.maths = exports.types = exports.holding = exports.position = exports.token = exports.chain = exports.market = exports.errors = exports.constants = exports.evm = void 0;
+__exportStar(require("./addresses"), exports);
+__exportStar(require("./evm"), 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("./notifications"), exports);
+__exportStar(require("./signatures"), exports);
+__exportStar(require("./user"), exports);
+__exportStar(require("./holding"), exports);
+__exportStar(require("./position"), exports);
+__exportStar(require("./helpers"), exports);
+__exportStar(require("./ethers"), exports);
+__exportStar(require("./vault"), exports);
+exports.evm = __importStar(require("./evm"));
+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.notifications = __importStar(require("./notifications"));
+exports.signatures = __importStar(require("./signatures"));
+exports.user = __importStar(require("./user"));
+exports.helpers = __importStar(require("./helpers"));
+exports.ethers = __importStar(require("./ethers"));
+exports.vault = __importStar(require("./vault"));

package/lib/market/Market.d.ts

@@ -0,0 +1,159 @@
+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 { MarketConfig } from "./MarketConfig";
+export declare enum CapacityLimitReason {
+    liquidity = "Liquidity",
+    balance = "Balance",
+    position = "Position",
+    collateral = "Collateral",
+    cap = "Cap"
+}
+export interface CapacityLimit {
+    value: bigint;
+    limiter: CapacityLimitReason;
+}
+export interface MaxPositionCapacities {
+    supply: CapacityLimit;
+    withdraw: CapacityLimit;
+    borrow: CapacityLimit;
+    repay: CapacityLimit;
+    supplyCollateral: CapacityLimit;
+    withdrawCollateral: CapacityLimit;
+}
+export interface InputMarket {
+    config: MarketConfig;
+    totalSupplyAssets: BigNumberish;
+    totalBorrowAssets: BigNumberish;
+    totalSupplyShares: BigNumberish;
+    totalBorrowShares: BigNumberish;
+    lastUpdate: BigNumberish;
+    fee: BigNumberish;
+    price: BigNumberish;
+    rateAtTarget?: BigNumberish;
+}
+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.
+     */
+    readonly config: MarketConfig;
+    /**
+     * The amount of loan assets supplied in total on the market.
+     */
+    totalSupplyAssets: bigint;
+    /**
+     * The amount of loan assets supplied in total on the market.
+     */
+    totalBorrowAssets: bigint;
+    /**
+     * The amount of loan assets supplied in total on the market.
+     */
+    totalSupplyShares: bigint;
+    /**
+     * The amount of loan assets supplied in total on the market.
+     */
+    totalBorrowShares: bigint;
+    /**
+     * The block timestamp (in __seconds__) when the interest was last accrued.
+     */
+    lastUpdate: bigint;
+    /**
+     * The fee percentage of the market, scaled by WAD.
+     */
+    fee: bigint;
+    /**
+     * The price as returned by the market's oracle.
+     */
+    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);
+    get id(): MarketId;
+    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;
+    get utilization(): bigint;
+    get apyAtTarget(): bigint | undefined;
+    get supplyRate(): bigint;
+    get borrowRate(): bigint;
+    get supplyApy(): bigint;
+    get borrowApy(): bigint;
+    accrueInterest(timestamp: BigNumberish): Market;
+    getLiquidityToUtilization(utilization: BigNumberish): bigint;
+    getCollateralValue(collateral: BigNumberish): bigint;
+    getMaxBorrowAssets(collateral: BigNumberish): bigint;
+    getMaxBorrowableAssets(position: {
+        collateral: BigNumberish;
+        borrowShares: BigNumberish;
+    }): bigint;
+    getLiquidationSeizedAssets(repaidShares: BigNumberish): bigint;
+    getLiquidationRepaidShares(seizedAssets: BigNumberish): bigint;
+    getSeizableCollateral(position: {
+        collateral: BigNumberish;
+        borrowShares: BigNumberish;
+    }): bigint;
+    getWithdrawableCollateral(position: {
+        collateral: BigNumberish;
+        borrowShares: BigNumberish;
+    }): bigint;
+    isHealthy(position: {
+        collateral: BigNumberish;
+        borrowShares: BigNumberish;
+    }): boolean;
+    getLiquidationPrice(position: {
+        collateral: BigNumberish;
+        borrowShares: BigNumberish;
+    }): bigint | null;
+    getPriceVariationToLiquidation(position: {
+        collateral: BigNumberish;
+        borrowShares: BigNumberish;
+    }): bigint | null;
+    getHealthFactor(position: {
+        collateral: BigNumberish;
+        borrowShares: BigNumberish;
+    }): bigint | null;
+    getLtv(position: {
+        collateral: BigNumberish;
+        borrowShares: BigNumberish;
+    }): bigint | null;
+    getBorrowCapacityUsage(position: {
+        collateral: BigNumberish;
+        borrowShares: BigNumberish;
+    }): 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;
+    getRepayCapacityLimit(borrowShares: bigint, loanTokenBalance: bigint): CapacityLimit;
+    getWithdrawCapacityLimit(supplyShares: bigint): CapacityLimit;
+    getWithdrawCollateralCapacityLimit(position: {
+        collateral: bigint;
+        borrowShares: bigint;
+    }): CapacityLimit;
+    getMaxCapacities(position: {
+        collateral: bigint;
+        supplyShares: bigint;
+        borrowShares: bigint;
+    }, loanTokenBalance: bigint, collateralTokenBalance: bigint): MaxPositionCapacities;
+}