schema.graphql

# Note: `project.id` is string concatenated from multiple properties. `projectId` represents an integer id of the project.

type ProtocolLog @entity {
  id: ID!
  v1: ProtocolV1Log @derivedFrom(field: "log")
  v2: ProtocolV2Log @derivedFrom(field: "log")
  v3: ProtocolV3Log @derivedFrom(field: "log")

  projectsCount: Int!
  volume: BigInt!
  volumeUSD: BigInt!
  volumeRedeemed: BigInt!
  volumeRedeemedUSD: BigInt!
  paymentsCount: Int!
  redeemCount: Int!
  erc20Count: Int!
  trendingLastUpdatedTimestamp: Int!
  latestInvalidTrendingPayEvent: PayEvent
}

type _Schema_
  @fulltext(
    name: "projectSearch"
    language: en
    algorithm: rank
    include: [{ entity: "Project", fields: [{ name: "handle" }] }]
  )

#############################################################################
############################## shared entities ##############################
#############################################################################

# Note: Events used for v1, v2 and v3 contracts include `pv` (projects version) and `terminal` (terminal address) properties which allows querying events for specific contract versions.

# shared
type ProjectCreateEvent @entity {
  id: ID!
  project: Project!
  projectId: Int!
  pv: String!
  timestamp: Int!
  txHash: Bytes!
  from: Bytes!
  caller: Bytes!
}

# shared
type Project @entity {
  id: ID!
  projectId: Int!
  pv: String!
  handle: String
  metadataUri: String

  # Only v1.x
  terminal: Bytes

  # Only v2 + v3
  metadataDomain: BigInt
  deployer: Bytes

  owner: Bytes!
  creator: Bytes!
  createdAt: Int!
  paymentsCount: Int!
  contributorsCount: Int!
  redeemCount: Int!
  volume: BigInt!
  volumeUSD: BigInt!
  redeemVolume: BigInt!
  redeemVolumeUSD: BigInt!
  currentBalance: BigInt!
  tokenSupply: BigInt!
  trendingScore: BigInt!
  trendingVolume: BigInt!
  trendingPaymentsCount: Int!
  createdWithinTrendingWindow: Boolean
  latestFundingCycle: Int!

  nftsMintedCount: Int! # only if project has jb721DelegateTokens
  # Derived event entities
  addToBalanceEvents: [AddToBalanceEvent!]! @derivedFrom(field: "project")
  burnEvents: [BurnEvent!]! @derivedFrom(field: "project")
  configureEvents: [ConfigureEvent!]! @derivedFrom(field: "project")
  deployedERC20Events: [DeployedERC20Event!]! @derivedFrom(field: "project")
  distributeToPayoutModEvents: [DistributeToPayoutModEvent!]!
    @derivedFrom(field: "project")
  distributePayoutsEvents: [DistributePayoutsEvent!]!
    @derivedFrom(field: "project")
  distributeReservedTokensEvents: [DistributeReservedTokensEvent!]!
    @derivedFrom(field: "project")
  distributeToPayoutSplitEvents: [DistributeToPayoutSplitEvent!]!
    @derivedFrom(field: "project")
  distributeToReservedTokenSplitEvents: [DistributeToReservedTokenSplitEvent!]!
    @derivedFrom(field: "project")
  distributeToTicketModEvents: [DistributeToTicketModEvent!]!
    @derivedFrom(field: "project")
  initEvents: [InitEvent!]! @derivedFrom(field: "project")
  mintTokensEvents: [MintTokensEvent!]! @derivedFrom(field: "project")
  payEvents: [PayEvent!]! @derivedFrom(field: "project")
  printReservesEvents: [PrintReservesEvent!]! @derivedFrom(field: "project")
  projectEvents: [ProjectEvent!]! @derivedFrom(field: "project")
  redeemEvents: [RedeemEvent!]! @derivedFrom(field: "project")
  setFundAccessConstraintsEvents: [SetFundAccessConstraintsEvent!]!
    @derivedFrom(field: "project")
  tapEvents: [TapEvent!]! @derivedFrom(field: "project")
  useAllowanceEvents: [UseAllowanceEvent!]! @derivedFrom(field: "project")
  v1ConfigureEvents: [V1ConfigureEvent!]! @derivedFrom(field: "project")
  v1InitEvents: [V1InitEvent!]! @derivedFrom(field: "project")
  ethErc20ProjectPayers: [ETHERC20ProjectPayer!]! @derivedFrom(field: "project")
  jb721DelegateTokens: [NFT!]! @derivedFrom(field: "project")
  nftCollections: [NFTCollection!]! @derivedFrom(field: "project")
  participants: [Participant!]! @derivedFrom(field: "project")
  migrateEvents: [MigrateEvent!]! @derivedFrom(field: "project")
}

