@morpho-org/blue-sdk 3.0.4 → 3.0.6

package/lib/holding/Holding.d.ts

@@ -31,10 +31,6 @@ export declare class Holding implements IHolding {
      * 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.
      */
@@ -54,5 +50,14 @@ export declare class Holding implements IHolding {
      * `undefined` if the token does not support ERC-2612.
      */
     erc2612Nonce?: bigint;
+    /**
+     * Allows to customize the setter behavior in child classes.
+     */
+    protected _balance: bigint;
     constructor({ user, token, erc20Allowances, permit2BundlerAllowance, balance, erc2612Nonce, canTransfer, }: IHolding);
+    /**
+     * The balance of the user for this token.
+     */
+    get balance(): bigint;
+    set balance(value: bigint);
 }

package/lib/holding/Holding.js

@@ -16,10 +16,6 @@ class Holding {
      * 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.
      */
@@ -37,10 +33,14 @@ class Holding {
      * `undefined` if the token does not support ERC-2612.
      */
     erc2612Nonce;
+    /**
+     * Allows to customize the setter behavior in child classes.
+     */
+    _balance;
     constructor({ user, token, erc20Allowances, permit2BundlerAllowance, balance, erc2612Nonce, canTransfer, }) {
         this.user = user;
         this.token = token;
-        this.balance = balance;
+        this._balance = balance;
         this.canTransfer = canTransfer;
         this.erc20Allowances = (0, morpho_ts_1.fromEntries)((0, morpho_ts_1.entries)(erc20Allowances).map(([address, allowance]) => [
             address,
@@ -54,5 +54,14 @@ class Holding {
         if (erc2612Nonce != null)
             this.erc2612Nonce = erc2612Nonce;
     }
+    /**
+     * The balance of the user for this token.
+     */
+    get balance() {
+        return this._balance;
+    }
+    set balance(value) {
+        this._balance = value;
+    }
 }
 exports.Holding = Holding;

package/lib/market/Market.d.ts

@@ -108,9 +108,16 @@ export declare class Market implements IMarket {
      */
     get supplyRate(): bigint;
     /**
-     * Returns the rate at which interest accrues for borrowers of this market,
-     * since the last time the market was updated (scaled by WAD).
-     * If interested in the rate at a specific timestamp, use `getAccrualBorrowRate(timestamp)` instead.
+     * Returns the average rate at which interest _would_ accrue from `lastUpdate`
+     * till now, if `accrueInterest` was called immediately onchain (scaled by WAD).
+     * If `accrueInterest` was just called, the average rate equals the instantaneous rate,
+     * so it is equivalent to `getBorrowRate(lastUpdate)`.
+     *
+     * In most cases, `accrueInterest` will not be called immediately onchain, so the
+     * average rate doesn't correspond to anything "real".
+     *
+     * If interested in the instantaneous rate experienced by existing market actors at a specific timestamp,
+     * use `getBorrowRate(timestamp)`, `getBorrowApy(timestamp)`, or `getSupplyApy(timestamp)` instead.
      */
     get borrowRate(): bigint;
     /**
@@ -136,7 +143,12 @@ export declare class Market implements IMarket {
      * at the given timestamp, if the state remains unchanged (not accrued) (scaled by WAD).
      * @param timestamp The timestamp at which to calculate the accrual borrow rate. Must be greater than or equal to `lastUpdate`. Defaults to `Time.timestamp()` (returns the current borrow rate).
      */
-    getAccrualBorrowRate(timestamp?: BigIntish): bigint;
+    protected getAccrualBorrowRate(timestamp?: BigIntish): {
+        elapsed: bigint;
+        avgBorrowRate: bigint;
+        endBorrowRate: bigint;
+        endRateAtTarget?: bigint;
+    };
     /**
      * The market's instantaneous borrow-side Annual Percentage Yield (APY) at the given timestamp,
      * if the state remains unchanged (not accrued) (scaled by WAD).

package/lib/market/Market.js

@@ -109,12 +109,19 @@ class Market {
         return MarketUtils_js_1.MarketUtils.getSupplyRate(this.borrowRate, this);
     }
     /**
-     * Returns the rate at which interest accrues for borrowers of this market,
-     * since the last time the market was updated (scaled by WAD).
-     * If interested in the rate at a specific timestamp, use `getAccrualBorrowRate(timestamp)` instead.
+     * Returns the average rate at which interest _would_ accrue from `lastUpdate`
+     * till now, if `accrueInterest` was called immediately onchain (scaled by WAD).
+     * If `accrueInterest` was just called, the average rate equals the instantaneous rate,
+     * so it is equivalent to `getBorrowRate(lastUpdate)`.
+     *
+     * In most cases, `accrueInterest` will not be called immediately onchain, so the
+     * average rate doesn't correspond to anything "real".
+     *
+     * If interested in the instantaneous rate experienced by existing market actors at a specific timestamp,
+     * use `getBorrowRate(timestamp)`, `getBorrowApy(timestamp)`, or `getSupplyApy(timestamp)` instead.
      */
     get borrowRate() {
-        return this.getAccrualBorrowRate();
+        return this.getAccrualBorrowRate().avgBorrowRate;
     }
     /**
      * The market's current, instantaneous supply-side Annual Percentage Yield (APY) (scaled by WAD).
@@ -153,14 +160,20 @@ class Market {
      * @param timestamp The timestamp at which to calculate the accrual borrow rate. Must be greater than or equal to `lastUpdate`. Defaults to `Time.timestamp()` (returns the current borrow rate).
      */
     getAccrualBorrowRate(timestamp = morpho_ts_1.Time.timestamp()) {
-        if (this.rateAtTarget == null)
-            return 0n;
         timestamp = BigInt(timestamp);
         const elapsed = timestamp - this.lastUpdate;
         if (elapsed < 0n)
             throw new errors_js_1.BlueErrors.InvalidInterestAccrual(this.id, timestamp, this.lastUpdate);
-        const { avgBorrowRate } = index_js_1.AdaptiveCurveIrmLib.getBorrowRate(this.utilization, this.rateAtTarget, elapsed);
-        return avgBorrowRate;
+        if (this.rateAtTarget == null)
+            return {
+                elapsed,
+                avgBorrowRate: 0n,
+                endBorrowRate: 0n,
+            };
+        return {
+            elapsed,
+            ...index_js_1.AdaptiveCurveIrmLib.getBorrowRate(this.utilization, this.rateAtTarget, elapsed),
+        };
     }
     /**
      * The market's instantaneous borrow-side Annual Percentage Yield (APY) at the given timestamp,
@@ -186,26 +199,15 @@ class Market {
      */
     accrueInterest(timestamp = this.lastUpdate) {
         timestamp = BigInt(timestamp);
-        const elapsed = timestamp - this.lastUpdate;
-        if (elapsed < 0n)
-            throw new errors_js_1.BlueErrors.InvalidInterestAccrual(this.id, timestamp, this.lastUpdate);
-        if (elapsed === 0n)
-            return new Market(this);
-        let borrowRate = 0n;
-        let { rateAtTarget } = this;
-        if (rateAtTarget != null) {
-            const { avgBorrowRate, endRateAtTarget } = index_js_1.AdaptiveCurveIrmLib.getBorrowRate(this.utilization, rateAtTarget, elapsed);
-            borrowRate = avgBorrowRate;
-            rateAtTarget = endRateAtTarget;
-        }
-        const { interest, feeShares } = MarketUtils_js_1.MarketUtils.getAccruedInterest(borrowRate, this, elapsed);
+        const { elapsed, avgBorrowRate, endRateAtTarget } = this.getAccrualBorrowRate(timestamp);
+        const { interest, feeShares } = MarketUtils_js_1.MarketUtils.getAccruedInterest(avgBorrowRate, this, elapsed);
         return new Market({
             ...this,
             totalSupplyAssets: this.totalSupplyAssets + interest,
             totalBorrowAssets: this.totalBorrowAssets + interest,
             totalSupplyShares: this.totalSupplyShares + feeShares,
             lastUpdate: timestamp,
-            rateAtTarget,
+            rateAtTarget: endRateAtTarget,
         });
     }
     supply(assets, shares, timestamp) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@morpho-org/blue-sdk",
   "description": "Framework-agnostic package that defines Morpho-related entity classes (such as `Market`, `Token`, `Vault`).",
-  "version": "3.0.4",
+  "version": "3.0.6",
   "author": "Morpho Association <contact@morpho.org>",
   "contributors": [
     "Rubilmax <rmilon@gmail.com>"