schema.graphql

type ZenlinkInfo @entity {
  id: ID!
  updatedDate: DateTime!
  "BigDecimal"
  totalVolumeUSD: String!
  "BigDecimal"
  totalTvlUSD: String!
  # transactions
  txCount: Int!

  factory: Factory!
  stableSwapInfo: StableSwapInfo!
}

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

  # pair info
  pairCount: Int!

  # total volume
  "BigDecimal"
  totalVolumeUSD: String!
  "BigDecimal"
  totalVolumeETH: String!

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

  # total liquidity
  "BigDecimal"
  totalLiquidityUSD: String!
  "BigDecimal"
  totalLiquidityETH: String!

  # transactions
  txCount: Int!
}

type StableSwapInfo @entity {
  id: ID!
  poolCount: Int!

  # total volume
  "BigDecimal"
  totalVolumeUSD: String!

  "BigDecimal"
  totalTvlUSD: String!
  # transactions
  txCount: Int!

  swaps: [StableSwap!]! @derivedFrom(field: "stableSwapInfo")
}

type StableSwap @entity {
  id: ID!

   # swap address
  address: String!

  # base swap address
  baseSwapAddress: String!

  # number of tokens supported
  numTokens: Int!

  # supported tokens
  tokens: [String!]!

  # supported base tokens (for SwapNormal, this is same as tokens; for MetaSwap, this is the corresbonding base pool tokens)
  baseTokens: [String!]!

  # supported all tokens (metapool tokens plus basepool tokens)
  allTokens: [String!]!

  # token balances
  balances: [String!]!

  # liquidity provider token
  lpToken: String!
  lpTotalSupply: String!

  # amplification coefficient
  a: BigInt!

  swapFee: BigInt!
  adminFee: BigInt!

  virtualPrice: BigInt!

  stableSwapInfo: StableSwapInfo!

  events: [StableSwapEvent!] @derivedFrom(field: "stableSwap")

  exchanges: [StableSwapExchange!] @derivedFrom(field: "stableSwap")

  stableSwapDayData: [StableSwapDayData!] @derivedFrom(field: "stableSwap")
  stableSwapHourData: [StableSwapHourData!] @derivedFrom(field: "stableSwap")

  farm: [Farm!] @derivedFrom(field: "stableSwap")

  "BigDecimal"
  tvlUSD: String!
  "BigDecimal"
  volumeUSD: String!
}

type StableSwapEvent @entity{
  id: ID!

  stableSwap: StableSwap!

  data: StableSwapEventData

  block: BigInt!
  timestamp: BigInt!
  transaction: Bytes!
}

union StableSwapEventData = 
  StableSwapNewFeeEventData | 
  StableSwapRampAEventData | 
  StableSwapStopRampAEventData | 
  StableSwapAddLiquidityEventData | 
  StableSwapRemoveLiquidityEventData | 
  StableSwapFlashLoanEventData

type StableSwapNewFeeEventData {
  swapFee: BigInt!
  adminFee: BigInt!
}

type StableSwapRampAEventData {
  oldA: BigInt!
  newA: BigInt!
  initialTime: BigInt!
  futureTime: BigInt!
}

type StableSwapStopRampAEventData {
  currentA: BigInt!
  time: BigInt!
}

type StableSwapAddLiquidityEventData {
  provider: Bytes!
  tokenAmounts: [String!]!
  fees: [String!]!
  invariant: BigInt
  lpTokenSupply: BigInt!
}

type StableSwapRemoveLiquidityEventData {
  provider: Bytes!
  tokenAmounts: [String!]!
  fees: [String!]
  lpTokenSupply: BigInt
}

type StableSwapFlashLoanEventData {
  caller: Bytes!
  receiver: Bytes!
  amountsOut: [String!]!
}

type StableSwapExchange @entity {
  id: ID!

  stableSwap: StableSwap!

  data: StableSwapExchangeData

  block: BigInt!
  timestamp: BigInt!
  transaction: Bytes!
}

union StableSwapExchangeData = StableSwapTokenExchangeData | StableSwapTokenExchangeUnderlyingData

type StableSwapTokenExchangeData {
  buyer: Bytes!
  boughtId: BigInt!
  tokensBought: BigInt!
  soldId: BigInt!
  tokensSold: BigInt!
}

