@morpho-org/blue-sdk 1.0.2 → 1.0.4

package/src/maths/MathLib.ts

@@ -1,208 +0,0 @@
-import { BigNumberish, formatUnits, parseUnits, toBigInt } from "ethers";
-
-import { Time } from "@morpho-org/morpho-ts";
-
-export type RoundingDirection = "Up" | "Down";
-
-/**
- * Library to manage fixed-point arithmetic.
- * This library reproduces the behaviour of the solidity library MathLib
- * TODO: add library link
- * @category Maths
- *
- */
-export class MathLib {
-  static WAD = parseUnits("1");
-  static MAX_UINT_160 = BigInt("0x" + "f".repeat(40));
-  static MAX_UINT_128 = BigInt("0x" + "f".repeat(32));
-  static MAX_UINT_48 = BigInt("0x" + "f".repeat(12));
-
-  /**
-   * Returns the smallest number given as param
-   * @param x The first number
-   * @param y The second number
-   */
-  static min(x: BigNumberish, y: BigNumberish): bigint {
-    x = toBigInt(x);
-    y = toBigInt(y);
-
-    return x <= y ? x : y;
-  }
-
-  /**
-   * Returns the greatest number given as param
-   * @param x The first number
-   * @param y The second number
-   */
-  static max(x: BigNumberish, y: BigNumberish): bigint {
-    x = toBigInt(x);
-    y = toBigInt(y);
-
-    return x <= y ? y : x;
-  }
-
-  /**
-   * Perform the WAD-based multiplication of 2 numbers, rounded down
-   * @param x The first number
-   * @param y The second number
-   */
-  static wMulDown(x: BigNumberish, y: BigNumberish): bigint {
-    x = toBigInt(x);
-    y = toBigInt(y);
-
-    return MathLib.wMul(x, y, "Down");
-  }
-
-  /**
-   * Perform the WAD-based multiplication of 2 numbers, rounded up
-   * @param x The first number
-   * @param y The second number
-   */
-  static wMulUp(x: BigNumberish, y: BigNumberish): bigint {
-    x = toBigInt(x);
-    y = toBigInt(y);
-
-    return MathLib.wMul(x, y, "Up");
-  }
-
-  /**
-   * Perform the WAD-based multiplication of 2 numbers with a provided rounding direction
-   * @param x The first number
-   * @param y The second number
-   */
-  static wMul(x: bigint, y: bigint, rounding: RoundingDirection): bigint {
-    return MathLib.mulDiv(x, y, MathLib.WAD, rounding);
-  }
-
-  /**
-   * Perform the WAD-based division of 2 numbers, rounded down
-   * @param x The first number
-   * @param y The second number
-   */
-  static wDivDown(x: BigNumberish, y: BigNumberish): bigint {
-    x = toBigInt(x);
-    y = toBigInt(y);
-
-    return MathLib.wDiv(x, y, "Down");
-  }
-
-  /**
-   * Perform the WAD-based multiplication of 2 numbers, rounded up
-   * @param x The first number
-   * @param y The second number
-   */
-  static wDivUp(x: BigNumberish, y: BigNumberish): bigint {
-    x = toBigInt(x);
-    y = toBigInt(y);
-
-    return MathLib.wDiv(x, y, "Up");
-  }
-
-  /**
-   * Perform the WAD-based multiplication of 2 numbers with a provided rounding direction
-   * @param x The first number
-   * @param y The second number
-   */
-  static wDiv(
-    x: BigNumberish,
-    y: BigNumberish,
-    rounding: RoundingDirection
-  ): bigint {
-    return MathLib.mulDiv(x, MathLib.WAD, y, rounding);
-  }
-
-  /**
-   * Multiply two numbers and divide by a denominator, rounding down the result
-   * @param x The first number
-   * @param y The second number
-   * @param denominator The denominator
-   */
-  static mulDivDown(
-    x: BigNumberish,
-    y: BigNumberish,
-    denominator: BigNumberish
-  ): bigint {
-    x = toBigInt(x);
-    y = toBigInt(y);
-    denominator = toBigInt(denominator);
-
-    if (denominator === 0n) throw Error("MathLib: DIVISION_BY_ZERO");
-
-    return (x * y) / denominator;
-  }
-
-  /**
-   * Multiply two numbers and divide by a denominator, rounding up the result
-   * @param x The first number
-   * @param y The second number
-   * @param denominator The denominator
-   */
-  static mulDivUp(
-    x: BigNumberish,
-    y: BigNumberish,
-    denominator: BigNumberish
-  ): bigint {
-    x = toBigInt(x);
-    y = toBigInt(y);
-    denominator = toBigInt(denominator);
-
-    if (denominator === 0n) throw Error("MathLib: DIVISION_BY_ZERO");
-
-    const roundup = (x * y) % denominator > 0 ? 1n : 0n;
-
-    return (x * y) / denominator + roundup;
-  }
-
-  static mulDiv(
-    x: BigNumberish,
-    y: BigNumberish,
-    denominator: BigNumberish,
-    rounding: RoundingDirection
-  ) {
-    return MathLib[`mulDiv${rounding}`](x, y, denominator);
-  }
-
-  /**
-   * The sum of the first three non-zero terms of a Taylor expansion of e^(nx) - 1,
-   * to approximate a continuous compound interest rate.
-   *
-   * @param x The base of the exponent
-   * @param n The exponent
-   */
-  static wTaylorCompounded(x: BigNumberish, n: BigNumberish) {
-    x = toBigInt(x);
-    n = toBigInt(n);
-
-    const firstTerm = x * n;
-    const secondTerm = MathLib.mulDivDown(
-      firstTerm,
-      firstTerm,
-      2n * MathLib.WAD
-    );
-    const thirdTerm = MathLib.mulDivDown(
-      secondTerm,
-      firstTerm,
-      3n * MathLib.WAD
-    );
-
-    return firstTerm + secondTerm + thirdTerm;
-  }
-
-  /**
-   * Converts an apr to compounded apy
-   *
-   * @param apr The apr to convert (in WAD)
-   * @param compounding The compounding basis
-   */
-  static aprToApy(apr: bigint, compounding: Time.Unit) {
-    const factor = Time[compounding].from.y(1n);
-
-    const rate = apr / factor;
-
-    return (
-      parseUnits(
-        ((+formatUnits(this.WAD + rate)) ** Number(factor)).toFixed(18)
-      ) - this.WAD
-    );
-  }
-}

