@0xmonaco/types 1.1.5 → 1.1.6

package/README.md

@@ -170,7 +170,7 @@ interface TradingAPI extends BaseAPI {
 type OrderSide = "BUY" | "SELL";
 type OrderType = "LIMIT" | "MARKET";
 type OrderStatus = "SUBMITTED" | "PARTIALLY_FILLED" | "FILLED" | "SETTLED_ON_CHAIN" | "SETTLED" | "CANCELLED" | "REJECTED" | "EXPIRED";
-type TradingMode = "SPOT";
+type TradingMode = "SPOT" | "MARGIN";
 type TimeInForce = "GTC" | "IOC" | "FOK"; // GTC: Good Till Cancel, IOC: Immediate or Cancel, FOK: Fill or Kill
 
 // Trading response types
@@ -237,8 +237,6 @@ interface TradingPair {
   marketType: TradingMode;
   category: string;
   isActive: boolean;
-  makerFeeBps: number;
-  takerFeeBps: number;
   minOrderSize: string;
   maxOrderSize: string;
   quantityStepSize: string;

package/dist/analytics/builders.d.ts

@@ -0,0 +1,135 @@
+/**
+ * Builder Analytics Types
+ *
+ * The public builder directory, lookup, figures and leaderboard. A builder is
+ * an application, or a display group that shows several applications as one.
+ * Builders the explorer does not display are left out of every list, and a
+ * lookup of one fails with 404 exactly as an unknown key.
+ *
+ * Fees here are the builder's own add-ons (taker plus maker), never the
+ * protocol taker fee. USD amounts are decimal strings (USDC 1:1).
+ */
+import type { AnalyticsWindow, AnalyticsWindowParams } from "./index";
+/** A builder's kind. */
+export type BuilderKind = "application" | "group";
+/** The display group an application is shown under. */
+export interface BuilderGroupRef {
+    /** Display group UUID; `getBuilder(id)` answers the group. */
+    id: string;
+    name: string;
+    /** The group's display code; `null` when it has none. */
+    code?: string | null;
+}
+/** One application behind a builder. */
+export interface BuilderApplication {
+    id: string;
+    name: string;
+    /** On-chain client id the application's deposits carry. */
+    clientId: string;
+    /** Whether the application can place new orders. */
+    active: boolean;
+    /** Archived applications are left out of the directory but keep their figures. */
+    archived: boolean;
+    /** Taker add-on the application charges, in basis points. */
+    additionalTakerFeeBps: number;
+    /** Maker add-on the application charges, in basis points. */
+    additionalMakerFeeBps: number;
+    /** Whether this is the exchange's default application: the one a sign-in that names no client id is placed under. */
+    isDefault: boolean;
+}
+/** A builder's identity. */
+export interface Builder {
+    /** Application UUID, or display group UUID when `kind` is `group`. */
+    id: string;
+    kind: BuilderKind | (string & {});
+    name: string;
+    /** Short display code (also a lookup key); `null` when unset. */
+    code?: string | null;
+    /** Display color, `#rrggbb` or `#rrggbbaa`; `null` when unset. */
+    color?: string | null;
+    verified: boolean;
+    /** For an application shown under a display group: that group; `null` otherwise. */
+    group?: BuilderGroupRef | null;
+    /**
+     * The application itself, or the group's displayed applications. Builder
+     * attribution on other responses may send this empty.
+     */
+    applications: BuilderApplication[];
+}
+/** A builder's figures over a window or one bucket. */
+export interface BuilderFigures {
+    /** Taker volume in USD of the trades the builder's applications took. */
+    volumeUsd: string;
+    /** The spot part of `volumeUsd`. */
+    spotVolumeUsd: string;
+    /** The perpetual (margin) part of `volumeUsd`. */
+    perpVolumeUsd: string;
+    /** Trades the builder's applications took. */
+    tradesCount: number;
+    /** The builder's add-on revenue: `takerFeesUsd` plus `makerFeesUsd`. */
+    feesUsd: string;
+    /** Taker add-ons on the trades it took. */
+    takerFeesUsd: string;
+    /** Maker add-ons on the trades it made, whoever took them. */
+    makerFeesUsd: string;
+    /** USDC deposited through the builder's applications, in USD (1:1); other tokens are unvalued. */
+    depositsUsd: string;
+    /** USDC withdrawals the builder's applications initiated, in USD (1:1); attributed by the initiating application. */
+    withdrawalsUsd: string;
+    /** `depositsUsd` less `withdrawalsUsd`; negative when more left than arrived. */
+    netFlowUsd: string;
+}
+/** Every displayed builder, by name. */
+export interface ListBuildersResponse {
+    builders: Builder[];
+}
+/** One builder. */
+export interface GetBuilderResponse {
+    builder: Builder;
+}
+/** A builder's figures over a window. */
+export interface GetBuilderTotalsResponse extends BuilderFigures {
+    window: AnalyticsWindow;
+    builder: Builder;
+    /** Distinct taker wallets that traded through the builder, each once. */
+    activeTakers: number;
+    /** Wallets whose first trade through one of its applications fell in the window, once per (application, wallet). */
+    newTraders: number;
+}
+/** A builder's figures for one bucket. */
+export interface BuilderSeriesPoint extends BuilderFigures {
+    /** Bucket start as Unix milliseconds (UTC; weeks start Monday). */
+    bucketStart: number;
+    activeTakers: number;
+    newTraders: number;
+}
+/** A builder's figures per bucket over a window. */
+export interface GetBuilderSeriesResponse {
+    window: AnalyticsWindow;
+    builder: Builder;
+    /** One point per bucket, oldest first; a bucket without trades carries zeros. */
+    points: BuilderSeriesPoint[];
+}
+/** Parameters for {@link AnalyticsAPI.listBuilderLeaderboard}. */
+export interface ListBuilderLeaderboardParams extends AnalyticsWindowParams {
+    /** Builders to return, largest volume first (1-100, default 25). */
+    limit?: number;
+}
+/** One builder's row on the leaderboard; a display group ranks as one. A builder that only took deposits ranks with zero volume. */
+export interface BuilderLeaderboardRow extends BuilderFigures {
+    builder: Builder;
+    newTraders: number;
+    /**
+     * Distinct taker wallets that traded through the builder, each once. With
+     * `window: "all"`, every wallet that ever traded through it. `null` for a
+     * window counted in hours that starts before the 90 days its hourly sets
+     * are kept.
+     */
+    activeTakers?: number | null;
+}
+/** Displayed builders ranked by volume over a window. */
+export interface ListBuilderLeaderboardResponse {
+    window: AnalyticsWindow;
+    /** Largest volume first (ties by builder id), up to `limit`. */
+    rows: BuilderLeaderboardRow[];
+}

package/dist/analytics/builders.js

@@ -0,0 +1,11 @@
+/**
+ * Builder Analytics Types
+ *
+ * The public builder directory, lookup, figures and leaderboard. A builder is
+ * an application, or a display group that shows several applications as one.
+ * Builders the explorer does not display are left out of every list, and a
+ * lookup of one fails with 404 exactly as an unknown key.
+ *
+ * Fees here are the builder's own add-ons (taker plus maker), never the
+ * protocol taker fee. USD amounts are decimal strings (USDC 1:1).
+ */

package/dist/analytics/index.d.ts

@@ -0,0 +1,153 @@
+/**
+ * Analytics Types
+ *
+ * Types for the public explorer analytics: protocol totals and series over a
+ * window, per-market volume, and the treasury's all-time net fees; and the
+ * builder directory, figures and leaderboard (see `./builders`).
+ *
+ * Windows: `window` is `24h`, `7d`, `30d`, `all` or `custom`, ending at
+ * `endTime` (default now). The server picks the bucket size from the window's
+ * length (hour up to 2.5 days, day up to 45 days, week beyond) and counts
+ * every bucket whose start lies in `[startTime, endTime]`; buckets are UTC and
+ * weeks start Monday.
+ *
+ * Volume, trade counts and the spot/perp split count the builders the
+ * explorer displays only. Fees, active takers, new traders and per-market
+ * volume count every trade. USD amounts are decimal strings (USDC 1:1).
+ *
+ * Custody: deposits, withdrawals, net flow and total value locked count USDC
+ * only (1:1); other tokens are unvalued. A withdrawal counts when initiated.
+ * TVL is the USDC custody (deposits less initiated withdrawals, never below
+ * zero) at a point, `null` before any custody was folded.
+ *
+ * NOTE: These endpoints are **public (unauthenticated)** and rate limited per
+ * client IP.
+ */
+import type { BaseAPI } from "../api";
+import type { GetBuilderResponse, GetBuilderSeriesResponse, GetBuilderTotalsResponse, ListBuilderLeaderboardParams, ListBuilderLeaderboardResponse, ListBuildersResponse } from "./builders";
+import type { WalletCustodyAnalyticsAPI } from "./wallets";
+export * from "./builders";
+export * from "./wallets";
+/** A window key. */
+export type AnalyticsWindowKey = "24h" | "7d" | "30d" | "all" | "custom";
+/** A bucket size. */
+export type AnalyticsGranularity = "hour" | "day" | "week";
+/** The window a request covers. */
+export interface AnalyticsWindowParams {
+    /** Window key (default `24h`). */
+    window?: AnalyticsWindowKey;
+    /** Custom window start as Unix milliseconds; required with `custom`, rejected otherwise. */
+    startTime?: number;
+    /** Window end as Unix milliseconds (default now); any window may end in the past, but one counted in hours (2.5 days or shorter) must start within the last 90 days. */
+    endTime?: number;
+}
+/** The window a response covers, as the server resolved it. */
+export interface AnalyticsWindow {
+    /** Window start as Unix milliseconds; buckets starting at or after it count. */
+    startTime: number;
+    /** Window end as Unix milliseconds; buckets starting at or before it count (the bucket holding it is usually partial). */
+    endTime: number;
+    /** Bucket size the window is counted in. */
+    granularity: AnalyticsGranularity | (string & {});
+}
+/** Protocol figures over a window or one bucket. */
+export interface ProtocolFigures {
+    /** Taker volume in USD routed by the displayed builders; hidden builders' trades are not counted. */
+    volumeUsd: string;
+    /** The spot part of `volumeUsd` (displayed builders only). */
+    spotVolumeUsd: string;
+    /** The perpetual (margin) part of `volumeUsd` (displayed builders only). */
+    perpVolumeUsd: string;
+    /** Trades routed by the displayed builders. */
+    tradesCount: number;
+    /** Protocol taker fees in USD over every trade, all builders included; excludes builder add-ons and maker fees. */
+    protocolFeesUsd: string;
+    /** Distinct taker wallets that traded (each once), all builders included. */
+    activeTakers: number;
+    /** Wallets whose first trade through a builder fell inside, once per (builder, wallet), all builders included. */
+    newTraders: number;
+}
+/** USDC custody flow over a window or one bucket, in USD (1:1). */
+export interface CustodyFlows {
+    /** USDC deposited. */
+    depositsUsd: string;
+    /** USDC withdrawals initiated. */
+    withdrawalsUsd: string;
+    /** `depositsUsd` less `withdrawalsUsd`; negative when more left than arrived. */
+    netFlowUsd: string;
+}
+/** Protocol totals over a window. */
+export interface GetProtocolTotalsResponse extends ProtocolFigures, CustodyFlows {
+    window: AnalyticsWindow;
+    /** Total value locked in USD at the end of the window (the end of the bucket holding `endTime`); `null` before any custody was folded. */
+    tvlUsd?: string | null;
+    /** Total value locked in USD at the start of the window; `tvlUsd` less this is the window's change. `null` before any custody was folded. */
+    openingTvlUsd?: string | null;
+    /** Distinct wallets that took a trade, received a deposit or were paid out a withdrawal initiated in the window (by payout address), each once. */
+    activeAccounts: number;
+}
+/** Protocol figures for one bucket. */
+export interface ProtocolSeriesPoint extends ProtocolFigures, CustodyFlows {
+    /** Bucket start as Unix milliseconds (UTC; weeks start Monday). */
+    bucketStart: number;
+    /** Total value locked in USD at the end of the bucket, carried across buckets without movement; `null` before any custody was folded. */
+    tvlUsd?: string | null;
+}
+/** Protocol figures per bucket over a window. */
+export interface GetProtocolSeriesResponse {
+    window: AnalyticsWindow;
+    /** One point per bucket, oldest first; a bucket without trades carries zeros. */
+    points: ProtocolSeriesPoint[];
+}
+/** Parameters for {@link AnalyticsAPI.listMarketVolumes}. */
+export interface ListMarketVolumesParams extends AnalyticsWindowParams {
+    /** Markets to return, largest volume first (1-100, default 25). */
+    limit?: number;
+}
+/** One market's figures over a window, all builders included. Resolve the symbol from the trading pairs listing. */
+export interface MarketVolume {
+    tradingPairId: string;
+    /** Taker volume in USD over every trade in the market. */
+    volumeUsd: string;
+    /** Protocol taker fees in USD. */
+    protocolFeesUsd: string;
+    /** Trades in the market. */
+    tradesCount: number;
+}
+/** Volume per market over a window. */
+export interface ListMarketVolumesResponse {
+    window: AnalyticsWindow;
+    /** Markets that traded, largest volume first, up to `limit`. */
+    markets: MarketVolume[];
+}
+/** The treasury's all-time net fees (not windowed). */
+export interface GetTreasuryNetFeesResponse {
+    /** Net protocol fees in USD: the treasury's net protocol fee (taker fees less maker rebates) plus the insurance fund's liquidation fees, less BuilderCodes payouts and TraderCodes rewards; negative when payouts exceed fees. */
+    netFeesUsd: string;
+    /** When the first counted fee landed, as Unix milliseconds; null before any. */
+    countingSince?: number | null;
+}
+/**
+ * Analytics API interface. Every endpoint is public (no auth required); each
+ * client IP has a read budget.
+ */
+export interface AnalyticsAPI extends BaseAPI, WalletCustodyAnalyticsAPI {
+    /** Protocol totals over a window. */
+    getProtocolTotals(params?: AnalyticsWindowParams): Promise<GetProtocolTotalsResponse>;
+    /** Protocol figures per bucket over a window, oldest first, one point per bucket. */
+    getProtocolSeries(params?: AnalyticsWindowParams): Promise<GetProtocolSeriesResponse>;
+    /** Volume per market over a window, every trade counted, largest first. */
+    listMarketVolumes(params?: ListMarketVolumesParams): Promise<ListMarketVolumesResponse>;
+    /** The treasury's all-time net fees. */
+    getTreasuryNetFees(): Promise<GetTreasuryNetFeesResponse>;
+    /** Every displayed builder, by name; archived applications left out. */
+    listBuilders(): Promise<ListBuildersResponse>;
+    /** One builder by application or group uuid, code, or client id; 404 when no displayed builder answers to it. */
+    getBuilder(builder: string): Promise<GetBuilderResponse>;
+    /** One builder's figures over a window. */
+    getBuilderTotals(builder: string, params?: AnalyticsWindowParams): Promise<GetBuilderTotalsResponse>;
+    /** One builder's figures per bucket over a window, oldest first. */
+    getBuilderSeries(builder: string, params?: AnalyticsWindowParams): Promise<GetBuilderSeriesResponse>;
+    /** Displayed builders ranked by volume over a window, a display group as one row. */
+    listBuilderLeaderboard(params?: ListBuilderLeaderboardParams): Promise<ListBuilderLeaderboardResponse>;
+}

package/dist/analytics/index.js

@@ -0,0 +1,27 @@
+/**
+ * Analytics Types
+ *
+ * Types for the public explorer analytics: protocol totals and series over a
+ * window, per-market volume, and the treasury's all-time net fees; and the
+ * builder directory, figures and leaderboard (see `./builders`).
+ *
+ * Windows: `window` is `24h`, `7d`, `30d`, `all` or `custom`, ending at
+ * `endTime` (default now). The server picks the bucket size from the window's
+ * length (hour up to 2.5 days, day up to 45 days, week beyond) and counts
+ * every bucket whose start lies in `[startTime, endTime]`; buckets are UTC and
+ * weeks start Monday.
+ *
+ * Volume, trade counts and the spot/perp split count the builders the
+ * explorer displays only. Fees, active takers, new traders and per-market
+ * volume count every trade. USD amounts are decimal strings (USDC 1:1).
+ *
+ * Custody: deposits, withdrawals, net flow and total value locked count USDC
+ * only (1:1); other tokens are unvalued. A withdrawal counts when initiated.
+ * TVL is the USDC custody (deposits less initiated withdrawals, never below
+ * zero) at a point, `null` before any custody was folded.
+ *
+ * NOTE: These endpoints are **public (unauthenticated)** and rate limited per
+ * client IP.
+ */
+export * from "./builders";
+export * from "./wallets";

package/dist/analytics/wallets.d.ts

@@ -0,0 +1,197 @@
+/**
+ * Wallet, custody and vault feed analytics types (0XM-3627).
+ *
+ * Wallet figures are all-time taker volume. A wallet summary folds its
+ * per-application rows through the explorer's builder display rules: a display
+ * group's applications are one row under the group, and what hidden builders
+ * carried is reported in `unattributed`.
+ *
+ * Custody counts a withdrawal when it is initiated, not when it is paid out
+ * on-chain; `pendingWithdrawalsRaw` is the initiated-but-unexecuted remainder,
+ * still physically in the vault. Only USDC is valued (1:1), and only USDC
+ * counts toward total value locked.
+ *
+ * NOTE: These endpoints are **public (unauthenticated)** and rate limited per
+ * client IP.
+ */
+import type { LiquidationHistoryEvent } from "../market";
+import type { Builder } from "./builders";
+/** Parameters for {@link WalletCustodyAnalyticsAPI.listWalletLeaderboard}. */
+export interface ListWalletLeaderboardParams {
+    /** Wallets to return, largest volume first (1-100, default 25). */
+    limit?: number;
+}
+/** One wallet's all-time taker figures. */
+export interface WalletVolume {
+    /** Wallet address, lowercase. */
+    wallet: string;
+    /** All-time taker volume in USD (USDC 1:1). */
+    volumeUsd: string;
+    tradesCount: number;
+    /** First taker trade as Unix milliseconds. */
+    firstTradedAt: number;
+    /** Latest taker trade as Unix milliseconds. */
+    lastTradedAt: number;
+}
+/** Wallets by all-time taker volume, every builder counted. */
+export interface ListWalletLeaderboardResponse {
+    /** Largest volume first (ties by wallet), up to `limit`. */
+    wallets: WalletVolume[];
+}
+/** A wallet's figures through one displayed builder. */
+export interface WalletBuilderVolume {
+    /** The builder the figures are reported under; `applications` is empty. */
+    builder: Builder;
+    volumeUsd: string;
+    tradesCount: number;
+    firstTradedAt: number;
+    lastTradedAt: number;
+}
+/** What a wallet traded through builders the explorer does not display. */
+export interface WithheldVolume {
+    volumeUsd: string;
+    tradesCount: number;
+}
+/** One wallet's summary. */
+export interface GetWalletSummaryResponse {
+    /** The wallet, lowercase. */
+    wallet: string;
+    /** All-time totals over every builder; null when the wallet never took a trade. */
+    totals?: WalletVolume | null;
+    /** Per displayed builder, largest volume first. */
+    builders: WalletBuilderVolume[];
+    /** What hidden builders carried; null when they carried nothing. */
+    unattributed?: WithheldVolume | null;
+    liquidationsCount: number;
+    /** Sum of each event's size times its event-time mark, in each market's quote units (every market is USDC-quoted today). */
+    liquidationsNotional: string;
+}
+/** Parameters for {@link WalletCustodyAnalyticsAPI.listWalletLiquidations}. */
+export interface ListWalletLiquidationsParams {
+    /** Events per page (1-1000, default 50). */
+    pageSize?: number;
+    /** Cursor from the previous page; bound to the wallet. */
+    pageToken?: string;
+}
+/** One wallet's liquidation events, every market. */
+export interface ListWalletLiquidationsResponse {
+    /** Newest first. */
+    events: LiquidationHistoryEvent[];
+    pageSize: number;
+    /** Cursor for the next page; empty when the walk is finished. */
+    nextPageToken: string;
+}
+/**
+ * What the vault holds of one token. Amounts are raw token units. Custody is
+ * folded into the aux database while `pendingWithdrawalsRaw` is read from core,
+ * so the two can disagree briefly while the fold lags.
+ */
+export interface TokenCustody {
+    /** Asset UUID; null for a token with custody flow and no listed asset. */
+    assetId?: string | null;
+    symbol?: string | null;
+    name?: string | null;
+    decimals?: number | null;
+    iconUrl?: string | null;
+    /** Token contract address, lowercase. */
+    contractAddress: string;
+    depositedRaw: string;
+    /** All-time initiated withdrawals. */
+    withdrawnRaw: string;
+    depositsCount: number;
+    withdrawalsCount: number;
+    /** Deposits less initiated withdrawals; null when not positive. */
+    custodyRaw?: string | null;
+    /** Initiated but not yet executed on-chain; the vault's physical balance is `custodyRaw` plus this. */
+    pendingWithdrawalsRaw: string;
+    /** `1` for USDC, null for every other token. */
+    referencePriceUsd?: string | null;
+    /** `custodyRaw` in USD; null without a price or a positive custody. */
+    custodyUsd?: string | null;
+    /** Whether `custodyUsd` is summed into `tvlUsd` (USDC only). */
+    countsTowardTvl: boolean;
+}
+/** Custody per token and total value locked. */
+export interface ListTokenCustodyResponse {
+    /** Listed assets by symbol, then unlisted tokens with custody flow. */
+    tokens: TokenCustody[];
+    tvlUsd: string;
+}
+/** One token's custody. */
+export interface GetTokenCustodyResponse {
+    token: TokenCustody;
+}
+/** Parameters for the vault deposit and withdrawal feeds. */
+export interface VaultFeedParams {
+    /** Rows per page (1-1000, default 50). */
+    pageSize?: number;
+    /** Cursor from the previous page; bound to `token` and `wallet`. */
+    pageToken?: string;
+    /** Only this token's rows: an asset symbol (any case), asset UUID or contract address. A token nothing answers to lists nothing. */
+    token?: string;
+    /** Only rows whose destination (the credited account, or a withdrawal's payout address) is this wallet. */
+    wallet?: string;
+}
+/** One deposit into the vault. */
+export interface VaultDeposit {
+    /** On-chain deposit index; the feed's order. */
+    onChainIndex: number;
+    txHash: string;
+    blockNumber: number;
+    /** Token contract address, lowercase. */
+    token: string;
+    assetId?: string | null;
+    symbol?: string | null;
+    amountRaw: string;
+    /** Account credited, lowercase. */
+    destination: string;
+    targetAccountType: string;
+    /** When the deposit was processed, as Unix milliseconds. */
+    depositedAt: number;
+    /** The displayed builder it came through; null when hidden or none. */
+    builder?: Builder | null;
+}
+/** Deposits, newest first. */
+export interface ListVaultDepositsResponse {
+    deposits: VaultDeposit[];
+    pageSize: number;
+    nextPageToken: string;
+}
+/** One withdrawal from the vault, from initiation on. */
+export interface VaultWithdrawal {
+    /** Withdrawal index, allocated in request order; the feed's order. */
+    withdrawalIndex: number;
+    token: string;
+    assetId?: string | null;
+    symbol?: string | null;
+    amountRaw: string;
+    destination: string;
+    status: "pending" | "confirmed" | "executed" | (string & {});
+    /** When the withdrawal was initiated, as Unix milliseconds. */
+    initiatedAt: number;
+    /** The displayed builder it came through; null when hidden. */
+    builder?: Builder | null;
+}
+/** Withdrawals, newest first. */
+export interface ListVaultWithdrawalsResponse {
+    withdrawals: VaultWithdrawal[];
+    pageSize: number;
+    nextPageToken: string;
+}
+/** The wallet, custody and vault feed reads of the analytics API. */
+export interface WalletCustodyAnalyticsAPI {
+    /** Wallets by all-time taker volume, largest first, every builder counted. */
+    listWalletLeaderboard(params?: ListWalletLeaderboardParams): Promise<ListWalletLeaderboardResponse>;
+    /** One wallet's totals, per displayed builder, and its liquidation count. A wallet that never traded answers with empty figures. */
+    getWalletSummary(wallet: string): Promise<GetWalletSummaryResponse>;
+    /** One wallet's liquidation events, newest first, every market. */
+    listWalletLiquidations(wallet: string, params?: ListWalletLiquidationsParams): Promise<ListWalletLiquidationsResponse>;
+    /** Custody per token and the total value locked. */
+    listTokenCustody(): Promise<ListTokenCustodyResponse>;
+    /** One token's custody, by symbol, asset UUID or contract address. */
+    getTokenCustody(token: string): Promise<GetTokenCustodyResponse>;
+    /** Vault deposits, newest first. */
+    listVaultDeposits(params?: VaultFeedParams): Promise<ListVaultDepositsResponse>;
+    /** Vault withdrawals, newest first, every status. */
+    listVaultWithdrawals(params?: VaultFeedParams): Promise<ListVaultWithdrawalsResponse>;
+}

package/dist/analytics/wallets.js

@@ -0,0 +1,16 @@
+/**
+ * Wallet, custody and vault feed analytics types (0XM-3627).
+ *
+ * Wallet figures are all-time taker volume. A wallet summary folds its
+ * per-application rows through the explorer's builder display rules: a display
+ * group's applications are one row under the group, and what hidden builders
+ * carried is reported in `unattributed`.
+ *
+ * Custody counts a withdrawal when it is initiated, not when it is paid out
+ * on-chain; `pendingWithdrawalsRaw` is the initiated-but-unexecuted remainder,
+ * still physically in the vault. Only USDC is valued (1:1), and only USDC
+ * counts toward total value locked.
+ *
+ * NOTE: These endpoints are **public (unauthenticated)** and rate limited per
+ * client IP.
+ */

package/dist/applications/requests.d.ts

@@ -8,7 +8,7 @@
  * Query parameters for listing application orders.
  */
 export interface ListAppOrdersParams {
-    /** Public client ID of the application to list (required). An unknown or inactive one is a `404`. */
+    /** Public client ID of the application to list (required). An unknown, inactive or hidden one is a `404`. */
     clientId: string;
     /** Items per page, 1 to 1000 (default 20). Rejected if larger. */
     pageSize?: number;
@@ -40,7 +40,7 @@ export interface ListAppOrdersParams {
  * Query parameters for listing application users.
  */
 export interface ListAppUsersParams {
-    /** Public client ID of the application to list (required). An unknown or inactive one is a `404`. */
+    /** Public client ID of the application to list (required). An unknown, inactive or hidden one is a `404`. */
     clientId: string;
     /** Items per page, 1 to 1000 (default 20). Rejected if larger. */
     pageSize?: number;
@@ -69,7 +69,7 @@ export interface ListAppUsersParams {
  * Query parameters for listing application movements.
  */
 export interface ListAppMovementsParams {
-    /** Public client ID of the application to list (required). An unknown or inactive one is a `404`. */
+    /** Public client ID of the application to list (required). An unknown, inactive or hidden one is a `404`. */
     clientId: string;
     /** Items per page, 1 to 1000 (default 20). Rejected if larger. */
     pageSize?: number;
@@ -99,7 +99,7 @@ export interface ListAppMovementsParams {
  * Query parameters for listing application balances.
  */
 export interface ListAppBalancesParams {
-    /** Public client ID of the application to list (required). An unknown or inactive one is a `404`. */
+    /** Public client ID of the application to list (required). An unknown, inactive or hidden one is a `404`. */
     clientId: string;
     /** Items per page, 1 to 1000 (default 20). Rejected if larger. */
     pageSize?: number;
@@ -126,7 +126,7 @@ export interface ListAppBalancesParams {
  * Query parameters for application stats.
  */
 export interface GetAppStatsParams {
-    /** Public client ID of the application to list (required). An unknown or inactive one is a `404`. */
+    /** Public client ID of the application to list (required). An unknown, inactive or hidden one is a `404`. */
     clientId: string;
     /** ISO 8601 datetime to filter stats from (e.g. 2026-01-01T00:00:00Z). Omit for all-time. */
     since?: string;

package/dist/buildercodes/index.d.ts

@@ -56,18 +56,20 @@ export interface BuildercodesAPI extends BaseAPI {
      * Throws 403 when the session is a delegated agent — a permanent
      * restriction on that session type, not a rollout state. No program switch
      * gates the claim, so a balance already credited stays claimable. Throws 409 when the payout balance is insufficient for the
-     * requested amount. Throws 503 when the matching engine is unreachable,
-     * restarting, or slow to answer — an UNKNOWN outcome, not a rejection: the
-     * claim is admitted to the sequencer before its reply is sent, so it may
-     * still commit, and with no idempotency key a blind retry can claim twice.
-     * Do not retry automatically: a balance read cannot settle it, because an
-     * admitted claim may still be queued. Ambiguous failures are thrown
-     * with `retryable: false` so retry logic driven off that flag cannot claim
-     * twice. Two pre-admission rejections stay retryable because they committed
-     * nothing: a maintenance block (`OPERATIONS_BLOCKED`) and a sequencer
-     * overload (`OVERLOADED`).
+     * requested amount, or 409 `IDEMPOTENCY_KEY_CONFLICT` when `idempotencyKey`
+     * already names a different claim. Throws 503 when the matching engine is
+     * unreachable, restarting, or slow to answer — an UNKNOWN outcome, not a
+     * rejection: the claim is admitted to the sequencer before its reply is
+     * sent, so it may still commit. With an `idempotencyKey`, retrying the same
+     * key and claim within 15 minutes returns the first claim's result without
+     * moving money again, and the 5xx stays `retryable`. Without one a blind
+     * retry can claim twice: do not retry automatically, because a balance read
+     * cannot settle it while an admitted claim may still be queued, and the
+     * ambiguous failure is thrown with `retryable: false`. Two pre-admission
+     * rejections stay retryable because they committed nothing: a maintenance
+     * block (`OPERATIONS_BLOCKED`) and a sequencer overload (`OVERLOADED`).
      *
-     * @param params - Payout token address and raw-unit amount to claim
+     * @param params - Payout token address, raw-unit amount to claim, and an optional idempotencyKey
      * @returns Promise resolving to the post-claim payout and trading balances
      */
     claimBuildercodeRewards(params: ClaimBuildercodeRewardsParams): Promise<ClaimBuildercodeRewardsResponse>;

package/dist/buildercodes/responses.d.ts

@@ -196,6 +196,7 @@ export declare const GetBuildercodeRewardsBalanceResponseSchema: z.ZodObject<{
 export declare const ClaimBuildercodeRewardsParamsSchema: z.ZodObject<{
     token: z.ZodString;
     amount: z.ZodString;
+    idempotencyKey: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 /** Schema for the claim-BuilderCodes-rewards response. */
 export declare const ClaimBuildercodeRewardsResponseSchema: z.ZodObject<{