type StableSwapTokenExchangeUnderlyingData {
  buyer: Bytes!
  boughtId: BigInt!
  tokensBought: BigInt!
  soldId: BigInt!
  tokensSold: BigInt!
}

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

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

  # used for other stats like marketcap
  totalSupply: String!

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

  # transactions across all pairs
  txCount: Int!

  # liquidity across all pairs
  "BigDecimal"
  totalLiquidity: String!

  # derived prices
  "BigDecimal"
  derivedETH: String!

  tokenDayData: [TokenDayData!]! @derivedFrom(field: "token")
  pairDayDataBase: [PairDayData!]! @derivedFrom(field: "token0")
  pairDayDataQuote: [PairDayData!]! @derivedFrom(field: "token1")
  pairBase: [Pair!]! @derivedFrom(field: "token0")
  pairQuote: [Pair!]! @derivedFrom(field: "token1")
}

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

  # mirrored from the smart contract
  token0: Token!
  token1: Token!
  "BigDecimal"
  reserve0: String!
  "BigDecimal"
  reserve1: String!
  "BigDecimal"
  totalSupply: String!

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

  # Price in terms of the asset pair
  "BigDecimal"
  token0Price: String!
  "BigDecimal"
  token1Price: String!

  # lifetime volume stats
  "BigDecimal"
  volumeToken0: String!
  "BigDecimal"
  volumeToken1: String!
  "BigDecimal"
  volumeUSD: String!
  "BigDecimal"
  untrackedVolumeUSD: String!
  txCount: Int!

  # creation stats
  createdAtTimestamp: DateTime!
  createdAtBlockNumber: BigInt!

  # Fields used to help derived relationship
  liquidityProviderCount: Int! # used to detect new exchanges
  # derived fields
  pairHourData: [PairHourData!]! @derivedFrom(field: "pair")
  pairDayData: [PairDayData!]! @derivedFrom(field: "pair")
  liquidityPositions: [LiquidityPosition!]! @derivedFrom(field: "pair")
  liquidityPositionSnapshots: [LiquidityPositionSnapshot!]! @derivedFrom(field: "pair")
  mints: [Mint!]! @derivedFrom(field: "pair")
  burns: [Burn!]! @derivedFrom(field: "pair")
  swaps: [Swap!]! @derivedFrom(field: "pair")
  farm: [Farm!]  @derivedFrom(field: "pair")
}

type User @entity {
  # user address
  id: ID!
  liquidityPositions: [LiquidityPosition!] @derivedFrom(field: "user")
  stableSwapLiquidityPositions: [StableSwapLiquidityPosition!] @derivedFrom(field: "user")
  stakePositions: [StakePosition!] @derivedFrom(field: "user")
  "BigDecimal"
  usdSwapped: String!
}

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

type StableSwapLiquidityPosition @entity {
  id: ID!
  user: User!
  stableSwap: StableSwap!
  liquidityTokenBalance: String!
}

# saved over time for return calculations, gets created and never updated
type LiquidityPositionSnapshot @entity {
  id: ID!
  liquidityPosition: LiquidityPosition!
  timestamp: DateTime! # saved for fast historical lookups
  block: Int! # saved for fast historical lookups
  user: User! # reference to user
  pair: Pair! # reference to pair
  "BigDecimal"
  token0PriceUSD: String! # snapshot of token0 price
  "BigDecimal"
  token1PriceUSD: String! # snapshot of token1 price
  "BigDecimal"
  reserve0: String! # snapshot of pair token0 reserves
  "BigDecimal"
  reserve1: String! # snapshot of pair token1 reserves
  "BigDecimal"
  reserveUSD: String! # snapshot of pair reserves in USD
  "BigDecimal"
  liquidityTokenTotalSupply: String! # snapshot of pool token supply
  "BigDecimal"
  liquidityTokenBalance: String! # snapshot of users pool token balance
}

type Transaction @entity {
  id: ID! # txn hash
  blockNumber: BigInt!
  timestamp: DateTime!
  mints: [ID!]!
  burns: [ID!]!
  swaps: [ID!]!
}

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

  # populated from the primary Transfer event
  to: String!
  liquidity: String!

  # populated from the Mint event
  sender: String
  amount0: String
  amount1: String
  logIndex: Int
  # derived amount based on available prices of tokens
  amountUSD: String

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

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

  # populated from the primary Transfer event
  liquidity: String!

  # populated from the Burn event
  sender: String
  amount0: String
  amount1: String
  to: String
  logIndex: Int
  # derived amount based on available prices of tokens
  amountUSD: String

  # mark uncomplete in ETH case
  needsComplete: Boolean!

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

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

  # populated from the Swap event
  sender: String!
  from: String! # the EOA that initiated the txn
  amount0In: String!
  amount1In: String!
  amount0Out: String!
  amount1Out: String!
  to: String!
  logIndex: Int

  # derived info
  amountUSD: String!
}