package/src/maths/MathUtils.ts

@@ -1,31 +0,0 @@
-/**
- * Math utilities
- * This library reproduces the behaviour of the solidity library MathUtils
- * TODO: add library link
- * @category Maths
- */
-export class MathUtils {
-  static zeroFloorSub(a: bigint, b: bigint): bigint {
-    return a - b < 0n ? 0n : a - b;
-  }
-
-  static min(a: bigint, b: bigint): bigint {
-    return a < b ? a : b;
-  }
-  static mins(...args: bigint[]): bigint {
-    return args.reduce((a, b) => this.min(a, b));
-  }
-  static max(a: bigint, b: bigint): bigint {
-    return a > b ? a : b;
-  }
-  static pos(a: bigint): bigint {
-    return a >= 0n ? a : 0n;
-  }
-  static neg(a: bigint): bigint {
-    return a < 0n ? -a : 0n;
-  }
-
-  static abs(a: bigint): bigint {
-    return a >= 0 ? a : -a;
-  }
-}

package/src/maths/SharesMath.ts

@@ -1,40 +0,0 @@
-import { BigNumberish, toBigInt } from "ethers";
-
-import { MathLib, RoundingDirection } from "./MathLib";
-
-/**
- * JS implementation of {@link https://github.com/morpho-org/morpho-blue/blob/main/src/libraries/SharesMathLib.sol SharesMathLib} used by Morpho Blue
- * & MetaMorpho (via {@link https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/contracts/token/ERC20/extensions/ERC4626.sol ERC4626}).
- */
-export namespace SharesMath {
-  export const VIRTUAL_SHARES = 1000000n;
-  export const VIRTUAL_ASSETS = 1n;
-
-  export function toAssets(
-    shares: BigNumberish,
-    totalAssets: BigNumberish,
-    totalShares: BigNumberish,
-    rounding: RoundingDirection
-  ) {
-    return MathLib.mulDiv(
-      shares,
-      toBigInt(totalAssets) + VIRTUAL_ASSETS,
-      toBigInt(totalShares) + VIRTUAL_SHARES,
-      rounding
-    );
-  }
-
-  export function toShares(
-    assets: BigNumberish,
-    totalAssets: BigNumberish,
-    totalShares: BigNumberish,
-    rounding: RoundingDirection
-  ) {
-    return MathLib.mulDiv(
-      assets,
-      toBigInt(totalShares) + VIRTUAL_SHARES,
-      toBigInt(totalAssets) + VIRTUAL_ASSETS,
-      rounding
-    );
-  }
-}