# shared
type Participant @entity {
  id: ID!
  project: Project!
  projectId: Int!
  pv: String!
  address: Bytes!
  wallet: Wallet!
  volume: BigInt!
  volumeUSD: BigInt!
  lastPaidTimestamp: Int!
  paymentsCount: Int!
  balance: BigInt!
  stakedBalance: BigInt!
  erc20Balance: BigInt!
  jb721DelegateTokens: [NFT!]! @derivedFrom(field: "owner")
}

# shared
type Wallet @entity {
  id: ID!
  volume: BigInt!
  volumeUSD: BigInt!
  lastPaidTimestamp: Int!
  participants: [Participant!]! @derivedFrom(field: "wallet")
}

# shared
type ProjectEvent @entity {
  id: ID!
  project: Project!
  projectId: Int!
  pv: String!
  terminal: Bytes # Only terminal events
  timestamp: Int!
  from: Bytes!
  caller: Bytes

  # Conditional properties. Only one of these properties should exist. This is a helper entity that makes it possible to query all "project events" for a project.
  payEvent: PayEvent
  addToBalanceEvent: AddToBalanceEvent
  mintTokensEvent: MintTokensEvent
  tapEvent: TapEvent
  redeemEvent: RedeemEvent
  printReservesEvent: PrintReservesEvent
  distributeToPayoutModEvent: DistributeToPayoutModEvent
  distributeToTicketModEvent: DistributeToTicketModEvent
  deployedERC20Event: DeployedERC20Event
  projectCreateEvent: ProjectCreateEvent
  distributePayoutsEvent: DistributePayoutsEvent
  distributeReservedTokensEvent: DistributeReservedTokensEvent
  distributeToReservedTokenSplitEvent: DistributeToReservedTokenSplitEvent
  distributeToPayoutSplitEvent: DistributeToPayoutSplitEvent
  useAllowanceEvent: UseAllowanceEvent
  deployETHERC20ProjectPayerEvent: DeployETHERC20ProjectPayerEvent
  configureEvent: ConfigureEvent
  initEvent: InitEvent
  v1ConfigureEvent: V1ConfigureEvent
  v1InitEvent: V1InitEvent
  burnEvent: BurnEvent
  setFundAccessConstraintsEvent: SetFundAccessConstraintsEvent
  migrateEvent: MigrateEvent
}

# shared
type PayEvent @entity {
  id: ID!
  project: Project!
  projectId: Int!
  pv: String!
  terminal: Bytes!
  timestamp: Int!
  txHash: Bytes!
  from: Bytes!
  caller: Bytes!

  isDistribution: Boolean!
  distributionFromProjectId: Int
  beneficiary: Bytes!
  amount: BigInt!
  amountUSD: BigInt
  note: String!
  feeFromV2Project: Int # Indicates payment is a fee from project with this ID
}

# shared
type AddToBalanceEvent @entity {
  id: ID!
  project: Project!
  projectId: Int!
  pv: String!
  terminal: Bytes!
  timestamp: Int!
  txHash: Bytes!
  from: Bytes!
  caller: Bytes!

  amount: BigInt!
  amountUSD: BigInt
  note: String
}

# shared
type MintTokensEvent @entity {
  id: ID!
  project: Project!
  projectId: Int!
  pv: String!
  timestamp: Int!
  txHash: Bytes!
  from: Bytes!
  caller: Bytes!

  beneficiary: Bytes!
  amount: BigInt!
  memo: String!
}

# shared
type RedeemEvent @entity {
  id: ID!
  project: Project!
  projectId: Int!
  pv: String!
  terminal: Bytes!
  timestamp: Int!
  txHash: Bytes!
  from: Bytes!
  caller: Bytes!

  metadata: Bytes # only v2/v3
  memo: String # only v2/v3
  holder: Bytes!
  beneficiary: Bytes!
  amount: BigInt!
  returnAmount: BigInt!
  returnAmountUSD: BigInt
}

# shared
type DeployedERC20Event @entity {
  id: ID!
  project: Project!
  projectId: Int!
  pv: String!
  timestamp: Int!
  txHash: Bytes!
  from: Bytes!
  caller: Bytes!

  symbol: String!
  address: Bytes # will be empty for v1.x events
}

# shared
type ENSNode @entity {
  id: ID!
  projectId: Int
}

