schema.template.graphql

interface Account {
  id: ID! # ethereum address
  internalBalances: [TokenInternalBalance!]! @derivedFrom(field: "account")
  withdrawals: [TokenWithdrawal!]! @derivedFrom(field: "account")
  accountEvents: [AccountEvent!]! @derivedFrom(field: "account")
  createdBlock: Int!
  latestBlock: Int!
  latestActivity: BigInt!

  # Deprecated
  upstream: [Recipient!] @derivedFrom(field: "account")
}

type Token @entity {
  id: ID! # ethereum address
  internalBalances: [TokenInternalBalance!]! @derivedFrom(field: "token")
  withdrawals: [TokenWithdrawal!]! @derivedFrom(field: "token")
}

interface TokenBalance {
  id: ID! # ${prefix}-${accountId}-${tokenId}
  amount: BigInt!
  token: Token!
  account: Account!
}

type TokenInternalBalance implements TokenBalance @entity {
  id: ID! # ib-${accountId}-${tokenId}
  amount: BigInt!
  token: Token!
  account: Account!
}

type TokenWithdrawal implements TokenBalance @entity {
  id: ID! # w-${accountId}-${tokenId}
  amount: BigInt!
  token: Token!
  account: Account!
}

type User implements Account @entity {
  id: ID! # ethereum address
  internalBalances: [TokenInternalBalance!]! @derivedFrom(field: "account")
  withdrawals: [TokenWithdrawal!]! @derivedFrom(field: "account")
  accountEvents: [AccountEvent!]! @derivedFrom(field: "account")
  createdBlock: Int!
  latestBlock: Int!
  latestActivity: BigInt!

  # Deprecated
  upstream: [Recipient!] @derivedFrom(field: "account")
}

type Split implements Account @entity {
  id: ID! # ethereum address
  internalBalances: [TokenInternalBalance!]! @derivedFrom(field: "account")
  withdrawals: [TokenWithdrawal!]! @derivedFrom(field: "account")
  accountEvents: [AccountEvent!]! @derivedFrom(field: "account")
  createdBlock: Int!
  latestBlock: Int!
  latestActivity: BigInt!

  controller: Bytes!
  newPotentialController: Bytes!
  distributorFee: BigInt!
  # can't use derived relations inside mapping.ts
  # recipients: [Recipient!]! @derivedFrom(field: "split")
  recipients: [Recipient!]!

  liquidSplit: LiquidSplit @derivedFrom(field: "split")

  # Deprecated
  upstream: [Recipient!] @derivedFrom(field: "account")
  vestingModules: [VestingModule!] @derivedFrom(field: "beneficiary")
}

type Recipient @entity {
  id: ID! # ${splitId}-${accountId}
  split: Split!
  account: Account!
  ownership: BigInt!
}

type VestingModule implements Account @entity {
  id: ID! # ethereum address
  internalBalances: [TokenInternalBalance!]! @derivedFrom(field: "account")
  withdrawals: [TokenWithdrawal!]! @derivedFrom(field: "account")
  accountEvents: [AccountEvent!]! @derivedFrom(field: "account")
  createdBlock: Int!
  latestBlock: Int!
  latestActivity: BigInt!
  
  vestingPeriod: BigInt!
  beneficiary: Split!
  streams: [VestingStream!] @derivedFrom(field: "account")

  # Deprecated
  upstream: [Recipient!] @derivedFrom(field: "account")
}

type VestingStream @entity {
  id: ID! # ${vestingId}-${streamId}
  streamId: BigInt!
  token: Token!
  totalAmount: BigInt!
  startTime: BigInt!
  account: VestingModule!

  claimedAmount: BigInt!
}

type WaterfallModule implements Account @entity {
  id: ID! # ethereum address
  internalBalances: [TokenInternalBalance!]! @derivedFrom(field: "account")
  withdrawals: [TokenWithdrawal!]! @derivedFrom(field: "account")
  accountEvents: [AccountEvent!]! @derivedFrom(field: "account")
  createdBlock: Int!
  latestBlock: Int!
  latestActivity: BigInt!

  token: Token!
  tranches: [WaterfallTranche!] @derivedFrom(field: "account")
  nonWaterfallRecipient: Bytes!
  totalClaimedAmount: BigInt!

  # Deprecated
  upstream: [Recipient!] @derivedFrom(field: "account")
}

type WaterfallTranche @entity {
  id: ID! #${waterfallId}-${trancheId}
  account: WaterfallModule!
  startAmount: BigInt!
  size: BigInt # optional because the residual has no size
  claimedAmount: BigInt!
  recipient: Account!
}

