schema.graphql

type OptionType @entity {
  # OptionId
  id: ID!

  # Position
  underlyingAsset: Token!
  underlyingAmount: BigInt!
  exerciseAsset: Token!
  exerciseAmount: BigInt!

  # Exercisable Window
  exerciseTimestamp: BigInt!
  expiryTimestamp: BigInt!

  # The address that created the newOptionType
  creator: Account!
  # The transaction for the creation of the newOptionType
  createTx: Transaction!

  # The amount of ERC-1155 options written for this OptionType
  amountWritten: BigInt!
  # The amount of ERC-1155 options exercised for this OptionType
  amountExercised: BigInt!

  # Claims which collateralize this type of option
  claims: [Claim!]! @derivedFrom(field: "optionType")

  # The exercise assignment buckets for this OptionType
  buckets: [OptionTypeBucket!]! @derivedFrom(field: "optionType")
}

type Claim @entity {
  # ClaimId
  id: ID!

  # The OptionType the Claim belongs to
  optionType: OptionType!

  # The address that wrote the claim
  writer: Account!
  # The write transaction
  writeTx: Transaction!

  # Whether or not claim has been redeemed
  redeemed: Boolean!
  # Optional: The address that redeemed the claim
  redeemer: Account
  # Optional: The redeem transaction
  redeemTx: Transaction

  # The total number of fungible ERC-1155 Options that this claim corresponds to
  amountWritten: BigInt!
  # The amount of ERC-1155 options assigned exercise for this claim
  amountExercised: BigInt!

  # The bucket(s) that this claim is assigned to
  claimBuckets: [ClaimBucket!]!
}

type OptionTypeBucket @entity {
  # The optionId + index of bucket
  # `{optionId}-{bucketIndex}`
  id: ID!

  # The OptionType the bucket belongs to
  optionType: OptionType!
  # The corresponding claimBucket(s) for this optionTypeBucket
  claimBuckets: [ClaimBucket!]!

  # The total amount of ERC-1155 options written for this optionTypeBucket
  amountWritten: BigInt!
  # The total amount of ERC-1155 options assigned exercise for this optionTypeBucket
  amountExercised: BigInt!
}

type ClaimBucket @entity {
  # The claimId + OptionTypeBucketId
  # `{claimId}-{optionTypeBucketId}`
  id: ID!

  # The Claim the bucket belongs to
  claim: Claim!
  # The corresponding optionTypeBucket
  optionTypeBucket: OptionTypeBucket!

  # The total amount of ERC-1155 options written for this claimBucket
  amountWritten: BigInt!
  # The total amount of ERC-1155 options assigned exercise for this claimBucket
  amountExercised: BigInt!
}

type DecimalValue @entity {
  id: ID!
  value: BigDecimal!
  exact: BigInt!
  decimals: Int!
}

type DayData @entity {
  # Timestamp of day at 00:00AM UTC
  id: ID!
  # Timestamp of day at 00:00AM UTC
  date: Int!

  # TVL in USD
  totalValueLockedUSD: BigDecimal!

  # Notional Volumes in USD
  notionalVolWrittenUSD: BigDecimal! # Underlying Asset written
  notionalVolExercisedUSD: BigDecimal! # Exercise Asset exercised for Options
  notionalVolRedeemedUSD: BigDecimal! # Underlying and/or Exercise Asset redeemed from Claims
  notionalVolTransferredUSD: BigDecimal! # Claim Transferred: Current Underlying and/or Exercise Asset; Option Transferred: Underlying Asset
  notionalVolSettledUSD: BigDecimal! # Fee Earning Volume; Written + Exercised
  notionalVolCoreSumUSD: BigDecimal! # Written + Exercised + Redeemed + Transferred
  volFeesAccruedUSD: BigDecimal!
  volFeesSweptUSD: BigDecimal!

  # ValoremOptionsClearinghouse pointer
  och: ValoremOptionsClearinghouse!
  # Metrics for each Token on same day
  tokenDayData: [TokenDayData!]! @derivedFrom(field: "dayData")
}

type Token @entity {
  # Token Address
  id: ID!

  # Token Info
  symbol: String!
  name: String!
  decimals: Int!

  # Total number of tokens in the OCH
  totalValueLocked: BigInt!

  # Amount of tokens that are ready to be swept as fees
  feeBalance: BigInt!
  # Lifetime sum of tokens paid to Valorem as fees
  feesAccrued: BigInt!

  # Daily metrics (tvl, volume, etc) for the token
  tokenDayData: [TokenDayData!]! @derivedFrom(field: "token")
}