# shared
type BurnEvent @entity {
  id: ID!
  project: Project!
  projectId: Int!
  pv: String!
  timestamp: Int!
  txHash: Bytes!
  from: Bytes!
  caller: Bytes

  holder: Bytes!
  amount: BigInt!
  stakedAmount: BigInt!
  erc20Amount: BigInt!
}

# shared
type NFT @entity {
  id: ID!
  tokenId: BigInt!
  collection: NFTCollection!
  tier: NFTTier!
  project: Project!
  projectId: Int!

  # dynamic fields
  owner: Participant!
  tokenUri: String!
}

type NFTCollection @entity {
  id: ID!
  address: Bytes!
  project: Project!
  projectId: Int!
  name: String!
  symbol: String!
  governanceType: Int!
  createdAt: Int!

  tiers: [NFTTier!]! @derivedFrom(field: "collection")
  nfts: [NFT!]! @derivedFrom(field: "collection")
}

type NFTTier @entity {
  id: ID!
  collection: NFTCollection!
  tierId: Int!
  allowManualMint: Boolean!
  price: BigInt!
  encodedIpfsUri: String
  resolvedUri: String
  initialQuantity: BigInt!
  remainingQuantity: BigInt!
  transfersPausable: Boolean!
  votingUnits: BigInt!
  createdAt: Int!

  # Supported in version ^3.1
  category: Int
  reservedRate: BigInt
  reservedTokenBeneficiary: Bytes

  nfts: [NFT!]! @derivedFrom(field: "tier")
}

#############################################################################
############################### v1.x entities ###############################
#############################################################################
# v1, v1.1
type ProtocolV1Log @entity {
  id: ID!
  log: ProtocolLog!
  projectsCount: Int!
  volume: BigInt!
  volumeUSD: BigInt!
  volumeRedeemed: BigInt!
  volumeRedeemedUSD: BigInt!
  paymentsCount: Int!
  redeemCount: Int!
  erc20Count: Int!
}

# v1, v1.1
type PrintReservesEvent @entity {
  id: ID!
  project: Project!
  projectId: Int!
  timestamp: Int!
  txHash: Bytes!
  from: Bytes!
  caller: Bytes!

  fundingCycleId: BigInt!
  beneficiary: Bytes!
  count: BigInt!
  beneficiaryTicketAmount: BigInt!
  distributions: [DistributeToTicketModEvent!]!
    @derivedFrom(field: "printReservesEvent")
}

# v1, v1.1
type DistributeToPayoutModEvent @entity {
  id: ID!
  project: Project!
  projectId: Int!
  timestamp: Int!
  txHash: Bytes!
  from: Bytes!
  caller: Bytes!

  fundingCycleId: BigInt!
  modProjectId: Int!
  modAllocator: Bytes!
  modBeneficiary: Bytes!
  modPreferUnstaked: Boolean!
  modCut: BigInt!
  modCutUSD: BigInt
  tapEvent: TapEvent!
}

# v1, v1.1
type TapEvent @entity {
  id: ID!
  project: Project!
  projectId: Int!
  timestamp: Int!
  txHash: Bytes!
  from: Bytes!
  caller: Bytes!

  fundingCycleId: BigInt!
  beneficiary: Bytes!
  amount: BigInt!
  amountUSD: BigInt
  currency: BigInt!
  netTransferAmount: BigInt!
  netTransferAmountUSD: BigInt
  beneficiaryTransferAmount: BigInt!
  beneficiaryTransferAmountUSD: BigInt
  govFeeAmount: BigInt!
  govFeeAmountUSD: BigInt
  distributions: [DistributeToPayoutModEvent!]! @derivedFrom(field: "tapEvent")
}

# v1, v1.1
type DistributeToTicketModEvent @entity {
  id: ID!
  project: Project!
  projectId: Int!
  timestamp: Int!
  txHash: Bytes!
  from: Bytes!
  caller: Bytes!

  fundingCycleId: BigInt!
  modBeneficiary: Bytes!
  modPreferUnstaked: Boolean!
  modCut: BigInt!
  printReservesEvent: PrintReservesEvent!
}

# v1, v1.1
type V1ConfigureEvent @entity {
  id: ID!
  project: Project!
  projectId: Int!
  timestamp: Int!
  txHash: Bytes!
  from: Bytes!
  caller: Bytes!

  target: BigInt!
  currency: Int!
  duration: Int!
  cycleLimit: Int!
  discountRate: Int!
  ballot: Bytes!

  fundingCycleId: Int!
  reconfigured: Int!
  metadata: BigInt!

  version: Int!
  reservedRate: Int!
  bondingCurveRate: Int!
  reconfigurationBondingCurveRate: Int!

  payIsPaused: Boolean
  ticketPrintingIsAllowed: Boolean
  extension: Bytes
}