type LiquidSplit implements Account @entity {
  id: ID! # ethereum address
  internalBalances: [TokenInternalBalance!]! @derivedFrom(field: "account")
  withdrawals: [TokenWithdrawal!]! @derivedFrom(field: "account")
  accountEvents: [AccountEvent!]! @derivedFrom(field: "account")
  createdBlock: Int!
  latestBlock: Int!
  latestActivity: BigInt!

  distributorFee: BigInt!
  holders: [Holder!]! @derivedFrom(field: "liquidSplit")
  split: Split!
  isFactoryGenerated: Boolean!

  # Deprecated
  upstream: [Recipient!] @derivedFrom(field: "account")
}

type Holder @entity {
  id: ID! # ${splitId}-${accountId}
  liquidSplit: LiquidSplit!
  account: Account!
  ownership: BigInt!
}

type Transaction @entity {
  id: ID! #txHash
  # can't use derived relations inside mapping.ts
  # distributionEvents: [DistributionEvent!]! @derivedFrom(field: "transaction")
  distributionEvents: [DistributionEvent!]
  setSplitEvents: [SetSplitEvent!]
}

interface AccountEvent {
  id: ID! # ${prefix}-${txHash}-${logIdx}-${accountId}
  timestamp: BigInt!
  account: Account!
  logIndex: BigInt!
}

enum SetSplitType {
  create
  update
}

type SetSplitEvent implements AccountEvent @entity {
  id: ID! # sse-${txHash}-${logIdx}
  timestamp: BigInt!
  account: Account!
  logIndex: BigInt!

  transaction: Transaction!
  type: SetSplitType

  recipientAddedEvents: [RecipientAddedEvent!] @derivedFrom(field: "setSplitEvent")
  recipientRemovedEvents: [RecipientRemovedEvent!] @derivedFrom(field: "setSplitEvent")
}

type RecipientAddedEvent implements AccountEvent @entity {
  id: ID!
  timestamp: BigInt!
  account: Account!
  logIndex: BigInt!

  setSplitEvent: SetSplitEvent!
}

type RecipientRemovedEvent implements AccountEvent @entity {
  id: ID!
  timestamp: BigInt!
  account: Account!
  logIndex: BigInt!

  setSplitEvent: SetSplitEvent!
}

type DistributionEvent implements AccountEvent @entity {
  id: ID! # de-${txHash}-${logIdx}
  timestamp: BigInt!
  account: Account!
  logIndex: BigInt!

  transaction: Transaction!
  token: Token!
  amount: BigInt!

  receiveDistributionEvents: [ReceiveDistributionEvent!]! @derivedFrom(field: "distributionEvent")
  distributeDistributionEvent: DistributeDistributionEvent @derivedFrom(field: "distributionEvent")
}

type ReceiveDistributionEvent implements AccountEvent @entity {
  id: ID! # r-de-${txHash}-${logIdx}-${accountId}
  timestamp: BigInt!
  account: Account!
  logIndex: BigInt!

  token: Token!
  amount: BigInt!
  distributionEvent: DistributionEvent!
}

type DistributeDistributionEvent implements AccountEvent @entity {
  id: ID! # d-de-${txHash}-${logIdx}-${accountId}
  timestamp: BigInt!
  account: Account!
  logIndex: BigInt!

  token: Token!
  amount: BigInt!
  distributionEvent: DistributionEvent!
}

type WithdrawalEvent implements AccountEvent @entity {
  id: ID! # we-${txHash}-${logIdx}-${accountId}
  timestamp: BigInt!
  account: Account!
  logIndex: BigInt!

  transaction: Transaction!
  tokenWithdrawalEvents: [TokenWithdrawalEvent!]! @derivedFrom(field: "withdrawalEvent")
}

type TokenWithdrawalEvent @entity {
  id: ID! # t-we-${txHash}-${logIdx}-${accountId}-${tokenId}
  token: Token!
  amount: BigInt!
  withdrawalEvent: WithdrawalEvent!
}

enum ControlTransferType {
  initiate
  cancel
  transfer
}

type ControlTransferEvent implements AccountEvent @entity {
  id: ID! # ct-{txHash}-${logIdx}
  timestamp: BigInt!
  account: Account!
  logIndex: BigInt!

  type: ControlTransferType
  transaction: Transaction!
  fromUserEvent: FromUserControlTransferEvent! @derivedFrom(field: "controlTransferEvent")
  toUserEvent: ToUserControlTransferEvent @derivedFrom(field: "controlTransferEvent")
}

type FromUserControlTransferEvent implements AccountEvent @entity {
  id: ID! # fu-ct-{txHash}-${logIdx}-${accountId}
  timestamp: BigInt!
  account: Account!
  logIndex: BigInt!

  controlTransferEvent: ControlTransferEvent!
}

type ToUserControlTransferEvent implements AccountEvent @entity {
  id: ID! # tu-ct-{txHash}-${logIdx}-${accountId}
  timestamp: BigInt!
  account: Account!
  logIndex: BigInt!

  controlTransferEvent: ControlTransferEvent!
}

