Module enums 

Wire-format enums for the Derive REST/WS APIs.

Variants are sourced from the venue’s own Rust SDK at derivexyz/cockpit, which is generated from Derive’s JSON-RPC schemas. Variant wire strings are case-sensitive and must round-trip byte-equivalent.

Structs

DeriveAssetTypeIter

An iterator over the variants of DeriveAssetType

DeriveInstrumentTypeIter

An iterator over the variants of DeriveInstrumentType

Enums

DeriveAssetType

Wire-level asset type as returned in subaccount and collateral responses (asset_type field on private/get_subaccount, public/get_assets, private/get_collaterals). The variants line up byte-for-byte with DeriveInstrumentType but the venue treats it as a distinct field.

DeriveAuctionState

Liquidation auction state.

DeriveAuctionType

Liquidation auction type returned by private/get_liquidation_history.

DeriveBalanceUpdateType

Cause of a balance row update on the WS {subaccount_id}.balances channel.

DeriveComplianceStatus

Compliance status returned by public/change_compliance_status.

DeriveEnvironment

Derive network selector. Drives REST/WS URLs and per-network protocol constants (DOMAIN_SEPARATOR, module addresses).

DeriveInstrumentType

Wire-level instrument type returned by public/get_instruments and used as the instrument_type filter on listing endpoints and WS channel names like trades.{instrument_type}.{currency}.

DeriveLiquidityRole

Role of the user in a trade (liquidity_role field).

DeriveMarginType

Subaccount margining mode. Returned by private/get_subaccount. Subaccount creation accepts only Sm and Pm; Pm2 appears only as a read value when an account has migrated to PMRM v2.

DeriveNotificationStatus

Notification acknowledgement state on private/get_notifications and private/update_notifications.

DeriveNotificationType

Notification category. The Types variant is emitted by the upstream codegen and surfaces in the wire enum; treat it as a generic placeholder rather than a meaningful category.

DeriveOptionKind

Option kind parsed from the instrument_name suffix (e.g. -C or -P).

DeriveOrderCancelReason

Cancel reason attached to a cancelled order. Empty string corresponds to no reason (order is still open or finished by another transition).

DeriveOrderSide

Order side (direction field on the venue API).

DeriveOrderStatus

Order lifecycle status reported by private/get_orders, private/get_order_history, and the WS {subaccount_id}.orders channel.

DeriveOrderType

Order type accepted by private/order and private/trigger_order.

DeriveOrderbookDepth

Discrete depth values allowed in the WS subscription channel name orderbook.{instrument_name}.{group}.{depth}.

DeriveOrderbookGroup

Discrete price-grouping values for orderbook.{instrument_name}.{group}.{depth}.

DeriveRfqCancelReason

Cancel reason attached to a cancelled RFQ quote. Similar to DeriveOrderCancelReason but emits rfq_no_longer_open instead of ioc_or_market_partial_fill.

DeriveTickerInterval

Discrete ticker push intervals (milliseconds) for the WS ticker_slim.{instrument_name}.{interval} channel.

DeriveTimeInForce

Time-in-force flag accepted by private/order.

DeriveTriggerPriceType

Trigger price source accepted by private/trigger_order.

DeriveTriggerType

Trigger side accepted by private/trigger_order.

DeriveTxStatus

Blockchain transaction lifecycle status (tx_status field on trades, deposits, withdrawals, transfers, and liquidation history).