# v1, v1.1
type V1InitEvent @entity {
  id: ID!
  project: Project!
  projectId: Int!
  timestamp: Int!
  txHash: Bytes!
  from: Bytes!

  fundingCycleId: Int!
  previous: Int!
  start: Int!
  weight: BigInt!
  number: Int!
}

#############################################################################
############################### v2/v3 entities ##############################
#############################################################################
# v2
type SetFundAccessConstraintsEvent @entity {
  id: ID!
  project: Project!
  projectId: Int!
  timestamp: Int!
  txHash: Bytes!
  from: Bytes!
  caller: Bytes!

  distributionLimit: BigInt!
  distributionLimitCurrency: Int!
  overflowAllowance: BigInt!
  overflowAllowanceCurrency: Int!
  terminal: Bytes!
  token: Bytes
  fundingCycleConfiguration: BigInt!
  fundingCycleNumber: Int
}

# v2
type ProtocolV2Log @entity {
  id: ID!
  log: ProtocolLog!
  projectsCount: Int!
  volume: BigInt!
  volumeUSD: BigInt!
  volumeRedeemed: BigInt!
  volumeRedeemedUSD: BigInt!
  paymentsCount: Int!
  redeemCount: Int!
  erc20Count: Int!
}

# v2
type DistributePayoutsEvent @entity {
  id: ID!
  project: Project!
  projectId: Int!
  timestamp: Int!
  txHash: Bytes!
  terminal: Bytes!
  from: Bytes!
  caller: Bytes!

  fundingCycleConfiguration: BigInt!
  fundingCycleNumber: Int!
  beneficiary: Bytes!
  amount: BigInt!
  amountUSD: BigInt
  distributedAmount: BigInt!
  distributedAmountUSD: BigInt
  fee: BigInt!
  feeUSD: BigInt
  beneficiaryDistributionAmount: BigInt!
  beneficiaryDistributionAmountUSD: BigInt
  memo: String
  splitDistributions: [DistributeToPayoutSplitEvent!]!
    @derivedFrom(field: "distributePayoutsEvent")
}

# v2
type DistributeToPayoutSplitEvent @entity {
  id: ID!
  project: Project!
  projectId: Int!
  timestamp: Int!
  txHash: Bytes!
  terminal: Bytes!
  from: Bytes!
  caller: Bytes!

  domain: BigInt!
  group: BigInt!
  amount: BigInt!
  amountUSD: BigInt
  distributePayoutsEvent: DistributePayoutsEvent!

  # Split struct properties below
  preferClaimed: Boolean!
  preferAddToBalance: Boolean!
  percent: Int!
  splitProjectId: Int!
  beneficiary: Bytes!
  lockedUntil: Int!
  allocator: Bytes!
}

# v2
type DistributeReservedTokensEvent @entity {
  id: ID!
  project: Project!
  projectId: Int!
  timestamp: Int!
  txHash: Bytes!
  from: Bytes!
  caller: Bytes!

  fundingCycleNumber: Int!
  beneficiary: Bytes!
  tokenCount: BigInt!
  beneficiaryTokenCount: BigInt!
  memo: String!
  splitDistributions: [DistributeToReservedTokenSplitEvent!]!
    @derivedFrom(field: "distributeReservedTokensEvent")
}

# v2
type DistributeToReservedTokenSplitEvent @entity {
  id: ID!
  project: Project!
  projectId: Int!
  timestamp: Int!
  txHash: Bytes!
  from: Bytes!
  caller: Bytes!

  tokenCount: BigInt!
  distributeReservedTokensEvent: DistributeReservedTokensEvent!

  # Split struct properties below
  preferClaimed: Boolean!
  percent: Int!
  splitProjectId: Int!
  beneficiary: Bytes!
  lockedUntil: Int!
  allocator: Bytes!
}

# v2
type UseAllowanceEvent @entity {
  id: ID!
  project: Project!
  projectId: Int!
  timestamp: Int!
  txHash: Bytes!
  from: Bytes!
  caller: Bytes!

  fundingCycleConfiguration: BigInt!
  fundingCycleNumber: Int!
  beneficiary: Bytes!
  amount: BigInt!
  amountUSD: BigInt
  distributedAmount: BigInt!
  distributedAmountUSD: BigInt
  netDistributedamount: BigInt!
  netDistributedamountUSD: BigInt
  memo: String!
}