type CreateVestingModuleEvent implements AccountEvent @entity {
  id: ID! # cvme-${txHash}-${logIdx}
  timestamp: BigInt!
  account: Account!
  logIndex: BigInt!

  transaction: Transaction!
}

type CreateVestingStreamEvent implements AccountEvent @entity {
  id: ID! # cvse-${txHash}-${logIdx}
  timestamp: BigInt!
  account: Account!
  logIndex: BigInt!

  transaction: Transaction!
  token: Token!
  amount: BigInt!
}

type ReleaseVestingFundsEvent implements AccountEvent @entity {
  id: ID!
  timestamp: BigInt!
  account: Account!
  logIndex: BigInt!

  transaction: Transaction!
  token: Token!
  amount: BigInt!
}

type ReceiveVestedFundsEvent implements AccountEvent @entity {
  id: ID!
  timestamp: BigInt!
  account: Account!
  logIndex: BigInt!

  releaseVestingFundsEvent: ReleaseVestingFundsEvent!
}

type CreateWaterfallModuleEvent implements AccountEvent @entity {
  id: ID! # cwme-${txHash}-${logIdx}
  timestamp: BigInt!
  account: Account!
  logIndex: BigInt!

  transaction: Transaction!
  
  recipientAddedEvents: [WaterfallRecipientAddedEvent!] @derivedFrom(field: "createWaterfallEvent")
}

type WaterfallRecipientAddedEvent implements AccountEvent @entity {
  id: ID!
  timestamp: BigInt!
  account: Account!
  logIndex: BigInt!

  createWaterfallEvent: CreateWaterfallModuleEvent!
}

type WaterfallFundsEvent implements AccountEvent @entity {
  id: ID! # wfe-${txHash}-${logIdx}
  timestamp: BigInt!
  account: Account!
  logIndex: BigInt!

  transaction: Transaction!
  amount: BigInt!

  receiveFundsEvents: [ReceiveWaterfallFundsEvent!]! @derivedFrom(field: "waterfallFundsEvent")
}

type ReceiveWaterfallFundsEvent implements AccountEvent @entity {
  id: ID! # r-wfe-${txHash}-${logIdx}-${accountId}
  timestamp: BigInt!
  account: Account!
  logIndex: BigInt!

  amount: BigInt!
  waterfallFundsEvent: WaterfallFundsEvent!
}

type RecoverNonWaterfallFundsEvent implements AccountEvent @entity {
  id: ID! # rnwfe-${txHash}-${logIdx}
  timestamp: BigInt!
  account: Account!
  logIndex: BigInt!

  transaction: Transaction!
  amount: BigInt!
  nonWaterfallToken: Token!

  receiveNonWaterfallFundsEvent: ReceiveNonWaterfallFundsEvent! @derivedFrom(field: "recoverNonWaterfallFundsEvent")
}

type ReceiveNonWaterfallFundsEvent implements AccountEvent @entity {
  id: ID! # r-rnwfe-${txHash}-${logIdx}-${accountId}
  timestamp: BigInt!
  account: Account!
  logIndex: BigInt!

  recoverNonWaterfallFundsEvent: RecoverNonWaterfallFundsEvent!
}

type CreateLiquidSplitEvent implements AccountEvent @entity {
  id: ID! # clse-${txHash}-${logIdx}
  timestamp: BigInt!
  account: Account!
  logIndex: BigInt!

  transaction: Transaction!
}

enum NFTTransferType {
  transfer
  mint
  burn
}

type LiquidSplitNFTTransferEvent implements AccountEvent @entity {
  id: ID! # nte-${txHash}-${logIdx}
  timestamp: BigInt!
  account: Account!
  logIndex: BigInt!

  amount: BigInt # not required right now for non-factory generated liquid splits. Maybe this should be ownership?
  transaction: Transaction!
  transferType: NFTTransferType

  nftAddedEvent: LiquidSplitNFTAddedEvent @derivedFrom(field: "nftTransferEvent")
  nftRemovedEvent: LiquidSplitNFTRemovedEvent @derivedFrom(field: "nftTransferEvent")
}

type LiquidSplitNFTAddedEvent implements AccountEvent @entity {
  id: ID! # add-nte-${txHash}-${logIdx}
  timestamp: BigInt!
  account: Account!
  logIndex: BigInt!

  nftTransferEvent: LiquidSplitNFTTransferEvent!
}

type LiquidSplitNFTRemovedEvent implements AccountEvent @entity {
  id: ID! # rem-nte-${txHash}-${logIdx}
  timestamp: BigInt!
  account: Account!
  logIndex: BigInt!

  nftTransferEvent: LiquidSplitNFTTransferEvent!
}