schema.graphql

"""
The Comptroller type has protocol level variables stored
"""
type Comptroller @entity {
  "ID is set to 1"
  id: ID!
  "Address of price oracle the comptroller uses"
  priceOracle: Bytes
  "Factor used to determine repayAmount for liquidating"
  closeFactor: BigInt
  "The percent bonus liquidators get for liquidating"
  liquidationIncentive: BigInt

  "Comptroller address"
  address: Bytes!
}

interface MarketInfo {
  
  #Fields that match compounds API
  "The protocol utilization rate with 18 decimal places"
  utilizationRate: BigDecimal!
  "Borrow interest rate for the current timestamp based on utilization rate"
  borrowRatePerTimestamp: BigInt!
  "Yearly borrow rate. With 31536000 seconds per year"
  borrowRateAPY: BigDecimal!
  "The cToken contract balance of ERC20 or ETH"
  cash: BigDecimal!
  "Collateral factor determining how much one can borrow"
  collateralFactor: BigDecimal!
  "Exchange rate of tokens / cTokens"
  exchangeRate: BigDecimal!
  "Address of the interest rate model"
  interestRateModelAddress: Bytes
  "Reserves stored in the contract"
  reserves: BigDecimal
  "Supply interest rate for the current timestamp based on utilization rate"
  supplyRatePerTimestamp: BigInt!
  "Yearly supply rate. With 2104400 blocks per year"
  supplyRateAPY: BigDecimal
  "Borrows in the market"
  totalBorrows: BigDecimal!
  "CToken supply. CTokens have 8 decimals"
  totalSupply: BigDecimal!
  "Number of users holding market tokens"
  suppliersCount: Int!
  "Number of users with pending borrows"
  borrowersCount: Int!
  "Underlying price of token in ETH (ex. 0.007 DAI)"
  underlyingPrice: BigDecimal!

  # Fields that are not in compounds api
  "Block timestamp the market is updated to"
  accrualBlockTimestamp: BigInt
  "Timestamp the market was most recently updated"
  blockTimestamp: BigInt!
  "The history of the markets borrow index return (Think S&P 500)"
  borrowIndex: BigDecimal!
  "The factor determining interest that goes to reserves"
  reserveFactor: BigDecimal!
  "Underlying token price in USD"
  underlyingPriceUSD: BigDecimal!
}

"""
Market stores all high level variables for a cToken market
"""
type Market implements MarketInfo @entity {
  "CToken address"
  id: ID!
  
  ### INTERFACE FIELDS
  #Fields that match compounds API
  "The protocol utilization rate with 18 decimal places"
  utilizationRate: BigDecimal!
  "Borrow interest rate for the current timestamp based on utilization rate"
  borrowRatePerTimestamp: BigInt!
  "Yearly borrow rate. With 31536000 seconds per year"
  borrowRateAPY: BigDecimal!
  "The cToken contract balance of ERC20 or ETH"
  cash: BigDecimal!
  "Collateral factor determining how much one can borrow"
  collateralFactor: BigDecimal!
  "Exchange rate of tokens / cTokens"
  exchangeRate: BigDecimal!
  "Address of the interest rate model"
  interestRateModelAddress: Bytes
  "Reserves stored in the contract"
  reserves: BigDecimal
  "Supply interest rate for the current timestamp based on utilization rate"
  supplyRatePerTimestamp: BigInt!
  "Yearly supply rate. With 2104400 blocks per year"
  supplyRateAPY: BigDecimal
  "Borrows in the market"
  totalBorrows: BigDecimal!
  "CToken supply. CTokens have 8 decimals"
  totalSupply: BigDecimal!
  "Number of users holding market tokens"
  suppliersCount: Int!
  "Number of users with pending borrows"
  borrowersCount: Int!
  "Underlying price of token in ETH (ex. 0.007 DAI)"
  underlyingPrice: BigDecimal!

  # Fields that are not in compounds api
  "Block the market is updated to"
  accrualBlockTimestamp: BigInt
  "Timestamp the market was most recently updated"
  blockTimestamp: BigInt!
  "The history of the markets borrow index return (Think S&P 500)"
  borrowIndex: BigDecimal!
  "The factor determining interest that goes to reserves"
  reserveFactor: BigDecimal!
  "Underlying token price in USD"
  underlyingPriceUSD: BigDecimal!

  ### END OF INTERFACE FIELDS

  #Fields that match compounds API
  "Name of the cToken"
  name: String!
  "CToken symbol"
  symbol: String!
  "Underlying token name"
  underlyingName: String!
  "Underlying token symbol"
  underlyingSymbol: String!

  # Fields that are not in compounds api
  "Underlying token decimal length"
  underlyingDecimals: Int!

  "Accounts that have interacted with this market"
  accounts: [AccountCToken!]! @derivedFrom(field: "market")

  marketEvents: [AccountCTokenEvent!]! @derivedFrom(field: "market")

  # @yhayun - added specifically for benqi:
  "Underlying token"
  denomination: Token

  hourlySnapshots: [MarketHourlySnapshot!]! @derivedFrom(field: "market")
  dailySnapshots: [MarketDailySnapshot!]! @derivedFrom(field: "market")
}