package/src/notifications.ts

@@ -1,167 +0,0 @@
-import {
-  Signature,
-  TransactionReceipt,
-  TransactionRequest,
-  TransactionResponse,
-} from "ethers";
-import { Observable, Observer, ReplaySubject, lastValueFrom } from "rxjs";
-
-import { SignatureMessage } from "./signatures/types";
-
-export enum NotificationStatus {
-  signing = "signing",
-  success = "success",
-  error = "error",
-  pending = "pending",
-}
-
-export enum NotificationTopic {
-  tx = "tx",
-  signature = "signature",
-}
-
-export interface NotificationContext {
-  [NotificationTopic.tx]: {
-    [NotificationStatus.signing]: {
-      tx: TransactionRequest;
-    };
-    [NotificationStatus.pending]: {
-      args: Record<PropertyKey, any>;
-      tx: TransactionRequest;
-      response?: TransactionResponse;
-    };
-    [NotificationStatus.success]: {
-      args: Record<PropertyKey, any>;
-      tx: TransactionRequest;
-      response?: TransactionResponse;
-      receipt: TransactionReceipt | null;
-    };
-    [NotificationStatus.error]: {
-      args: Record<PropertyKey, any>;
-      tx: TransactionRequest;
-      response?: TransactionResponse;
-      error: Error;
-    };
-  };
-  [NotificationTopic.signature]: {
-    [NotificationStatus.signing]: never;
-    [NotificationStatus.pending]: {
-      message: SignatureMessage;
-      args: Record<PropertyKey, any>;
-    };
-    [NotificationStatus.success]: {
-      message: SignatureMessage;
-      args: Record<PropertyKey, any>;
-      signature: Signature;
-    };
-    [NotificationStatus.error]: {
-      message: SignatureMessage;
-      args: Record<PropertyKey, any>;
-      error: Error;
-    };
-  };
-}
-
-export interface NotificationBody<
-  Topic extends NotificationTopic = NotificationTopic,
-  Status extends NotificationStatus = NotificationStatus
-> {
-  id: string;
-  topic: Topic;
-  status: Status;
-}
-
-export type Notifications = {
-  [Topic in NotificationTopic]: {
-    [Status in NotificationStatus]: NotificationBody<Topic, Status> &
-      (NotificationContext[Topic][Status] extends never
-        ? unknown
-        : { context: NotificationContext[Topic][Status] });
-  };
-};
-
-export type TxNotification =
-  Notifications[NotificationTopic.tx][NotificationStatus];
-export type SignatureNotification =
-  Notifications[NotificationTopic.signature][NotificationStatus];
-export type Notification = Notifications[NotificationTopic][NotificationStatus];
-
-export type NotificationsWithoutTopic = {
-  [Topic in NotificationTopic]: {
-    [Status in NotificationStatus]: Omit<
-      NotificationBody<Topic, Status>,
-      "topic"
-    > &
-      (NotificationContext[Topic][Status] extends never
-        ? unknown
-        : { context: NotificationContext[Topic][Status] });
-  };
-};
-
-export interface NotificationConsumer<Topic extends NotificationTopic> {
-  notifications$: Observable<Notifications[Topic][NotificationStatus]>;
-  wait: (
-    observerOrNext?:
-      | Partial<Observer<Notifications[Topic][NotificationStatus]>>
-      | ((value: Notifications[Topic][NotificationStatus]) => void)
-  ) => Promise<
-    Notifications[Topic][NotificationStatus.success | NotificationStatus.error]
-  >;
-}
-
-/**
- * MUST receive a success or error notification at some point to ensure the result promise resolves.
- */
-export class NotificationProducer<Topic extends NotificationTopic> {
-  protected readonly _notifications$ = new ReplaySubject<
-    Notifications[Topic][NotificationStatus]
-  >(Infinity);
-  public readonly notifications$ = this._notifications$.asObservable();
-
-  protected readonly _result = lastValueFrom(this._notifications$);
-
-  public readonly consumer: NotificationConsumer<Topic> = {
-    notifications$: this.notifications$,
-    wait: this.wait.bind(this),
-  };
-
-  /**
-   * Creates a notification producer.
-   * MUST receive a success or error notification at some point to ensure the result promise resolves.
-   * @param topic The notification topic to populate each notification with.
-   */
-  constructor(public readonly topic: Topic) {}
-
-  public async wait(
-    observerOrNext?:
-      | Partial<Observer<Notifications[Topic][NotificationStatus]>>
-      | ((value: Notifications[Topic][NotificationStatus]) => void)
-  ) {
-    const subscription = this.notifications$.subscribe(observerOrNext);
-
-    const notification = (await this._result) as unknown as Promise<
-      Notifications[Topic][
-        | NotificationStatus.success
-        | NotificationStatus.error]
-    >;
-
-    subscription.unsubscribe();
-
-    return notification;
-  }
-
-  public next(
-    notification: NotificationsWithoutTopic[Topic][NotificationStatus]
-  ) {
-    this._notifications$.next({
-      ...notification,
-      topic: this.topic,
-    } as unknown as Notifications[Topic][NotificationStatus]);
-
-    if (
-      notification.status === NotificationStatus.success ||
-      notification.status === NotificationStatus.error
-    )
-      this._notifications$.complete();
-  }
-}

