@morpho-org/blue-sdk 1.0.0-integ-650.0

package/lib/helpers/locale.js

@@ -0,0 +1,96 @@
+"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
+ *
+ * @deprecated Import from `@morpho-org/morpho-ts`
+ */
+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
+ *
+ * @deprecated Import from `@morpho-org/morpho-ts`
+ */
+const getEffectiveLocale = () => {
+    if (typeof window !== "undefined") {
+        try {
+            const locale = navigator?.language || document?.documentElement?.lang || "en-US";
+            new Intl.NumberFormat(locale);
+            return locale;
+        }
+        catch {
+            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")
+ *
+ * @deprecated Import from `@morpho-org/morpho-ts`
+ */
+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")
+ *
+ * @deprecated Import from `@morpho-org/morpho-ts`
+ */
+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")
+ *
+ * @deprecated Import from `@morpho-org/morpho-ts`
+ */
+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/AssetBalances.d.ts

@@ -0,0 +1,48 @@
+import { Token } from "../token/Token";
+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 InputAssetBalances 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: InputAssetBalances);
+    add(balance: PeripheralBalance): this;
+    sub(balance: PeripheralBalance): this;
+}

package/lib/holding/AssetBalances.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AssetBalances = void 0;
+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;
+    }
+}
+exports.AssetBalances = AssetBalances;

package/lib/holding/Holding.d.ts

@@ -0,0 +1,59 @@
+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]: bigint;
+    };
+    permit2Allowances: {
+        [key in Permit2AllowanceRecipient]: Permit2Allowance;
+    };
+    erc2612Nonce?: bigint;
+    canTransfer?: boolean;
+    balance: bigint;
+}
+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,59 @@
+"use strict";
+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",
+    "bundler",
+];
+exports.PERMIT2_ALLOWANCE_RECIPIENTS = [
+    "morpho",
+    "bundler",
+];
+class Holding {
+    /**
+     * The user of this holding.
+     */
+    user;
+    /**
+     * The token in which this holding is denominated.
+     */
+    token;
+    /**
+     * The balance of the user for this token.
+     */
+    balance;
+    /**
+     * 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.
+     */
+    permit2Allowances;
+    /**
+     * ERC-2612 Permit nonce of the user for this token.
+     * `undefined` if the token does not support ERC-2612.
+     */
+    erc2612Nonce;
+    constructor({ user, token, erc20Allowances, permit2Allowances, balance, erc2612Nonce, canTransfer = true, }) {
+        this.user = user;
+        this.token = token;
+        this.balance = 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,
+            allowance,
+        ]));
+        this.permit2Allowances = permit2Allowances;
+        if (erc2612Nonce != null)
+            this.erc2612Nonce = erc2612Nonce;
+    }
+}
+exports.Holding = Holding;

package/lib/holding/index.d.ts

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

package/lib/holding/index.js

@@ -0,0 +1,18 @@
+"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);
+__exportStar(require("./AssetBalances"), exports);

package/lib/index.d.ts

@@ -0,0 +1,25 @@
+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";

package/lib/index.js

@@ -0,0 +1,54 @@
+"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.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"));