"""
Saves the historical values in the Market over time for every beginning of hour in UTC.
Basically a copy of the market values in that particular moment
"""
type MarketHourlySnapshot implements MarketInfo @entity {
  "The id is marketId-timestamp"
  id: ID!
  market: Market!
  "UTC timestamp for the beginning of the hour (ex.: timestamp for 01:00:00, 14:00:00, ...)"
  timestamp: BigInt!
  lastBlockNumber: BigInt!
  lastBlockHash: Bytes!

  ### INTERFACE FIELDS
  #Fields that match compounds API
  "The protocol utilization rate with 18 decimal places"
  utilizationRate: BigDecimal!
  "Borrow interest rate for the current timestamp based on utilization rate"
  borrowRatePerTimestamp: BigInt!
  "Yearly borrow rate. With 31536000 seconds per year"
  borrowRateAPY: BigDecimal!
  "The cToken contract balance of ERC20 or ETH"
  cash: BigDecimal!
  "Collateral factor determining how much one can borrow"
  collateralFactor: BigDecimal!
  "Exchange rate of tokens / cTokens"
  exchangeRate: BigDecimal!
  "Address of the interest rate model"
  interestRateModelAddress: Bytes
  "Reserves stored in the contract"
  reserves: BigDecimal
  "Supply interest rate for the current timestamp based on utilization rate"
  supplyRatePerTimestamp: BigInt!
  "Yearly supply rate. With 2104400 blocks per year"
  supplyRateAPY: BigDecimal
  "Borrows in the market"
  totalBorrows: BigDecimal!
  "CToken supply. CTokens have 8 decimals"
  totalSupply: BigDecimal!
  "Number of users holding market tokens"
  suppliersCount: Int!
  "Number of users with pending borrows"
  borrowersCount: Int!
  "Underlying price of token in ETH (ex. 0.007 DAI)"
  underlyingPrice: BigDecimal!

  # Fields that are not in compounds api
  "Block the market is updated to"
  accrualBlockTimestamp: BigInt
  "Timestamp the market was most recently updated"
  blockTimestamp: BigInt!
  "The history of the markets borrow index return (Think S&P 500)"
  borrowIndex: BigDecimal!
  "The factor determining interest that goes to reserves"
  reserveFactor: BigDecimal!
  "Underlying token price in USD"
  underlyingPriceUSD: BigDecimal!

  ### END OF INTERFACE FIELDS
}

"""
Saves the historical values in the Market over time for every beginning of a day in UTC.
Basically a copy of the market values in that particular moment
"""
type MarketDailySnapshot implements MarketInfo @entity {
  "The id is marketId-timestamp"
  id: ID!
  market: Market!
  "UTC timestamp for the beginning of the day (ex.: timestamp for Day 1 00:00:00, Day 2 00:00:00, ...)"
  timestamp: BigInt!
  lastBlockNumber: BigInt!
  lastBlockHash: Bytes!

  ### INTERFACE FIELDS
  #Fields that match compounds API
  "The protocol utilization rate with 18 decimal places"
  utilizationRate: BigDecimal!
  "Borrow interest rate for the current timestamp based on utilization rate"
  borrowRatePerTimestamp: BigInt!
  "Yearly borrow rate. With 31536000 seconds per year"
  borrowRateAPY: BigDecimal!
  "The cToken contract balance of ERC20 or ETH"
  cash: BigDecimal!
  "Collateral factor determining how much one can borrow"
  collateralFactor: BigDecimal!
  "Exchange rate of tokens / cTokens"
  exchangeRate: BigDecimal!
  "Address of the interest rate model"
  interestRateModelAddress: Bytes
  "Reserves stored in the contract"
  reserves: BigDecimal
  "Supply interest rate for the current timestamp based on utilization rate"
  supplyRatePerTimestamp: BigInt!
  "Yearly supply rate. With 2104400 blocks per year"
  supplyRateAPY: BigDecimal
  "Borrows in the market"
  totalBorrows: BigDecimal!
  "CToken supply. CTokens have 8 decimals"
  totalSupply: BigDecimal!
  "Number of users holding market tokens"
  suppliersCount: Int!
  "Number of users with pending borrows"
  borrowersCount: Int!
  "Underlying price of token in ETH (ex. 0.007 DAI)"
  underlyingPrice: BigDecimal!

  # Fields that are not in compounds api
  "Block the market is updated to"
  accrualBlockTimestamp: BigInt
  "Timestamp the market was most recently updated"
  blockTimestamp: BigInt!
  "The history of the markets borrow index return (Think S&P 500)"
  borrowIndex: BigDecimal!
  "The factor determining interest that goes to reserves"
  reserveFactor: BigDecimal!
  "Underlying token price in USD"
  underlyingPriceUSD: BigDecimal!

  ### END OF INTERFACE FIELDS
}

