@morpho-org/midnight-sdk 0.1.0 → 1.0.0

package/lib/esm/market/MarketUtils.js

@@ -1,17 +1,20 @@
-import { assertNonNegative, getChainAddress, MathLib, } from "@morpho-org/morpho-ts";
+import { assertNonNegative, MathLib, } from "@morpho-org/morpho-ts";
 import { concat, encodeAbiParameters, encodePacked, keccak256 } from "viem";
 import { CBP, COLLATERAL_PARAMS_TYPEHASH, MARKET_TYPEHASH, SETTLEMENT_FEE_BREAKPOINTS, } from "../constants.js";
+import { InvalidMarketParameterError, UnknownCollateralIndexError, } from "../errors.js";
 import { MarketParams, } from "./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" },
@@ -22,6 +25,8 @@ const marketHashParams = [
 const marketParamsAbiParameter = {
     type: "tuple",
     components: [
+        { name: "chainId", type: "uint256" },
+        { name: "midnight", type: "address" },
         { name: "loanToken", type: "address" },
         {
             name: "collateralParams",
@@ -29,7 +34,7 @@ const marketParamsAbiParameter = {
             components: [
                 { name: "token", type: "address" },
                 { name: "lltv", type: "uint256" },
-                { name: "maxLif", type: "uint256" },
+                { name: "liquidationCursor", type: "uint256" },
                 { name: "oracle", type: "address" },
             ],
         },
@@ -56,7 +61,7 @@ export 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
@@ -66,17 +71,31 @@ export 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 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,
         };
     }
@@ -91,12 +110,14 @@ export 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",
      *     },
      *   ],
@@ -111,11 +132,13 @@ export var MarketUtils;
     function toStruct(market) {
         const params = 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,
@@ -125,19 +148,66 @@ export 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 = MarketParams.from(market);
+        const collateral = normalizedIndex >= 0n &&
+            normalizedIndex <= BigInt(Number.MAX_SAFE_INTEGER)
+            ? params.collateralParams[Number(normalizedIndex)]
+            : undefined;
+        if (collateral == null) {
+            throw new 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);
      * ```
@@ -206,12 +276,14 @@ export 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",
      *     },
      *   ],
@@ -232,12 +304,14 @@ export var MarketUtils;
             COLLATERAL_PARAMS_TYPEHASH,
             params.token,
             BigInt(params.lltv),
-            BigInt(params.maxLif),
+            BigInt(params.liquidationCursor),
             params.oracle,
         ])));
         const collateralParamsHash = keccak256(concat(collateralParamHashes));
         return keccak256(encodeAbiParameters(marketHashParams, [
             MARKET_TYPEHASH,
+            BigInt(marketParams.chainId),
+            marketParams.midnight,
             marketParams.loanToken,
             collateralParamsHash,
             BigInt(marketParams.maturity),
@@ -250,51 +324,37 @@ export 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 = getChainAddress(Number(chainId), "midnight");
-        const encodedMarket = encodeAbiParameters([marketParamsAbiParameter], [toStruct(params.market)]);
+    function toId(market) {
+        const marketParams = MarketParams.from(market);
+        const encodedMarket = encodeAbiParameters([marketParamsAbiParameter], [toStruct(marketParams)]);
         const creationHash = keccak256(concat([SSTORE2_PREFIX, encodedMarket]));
-        return keccak256(encodePacked(["uint8", "address", "uint256", "bytes32"], [255, midnight, chainId, creationHash]));
+        return keccak256(encodePacked(["uint8", "address", "uint256", "bytes32"], [255, marketParams.midnight, 0n, creationHash]));
     }
     MarketUtils.toId = toId;
 })(MarketUtils || (MarketUtils = {}));

package/lib/esm/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/esm/market/Position.js

@@ -1,4 +1,5 @@
-import { MathLib } from "@morpho-org/morpho-ts";
+import { _try, MathLib } from "@morpho-org/morpho-ts";
+import { UnknownCollateralIndexError } from "../errors.js";
 import { Market } from "./Market.js";
 import { PositionUtils } from "./PositionUtils.js";
 /**
@@ -101,14 +102,15 @@ export class Position {
  *     collateral: [50n],
  *   },
  *   {
- *     chainId: 31337,
  *     params: {
+ *       chainId: 31337,
+ *       midnight: "0x0000000000000000000000000000000000001000",
  *       loanToken: "0x0000000000000000000000000000000000006000",
  *       collateralParams: [
  *         {
  *           token: "0x0000000000000000000000000000000000007000",
  *           lltv: 770000000000000000n,
- *           maxLif: 1061007957559681697n,
+ *           liquidationCursor: 250000000000000000n,
  *           oracle: "0x0000000000000000000000000000000000008000",
  *         },
  *       ],
@@ -134,7 +136,7 @@ export class AccrualPosition extends Position {
     market;
     constructor(position, market) {
         super(position);
-        this.market = market instanceof Market ? market : new Market(market);
+        this.market = Market.from(market);
     }
     /**
      * Returns the position collateral balance at an index configured by the market.
@@ -171,14 +173,15 @@ export 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",
      *         },
      *       ],
@@ -202,7 +205,7 @@ export class AccrualPosition extends Position {
      */
     getCollateralBalanceByIndex(index) {
         const normalizedIndex = BigInt(index);
-        if (this.market.getCollateralParamsByIndex(normalizedIndex) == null)
+        if (_try(() => this.market.getCollateralByIndex(normalizedIndex), UnknownCollateralIndexError) == null)
             return undefined;
         return this.collateral[Number(normalizedIndex)] ?? 0n;
     }
@@ -242,14 +245,15 @@ export 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",
      *         },
      *       ],
@@ -310,14 +314,15 @@ export 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",
      *         },
      *       ],
@@ -380,14 +385,15 @@ export 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/esm/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/esm/market/PositionUtils.js

@@ -18,14 +18,15 @@ import { InvalidPositionAccrualStateError, InvalidPositionAccrualTimestampError,
  *     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 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",
      *         },
      *       ],
@@ -143,10 +145,12 @@ export 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,
@@ -174,7 +178,6 @@ export var PositionUtils;
                 collateral,
             },
             market: {
-                chainId: BigInt(params.market.chainId),
                 params: marketParams,
                 totalUnits: BigInt(params.market.totalUnits),
                 lossFactor: marketLossFactor,

package/lib/esm/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/esm/math/TickLib.js

@@ -1,4 +1,4 @@
-import { assertNonNegative, DivisionByZeroError, MathLib, } from "@morpho-org/morpho-ts";
+import { assertNonNegative, DivisionByZeroError, MathLib, Time, } from "@morpho-org/morpho-ts";
 import { DEFAULT_TICK_SPACING, MAX_TICK, PRICE_ROUNDING_STEP, } from "../constants.js";
 import { InvalidTickSpacingError, PriceGreaterThanOneError, TickOutOfRangeError, } from "../errors.js";
 /**
@@ -236,6 +236,36 @@ export var TickLib;
         return MathLib.mulDiv(MathLib.WAD, MathLib.WAD, price, "Up") - 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);
+        assertNonNegative("timeToMaturity", normalizedTimeToMaturity);
+        if (normalizedTimeToMaturity === 0n) {
+            throw new DivisionByZeroError("timeToMaturity");
+        }
+        return MathLib.mulDiv(tickToRate(tick), Time.s.from.y(1n), normalizedTimeToMaturity, "Up");
+    }
+    TickLib.tickToApr = tickToApr;
     /**
      * Asserts that a tick is aligned to the provided spacing.
      *

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

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

package/lib/esm/math/index.js

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