@velocity-exchange/sdk 0.3.0 → 0.4.0

package/lib/browser/types.js

@@ -4,6 +4,13 @@ exports.ConstituentStatus = exports.OracleValidity = exports.SwapReduceOnly = ex
 exports.TransferFeeAndPnlPoolDirection = exports.ConstituentLpOperation = void 0;
 const numericConstants_1 = require("./constants/numericConstants");
 // # Utility Types / Enums / Constants
+/**
+ * Bitmask mirror of `State.exchangeStatus`. Each non-zero member pauses one class of
+ * instructions protocol-wide; multiple bits may be set simultaneously (e.g. deposits and
+ * withdrawals paused together). `PAUSED` (255) is the "pause everything" value, not a flag
+ * combinable with the others. Only `coldAdmin`/`warmAdmin` may clear bits; `pauseAdmin` may
+ * only set them (see `StateAccount.pauseAdmin`).
+ */
 var ExchangeStatus;
 (function (ExchangeStatus) {
     ExchangeStatus[ExchangeStatus["ACTIVE"] = 0] = "ACTIVE";
@@ -17,20 +24,36 @@ var ExchangeStatus;
     ExchangeStatus[ExchangeStatus["AMM_IMMEDIATE_FILL_PAUSED"] = 128] = "AMM_IMMEDIATE_FILL_PAUSED";
     ExchangeStatus[ExchangeStatus["PAUSED"] = 255] = "PAUSED";
 })(ExchangeStatus || (exports.ExchangeStatus = ExchangeStatus = {}));
-// Mirror of the Rust `SolvencyStatus` bitflag (State.solvencyStatus). Gates
-// internal solvency-repair flows independently of ExchangeStatus.WITHDRAW_PAUSED.
+/**
+ * Mirror of the Rust `SolvencyStatus` bitflag (`StateAccount.solvencyStatus`). Gates internal
+ * solvency-repair flows (bankruptcy / pnl-deficit resolution) independently of
+ * `ExchangeStatus.WITHDRAW_PAUSED`, so withdrawals can be halted while repair keeps running, or
+ * repair can be frozen on its own (e.g. when an oracle is suspect) without touching withdrawals.
+ * `ACTIVE` (0) means repair is allowed.
+ */
 var SolvencyStatus;
 (function (SolvencyStatus) {
     SolvencyStatus[SolvencyStatus["ACTIVE"] = 0] = "ACTIVE";
     SolvencyStatus[SolvencyStatus["SOLVENCY_REPAIR_PAUSED"] = 1] = "SOLVENCY_REPAIR_PAUSED";
 })(SolvencyStatus || (exports.SolvencyStatus = SolvencyStatus = {}));
+/** Bitmask mirror of `StateAccount.featureBitFlags`, gating protocol-wide optional features. */
 var FeatureBitFlags;
 (function (FeatureBitFlags) {
     FeatureBitFlags[FeatureBitFlags["MM_ORACLE_UPDATE"] = 1] = "MM_ORACLE_UPDATE";
     FeatureBitFlags[FeatureBitFlags["MEDIAN_TRIGGER_PRICE"] = 2] = "MEDIAN_TRIGGER_PRICE";
     FeatureBitFlags[FeatureBitFlags["BUILDER_CODES"] = 4] = "BUILDER_CODES";
-    FeatureBitFlags[FeatureBitFlags["BUILDER_REFERRAL"] = 8] = "BUILDER_REFERRAL";
 })(FeatureBitFlags || (exports.FeatureBitFlags = FeatureBitFlags = {}));
+/**
+ * Mirrors the Rust `MarketStatus` enum on `PerpMarketAccount.status` / `SpotMarketAccount.status`.
+ * Controls which operations a market allows: `INITIALIZED` (warm-up, fills paused), `ACTIVE` (all
+ * operations allowed), `REDUCE_ONLY` (fills may only shrink a liability), `SETTLEMENT` (market has
+ * a determined settlement price; positions must be settled), `DELISTED` (no participants remain).
+ * Velocity's on-chain discriminants (`Initialized`=0, `Active`=1, `ReduceOnly`=2, `Settlement`=3,
+ * `Delisted`=4) are **shifted down from upstream Drift's** (`ReduceOnly`=6, `Settlement`=7,
+ * `Delisted`=8) after the deprecated `FundingPaused`/`AmmPaused`/`FillPaused`/`WithdrawPaused`
+ * variants were removed — any decoder built against the old Drift discriminants will silently
+ * misread these states.
+ */
 class MarketStatus {
 }
 exports.MarketStatus = MarketStatus;
