schema.graphql

type Analytics @entity {
  # factory address - for uniqueness
  id: Bytes!
  totalUsers: BigInt!
  totalTransactions: BigInt!
  totalTokensLocked: BigInt!
  totalVolumeBuilds: BigInt!
  totalVolumeUnwinds: BigInt!
  totalVolumeLiquidations: BigInt!
  totalVolume: BigInt!
}

type AnalyticsHourData @entity {
  # factory address concatendated with date - for uniqueness
  id: Bytes!
  # unix timestamp for start of hour
  periodStartUnix: Int!
  totalUsers: BigInt!
  totalTransactions: BigInt!
  totalTokensLocked: BigInt!
  totalVolumeBuilds: BigInt!
  totalVolumeUnwinds: BigInt!
  totalVolumeLiquidations: BigInt!
  totalVolume: BigInt!
}

type Factory @entity {
  # factory address
  id: Bytes!
  # amount of markets created
  marketCount: BigInt!
  # amount of transactions all time
  txCount: BigInt!
  # total volumne all time in OVL
  totalVolumeOVL: BigDecimal!
  # total fees generated in OVL
  totalFeesOVL: BigDecimal!
  # total value locked in OVL
  totalValueLockedOVL: BigDecimal!
  # fee receipient address
  feeRecipient: ID!
  # owner of factory
  owner: ID!
  # markets held in factory contract
  markets: [Market!]! @derivedFrom(field: "factory")
}

type Market @entity {
  # market contract address
  id: Bytes!
  # feed contract address
  feedAddress: String!
  # factory contract address
  factory: Factory!
  # creation timestamp
  createdAtTimestamp: BigInt!
  # creation block number
  createdAtBlockNumber: BigInt!
  # funding constant
  k: BigInt!
  # market impact constant
  lmbda: BigInt!
  # bid-ask static spread constant
  delta: BigInt!
  # cap pay-off
  capPayoff: BigInt!
  # notional cap
  capNotional: BigInt!
  # leverage cap
  capLeverage: BigInt!
  # trailing window for circuit breaker
  circuitBreakerWindow: BigInt!
  # target worst case inflation rate over trailing window
  circuitBreakerMintTarget: BigInt!
  # maintenance margin constant
  maintenanceMarginFraction: BigInt!
  # burn rate for maintenance margin constant
  maintenanceMarginBurnRate: BigInt!
  # liquidation fees
  liquidationFeeRate: BigInt!
  # trading fees on build/unwind
  tradingFeeRate: BigInt!
  # minimum collateral to open a position in OVL
  minCollateral: BigInt!
  # upper limit for price feed changes since last update
  priceDriftUpperLimit: BigInt!
  # average block time of the respective chain
  averageBlockTime: BigInt!
  # total current oi long
  oiLong: BigInt!
  # total current oi short
  oiShort: BigInt!
  # oi long shares
  oiLongShares: BigInt!
  # oi short shares
  oiShortShares: BigInt!
  # if market is shut down
  isShutdown: Boolean!
  # fees and tx count:
  # number of builds/positions
  numberOfBuilds: BigInt!
  # sum of all build fees
  totalBuildFees: BigInt!
  # number of unwinds
  numberOfUnwinds: BigInt!
  # sum of all build fees
  totalUnwindFees: BigInt!
  # number of liquidates
  numberOfLiquidates: BigInt!
  # sum of all build fees
  totalLiquidateFees: BigInt!
  # sum of all fees
  totalFees: BigInt!  
  # sum of volume
  totalVolume: BigInt!  
  # positive means net minting | negative means net burning
  totalMint: BigInt!
  # used in dataIsValid function
  dpUpperLimit: BigInt!
  # derived fields
  marketHourData: [MarketHourData!]! @derivedFrom(field: "market")
  # positions held in market
  positions: [Position!]! @derivedFrom(field: "market")
  # last state of the market
  marketState: MarketState! @derivedFrom(field: "market")
}

