@drift-labs/sdk 2.28.0-beta.3 → 2.28.0-beta.5

package/lib/idl/drift.json

@@ -1,5 +1,5 @@
 {
-    "version": "2.28.0-beta.3",
+    "version": "2.28.0-beta.5",
     "name": "drift",
     "instructions": [
         {
@@ -4285,22 +4285,35 @@
                 "fields": [
                     {
                         "name": "pubkey",
+                        "docs": [
+                            "The perp market's address. It is a pda of the market index"
+                        ],
                         "type": "publicKey"
                     },
                     {
                         "name": "amm",
+                        "docs": [
+                            "The automated market maker"
+                        ],
                         "type": {
                             "defined": "AMM"
                         }
                     },
                     {
                         "name": "pnlPool",
+                        "docs": [
+                            "The market's pnl pool. When users settle negative pnl, the balance increases.",
+                            "When users settle positive pnl, the balance decreases. Can not go negative."
+                        ],
                         "type": {
                             "defined": "PoolBalance"
                         }
                     },
                     {
                         "name": "name",
+                        "docs": [
+                            "Encoded display name for the perp market e.g. SOL-PERP"
+                        ],
                         "type": {
                             "array": [
                                 "u8",
@@ -4310,72 +4323,138 @@
                     },
                     {
                         "name": "insuranceClaim",
+                        "docs": [
+                            "The perp market's claim on the insurance fund"
+                        ],
                         "type": {
                             "defined": "InsuranceClaim"
                         }
                     },
                     {
                         "name": "unrealizedPnlMaxImbalance",
+                        "docs": [
+                            "The max pnl imbalance before positive pnl asset weight is discounted",
+                            "pnl imbalance is the difference between long and short pnl. When it's greater than 0,",
+                            "the amm has negative pnl and the initial asset weight for positive pnl is discounted",
+                            "precision = QUOTE_PRECISION"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "expiryTs",
+                        "docs": [
+                            "The ts when the market will be expired. Only set if market is in reduce only mode"
+                        ],
                         "type": "i64"
                     },
                     {
                         "name": "expiryPrice",
+                        "docs": [
+                            "The price at which positions will be settled. Only set if market is expired",
+                            "precision = PRICE_PRECISION"
+                        ],
                         "type": "i64"
                     },
                     {
                         "name": "nextFillRecordId",
+                        "docs": [
+                            "Every trade has a fill record id. This is the next id to be used"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "nextFundingRateRecordId",
+                        "docs": [
+                            "Every funding rate update has a record id. This is the next id to be used"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "nextCurveRecordId",
+                        "docs": [
+                            "Every amm k updated has a record id. This is the next id to be used"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "imfFactor",
+                        "docs": [
+                            "The initial margin fraction factor. Used to increase margin ratio for large positions",
+                            "precision: MARGIN_PRECISION"
+                        ],
                         "type": "u32"
                     },
                     {
                         "name": "unrealizedPnlImfFactor",
+                        "docs": [
+                            "The imf factor for unrealized pnl. Used to discount asset weight for large positive pnl",
+                            "precision: MARGIN_PRECISION"
+                        ],
                         "type": "u32"
                     },
                     {
                         "name": "liquidatorFee",
+                        "docs": [
+                            "The fee the liquidator is paid for taking over perp position",
+                            "precision: LIQUIDATOR_FEE_PRECISION"
+                        ],
                         "type": "u32"
                     },
                     {
                         "name": "ifLiquidationFee",
+                        "docs": [
+                            "The fee the insurance fund receives from liquidation",
+                            "precision: LIQUIDATOR_FEE_PRECISION"
+                        ],
                         "type": "u32"
                     },
                     {
                         "name": "marginRatioInitial",
+                        "docs": [
+                            "The margin ratio which determines how much collateral is required to open a position",
+                            "e.g. margin ratio of .1 means a user must have $100 of total collateral to open a $1000 position",
+                            "precision: MARGIN_PRECISION"
+                        ],
                         "type": "u32"
                     },
                     {
                         "name": "marginRatioMaintenance",
+                        "docs": [
+                            "The margin ratio which determines when a user will be liquidated",
+                            "e.g. margin ratio of .05 means a user must have $50 of total collateral to maintain a $1000 position",
+                            "else they will be liquidated",
+                            "precision: MARGIN_PRECISION"
+                        ],
                         "type": "u32"
                     },
                     {
                         "name": "unrealizedPnlInitialAssetWeight",
+                        "docs": [
+                            "The initial asset weight for positive pnl. Negative pnl always has an asset weight of 1",
+                            "precision: SPOT_WEIGHT_PRECISION"
+                        ],
                         "type": "u32"
                     },
                     {
                         "name": "unrealizedPnlMaintenanceAssetWeight",
+                        "docs": [
+                            "The maintenance asset weight for positive pnl. Negative pnl always has an asset weight of 1",
+                            "precision: SPOT_WEIGHT_PRECISION"
+                        ],
                         "type": "u32"
                     },
                     {
                         "name": "numberOfUsersWithBase",
+                        "docs": [
+                            "number of users in a position (base)"
+                        ],
                         "type": "u32"
                     },
                     {
                         "name": "numberOfUsers",
+                        "docs": [
+                            "number of users in a position (pnl) or pnl (quote)"
+                        ],
                         "type": "u32"
                     },
                     {
@@ -4384,18 +4463,29 @@
                     },
                     {
                         "name": "status",
+                        "docs": [
+                            "Whether a market is active, reduce only, expired, etc",
+                            "Affects whether users can open/close positions"
+                        ],
                         "type": {
                             "defined": "MarketStatus"
                         }
                     },
                     {
                         "name": "contractType",
+                        "docs": [
+                            "Currently only Perpetual markets are supported"
+                        ],
                         "type": {
                             "defined": "ContractType"
                         }
                     },
                     {
                         "name": "contractTier",
+                        "docs": [
+                            "The contract tier determines how much insurance a market can receive, with more speculative markets receiving less insurance",
+                            "It also influences the order perp markets can be liquidated, with less speculative markets being liquidated first"
+                        ],
                         "type": {
                             "defined": "ContractTier"
                         }
@@ -4406,6 +4496,9 @@
                     },
                     {
                         "name": "quoteSpotMarketIndex",
+                        "docs": [
+                            "The spot market that pnl is settled in"
+                        ],
                         "type": "u16"
                     },
                     {
@@ -4427,22 +4520,38 @@
                 "fields": [
                     {
                         "name": "pubkey",
+                        "docs": [
+                            "The address of the spot market. It is a pda of the market index"
+                        ],
                         "type": "publicKey"
                     },
                     {
                         "name": "oracle",
+                        "docs": [
+                            "The oracle used to price the markets deposits/borrows"
+                        ],
                         "type": "publicKey"
                     },
                     {
                         "name": "mint",
+                        "docs": [
+                            "The token mint of the market"
+                        ],
                         "type": "publicKey"
                     },
                     {
                         "name": "vault",
+                        "docs": [
+                            "The vault used to store the market's deposits",
+                            "The amount in the vault should be equal to or greater than deposits - borrows"
+                        ],
                         "type": "publicKey"
                     },
                     {
                         "name": "name",
+                        "docs": [
+                            "The encoded display name fo the market e.g. SOL"
+                        ],
                         "type": {
                             "array": [
                                 "u8",
@@ -4464,148 +4573,294 @@
                     },
                     {
                         "name": "revenuePool",
+                        "docs": [
+                            "Revenue the protocol has collected in this markets token",
+                            "e.g. for SOL-PERP, funds can be settled in usdc and will flow into the USDC revenue pool"
+                        ],
                         "type": {
                             "defined": "PoolBalance"
                         }
                     },
                     {
                         "name": "spotFeePool",
+                        "docs": [
+                            "The fees collected from swaps between this market and the quote market",
+                            "Is settled to the quote markets revenue pool"
+                        ],
                         "type": {
                             "defined": "PoolBalance"
                         }
                     },
                     {
                         "name": "insuranceFund",
+                        "docs": [
+                            "Details on the insurance fund covering bankruptcies in this markets token",
+                            "Covers bankruptcies for borrows with this markets token and perps settling in this markets token"
+                        ],
                         "type": {
                             "defined": "InsuranceFund"
                         }
                     },
                     {
                         "name": "totalSpotFee",
+                        "docs": [
+                            "The total spot fees collected for this market",
+                            "precision: QUOTE_PRECISION"
+                        ],
                         "type": "u128"
                     },
                     {
                         "name": "depositBalance",
+                        "docs": [
+                            "The sum of the scaled balances for deposits across users and pool balances",
+                            "To convert to the deposit token amount, multiply by the cumulative deposit interest",
+                            "precision: SPOT_BALANCE_PRECISION"
+                        ],
                         "type": "u128"
                     },
                     {
                         "name": "borrowBalance",
+                        "docs": [
+                            "The sum of the scaled balances for borrows across users and pool balances",
+                            "To convert to the borrow token amount, multiply by the cumulative borrow interest",
+                            "precision: SPOT_BALANCE_PRECISION"
+                        ],
                         "type": "u128"
                     },
                     {
                         "name": "cumulativeDepositInterest",
+                        "docs": [
+                            "The cumulative interest earned by depositors",
+                            "Used to calculate the deposit token amount from the deposit balance",
+                            "precision: SPOT_CUMULATIVE_INTEREST_PRECISION"
+                        ],
                         "type": "u128"
                     },
                     {
                         "name": "cumulativeBorrowInterest",
+                        "docs": [
+                            "The cumulative interest earned by borrowers",
+                            "Used to calculate the borrow token amount from the borrow balance",
+                            "precision: SPOT_CUMULATIVE_INTEREST_PRECISION"
+                        ],
                         "type": "u128"
                     },
                     {
                         "name": "totalSocialLoss",
+                        "docs": [
+                            "The total socialized loss from borrows, in the mint's token",
+                            "precision: token mint precision"
+                        ],
                         "type": "u128"
                     },
                     {
                         "name": "totalQuoteSocialLoss",
+                        "docs": [
+                            "The total socialized loss from borrows, in the quote market's token",
+                            "preicision: QUOTE_PRECISION"
+                        ],
                         "type": "u128"
                     },
                     {
                         "name": "withdrawGuardThreshold",
+                        "docs": [
+                            "no withdraw limits/guards when deposits below this threshold",
+                            "precision: token mint precision"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "maxTokenDeposits",
+                        "docs": [
+                            "The max amount of token deposits in this market",
+                            "0 if there is no limit",
+                            "precision: token mint precision"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "depositTokenTwap",
+                        "docs": [
+                            "24hr average of deposit token amount",
+                            "precision: token mint precision"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "borrowTokenTwap",
+                        "docs": [
+                            "24hr average of borrow token amount",
+                            "precision: token mint precision"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "utilizationTwap",
+                        "docs": [
+                            "24hr average of utilization",
+                            "which is borrow amount over token amount",
+                            "precision: SPOT_UTILIZATION_PRECISION"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "lastInterestTs",
+                        "docs": [
+                            "Last time the cumulative deposit and borrow interest was updated"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "lastTwapTs",
+                        "docs": [
+                            "Last time the deposit/borrow/utilization averages were updated"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "expiryTs",
+                        "docs": [
+                            "The time the market is set to expire. Only set if market is in reduce only mode"
+                        ],
                         "type": "i64"
                     },
                     {
                         "name": "orderStepSize",
+                        "docs": [
+                            "Spot orders must be a multiple of the step size",
+                            "precision: token mint precision"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "orderTickSize",
+                        "docs": [
+                            "Spot orders must be a multiple of the tick size",
+                            "precision: QUOTE_PRECISION"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "minOrderSize",
+                        "docs": [
+                            "The minimum order size",
+                            "precision: token mint precision"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "maxPositionSize",
+                        "docs": [
+                            "The maximum spot position size",
+                            "if the limit is 0, there is no limit",
+                            "precision: token mint precision"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "nextFillRecordId",
+                        "docs": [
+                            "Every spot trade has a fill record id. This is the next id to use"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "nextDepositRecordId",
+                        "docs": [
+                            "Every deposit has a deposit record id. This is the next id to use"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "initialAssetWeight",
+                        "docs": [
+                            "The initial asset weight used to calculate a deposits contribution to a users initial total collateral",
+                            "e.g. if the asset weight is .8, $100 of deposits contributes $80 to the users initial total collateral",
+                            "precision: SPOT_WEIGHT_PRECISION"
+                        ],
                         "type": "u32"
                     },
                     {
                         "name": "maintenanceAssetWeight",
+                        "docs": [
+                            "The maintenance asset weight used to calculate a deposits contribution to a users maintenance total collateral",
+                            "e.g. if the asset weight is .9, $100 of deposits contributes $90 to the users maintenance total collateral",
+                            "precision: SPOT_WEIGHT_PRECISION"
+                        ],
                         "type": "u32"
                     },
                     {
                         "name": "initialLiabilityWeight",
+                        "docs": [
+                            "The initial liability weight used to calculate a borrows contribution to a users initial margin requirement",
+                            "e.g. if the liability weight is .9, $100 of borrows contributes $90 to the users initial margin requirement",
+                            "precision: SPOT_WEIGHT_PRECISION"
+                        ],
                         "type": "u32"
                     },
                     {
                         "name": "maintenanceLiabilityWeight",
+                        "docs": [
+                            "The maintenance liability weight used to calculate a borrows contribution to a users maintenance margin requirement",
+                            "e.g. if the liability weight is .8, $100 of borrows contributes $80 to the users maintenance margin requirement",
+                            "precision: SPOT_WEIGHT_PRECISION"
+                        ],
                         "type": "u32"
                     },
                     {
                         "name": "imfFactor",
+                        "docs": [
+                            "The initial margin fraction factor. Used to increase liability weight/decrease asset weight for large positions",
+                            "precision: MARGIN_PRECISION"
+                        ],
                         "type": "u32"
                     },
                     {
                         "name": "liquidatorFee",
+                        "docs": [
+                            "The fee the liquidator is paid for taking over borrow/deposit",
+                            "precision: LIQUIDATOR_FEE_PRECISION"
+                        ],
                         "type": "u32"
                     },
                     {
                         "name": "ifLiquidationFee",
+                        "docs": [
+                            "The fee the insurance fund receives from liquidation",
+                            "precision: LIQUIDATOR_FEE_PRECISION"
+                        ],
                         "type": "u32"
                     },
                     {
                         "name": "optimalUtilization",
+                        "docs": [
+                            "The optimal utilization rate for this market.",
+                            "Used to determine the markets borrow rate",
+                            "precision: SPOT_UTILIZATION_PRECISION"
+                        ],
                         "type": "u32"
                     },
                     {
                         "name": "optimalBorrowRate",
+                        "docs": [
+                            "The borrow rate for this market when the market has optimal utilization",
+                            "precision: SPOT_RATE_PRECISION"
+                        ],
                         "type": "u32"
                     },
                     {
                         "name": "maxBorrowRate",
+                        "docs": [
+                            "The borrow rate for this market when the market has 1000 utilization",
+                            "precision: SPOT_RATE_PRECISION"
+                        ],
                         "type": "u32"
                     },
                     {
                         "name": "decimals",
+                        "docs": [
+                            "The market's token mint's decimals. To from decimals to a precision, 10^decimals"
+                        ],
                         "type": "u32"
                     },
                     {
@@ -4614,6 +4869,9 @@
                     },
                     {
                         "name": "ordersEnabled",
+                        "docs": [
+                            "Whether or not spot trading is enabled"
+                        ],
                         "type": "bool"
                     },
                     {
@@ -4630,6 +4888,9 @@
                     },
                     {
                         "name": "assetTier",
+                        "docs": [
+                            "The asset tier affects how a deposit can be used as collateral and the priority for a borrow being liquidated"
+                        ],
                         "type": {
                             "defined": "AssetTier"
                         }
@@ -4764,14 +5025,23 @@
                 "fields": [
                     {
                         "name": "authority",
+                        "docs": [
+                            "The owner/authority of the account"
+                        ],
                         "type": "publicKey"
                     },
                     {
                         "name": "delegate",
+                        "docs": [
+                            "An addresses that can control the account on the authority's behalf. Has limited power, cant withdraw"
+                        ],
                         "type": "publicKey"
                     },
                     {
                         "name": "name",
+                        "docs": [
+                            "Encoded display name e.g. \"toly\""
+                        ],
                         "type": {
                             "array": [
                                 "u8",
@@ -4781,6 +5051,9 @@
                     },
                     {
                         "name": "spotPositions",
+                        "docs": [
+                            "The user's spot positions"
+                        ],
                         "type": {
                             "array": [
                                 {
@@ -4792,6 +5065,9 @@
                     },
                     {
                         "name": "perpPositions",
+                        "docs": [
+                            "The user's perp positions"
+                        ],
                         "type": {
                             "array": [
                                 {
@@ -4803,6 +5079,9 @@
                     },
                     {
                         "name": "orders",
+                        "docs": [
+                            "The user's orders"
+                        ],
                         "type": {
                             "array": [
                                 {
@@ -4814,68 +5093,125 @@
                     },
                     {
                         "name": "lastAddPerpLpSharesTs",
+                        "docs": [
+                            "The last time the user added perp lp positions"
+                        ],
                         "type": "i64"
                     },
                     {
                         "name": "totalDeposits",
+                        "docs": [
+                            "The total values of deposits the user has made",
+                            "precision: QUOTE_PRECISION"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "totalWithdraws",
+                        "docs": [
+                            "The total values of withdrawals the user has made",
+                            "precision: QUOTE_PRECISION"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "totalSocialLoss",
+                        "docs": [
+                            "The total socialized loss the users has incurred upon the protocol",
+                            "precision: QUOTE_PRECISION"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "settledPerpPnl",
+                        "docs": [
+                            "Fees (taker fees, maker rebate, referrer reward, filler reward) and pnl for perps",
+                            "precision: QUOTE_PRECISION"
+                        ],
                         "type": "i64"
                     },
                     {
                         "name": "cumulativeSpotFees",
+                        "docs": [
+                            "Fees (taker fees, maker rebate, filler reward) for spot",
+                            "precision: QUOTE_PRECISION"
+                        ],
                         "type": "i64"
                     },
                     {
                         "name": "cumulativePerpFunding",
+                        "docs": [
+                            "Cumulative funding paid/received for perps",
+                            "precision: QUOTE_PRECISION"
+                        ],
                         "type": "i64"
                     },
                     {
                         "name": "liquidationMarginFreed",
+                        "docs": [
+                            "The amount of margin freed during liquidation. Used to force the liquidation to occur over a period of time",
+                            "Defaults to zero when not being liquidated",
+                            "precision: QUOTE_PRECISION"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "lastActiveSlot",
+                        "docs": [
+                            "The last slot a user was active. Used to determine if a user is idle"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "nextOrderId",
+                        "docs": [
+                            "Every user order has an order id. This is the next order id to be used"
+                        ],
                         "type": "u32"
                     },
                     {
                         "name": "maxMarginRatio",
+                        "docs": [
+                            "Custom max initial margin ratio for the user"
+                        ],
                         "type": "u32"
                     },
                     {
                         "name": "nextLiquidationId",
+                        "docs": [
+                            "The next liquidation id to be used for user"
+                        ],
                         "type": "u16"
                     },
                     {
                         "name": "subAccountId",
+                        "docs": [
+                            "The sub account id for this user"
+                        ],
                         "type": "u16"
                     },
                     {
                         "name": "status",
+                        "docs": [
+                            "Whether the user is active, being liquidated or bankrupt"
+                        ],
                         "type": {
                             "defined": "UserStatus"
                         }
                     },
                     {
                         "name": "isMarginTradingEnabled",
+                        "docs": [
+                            "Whether the user has enabled margin trading"
+                        ],
                         "type": "bool"
                     },
                     {
                         "name": "idle",
+                        "docs": [
+                            "User is idle if they haven't interacted with the protocol in 1 week and they have no orders, perp positions or borrows",
+                            "Off-chain keeper bots can ignore users that are idle"
+                        ],
                         "type": "bool"
                     },
                     {
@@ -4897,60 +5233,107 @@
                 "fields": [
                     {
                         "name": "authority",
+                        "docs": [
+                            "The authority for all of a users sub accounts"
+                        ],
                         "type": "publicKey"
                     },
                     {
                         "name": "referrer",
+                        "docs": [
+                            "The address that referred this user"
+                        ],
                         "type": "publicKey"
                     },
                     {
                         "name": "fees",
+                        "docs": [
+                            "Stats on the fees paid by the user"
+                        ],
                         "type": {
                             "defined": "UserFees"
                         }
                     },
                     {
                         "name": "nextEpochTs",
+                        "docs": [
+                            "The timestamp of the next epoch",
+                            "Epoch is used to limit referrer rewards earned in single epoch"
+                        ],
                         "type": "i64"
                     },
                     {
                         "name": "makerVolume30d",
+                        "docs": [
+                            "Rolling 30day maker volume for user",
+                            "precision: QUOTE_PRECISION"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "takerVolume30d",
+                        "docs": [
+                            "Rolling 30day taker volume for user",
+                            "precision: QUOTE_PRECISION"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "fillerVolume30d",
+                        "docs": [
+                            "Rolling 30day filler volume for user",
+                            "precision: QUOTE_PRECISION"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "lastMakerVolume30dTs",
+                        "docs": [
+                            "last time the maker volume was updated"
+                        ],
                         "type": "i64"
                     },
                     {
                         "name": "lastTakerVolume30dTs",
+                        "docs": [
+                            "last time the taker volume was updated"
+                        ],
                         "type": "i64"
                     },
                     {
                         "name": "lastFillerVolume30dTs",
+                        "docs": [
+                            "last time the filler volume was updated"
+                        ],
                         "type": "i64"
                     },
                     {
                         "name": "ifStakedQuoteAssetAmount",
+                        "docs": [
+                            "The amount of tokens staked in the quote spot markets if"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "numberOfSubAccounts",
+                        "docs": [
+                            "The current number of sub accounts"
+                        ],
                         "type": "u16"
                     },
                     {
                         "name": "numberOfSubAccountsCreated",
+                        "docs": [
+                            "The number of sub accounts created. Can be greater than the number of sub accounts if user",
+                            "has deleted sub accounts"
+                        ],
                         "type": "u16"
                     },
                     {
                         "name": "isReferrer",
+                        "docs": [
+                            "Whether the user is a referrer. Sub account 0 can not be deleted if user is a referrer"
+                        ],
                         "type": "bool"
                     },
                     {
@@ -5401,10 +5784,16 @@
                 "fields": [
                     {
                         "name": "lastOraclePrice",
+                        "docs": [
+                            "precision: PRICE_PRECISION"
+                        ],
                         "type": "i64"
                     },
                     {
                         "name": "lastOracleConf",
+                        "docs": [
+                            "precision: PRICE_PRECISION"
+                        ],
                         "type": "u64"
                     },
                     {
@@ -5413,10 +5802,16 @@
                     },
                     {
                         "name": "lastOraclePriceTwap",
+                        "docs": [
+                            "precision: PRICE_PRECISION"
+                        ],
                         "type": "i64"
                     },
                     {
                         "name": "lastOraclePriceTwap5min",
+                        "docs": [
+                            "precision: PRICE_PRECISION"
+                        ],
                         "type": "i64"
                     },
                     {
@@ -5433,18 +5828,30 @@
                 "fields": [
                     {
                         "name": "lastIndexBidPrice",
+                        "docs": [
+                            "precision: PRICE_PRECISION"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "lastIndexAskPrice",
+                        "docs": [
+                            "precision: PRICE_PRECISION"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "lastIndexPriceTwap",
+                        "docs": [
+                            "precision: PRICE_PRECISION"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "lastIndexPriceTwap5min",
+                        "docs": [
+                            "precision: PRICE_PRECISION"
+                        ],
                         "type": "u64"
                     },
                     {
@@ -5461,22 +5868,43 @@
                 "fields": [
                     {
                         "name": "revenueWithdrawSinceLastSettle",
+                        "docs": [
+                            "The amount of revenue last settled",
+                            "Positive if funds left the perp market,",
+                            "negative if funds were pulled into the perp market",
+                            "precision: QUOTE_PRECISION"
+                        ],
                         "type": "i64"
                     },
                     {
                         "name": "maxRevenueWithdrawPerPeriod",
+                        "docs": [
+                            "The max amount of revenue that can be withdrawn per period",
+                            "precision: QUOTE_PRECISION"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "quoteMaxInsurance",
+                        "docs": [
+                            "The max amount of insurance that perp market can use to resolve bankruptcy and pnl deficits",
+                            "precision: QUOTE_PRECISION"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "quoteSettledInsurance",
+                        "docs": [
+                            "The amount of insurance that has been used to resolve bankruptcy and pnl deficits",
+                            "precision: QUOTE_PRECISION"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "lastRevenueWithdrawTs",
+                        "docs": [
+                            "The last time revenue was settled in/out of market"
+                        ],
                         "type": "i64"
                     }
                 ]
@@ -5489,10 +5917,18 @@
                 "fields": [
                     {
                         "name": "scaledBalance",
+                        "docs": [
+                            "To get the pool's token amount, you must multiply the scaled balance by the market's cumulative",
+                            "deposit interest",
+                            "precision: SPOT_BALANCE_PRECISION"
+                        ],
                         "type": "u128"
                     },
                     {
                         "name": "marketIndex",
+                        "docs": [
+                            "The spot market the pool is for"
+                        ],
                         "type": "u16"
                     },
                     {
@@ -5514,308 +5950,536 @@
                 "fields": [
                     {
                         "name": "oracle",
+                        "docs": [
+                            "oracle price data public key"
+                        ],
                         "type": "publicKey"
                     },
                     {
                         "name": "historicalOracleData",
+                        "docs": [
+                            "stores historically witnessed oracle data"
+                        ],
                         "type": {
                             "defined": "HistoricalOracleData"
                         }
                     },
                     {
                         "name": "baseAssetAmountPerLp",
+                        "docs": [
+                            "accumulated base asset amount since inception per lp share"
+                        ],
                         "type": "i128"
                     },
                     {
                         "name": "quoteAssetAmountPerLp",
+                        "docs": [
+                            "accumulated quote asset amount since inception per lp share"
+                        ],
                         "type": "i128"
                     },
                     {
                         "name": "feePool",
+                        "docs": [
+                            "partition of fees from perp market trading moved from pnl settlements"
+                        ],
                         "type": {
                             "defined": "PoolBalance"
                         }
                     },
                     {
                         "name": "baseAssetReserve",
+                        "docs": [
+                            "`x` reserves for constant product mm formula (x * y = k)"
+                        ],
                         "type": "u128"
                     },
                     {
                         "name": "quoteAssetReserve",
+                        "docs": [
+                            "`y` reserves for constant product mm formula (x * y = k)"
+                        ],
                         "type": "u128"
                     },
                     {
                         "name": "concentrationCoef",
+                        "docs": [
+                            "determines how close the min/max base asset reserve sit vs base reserves",
+                            "allow for decreasing slippage without increasing liquidity and v.v."
+                        ],
                         "type": "u128"
                     },
                     {
                         "name": "minBaseAssetReserve",
+                        "docs": [
+                            "minimum base_asset_reserve allowed before AMM is unavailable"
+                        ],
                         "type": "u128"
                     },
                     {
                         "name": "maxBaseAssetReserve",
+                        "docs": [
+                            "maximum base_asset_reserve allowed before AMM is unavailable"
+                        ],
                         "type": "u128"
                     },
                     {
                         "name": "sqrtK",
+                        "docs": [
+                            "`sqrt(k)` in constant product mm formula (x * y = k). stored to avoid drift caused by integer math issues"
+                        ],
                         "type": "u128"
                     },
                     {
                         "name": "pegMultiplier",
+                        "docs": [
+                            "normalizing numerical factor for y, its use offers lowest slippage in cp-curve when market is balanced"
+                        ],
                         "type": "u128"
                     },
                     {
                         "name": "terminalQuoteAssetReserve",
+                        "docs": [
+                            "y when market is balanced. stored to save computation"
+                        ],
                         "type": "u128"
                     },
                     {
                         "name": "baseAssetAmountLong",
+                        "docs": [
+                            "tracks number of total longs in market (regardless of counterparty)"
+                        ],
                         "type": "i128"
                     },
                     {
                         "name": "baseAssetAmountShort",
+                        "docs": [
+                            "tracks number of total shorts in market (regardless of counterparty)"
+                        ],
                         "type": "i128"
                     },
                     {
                         "name": "baseAssetAmountWithAmm",
+                        "docs": [
+                            "tracks net position (longs-shorts) in market with AMM as counterparty"
+                        ],
                         "type": "i128"
                     },
                     {
                         "name": "baseAssetAmountWithUnsettledLp",
+                        "docs": [
+                            "tracks net position (longs-shorts) in market with LPs as counterparty"
+                        ],
                         "type": "i128"
                     },
                     {
                         "name": "maxOpenInterest",
+                        "docs": [
+                            "max allowed open interest, blocks trades that breach this value"
+                        ],
                         "type": "u128"
                     },
                     {
                         "name": "quoteAssetAmount",
+                        "docs": [
+                            "sum of all user's perp quote_asset_amount in market"
+                        ],
                         "type": "i128"
                     },
                     {
                         "name": "quoteEntryAmountLong",
+                        "docs": [
+                            "sum of all long user's quote_entry_amount in market"
+                        ],
                         "type": "i128"
                     },
                     {
                         "name": "quoteEntryAmountShort",
+                        "docs": [
+                            "sum of all short user's quote_entry_amount in market"
+                        ],
                         "type": "i128"
                     },
                     {
                         "name": "quoteBreakEvenAmountLong",
+                        "docs": [
+                            "sum of all long user's quote_break_even_amount in market"
+                        ],
                         "type": "i128"
                     },
                     {
                         "name": "quoteBreakEvenAmountShort",
+                        "docs": [
+                            "sum of all short user's quote_break_even_amount in market"
+                        ],
                         "type": "i128"
                     },
                     {
                         "name": "userLpShares",
+                        "docs": [
+                            "total user lp shares of sqrt_k (protocol owned liquidity = sqrt_k - last_funding_rate)"
+                        ],
                         "type": "u128"
                     },
                     {
                         "name": "lastFundingRate",
+                        "docs": [
+                            "last funding rate in this perp market (unit is quote per base)"
+                        ],
                         "type": "i64"
                     },
                     {
                         "name": "lastFundingRateLong",
+                        "docs": [
+                            "last funding rate for longs in this perp market (unit is quote per base)"
+                        ],
                         "type": "i64"
                     },
                     {
                         "name": "lastFundingRateShort",
+                        "docs": [
+                            "last funding rate for shorts in this perp market (unit is quote per base)"
+                        ],
                         "type": "i64"
                     },
                     {
                         "name": "last24hAvgFundingRate",
+                        "docs": [
+                            "estimate of last 24h of funding rate perp market (unit is quote per base)"
+                        ],
                         "type": "i64"
                     },
                     {
                         "name": "totalFee",
+                        "docs": [
+                            "total fees collected by this perp market"
+                        ],
                         "type": "i128"
                     },
                     {
                         "name": "totalMmFee",
+                        "docs": [
+                            "total fees collected by the vAMM's bid/ask spread"
+                        ],
                         "type": "i128"
                     },
                     {
                         "name": "totalExchangeFee",
+                        "docs": [
+                            "total fees collected by exchange fee schedule"
+                        ],
                         "type": "u128"
                     },
                     {
                         "name": "totalFeeMinusDistributions",
+                        "docs": [
+                            "total fees minus any recognized upnl and pool withdraws"
+                        ],
                         "type": "i128"
                     },
                     {
                         "name": "totalFeeWithdrawn",
+                        "docs": [
+                            "sum of all fees from fee pool withdrawn to revenue pool"
+                        ],
                         "type": "u128"
                     },
                     {
                         "name": "totalLiquidationFee",
+                        "docs": [
+                            "all fees collected by market for liquidations"
+                        ],
                         "type": "u128"
                     },
                     {
                         "name": "cumulativeFundingRateLong",
+                        "docs": [
+                            "accumulated funding rate for longs since inception in market"
+                        ],
                         "type": "i128"
                     },
                     {
                         "name": "cumulativeFundingRateShort",
+                        "docs": [
+                            "accumulated funding rate for shorts since inception in market"
+                        ],
                         "type": "i128"
                     },
                     {
                         "name": "totalSocialLoss",
+                        "docs": [
+                            "accumulated social loss paid by users since inception in market"
+                        ],
                         "type": "u128"
                     },
                     {
                         "name": "askBaseAssetReserve",
+                        "docs": [
+                            "transformed base_asset_reserve for users going long"
+                        ],
                         "type": "u128"
                     },
                     {
                         "name": "askQuoteAssetReserve",
+                        "docs": [
+                            "transformed quote_asset_reserve for users going long"
+                        ],
                         "type": "u128"
                     },
                     {
                         "name": "bidBaseAssetReserve",
+                        "docs": [
+                            "transformed base_asset_reserve for users going short"
+                        ],
                         "type": "u128"
                     },
                     {
                         "name": "bidQuoteAssetReserve",
+                        "docs": [
+                            "transformed quote_asset_reserve for users going short"
+                        ],
                         "type": "u128"
                     },
                     {
                         "name": "lastOracleNormalisedPrice",
+                        "docs": [
+                            "the last seen oracle price partially shrunk toward the amm reserve price"
+                        ],
                         "type": "i64"
                     },
                     {
                         "name": "lastOracleReservePriceSpreadPct",
+                        "docs": [
+                            "the gap between the oracle price and the reserve price = y * peg_multiplier / x"
+                        ],
                         "type": "i64"
                     },
                     {
                         "name": "lastBidPriceTwap",
+                        "docs": [
+                            "average estimate of bid price over funding_period"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "lastAskPriceTwap",
+                        "docs": [
+                            "average estimate of ask price over funding_period"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "lastMarkPriceTwap",
+                        "docs": [
+                            "average estimate of (bid+ask)/2 price over funding_period"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "lastMarkPriceTwap5min",
+                        "docs": [
+                            "average estimate of (bid+ask)/2 price over FIVE_MINUTES"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "lastUpdateSlot",
+                        "docs": [
+                            "the last blockchain slot the amm was updated"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "lastOracleConfPct",
+                        "docs": [
+                            "the pct size of the oracle confidence interval",
+                            "PERCENTAGE_PRECISION"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "netRevenueSinceLastFunding",
+                        "docs": [
+                            "the total_fee_minus_distribution change since the last funding update"
+                        ],
                         "type": "i64"
                     },
                     {
                         "name": "lastFundingRateTs",
+                        "docs": [
+                            "the last funding rate update unix_timestamp"
+                        ],
                         "type": "i64"
                     },
                     {
                         "name": "fundingPeriod",
+                        "docs": [
+                            "the peridocity of the funding rate updates"
+                        ],
                         "type": "i64"
                     },
                     {
                         "name": "orderStepSize",
+                        "docs": [
+                            "the base step size (increment) of orders"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "orderTickSize",
+                        "docs": [
+                            "the price tick size of orders"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "minOrderSize",
+                        "docs": [
+                            "the minimum base size of an order"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "maxPositionSize",
+                        "docs": [
+                            "the max base size a single user can have"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "volume24h",
+                        "docs": [
+                            "estimated total of volume in market",
+                            "QUOTE_PRECISION"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "longIntensityVolume",
+                        "docs": [
+                            "the volume intensity of long fills against AMM"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "shortIntensityVolume",
+                        "docs": [
+                            "the volume intensity of short fills against AMM"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "lastTradeTs",
+                        "docs": [
+                            "the blockchain unix timestamp at the time of the last trade"
+                        ],
                         "type": "i64"
                     },
                     {
                         "name": "markStd",
+                        "docs": [
+                            "estimate of standard deviation of the fill (mark) prices"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "oracleStd",
+                        "docs": [
+                            "estimate of standard deviation of the oracle price at each update"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "lastMarkPriceTwapTs",
+                        "docs": [
+                            "the last unix_timestamp the mark twap was updated"
+                        ],
                         "type": "i64"
                     },
                     {
                         "name": "baseSpread",
+                        "docs": [
+                            "the minimum spread the AMM can quote. also used as step size for some spread logic increases."
+                        ],
                         "type": "u32"
                     },
                     {
                         "name": "maxSpread",
+                        "docs": [
+                            "the maximum spread the AMM can quote"
+                        ],
                         "type": "u32"
                     },
                     {
                         "name": "longSpread",
+                        "docs": [
+                            "the spread for asks vs the reserve price"
+                        ],
                         "type": "u32"
                     },
                     {
                         "name": "shortSpread",
+                        "docs": [
+                            "the spread for bids vs the reserve price"
+                        ],
                         "type": "u32"
                     },
                     {
                         "name": "longIntensityCount",
+                        "docs": [
+                            "the count intensity of long fills against AMM"
+                        ],
                         "type": "u32"
                     },
                     {
                         "name": "shortIntensityCount",
+                        "docs": [
+                            "the count intensity of short fills against AMM"
+                        ],
                         "type": "u32"
                     },
                     {
                         "name": "maxFillReserveFraction",
+                        "docs": [
+                            "the fraction of total available liquidity a single fill on the AMM can consume"
+                        ],
                         "type": "u16"
                     },
                     {
                         "name": "maxSlippageRatio",
+                        "docs": [
+                            "the maximum slippage a single fill on the AMM can push"
+                        ],
                         "type": "u16"
                     },
                     {
                         "name": "curveUpdateIntensity",
+                        "docs": [
+                            "the update intensity of AMM formulaic updates (adjusting k). 0-100"
+                        ],
                         "type": "u8"
                     },
                     {
                         "name": "ammJitIntensity",
+                        "docs": [
+                            "the jit intensity of AMM. larger intensity means larger participation in jit. 0 means no jit participation."
+                        ],
                         "type": "u8"
                     },
                     {
                         "name": "oracleSource",
+                        "docs": [
+                            "the oracle provider information. used to decode/scale the oracle public key"
+                        ],
                         "type": {
                             "defined": "OracleSource"
                         }
                     },
                     {
                         "name": "lastOracleValid",
+                        "docs": [
+                            "tracks whether the oracle was considered valid at the last AMM update"
+                        ],
                         "type": "bool"
                     },
                     {
@@ -6034,26 +6698,50 @@
                 "fields": [
                     {
                         "name": "totalFeePaid",
+                        "docs": [
+                            "Total taker fee paid",
+                            "precision: QUOTE_PRECISION"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "totalFeeRebate",
+                        "docs": [
+                            "Total maker fee rebate",
+                            "precision: QUOTE_PRECISION"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "totalTokenDiscount",
+                        "docs": [
+                            "Total discount from holding token",
+                            "precision: QUOTE_PRECISION"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "totalRefereeDiscount",
+                        "docs": [
+                            "Total discount from being referred",
+                            "precision: QUOTE_PRECISION"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "totalReferrerReward",
+                        "docs": [
+                            "Total reward to referrer",
+                            "precision: QUOTE_PRECISION"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "currentEpochReferrerReward",
+                        "docs": [
+                            "Total reward to referrer this epoch",
+                            "precision: QUOTE_PRECISION"
+                        ],
                         "type": "u64"
                     }
                 ]
@@ -6066,32 +6754,58 @@
                 "fields": [
                     {
                         "name": "scaledBalance",
+                        "docs": [
+                            "The scaled balance of the position. To get the token amount, multiply by the cumulative deposit/borrow",
+                            "interest of corresponding market.",
+                            "precision: SPOT_BALANCE_PRECISION"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "openBids",
+                        "docs": [
+                            "How many spot bids the user has open",
+                            "precision: token mint precision"
+                        ],
                         "type": "i64"
                     },
                     {
                         "name": "openAsks",
+                        "docs": [
+                            "How many spot asks the user has open",
+                            "precision: token mint precision"
+                        ],
                         "type": "i64"
                     },
                     {
                         "name": "cumulativeDeposits",
+                        "docs": [
+                            "The cumulative deposits/borrows a user has made into a market",
+                            "precision: token mint precision"
+                        ],
                         "type": "i64"
                     },
                     {
                         "name": "marketIndex",
+                        "docs": [
+                            "The market index of the corresponding spot market"
+                        ],
                         "type": "u16"
                     },
                     {
                         "name": "balanceType",
+                        "docs": [
+                            "Whether the position is deposit or borrow"
+                        ],
                         "type": {
                             "defined": "SpotBalanceType"
                         }
                     },
                     {
                         "name": "openOrders",
+                        "docs": [
+                            "Number of open orders"
+                        ],
                         "type": "u8"
                     },
                     {
@@ -6113,58 +6827,119 @@
                 "fields": [
                     {
                         "name": "lastCumulativeFundingRate",
+                        "docs": [
+                            "The perp market's last cumulative funding rate. Used to calculate the funding payment owed to user",
+                            "precision: FUNDING_RATE_PRECISION"
+                        ],
                         "type": "i64"
                     },
                     {
                         "name": "baseAssetAmount",
+                        "docs": [
+                            "the size of the users perp position",
+                            "precision: BASE_PRECISION"
+                        ],
                         "type": "i64"
                     },
                     {
                         "name": "quoteAssetAmount",
+                        "docs": [
+                            "Used to calculate the users pnl. Upon entry, is equal to base_asset_amount * avg entry price - fees",
+                            "Updated when the user open/closes position or settles pnl. Includes fees/funding",
+                            "precision: QUOTE_PRECISION"
+                        ],
                         "type": "i64"
                     },
                     {
                         "name": "quoteBreakEvenAmount",
+                        "docs": [
+                            "The amount of quote the user would need to exit their position at to break even",
+                            "Updated when the user open/closes position or settles pnl. Includes fees/funding",
+                            "precision: QUOTE_PRECISION"
+                        ],
                         "type": "i64"
                     },
                     {
                         "name": "quoteEntryAmount",
+                        "docs": [
+                            "The amount quote the user entered the position with. Equal to base asset amount * avg entry price",
+                            "Updated when the user open/closes position. Excludes fees/funding",
+                            "precision: QUOTE_PRECISION"
+                        ],
                         "type": "i64"
                     },
                     {
                         "name": "openBids",
+                        "docs": [
+                            "The amount of open bids the user has in this perp market",
+                            "precision: BASE_PRECISION"
+                        ],
                         "type": "i64"
                     },
                     {
                         "name": "openAsks",
+                        "docs": [
+                            "The amount of open asks the user has in this perp market",
+                            "precision: BASE_PRECISION"
+                        ],
                         "type": "i64"
                     },
                     {
                         "name": "settledPnl",
+                        "docs": [
+                            "The amount of pnl settled in this market since opening the position",
+                            "precision: QUOTE_PRECISION"
+                        ],
                         "type": "i64"
                     },
                     {
                         "name": "lpShares",
+                        "docs": [
+                            "The number of lp (liquidity provider) shares the user has in this perp market",
+                            "LP shares allow users to provide liquidity via the AMM",
+                            "precision: BASE_PRECISION"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "lastBaseAssetAmountPerLp",
+                        "docs": [
+                            "The last base asset amount per lp the amm had",
+                            "Used to settle the users lp position",
+                            "precision: BASE_PRECISION"
+                        ],
                         "type": "i64"
                     },
                     {
                         "name": "lastQuoteAssetAmountPerLp",
+                        "docs": [
+                            "The last quote asset amount per lp the amm had",
+                            "Used to settle the users lp position",
+                            "precision: QUOTE_PRECISION"
+                        ],
                         "type": "i64"
                     },
                     {
                         "name": "remainderBaseAssetAmount",
+                        "docs": [
+                            "Settling LP position can lead to a small amount of base asset being left over smaller than step size",
+                            "This records that remainder so it can be settled later on",
+                            "precision: BASE_PRECISION"
+                        ],
                         "type": "i32"
                     },
                     {
                         "name": "marketIndex",
+                        "docs": [
+                            "The market index for the perp market"
+                        ],
                         "type": "u16"
                     },
                     {
                         "name": "openOrders",
+                        "docs": [
+                            "The number of open orders"
+                        ],
                         "type": "u8"
                     },
                     {
@@ -6186,106 +6961,186 @@
                 "fields": [
                     {
                         "name": "slot",
+                        "docs": [
+                            "The slot the order was placed"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "price",
+                        "docs": [
+                            "The limit price for the order (can be 0 for market orders)",
+                            "For orders with an auction, this price isn't used until the auction is complete",
+                            "precision: PRICE_PRECISION"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "baseAssetAmount",
+                        "docs": [
+                            "The size of the order",
+                            "precision for perps: BASE_PRECISION",
+                            "precision for spot: token mint precision"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "baseAssetAmountFilled",
+                        "docs": [
+                            "The amount of the order filled",
+                            "precision for perps: BASE_PRECISION",
+                            "precision for spot: token mint precision"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "quoteAssetAmountFilled",
+                        "docs": [
+                            "The amount of quote filled for the order",
+                            "precision: QUOTE_PRECISION"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "triggerPrice",
+                        "docs": [
+                            "At what price the order will be triggered. Only relevant for trigger orders",
+                            "precision: PRICE_PRECISION"
+                        ],
                         "type": "u64"
                     },
                     {
                         "name": "auctionStartPrice",
+                        "docs": [
+                            "The start price for the auction. Only relevant for market/oracle orders",
+                            "precision: PRICE_PRECISION"
+                        ],
                         "type": "i64"
                     },
                     {
                         "name": "auctionEndPrice",
+                        "docs": [
+                            "The end price for the auction. Only relevant for market/oracle orders",
+                            "precision: PRICE_PRECISION"
+                        ],
                         "type": "i64"
                     },
                     {
                         "name": "maxTs",
+                        "docs": [
+                            "The time when the order will expire"
+                        ],
                         "type": "i64"
                     },
                     {
                         "name": "oraclePriceOffset",
+                        "docs": [
+                            "If set, the order limit price is the oracle price + this offset",
+                            "precision: PRICE_PRECISION"
+                        ],
                         "type": "i32"
                     },
                     {
                         "name": "orderId",
+                        "docs": [
+                            "The id for the order. Each users has their own order id space"
+                        ],
                         "type": "u32"
                     },
                     {
                         "name": "marketIndex",
+                        "docs": [
+                            "The perp/spot market index"
+                        ],
                         "type": "u16"
                     },
                     {
                         "name": "status",
+                        "docs": [
+                            "Whether the order is open or unused"
+                        ],
                         "type": {
                             "defined": "OrderStatus"
                         }
                     },
                     {
                         "name": "orderType",
+                        "docs": [
+                            "The type of order"
+                        ],
                         "type": {
                             "defined": "OrderType"
                         }
                     },
                     {
                         "name": "marketType",
+                        "docs": [
+                            "Whether market is spot or perp"
+                        ],
                         "type": {
                             "defined": "MarketType"
                         }
                     },
                     {
                         "name": "userOrderId",
+                        "docs": [
+                            "User generated order id. Can make it easier to place/cancel orders"
+                        ],
                         "type": "u8"
                     },
                     {
                         "name": "existingPositionDirection",
+                        "docs": [
+                            "What the users position was when the order was placed"
+                        ],
                         "type": {
                             "defined": "PositionDirection"
                         }
                     },
                     {
                         "name": "direction",
+                        "docs": [
+                            "Whether the user is going long or short. LONG = bid, SHORT = ask"
+                        ],
                         "type": {
                             "defined": "PositionDirection"
                         }
                     },
                     {
                         "name": "reduceOnly",
+                        "docs": [
+                            "Whether the order is allowed to only reduce position size"
+                        ],
                         "type": "bool"
                     },
                     {
                         "name": "postOnly",
+                        "docs": [
+                            "Whether the order must be a maker"
+                        ],
                         "type": "bool"
                     },
                     {
                         "name": "immediateOrCancel",
+                        "docs": [
+                            "Whether the order must be canceled the same slot it is placed"
+                        ],
                         "type": "bool"
                     },
                     {
                         "name": "triggerCondition",
+                        "docs": [
+                            "Whether the order is triggered above or below the trigger price. Only relevant for trigger orders"
+                        ],
                         "type": {
                             "defined": "OrderTriggerCondition"
                         }
                     },
                     {
                         "name": "auctionDuration",
+                        "docs": [
+                            "How many slots the auction lasts"
+                        ],
                         "type": "u8"
                     },
                     {