type Bundle @entity {
  id: ID!
  "BigDecimal"
  ethPrice: String! # price of ETH usd
}

type FactoryDayData @entity {
  id: ID! # timestamp rounded to current day by dividing by 86400
  date: DateTime!

  dailyVolumeETH: String!
  dailyVolumeUSD: String!
  dailyVolumeUntracked: String!

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

  txCount: Int!
}

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

  # reserves
  reserve0: String!
  reserve1: String!

  # total supply for LP historical returns
  totalSupply: String!

  # derived liquidity
  reserveUSD: String!

  # volume stats
  hourlyVolumeToken0: String!
  hourlyVolumeToken1: String!
  hourlyVolumeUSD: String!
  hourlyTxns: Int!
}

type PairDayData @entity {
  id: ID!
  date: DateTime!
  pairAddress: String!
  pair: Pair!
  token0: Token!
  token1: Token!

  # reserves
  reserve0: String!
  reserve1: String!

  # total supply for LP historical returns
  totalSupply: String!

  # derived String
  reserveUSD: String!

  # volume stats
  dailyVolumeToken0: String!
  dailyVolumeToken1: String!
  dailyVolumeUSD: String!
  dailyTxns: Int!
}

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

  # volume stats
  dailyVolumeToken: String!
  dailyVolumeETH: String!
  dailyVolumeUSD: String!
  dailyTxns: Int!

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

  # price stats
  priceUSD: String!
}

type StableSwapDayData @entity {
  id: ID!
  date: DateTime!
  stableSwap: StableSwap!

  dailyVolumeUSD: String!
  tvlUSD: String!
}

type StableSwapHourData @entity {
  id: ID!
  hourStartUnix: BigInt! # unix timestamp for start of hour
  stableSwap: StableSwap!

  hourlyVolumeUSD: String!
  tvlUSD: String!
}

type StableDayData @entity {
  id: ID!
  date: DateTime!

  dailyVolumeUSD: String!
  tvlUSD: String!
}

type ZenlinkDayInfo @entity {
  id: ID!
  date: DateTime!

  standardInfo: FactoryDayData!
  stableInfo: StableSwapDayData!

  dailyVolumeUSD: String!
  tvlUSD: String!
}

type SingleTokenLockDayData @entity {
  id: ID!
  singleTokenLock: SingleTokenLock!
  date: DateTime!
  totalLiquidity: String!
  totalLiquidityUSD: String!
  totalLiquidityETH: String!
}

type SingleTokenLockHourData  @entity {
  id: ID!
  hourStartUnix: BigInt! # unix timestamp for start of hour
  singleTokenLock: SingleTokenLock!
  totalLiquidity: String!
  totalLiquidityUSD: String!
  totalLiquidityETH: String!
}


type SingleTokenLock  @entity {
  id: ID!
  token: Token!
  totalLiquidityUSD: String!
  totalLiquidity: String!
  totalLiquidityETH: String!
  singleTokenLockDayData:[SingleTokenLockDayData!] @derivedFrom(field: "singleTokenLock")
  singleTokenLockHourData:[SingleTokenLockHourData!] @derivedFrom(field: "singleTokenLock")
  farm: [Farm!]  @derivedFrom(field: "singleTokenLock")

}

type StakePosition @entity {
  id: ID!
  user: User!
  farm: Farm!
  liquidityStakedBalance: BigInt!
}


type Farm @entity {
  id: ID!
  pid: BigInt!
  singleTokenLock: SingleTokenLock
  stableSwap: StableSwap
  pair: Pair
  stakeToken: String!
  liquidityStaked: BigInt!
  createdAtBlock: BigInt!
  createdAtTimestamp: BigInt!

  # stake apr
  stakedUSD: String!
  rewardUSDPerDay: String!
  stakeApr: String!
  incentives: [Incentive!]! @derivedFrom(field: "farm")
  stakePositions: [StakePosition!] @derivedFrom(field: "farm")
}

type Incentive @entity {
  id: ID!
  farm: Farm!
  rewardToken: Token!
  rewardPerDay: String!
}