schema.graphql

type PulsarFactory @entity {
  # factory address
  id: ID!

  # pair info
  pairCount: Int!

  # total volume
  totalVolumeUSD: BigDecimal!
  totalVolumeETH: BigDecimal!

  # untracked values - less confident USD scores
  untrackedVolumeUSD: BigDecimal!

  # total liquidity
  totalLiquidityUSD: BigDecimal!
  totalLiquidityETH: BigDecimal!

  # transactions
  txCount: BigInt!
}

type Token @entity {
  # token address
  id: ID!

  # mirrored from the smart contract
  symbol: String!
  name: String!
  decimals: BigInt!

  # used for other stats like marketcap
  totalSupply: BigInt!

  # token specific volume
  tradeVolume: BigDecimal!
  tradeVolumeUSD: BigDecimal!
  untrackedVolumeUSD: BigDecimal!

  # transactions across all pairs
  txCount: BigInt!

  # liquidity across all pairs
  totalLiquidity: BigDecimal!

  # derived prices
  derivedETH: BigDecimal!

  # derived fields
  tokenDayData: [TokenDayData!]! @derivedFrom(field: "token")
  pairDayDataBase: [PairDayData!]! @derivedFrom(field: "tokenA")
  pairDayDataQuote: [PairDayData!]! @derivedFrom(field: "tokenB")
  pairBase: [Pair!]! @derivedFrom(field: "tokenA")
  pairQuote: [Pair!]! @derivedFrom(field: "tokenB")
}

type Order @entity {
  # pair address
  id: ID!

  # order details
  user: User!
  orderId: BigDecimal!
  submitBlock: BigDecimal!
  expirationBlock: BigDecimal!
  saleRate: BigDecimal!
  sellAmount: BigDecimal!
  buyAmount: BigDecimal!
  sellToken: Token!
  buyToken: Token!
}

type Pair @entity {
  # pair address
  id: ID!

  # mirrored from the smart contract
  tokenA: Token!
  tokenB: Token!
  reserveA: BigDecimal!
  reserveB: BigDecimal!
  totalSupply: BigDecimal!
  ordersAmount: BigDecimal!
  lastVirtualOrderBlock: BigDecimal!
  tokenASalesRate: BigDecimal!
  tokenBSalesRate: BigDecimal!
  orderPoolARewardFactor: BigDecimal!
  orderPoolBRewardFactor: BigDecimal!

  # derived liquidity
  reserveETH: BigDecimal!
  reserveUSD: BigDecimal!
  # used for separating per pair reserves and global
  trackedReserveETH: BigDecimal!

  # Price in terms of the asset pair
  tokenAPrice: BigDecimal!
  tokenBPrice: BigDecimal!

  # lifetime volume stats
  volumeTokenA: BigDecimal!
  volumeTokenB: BigDecimal!
  volumeUSD: BigDecimal!
  untrackedVolumeUSD: BigDecimal!
  txCount: BigInt!

  # creation stats
  createdAtTimestamp: BigInt!
  createdAtBlockNumber: BigInt!

  # Fields used to help derived relationship
  liquidityProviderCount: BigInt! # used to detect new exchanges
  # derived fields
  pairHourData: [PairHourData!]! @derivedFrom(field: "pair")
  liquidityPositions: [LiquidityPosition!]! @derivedFrom(field: "pair")
  liquidityPositionSnapshots: [LiquidityPositionSnapshot!]!
    @derivedFrom(field: "pair")
  initialmints: [InitialMint!]! @derivedFrom(field: "pair")
  mints: [Mint!]! @derivedFrom(field: "pair")
  burns: [Burn!]! @derivedFrom(field: "pair")
  instantswaps: [InstantSwap!]! @derivedFrom(field: "pair")
  termswaps: [TermSwap!]! @derivedFrom(field: "pair")
  withdraworder: [WithdrawOrder!]! @derivedFrom(field: "pair")
  cancelorder: [CancelOrder!]! @derivedFrom(field: "pair")
}

type User @entity {
  id: ID!
  orders: [Order!]! @derivedFrom(field: "user")
  liquidityPositions: [LiquidityPosition!]! @derivedFrom(field: "user")
  usdSwapped: BigDecimal!
}