@@ -39,6 +62,7 @@ MarketStatus.ACTIVE = { active: {} };
 MarketStatus.REDUCE_ONLY = { reduceOnly: {} };
 MarketStatus.SETTLEMENT = { settlement: {} };
 MarketStatus.DELISTED = { delisted: {} };
+/** Bitmask mirror of `PerpMarketAccount.pausedOperations`; each bit disables one perp-market operation. */
 var PerpOperation;
 (function (PerpOperation) {
     PerpOperation[PerpOperation["UPDATE_FUNDING"] = 1] = "UPDATE_FUNDING";
@@ -47,8 +71,10 @@ var PerpOperation;
     PerpOperation[PerpOperation["SETTLE_PNL"] = 8] = "SETTLE_PNL";
     PerpOperation[PerpOperation["SETTLE_PNL_WITH_POSITION"] = 16] = "SETTLE_PNL_WITH_POSITION";
     PerpOperation[PerpOperation["LIQUIDATION"] = 32] = "LIQUIDATION";
-    PerpOperation[PerpOperation["SETTLE_REV_POOL"] = 64] = "SETTLE_REV_POOL";
+    PerpOperation[PerpOperation["AMM_IMMEDIATE_FILL"] = 64] = "AMM_IMMEDIATE_FILL";
+    PerpOperation[PerpOperation["SETTLE_REV_POOL"] = 128] = "SETTLE_REV_POOL";
 })(PerpOperation || (exports.PerpOperation = PerpOperation = {}));
+/** Bitmask mirror of `SpotMarketAccount.pausedOperations`; each bit disables one spot-market operation. */
 var SpotOperation;
 (function (SpotOperation) {
     SpotOperation[SpotOperation["UPDATE_CUMULATIVE_INTEREST"] = 1] = "UPDATE_CUMULATIVE_INTEREST";
@@ -57,6 +83,7 @@ var SpotOperation;
     SpotOperation[SpotOperation["WITHDRAW"] = 8] = "WITHDRAW";
     SpotOperation[SpotOperation["LIQUIDATION"] = 16] = "LIQUIDATION";
 })(SpotOperation || (exports.SpotOperation = SpotOperation = {}));
+/** Bitmask mirror of `SpotMarketAccount.ifPausedOperations`; each bit disables one insurance-fund-stake operation. */
 var InsuranceFundOperation;
 (function (InsuranceFundOperation) {
     InsuranceFundOperation[InsuranceFundOperation["INIT"] = 1] = "INIT";
@@ -64,6 +91,11 @@ var InsuranceFundOperation;
     InsuranceFundOperation[InsuranceFundOperation["REQUEST_REMOVE"] = 4] = "REQUEST_REMOVE";
     InsuranceFundOperation[InsuranceFundOperation["REMOVE"] = 8] = "REMOVE";
 })(InsuranceFundOperation || (exports.InsuranceFundOperation = InsuranceFundOperation = {}));
+/**
+ * Bitmask mirror of `UserAccount.status`. Multiple bits can be set at once (e.g. a bankrupt user
+ * is also `BEING_LIQUIDATED`). `0` (unset) means active/normal. Bit `16` (was `PROTECTED_MAKER`)
+ * is reserved and no longer assigned.
+ */
 var UserStatus;
 (function (UserStatus) {
     UserStatus[UserStatus["BEING_LIQUIDATED"] = 1] = "BEING_LIQUIDATED";
@@ -72,29 +104,44 @@ var UserStatus;
     UserStatus[UserStatus["ADVANCED_LP"] = 8] = "ADVANCED_LP";
     // 16 reserved (was PROTECTED_MAKER)
 })(UserStatus || (exports.UserStatus = UserStatus = {}));