# v2
type DeployETHERC20ProjectPayerEvent @entity {
  id: ID!
  project: Project!
  projectId: Int!
  timestamp: Int!
  txHash: Bytes!
  from: Bytes!
  caller: Bytes!

  address: Bytes!
  beneficiary: Bytes!
  preferClaimedTokens: Boolean!
  preferAddToBalance: Boolean!
  directory: Bytes!
  owner: Bytes!
  memo: String
  metadata: Bytes
}

# v2
type ETHERC20ProjectPayer @entity {
  id: ID!
  project: Project!
  projectId: Int!
  address: Bytes!
  beneficiary: Bytes!
  preferClaimedTokens: Boolean!
  preferAddToBalance: Boolean!
  directory: Bytes!
  owner: Bytes!
  memo: String
  metadata: Bytes
}

# v2, v3
type ConfigureEvent @entity {
  id: ID!
  projectId: Int!
  project: Project!
  timestamp: Int!
  txHash: Bytes!
  from: Bytes!
  caller: Bytes!
  fundingCycle: FundingCycle @derivedFrom(field: "configureEvent")

  duration: Int!
  weight: BigInt!
  discountRate: BigInt!
  ballot: Bytes!
  memo: String
  mustStartAtOrAfter: Int!
  configuration: BigInt!
}

# v2, v3
type InitEvent @entity {
  id: ID!
  projectId: Int!
  project: Project!
  timestamp: Int!
  txHash: Bytes!
  from: Bytes!

  configuration: BigInt!
  basedOn: Int!
}

# v2, v3
type MigrateEvent @entity {
  id: ID!
  projectId: Int!
  project: Project!
  timestamp: Int!
  txHash: Bytes!
  from: Bytes!
  caller: Bytes!

  amount: BigInt!
  to: Bytes!
}

# v2+
type FundingCycle @entity {
  id: ID!
  projectId: Int!
  project: Project!
  configureEvent: ConfigureEvent
  number: Int!
  basedOn: Int!

  startTimestamp: Int!
  endTimestamp: Int
  duration: Int!
  weight: BigInt!
  discountRate: BigInt!
  ballot: Bytes!

  mustStartAtOrAfter: Int
  configuration: BigInt!
  metadata: BigInt!

  setTerminalsAllowed: Boolean!
  setControllerAllowed: Boolean!
  transfersPaused: Boolean!

  reservedRate: Int!
  redemptionRate: Int!
  ballotRedemptionRate: Int!
  pausePay: Boolean!
  distributionsPaused: Boolean!
  redeemPaused: Boolean!
  burnPaused: Boolean!
  mintingAllowed: Boolean!
  terminalMigrationAllowed: Boolean!
  controllerMigrationAllowed: Boolean!
  shouldHoldFees: Boolean!
  preferClaimedTokenOverride: Boolean!
  useTotalOverflowForRedemptions: Boolean!
  useDataSourceForPay: Boolean!
  useDataSourceForRedeem: Boolean!

  dataSource: Bytes
  metametadata: Int!

  withdrawnAmount: BigInt!
}

# v3
type ProtocolV3Log @entity {
  id: ID!
  log: ProtocolLog!
  projectsCount: Int!
  volume: BigInt!
  volumeUSD: BigInt!
  volumeRedeemed: BigInt!
  volumeRedeemedUSD: BigInt!
  paymentsCount: Int!
  redeemCount: Int!
  erc20Count: Int!
}

type ETHERC20SplitsPayer @entity {
  id: ID!

  defaultBeneficiary: Bytes!
  defaultMemo: String!
  defaultMetadata: Bytes!
  defaultPreferClaimedTokens: Boolean!
  defaultProjectId: Int!
  defaultSplitsDomain: BigInt!
  defaultSplitsGroup: BigInt!
  defaultSplitsProjectId: Int!
  owner: Bytes!
  preferAddToBalance: Boolean!
  splitsPayer: Bytes!
}

type DeployETHERC20SplitsPayerEvent @entity {
  id: ID!
  caller: Bytes!

  defaultBeneficiary: Bytes!
  defaultMemo: String!
  defaultMetadata: Bytes!
  defaultPreferClaimedTokens: Boolean!
  defaultProjectId: Int!
  defaultSplitsDomain: BigInt!
  defaultSplitsGroup: BigInt!
  defaultSplitsProjectId: Int!
  owner: Bytes!
  preferAddToBalance: Boolean!
  splitsPayer: Bytes!
}