@morpho-org/blue-common

@morpho-org/blue-sdk

Ethers-based SDK foundational to Morpho Blue's offchain ecosystem, useful to fetch and interact with the protocol and MetaMorpho.

Install

npm install @morpho-org/blue-sdk

yarn add @morpho-org/blue-sdk

Getting Started

Fetch the config of a specific market

Leverage the MarketConfig class to fetch and query minimal information on a given market's immutable configuration:

import { MarketConfig } from "@morpho-org/blue-sdk";

const config = MarketConfig.fetch(
  "0xb323495f7e4148be5643a4ea4a8221eef163e4bccfdedc2a6f4696baacbc86cc",
  provider // Ethers provider.
);

market.collateralToken; // e.g. 0x7f39C581F595B53c5cb19bD0b3f8dA6c935E2Ca0.

Fetch data of a specific market

Leverage the Market class to fetch and query useful information on a specific market:

import { Market } from "@morpho-org/blue-sdk";
import { Time } from "@morpho-org/morpho-ts";

const market = Market.fetchFromId(
  "0xb323495f7e4148be5643a4ea4a8221eef163e4bccfdedc2a6f4696baacbc86cc",
  provider // Ethers provider.
);

// Or from a config, to fetch faster:
// const market = Market.fetchFromConfig(
//   config,
//   provider // Ethers provider.
// );

market.utilization; // e.g. 92% (scaled by WAD).
market.liquidity; // e.g. 23_000000n (in loan assets).
market.apyAtTarget; // e.g. 3% (scaled by WAD).

const accruedMarket = market.accrueInterest(Time.timestamp()); // Accrue interest to the latest's timestamp.

accruedMarket.toSupplyAssets(shares); // Convert supply shares to assets.

Fetch data on the position of a specific user on a specific market

Leverage the Position class to fetch and query useful information about the position of a user on a given market:

import { Position } from "@morpho-org/blue-sdk";
import { Time } from "@morpho-org/morpho-ts";

const position = AccrualPosition.fetchFromId(
  "0x7f65e7326F22963e2039734dDfF61958D5d284Ca",
  "0xb323495f7e4148be5643a4ea4a8221eef163e4bccfdedc2a6f4696baacbc86cc",
  provider // Ethers provider.
);

// Or from a config, to fetch faster:
// const position = AccrualPosition.fetchFromConfig(
//   "0x7f65e7326F22963e2039734dDfF61958D5d284Ca",
//   config,
//   provider // Ethers provider.
// );

position.borrowAssets; // e.g. 23_000000n (in loan assets).
position.isHealthy; // e.g. true.
position.maxBorrowableAssets; // e.g. 2100_000000n (in loan assets).

const accruedPosition = position.accrueInterest(Time.timestamp()); // Accrue interest to the latest's timestamp.

position.borrowAssets; // e.g. 23_500000n (in loan assets).