@morpho-org/midnight-sdk 0.1.0

package/lib/esm/api/helpers.d.ts

@@ -0,0 +1,20 @@
+import type { Hash } from "viem";
+import type { ApiBookMarketResponse, ApiCollateralResponse, ApiPriceLevelResponse, ApiRequestParams, ApiTakeableOfferResponse, MempoolPayloadValidationResult, MidnightApiBookMarket, MidnightApiBookSide, MidnightApiCollateral, MidnightApiPriceLevel, MidnightApiTake } from "./types.js";
+/** @internal Sends one Midnight API request and maps non-2xx responses to SDK errors. */
+export declare function requestMidnightApi<Response = unknown>(params: ApiRequestParams): Promise<Response>;
+/** @internal Builds a book endpoint path with encoded path segments. */
+export declare function buildBookPath(params: {
+    readonly marketId: Hash;
+    readonly side?: MidnightApiBookSide;
+    readonly suffix?: "quote" | "takeable-offers";
+}): string;
+/** @internal Maps a book market API payload to the SDK response shape. */
+export declare function mapBookMarket(book: ApiBookMarketResponse): MidnightApiBookMarket;
+/** @internal Maps a collateral API payload to the SDK response shape. */
+export declare function mapCollateral(collateral: ApiCollateralResponse): MidnightApiCollateral;
+/** @internal Maps a price-level API payload to the SDK response shape. */
+export declare function mapPriceLevel(level: ApiPriceLevelResponse): MidnightApiPriceLevel;
+/** @internal Maps a takeable-offer API payload to the SDK response shape. */
+export declare function mapTakeableOffer(takeableOffer: ApiTakeableOfferResponse): MidnightApiTake;
+/** @internal Parses the mempool validation response envelope. */
+export declare function parseValidationResponse(response: unknown): MempoolPayloadValidationResult;

package/lib/esm/api/helpers.js