type LiquidityPosition @entity {
  id: ID!
  user: User!
  pair: Pair!
  liquidityTokenBalance: BigDecimal!
}

# saved over time for return calculations, gets created and never updated
type LiquidityPositionSnapshot @entity {
  id: ID!
  liquidityPosition: LiquidityPosition!
  timestamp: Int! # saved for fast historical lookups
  block: Int! # saved for fast historical lookups
  user: User! # reference to user
  pair: Pair! # reference to pair
  tokenAPriceUSD: BigDecimal! # snapshot of tokenA price
  tokenBPriceUSD: BigDecimal! # snapshot of tokenB price
  reserveA: BigDecimal! # snapshot of pair tokenA reserves
  reserveB: BigDecimal! # snapshot of pair tokenB reserves
  reserveUSD: BigDecimal! # snapshot of pair reserves in USD
  liquidityTokenTotalSupply: BigDecimal! # snapshot of pool token supply
  liquidityTokenBalance: BigDecimal! # snapshot of users pool token balance
}

type Transaction @entity {
  id: ID! # txn hash
  blockNumber: BigInt!
  timestamp: BigInt!
  transactionHash: Bytes!
  # This is not the reverse of Mint.transaction; it is only used to
  # track incomplete mints (similar for burns and swaps)
  initialmints: [InitialMint!]!
  mints: [Mint!]!
  burns: [Burn!]!
  instantswaps: [InstantSwap!]!
  termswaps: [TermSwap!]!
  withdraworder: [WithdrawOrder!]!
  cancelorder: [CancelOrder!]!
}

type InitialMint @entity {
  # transaction hash + "-" + index in mints Transaction array
  id: ID!
  transaction: Transaction!
  timestamp: BigInt! # need this to pull recent txns for specific token or pair
  pair: Pair!

  # populated from the primary Transfer event
  to: Bytes!
  liquidity: BigDecimal!

  # populated from the InitialMint event
  sender: Bytes!
  amountA: BigDecimal!
  amountB: BigDecimal!
  logIndex: BigInt!
  # derived amount based on available prices of tokens
  amountUSD: BigDecimal!

  # optional fee fields, if a Transfer event is fired in _mintFee
  feeTo: Bytes!
  feeLiquidity: BigDecimal!
}

type Mint @entity {
  # transaction hash + "-" + index in mints Transaction array
  id: ID!
  transaction: Transaction!
  timestamp: BigInt! # need this to pull recent txns for specific token or pair
  pair: Pair!

  # populated from the primary Transfer event
  to: Bytes!
  liquidity: BigDecimal!

  # populated from the Mint event
  sender: Bytes!
  amountA: BigDecimal!
  amountB: BigDecimal!
  logIndex: BigInt!
  # derived amount based on available prices of tokens
  amountUSD: BigDecimal!

  # optional fee fields, if a Transfer event is fired in _mintFee
  feeTo: Bytes!
  feeLiquidity: BigDecimal!
}

type Burn @entity {
  # transaction hash + "-" + index in mints Transaction array
  id: ID!
  transaction: Transaction!
  timestamp: BigInt! # need this to pull recent txns for specific token or pair
  pair: Pair!

  # populated from the primary Transfer event
  liquidity: BigDecimal!

  # populated from the Burn event
  sender: Bytes!
  amountA: BigDecimal!
  amountB: BigDecimal!
  to: Bytes!
  logIndex: BigInt!
  # derived amount based on available prices of tokens
  amountUSD: BigDecimal!

  # mark uncompleted in ETH case
  needsComplete: Boolean!

  # optional fee fields, if a Transfer event is fired in _mintFee
  feeTo: Bytes!
  feeLiquidity: BigDecimal!
}

type InstantSwap @entity {
  # transaction hash + "-" + index in swaps Transaction array
  id: ID!
  transaction: Transaction!
  timestamp: BigInt! # need this to pull recent txns for specific token or pair
  pair: Pair!

  # populated from the InstantSwap event
  sender: Bytes!
  from: Bytes! # the EOA that initiated the txn
  amountAIn: BigDecimal!
  amountBIn: BigDecimal!
  amountAOut: BigDecimal!
  amountBOut: BigDecimal!
  to: Bytes!
  logIndex: BigInt!

  # derived info
  amountUSD: BigDecimal!
}