+/** Bitmask mirror of `UserAccount.specialUserStatus`. `VAMM_HEDGER` marks the account used by the protocol's own vAMM-hedging bot. */
 var SpecialUserStatus;
 (function (SpecialUserStatus) {
     SpecialUserStatus[SpecialUserStatus["VAMM_HEDGER"] = 1] = "VAMM_HEDGER";
 })(SpecialUserStatus || (exports.SpecialUserStatus = SpecialUserStatus = {}));
+/** Bitmask mirror of `UserStatsAccount.pausedOperations`; each bit disables one per-user-stats update path. */
 var UserStatsPausedOperation;
 (function (UserStatsPausedOperation) {
     UserStatsPausedOperation[UserStatsPausedOperation["UPDATE_BID_ASK_TWAP"] = 1] = "UPDATE_BID_ASK_TWAP";
     UserStatsPausedOperation[UserStatsPausedOperation["AMM_ATOMIC_FILL"] = 2] = "AMM_ATOMIC_FILL";
     UserStatsPausedOperation[UserStatsPausedOperation["AMM_ATOMIC_RISK_INCREASING_FILL"] = 4] = "AMM_ATOMIC_RISK_INCREASING_FILL";
 })(UserStatsPausedOperation || (exports.UserStatsPausedOperation = UserStatsPausedOperation = {}));
+/** Bitmask mirror of `PerpMarketAccount.marketConfig`. `DISABLE_FORMULAIC_K_UPDATE` turns off the AMM's automatic `k` (liquidity depth) adjustments for that market. */
 var MarketConfigFlag;
 (function (MarketConfigFlag) {
     MarketConfigFlag[MarketConfigFlag["DISABLE_FORMULAIC_K_UPDATE"] = 1] = "DISABLE_FORMULAIC_K_UPDATE";
 })(MarketConfigFlag || (exports.MarketConfigFlag = MarketConfigFlag = {}));
+/** Margin-mode enum-class. Currently only `DEFAULT` (cross margin) exists; isolated margin is expressed per-position via `PositionFlag.IsolatedPosition`, not a distinct margin mode. */
 class MarginMode {
 }
 exports.MarginMode = MarginMode;
 MarginMode.DEFAULT = { default: {} };
+/**
+ * Mirrors the on-chain `ContractType` on `PerpMarketAccount.contractType`. Only `PERPETUAL` is
+ * live; `DEPRECATED_FUTURE` and `DEPRECATED_PREDICTION` are inert stubs kept for IDL/discriminant
+ * compatibility and are never assigned to a market.
+ */
 class ContractType {
 }
 exports.ContractType = ContractType;
 ContractType.PERPETUAL = { perpetual: {} };
-ContractType.FUTURE = { future: {} };
+ContractType.DEPRECATED_FUTURE = { deprecatedFuture: {} };
+ContractType.DEPRECATED_PREDICTION = { deprecatedPrediction: {} };
+/**
+ * A perp market's speculativeness tier (`PerpMarketAccount.contractTier`). Determines how much of
+ * the insurance fund the market may draw on during bankruptcy and the order markets are
+ * liquidated in — `ISOLATED` markets receive no shared insurance coverage; `A` is safest.
+ */
 class ContractTier {
 }
 exports.ContractTier = ContractTier;
@@ -104,6 +151,12 @@ ContractTier.C = { c: {} };
 ContractTier.SPECULATIVE = { speculative: {} };
 ContractTier.HIGHLY_SPECULATIVE = { highlySpeculative: {} };
 ContractTier.ISOLATED = { isolated: {} };
+/**
+ * A spot market's collateral-safety tier (`SpotMarketAccount.assetTier`). Determines whether a
+ * deposit can be used as cross-margin collateral alongside other assets: `COLLATERAL` may back
+ * any borrow, `PROTECTED`/`CROSS` have restrictions on being borrowed against, `ISOLATED` deposits
+ * can't be combined with other borrows, and `UNLISTED` deposits count for nothing.
+ */
 class AssetTier {
 }
 exports.AssetTier = AssetTier;
@@ -112,31 +165,43 @@ AssetTier.PROTECTED = { protected: {} };
 AssetTier.CROSS = { cross: {} };
 AssetTier.ISOLATED = { isolated: {} };
 AssetTier.UNLISTED = { unlisted: {} };