@@ -0,0 +1,180 @@
+import { BLUE_API_BASE_URL } from "@morpho-org/morpho-ts";
+import { InvalidMidnightApiResponseError, MidnightApiError, } from "../errors.js";
+const DEFAULT_MIDNIGHT_API_URL = new URL("/v1/midnight", BLUE_API_BASE_URL);
+// Keep this literal in source so the browser ESM build does not import package.json
+// through Node-only createRequire/module shims.
+const MIDNIGHT_SDK_VERSION = "0.1.0";
+/** @internal Sends one Midnight API request and maps non-2xx responses to SDK errors. */
+export async function requestMidnightApi(params) {
+    const baseUrl = new URL(params.baseUrl ?? DEFAULT_MIDNIGHT_API_URL);
+    baseUrl.search = "";
+    baseUrl.hash = "";
+    if (!baseUrl.pathname.endsWith("/")) {
+        baseUrl.pathname = `${baseUrl.pathname}/`;
+    }
+    const relativePath = params.path.startsWith("/")
+        ? params.path.slice(1)
+        : params.path;
+    const url = new URL(relativePath, baseUrl);
+    url.search = "";
+    url.hash = "";
+    if (params.query != null) {
+        for (const [key, value] of Object.entries(params.query)) {
+            if (value === undefined)
+                continue;
+            if (Array.isArray(value) && value.length === 0)
+                continue;
+            url.searchParams.set(key, Array.isArray(value)
+                ? value.map(String).join(",")
+                : value instanceof Date
+                    ? value.toISOString()
+                    : String(value));
+        }
+    }
+    const headers = new Headers(params.request?.headers);
+    if (params.body !== undefined)
+        headers.set("Content-Type", "application/json");
+    headers.set("sdk-version", MIDNIGHT_SDK_VERSION);
+    const init = {
+        ...params.request,
+        method: params.method,
+        headers,
+    };
+    init.body =
+        params.body === undefined ? undefined : JSON.stringify(params.body);
+    const response = await (params.fetch ?? globalThis.fetch)(url, init);
+    let json;
+    let jsonParseError;
+    try {
+        json = await response.json();
+    }
+    catch (error) {
+        if (response.ok) {
+            throw new InvalidMidnightApiResponseError("Midnight API success response did not contain valid JSON.", { cause: error });
+        }
+        jsonParseError = error;
+        json = undefined;
+    }
+    if (!response.ok) {
+        const error = isRecord(json) && isRecord(json.error) ? json.error : undefined;
+        throw new MidnightApiError({
+            status: response.status,
+            code: typeof error?.code === "string" ? error.code : undefined,
+            message: typeof error?.message === "string" ? error.message : undefined,
+            details: error != null && "details" in error ? error.details : undefined,
+            requestId: typeof error?.request_id === "string" ? error.request_id : undefined,
+            cause: jsonParseError,
+        });
+    }
+    return json;
+}
+/** @internal Builds a book endpoint path with encoded path segments. */
+export function buildBookPath(params) {
+    const segments = [
+        "books",
+        params.marketId,
+        params.side,
+        params.suffix,
+    ].filter((segment) => segment !== undefined);
+    return segments.map(encodeURIComponent).join("/");
+}
+/** @internal Maps a book market API payload to the SDK response shape. */
+export function mapBookMarket(book) {
+    return {
+        marketId: book.market_id,
+        chainId: book.chain_id,
+        loanToken: book.loan_token,
+        collaterals: book.collaterals.map(mapCollateral),
+        maturity: book.maturity,
+        rcfThreshold: book.rcf_threshold,
+        enterGate: book.enter_gate,
+        liquidatorGate: book.liquidator_gate,
+        asks: book.asks.map(mapPriceLevel),
+        bids: book.bids.map(mapPriceLevel),
+    };
+}
+/** @internal Maps a collateral API payload to the SDK response shape. */
+export function mapCollateral(collateral) {
+    return {
+        token: collateral.token,
+        lltv: collateral.lltv,
+        maxLif: collateral.max_lif,
+        oracle: collateral.oracle,
+    };
+}
+/** @internal Maps a price-level API payload to the SDK response shape. */
+export function mapPriceLevel(level) {
+    return {
+        tick: level.tick,
+        price: level.price,
+        units: level.units,
+        assets: level.assets,
+        count: level.count,
+    };
+}
+/** @internal Maps a takeable-offer API payload to the SDK response shape. */
+export function mapTakeableOffer(takeableOffer) {
+    const offer = takeableOffer.offer;
+    return {
+        marketId: takeableOffer.market_id,
+        units: BigInt(takeableOffer.units),
+        offer: {
+            market: {
+                loanToken: offer.market.loan_token,
+                collateralParams: offer.market.collaterals.map((collateral) => ({
+                    token: collateral.token,
+                    lltv: BigInt(collateral.lltv),
+                    maxLif: BigInt(collateral.max_lif),
+                    oracle: collateral.oracle,
+                })),
+                maturity: BigInt(offer.market.maturity),
+                rcfThreshold: BigInt(offer.market.rcf_threshold),
+                enterGate: offer.market.enter_gate,
+                liquidatorGate: offer.market.liquidator_gate,
+            },
+            buy: offer.buy,
+            maker: offer.maker,
+            start: BigInt(offer.start),
+            expiry: BigInt(offer.expiry),
+            tick: BigInt(offer.tick),
+            group: offer.group,
+            callback: offer.callback,
+            callbackData: offer.callback_data,
+            receiverIfMakerIsSeller: offer.receiver_if_maker_is_seller,
+            ratifier: offer.ratifier,
+            reduceOnly: offer.reduce_only,
+            maxUnits: BigInt(offer.max_units),
+            maxAssets: BigInt(offer.max_assets),
+            continuousFeeCap: BigInt(offer.continuous_fee_cap),
+        },
+        ratifierData: takeableOffer.ratifier_data,
+    };
+}
+/** @internal Parses the mempool validation response envelope. */
+export function parseValidationResponse(response) {
+    const parsedResponse = requireRecord(response, "validation response");
+    const data = requireRecord(parsedResponse.data, "validation response data");
+    if (!Array.isArray(data.issues)) {
+        throw new InvalidMidnightApiResponseError('Midnight API validation response is missing "data.issues".');
+    }
+    const issues = data.issues.map((issue) => {
+        const record = requireRecord(issue, "validation issue");
+        const rule = record.rule;
+        if (typeof rule !== "string") {
+            throw new InvalidMidnightApiResponseError('Midnight API validation issue is missing "rule".');
+        }
+        return { rule };
+    });
+    return {
+        valid: issues.length === 0,
+        issues,
+    };
+}
+function requireRecord(value, context) {
+    if (isRecord(value))
+        return value;
+    throw new InvalidMidnightApiResponseError(`Midnight API ${context} is malformed.`);
+}
+function isRecord(value) {
+    return typeof value === "object" && value !== null && !Array.isArray(value);
+}

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

