Protocol Overview

export type StateAccount = {
  admin: PublicKey;
  exchangeStatus: number;
  whitelistMint: PublicKey;
  discountMint: PublicKey;
  oracleGuardRails: OracleGuardRails;
  numberOfAuthorities: BN;
  numberOfSubAccounts: BN;
  numberOfMarkets: number;
  numberOfSpotMarkets: number;
  minPerpAuctionDuration: number;
  defaultMarketOrderTimeInForce: number;
  defaultSpotAuctionDuration: number;
  liquidationMarginBufferRatio: number;
  settlementDuration: number;
  maxNumberOfSubAccounts: number;
  signer: PublicKey;
  signerNonce: number;
  srmVault: PublicKey;
  perpFeeStructure: FeeStructure;
  spotFeeStructure: FeeStructure;
  lpCooldownTime: BN;
  initialPctToLiquidate: number;
  liquidationDuration: number;
  maxInitializeUserFee: number;
  featureBitFlags: number;
};

export class MarketStatus {
  static readonly INITIALIZED = { initialized: {} };
  static readonly ACTIVE = { active: {} };
  static readonly FUNDING_PAUSED = { fundingPaused: {} };
  static readonly AMM_PAUSED = { ammPaused: {} };
  static readonly FILL_PAUSED = { fillPaused: {} };
  static readonly WITHDRAW_PAUSED = { withdrawPaused: {} };
  static readonly REDUCE_ONLY = { reduceOnly: {} };
  static readonly SETTLEMENT = { settlement: {} };
  static readonly DELISTED = { delisted: {} };
}

export class ContractTier {
  static readonly A = { a: {} };              // Highest insurance coverage
  static readonly B = { b: {} };              // Medium insurance coverage
  static readonly C = { c: {} };              // Lower insurance coverage
  static readonly SPECULATIVE = { speculative: {} };           // No insurance
  static readonly HIGHLY_SPECULATIVE = { highlySpeculative: {} }; // No insurance
  static readonly ISOLATED = { isolated: {} }; // Isolated margin only
}

export type AMM = {
  baseAssetReserve: BN;          // Virtual base reserves
  quoteAssetReserve: BN;         // Virtual quote reserves
  sqrtK: BN;                     // Sqrt of constant product
  pegMultiplier: BN;             // Price peg to oracle
  cumulativeFundingRate: BN;     // Cumulative funding
  oracle: PublicKey;             // Oracle address
  oracleSource: OracleSource;    // Oracle type
  baseAssetAmountWithAmm: BN;    // Net AMM position
  baseAssetAmountLong: BN;       // Total long positions
  baseAssetAmountShort: BN;      // Total short positions
  // ... additional fields
};

export enum ExchangeStatus {
  ACTIVE = 0,
  DEPOSIT_PAUSED = 1,
  WITHDRAW_PAUSED = 2,
  AMM_PAUSED = 4,
  FILL_PAUSED = 8,
  LIQ_PAUSED = 16,
  FUNDING_PAUSED = 32,
  SETTLE_PNL_PAUSED = 64,
  AMM_IMMEDIATE_FILL_PAUSED = 128,
  PAUSED = 255,
}