@morpho-org/midnight-sdk 0.1.0

package/lib/esm/constants.d.ts

@@ -0,0 +1,168 @@
+/**
+ * Centibip scale used by settlement fees.
+ *
+ * @example
+ * ```ts
+ * import { CBP } from "@morpho-org/midnight-sdk";
+ *
+ * console.log(CBP);
+ * ```
+ */
+export declare const CBP = 1000000000000n;
+/**
+ * Settlement-fee time-to-maturity breakpoints in seconds.
+ *
+ * Midnight linearly interpolates each market's seven settlement-fee cbp
+ * buckets across these breakpoints.
+ *
+ * @example
+ * ```ts
+ * import { SETTLEMENT_FEE_BREAKPOINTS } from "@morpho-org/midnight-sdk";
+ *
+ * console.log(SETTLEMENT_FEE_BREAKPOINTS[1]);
+ * ```
+ */
+export declare const SETTLEMENT_FEE_BREAKPOINTS: readonly [0n, bigint, bigint, bigint, bigint, bigint, bigint];
+/**
+ * Maximum Midnight tick.
+ *
+ * @example
+ * ```ts
+ * import { MAX_TICK } from "@morpho-org/midnight-sdk";
+ *
+ * console.log(MAX_TICK);
+ * ```
+ */
+export declare const MAX_TICK = 6744n;
+/**
+ * WAD price quantum used by Midnight tick prices.
+ *
+ * @example
+ * ```ts
+ * import { PRICE_ROUNDING_STEP } from "@morpho-org/midnight-sdk";
+ *
+ * console.log(PRICE_ROUNDING_STEP);
+ * ```
+ */
+export declare const PRICE_ROUNDING_STEP = 100000000000n;
+/**
+ * Default Midnight tick spacing.
+ *
+ * @example
+ * ```ts
+ * import { DEFAULT_TICK_SPACING } from "@morpho-org/midnight-sdk";
+ *
+ * console.log(DEFAULT_TICK_SPACING);
+ * ```
+ */
+export declare const DEFAULT_TICK_SPACING = 4n;
+/**
+ * Maximum collateral entries in a Midnight market.
+ *
+ * @example
+ * ```ts
+ * import { MAX_COLLATERALS } from "@morpho-org/midnight-sdk";
+ *
+ * console.log(MAX_COLLATERALS);
+ * ```
+ */
+export declare const MAX_COLLATERALS = 128n;
+/**
+ * Maximum active collateral entries per borrower.
+ *
+ * @example
+ * ```ts
+ * import { MAX_COLLATERALS_PER_BORROWER } from "@morpho-org/midnight-sdk";
+ *
+ * console.log(MAX_COLLATERALS_PER_BORROWER);
+ * ```
+ */
+export declare const MAX_COLLATERALS_PER_BORROWER = 16n;
+/**
+ * Maximum settlement-fee values by Midnight fee index.
+ *
+ * @example
+ * ```ts
+ * import { MAX_SETTLEMENT_FEES } from "@morpho-org/midnight-sdk";
+ *
+ * console.log(MAX_SETTLEMENT_FEES[0]);
+ * ```
+ */
+export declare const MAX_SETTLEMENT_FEES: readonly [14000000000000n, 14000000000000n, 98000000000000n, 417000000000000n, 1250000000000000n, 2500000000000000n, 5000000000000000n];
+/**
+ * Maximum continuous fee per second.
+ *
+ * @example
+ * ```ts
+ * import { MAX_CONTINUOUS_FEE } from "@morpho-org/midnight-sdk";
+ *
+ * console.log(MAX_CONTINUOUS_FEE);
+ * ```
+ */
+export declare const MAX_CONTINUOUS_FEE = 317097919n;
+/**
+ * Low liquidation cursor used by liquidation incentive factor helpers.
+ *
+ * @example
+ * ```ts
+ * import { LIQUIDATION_CURSOR_LOW } from "@morpho-org/midnight-sdk";
+ *
+ * console.log(LIQUIDATION_CURSOR_LOW);
+ * ```
+ */
+export declare const LIQUIDATION_CURSOR_LOW = 250000000000000000n;
+/**
+ * High liquidation cursor from Midnight ConstantsLib.
+ *
+ * @example
+ * ```ts
+ * import { LIQUIDATION_CURSOR_HIGH } from "@morpho-org/midnight-sdk";
+ *
+ * console.log(LIQUIDATION_CURSOR_HIGH);
+ * ```
+ */
+export declare const LIQUIDATION_CURSOR_HIGH = 500000000000000000n;
+/**
+ * HashLib collateral params typehash.
+ *
+ * @example
+ * ```ts
+ * import { COLLATERAL_PARAMS_TYPEHASH } from "@morpho-org/midnight-sdk";
+ *
+ * console.log(COLLATERAL_PARAMS_TYPEHASH);
+ * ```
+ */
+export declare const COLLATERAL_PARAMS_TYPEHASH = "0xaf44a88eb50ebdbbebd980e5a23045c44f61ece5f80ab708a1bbe8718102e6af";
+/**
+ * HashLib market typehash.
+ *
+ * @example
+ * ```ts
+ * import { MARKET_TYPEHASH } from "@morpho-org/midnight-sdk";
+ *
+ * console.log(MARKET_TYPEHASH);
+ * ```
+ */
+export declare const MARKET_TYPEHASH = "0x358117e98511cc3df97175dca58053b06675b43ad090b0553f8a1eff008b6e2e";
+/**
+ * HashLib offer typehash.
+ *
+ * @example
+ * ```ts
+ * import { OFFER_TYPEHASH } from "@morpho-org/midnight-sdk";
+ *
+ * console.log(OFFER_TYPEHASH);
+ * ```
+ */
+export declare const OFFER_TYPEHASH = "0x6bd2a06ec6952feb97c3e3b4f7de6c342f12b1ac769d5c91368271af636c85b7";
+/**
+ * EcrecoverRatifier EIP-712 domain typehash.
+ *
+ * @example
+ * ```ts
+ * import { EIP712_DOMAIN_TYPEHASH } from "@morpho-org/midnight-sdk";
+ *
+ * console.log(EIP712_DOMAIN_TYPEHASH);
+ * ```
+ */
+export declare const EIP712_DOMAIN_TYPEHASH = "0x47e79534a245952e8b16893a336b85a3d9ea9fa8c573f3d803afb92a79469218";

