manifold/common/contract.ts

import { Answer } from './answer'

export type FullContract<
  M extends DPM | CPMM,
  T extends Binary | Multi | FreeResponse
> = {
  id: string
  slug: string // auto-generated; must be unique

  creatorId: string
  creatorName: string
  creatorUsername: string
  creatorAvatarUrl?: string // Start requiring after 2022-03-01

  question: string
  description: string // More info about what the contract is about
  tags: string[]
  lowercaseTags: string[]
  visibility: 'public' | 'unlisted'

  createdTime: number // Milliseconds since epoch
  lastUpdatedTime: number // If the question or description was changed
  closeTime?: number // When no more trading is allowed

  isResolved: boolean
  resolutionTime?: number // When the contract creator resolved the market
  resolution?: string

  closeEmailsSent?: number

  volume24Hours: number
  volume7Days: number
} & M &
  T

export type Contract = FullContract<DPM | CPMM, Binary | Multi | FreeResponse>

export type DPM = {
  mechanism: 'dpm-2'

  pool: { [outcome: string]: number }
  phantomShares?: { [outcome: string]: number }
  totalShares: { [outcome: string]: number }
  totalBets: { [outcome: string]: number }
}

export type CPMM = {
  mechanism: 'cpmm-1'

  pool: { [outcome: string]: number }
  k: number // liquidity constant
  liquidity: { [userId: string]: { [outcome: string]: number } } // track liquidity providers
}

export type Binary = {
  outcomeType: 'BINARY'
  resolutionProbability?: number // Used for BINARY markets resolved to MKT
}

export type Multi = {
  outcomeType: 'MULTI'
  multiOutcomes: string[] // Used for outcomeType 'MULTI'.
  resolutions?: { [outcome: string]: number } // Used for PROB
}

export type FreeResponse = {
  outcomeType: 'FREE_RESPONSE'
  answers: Answer[] // Used for outcomeType 'FREE_RESPONSE'.
  resolutions?: { [outcome: string]: number } // Used for PROB
}

export type outcomeType = 'BINARY' | 'MULTI' | 'FREE_RESPONSE'