type AccountMarketSnapshot @entity {
  "AccountId-MarketId"
  id: ID!
  accountMarket: AccountCToken!
  accrualBlockTimestamp: BigInt
  blockNumber: BigInt!
  timestamp: BigInt!
  totalSupplyAmount: BigDecimal!
  storedBorrowBalance: BigDecimal!
  borrowBalanceWithInterest: BigDecimal!
  marketBorrowIndex: BigDecimal!
  accountBorrowIndex: BigDecimal!
  exchangeRate: BigDecimal!
}

"""
Account is an ETH address, with a list of all cToken markets the account has
participated in, along with liquidation information.
"""
type Account @entity {
  "User ETH address"
  id: ID!
  "Array of CTokens user is in"
  tokens: [AccountCToken!]! @derivedFrom(field: "account")
  "Count user has been liquidated"
  countLiquidated: Int!
  "Count user has liquidated others"
  countLiquidator: Int!
  "True if user has ever borrowed"
  hasBorrowed: Boolean!

  accountEvents: [AccountCTokenEvent!]! @derivedFrom(field: "account")

  # The following values are added by the JS Wrapper, and must be calculated with the most up
  # to date values based on the block delta for market.exchangeRate and market.borrowIndex
  # They do not need to be in the schema, but they will show up in the explorer playground

  # "If less than 1, the account can be liquidated
  # health: BigDecimal!
  # "Total assets supplied by user"
  # totalBorrowValueInEth: BigDecimal!
  # "Total assets borrowed from user"
  # totalCollateralValueInEth: BigDecimal!
}

"""
AccountCToken is a single account within a single cToken market, with data such
as interest earned or paid
"""
type AccountCToken @entity {
  "Concatenation of CToken address and user address"
  id: ID!
  "Relation to market"
  market: Market!
  "Symbol of the cToken"
  symbol: String!
  "Relation to user"
  account: Account!
  "Block number this asset was updated at in the contract"
  accrualBlockTimestamp: BigInt!
  "True if user is entered, false if they are exited"
  enteredMarket: Boolean!

  "CToken balance of the user"
  cTokenBalance: BigDecimal!
  "Total amount of underlying supplied"
  totalUnderlyingSupplied: BigDecimal!
  "Total amount of underling redeemed"
  totalUnderlyingRedeemed: BigDecimal!
  "The value of the borrow index upon users last interaction"
  accountBorrowIndex: BigDecimal!
  "Total amount underlying borrowed, exclusive of interest"
  totalUnderlyingBorrowed: BigDecimal!
  "Total amount underlying repaid"
  totalUnderlyingRepaid: BigDecimal!
  "Current borrow balance stored in contract (exclusive of interest since accrualBlockTimestamp)"
  storedBorrowBalance: BigDecimal!

  "Historical snapshots for this Account-Market association"
  snapshots: [AccountMarketSnapshot!]! @derivedFrom(field: "accountMarket")

  tokenEvents: [AccountCTokenEvent!]! @derivedFrom(field: "accountCToken")

  # The following values are added by the JS Wrapper, and must be calculated with the most up
  # to date values based on the block delta for market.exchangeRate and market.borrowIndex
  # They do not need to be in the schema, but they will show up in the explorer playground
  # NOTE: this a custom feature that The Graph implemented for our subgraph. It's not yet
  # available to the public.

  # supplyBalanceUnderlying: BigDecimal!
  # FORMULA: supplyBalanceUnderlying = cTokenBalance * market.exchangeRate

  # lifetimeSupplyInterestAccrued: BigDecimal!
  # FORMULA: lifetimeSupplyInterestAccrued = supplyBalanceUnderlying - totalUnderlyingSupplied + totalUnderlyingRedeemed

  # borrowBalanceUnderlying: BigDecimal!
  # FORMULA: borrowBalanceUnderlying = storedBorrowBalance * market.borrowIndex / accountBorrowIndex

  # lifetimeBorrowInterestAccrued: BigDecimal!
  # FORMULA: lifetimeBorrowInterestAccrued = borrowBalanceUnderlying - totalUnderlyingBorrowed + totalUnderlyingRepaid
}