package/src/position/Position.ts

@@ -1,251 +0,0 @@
-import { BigNumberish, Provider, toBigInt } from "ethers";
-import { MorphoBlue__factory } from "ethers-types";
-import { ViewOverrides } from "ethers-types/dist/common";
-
-import { getChainAddresses } from "../addresses";
-import { ChainId, ChainUtils } from "../chain";
-import { Market, MarketConfig } from "../market";
-import { Address, MarketId } from "../types";
-
-export interface InputPosition {
-  user: Address;
-  marketId: MarketId;
-  supplyShares: BigNumberish;
-  borrowShares: BigNumberish;
-  collateral: BigNumberish;
-}
-
-export class Position implements InputPosition {
-  static async fetch(
-    user: Address,
-    marketId: MarketId,
-    runner: { provider: Provider },
-    {
-      chainId,
-      overrides = {},
-    }: { chainId?: ChainId; overrides?: ViewOverrides } = {}
-  ) {
-    chainId ??= ChainUtils.parseSupportedChainId(
-      (await runner.provider.getNetwork()).chainId
-    );
-    const { morpho } = getChainAddresses(chainId);
-
-    const { supplyShares, borrowShares, collateral } =
-      await MorphoBlue__factory.connect(morpho, runner).position(
-        marketId,
-        user,
-        overrides
-      );
-
-    return new Position({
-      user,
-      marketId,
-      supplyShares,
-      borrowShares,
-      collateral,
-    });
-  }
-
-  /**
-   * The user holding this position.
-   */
-  public readonly user: Address;
-
-  /**
-   * The id of the market on which this position is held.
-   */
-  public readonly marketId: MarketId;
-
-  /**
-   * The amount of supply shares held with this position.
-   */
-  public supplyShares: bigint;
-  /**
-   * The amount of borrow shares held with this position.
-   */
-  public borrowShares: bigint;
-  /**
-   * The amount of collateral assets held with this position.
-   */
-  public collateral: bigint;
-
-  constructor({
-    user,
-    marketId,
-    supplyShares,
-    borrowShares,
-    collateral,
-  }: InputPosition) {
-    this.user = user;
-    this.marketId = marketId;
-    this.supplyShares = toBigInt(supplyShares);
-    this.borrowShares = toBigInt(borrowShares);
-    this.collateral = toBigInt(collateral);
-  }
-}
-
-export interface InputAccrualPosition extends Omit<InputPosition, "marketId"> {}
-
-export class AccrualPosition extends Position implements InputAccrualPosition {
-  static async fetchFromId(
-    user: Address,
-    marketId: MarketId,
-    runner: { provider: Provider },
-    options: { chainId?: ChainId; overrides?: ViewOverrides }
-  ) {
-    const [position, market] = await Promise.all([
-      await Position.fetch(user, marketId, runner, options),
-      await Market.fetchFromId(marketId, runner, options),
-    ]);
-
-    return new AccrualPosition(position, market);
-  }
-
-  static async fetchFromConfig(
-    user: Address,
-    config: MarketConfig,
-    runner: { provider: Provider },
-    options: { chainId?: ChainId; overrides?: ViewOverrides }
-  ) {
-    const [position, market] = await Promise.all([
-      await Position.fetch(user, config.id, runner, options),
-      await Market.fetchFromConfig(config, runner, options),
-    ]);
-
-    return new AccrualPosition(position, market);
-  }
-
-  /**
-   * The market on which this position is held.
-   */
-  public readonly market: Market;
-
-  constructor(position: InputAccrualPosition, market: Market) {
-    super({ ...position, marketId: market.id });
-
-    this.market = market;
-  }
-
-  get supplyAssets() {
-    return this.market.toSupplyAssets(this.supplyShares);
-  }
-
-  get borrowAssets() {
-    return this.market.toBorrowAssets(this.borrowShares);
-  }
-
-  /**
-   * The value of this position's collateral quoted in loan assets.
-   */
-  get collateralValue() {
-    return this.market.getCollateralValue(this.collateral);
-  }
-
-  /**
-   * The maximum amount of loan assets that can be borrowed against this position's collateral.
-   */
-  get maxBorrowAssets() {
-    return this.market.getMaxBorrowAssets(this.collateral);
-  }
-
-  /**
-   * The maximum additional amount of assets that can be borrowed against this position's collateral.
-   */
-  get maxBorrowableAssets() {
-    return this.market.getMaxBorrowableAssets(this);
-  }
-
-  /**
-   * The maximum amount of collateral that can be seized in exchange for the outstanding debt.
-   */
-  get seizableCollateral() {
-    return this.market.getSeizableCollateral(this);
-  }
-
-  /**
-   * The maximum amount of collateral that can be withdrawn.
-   */
-  get withdrawableCollateral() {
-    return this.market.getWithdrawableCollateral(this);
-  }
-
-  /**
-   * Whether this position is healthy.
-   */
-  get isHealthy() {
-    return this.market.isHealthy(this);
-  }
-
-  /**
-   * The price of the collateral quoted in loan assets that would allow this position to be liquidated.
-   */
-  get liquidationPrice() {
-    return this.market.getLiquidationPrice(this);
-  }
-
-  /**
-   * The variation of the price of the collateral quoted in loan assets that would allow this position to be liquidated,
-   * relative to the current collateral price (scaled by WAD).
-   */
-  get priceVariationToLiquidation() {
-    return this.market.getPriceVariationToLiquidation(this);
-  }
-
-  /**
-   * This position's Loan-To-Value (debt over collateral power, scaled by WAD).
-   * If the collateral price is 0, LTV is `MaxUint256`.
-   */
-  get ltv() {
-    return this.market.getLtv(this);
-  }
-
-  /**
-   * This position's health factor (collateral power over debt, scaled by WAD).
-   * If the debt is 0, health factor is `MaxUint256`.
-   */
-  get healthFactor() {
-    return this.market.getHealthFactor(this);
-  }
-
-  /**
-   * The percentage of this position's borrow power currently used (scaled by WAD).
-   * If the collateral price is 0, usage is `MaxUint256`.
-   */
-  get borrowCapacityUsage() {
-    return this.market.getBorrowCapacityUsage(this);
-  }
-
-  get borrowCapacityLimit() {
-    return this.market.getBorrowCapacityLimit(this.collateral);
-  }
-
-  get withdrawCapacityLimit() {
-    return this.market.getWithdrawCapacityLimit(this.supplyShares);
-  }
-
-  get withdrawCollateralCapacityLimit() {
-    return this.market.getWithdrawCollateralCapacityLimit(this);
-  }
-
-  public accrueInterest(timestamp: BigNumberish) {
-    return new AccrualPosition(this, this.market.accrueInterest(timestamp));
-  }
-
-  public getRepayCapacityLimit(loanTokenBalance: bigint) {
-    return this.market.getRepayCapacityLimit(
-      this.borrowShares,
-      loanTokenBalance
-    );
-  }
-
-  public getMaxCapacities(
-    loanTokenBalance: bigint,
-    collateralTokenBalance: bigint
-  ) {
-    return this.market.getMaxCapacities(
-      this,
-      loanTokenBalance,
-      collateralTokenBalance
-    );
-  }
-}

package/src/signatures/index.ts

@@ -1,18 +0,0 @@
-import * as _Manager from "./manager";
-import * as _Permit from "./permit";
-import * as _Permit2 from "./permit2";
-import {
-  safeSignTypedData as _safeSignTypedData,
-  verifySignature as _verifySignature,
-  getMessage as _getMessage,
-} from "./utils";
-
-export namespace SignatureUtils {
-  export import Permit = _Permit;
-  export import Permit2 = _Permit2;
-  export import Manager = _Manager;
-
-  export const safeSignTypedData = _safeSignTypedData;
-  export const verifySignature = _verifySignature;
-  export const getMessage = _getMessage;
-}