@0xmonaco/types 1.0.56 → 1.0.58-develop.f12e78b

package/dist/auth/index.d.ts

@@ -31,10 +31,24 @@ export interface AuthAPI extends BaseAPI {
     /**
      * Signs a challenge message using the wallet client.
      *
-     * Signs the provided message using the wallet's private key.
-     * This is used in the authentication flow to prove ownership of the wallet.
+     * Asks the connected wallet to authorize the message, proving control of the
+     * address. An EOA signs it with its private key (EIP-191 `personal_sign`). A
+     * smart-contract wallet such as a Safe has no private key and returns a
+     * signature its own contract will accept, which the server checks under
+     * EIP-1271; the wallet client handles that difference, and the returned value
+     * is submitted unchanged either way.
      *
-     * @param message - The message to sign
+     * The returned signature is therefore not guaranteed to be 65 bytes — a
+     * contract signature is usually longer — so callers must not assume the
+     * EOA shape.
+     *
+     * Note the scope. Server-side EIP-1271 verification is deliberately narrow:
+     * it is offered only to a wallet holding a BuilderCodes payout bucket, on a
+     * deployment with the contract-wallet flag on and a chain RPC endpoint
+     * configured. An ordinary smart-contract trading account is not covered — it
+     * still takes the recovery path, which it cannot satisfy.
+     *
+     * @param message - The message to authorize
      * @returns Promise resolving to the signature
      */
     signChallenge(message: string): Promise<string>;

package/dist/buildercodes/index.d.ts

@@ -0,0 +1,71 @@
+/**
+ * BuilderCodes Types
+ *
+ * Types for the BuilderCodes API: reading and claiming an enrolled frontend's
+ * per-trade revenue share.
+ */
+import type { BaseAPI } from "../api";
+import type { ClaimBuildercodeRewardsParams, ClaimBuildercodeRewardsResponse, GetBuildercodePayoutSummaryResponse, GetBuildercodeRewardsBalanceResponse, GetBuildercodesConfigResponse, ListBuildercodePayoutsParams, ListBuildercodePayoutsResponse } from "./responses";
+/**
+ * BuilderCodes payout API interface.
+ *
+ * BuilderCodes is Monaco's per-trade frontend revenue share: an enrolled
+ * frontend earns a configured share of the net take on every fill its users
+ * generate, accruing to a reserved payout bucket owned by the frontend's
+ * configured payout wallet. Accrual is internal accounting only — this API is
+ * how that balance is claimed into a tradeable (and then withdrawable) balance.
+ */
+export interface BuildercodesAPI extends BaseAPI {
+    /** Read this authenticated frontend's enrollment, payout address, and live budget. */
+    getConfig(): Promise<GetBuildercodesConfigResponse>;
+    /** List this authenticated frontend's per-trade BuilderCodes credits. */
+    listPayouts(params?: ListBuildercodePayoutsParams): Promise<ListBuildercodePayoutsResponse>;
+    /** Summarize this authenticated frontend's BuilderCodes credits by token. */
+    getPayoutSummary(): Promise<GetBuildercodePayoutSummaryResponse>;
+    /** Read the authenticated wallet's available reserved reward balances. */
+    getRewardsBalance(): Promise<GetBuildercodeRewardsBalanceResponse>;
+    /**
+     * Claim accrued BuilderCodes payout balance into a trading balance.
+     *
+     * Moves the specified amount of a payout token out of the authenticated
+     * caller's reserved payout bucket and into their trading balance under the
+     * authenticated application, from where the ordinary withdrawal flow applies.
+     * Ledger-only — no on-chain transaction and no gas, and the funds are
+     * immediately tradeable.
+     *
+     * The payout wallet may be an EOA or a smart-contract wallet. An EOA answers
+     * the signature challenge directly; a multisig such as a Safe authenticates by
+     * EIP-1271 contract signature instead. That path is offered only to a wallet
+     * holding a BuilderCodes payout bucket, only while `contract_wallet_auth_enabled`
+     * is on, and only where the deployment has a chain RPC endpoint configured —
+     * otherwise login is EOA-only and a contract payout wallet can neither call
+     * this endpoint nor withdraw afterwards.
+     *
+     * The bucket is resolved from the authenticated caller's own wallet address,
+     * so a caller can only ever claim their own accrued balance. A wallet that
+     * has never been an enrolled frontend's payout address has nothing to claim.
+     * A wallet that *used to be* a payout address keeps what it accrued back then
+     * and can still claim it — payout-address changes are not retroactive.
+     *
+     * Throws 403 when the caller is refused: BuilderCodes is not enabled, or
+     * the session is a delegated agent — which is rejected before the feature is
+     * checked, so it is a permanent restriction on that session type, not a
+     * rollout state. 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`).
+     *
+     * @param params - Payout token address and raw-unit amount to claim
+     * @returns Promise resolving to the post-claim payout and trading balances
+     */
+    claimBuildercodeRewards(params: ClaimBuildercodeRewardsParams): Promise<ClaimBuildercodeRewardsResponse>;
+}
+export type { BuildercodePayout, BuildercodePayoutTokenTotal, BuildercodeRewardsBalance, ClaimBuildercodeRewardsParams, ClaimBuildercodeRewardsResponse, GetBuildercodePayoutSummaryResponse, GetBuildercodeRewardsBalanceResponse, GetBuildercodesConfigResponse, ListBuildercodePayoutsParams, ListBuildercodePayoutsResponse, } from "./responses";
+export { BuildercodePayoutSchema, BuildercodePayoutTokenTotalSchema, BuildercodeRewardsBalanceSchema, ClaimBuildercodeRewardsParamsSchema, ClaimBuildercodeRewardsResponseSchema, GetBuildercodePayoutSummaryResponseSchema, GetBuildercodeRewardsBalanceResponseSchema, GetBuildercodesConfigResponseSchema, ListBuildercodePayoutsParamsSchema, ListBuildercodePayoutsResponseSchema, } from "./responses";

package/dist/buildercodes/index.js

@@ -0,0 +1,7 @@
+/**
+ * BuilderCodes Types
+ *
+ * Types for the BuilderCodes API: reading and claiming an enrolled frontend's
+ * per-trade revenue share.
+ */
+export { BuildercodePayoutSchema, BuildercodePayoutTokenTotalSchema, BuildercodeRewardsBalanceSchema, ClaimBuildercodeRewardsParamsSchema, ClaimBuildercodeRewardsResponseSchema, GetBuildercodePayoutSummaryResponseSchema, GetBuildercodeRewardsBalanceResponseSchema, GetBuildercodesConfigResponseSchema, ListBuildercodePayoutsParamsSchema, ListBuildercodePayoutsResponseSchema, } from "./responses";

package/dist/buildercodes/responses.d.ts

@@ -0,0 +1,94 @@
+/**
+ * BuilderCodes Response Types
+ *
+ * Types for the BuilderCodes earnings and payout API responses and requests.
+ * All types are derived from Zod schemas for runtime validation.
+ */
+import { z } from "zod";
+/** Schema for this frontend's current BuilderCodes program state. */
+export declare const GetBuildercodesConfigResponseSchema: z.ZodObject<{
+    applicationId: z.ZodString;
+    enrolled: z.ZodBoolean;
+    payoutAddress: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    buildercodesEnabled: z.ZodBoolean;
+    buildercodesBudgetBps: z.ZodNumber;
+}, z.core.$strip>;
+/** Pagination accepted by the per-trade payout history endpoint. */
+export declare const ListBuildercodePayoutsParamsSchema: z.ZodObject<{
+    page: z.ZodOptional<z.ZodNumber>;
+    pageSize: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+/** One per-trade BuilderCodes credit. Amounts are RAW atomic units. */
+export declare const BuildercodePayoutSchema: z.ZodObject<{
+    tradeId: z.ZodString;
+    payoutAddress: z.ZodString;
+    token: z.ZodString;
+    amount: z.ZodString;
+    appliedBps: z.ZodNumber;
+    createdAt: z.ZodString;
+}, z.core.$strip>;
+/** Schema for the paginated per-trade payout history. */
+export declare const ListBuildercodePayoutsResponseSchema: z.ZodObject<{
+    payouts: z.ZodArray<z.ZodObject<{
+        tradeId: z.ZodString;
+        payoutAddress: z.ZodString;
+        token: z.ZodString;
+        amount: z.ZodString;
+        appliedBps: z.ZodNumber;
+        createdAt: z.ZodString;
+    }, z.core.$strip>>;
+    total: z.ZodNumber;
+    page: z.ZodNumber;
+    pageSize: z.ZodNumber;
+    totalPages: z.ZodNumber;
+}, z.core.$strip>;
+/** One token-denominated BuilderCodes earnings total. */
+export declare const BuildercodePayoutTokenTotalSchema: z.ZodObject<{
+    token: z.ZodString;
+    totalAmount: z.ZodString;
+    payoutCount: z.ZodNumber;
+    lastCreditedAt: z.ZodString;
+}, z.core.$strip>;
+/** Schema for this frontend's payout summary. */
+export declare const GetBuildercodePayoutSummaryResponseSchema: z.ZodObject<{
+    totalPayouts: z.ZodNumber;
+    lastCreditedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    byToken: z.ZodArray<z.ZodObject<{
+        token: z.ZodString;
+        totalAmount: z.ZodString;
+        payoutCount: z.ZodNumber;
+        lastCreditedAt: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/** One available balance in the reserved BuilderCodes reward bucket. */
+export declare const BuildercodeRewardsBalanceSchema: z.ZodObject<{
+    token: z.ZodString;
+    available: z.ZodString;
+}, z.core.$strip>;
+/** Schema for the caller wallet's reserved BuilderCodes balances. */
+export declare const GetBuildercodeRewardsBalanceResponseSchema: z.ZodObject<{
+    balances: z.ZodArray<z.ZodObject<{
+        token: z.ZodString;
+        available: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/** Schema for the claim-BuilderCodes-rewards request body. */
+export declare const ClaimBuildercodeRewardsParamsSchema: z.ZodObject<{
+    token: z.ZodString;
+    amount: z.ZodString;
+}, z.core.$strip>;
+/** Schema for the claim-BuilderCodes-rewards response. */
+export declare const ClaimBuildercodeRewardsResponseSchema: z.ZodObject<{
+    payoutBalance: z.ZodString;
+    tradingBalance: z.ZodString;
+}, z.core.$strip>;
+export type ClaimBuildercodeRewardsParams = z.infer<typeof ClaimBuildercodeRewardsParamsSchema>;
+export type ClaimBuildercodeRewardsResponse = z.infer<typeof ClaimBuildercodeRewardsResponseSchema>;
+export type GetBuildercodesConfigResponse = z.infer<typeof GetBuildercodesConfigResponseSchema>;
+export type ListBuildercodePayoutsParams = z.infer<typeof ListBuildercodePayoutsParamsSchema>;
+export type BuildercodePayout = z.infer<typeof BuildercodePayoutSchema>;
+export type ListBuildercodePayoutsResponse = z.infer<typeof ListBuildercodePayoutsResponseSchema>;
+export type BuildercodePayoutTokenTotal = z.infer<typeof BuildercodePayoutTokenTotalSchema>;
+export type GetBuildercodePayoutSummaryResponse = z.infer<typeof GetBuildercodePayoutSummaryResponseSchema>;
+export type BuildercodeRewardsBalance = z.infer<typeof BuildercodeRewardsBalanceSchema>;
+export type GetBuildercodeRewardsBalanceResponse = z.infer<typeof GetBuildercodeRewardsBalanceResponseSchema>;

package/dist/buildercodes/responses.js

@@ -0,0 +1,92 @@
+/**
+ * BuilderCodes Response Types
+ *
+ * Types for the BuilderCodes earnings and payout API responses and requests.
+ * All types are derived from Zod schemas for runtime validation.
+ */
+import { z } from "zod";
+/** Schema for this frontend's current BuilderCodes program state. */
+export const GetBuildercodesConfigResponseSchema = z.object({
+    applicationId: z.string().uuid(),
+    enrolled: z.boolean(),
+    // Nullable, not merely absent: `payout_address` is an `optional` proto field
+    // with no skip-serializing, so the server sends an explicit `null` when no
+    // address is configured. `.optional()` alone accepts `undefined` and would
+    // throw on that valid response. Matches `lastCreditedAt` below.
+    payoutAddress: z.string().nullable().optional(),
+    buildercodesEnabled: z.boolean(),
+    buildercodesBudgetBps: z.number().int().min(0).max(10_000),
+});
+/** Pagination accepted by the per-trade payout history endpoint. */
+export const ListBuildercodePayoutsParamsSchema = z.object({
+    page: z.number().int().min(1).max(10_000).optional(),
+    pageSize: z.number().int().min(1).max(100).optional(),
+});
+/** One per-trade BuilderCodes credit. Amounts are RAW atomic units. */
+export const BuildercodePayoutSchema = z.object({
+    tradeId: z.string().uuid(),
+    payoutAddress: z.string(),
+    token: z.string(),
+    amount: z.string(),
+    appliedBps: z.number().int(),
+    createdAt: z.string(),
+});
+/** Schema for the paginated per-trade payout history. */
+export const ListBuildercodePayoutsResponseSchema = z.object({
+    payouts: z.array(BuildercodePayoutSchema),
+    total: z.number().int().nonnegative(),
+    page: z.number().int().positive(),
+    pageSize: z.number().int().positive(),
+    totalPages: z.number().int().nonnegative(),
+});
+/** One token-denominated BuilderCodes earnings total. */
+export const BuildercodePayoutTokenTotalSchema = z.object({
+    token: z.string(),
+    totalAmount: z.string(),
+    payoutCount: z.number().int().nonnegative(),
+    lastCreditedAt: z.string(),
+});
+/** Schema for this frontend's payout summary. */
+export const GetBuildercodePayoutSummaryResponseSchema = z.object({
+    totalPayouts: z.number().int().nonnegative(),
+    lastCreditedAt: z.string().nullable().optional(),
+    byToken: z.array(BuildercodePayoutTokenTotalSchema),
+});
+/** One available balance in the reserved BuilderCodes reward bucket. */
+export const BuildercodeRewardsBalanceSchema = z.object({
+    token: z.string(),
+    available: z.string(),
+});
+/** Schema for the caller wallet's reserved BuilderCodes balances. */
+export const GetBuildercodeRewardsBalanceResponseSchema = z.object({
+    balances: z.array(BuildercodeRewardsBalanceSchema),
+});
+/** Schema for the claim-BuilderCodes-rewards request body. */
+export const ClaimBuildercodeRewardsParamsSchema = z.object({
+    /**
+     * Payout token contract address (0x-prefixed) to claim. BuilderCodes shares
+     * accrue in the quote token of the traded pair.
+     */
+    token: z
+        .string()
+        .trim()
+        .min(1, "token is required")
+        .regex(/^0x[0-9a-fA-F]{40}$/, "token must be a 0x-prefixed EVM address"),
+    /**
+     * Amount to claim, in RAW atomic units of the token. Must be a positive
+     * integer string and no greater than the accrued payout balance — the server
+     * rejects an over-claim with 409 rather than moving a partial amount.
+     */
+    amount: z
+        .string()
+        .trim()
+        .min(1, "amount is required")
+        .refine((v) => /^\d+$/.test(v) && BigInt(v) > 0n, "amount must be a positive integer string"),
+});
+/** Schema for the claim-BuilderCodes-rewards response. */
+export const ClaimBuildercodeRewardsResponseSchema = z.object({
+    /** Your BuilderCodes payout-bucket balance after the claim, RAW atomic units. */
+    payoutBalance: z.string(),
+    /** Your trading balance for the token after the claim, RAW atomic units. */
+    tradingBalance: z.string(),
+});

package/dist/index.d.ts

@@ -7,6 +7,7 @@
 export * from "./api";
 export * from "./applications";
 export * from "./auth";
+export * from "./buildercodes";
 export * from "./contracts";
 export * from "./delegated-agents";
 export * from "./faucet";

package/dist/index.js

@@ -8,6 +8,7 @@
 export * from "./api";
 export * from "./applications";
 export * from "./auth";
+export * from "./buildercodes";
 export * from "./contracts";
 export * from "./delegated-agents";
 export * from "./faucet";

package/dist/positions/index.d.ts

@@ -107,6 +107,34 @@ export interface Position {
      * an understated partial.
      */
     cumFees?: string;
+    /**
+     * Opaque, non-negative producer-owned row version for this position
+     * (0XM-2673). Compare only within the same `positionId`; higher is newer.
+     *
+     * The same number the WebSocket `positions` snapshot and a RANKED live
+     * `position_update` frame carry, so this read can be ranked against them.
+     * Some live frames are deliberately unranked and omit `version` even when
+     * their state matches this row.
+     * `0` is the unranked legacy sentinel and never participates in ordering:
+     * treat it exactly as an absent version and fall back to a full field
+     * comparison rather than ranking it as oldest.
+     *
+     * The merge rule is PER FIELD GROUP, never per payload. On an EQUAL version
+     * skip the versioned fields as an idempotent redelivery — EXCEPT
+     * `isolatedMargin`, which the WebSocket positions snapshot overlays from an
+     * independent live matching-engine read rather than from the versioned row,
+     * so it can reflect a later command than the version names and must be
+     * taken from the newer payload. Also still take
+     * `markPrice`, `unrealizedPnl`, `liquidationPrice` and `leverage` from the
+     * newer payload: those four are re-derived from the oracle mark on every
+     * read, carry no version, and the version does not advance for them.
+     * Discarding a whole payload on an equal version freezes displayed PnL
+     * until the position's next real mutation.
+     *
+     * A response served from live matching-engine state reports `0`: the engine
+     * holds the state but not the version, so it cannot rank itself.
+     */
+    version?: number;
 }
 export interface ListPositionsParams {
     marginAccountId?: string;

package/dist/profile/index.d.ts

@@ -5,7 +5,7 @@
  */
 import type { Address } from "viem";
 import type { BaseAPI } from "../api";
-import type { OrderSide, OrderStatus, OrderType, TimeInForce } from "../trading";
+import type { OrderSide, OrderStatus, OrderType, SelfTradePreventionMode, TimeInForce } from "../trading";
 /**
  * Account movement/transaction information.
  * Represents transactions/movements returned in the profile's recent_movements array.
@@ -502,6 +502,17 @@ export interface UserProfile {
     /** Additional maker fee in basis points contributed by the application (if any) */
     applicationMakerFeeBps?: number;
 }
+/**
+ * The wallet's self-trade-prevention default — the mode applied when an order
+ * from this wallet family would match the family's own resting order and the
+ * order itself names no override.
+ */
+export interface SelfTradePreventionDefault {
+    /** The wallet's effective mode. */
+    mode: SelfTradePreventionMode;
+    /** True when this wallet has explicitly set a default; false when the platform default (`CANCEL_MAKER`) is in effect. */
+    isCustom: boolean;
+}
 /**
  * Profile API interface.
  * Provides methods for fetching and managing user profile information.
@@ -612,4 +623,27 @@ export interface ProfileAPI extends BaseAPI {
      * @throws ValidationError If pagination params or a UUID filter are invalid; this may occur before any network request.
      */
     listFundingPayments(params?: ListFundingPaymentsParams): Promise<ListFundingPaymentsResponse>;
+    /**
+     * Get the wallet's self-trade-prevention default.
+     *
+     * Fetches the setting from the /api/v1/accounts/self-trade-prevention endpoint.
+     * Requires a valid access token to be set. The default is wallet-scoped: it
+     * covers every application and account sharing the wallet address.
+     *
+     * @returns Promise resolving to the effective mode plus whether it was explicitly set
+     */
+    getSelfTradePreventionDefault(): Promise<SelfTradePreventionDefault>;
+    /**
+     * Set the wallet's self-trade-prevention default.
+     *
+     * Sends a PUT to the /api/v1/accounts/self-trade-prevention endpoint. The
+     * write is sequenced through the matching engine; on success the wallet
+     * family's next order already resolves the new mode. Delegated-agent
+     * sessions cannot change it (403).
+     *
+     * @param mode - One of "CANCEL_MAKER", "CANCEL_TAKER", "CANCEL_BOTH", "SKIP"
+     * @returns Promise resolving to the setting now in force
+     * @throws ValidationError If mode is not a known token; this occurs before any network request.
+     */
+    setSelfTradePreventionDefault(mode: SelfTradePreventionMode): Promise<SelfTradePreventionDefault>;
 }

package/dist/sdk/index.d.ts

@@ -1,6 +1,7 @@
 import type { Address, PublicClient, TransactionReceipt, WalletClient } from "viem";
 import type { ApplicationsAPI } from "../applications";
 import type { AuthAPI, AuthState } from "../auth/index";
+import type { BuildercodesAPI } from "../buildercodes";
 import type { DelegatedAgentsAPI } from "../delegated-agents";
 import type { FaucetAPI } from "../faucet";
 import type { FeesAPI } from "../fees";
@@ -111,6 +112,8 @@ export interface MonacoSDK {
     subAccounts: SubAccountsAPI;
     /** PitPass TraderCode referral and rewards API */
     pitpass: PitpassAPI;
+    /** BuilderCodes frontend revenue-share payout API */
+    buildercodes: BuildercodesAPI;
     /** Testnet faucet API */
     faucet: FaucetAPI;
     /** Deposit-address registration (sweeper) API; requires a session */

package/dist/trading/index.d.ts

@@ -5,7 +5,7 @@
  */
 import type { BaseAPI } from "../api/index";
 import type { MarginMode } from "../margin-accounts";
-import type { Order, OrderSide, PositionSide, TimeInForce, TradingMode } from "./orders";
+import type { Order, OrderSide, PositionSide, SelfTradePreventionMode, TimeInForce, TradingMode } from "./orders";
 import type { BatchCancelOrdersResponse, BatchCreateOrderParams, BatchCreateOrdersResponse, BatchReplaceOrderParams, BatchReplaceOrdersResponse, CancelConditionalOrderResponse, CancelOrderResponse, CancelTwapOrderResponse, ConditionalOrder, CreateOrderResponse, CreateTwapOrderOptions, CreateTwapOrderResponse, GetOrderResponse, GetPaginatedOrdersParams, GetPaginatedOrdersResponse, GetTwapOrderTcaResponse, ListConditionalOrdersParams, ListConditionalOrdersResponse, ListTwapOrdersParams, ListTwapOrdersResponse, ParentTpSlLegParams, ReplaceOrderResponse, TwapOrder } from "./responses";
 /**
  * Trading API interface.
@@ -45,6 +45,13 @@ export interface TradingAPI extends BaseAPI {
          * Echoed back as `postOnly` on order detail and list reads.
          */
         postOnly?: boolean;
+        /**
+         * Per-order self-trade-prevention override: CANCEL_MAKER, CANCEL_TAKER,
+         * CANCEL_BOTH, or SKIP. Omitted, your wallet's configured default
+         * applies, else the platform default CANCEL_MAKER. Echoed back as
+         * `selfTradePreventionMode` on order reads.
+         */
+        selfTradePreventionMode?: SelfTradePreventionMode;
         /**
          * Client-assigned correlation handle, echoed back on order reads and
          * order WebSocket events. At most 64 characters from [A-Za-z0-9._:-].
@@ -82,6 +89,13 @@ export interface TradingAPI extends BaseAPI {
         positionSide?: PositionSide;
         leverage?: string;
         reduceOnly?: boolean;
+        /**
+         * Per-order self-trade-prevention override: CANCEL_MAKER, CANCEL_TAKER,
+         * CANCEL_BOTH, or SKIP. Omitted, your wallet's configured default
+         * applies, else the platform default CANCEL_MAKER. Echoed back as
+         * `selfTradePreventionMode` on order reads.
+         */
+        selfTradePreventionMode?: SelfTradePreventionMode;
         /**
          * Client-assigned correlation handle, echoed back on order reads and
          * order WebSocket events. At most 64 characters from [A-Za-z0-9._:-].
@@ -149,6 +163,12 @@ export interface TradingAPI extends BaseAPI {
         quantity?: string;
         useMasterBalance?: boolean;
         postOnly?: boolean;
+        /**
+         * Re-states the self-trade-prevention override for the replacement:
+         * nothing is inherited from the original order. Omitted, your wallet's
+         * configured default applies, else the platform default CANCEL_MAKER.
+         */
+        selfTradePreventionMode?: SelfTradePreventionMode;
         /**
          * Client-assigned correlation handle, echoed back on order reads and
          * order WebSocket events. At most 64 characters from [A-Za-z0-9._:-].
@@ -238,6 +258,6 @@ export interface TradingAPI extends BaseAPI {
      */
     listTwapOrders(params?: ListTwapOrdersParams): Promise<ListTwapOrdersResponse>;
 }
-export type { ConditionalOrderConditionType, ConditionalOrderState, ConditionalOrderTriggerSource, Order, OrderRole, OrderSide, OrderStatus, OrderStatusFilter, OrderTerminalReason, OrderType, PositionSide, TimeInForce, TradingMode, TwapExecutionStyle, TwapOrderState, } from "./orders";
+export type { ConditionalOrderConditionType, ConditionalOrderState, ConditionalOrderTriggerSource, ListedOrderType, Order, OrderRole, OrderSide, OrderStatus, OrderStatusFilter, OrderTerminalReason, OrderType, PositionSide, SelfTradePreventionMode, TimeInForce, TradingMode, TwapExecutionStyle, TwapOrderState, } from "./orders";
 export { ORDER_STATUS_VALUES } from "./orders";
 export type { BatchCancelError, BatchCancelOrdersResponse, BatchCancelResult, BatchCreateOrderParams, BatchCreateOrdersResponse, BatchCreateResult, BatchError, BatchReplaceOrderParams, BatchReplaceOrdersResponse, BatchReplaceResult, CancelConditionalOrderResponse, CancelOrderResponse, CancelTwapOrderResponse, ConditionalOrder, CreateOrderResponse, CreateTwapOrderOptions, CreateTwapOrderResponse, GetOrderResponse, GetPaginatedOrdersParams, GetPaginatedOrdersResponse, GetTwapOrderTcaResponse, ListConditionalOrdersParams, ListConditionalOrdersResponse, ListTwapOrdersParams, ListTwapOrdersResponse, MatchResult, ParentTpSlLegParams, ReplaceOrderResponse, TwapOrder, UpdatedFields, } from "./responses";

package/dist/trading/orders.d.ts

@@ -3,6 +3,7 @@
  *
  * Types for trading operations and order management.
  */
+import type { ConditionalOrder, TwapOrder } from "./responses";
 /**
  * Standard order structure used across all order-related responses.
  * This represents the complete order information as returned by the API.
@@ -13,6 +14,13 @@
  * Orders can transition to `CANCELLED`, `REJECTED`, or `EXPIRED` at various stages.
  * Fee fields are only populated after order fills occur.
  *
+ * The order listing returns every kind of order in one stream, so a row here
+ * may be a book order, a TWAP parent (`orderType: "TWAP"`) or a conditional
+ * order (`orderType: "CONDITIONAL"`). Switch on `orderType`: the kind-specific
+ * detail hangs off `twap` / `conditional`, and the fields above are populated
+ * for every kind — a parent's `quantity` is its total, `filledQuantity` what
+ * it has executed so far, and `status` its state expressed as an order status.
+ *
  * @example
  * To calculate remaining quantity:
  * ```typescript
@@ -26,8 +34,8 @@ export interface Order {
     tradingPairId: string;
     /** Order side (BUY or SELL) */
     side: OrderSide;
-    /** Order type - see OrderType for all supported types */
-    orderType: OrderType;
+    /** What kind of order this row is - see ListedOrderType */
+    orderType: ListedOrderType;
     /** Order status - see OrderStatus for lifecycle details */
     status: OrderStatus;
     /** Order price - null for market orders, required for limit orders */
@@ -70,6 +78,14 @@ export interface Order {
     reduceOnly?: boolean;
     /** Whether the order was placed post-only (maker-only). Absent for orders placed before the flag was persisted. */
     postOnly?: boolean;
+    /**
+     * The per-order self-trade-prevention override REQUESTED when this order was
+     * placed or replaced. Absent when the order carried no override — including
+     * every order placed before the field was accepted on write — even though a
+     * wallet or platform default still governed its matching: this echoes the
+     * request, not the resolved default.
+     */
+    selfTradePreventionMode?: SelfTradePreventionMode;
     /**
      * Client-assigned correlation handle as stored: the value supplied on create
      * or replace, with surrounding whitespace trimmed. Absent when the order
@@ -82,6 +98,18 @@ export interface Order {
     clientOrderId?: string;
     /** Position ID linked to the order, when available */
     positionId?: string;
+    /**
+     * The TWAP parent behind this row - its schedule, slice counters and
+     * progress - present only when `orderType` is `"TWAP"`. Identical to what
+     * `getTwapOrder` returns for the same id.
+     */
+    twap?: TwapOrder;
+    /**
+     * The conditional order behind this row - its trigger and the order it fires
+     * - present only when `orderType` is `"CONDITIONAL"`. Identical to what the
+     * conditional-order endpoints return for the same id.
+     */
+    conditional?: ConditionalOrder;
     /** Stable cause when status is CANCELLED */
     terminalReason?: OrderTerminalReason;
     /**
@@ -131,7 +159,7 @@ export interface Order {
     version?: number;
 }
 /** Stable terminal causes for accepted orders that end as CANCELLED. */
-export type OrderTerminalReason = "USER_REQUESTED" | "REPLACED" | "LIQUIDATION" | "INSUFFICIENT_MARGIN" | "REDUCE_ONLY_EXHAUSTED" | "POSITION_CLOSED" | "OCO_SIBLING_TRIGGERED" | "SYSTEM";
+export type OrderTerminalReason = "USER_REQUESTED" | "REPLACED" | "LIQUIDATION" | "INSUFFICIENT_MARGIN" | "REDUCE_ONLY_EXHAUSTED" | "POSITION_CLOSED" | "OCO_SIBLING_TRIGGERED" | "SELF_TRADE_PREVENTION" | "SYSTEM";
 /**
  * Role of the creator or order
  */
@@ -154,6 +182,16 @@ export type PositionSide = "LONG" | "SHORT" | "NONE";
  * - TRAILING_STOP: Stop order that trails the market price
  */
 export type OrderType = "LIMIT" | "MARKET";
+/**
+ * What kind of order a listed row is.
+ *
+ * Wider than {@link OrderType}, which is what you can place: the order listing
+ * serves book orders, TWAP parents and conditional orders as one stream, and
+ * `"TWAP"` / `"CONDITIONAL"` name the two kinds that are created through their
+ * own endpoints rather than `createOrder`. A row of either kind carries its
+ * detail on {@link Order.twap} or {@link Order.conditional}.
+ */
+export type ListedOrderType = OrderType | "TWAP" | "CONDITIONAL";
 /**
  * Source-of-truth order status values used by runtime validation schemas.
  */
@@ -195,6 +233,24 @@ export type TradingMode = "SPOT" | "MARGIN";
  *   `GTC` together with `expirationDate`.
  */
 export type TimeInForce = "GTC" | "IOC" | "FOK" | "GTD";
+/**
+ * Per-order self-trade-prevention override: how the engine resolves the order
+ * matching against one of your own resting orders (whole wallet family,
+ * subaccounts included; the incoming order's mode governs the step).
+ * - CANCEL_MAKER: cancel each of your resting orders encountered and keep
+ *   matching (the platform default when no override or wallet default is set)
+ * - CANCEL_TAKER: fill third-party liquidity up to the first self-touch, then
+ *   cancel the incoming order's remainder (zero-fill CANCELLED possible)
+ * - CANCEL_BOTH: CANCEL_TAKER plus cancelling the encountered resting orders;
+ *   an FOK order with your own order in the fill path is rejected with
+ *   SELF_TRADE_NOT_ALLOWED
+ * - SKIP: trade around your resting orders; a remainder that would rest
+ *   crossing one of your surviving orders is cancelled instead of resting
+ *
+ * STP cancellations carry `terminalReason: "SELF_TRADE_PREVENTION"` and
+ * `stpCounterpartyOrderId` on order reads and WebSocket events.
+ */
+export type SelfTradePreventionMode = "CANCEL_MAKER" | "CANCEL_TAKER" | "CANCEL_BOTH" | "SKIP";
 /**
  * Conditional TP/SL condition type.
  */

package/dist/trading/responses.d.ts

@@ -4,7 +4,7 @@
  * Response types for trading operations.
  */
 import type { MarginMode } from "../margin-accounts";
-import type { ConditionalOrderConditionType, ConditionalOrderState, ConditionalOrderTriggerSource, Order, OrderSide, OrderStatus, OrderStatusFilter, OrderType, PositionSide, TimeInForce, TradingMode, TwapExecutionStyle, TwapOrderState } from "./orders";
+import type { ConditionalOrderConditionType, ConditionalOrderState, ConditionalOrderTriggerSource, Order, OrderSide, OrderStatus, OrderStatusFilter, OrderType, PositionSide, SelfTradePreventionMode, TimeInForce, TradingMode, TwapExecutionStyle, TwapOrderState } from "./orders";
 /**
  * Match result information for order execution.
  * Contains detailed information about trades, fills, and execution quality.
@@ -375,6 +375,16 @@ export interface BatchCreateOrderParams {
      * detail and list reads.
      */
     postOnly?: boolean;
+    /**
+     * Per-order self-trade-prevention override. An unknown value fails only this
+     * item, with a structured `error.code` of
+     * `INVALID_SELF_TRADE_PREVENTION_MODE`; an FOK item under CANCEL_BOTH with
+     * your own order in the fill path fails with `SELF_TRADE_NOT_ALLOWED`.
+     * Omitted, your wallet's configured default applies, else the platform
+     * default CANCEL_MAKER. Echoed back as `selfTradePreventionMode` on order
+     * reads.
+     */
+    selfTradePreventionMode?: SelfTradePreventionMode;
     /**
      * Client-assigned correlation handle, echoed back on order reads and on
      * order WebSocket events. At most 64 characters from [A-Za-z0-9._:-].
@@ -405,6 +415,12 @@ export interface BatchReplaceOrderParams {
      * inherited from the original order — see `TradingAPI.replaceOrder`.
      */
     postOnly?: boolean;
+    /**
+     * Re-states the self-trade-prevention override for the replacement
+     * (optional). Nothing is inherited from the original order; an unknown value
+     * fails only this item with `INVALID_SELF_TRADE_PREVENTION_MODE`.
+     */
+    selfTradePreventionMode?: SelfTradePreventionMode;
     /**
      * Client-assigned correlation handle, echoed back on order reads and on
      * order WebSocket events. At most 64 characters from [A-Za-z0-9._:-].

package/dist/validation/profile.d.ts

@@ -28,6 +28,19 @@ export declare const TransactionTypeSchema: z.ZodEnum<{
     INTEREST: "INTEREST";
     REWARD: "REWARD";
 }>;
+/**
+ * Set Self-Trade-Prevention Default validation schema
+ *
+ * Validates the body of PUT /api/v1/accounts/self-trade-prevention.
+ */
+export declare const SetSelfTradePreventionDefaultSchema: z.ZodObject<{
+    mode: z.ZodEnum<{
+        CANCEL_MAKER: "CANCEL_MAKER";
+        CANCEL_TAKER: "CANCEL_TAKER";
+        CANCEL_BOTH: "CANCEL_BOTH";
+        SKIP: "SKIP";
+    }>;
+}, z.core.$strip>;
 /**
  * Get User Movements validation schema
  *