package/lib/esm/constants.js

@@ -0,0 +1,184 @@
+/**
+ * Centibip scale used by settlement fees.
+ *
+ * @example
+ * ```ts
+ * import { CBP } from "@morpho-org/midnight-sdk";
+ *
+ * console.log(CBP);
+ * ```
+ */
+export const CBP = 1000000000000n;
+/**
+ * Settlement-fee time-to-maturity breakpoints in seconds.
+ *
+ * Midnight linearly interpolates each market's seven settlement-fee cbp
+ * buckets across these breakpoints.
+ *
+ * @example
+ * ```ts
+ * import { SETTLEMENT_FEE_BREAKPOINTS } from "@morpho-org/midnight-sdk";
+ *
+ * console.log(SETTLEMENT_FEE_BREAKPOINTS[1]);
+ * ```
+ */
+export const SETTLEMENT_FEE_BREAKPOINTS = [
+    0n,
+    1n * 24n * 60n * 60n,
+    7n * 24n * 60n * 60n,
+    30n * 24n * 60n * 60n,
+    90n * 24n * 60n * 60n,
+    180n * 24n * 60n * 60n,
+    360n * 24n * 60n * 60n,
+];
+/**
+ * Maximum Midnight tick.
+ *
+ * @example
+ * ```ts
+ * import { MAX_TICK } from "@morpho-org/midnight-sdk";
+ *
+ * console.log(MAX_TICK);
+ * ```
+ */
+export const MAX_TICK = 6744n;
+/**
+ * WAD price quantum used by Midnight tick prices.
+ *
+ * @example
+ * ```ts
+ * import { PRICE_ROUNDING_STEP } from "@morpho-org/midnight-sdk";
+ *
+ * console.log(PRICE_ROUNDING_STEP);
+ * ```
+ */
+export const PRICE_ROUNDING_STEP = 100000000000n;
+/**
+ * Default Midnight tick spacing.
+ *
+ * @example
+ * ```ts
+ * import { DEFAULT_TICK_SPACING } from "@morpho-org/midnight-sdk";
+ *
+ * console.log(DEFAULT_TICK_SPACING);
+ * ```
+ */
+export const DEFAULT_TICK_SPACING = 4n;
+/**
+ * Maximum collateral entries in a Midnight market.
+ *
+ * @example
+ * ```ts
+ * import { MAX_COLLATERALS } from "@morpho-org/midnight-sdk";
+ *
+ * console.log(MAX_COLLATERALS);
+ * ```
+ */
+export const MAX_COLLATERALS = 128n;
+/**
+ * Maximum active collateral entries per borrower.
+ *
+ * @example
+ * ```ts
+ * import { MAX_COLLATERALS_PER_BORROWER } from "@morpho-org/midnight-sdk";
+ *
+ * console.log(MAX_COLLATERALS_PER_BORROWER);
+ * ```
+ */
+export const MAX_COLLATERALS_PER_BORROWER = 16n;
+/**
+ * Maximum settlement-fee values by Midnight fee index.
+ *
+ * @example
+ * ```ts
+ * import { MAX_SETTLEMENT_FEES } from "@morpho-org/midnight-sdk";
+ *
+ * console.log(MAX_SETTLEMENT_FEES[0]);
+ * ```
+ */
+export const MAX_SETTLEMENT_FEES = [
+    14000000000000n,
+    14000000000000n,
+    98000000000000n,
+    417000000000000n,
+    1250000000000000n,
+    2500000000000000n,
+    5000000000000000n,
+];
+/**
+ * Maximum continuous fee per second.
+ *
+ * @example
+ * ```ts
+ * import { MAX_CONTINUOUS_FEE } from "@morpho-org/midnight-sdk";
+ *
+ * console.log(MAX_CONTINUOUS_FEE);
+ * ```
+ */
+export const MAX_CONTINUOUS_FEE = 317097919n;
+/**
+ * Low liquidation cursor used by liquidation incentive factor helpers.
+ *
+ * @example
+ * ```ts
+ * import { LIQUIDATION_CURSOR_LOW } from "@morpho-org/midnight-sdk";
+ *
+ * console.log(LIQUIDATION_CURSOR_LOW);
+ * ```
+ */
+export const LIQUIDATION_CURSOR_LOW = 250000000000000000n;
+/**
+ * High liquidation cursor from Midnight ConstantsLib.
+ *
+ * @example
+ * ```ts
+ * import { LIQUIDATION_CURSOR_HIGH } from "@morpho-org/midnight-sdk";
+ *
+ * console.log(LIQUIDATION_CURSOR_HIGH);
+ * ```
+ */
+export const LIQUIDATION_CURSOR_HIGH = 500000000000000000n;
+/**
+ * HashLib collateral params typehash.
+ *
+ * @example
+ * ```ts
+ * import { COLLATERAL_PARAMS_TYPEHASH } from "@morpho-org/midnight-sdk";
+ *
+ * console.log(COLLATERAL_PARAMS_TYPEHASH);
+ * ```
+ */
+export const COLLATERAL_PARAMS_TYPEHASH = "0xaf44a88eb50ebdbbebd980e5a23045c44f61ece5f80ab708a1bbe8718102e6af";
+/**
+ * HashLib market typehash.
+ *
+ * @example
+ * ```ts
+ * import { MARKET_TYPEHASH } from "@morpho-org/midnight-sdk";
+ *
+ * console.log(MARKET_TYPEHASH);
+ * ```
+ */
+export const MARKET_TYPEHASH = "0x358117e98511cc3df97175dca58053b06675b43ad090b0553f8a1eff008b6e2e";
+/**
+ * HashLib offer typehash.
+ *
+ * @example
+ * ```ts
+ * import { OFFER_TYPEHASH } from "@morpho-org/midnight-sdk";
+ *
+ * console.log(OFFER_TYPEHASH);
+ * ```
+ */
+export const OFFER_TYPEHASH = "0x6bd2a06ec6952feb97c3e3b4f7de6c342f12b1ac769d5c91368271af636c85b7";
+/**
+ * EcrecoverRatifier EIP-712 domain typehash.
+ *
+ * @example
+ * ```ts
+ * import { EIP712_DOMAIN_TYPEHASH } from "@morpho-org/midnight-sdk";
+ *
+ * console.log(EIP712_DOMAIN_TYPEHASH);
+ * ```
+ */
+export const EIP712_DOMAIN_TYPEHASH = "0x47e79534a245952e8b16893a336b85a3d9ea9fa8c573f3d803afb92a79469218";

