@morpho-org/midnight-sdk 0.1.0 → 1.0.0

package/lib/cjs/market/MarketUtils.js

@@ -4,17 +4,20 @@ exports.MarketUtils = void 0;
 const morpho_ts_1 = require("@morpho-org/morpho-ts");
 const viem_1 = require("viem");
 const constants_js_1 = require("../constants.js");
+const errors_js_1 = require("../errors.js");
 const Market_js_1 = require("./Market.js");
 const SSTORE2_PREFIX = "0x600b380380600b5f395ff3";
 const collateralParamsHashParams = [
     { name: "typehash", type: "bytes32" },
     { name: "token", type: "address" },
     { name: "lltv", type: "uint256" },
-    { name: "maxLif", type: "uint256" },
+    { name: "liquidationCursor", type: "uint256" },
     { name: "oracle", type: "address" },
 ];
 const marketHashParams = [
     { name: "typehash", type: "bytes32" },
+    { name: "chainId", type: "uint256" },
+    { name: "midnight", type: "address" },
     { name: "loanToken", type: "address" },
     { name: "collateralParamsHash", type: "bytes32" },
     { name: "maturity", type: "uint256" },
@@ -25,6 +28,8 @@ const marketHashParams = [
 const marketParamsAbiParameter = {
     type: "tuple",
     components: [
+        { name: "chainId", type: "uint256" },
+        { name: "midnight", type: "address" },
         { name: "loanToken", type: "address" },
         {
             name: "collateralParams",
@@ -32,7 +37,7 @@ const marketParamsAbiParameter = {
             components: [
                 { name: "token", type: "address" },
                 { name: "lltv", type: "uint256" },
-                { name: "maxLif", type: "uint256" },
+                { name: "liquidationCursor", type: "uint256" },
                 { name: "oracle", type: "address" },
             ],
         },
@@ -59,7 +64,7 @@ var MarketUtils;
      *
      * @param params.token - Collateral token address.
      * @param params.lltv - WAD-scaled liquidation loan-to-value.
-     * @param params.maxLif - WAD-scaled maximum liquidation incentive factor.
+     * @param params.liquidationCursor - WAD-scaled liquidation cursor.
      * @param params.oracle - Oracle address used to price this collateral.
      * @returns Collateral params with bigint fields.
      * @example
@@ -69,17 +74,31 @@ var MarketUtils;
      * const collateral = MarketUtils.toCollateralParams({
      *   token: "0x0000000000000000000000000000000000000001",
      *   lltv: 770000000000000000n,
-     *   maxLif: 1061007957559681697n,
+     *   liquidationCursor: 250000000000000000n,
      *   oracle: "0x0000000000000000000000000000000000000002",
      * });
-     * console.log(collateral.maxLif);
+     * console.log(collateral.liquidationCursor);
      * ```
      */
     function toCollateralParams(params) {
+        let lltv;
+        let liquidationCursor;
+        try {
+            lltv = BigInt(params.lltv);
+            liquidationCursor = BigInt(params.liquidationCursor);
+        }
+        catch (cause) {
+            throw new errors_js_1.InvalidMarketParameterError({
+                parameter: "collateralParams",
+                value: params,
+                instruction: "Provide bigint-compatible lltv and liquidationCursor values.",
+                cause,
+            });
+        }
         return {
             token: params.token,
-            lltv: BigInt(params.lltv),
-            maxLif: BigInt(params.maxLif),
+            lltv,
+            liquidationCursor,
             oracle: params.oracle,
         };
     }
@@ -94,12 +113,14 @@ var MarketUtils;
      * import { MarketUtils } from "@morpho-org/midnight-sdk";
      *
      * const struct = MarketUtils.toStruct({
+     *   chainId: 8453,
+     *   midnight: "0x0000000000000000000000000000000000001000",
      *   loanToken: "0x0000000000000000000000000000000000006000",
      *   collateralParams: [
      *     {
      *       token: "0x0000000000000000000000000000000000007000",
      *       lltv: 770000000000000000n,
-     *       maxLif: 1061007957559681697n,
+     *       liquidationCursor: 250000000000000000n,
      *       oracle: "0x0000000000000000000000000000000000008000",
      *     },
      *   ],
@@ -114,11 +135,13 @@ var MarketUtils;
     function toStruct(market) {
         const params = Market_js_1.MarketParams.from(market);
         return {
+            chainId: params.chainId,
+            midnight: params.midnight,
             loanToken: params.loanToken,
             collateralParams: params.collateralParams.map((collateral) => ({
                 token: collateral.token,
                 lltv: collateral.lltv,
-                maxLif: collateral.maxLif,
+                liquidationCursor: collateral.liquidationCursor,
                 oracle: collateral.oracle,
             })),
             maturity: params.maturity,
@@ -128,19 +151,66 @@ var MarketUtils;
         };
     }
     MarketUtils.toStruct = toStruct;
+    /**
+     * Returns configured collateral by index.
+     *
+     * @param market - Market params or hydrated market.
+     * @param index - Collateral index to look up.
+     * @returns Collateral entry for the configured index.
+     * @throws {UnknownCollateralIndexError} when the index is not configured.
+     * @example
+     * ```ts
+     * import { MarketUtils } from "@morpho-org/midnight-sdk";
+     *
+     * const collateral = MarketUtils.getCollateralByIndex({
+     *   chainId: 8453,
+     *   midnight: "0x0000000000000000000000000000000000001000",
+     *   loanToken: "0x0000000000000000000000000000000000000001",
+     *   collateralParams: [
+     *     {
+     *       token: "0x0000000000000000000000000000000000000002",
+     *       lltv: 770000000000000000n,
+     *       liquidationCursor: 250000000000000000n,
+     *       oracle: "0x0000000000000000000000000000000000000003",
+     *     },
+     *   ],
+     *   maturity: 1n,
+     *   rcfThreshold: 0n,
+     *   enterGate: "0x0000000000000000000000000000000000000000",
+     *   liquidatorGate: "0x0000000000000000000000000000000000000000",
+     * }, 0n);
+     * console.log(collateral.token);
+     * ```
+     */
+    function getCollateralByIndex(market, index) {
+        const normalizedIndex = BigInt(index);
+        const params = Market_js_1.MarketParams.from(market);
+        const collateral = normalizedIndex >= 0n &&
+            normalizedIndex <= BigInt(Number.MAX_SAFE_INTEGER)
+            ? params.collateralParams[Number(normalizedIndex)]
+            : undefined;
+        if (collateral == null) {
+            throw new errors_js_1.UnknownCollateralIndexError({
+                market: toId(params),
+                collateralIndex: normalizedIndex,
+            });
+        }
+        return collateral;
+    }
+    MarketUtils.getCollateralByIndex = getCollateralByIndex;
     /**
      * Returns the liquidation incentive factor for an LLTV and liquidation cursor.
      *
      * @param input - WAD-scaled LLTV or collateral params carrying an LLTV.
-     * @param cursor - WAD-scaled liquidation cursor, usually `LIQUIDATION_CURSOR_LOW` or `LIQUIDATION_CURSOR_HIGH`.
+     * @param cursor - WAD-scaled liquidation cursor.
      * @returns WAD-scaled liquidation incentive factor.
      * @example
      * ```ts
-     * import { LIQUIDATION_CURSOR_LOW, MarketUtils } from "@morpho-org/midnight-sdk";
+     * import { MarketUtils } from "@morpho-org/midnight-sdk";
      *
      * const liquidationIncentiveFactor = MarketUtils.getLiquidationIncentiveFactor(
      *   770000000000000000n,
-     *   LIQUIDATION_CURSOR_LOW,
+     *   250000000000000000n,
      * );
      * console.log(liquidationIncentiveFactor);
      * ```
@@ -209,12 +279,14 @@ var MarketUtils;
      * import { MarketUtils } from "@morpho-org/midnight-sdk";
      *
      * const hash = MarketUtils.hash({
+     *   chainId: 8453,
+     *   midnight: "0x0000000000000000000000000000000000001000",
      *   loanToken: "0x0000000000000000000000000000000000000001",
      *   collateralParams: [
      *     {
      *       token: "0x0000000000000000000000000000000000000002",
      *       lltv: 770000000000000000n,
-     *       maxLif: 1061007957559681697n,
+     *       liquidationCursor: 250000000000000000n,
      *       oracle: "0x0000000000000000000000000000000000000003",
      *     },
      *   ],
@@ -235,12 +307,14 @@ var MarketUtils;
             constants_js_1.COLLATERAL_PARAMS_TYPEHASH,
             params.token,
             BigInt(params.lltv),
-            BigInt(params.maxLif),
+            BigInt(params.liquidationCursor),
             params.oracle,
         ])));
         const collateralParamsHash = (0, viem_1.keccak256)((0, viem_1.concat)(collateralParamHashes));
         return (0, viem_1.keccak256)((0, viem_1.encodeAbiParameters)(marketHashParams, [
             constants_js_1.MARKET_TYPEHASH,
+            BigInt(marketParams.chainId),
+            marketParams.midnight,
             marketParams.loanToken,
             collateralParamsHash,
             BigInt(marketParams.maturity),
@@ -253,51 +327,37 @@ var MarketUtils;
     /**
      * Computes the Midnight id for a market using `IdLib.toId`.
      *
-     * @param params.market - Market to hash.
-     * @param params.chainId - EIP-155 chain id used to resolve the core Midnight address from the registry.
+     * @param market - Market to hash.
      * @returns Market id.
-     * @throws {UnsupportedChainIdError} when no address registry exists for `chainId`.
-     * @throws {UnknownAddressError} when the registry has no Midnight address for `chainId`.
      * @example
      * ```ts
-     * import { ChainId, registerCustomAddresses } from "@morpho-org/morpho-ts";
      * import { MarketUtils } from "@morpho-org/midnight-sdk";
      *
-     * registerCustomAddresses({
-     *   addresses: {
-     *     [ChainId.BaseMainnet]: {
-     *       midnight: "0x0000000000000000000000000000000000000001",
-     *     },
-     *   },
-     * });
-     *
      * const id = MarketUtils.toId({
-     *   market: {
-     *     loanToken: "0x0000000000000000000000000000000000000001",
-     *     collateralParams: [
-     *       {
-     *         token: "0x0000000000000000000000000000000000000002",
-     *         lltv: 770000000000000000n,
-     *         maxLif: 1061007957559681697n,
-     *         oracle: "0x0000000000000000000000000000000000000003",
-     *       },
-     *     ],
-     *     maturity: 1n,
-     *     rcfThreshold: 0n,
-     *     enterGate: "0x0000000000000000000000000000000000000000",
-     *     liquidatorGate: "0x0000000000000000000000000000000000000000",
-     *   },
-     *   chainId: ChainId.BaseMainnet,
+     *   chainId: 8453,
+     *   midnight: "0x0000000000000000000000000000000000001000",
+     *   loanToken: "0x0000000000000000000000000000000000000001",
+     *   collateralParams: [
+     *     {
+     *       token: "0x0000000000000000000000000000000000000002",
+     *       lltv: 770000000000000000n,
+     *       liquidationCursor: 250000000000000000n,
+     *       oracle: "0x0000000000000000000000000000000000000003",
+     *     },
+     *   ],
+     *   maturity: 1n,
+     *   rcfThreshold: 0n,
+     *   enterGate: "0x0000000000000000000000000000000000000000",
+     *   liquidatorGate: "0x0000000000000000000000000000000000000000",
      * });
      * console.log(id);
      * ```
      */
-    function toId(params) {
-        const chainId = BigInt(params.chainId);
-        const midnight = (0, morpho_ts_1.getChainAddress)(Number(chainId), "midnight");
-        const encodedMarket = (0, viem_1.encodeAbiParameters)([marketParamsAbiParameter], [toStruct(params.market)]);
+    function toId(market) {
+        const marketParams = Market_js_1.MarketParams.from(market);
+        const encodedMarket = (0, viem_1.encodeAbiParameters)([marketParamsAbiParameter], [toStruct(marketParams)]);
         const creationHash = (0, viem_1.keccak256)((0, viem_1.concat)([SSTORE2_PREFIX, encodedMarket]));
-        return (0, viem_1.keccak256)((0, viem_1.encodePacked)(["uint8", "address", "uint256", "bytes32"], [255, midnight, chainId, creationHash]));
+        return (0, viem_1.keccak256)((0, viem_1.encodePacked)(["uint8", "address", "uint256", "bytes32"], [255, marketParams.midnight, 0n, creationHash]));
     }
     MarketUtils.toId = toId;
 })(MarketUtils || (exports.MarketUtils = MarketUtils = {}));

package/lib/cjs/market/Position.d.ts

@@ -125,14 +125,15 @@ export declare class Position {
  *     collateral: [50n],
  *   },
  *   {
- *     chainId: 31337,
  *     params: {
+ *       chainId: 31337,
+ *       midnight: "0x0000000000000000000000000000000000001000",
  *       loanToken: "0x0000000000000000000000000000000000006000",
  *       collateralParams: [
  *         {
  *           token: "0x0000000000000000000000000000000000007000",
  *           lltv: 770000000000000000n,
- *           maxLif: 1061007957559681697n,
+ *           liquidationCursor: 250000000000000000n,
  *           oracle: "0x0000000000000000000000000000000000008000",
  *         },
  *       ],
@@ -156,7 +157,7 @@ export declare class Position {
 export declare class AccrualPosition extends Position {
     /** Hydrated market for this position. */
     readonly market: Market;
-    constructor(position: IPosition, market: IMarket);
+    constructor(position: IPosition, market: IMarket | Market);
     /**
      * Returns the position collateral balance at an index configured by the market.
      *
@@ -192,14 +193,15 @@ export declare class AccrualPosition extends Position {
      *     collateral: [50n],
      *   },
      *   {
-     *     chainId: 31337,
      *     params: {
+     *       chainId: 31337,
+     *       midnight: "0x0000000000000000000000000000000000001000",
      *       loanToken: "0x0000000000000000000000000000000000006000",
      *       collateralParams: [
      *         {
      *           token: "0x0000000000000000000000000000000000007000",
      *           lltv: 770000000000000000n,
-     *           maxLif: 1061007957559681697n,
+     *           liquidationCursor: 250000000000000000n,
      *           oracle: "0x0000000000000000000000000000000000008000",
      *         },
      *       ],
@@ -258,14 +260,15 @@ export declare class AccrualPosition extends Position {
      *     collateral: [50n],
      *   },
      *   {
-     *     chainId: 31337,
      *     params: {
+     *       chainId: 31337,
+     *       midnight: "0x0000000000000000000000000000000000001000",
      *       loanToken: "0x0000000000000000000000000000000000006000",
      *       collateralParams: [
      *         {
      *           token: collateralToken,
      *           lltv: 770000000000000000n,
-     *           maxLif: 1061007957559681697n,
+     *           liquidationCursor: 250000000000000000n,
      *           oracle: "0x0000000000000000000000000000000000008000",
      *         },
      *       ],
@@ -323,14 +326,15 @@ export declare class AccrualPosition extends Position {
      *     collateral: [50n],
      *   },
      *   {
-     *     chainId: 31337,
      *     params: {
+     *       chainId: 31337,
+     *       midnight: "0x0000000000000000000000000000000000001000",
      *       loanToken: "0x0000000000000000000000000000000000006000",
      *       collateralParams: [
      *         {
      *           token: "0x0000000000000000000000000000000000007000",
      *           lltv: 770000000000000000n,
-     *           maxLif: 1061007957559681697n,
+     *           liquidationCursor: 250000000000000000n,
      *           oracle: "0x0000000000000000000000000000000000008000",
      *         },
      *       ],
@@ -391,14 +395,15 @@ export declare class AccrualPosition extends Position {
      *     collateral: [50n],
      *   },
      *   {
-     *     chainId: 31337,
      *     params: {
+     *       chainId: 31337,
+     *       midnight: "0x0000000000000000000000000000000000001000",
      *       loanToken: "0x0000000000000000000000000000000000006000",
      *       collateralParams: [
      *         {
      *           token: "0x0000000000000000000000000000000000007000",
      *           lltv: 770000000000000000n,
-     *           maxLif: 1061007957559681697n,
+     *           liquidationCursor: 250000000000000000n,
      *           oracle: "0x0000000000000000000000000000000000008000",
      *         },
      *       ],

package/lib/cjs/market/Position.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AccrualPosition = exports.Position = void 0;
 const morpho_ts_1 = require("@morpho-org/morpho-ts");
+const errors_js_1 = require("../errors.js");
 const Market_js_1 = require("./Market.js");
 const PositionUtils_js_1 = require("./PositionUtils.js");
 /**
@@ -105,14 +106,15 @@ exports.Position = Position;
  *     collateral: [50n],
  *   },
  *   {
- *     chainId: 31337,
  *     params: {
+ *       chainId: 31337,
+ *       midnight: "0x0000000000000000000000000000000000001000",
  *       loanToken: "0x0000000000000000000000000000000000006000",
  *       collateralParams: [
  *         {
  *           token: "0x0000000000000000000000000000000000007000",
  *           lltv: 770000000000000000n,
- *           maxLif: 1061007957559681697n,
+ *           liquidationCursor: 250000000000000000n,
  *           oracle: "0x0000000000000000000000000000000000008000",
  *         },
  *       ],
@@ -138,7 +140,7 @@ class AccrualPosition extends Position {
     market;
     constructor(position, market) {
         super(position);
-        this.market = market instanceof Market_js_1.Market ? market : new Market_js_1.Market(market);
+        this.market = Market_js_1.Market.from(market);
     }
     /**
      * Returns the position collateral balance at an index configured by the market.
@@ -175,14 +177,15 @@ class AccrualPosition extends Position {
      *     collateral: [50n],
      *   },
      *   {
-     *     chainId: 31337,
      *     params: {
+     *       chainId: 31337,
+     *       midnight: "0x0000000000000000000000000000000000001000",
      *       loanToken: "0x0000000000000000000000000000000000006000",
      *       collateralParams: [
      *         {
      *           token: "0x0000000000000000000000000000000000007000",
      *           lltv: 770000000000000000n,
-     *           maxLif: 1061007957559681697n,
+     *           liquidationCursor: 250000000000000000n,
      *           oracle: "0x0000000000000000000000000000000000008000",
      *         },
      *       ],
@@ -206,7 +209,7 @@ class AccrualPosition extends Position {
      */
     getCollateralBalanceByIndex(index) {
         const normalizedIndex = BigInt(index);
-        if (this.market.getCollateralParamsByIndex(normalizedIndex) == null)
+        if ((0, morpho_ts_1._try)(() => this.market.getCollateralByIndex(normalizedIndex), errors_js_1.UnknownCollateralIndexError) == null)
             return undefined;
         return this.collateral[Number(normalizedIndex)] ?? 0n;
     }
@@ -246,14 +249,15 @@ class AccrualPosition extends Position {
      *     collateral: [50n],
      *   },
      *   {
-     *     chainId: 31337,
      *     params: {
+     *       chainId: 31337,
+     *       midnight: "0x0000000000000000000000000000000000001000",
      *       loanToken: "0x0000000000000000000000000000000000006000",
      *       collateralParams: [
      *         {
      *           token: collateralToken,
      *           lltv: 770000000000000000n,
-     *           maxLif: 1061007957559681697n,
+     *           liquidationCursor: 250000000000000000n,
      *           oracle: "0x0000000000000000000000000000000000008000",
      *         },
      *       ],
@@ -314,14 +318,15 @@ class AccrualPosition extends Position {
      *     collateral: [50n],
      *   },
      *   {
-     *     chainId: 31337,
      *     params: {
+     *       chainId: 31337,
+     *       midnight: "0x0000000000000000000000000000000000001000",
      *       loanToken: "0x0000000000000000000000000000000000006000",
      *       collateralParams: [
      *         {
      *           token: "0x0000000000000000000000000000000000007000",
      *           lltv: 770000000000000000n,
-     *           maxLif: 1061007957559681697n,
+     *           liquidationCursor: 250000000000000000n,
      *           oracle: "0x0000000000000000000000000000000000008000",
      *         },
      *       ],
@@ -384,14 +389,15 @@ class AccrualPosition extends Position {
      *     collateral: [50n],
      *   },
      *   {
-     *     chainId: 31337,
      *     params: {
+     *       chainId: 31337,
+     *       midnight: "0x0000000000000000000000000000000000001000",
      *       loanToken: "0x0000000000000000000000000000000000006000",
      *       collateralParams: [
      *         {
      *           token: "0x0000000000000000000000000000000000007000",
      *           lltv: 770000000000000000n,
-     *           maxLif: 1061007957559681697n,
+     *           liquidationCursor: 250000000000000000n,
      *           oracle: "0x0000000000000000000000000000000000008000",
      *         },
      *       ],

package/lib/cjs/market/PositionUtils.d.ts

@@ -19,14 +19,15 @@ import type { IPosition } from "./Position.js";
  *     collateral: [50n],
  *   },
  *   market: {
- *     chainId: 8453,
  *     params: {
+ *       chainId: 8453,
+ *       midnight: "0x0000000000000000000000000000000000001000",
  *       loanToken: "0x0000000000000000000000000000000000006000",
  *       collateralParams: [
  *         {
  *           token: "0x0000000000000000000000000000000000007000",
  *           lltv: 770000000000000000n,
- *           maxLif: 1061007957559681697n,
+ *           liquidationCursor: 250000000000000000n,
  *           oracle: "0x0000000000000000000000000000000000008000",
  *         },
  *       ],
@@ -74,14 +75,15 @@ export declare namespace PositionUtils {
      *     collateral: [50n],
      *   },
      *   market: {
-     *     chainId: 8453,
      *     params: {
+     *       chainId: 8453,
+     *       midnight: "0x0000000000000000000000000000000000001000",
      *       loanToken: "0x0000000000000000000000000000000000006000",
      *       collateralParams: [
      *         {
      *           token: "0x0000000000000000000000000000000000007000",
      *           lltv: 770000000000000000n,
-     *           maxLif: 1061007957559681697n,
+     *           liquidationCursor: 250000000000000000n,
      *           oracle: "0x0000000000000000000000000000000000008000",
      *         },
      *       ],

package/lib/cjs/market/PositionUtils.js

@@ -21,14 +21,15 @@ const errors_js_1 = require("../errors.js");
  *     collateral: [50n],
  *   },
  *   market: {
- *     chainId: 8453,
  *     params: {
+ *       chainId: 8453,
+ *       midnight: "0x0000000000000000000000000000000000001000",
  *       loanToken: "0x0000000000000000000000000000000000006000",
  *       collateralParams: [
  *         {
  *           token: "0x0000000000000000000000000000000000007000",
  *           lltv: 770000000000000000n,
- *           maxLif: 1061007957559681697n,
+ *           liquidationCursor: 250000000000000000n,
  *           oracle: "0x0000000000000000000000000000000000008000",
  *         },
  *       ],
@@ -77,14 +78,15 @@ var PositionUtils;
      *     collateral: [50n],
      *   },
      *   market: {
-     *     chainId: 8453,
      *     params: {
+     *       chainId: 8453,
+     *       midnight: "0x0000000000000000000000000000000000001000",
      *       loanToken: "0x0000000000000000000000000000000000006000",
      *       collateralParams: [
      *         {
      *           token: "0x0000000000000000000000000000000000007000",
      *           lltv: 770000000000000000n,
-     *           maxLif: 1061007957559681697n,
+     *           liquidationCursor: 250000000000000000n,
      *           oracle: "0x0000000000000000000000000000000000008000",
      *         },
      *       ],
@@ -146,10 +148,12 @@ var PositionUtils;
         const collateralParams = params.market.params.collateralParams.map((collateralParam) => ({
             token: collateralParam.token,
             lltv: BigInt(collateralParam.lltv),
-            maxLif: BigInt(collateralParam.maxLif),
+            liquidationCursor: BigInt(collateralParam.liquidationCursor),
             oracle: collateralParam.oracle,
         }));
         const marketParams = {
+            chainId: BigInt(params.market.params.chainId),
+            midnight: params.market.params.midnight,
             loanToken: params.market.params.loanToken,
             collateralParams,
             maturity,
@@ -177,7 +181,6 @@ var PositionUtils;
                 collateral,
             },
             market: {
-                chainId: BigInt(params.market.chainId),
                 params: marketParams,
                 totalUnits: BigInt(params.market.totalUnits),
                 lossFactor: marketLossFactor,

package/lib/cjs/math/TickLib.d.ts

@@ -178,6 +178,28 @@ export declare namespace TickLib {
      * ```
      */
     function tickToRate(tick: BigIntish): bigint;
+    /**
+     * Converts a Midnight tick into a WAD simple annual percentage rate.
+     *
+     * This is an SDK-only rate display convenience. It annualizes the fixed
+     * period rate from {@link tickToRate} over `timeToMaturity` seconds.
+     *
+     * @param tick - Midnight tick.
+     * @param timeToMaturity - Seconds until the market matures.
+     * @returns WAD simple APR rounded up.
+     * @throws {NegativeValueError} when `tick` or `timeToMaturity` is negative.
+     * @throws {TickOutOfRangeError} when `tick` exceeds `MAX_TICK`.
+     * @throws {DivisionByZeroError} when the tick price or `timeToMaturity` is zero.
+     * @example
+     * ```ts
+     * import { TickLib } from "@morpho-org/midnight-sdk";
+     * import { Time } from "@morpho-org/morpho-ts";
+     *
+     * const apr = TickLib.tickToApr(6744n, Time.s.from.y(1n));
+     * console.log(apr);
+     * ```
+     */
+    function tickToApr(tick: BigIntish, timeToMaturity: BigIntish): bigint;
     /**
      * Asserts that a tick is aligned to the provided spacing.
      *

package/lib/cjs/math/TickLib.js

@@ -239,6 +239,36 @@ var TickLib;
         return morpho_ts_1.MathLib.mulDiv(morpho_ts_1.MathLib.WAD, morpho_ts_1.MathLib.WAD, price, "Up") - morpho_ts_1.MathLib.WAD;
     }
     TickLib.tickToRate = tickToRate;
+    /**
+     * Converts a Midnight tick into a WAD simple annual percentage rate.
+     *
+     * This is an SDK-only rate display convenience. It annualizes the fixed
+     * period rate from {@link tickToRate} over `timeToMaturity` seconds.
+     *
+     * @param tick - Midnight tick.
+     * @param timeToMaturity - Seconds until the market matures.
+     * @returns WAD simple APR rounded up.
+     * @throws {NegativeValueError} when `tick` or `timeToMaturity` is negative.
+     * @throws {TickOutOfRangeError} when `tick` exceeds `MAX_TICK`.
+     * @throws {DivisionByZeroError} when the tick price or `timeToMaturity` is zero.
+     * @example
+     * ```ts
+     * import { TickLib } from "@morpho-org/midnight-sdk";
+     * import { Time } from "@morpho-org/morpho-ts";
+     *
+     * const apr = TickLib.tickToApr(6744n, Time.s.from.y(1n));
+     * console.log(apr);
+     * ```
+     */
+    function tickToApr(tick, timeToMaturity) {
+        const normalizedTimeToMaturity = BigInt(timeToMaturity);
+        (0, morpho_ts_1.assertNonNegative)("timeToMaturity", normalizedTimeToMaturity);
+        if (normalizedTimeToMaturity === 0n) {
+            throw new morpho_ts_1.DivisionByZeroError("timeToMaturity");
+        }
+        return morpho_ts_1.MathLib.mulDiv(tickToRate(tick), morpho_ts_1.Time.s.from.y(1n), normalizedTimeToMaturity, "Up");
+    }
+    TickLib.tickToApr = tickToApr;
     /**
      * Asserts that a tick is aligned to the provided spacing.
      *

package/lib/cjs/math/index.d.ts

@@ -1,3 +1,2 @@
-export * from "./ConsumableUnitsLib.js";
 export * from "./TakeAmountsLib.js";
 export * from "./TickLib.js";

package/lib/cjs/math/index.js

@@ -14,6 +14,5 @@ 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("./ConsumableUnitsLib.js"), exports);
 __exportStar(require("./TakeAmountsLib.js"), exports);
 __exportStar(require("./TickLib.js"), exports);