"""
Relationship entity to map between events with Account and Market entities
"""
type AccountCTokenEvent @entity(immutable: true) {
  "AccountCToken id concatenated with event id"
  id: ID!
  account: Account!
  market: Market!
  event: CTokenEvent!
  "This is redundant with the other two, but allows us to add a relation in the AccountCToken entity as well"
  accountCToken: AccountCToken!
}

"""
Types of CTokenEvents
"""
enum CTokenEventType {
  Transfer
  Mint
  Redeem
  Borrow
  RepayBorrow
  Liquidation
  MarketEntered
  MarketExited
}

"""
An interface for an event of any cToken. TransferEvent, MintEvent,
RedeemEvent, BorrowEvent, RepayEvent, MarketEnteredEvent, MarketExitedEvent and LiquidationEvent all use this interface
"""
interface CTokenEvent {
  "Transaction hash concatenated with log index"
  id: ID!
  "Type of the specific transfer"
  type: CTokenEventType!
  "The tx_hash that contains this event"
  tx_hash: Bytes!
  "The index of the associated log inside the transaction that corresponds to this event"
  logIndex: BigInt!
  "Block number"
  blockNumber: BigInt!
  "Block time"
  blockTime: BigInt!
}

"""
TransferEvent will be stored for every mint, redeem, liquidation, and any normal
transfer between two accounts.
"""
type TransferEvent implements CTokenEvent @entity(immutable: true) {
  "Transaction hash concatenated with log index"
  id: ID!
  "Type of the specific transfer"
  type: CTokenEventType!
  "The tx_hash that contains this event"
  tx_hash: Bytes!
  "The index of the associated log inside the transaction that corresponds to this event"
  logIndex: BigInt!
  "The cToken transferred"
  market: Market!
  "Account that received tokens"
  to: Account
  "Account that sent tokens"
  from: Account
  "cTokens transferred"
  amount: BigDecimal!
  "Block number"
  blockNumber: BigInt!
  "Block time"
  blockTime: BigInt!
}

"""
MintEvent stores information for mints. From address will always be a cToken
market address
"""
type MintEvent implements CTokenEvent @entity(immutable: true) {
  "Transaction hash concatenated with log index"
  id: ID!
  "Type of the specific transfer"
  type: CTokenEventType!
  "The tx_hash that contains this event"
  tx_hash: Bytes!
  "The index of the associated log inside the transaction that corresponds to this event"
  logIndex: BigInt!
  "The cToken transferred"
  market: Market!
  "Account that received tokens (minter)"
  user: Account!
  "cTokens transferred"
  amount: BigDecimal!
  "Underlying token amount transferred"
  underlyingAmount: BigDecimal
  "Block number"
  blockNumber: BigInt!
  "Block time"
  blockTime: BigInt!
}

"""
RedeemEvent stores information for redeems. To address will always be a
cToken market address
"""
type RedeemEvent implements CTokenEvent @entity(immutable: true) {
  "Transaction hash concatenated with log index"
  id: ID!
  "Type of the specific transfer"
  type: CTokenEventType!
  "The tx_hash that contains this event"
  tx_hash: Bytes!
  "The index of the associated log inside the transaction that corresponds to this event"
  logIndex: BigInt!
  "The cToken transferred"
  market: Market!
  "Account that sent tokens (redeemer)"
  user: Account!
  "cTokens transferred"
  amount: BigDecimal!
  "Underlying token amount transferred"
  underlyingAmount: BigDecimal
  "Block number"
  blockNumber: BigInt!
  "Block time"
  blockTime: BigInt!
}

