manifold/common/txn.ts

// A txn (pronounced "texan") respresents a payment between two ids on Manifold
// Shortened from "transaction" to distinguish from Firebase transactions (and save chars)
export type Txn = {
  id: string
  createdTime: number

  fromId: string
  fromType: SourceType

  toId: string
  toType: SourceType

  amount: number
  token: 'M$' // | 'USD' | MarketOutcome

  category: 'CHARITY' | 'TIP' // | 'BET'
  // Any extra data
  data?: { [key: string]: any }
  // Human-readable description
  description?: string
}

export type SourceType = 'USER' | 'CONTRACT' | 'CHARITY' | 'BANK'

export type DonationTxn = Omit<Txn, 'data'> & {
  fromType: 'USER'
  toType: 'CHARITY'
  category: 'CHARITY'
}

export type TipTxn = Txn & {
  fromType: 'USER'
  toType: 'USER'
  category: 'TIP'
  data: {
    contractId: string
    commentId: string
  }
}