@morpho-org/blue-sdk 1.2.1 → 1.2.3

package/README.md

@@ -3,7 +3,7 @@
 [![npm package][npm-img]][npm-url]
 [![Downloads][downloads-img]][downloads-url]
 
-> Ethers-based SDK foundational to Morpho Blue's offchain ecosystem, useful to fetch and interact with the protocol and MetaMorpho.
+Framework-agnostic SDK foundational to Morpho Blue's offchain ecosystem, useful to fetch and interact with Morpho Blue and MetaMorpho.
 
 ## Install
 
@@ -19,77 +19,85 @@ yarn add @morpho-org/blue-sdk
 
 ## Getting Started
 
-### Fetch the config of a specific market
+### Instance of the immutable configuration of a specific market
 
-Leverage the [`MarketConfig`](./src/market/MarketConfig.ts) class to fetch and query minimal information on a given market's immutable configuration:
+Leverage the [`MarketConfig`](./src/market/MarketConfig.ts) class to manipulate a given market's immutable configuration:
 
 ```typescript
 import { MarketConfig } from "@morpho-org/blue-sdk";
 
-const config = MarketConfig.fetch(
-  "0xb323495f7e4148be5643a4ea4a8221eef163e4bccfdedc2a6f4696baacbc86cc",
-  provider // Ethers provider.
-);
+const config = new MarketConfig({
+  loanToken: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",       // WETH
+  collateralToken: "0x7f39C581F595B53c5cb19bD0b3f8dA6c935E2Ca0", // wstETH
+  oracle: "0x2a01EB9496094dA03c4E364Def50f5aD1280AD72",
+  irm: "0x870aC11D48B15DB9a138Cf899d20F13F79Ba00BC",             // AdaptiveCurveIrm
+  lltv: 94_5000000000000000n,                                    // 94.5%
+});
 
-market.collateralToken; // e.g. 0x7f39C581F595B53c5cb19bD0b3f8dA6c935E2Ca0.
+config.liquidationIncentiveFactor; // e.g. 1_090000000000000000n (109%).
 ```
 
-### Fetch data of a specific market
+### Instance of a specific market
 
-Leverage the [`Market`](./src/market/Market.ts) class to fetch and query useful information on a specific market:
+Leverage the [`Market`](./src/market/Market.ts) class to manipulate a specific market:
 
 ```typescript
 import { Market } from "@morpho-org/blue-sdk";
 import { Time } from "@morpho-org/morpho-ts";
 
-const market = Market.fetch(
-  "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 market = new Market({
+  config: new MarketConfig({
+    loanToken: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",       // WETH
+    collateralToken: "0x7f39C581F595B53c5cb19bD0b3f8dA6c935E2Ca0", // wstETH
+    oracle: "0x2a01EB9496094dA03c4E364Def50f5aD1280AD72",
+    irm: "0x870aC11D48B15DB9a138Cf899d20F13F79Ba00BC",             // AdaptiveCurveIrm
+    lltv: 94_5000000000000000n,                                    // 94.5%
+  }),
+  totalSupplyAssets: 1000_000000000000000000n,
+  totalBorrowAssets: 920_000000000000000000n,
+  totalSupplyShares: 1000_000000000000000000000000n,
+  totalBorrowShares: 920_000000000000000000000000n,
+  lastUpdate: 1721000000n,
+  fee: 0n,
+  price: 1_100000000000000000000000000000000000n,
+  rateAtTarget: 94850992095n
+});
+
+market.utilization; // e.g. 92_0000000000000000n (92%).
+market.liquidity; // e.g. 80_000000000000000000n (in loan assets).
+market.apyAtTarget; // e.g. 3_0000000000000000n (3%).
 
 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
+### Instance of the position of a specific user on a specific market
 
-Leverage the [`Position`](./src/position/Position.ts) class to fetch and query useful information about the position of a user on a given market:
+Leverage the [`Position`](./src/position/Position.ts) class to manipulate the position of a user on a given market:
 
 ```typescript
 import { Position } from "@morpho-org/blue-sdk";
 import { Time } from "@morpho-org/morpho-ts";
 