type TermSwap @entity {
  # transaction hash + "-" + index in swaps Transaction array
  id: ID!
  transaction: Transaction!
  timestamp: BigInt! # need this to pull recent txns for specific token or pair
  pair: Pair!

  # populated from the TermSwap event
  sender: Bytes!
  from: Bytes! # the EOA that initiated the txn
  amountAIn: BigDecimal!
  amountBIn: BigDecimal!
  numberOBI: BigDecimal!
  orderId: BigDecimal!
  logIndex: BigInt!

  # derived info
  amountUSD: BigDecimal!
}

type CancelOrder @entity {
  # transaction hash + "-" + index in cancel Transaction array
  id: ID!
  transaction: Transaction!
  timestamp: BigInt! # need this to pull recent txns for specific token or pair
  pair: Pair!

  # populated from the CancelOrder event
  sender: Bytes!
  from: Bytes! # the EOA that initiated the txn
  orderId: BigDecimal!
  unsoldAmount: BigDecimal!
  purchasedAmount: BigDecimal!
  to: Bytes!
  logIndex: BigInt!

  # derived info
  amountUSD: BigDecimal!
}

type WithdrawOrder @entity {
  # transaction hash + "-" + index in withdraw Transaction array
  id: ID!
  transaction: Transaction!
  timestamp: BigInt! # need this to pull recent txns for specific token or pair
  pair: Pair!

  # populated from the WithdrawOrder event
  sender: Bytes!
  from: Bytes! # the EOA that initiated the txn
  orderId: BigDecimal!
  proceeds: BigDecimal!
  to: Bytes!
  logIndex: BigInt!

  # derived info
  amountUSD: BigDecimal!
}

# stores for USD calculations
type Bundle @entity {
  id: ID!
  ethPrice: BigDecimal! # price of ETH usd
}

# Data accumulated and condensed into day stats for all of Pulsar
type PulsarDayData @entity {
  id: ID! # timestamp rounded to current day by dividing by 86400
  date: Int!

  dailyVolumeETH: BigDecimal!
  dailyVolumeUSD: BigDecimal!
  dailyVolumeUntracked: BigDecimal!

  totalVolumeETH: BigDecimal!
  totalLiquidityETH: BigDecimal!
  totalVolumeUSD: BigDecimal! # Accumulate at each trade, not just calculated off whatever totalVolume is. making it more accurate as it is a live conversion
  totalLiquidityUSD: BigDecimal!

  txCount: BigInt!
}

type PairHourData @entity {
  id: ID!
  hourStartUnix: Int! # unix timestamp for start of hour
  pair: Pair!

  # reserves
  reserveA: BigDecimal!
  reserveB: BigDecimal!

  # total supply for LP historical returns
  totalSupply: BigDecimal!

  # derived liquidity
  reserveUSD: BigDecimal!

  # volume stats
  hourlyVolumeTokenA: BigDecimal!
  hourlyVolumeTokenB: BigDecimal!
  hourlyVolumeUSD: BigDecimal!
  hourlyTxns: BigInt!
}

# Data accumulated and condensed into day stats for each exchange
type PairDayData @entity {
  id: ID!
  date: Int!
  pairAddress: Bytes!
  tokenA: Token!
  tokenB: Token!

  # reserves
  reserveA: BigDecimal!
  reserveB: BigDecimal!

  # total supply for LP historical returns
  totalSupply: BigDecimal!

  # derived liquidity
  reserveUSD: BigDecimal!

  # volume stats
  dailyVolumeTokenA: BigDecimal!
  dailyVolumeTokenB: BigDecimal!
  dailyVolumeUSD: BigDecimal!
  dailyTxns: BigInt!
}

type TokenDayData @entity {
  id: ID!
  date: Int!
  token: Token!

  # volume stats
  dailyVolumeToken: BigDecimal!
  dailyVolumeETH: BigDecimal!
  dailyVolumeUSD: BigDecimal!
  dailyTxns: BigInt!

  # liquidity stats
  totalLiquidityToken: BigDecimal!
  totalLiquidityETH: BigDecimal!
  totalLiquidityUSD: BigDecimal!

  # price stats
  priceUSD: BigDecimal!
}