@@ -0,0 +1,2 @@
+export { InvalidMidnightApiResponseError, MidnightApiError, } from "../errors.js";
+export * from "./MidnightApi.js";

package/lib/esm/api/index.js

@@ -0,0 +1,2 @@
+export { InvalidMidnightApiResponseError, MidnightApiError, } from "../errors.js";
+export * from "./MidnightApi.js";

package/lib/esm/api/types.d.ts

@@ -0,0 +1,453 @@
+import type { BigIntish } from "@morpho-org/morpho-ts";
+import type { Address, Hash, Hex } from "viem";
+import type { OfferStruct } from "../offers/Offer.js";
+import type { Item as MidnightPayloadItem } from "../signatures/Payload.js";
+/**
+ * Fetch implementation used by Midnight API helpers.
+ */
+export type MidnightApiFetch = typeof fetch;
+/**
+ * Request options forwarded to Midnight API calls.
+ *
+ * The SDK owns `method` and `body`; callers can still pass headers, abort
+ * signals, credentials, cache settings, and other fetch options.
+ */
+export type MidnightApiRequestOptions = Omit<RequestInit, "method" | "body">;
+/**
+ * Shared configuration for Midnight API calls.
+ */
+export interface MidnightApiConfig {
+    /** Midnight API base URL. Defaults to `https://api.morpho.org/v1/midnight`. */
+    readonly baseUrl?: string | URL;
+    /** Fetch implementation. Defaults to the global `fetch`. */
+    readonly fetch?: MidnightApiFetch;
+    /** Additional fetch options forwarded to the request. */
+    readonly request?: MidnightApiRequestOptions;
+}
+/**
+ * Constructor input for {@link MidnightApi}.
+ */
+export type MidnightApiConstructorConfig = string | URL | MidnightApiConfig;
+/**
+ * Removes shared instance configuration keys from a parameter union.
+ */
+export type MidnightApiClientParams<Params extends MidnightApiConfig> = Params extends unknown ? Omit<Params, keyof MidnightApiConfig> : never;
+/**
+ * Book side accepted by Midnight API book routes.
+ */
+export type MidnightApiBookSide = "asks" | "bids";
+/**
+ * Book list sort field accepted by the Midnight API.
+ */
+export type MidnightApiBookSortField = "id" | "ask" | "bid" | "maturity";
+/**
+ * One Midnight API book sort term. Prefix with `-` for descending order.
+ */
+export type MidnightApiBookSortTerm = MidnightApiBookSortField | `-${MidnightApiBookSortField}`;
+/**
+ * Book list sort input. Strings are forwarded as comma-separated API sort keys.
+ */
+export type MidnightApiBookSort = string | readonly MidnightApiBookSortTerm[];
+/**
+ * Quote slippage percentage accepted by the Midnight API.
+ */
+export type MidnightApiSlippage = string | number;
+/**
+ * Parameters for {@link MidnightApi.validateMempoolPayload}.
+ */
+export interface ValidateMempoolPayloadParams extends MidnightApiConfig {
+    /** Chain id whose API policy should validate the payload. */
+    readonly chainId: number;
+    /** Encoded Midnight mempool payload bytes. */
+    readonly payload: Hex;
+    /** Optional ISO-8601 timestamp or `Date` selecting the API policy snapshot. */
+    readonly timestamp?: string | Date;
+}
+/**
+ * Parameters for {@link MidnightApi.validateMempoolItems}.
+ */
+export interface ValidateMempoolItemsParams extends MidnightApiConfig {
+    /** Chain id whose API policy should validate the payload. */
+    readonly chainId: number;
+    /** SDK-native payload items to encode before API validation. */
+    readonly items: readonly MidnightPayloadItem[];
+    /** Optional ISO-8601 timestamp or `Date` selecting the API policy snapshot. */
+    readonly timestamp?: string | Date;
+}
+/**
+ * Parameters for {@link MidnightApi.fetchBooks}.
+ */
+export interface FetchBooksParams extends MidnightApiConfig {
+    /** Sort fields, either already comma-separated or as individual terms. */
+    readonly sort?: MidnightApiBookSort;
+    /** Exact maturity timestamp filters in unix seconds. */
+    readonly maturities?: readonly number[];
+    /** Collateral token address filters. */
+    readonly collateralTokens?: readonly Address[];
+    /** Loan token address filters. */
+    readonly loanTokens?: readonly Address[];
+    /** Chain id filters. */
+    readonly chainIds?: readonly number[];
+    /** Market id filters. */
+    readonly marketIds?: readonly Hash[];
+    /** Maximum number of books to return. */
+    readonly limit?: number;
+    /** Opaque pagination cursor from a previous response. */
+    readonly cursor?: string;
+}
+/**
+ * Parameters for {@link MidnightApi.fetchBook}.
+ */
+export interface FetchBookParams extends MidnightApiConfig {
+    /** Market id whose book to read. */
+    readonly marketId: Hash;
+    /** Maximum levels returned per side. */
+    readonly depth?: number;
+}
+/**
+ * Parameters for {@link MidnightApi.fetchBookPriceLevels}.
+ */
+export interface FetchBookPriceLevelsParams extends MidnightApiConfig {
+    /** Market id whose book side to read. */
+    readonly marketId: Hash;
+    /** Book side to query. */
+    readonly side: MidnightApiBookSide;
+    /** Maximum levels returned. */
+    readonly depth?: number;
+}
+/**
+ * Parameters for {@link MidnightApi.fetchBookTakeableOffers}.
+ */
+export interface FetchBookTakeableOffersParams extends MidnightApiConfig {
+    /** Market id whose book side to read. */
+    readonly marketId: Hash;
+    /** Book side to query. */
+    readonly side: MidnightApiBookSide;
+}
+/**
+ * Quote target specified as maker-side assets.
+ */
+export interface MidnightApiQuoteAssetsTarget {
+    /** Target assets amount. */
+    readonly assets: BigIntish;
+    /** Mutually exclusive with `assets`. */
+    readonly units?: never;
+}
+/**
+ * Quote target specified as units.
+ */
+export interface MidnightApiQuoteUnitsTarget {
+    /** Target unit amount. */
+    readonly units: BigIntish;
+    /** Mutually exclusive with `units`. */
+    readonly assets?: never;
+}
+/**
+ * Quote price guard specified directly as a WAD-scaled average worst price.
+ */
+export interface MidnightApiQuoteAverageWorstPriceGuard {
+    /** Average worst price guard. */
+    readonly averageWorstPrice: BigIntish;
+    /** Mutually exclusive with `averageWorstPrice`. */
+    readonly slippage?: never;
+}
+/**
+ * Quote price guard specified as a slippage percentage.
+ */
+export interface MidnightApiQuoteSlippageGuard {
+    /** Slippage percentage used to derive the guard. */
+    readonly slippage: MidnightApiSlippage;
+    /** Mutually exclusive with `slippage`. */
+    readonly averageWorstPrice?: never;
+}
+/**
+ * Quote request without a client-side price guard.
+ */
+export interface MidnightApiQuoteWithoutGuard {
+    /** No average worst price guard. */
+    readonly averageWorstPrice?: undefined;
+    /** No slippage guard. */
+    readonly slippage?: undefined;
+}
+/**
+ * Parameters for {@link MidnightApi.fetchBookQuote}.
+ */
+export type FetchBookQuoteParams = MidnightApiConfig & {
+    /** Market id whose book side to quote. */
+    readonly marketId: Hash;
+    /** Book side to quote. */
+    readonly side: MidnightApiBookSide;
+} & (MidnightApiQuoteAssetsTarget | MidnightApiQuoteUnitsTarget) & (MidnightApiQuoteAverageWorstPriceGuard | MidnightApiQuoteSlippageGuard | MidnightApiQuoteWithoutGuard);
+/**
+ * Parameters for {@link MidnightApi.fetchTakeableOffers}.
+ */
+export interface FetchTakeableOffersParams extends MidnightApiConfig {
+    /** Maker EVM address. */
+    readonly maker: Address;
+    /** Market id filters. */
+    readonly marketIds?: readonly Hash[];
+    /** Group id filters. */
+    readonly groups?: readonly Hash[];
+    /** Maximum number of offers to return. */
+    readonly limit?: number;
+    /** Opaque pagination cursor from a previous response. */
+    readonly cursor?: string;
+}
+/**
+ * One API validation issue.
+ */
+export interface MempoolPayloadValidationIssue {
+    /** API rule violated by the payload. */
+    readonly rule: string;
+}
+/**
+ * SDK-shaped result returned by Midnight mempool validation.
+ */
+export interface MempoolPayloadValidationResult {
+    /** Whether the API returned zero validation issues. */
+    readonly valid: boolean;
+    /** Payload-level API issues. */
+    readonly issues: readonly MempoolPayloadValidationIssue[];
+}
+/**
+ * Collateral metadata returned by Midnight API book routes.
+ */
+export interface MidnightApiCollateral {
+    /** Collateral token address. */
+    readonly token: Address;
+    /** WAD-scaled liquidation loan-to-value. */
+    readonly lltv: string;
+    /** WAD-scaled maximum liquidation incentive factor. */
+    readonly maxLif: string;
+    /** Oracle address used to price this collateral. */
+    readonly oracle: Address;
+}
+/**
+ * Price level returned by Midnight API book routes.
+ */
+export interface MidnightApiPriceLevel {
+    /** Midnight tick. */
+    readonly tick: number;
+    /** WAD-scaled price at this tick. */
+    readonly price: string;
+    /** Total executable units at this tick. */
+    readonly units: string;
+    /** Total maker-side assets at this tick. */
+    readonly assets: string;
+    /** Number of offers grouped into this level. */
+    readonly count: number;
+}
+/**
+ * Market and top-of-book metadata returned by Midnight API book routes.
+ */
+export interface MidnightApiBookMarket {
+    /** Market id. */
+    readonly marketId: Hash;
+    /** Chain id the market lives on. */
+    readonly chainId: number;
+    /** Loan token address. */
+    readonly loanToken: Address;
+    /** Collateral definitions for the market. */
+    readonly collaterals: readonly MidnightApiCollateral[];
+    /** Market maturity timestamp in unix seconds. */
+    readonly maturity: number;
+    /** Recovery close factor threshold. */
+    readonly rcfThreshold: string;
+    /** Entry gate address. */
+    readonly enterGate: Address;
+    /** Liquidator gate address. */
+    readonly liquidatorGate: Address;
+    /** Ask levels sorted best first. */
+    readonly asks: readonly MidnightApiPriceLevel[];
+    /** Bid levels sorted best first. */
+    readonly bids: readonly MidnightApiPriceLevel[];
+}
+/**
+ * Paginated Midnight API books result.
+ */
+export interface MidnightApiBooksResult {
+    /** Opaque pagination cursor, or `null` when no next page exists. */
+    readonly cursor: string | null;
+    /** Books with market metadata and top price levels. */
+    readonly data: readonly MidnightApiBookMarket[];
+}
+/**
+ * Midnight API single-book result.
+ */
+export interface MidnightApiBookResult {
+    /** Book snapshot with market metadata and both sides. */
+    readonly data: MidnightApiBookMarket;
+}
+/**
+ * ABI-ready take returned by Midnight API book and quote routes.
+ *
+ * This shape matches the Midnight periphery `Take` tuple. Pass `offer`,
+ * `ratifierData`, and `units` directly to `IMidnight.take`, or pass the object
+ * in the `takes` array of a target-aware `MidnightBundles` call. `marketId` is
+ * API metadata and is ignored by ABI encoders.
+ */
+export interface MidnightApiTake {
+    /** Market id the offer belongs to. */
+    readonly marketId: Hash;
+    /** Executable or currently reserved offer size in units. */
+    readonly units: bigint;
+    /** Inline protocol offer. */
+    readonly offer: OfferStruct;
+    /** Ratifier data generated by the maker. */
+    readonly ratifierData: Hex;
+}
+/**
+ * Non-paginated takeable offers returned for a book side.
+ */
+export interface MidnightApiBookTakeableOffersResult {
+    /** Takeable offers for the requested book side. */
+    readonly data: readonly MidnightApiTake[];
+}
+/**
+ * One side of a Midnight API book grouped by price level.
+ */
+export interface MidnightApiBookPriceLevelsResult {
+    /** Book price levels grouped by tick, sorted best first. */
+    readonly data: readonly MidnightApiPriceLevel[];
+}
+/**
+ * Quote returned by Midnight API book quote routes.
+ */
+export interface MidnightApiQuote {
+    /** Weighted average price for the requested size before any guard. */
+    readonly averageBestPrice: string;
+    /** Effective weighted average-price guard for the returned instructions. */
+    readonly averageWorstPrice: string;
+    /** Maximum assets available from the returned take caps. */
+    readonly availableAssets: string;
+    /** Maximum units available from the returned take caps. */
+    readonly availableUnits: string;
+    /**
+     * Best-priced signed takeable-offer caps for target-aware bundle execution.
+     *
+     * The sum can exceed the requested target. Clamp each offer to the remaining
+     * target before calling Midnight.take directly.
+     */
+    readonly takeableOffers: readonly MidnightApiTake[];
+}
+/**
+ * Quote response returned by Midnight API book quote routes.
+ */
+export interface MidnightApiQuoteResult {
+    /** Quote result and signed takeable-offer caps. */
+    readonly data: MidnightApiQuote;
+}
+/**
+ * Paginated maker takeable offers result.
+ */
+export interface MidnightApiTakeableOffersResult {
+    /** Opaque pagination cursor, or `null` when no next page exists. */
+    readonly cursor: string | null;
+    /** Takeable offers for the requested maker. */
+    readonly data: readonly MidnightApiTake[];
+}
+/** @internal HTTP method owned by Midnight API helpers. */
+export type ApiMethod = "GET" | "POST";
+/** @internal Query values serializable by Midnight API helpers. */
+export type QueryValue = string | number | bigint | boolean | Date | readonly string[] | readonly number[] | undefined;
+/** @internal Request descriptor consumed by the Midnight API HTTP helper. */
+export type ApiRequestParams = MidnightApiConfig & {
+    readonly method: ApiMethod;
+    readonly path: string;
+    readonly query?: Readonly<Record<string, QueryValue>>;
+    readonly body?: unknown;
+};
+/** @internal Collateral response shape returned by the API. */
+export type ApiCollateralResponse = {
+    readonly token: Address;
+    readonly lltv: string;
+    readonly max_lif: string;
+    readonly oracle: Address;
+};
+/** @internal Price-level response shape returned by the API. */
+export type ApiPriceLevelResponse = {
+    readonly tick: number;
+    readonly price: string;
+    readonly units: string;
+    readonly assets: string;
+    readonly count: number;
+};
+/** @internal Book response shape returned by the API. */
+export type ApiBookMarketResponse = {
+    readonly market_id: Hash;
+    readonly chain_id: number;
+    readonly loan_token: Address;
+    readonly collaterals: readonly ApiCollateralResponse[];
+    readonly maturity: number;
+    readonly rcf_threshold: string;
+    readonly enter_gate: Address;
+    readonly liquidator_gate: Address;
+    readonly asks: readonly ApiPriceLevelResponse[];
+    readonly bids: readonly ApiPriceLevelResponse[];
+};
+/** @internal Books response shape returned by the API. */
+export type ApiBooksResponse = {
+    readonly cursor: string | null;
+    readonly data: readonly ApiBookMarketResponse[];
+};
+/** @internal Single-book response shape returned by the API. */
+export type ApiBookResponse = {
+    readonly data: ApiBookMarketResponse;
+};
+/** @internal Price-level response shape returned by the API. */
+export type ApiPriceLevelsResponse = {
+    readonly data: readonly ApiPriceLevelResponse[];
+};
+/** @internal Offer market response shape returned by the API. */
+export type ApiOfferMarketResponse = {
+    readonly loan_token: Address;
+    readonly collaterals: readonly ApiCollateralResponse[];
+    readonly maturity: number;
+    readonly rcf_threshold: string;
+    readonly enter_gate: Address;
+    readonly liquidator_gate: Address;
+};
+/** @internal Inline offer response shape returned by the API. */
+export type ApiOfferResponse = {
+    readonly market: ApiOfferMarketResponse;
+    readonly buy: boolean;
+    readonly maker: Address;
+    readonly max_units: string;
+    readonly start: number;
+    readonly expiry: number;
+    readonly tick: number;
+    readonly group: Hash;
+    readonly callback: Address;
+    readonly callback_data: Hex;
+    readonly receiver_if_maker_is_seller: Address;
+    readonly ratifier: Address;
+    readonly reduce_only: boolean;
+    readonly max_assets: string;
+    readonly continuous_fee_cap: string;
+};
+/** @internal Takeable-offer response shape returned by the API. */
+export type ApiTakeableOfferResponse = {
+    readonly market_id: Hash;
+    readonly units: string;
+    readonly offer: ApiOfferResponse;
+    readonly ratifier_data: Hex;
+};
+/** @internal Book takeable-offers response shape returned by the API. */
+export type ApiBookTakeableOffersResponse = {
+    readonly data: readonly ApiTakeableOfferResponse[];
+};
+/** @internal Quote response shape returned by the API. */
+export type ApiQuoteResponse = {
+    readonly data: {
+        readonly average_best_price: string;
+        readonly average_worst_price: string;
+        readonly available_assets: string;
+        readonly available_units: string;
+        readonly takeable_offers: readonly ApiTakeableOfferResponse[];
+    };
+};
+/** @internal Paginated takeable-offers response shape returned by the API. */
+export type ApiTakeableOffersResponse = {
+    readonly cursor: string | null;
+    readonly data: readonly ApiTakeableOfferResponse[];
+};

package/lib/esm/api/types.js

@@ -0,0 +1 @@
+export {};