-const position = AccrualPosition.fetch(
-  "0x7f65e7326F22963e2039734dDfF61958D5d284Ca",
-  "0xb323495f7e4148be5643a4ea4a8221eef163e4bccfdedc2a6f4696baacbc86cc",
-  provider // Ethers provider.
+const position = new AccrualPosition(
+  new Position({
+    user,
+    marketId: market.id,
+    supplyShares: 0n,
+    borrowShares: 20_000000000000000000000000n,
+    collateral: 27_000000000000000000n
+  }),
+  market
 );
 
-// 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.borrowAssets; // e.g. 20_000000000000000000n (in loan assets).
 position.isHealthy; // e.g. true.
-position.maxBorrowableAssets; // e.g. 2100_000000n (in loan assets).
+position.maxBorrowableAssets; // e.g. 2100_000000000000000000n (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).
+position.borrowAssets; // e.g. 20_400000000000000000n (in loan assets).
 ```
 
 [downloads-img]: https://img.shields.io/npm/dt/@morpho-org/blue-sdk

package/lib/addresses.d.ts

@@ -78,6 +78,7 @@ export declare const addresses: {
         readonly adaptiveCurveIrm: "0x46415998764C29aB2a25CbeA6254146D50D22687";
         readonly publicAllocator: "0xA090dD1a701408Df1d4d0B85b716c87565f90467";
         readonly aaveV3Bundler: "0xcAe2929baBc60Be34818EaA5F40bF69265677108";
+        readonly compoundV3Bundler: "0x1f8076e2EB6f10b12e6886f30D4909A91969F7dA";
         readonly usdc: "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913";
         readonly cbEth: "0x2Ae3F1Ec7F1F5012CFEab0185bfc7aa3cf0DEc22";
         readonly verUsdc: "0x59aaF835D34b1E3dF2170e4872B785f11E2a964b";

package/lib/addresses.js

@@ -88,6 +88,7 @@ exports.addresses = {
         adaptiveCurveIrm: "0x46415998764C29aB2a25CbeA6254146D50D22687",
         publicAllocator: "0xA090dD1a701408Df1d4d0B85b716c87565f90467",
         aaveV3Bundler: "0xcAe2929baBc60Be34818EaA5F40bF69265677108",
+        compoundV3Bundler: "0x1f8076e2EB6f10b12e6886f30D4909A91969F7dA",
         /* Tokens */
         usdc: "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
         cbEth: "0x2Ae3F1Ec7F1F5012CFEab0185bfc7aa3cf0DEc22",

package/lib/helpers/format/format.test.js

@@ -137,9 +137,7 @@ describe("format", () => {
                 expect(format_1.format.short
                     .smallValuesWithCommas()
                     .locale("fr-FR")
-                    .of(bigint, decimals + 1)
-                // the correct space in fr-FR is narrow no-break space (U+202F)
-                ).toEqual("1\u202F234,56789");
+                    .of(bigint, decimals + 1)).toEqual("1\u202F234,56789");
             });
         });
     });

package/lib/helpers/locale.js

@@ -39,7 +39,7 @@ const getEffectiveLocale = () => {
             new Intl.NumberFormat(locale);
             return locale;
         }
-        catch (e) {
+        catch {
             return "en-US";
         }
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@morpho-org/blue-sdk",
-  "version": "1.2.1",
+  "version": "1.2.3",
   "author": "Morpho Association <contact@morpho.org>",
   "license": "MIT",
   "main": "lib/index.js",
@@ -13,14 +13,15 @@
     "test": "jest"
   },
   "dependencies": {
-    "@morpho-org/morpho-ts": "1.0.5",
+    "@morpho-org/morpho-ts": "1.0.6",
     "keccak256": "^1.0.6"
   },
   "devDependencies": {
-    "@morpho-org/morpho-test": "1.0.5",
+    "@morpho-org/morpho-test": "1.0.6",
     "@types/jest": "^29.5.12",
-    "jest": "^29.6.2",
-    "ts-jest": "^29.1.1",
+    "@types/node": "^20.12.8",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.2.2",
     "typescript": "^5.4.5"
   },
   "publishConfig": {
@@ -45,5 +46,5 @@
     ],
     "preset": "ts-jest"
   },
-  "gitHead": "cc64e88993808eb357c59e27501e4d05bd868e5b"
+  "gitHead": "0c32ea00c8b60b6f408b6d05329261ce4eb3f94c"
 }