+/** Bitmask mirror of `SpotMarketAccount.tokenProgramFlag`, recording which SPL token-program features the market's mint uses. */
 var TokenProgramFlag;
 (function (TokenProgramFlag) {
     TokenProgramFlag[TokenProgramFlag["Token2022"] = 1] = "Token2022";
     TokenProgramFlag[TokenProgramFlag["TransferHook"] = 2] = "TransferHook";
 })(TokenProgramFlag || (exports.TokenProgramFlag = TokenProgramFlag = {}));
+/** Direction of an LP-pool constituent swap (add liquidity vs remove liquidity). */
 class SwapDirection {
 }
 exports.SwapDirection = SwapDirection;
 SwapDirection.ADD = { add: {} };
 SwapDirection.REMOVE = { remove: {} };
+/** Whether a `SpotPosition`/`PoolBalance`'s scaled balance represents a deposit (positive token claim) or a borrow (liability). */
 class SpotBalanceType {
 }
 exports.SpotBalanceType = SpotBalanceType;
 SpotBalanceType.DEPOSIT = { deposit: {} };
 SpotBalanceType.BORROW = { borrow: {} };
+/** Long (bid) or short (ask) side of a perp/spot order or position. */
 class PositionDirection {
 }
 exports.PositionDirection = PositionDirection;
 PositionDirection.LONG = { long: {} };
 PositionDirection.SHORT = { short: {} };
+/** Direction of a `DepositRecord` / `LPBorrowLendDepositRecord` event: funds entering or leaving the protocol. */
 class DepositDirection {
 }
 exports.DepositDirection = DepositDirection;
 DepositDirection.DEPOSIT = { deposit: {} };
 DepositDirection.WITHDRAW = { withdraw: {} };
+/**
+ * Mirrors the on-chain `OracleSource` enum, identifying which oracle provider/decoder to use for
+ * a market's `oracle` account. The `1K`/`1M` suffixes scale the raw feed price by 1e3/1e6 (used
+ * for low-priced assets like BONK). `DEPRECATED_SWITCHBOARD`/`DEPRECATED_SWITCHBOARD_ON_DEMAND`
+ * are inert stubs — using them returns `InvalidOracle`. `Prelaunch` reads from a `PrelaunchOracle`
+ * account instead of an external feed.
+ */
 class OracleSource {
 }
 exports.OracleSource = OracleSource;
@@ -146,16 +211,25 @@ OracleSource.PYTH_1M = { pyth1M: {} };
 OracleSource.PYTH_PULL = { pythPull: {} };
 OracleSource.PYTH_1K_PULL = { pyth1KPull: {} };
 OracleSource.PYTH_1M_PULL = { pyth1MPull: {} };
-OracleSource.SWITCHBOARD = { switchboard: {} };
+OracleSource.DEPRECATED_SWITCHBOARD = { deprecatedSwitchboard: {} };
 OracleSource.QUOTE_ASSET = { quoteAsset: {} };
 OracleSource.PYTH_STABLE_COIN = { pythStableCoin: {} };
 OracleSource.PYTH_STABLE_COIN_PULL = { pythStableCoinPull: {} };
 OracleSource.Prelaunch = { prelaunch: {} };
-OracleSource.SWITCHBOARD_ON_DEMAND = { switchboardOnDemand: {} };
+OracleSource.DEPRECATED_SWITCHBOARD_ON_DEMAND = {
+    deprecatedSwitchboardOnDemand: {},
+};
 OracleSource.PYTH_LAZER = { pythLazer: {} };
 OracleSource.PYTH_LAZER_1K = { pythLazer1K: {} };
 OracleSource.PYTH_LAZER_1M = { pythLazer1M: {} };
 OracleSource.PYTH_LAZER_STABLE_COIN = { pythLazerStableCoin: {} };
+/**
+ * Stable SDK-internal numeric encoding of `OracleSource`, used only for oracle-id string
+ * round-tripping (`getOracleSourceNum` ↔ `getOracleSourceFromNum` in `oracles/oracleId.ts`).
+ * NOTE: these numbers are **not** the on-chain Borsh discriminants and are **not** in the
+ * on-chain enum's declaration order — do not use them for raw memcmp filters against chain
+ * data. They only need to be self-consistent within the SDK.
+ */
 class OracleSourceNum {
 }
 exports.OracleSourceNum = OracleSourceNum;