type MarketState @entity {
  # market address
  id: Bytes!
  market: Market!
  bid: BigInt!
  ask: BigInt!
  mid: BigInt!
  volumeBid: BigInt!
  volumeAsk: BigInt!
  oiLong: BigInt!
  oiShort: BigInt!
  capOi: BigInt!
  circuitBreakerLevel: BigInt!
  fundingRate: BigInt!
}

type Position @entity {
  # market contract concat'd with position id
  id: ID!
  # position id
  positionId: String!
  # owner of position
  owner: Account!
  # market contract address related to position
  market: Market!
  # initial oi when building position
  initialOi: BigInt!
  # initial debt when building position
  initialDebt: BigInt!
  # initial collateral at time of building position
  initialCollateral: BigInt!
  # initial notional at time of building position
  initialNotional: BigInt!
  # leverage taken on position
  leverage: BigDecimal!
  # total fraction unwound from inception
  fractionUnwound: BigInt!
  # long/short
  isLong: Boolean!
  # entry price when building position
  entryPrice: BigInt!
  # is position liquidated
  isLiquidated: Boolean!
  # current oi
  currentOi: BigInt!
  # current debt
  currentDebt: BigInt!
  # total ovl minted/burned from transactions
  mint: BigInt!
  # time stamp of position creation
  createdAtTimestamp: BigInt!
  # block number of position creation
  createdAtBlockNumber: BigInt!
  # number of unwinds
  numberOfUniwnds: BigInt!

   # derived fields
  builds: [Build!]! @derivedFrom(field: "position")
  liquidates: [Liquidate!]! @derivedFrom(field: "position")
  unwinds: [Unwind!]! @derivedFrom(field: "position")
}

type Transaction @entity {
  # txn hash
  id: Bytes!
  # block txn was included in
  blockNumber: BigInt!
  # timestamp txn was confirmed
  timestamp: BigInt!
  # gas settings during txn execution
  gasLimit: BigInt!
  gasPrice: BigInt!
  # derived values
  builds: [Build!]! @derivedFrom(field: "transaction")
  unwinds: [Unwind!]! @derivedFrom(field: "transaction")
  liquidates: [Liquidate!]! @derivedFrom(field: "transaction")
  tokenTransfers: [TokenTransfer!]! @derivedFrom(field: "transaction")
}

type Build @entity {
  # market contract concat'd with position id
  id: ID!
  # account performing action
  owner: Account!
  # position entitie
  position: Position!
  # price at time of build
  price: BigInt!
  # Fee amount of this build
  feeAmount: BigInt!
  # timestamp of transaction
  timestamp: BigInt!
  # transaction the position was built in
  transaction: Transaction!
}

type Unwind @entity {
  # market contract concat'd with position id concat'd with unwind number
  id: ID!
  # account performing action
  owner: Account!
  # position id
  position: Position!
  # unwind number
  unwindNumber: BigInt!
  # amount of oi unwound
  oiUnwound: BigInt!
  # price at time of unwind
  price: BigInt!
  # fraction of unwind
  fraction: BigInt!
  # fraction of the original position
  fractionOfPosition: BigInt!
  # amount of OVL transferred to the owner
  transferAmount: BigInt!
  # PnL of this unwind
  pnl: BigInt!
  # Fee amount of this unwind
  feeAmount: BigInt!
  # funding payment of this unwind
  fundingPayment: BigInt!
  # fraction of initial collateral of this unwind
  size: BigInt!
  # volume = transferAmount + (initialDebt * fractionOfPosition) 
  volume: BigInt!
  # total ovl minted/burned in this unwind
  mint: BigInt!
  # timestamp of transaction
  timestamp: BigInt!
  # transaction the position was unwinded in
  transaction: Transaction!
}

type Liquidate @entity {
  # market contract concat'd with position id
  id: ID!
  # owner of the position
  owner: Account!
  # address performing the transaction
  sender: Account!
  # position id
  position: Position!
  # fraction of the original position
  fractionOfPosition: BigInt!
  # funding payment of this liquidation
  fundingPayment: BigInt!
  # liquidate size = initialCollateral * fractionOfPosition
  size: BigInt!
  # price at time of liquidate
  price: BigInt!
  # total ovl minted/burned in this transaction
  mint: BigInt!
  # timestamp of transaction
  timestamp: BigInt!
  # transaction the position was liquidated in
  transaction: Transaction!
  # volume = (initialDebt * fractionOfPosition) + liquidationFee + marginRemaining
  # TODO add marginToBurn
  volume: BigInt!
  # amount sent to liquidator (tx sender)
  liquidationFee: BigInt!
  marginToBurn: BigInt!
  transferFeeAmount: BigInt!
}