package/lib/esm/errors.d.ts

@@ -0,0 +1,253 @@
+import type { Address } from "viem";
+/**
+ * Thrown when a Midnight offer group violates protocol-level group mechanics.
+ *
+ * @example
+ * ```ts
+ * import { InvalidOfferGroupError } from "@morpho-org/midnight-sdk";
+ *
+ * throw new InvalidOfferGroupError("All offers in a group must use the same maker.");
+ * ```
+ */
+export declare class InvalidOfferGroupError extends Error {
+    constructor(reason: string);
+}
+/**
+ * Thrown when a tick exceeds the deployed TickLib range.
+ *
+ * @example
+ * ```ts
+ * import { TickOutOfRangeError } from "@morpho-org/midnight-sdk";
+ *
+ * const error = new TickOutOfRangeError(7000n, 6744n);
+ * console.log(error.message);
+ * ```
+ */
+export declare class TickOutOfRangeError extends Error {
+    constructor(tick: bigint, maxTick: bigint);
+}
+/**
+ * Thrown when a price is above the maximum WAD price accepted by TickLib.
+ *
+ * @example
+ * ```ts
+ * import { PriceGreaterThanOneError } from "@morpho-org/midnight-sdk";
+ *
+ * throw new PriceGreaterThanOneError(2n * 10n ** 18n);
+ * ```
+ */
+export declare class PriceGreaterThanOneError extends Error {
+    constructor(price: bigint);
+}
+/**
+ * Thrown when tick spacing is invalid or a tick is not aligned to it.
+ *
+ * @example
+ * ```ts
+ * import { InvalidTickSpacingError } from "@morpho-org/midnight-sdk";
+ *
+ * throw new InvalidTickSpacingError(5n, 4n);
+ * ```
+ */
+export declare class InvalidTickSpacingError extends Error {
+    constructor(spacing: bigint);
+    constructor(tick: bigint, spacing: bigint);
+}
+/**
+ * Thrown when a buy offer's settlement fee exceeds its tick price.
+ *
+ * @example
+ * ```ts
+ * import { SettlementFeeExceedsPriceError } from "@morpho-org/midnight-sdk";
+ *
+ * throw new SettlementFeeExceedsPriceError(10n, 9n);
+ * ```
+ */
+export declare class SettlementFeeExceedsPriceError extends Error {
+    constructor(settlementFee: bigint, price: bigint);
+}
+/**
+ * Thrown when a local position accrual is requested for an impossible timestamp.
+ *
+ * @example
+ * ```ts
+ * import { InvalidPositionAccrualTimestampError } from "@morpho-org/midnight-sdk";
+ *
+ * throw new InvalidPositionAccrualTimestampError(1n, 2n);
+ * ```
+ */
+export declare class InvalidPositionAccrualTimestampError extends Error {
+    constructor(timestamp: bigint, lastAccrual: bigint);
+}
+/**
+ * Thrown when a local position accrual sees a market loss factor older than the position.
+ *
+ * @example
+ * ```ts
+ * import { InvalidPositionLossFactorError } from "@morpho-org/midnight-sdk";
+ *
+ * throw new InvalidPositionLossFactorError(1n, 2n);
+ * ```
+ */
+export declare class InvalidPositionLossFactorError extends Error {
+    constructor(marketLossFactor: bigint, positionLossFactor: bigint);
+}
+/**
+ * Thrown when local position accrual inputs violate Midnight accounting invariants.
+ *
+ * @example
+ * ```ts
+ * import { InvalidPositionAccrualStateError } from "@morpho-org/midnight-sdk";
+ *
+ * throw new InvalidPositionAccrualStateError("Pending fee exceeds credit.");
+ * ```
+ */
+export declare class InvalidPositionAccrualStateError extends Error {
+    constructor(reason: string);
+}
+/**
+ * Thrown when a market parameter cannot satisfy Midnight protocol rules.
+ *
+ * @example
+ * ```ts
+ * import { InvalidMarketParameterError } from "@morpho-org/midnight-sdk";
+ *
+ * throw new InvalidMarketParameterError({
+ *   parameter: "collateralParams",
+ *   value: 0,
+ *   instruction: "Provide at least one collateral.",
+ * });
+ * ```
+ * @param params.parameter - Invalid market parameter name.
+ * @param params.value - Invalid market parameter value.
+ * @param params.instruction - Optional instruction appended to the error message.
+ * @param params.cause - Optional wrapped cause.
+ */
+export declare class InvalidMarketParameterError extends Error {
+    /** Invalid market parameter name. */
+    readonly parameter: string;
+    /** Invalid market parameter value. */
+    readonly value: unknown;
+    constructor(params: {
+        readonly parameter: string;
+        readonly value: unknown;
+        readonly instruction?: string;
+        readonly cause?: unknown;
+    });
+}
+/**
+ * Thrown when an offer builder receives a parameter that cannot satisfy Midnight protocol rules.
+ *
+ * @example
+ * ```ts
+ * import { InvalidOfferParameterError } from "@morpho-org/midnight-sdk";
+ *
+ * throw new InvalidOfferParameterError({ parameter: "tick", value: 5821n });
+ * ```
+ * @param params.parameter - Invalid offer parameter name.
+ * @param params.value - Invalid offer parameter value.
+ * @param params.instruction - Optional instruction appended to the error message.
+ * @param params.cause - Optional wrapped cause.
+ */
+export declare class InvalidOfferParameterError extends Error {
+    /** Invalid offer parameter name. */
+    readonly parameter: string;
+    /** Invalid offer parameter value. */
+    readonly value: unknown;
+    constructor(params: {
+        readonly parameter: string;
+        readonly value: unknown;
+        readonly instruction?: string;
+        readonly cause?: unknown;
+    });
+}
+/**
+ * Thrown when a tree height exceeds the ratifier typehash table.
+ *
+ * @example
+ * ```ts
+ * import { InvalidTreeHeightError } from "@morpho-org/midnight-sdk";
+ *
+ * throw new InvalidTreeHeightError(21);
+ * ```
+ */
+export declare class InvalidTreeHeightError extends Error {
+    constructor(height: number);
+}
+/**
+ * Thrown when a tree cannot be represented by the ratifiers.
+ *
+ * @example
+ * ```ts
+ * import { InvalidTreeError } from "@morpho-org/midnight-sdk";
+ *
+ * throw new InvalidTreeError("Tree must not be empty.");
+ * ```
+ */
+export declare class InvalidTreeError extends Error {
+    constructor(message: string);
+}
+/**
+ * Thrown when a typed-data signature does not recover to the expected signer.
+ *
+ * @example
+ * ```ts
+ * import { InvalidTypedDataSignatureError } from "@morpho-org/midnight-sdk";
+ *
+ * throw new InvalidTypedDataSignatureError(
+ *   "0x0000000000000000000000000000000000000001",
+ * );
+ * ```
+ */
+export declare class InvalidTypedDataSignatureError extends Error {
+    /** Signer address the signature was expected to recover. */
+    readonly signer: Address;
+    constructor(signer: Address);
+}
+/**
+ * Thrown when the Midnight API returns a non-2xx response.
+ *
+ * @example
+ * ```ts
+ * import { MidnightApiError } from "@morpho-org/midnight-sdk/api";
+ *
+ * throw new MidnightApiError({
+ *   status: 400,
+ *   code: "BAD_REQUEST",
+ *   message: "Limit must be greater than 0.",
+ *   details: [{ field: "limit", issue: "Limit must be greater than 0." }],
+ *   requestId: "req-123",
+ * });
+ * ```
+ */
+export declare class MidnightApiError extends Error {
+    /** HTTP response status from the API. */
+    readonly status: number;
+    /** API error code, when the response body includes one. */
+    readonly code?: string;
+    /** API error details, when the response body includes them. */
+    readonly details?: unknown;
+    /** API request id, when the response body includes one. */
+    readonly requestId?: string;
+    constructor(params: {
+        readonly status: number;
+        readonly code?: string;
+        readonly message?: string;
+        readonly details?: unknown;
+        readonly requestId?: string;
+        readonly cause?: unknown;
+    });
+}
+/**
+ * Thrown when the Midnight API returns a malformed successful response.
+ *
+ * @example
+ * ```ts
+ * import { InvalidMidnightApiResponseError } from "@morpho-org/midnight-sdk/api";
+ *
+ * throw new InvalidMidnightApiResponseError("API response is missing data.");
+ * ```
+ */
+export declare class InvalidMidnightApiResponseError extends Error {
+    constructor(message: string, options?: ErrorOptions);
+}