@@ -165,16 +239,17 @@ OracleSourceNum.PYTH_1M = 2;
 OracleSourceNum.PYTH_PULL = 3;
 OracleSourceNum.PYTH_1K_PULL = 4;
 OracleSourceNum.PYTH_1M_PULL = 5;
-OracleSourceNum.SWITCHBOARD = 6;
+OracleSourceNum.DEPRECATED_SWITCHBOARD = 6;
 OracleSourceNum.QUOTE_ASSET = 7;
 OracleSourceNum.PYTH_STABLE_COIN = 8;
 OracleSourceNum.PYTH_STABLE_COIN_PULL = 9;
 OracleSourceNum.PRELAUNCH = 10;
-OracleSourceNum.SWITCHBOARD_ON_DEMAND = 11;
+OracleSourceNum.DEPRECATED_SWITCHBOARD_ON_DEMAND = 11;
 OracleSourceNum.PYTH_LAZER = 12;
 OracleSourceNum.PYTH_LAZER_1K = 13;
 OracleSourceNum.PYTH_LAZER_1M = 14;
 OracleSourceNum.PYTH_LAZER_STABLE_COIN = 15;
+/** The order's price-determination mechanism: `LIMIT`/`TRIGGER_LIMIT` use `Order.price`, `MARKET`/`TRIGGER_MARKET` fill at the best available price (subject to any auction), and `ORACLE` prices relative to the oracle via `Order.oraclePriceOffset`. `TRIGGER_*` variants only become active once `Order.triggerPrice` is crossed. */
 class OrderType {
 }
 exports.OrderType = OrderType;
@@ -183,11 +258,13 @@ OrderType.TRIGGER_MARKET = { triggerMarket: {} };
 OrderType.TRIGGER_LIMIT = { triggerLimit: {} };
 OrderType.MARKET = { market: {} };
 OrderType.ORACLE = { oracle: {} };
+/** Whether an order/position/market is on the spot or perp side of the protocol. */
 class MarketType {
 }
 exports.MarketType = MarketType;
 MarketType.SPOT = { spot: {} };
 MarketType.PERP = { perp: {} };
+/** Lifecycle state of an `Order`: `INIT` (unused slot), `OPEN` (live, may still be filled), `FILLED` (fully filled), `CANCELED`. */
 class OrderStatus {
 }
 exports.OrderStatus = OrderStatus;
@@ -195,6 +272,18 @@ OrderStatus.INIT = { init: {} };
 OrderStatus.OPEN = { open: {} };
 OrderStatus.FILLED = { filled: {} };
 OrderStatus.CANCELED = { canceled: {} };
+/**
+ * Bitmask mirror of `Order.bitFlags` / `OrderParams.bitFlags`.
+ * - `SignedMessage`: order originated from a signed off-chain message (swift/signed-msg flow).
+ * - `OracleTriggerMarket`: a `TriggerMarket` order whose trigger condition is evaluated against
+ *   the oracle price rather than the last mark/fill price.
+ * - `SafeTriggerOrder`: exempts the order from the AMM's low-risk-fill slot-delay gate — it may
+ *   be immediately filled by the AMM once triggered, or when the order itself is a liquidation.
+ * - `NewTriggerReduceOnly`: for a reduce-only order that has triggered, suppresses updating the
+ *   user's `openBids`/`openAsks` counters (avoids double-counting margin already reserved).
+ * - `HasBuilder`: the order carries a `builderIdx`/`builderFeeTenthBps` builder-code fee split.
+ * - `IsIsolatedPosition`: the order trades against/opens an isolated-margin position rather than cross margin.
+ */
 class OrderBitFlag {
 }
 exports.OrderBitFlag = OrderBitFlag;
@@ -202,6 +291,9 @@ OrderBitFlag.SignedMessage = 1;
 OrderBitFlag.OracleTriggerMarket = 2;
 OrderBitFlag.SafeTriggerOrder = 4;
 OrderBitFlag.NewTriggerReduceOnly = 8;