type Account @entity {
  # account address
  id: Bytes!
  # totalRealizedPnl
  realizedPnl:  BigInt!
  # numberOfUnwinds of the account
  numberOfUnwinds: BigInt!
  # numberOfLiquidatedPositions
  numberOfLiquidatedPositions: BigInt!
  # numberOfOpenPositions
  numberOfOpenPositions: BigInt!
  planckCatBalance: BigInt! # number of PlanckCat NFTs owned
  ovlVolumeTraded: BigInt! # total OVL volume traded historically
  # derived account info
  positions: [Position!]! @derivedFrom(field: "owner")
  builds: [Build!]! @derivedFrom(field: "owner")
  unwinds: [Unwind!]! @derivedFrom(field: "owner")
  liquidates: [Liquidate!]! @derivedFrom(field: "owner")
  stakingPositions: [StakingPosition!]! @derivedFrom(field: "owner")
  referralPositions: [ReferralPosition!]! @derivedFrom(field: "owner")
  tradingMiningEpochVolumes: [TradingMiningEpochVolume!]! @derivedFrom(field: "trader")
  tokens: [TokenPosition!]! @derivedFrom(field: "owner")
  nfts: [ERC721NFT!]! @derivedFrom(field: "owner")
  erc1155Tokens: [ERC1155TokenBalance!]! @derivedFrom(field: "owner")
}

type TokenTransfer @entity(immutable: true) {
  # The `transactionIndex` is the index of the transaction in the block.
  # The `logIndex` is the index of the log in the block logs.
  id: Bytes! # tx hash + log index
  token: ERC20Token!
  from: Bytes!
  to: Bytes!
  amount: BigInt!
  transaction: Transaction!
}

type TokenPosition @entity {
  id: Bytes! # token + owner addresses
  token: ERC20Token!
  owner: Account! # address
  balance: BigInt!
}

type ERC20Token @entity {
  id: Bytes! # address
  totalSupply: BigInt!
  name: String!
  symbol: String!
  # derived fields
  totalSupplyHourData: [TotalSupplyHourData!]! @derivedFrom(field: "token")
}

type RewardsClaimed @entity(immutable: true) {
  id: Bytes!
  staker: Bytes! # address
  stakingPosition: StakingPosition!
  rewardAmount: BigInt! # uint256
  blockNumber: BigInt!
  blockTimestamp: BigInt!
  transactionHash: Bytes!
}

type TokensStaked @entity(immutable: true) {
  id: Bytes!
  staker: Bytes! # address
  stakingPosition: StakingPosition!
  amount: BigInt! # uint256
  blockNumber: BigInt!
  blockTimestamp: BigInt!
  transactionHash: Bytes!
}

type TokensWithdrawn @entity(immutable: true) {
  id: Bytes!
  staker: Bytes! # address
  stakingPosition: StakingPosition!
  amount: BigInt! # uint256
  blockNumber: BigInt!
  blockTimestamp: BigInt!
  transactionHash: Bytes!
}

type StakingPosition @entity {
  id: Bytes! # pool + owner addresses
  pool: Staking!
  owner: Account! # address
  stakedBalance: BigInt! # amount currently staked
  totalRewardsClaimed: BigInt! # historical rewards claimed
  tokensStaked: [TokensStaked!]! @derivedFrom(field: "stakingPosition")
  tokensWithdrawn: [TokensWithdrawn!]! @derivedFrom(field: "stakingPosition")
  rewardsClaimed: [RewardsClaimed!]! @derivedFrom(field: "stakingPosition")
}