"""
LiquidationEvent stores information for liquidations. The event is emitted from
the cToken market address.
"""
type LiquidationEvent implements CTokenEvent @entity(immutable: true) {
  "Transaction hash concatenated with log index"
  id: ID!
  "Type of the specific transfer"
  type: CTokenEventType!
  "The tx_hash that contains this event"
  tx_hash: Bytes!
  "The index of the associated log inside the transaction that corresponds to this event"
  logIndex: BigInt!
  "cToken that was seized as collateral"
  seizedMarket: Market!
  "The cToken that was repaid during this liquidation"
  repayMarket: Market!
  "Liquidator receiving tokens"
  liquidator: Account!
  "Account being liquidated (borrower)"
  borrower: Account!
  "cTokens seized"
  seizedTokens: BigDecimal!
  "Symbol of the underlying asset repaid through liquidation"
  underlyingSymbol: String!
  "Underlying cToken amount that was repaid by liquidator"
  underlyingRepayAmount: BigDecimal!
  "Block number"
  blockNumber: BigInt!
  "Block time"
  blockTime: BigInt!
}

"""
BorrowEvent stores information for borrows
"""
type BorrowEvent implements CTokenEvent @entity(immutable: true) {
  "Transaction hash concatenated with log index"
  id: ID!
  "Specific type of the implementation"
  type: CTokenEventType!
  "The tx_hash that contains this event"
  tx_hash: Bytes!
  "The index of the associated log inside the transaction that corresponds to this event"
  logIndex: BigInt!
  "Market from which the token is being borrowed"
  market: Market!
  "Account that borrowed the tokens"
  borrower: Account!
  "Amount of underlying borrowed"
  amount: BigDecimal!
  "Total borrows of this asset the account has"
  accountBorrows: BigDecimal!
  "Symbol of the borrowed underlying asset"
  underlyingSymbol: String!
  "Block number"
  blockNumber: BigInt!
  "Block time"
  blockTime: BigInt!
}

"""
RepayEvent stores information for repays. Payer is not always the same as
borrower, such as in the event of a Liquidation
"""
type RepayEvent implements CTokenEvent @entity(immutable: true) {
  "Transaction hash concatenated with log index"
  id: ID!
  "Specific type of the implementation"
  type: CTokenEventType!
  "The tx_hash that contains this event"
  tx_hash: Bytes!
  "The index of the associated log inside the transaction that corresponds to this event"
  logIndex: BigInt!
  "Market to which the token is being repaid"
  market: Market!
  "Account that borrowed the tokens"
  borrower: Account!
  "Payer of the borrow funds"
  payer: Account!
  "Amount of underlying repaid"
  amount: BigDecimal!
  "Total borrows of this asset the account has"
  accountBorrows: BigDecimal!
  "Symbol of the borrowed underlying asset"
  underlyingSymbol: String!
  "Block number"
  blockNumber: BigInt!
  "Block time"
  blockTime: BigInt!
}

"""
MarketEnteredEvent stores information for markets activated as collateral.
"""
type MarketEnteredEvent implements CTokenEvent @entity(immutable: true) {
  "Transaction hash concatenated with log index"
  id: ID!
  "Specific type of the implementation"
  type: CTokenEventType!
  "The tx_hash that contains this event"
  tx_hash: Bytes!
  "The index of the associated log inside the transaction that corresponds to this event"
  logIndex: BigInt!
  "Market to which the token is being repaid"
  market: Market!
  "Account that borrowed the tokens"
  account: Account!
  "Block number"
  blockNumber: BigInt!
  "Block time"
  blockTime: BigInt!
}

"""
MarketExitedEvent stores information for markets deactivated as collateral.
"""
type MarketExitedEvent implements CTokenEvent @entity(immutable: true) {
  "Transaction hash concatenated with log index"
  id: ID!
  "Specific type of the implementation"
  type: CTokenEventType!
  "The tx_hash that contains this event"
  tx_hash: Bytes!
  "The index of the associated log inside the transaction that corresponds to this event"
  logIndex: BigInt!
  "Market to which the token is being repaid"
  market: Market!
  "Account that borrowed the tokens"
  account: Account!
  "Block number"
  blockNumber: BigInt!
  "Block time"
  blockTime: BigInt!
}

type Token @entity(immutable: true) {
  "Token address"
  id: ID!

  "Token address"
  address: Bytes!

  "Token name"
  name: String

  "Token symbol"
  symbol: String

  "Token decimals"
  decimals: Int

  "Token's total supply"
  totalSupply: BigInt
}