+OrderBitFlag.HasBuilder = 16;
+OrderBitFlag.IsIsolatedPosition = 32;
+/** The kind of action an `OrderActionRecord` event describes. */
 class OrderAction {
 }
 exports.OrderAction = OrderAction;
@@ -210,6 +302,7 @@ OrderAction.CANCEL = { cancel: {} };
 OrderAction.EXPIRE = { expire: {} };
 OrderAction.FILL = { fill: {} };
 OrderAction.TRIGGER = { trigger: {} };
+/** Why an `OrderActionRecord` event happened — the specific reason a fill/cancel/expire/trigger occurred (e.g. which fulfillment method filled the order, or why it was rejected/canceled). */
 class OrderActionExplanation {
 }
 exports.OrderActionExplanation = OrderActionExplanation;
@@ -262,6 +355,7 @@ OrderActionExplanation.DERISK_LP = {
 OrderActionExplanation.TRANSFER_PERP_POSITION = {
     transferPerpPosition: {},
 };
+/** Trigger-order condition on `Order.triggerCondition`. `ABOVE`/`BELOW` are the pending (not-yet-triggered) states; `TRIGGERED_ABOVE`/`TRIGGERED_BELOW` record that the condition has already fired, so the order is now live for filling. */
 class OrderTriggerCondition {
 }
 exports.OrderTriggerCondition = OrderTriggerCondition;
@@ -269,6 +363,7 @@ OrderTriggerCondition.ABOVE = { above: {} };
 OrderTriggerCondition.BELOW = { below: {} };
 OrderTriggerCondition.TRIGGERED_ABOVE = { triggeredAbove: {} }; // above condition has been triggered
 OrderTriggerCondition.TRIGGERED_BELOW = { triggeredBelow: {} }; // below condition has been triggered
+/** Why a `DepositRecord` event happened: a direct transfer, a borrow being drawn, a borrow being repaid, or a protocol reward credit. */
 class DepositExplanation {
 }
 exports.DepositExplanation = DepositExplanation;
@@ -277,11 +372,13 @@ DepositExplanation.TRANSFER = { transfer: {} };
 DepositExplanation.BORROW = { borrow: {} };
 DepositExplanation.REPAY_BORROW = { repayBorrow: {} };
 DepositExplanation.REWARD = { reward: {} };
+/** Why a `SettlePnlRecord` event happened: a normal settle, or settlement of an expired-market position at the market's `expiryPrice`. */
 class SettlePnlExplanation {
 }
 exports.SettlePnlExplanation = SettlePnlExplanation;
 SettlePnlExplanation.NONE = { none: {} };
 SettlePnlExplanation.EXPIRED_POSITION = { expiredPosition: {} };
+/** The insurance-fund-stake action an `InsuranceFundStakeRecord` event describes. */
 class StakeAction {
 }
 exports.StakeAction = StakeAction;
@@ -291,31 +388,37 @@ StakeAction.UNSTAKE_CANCEL_REQUEST = { unstakeCancelRequest: {} };
 StakeAction.UNSTAKE = { unstake: {} };
 StakeAction.UNSTAKE_TRANSFER = { unstakeTransfer: {} };
 StakeAction.STAKE_TRANSFER = { stakeTransfer: {} };
+/** Fill/settle-PnL strictness passed to settle-PnL instructions: `TRY_SETTLE` settles as much as is safe and never fails outright, `MUST_SETTLE` requires the full requested settlement to succeed or the instruction reverts. */
 class SettlePnlMode {
 }
 exports.SettlePnlMode = SettlePnlMode;
 SettlePnlMode.TRY_SETTLE = { trySettle: {} };
 SettlePnlMode.MUST_SETTLE = { mustSettle: {} };
+/** Returns true if the Anchor enum-class instance `object` (shape `{ [variant]: {} }`) is the given variant key. */
 function isVariant(object, type) {
     return Object.prototype.hasOwnProperty.call(object, type);
 }
 exports.isVariant = isVariant;
+/** Returns true if the Anchor enum-class instance `object` matches any of the given variant keys. */
 function isOneOfVariant(object, types) {
     return types.reduce((result, type) => {
         return result || Object.prototype.hasOwnProperty.call(object, type);
     }, false);
 }
 exports.isOneOfVariant = isOneOfVariant;
+/** Returns the sole variant key of an Anchor enum-class instance (shape `{ [variant]: {} }`), e.g. `"long"` for `PositionDirection.LONG`. */
 function getVariant(object) {
     return Object.keys(object)[0];
 }
 exports.getVariant = getVariant;
+/** Aggressor side of a trade for candle/trade-history purposes. `None` is used when a fill has no clear taker side (e.g. some liquidations). */
 var TradeSide;
 (function (TradeSide) {
     TradeSide[TradeSide["None"] = 0] = "None";
     TradeSide[TradeSide["Buy"] = 1] = "Buy";
     TradeSide[TradeSide["Sell"] = 2] = "Sell";
 })(TradeSide || (exports.TradeSide = TradeSide = {}));
+/** Which liquidation path a `LiquidationRecord` describes; selects which of the record's sub-record fields is populated. */
 class LiquidationType {
 }
 exports.LiquidationType = LiquidationType;
@@ -335,10 +438,12 @@ LiquidationType.SPOT_BANKRUPTCY = {
 LiquidationType.LIQUIDATE_SPOT = {
     liquidateSpot: {},
 };
+/** Bitmask mirror of `LiquidationRecord.bitFlags`. `IsolatedPosition` marks that the liquidation acted on an isolated-margin position rather than the user's cross-margin account. */
 class LiquidationBitFlag {
 }
 exports.LiquidationBitFlag = LiquidationBitFlag;
 LiquidationBitFlag.IsolatedPosition = 1;
+/** Whether/how an order must avoid taking liquidity. `MUST_POST_ONLY` reverts the transaction if the order would cross; `TRY_POST_ONLY` silently drops the order instead of reverting; `SLIDE` adjusts the price to make it post-only. */
 class PostOnlyParams {
 }
 exports.PostOnlyParams = PostOnlyParams;
@@ -355,21 +460,25 @@ exports.SizeDistribution = SizeDistribution;
 SizeDistribution.FLAT = { flat: {} }; // Equal size for all orders
 SizeDistribution.ASCENDING = { ascending: {} }; // Smallest at start price, largest at end price
 SizeDistribution.DESCENDING = { descending: {} }; // Largest at start price, smallest at end price
+/** Bitmask mirror of `OrderParams.bitFlags` (the instruction-parameter flag set; distinct from the on-chain `Order.bitFlags` set of `OrderBitFlag`). */
 class OrderParamsBitFlag {
 }
 exports.OrderParamsBitFlag = OrderParamsBitFlag;
 OrderParamsBitFlag.ImmediateOrCancel = 1;
+/** Bitmask mirror of `PerpPosition.positionFlag`. Multiple bits can be set (e.g. an isolated position mid-liquidation has both `IsolatedPosition` and `BeingLiquidated`). */
 class PositionFlag {
 }
 exports.PositionFlag = PositionFlag;
 PositionFlag.IsolatedPosition = 1;
 PositionFlag.BeingLiquidated = 2;
 PositionFlag.Bankruptcy = 4;
+/** Bitmask passed as `ModifyOrderParams.policy` (combine with `|`). `MustModify`: fail the instruction instead of silently no-op'ing if the target order id can't be found. `ExcludePreviousFill`: when a new `baseAssetAmount` is given, treat it as the new *remaining* size — the already-filled amount is subtracted off it (rather than replacing the order's total size outright). */
 var ModifyOrderPolicy;
 (function (ModifyOrderPolicy) {
     ModifyOrderPolicy[ModifyOrderPolicy["MustModify"] = 1] = "MustModify";
     ModifyOrderPolicy[ModifyOrderPolicy["ExcludePreviousFill"] = 2] = "ExcludePreviousFill";
 })(ModifyOrderPolicy || (exports.ModifyOrderPolicy = ModifyOrderPolicy = {}));
+/** Base `OrderParams` (a market perp long of size 0) that SDK order-building helpers spread their caller-supplied `OptionalOrderParams` over. */
 exports.DefaultOrderParams = {
     orderType: OrderType.MARKET,
     marketType: MarketType.PERP,
@@ -391,6 +500,7 @@ exports.DefaultOrderParams = {
     builderIdx: null,
     builderFeeTenthBps: null,
 };
+/** Bitmask mirror of `UserStatsAccount.referrerStatus`. */
 var ReferrerStatus;
 (function (ReferrerStatus) {
     ReferrerStatus[ReferrerStatus["IsReferrer"] = 1] = "IsReferrer";
@@ -398,16 +508,19 @@ var ReferrerStatus;
     /** set when the user's RevenueShareEscrow was initialized with a referrer */
     ReferrerStatus[ReferrerStatus["BuilderReferral"] = 4] = "BuilderReferral";
 })(ReferrerStatus || (exports.ReferrerStatus = ReferrerStatus = {}));
+/** Which fill outcome counts as "success" for a `placeAndTake*` instruction's on-chain success check. */
 var PlaceAndTakeOrderSuccessCondition;
 (function (PlaceAndTakeOrderSuccessCondition) {
     PlaceAndTakeOrderSuccessCondition[PlaceAndTakeOrderSuccessCondition["PartialFill"] = 1] = "PartialFill";
     PlaceAndTakeOrderSuccessCondition[PlaceAndTakeOrderSuccessCondition["FullFill"] = 2] = "FullFill";
 })(PlaceAndTakeOrderSuccessCondition || (exports.PlaceAndTakeOrderSuccessCondition = PlaceAndTakeOrderSuccessCondition = {}));
+/** For `beginSwap`/`endSwap`, whether the reduce-only constraint applies to the `In` (source) or `Out` (destination) side of the swap. */
 class SwapReduceOnly {
 }
 exports.SwapReduceOnly = SwapReduceOnly;
 SwapReduceOnly.In = { in: {} };
 SwapReduceOnly.Out = { out: {} };
+/** Result of the oracle validity check (`is_oracle_valid_for_action` and friends). Only `Valid` (7) permits using the price; every other variant identifies the specific failure so callers can gate accordingly (stale-for-margin still permits AMM-only actions, etc.). */
 var OracleValidity;
 (function (OracleValidity) {
     OracleValidity[OracleValidity["NonPositive"] = 0] = "NonPositive";
@@ -419,18 +532,22 @@ var OracleValidity;
     OracleValidity[OracleValidity["isStaleForAmmImmediate"] = 6] = "isStaleForAmmImmediate";
     OracleValidity[OracleValidity["Valid"] = 7] = "Valid";
 })(OracleValidity || (exports.OracleValidity = OracleValidity = {}));
+/** Lifecycle status of an LP-pool `ConstituentAccount`. */
 var ConstituentStatus;
 (function (ConstituentStatus) {
     ConstituentStatus[ConstituentStatus["ACTIVE"] = 0] = "ACTIVE";
+    /** may only shrink toward its target weight, not grow */
     ConstituentStatus[ConstituentStatus["REDUCE_ONLY"] = 1] = "REDUCE_ONLY";
     ConstituentStatus[ConstituentStatus["DECOMMISSIONED"] = 2] = "DECOMMISSIONED";
 })(ConstituentStatus || (exports.ConstituentStatus = ConstituentStatus = {}));
+/** Bitmask mirror of `ConstituentAccount.pausedOperations`, gating which LP-pool operations a constituent allows. */
 var ConstituentLpOperation;
 (function (ConstituentLpOperation) {
     ConstituentLpOperation[ConstituentLpOperation["Swap"] = 1] = "Swap";
     ConstituentLpOperation[ConstituentLpOperation["Deposit"] = 2] = "Deposit";
     ConstituentLpOperation[ConstituentLpOperation["Withdraw"] = 4] = "Withdraw";
 })(ConstituentLpOperation || (exports.ConstituentLpOperation = ConstituentLpOperation = {}));
+/** Direction of an admin `transferFeeAndPnlPool` action, moving funds between a perp market's protocol fee pool and its pnl pool. */
 class TransferFeeAndPnlPoolDirection {
 }
 exports.TransferFeeAndPnlPoolDirection = TransferFeeAndPnlPoolDirection;