type Staking @entity {
  id: Bytes! # address
  rewardToken: Bytes! # address
  stakingToken: Bytes! # address
  timeUnit: BigInt!
  rewardsBalance: BigInt!
  stakedBalance: BigInt!
  totalRewardsClaimed: BigInt!
  totalStaked: BigInt!
  rewardRatioNumerator: BigInt!
  rewardRatioDenominator: BigInt!
  stakingPositions: [StakingPosition!]! @derivedFrom(field: "pool")
}

type ERC721Transfer @entity(immutable: true) {
  id: Bytes! # tx hash + log index
  nft: ERC721NFT!
  from: Account!
  to: Account!
  transaction: Transaction!
}

type ERC721NFT @entity {
  id: Bytes! # contract address + tokenId
  contract: ERC721Token! # address
  tokenId: BigInt!
  tokenUri: String!
  owner: Account! # address
}

type ERC721Token @entity {
  id: Bytes! # address
  name: String!
  symbol: String!
  totalSupply: BigInt!
}

type ReferralProgram @entity {
  id: Bytes! # address
  rewardToken: Bytes! # address
  affiliateComission: [BigInt!]! # bps
  traderDiscount: [BigInt!]! # bps
  # creation timestamp
  createdAtTimestamp: BigInt!
  # creation block number
  createdAtBlockNumber: BigInt!
  # last modification transaction
  latestUpdateTransaction: Transaction!
  # totalRewards
  totalRewards: BigInt!
  totalAirdropped: BigInt!
  referralPositions: [ReferralPosition!]! @derivedFrom(field: "referralProgram")
}

type ReferralPosition @entity {
  id: Bytes! # referral address + owner addresses
  referralProgram: ReferralProgram!
  owner: Account! # address
  tier: Int!
  affiliatedTo: Account
  totalAffiliateComission: BigInt!
  totalTraderDiscount: BigInt!
  totalAirdroppedAmount: BigInt!
  totalRewardsPending: BigInt!
  accountsReferred: Int!
}

type TradingMining @entity {
  id: Bytes! # address
  totalRewards: BigInt!
  rewardToken1: Bytes! # address
  rewardToken2: Bytes! # address
  token1Percentage: Int!
  startTime: BigInt!
  epochDuration: BigInt!
  pcdHolderBonusPercentage: Int!
  maxRewardPerEpochPerAddress: BigInt!
}

type TradingMiningEpoch @entity {
  id: Bytes! # address + epoch
  epoch: BigInt!
  totalVolume: BigInt!
  totalRewards: BigInt!
  token1Percentage: Int!
}

type TradingMiningEpochVolume @entity {
  id: Bytes! # trading mining address + trader address + epoch
  epoch: BigInt!
  volume: BigInt!
  trader: Account!  
}

type TotalSupplyHourData @entity {
  # token address concatendated with date
  id: Bytes!
  # unix timestamp for start of hour
  periodStartUnix: Int!
  # pointer to token
  token: ERC20Token!
  minted: BigInt!
  burnt: BigInt!
  open: BigInt!
  high: BigInt!
  low: BigInt!
  close: BigInt!
}

type MarketHourData @entity {
  # market address concatendated with date
  id: Bytes!
  # unix timestamp for start of hour
  periodStartUnix: Int!
  # pointer to market
  market: Market!
  minted: BigInt!
  burnt: BigInt!
  # positive means net minting | negative means net burning
  totalMint: BigInt!
  # positive means net minting | negative means net burning
  accumulatedTotalMint: BigInt!
  volume: BigInt!
  oiLong: BigInt!
  oiShort: BigInt!
  fundingRate: BigInt!
}

type ERC1155TokenBalance @entity {
  id: Bytes! # contract address + tokenId + owner
  owner: Account!
  token: ERC1155Token!
  amount: BigInt!
  burnt: BigInt!
}

type ERC1155Token @entity {
  id: Bytes! # contract address + tokenId
  address: String!
  tokenId: BigInt!
  totalSupply: BigInt!
  totalBurnt: BigInt!
  tokenUri: String!
}

type ERC1155Transfer @entity {
  id: Bytes! # transaction hash + log index + index of transaction in a batch
  token: ERC1155Token!
  from: Account!
  to: Account!
  amount: BigInt!
  transaction: Transaction!
}