type TokenDayData @entity {
  # Token Address + Timestamp of day at 00:00AM UTC
  id: ID!
  # Timestamp of day at 00:00AM UTC
  date: Int!

  # The Token that these metrics belong to
  token: Token!

  # TVL in OCH in token units
  totalValueLocked: BigInt!
  # TVL in OCH in USD
  totalValueLockedUSD: BigDecimal!

  ## Notional Volumes in token units
  notionalVolWritten: BigInt! # Underlying Asset written
  notionalVolExercised: BigInt! # Exercise Asset exercised for Options
  notionalVolRedeemed: BigInt! # Underlying and/or Exercise Asset redeemed from Claims
  notionalVolTransferred: BigInt! # Claim Transferred: Current Underlying and/or Exercise Asset; Option Transferred: Underlying Asset
  notionalVolSettled: BigInt! # Fee Earning Volume; Written + Exercised
  notionalVolCoreSum: BigInt! # Written + Exercised + Redeemed + Transferred
  volFeesAccrued: BigInt!
  volFeesSwept: BigInt!

  ## Notional Volumes in USD
  notionalVolWrittenUSD: BigDecimal!
  notionalVolExercisedUSD: BigDecimal!
  notionalVolRedeemedUSD: BigDecimal!
  notionalVolTransferredUSD: BigDecimal!
  notionalVolSettledUSD: BigDecimal!
  notionalVolCoreSumUSD: BigDecimal!
  volFeesAccruedUSD: BigDecimal!
  volFeesSweptUSD: BigDecimal!

  # Pointer to DayData for same day
  dayData: DayData!
}

type ValoremOptionsClearinghouse @entity {
  # ValoremOptionsClearinghouse contract address
  id: ID!

  # Whether or not fees for protocol are enabled
  feesEnabled: Boolean!
  # The address of the recipient of protocol fees
  feeToAddress: Account!

  # Daily metrics
  historicalDayData: [DayData!]! @derivedFrom(field: "och")
}

#######
# The following types/entities are credited to https://github.com/OpenZeppelin/openzeppelin-subgraphs
# Included under MIT License
# Extended to support Valorem
#######
type Account @entity {
  id: ID!
  asERC1155: ERC1155Contract
  ERC1155balances: [ERC1155Balance!]! @derivedFrom(field: "account")
  ERC1155operatorOwner: [ERC1155Operator!]! @derivedFrom(field: "owner")
  ERC1155operatorOperator: [ERC1155Operator!]! @derivedFrom(field: "operator")
  ERC1155transferFromEvent: [ERC1155Transfer!]! @derivedFrom(field: "from")
  ERC1155transferToEvent: [ERC1155Transfer!]! @derivedFrom(field: "to")
  ERC1155transferOperatorEvent: [ERC1155Transfer!]!
    @derivedFrom(field: "operator")
  events: [Event!]! @derivedFrom(field: "emitter")
}

type ERC1155Contract @entity(immutable: true) {
  id: ID!
  asAccount: Account!
  tokens: [ERC1155Token!]! @derivedFrom(field: "contract")
  balances: [ERC1155Balance!]! @derivedFrom(field: "contract")
  operators: [ERC1155Operator!]! @derivedFrom(field: "contract")
  transfers: [ERC1155Transfer!]! @derivedFrom(field: "contract")
}

type ERC1155Token @entity {
  id: ID!
  contract: ERC1155Contract!
  identifier: BigInt!
  uri: String
  totalSupply: ERC1155Balance!
  balances: [ERC1155Balance!]! @derivedFrom(field: "token")
  transfers: [ERC1155Transfer!]! @derivedFrom(field: "token")

  ## Valorem extended ERC-1155Token attributes
  # 1 = Option; 2 = Claim
  type: Int
  # The OptionId if (type == 1)
  optionType: OptionType
  # The ClaimId if (type == 2)
  claim: Claim
}

type ERC1155Balance @entity {
  id: ID!
  contract: ERC1155Contract!
  token: ERC1155Token!
  account: Account
  value: BigDecimal!
  valueExact: BigInt!
  transferFromEvent: [ERC1155Transfer!]! @derivedFrom(field: "fromBalance")
  transferToEvent: [ERC1155Transfer!]! @derivedFrom(field: "toBalance")
}

type ERC1155Operator @entity {
  id: ID!
  contract: ERC1155Contract!
  owner: Account!
  operator: Account!
  approved: Boolean!
}

type ERC1155Transfer implements Event @entity(immutable: true) {
  id: ID!
  emitter: Account!
  transaction: Transaction!
  timestamp: BigInt!
  contract: ERC1155Contract!
  token: ERC1155Token!
  operator: Account!
  from: Account
  fromBalance: ERC1155Balance
  to: Account
  toBalance: ERC1155Balance
  value: BigDecimal!
  valueExact: BigInt!
}

interface Event {
  id: ID!
  transaction: Transaction!
  emitter: Account!
  timestamp: BigInt!
}

type Transaction @entity(immutable: true) {
  id: ID!
  timestamp: BigInt!
  blockNumber: BigInt!
  events: [Event!]! @derivedFrom(field: "transaction")
}