schema.graphql

enum ProtocolVersion {
  v2
  v3
  v3_1
}

# VestingTokenFactory
type VestingTokenFactory @entity {
  id: String! # address
  # Fee collector
  feeCollector: Bytes!
  # Creation Fee
  currentGlobalCreationFee: BigInt!
  nextGlobalCreationFee: BigInt!
  nextGlobalCreationFeeTime: BigInt!
  # Transfer Fee
  currentGlobalTransferFee: BigInt!
  nextGlobalTransferFee: BigInt!
  nextGlobalTransferFeeTime: BigInt!
  # Claim Fee
  currentGlobalClaimFee: BigInt!
  nextGlobalClaimFee: BigInt!
  nextGlobalClaimFeeTime: BigInt!
  # Tx info
  blockNumber: BigInt!
  blockTimestamp: BigInt!
  transactionHash: Bytes!
  # Misc
  version: ProtocolVersion!
}

# CustomCreationFee for the underlying token
type CustomCreationFee @entity {
  id: Bytes!
  "Indicates if the custom fee is currently enabled."
  isEnabled: Boolean!
  "The current fee value in wei."
  currentCustomValue: BigInt!
  "The new fee value in wei to be applied at `valueChangeAt`."
  nextCustomValue: BigInt!
  "Timestamp at which a new fee value becomes effective."
  valueChangeAt: BigInt!
  "Indicates the future state of `isEnabled` after `statusChangeAt`."
  nextEnableState: Boolean!
  "Timestamp at which the change to `isEnabled` becomes effective."
  statusChangeAt: BigInt!

  underlyingToken: UnderlyingToken!

  updatedAt: BigInt!
}

# CustomTransferFee for the underlying token
type CustomTransferFee @entity {
  id: Bytes!
  "Indicates if the custom fee is currently enabled."
  isEnabled: Boolean!
  "The current fee value in wei."
  currentCustomValue: BigInt!
  "The new fee value in wei to be applied at `valueChangeAt`."
  nextCustomValue: BigInt!
  "Timestamp at which a new fee value becomes effective."
  valueChangeAt: BigInt!
  "Indicates the future state of `isEnabled` after `statusChangeAt`."
  nextEnableState: Boolean!
  "Timestamp at which the change to `isEnabled` becomes effective."
  statusChangeAt: BigInt!

  underlyingToken: UnderlyingToken!

  updatedAt: BigInt!
}

# CustomClaimFee for the underlying token
type CustomClaimFee @entity {
  id: Bytes!
  "Indicates if the custom fee is currently enabled."
  isEnabled: Boolean!
  "The current fee value in wei."
  currentCustomValue: BigInt!
  "The new fee value in wei to be applied at `valueChangeAt`."
  nextCustomValue: BigInt!
  "Timestamp at which a new fee value becomes effective."
  valueChangeAt: BigInt!
  "Indicates the future state of `isEnabled` after `statusChangeAt`."
  nextEnableState: Boolean!
  "Timestamp at which the change to `isEnabled` becomes effective."
  statusChangeAt: BigInt!

  underlyingToken: UnderlyingToken!

  updatedAt: BigInt!
}

# PermanentFee for the `UnderlyingToken`.
type UnderlyingTokenPermanentFees @entity {
  id: Bytes!
  isEnabled: Boolean!
  claimFeeValue: BigInt!
  transferFeePercentage: BigInt!
  underlyingToken: UnderlyingToken!
  updatedAt: BigInt!
}

# PermanentFee for the `VestingToken`.
type VestingTokenPermanentFees @entity {
  id: Bytes!
  claimFeeValue: BigInt!
  transferFeePercentage: BigInt!
  vestingToken: VestingToken!
}

# UnderlyingToken (ERC20)
type UnderlyingToken @entity(immutable: true) {
  id: String! # address
  name: String!
  symbol: String!
  decimals: Int!
  # Vesting tokens
  vestingTokens: [VestingToken!]! @derivedFrom(field: "underlyingToken")
  # Custom fees
  customCreationFee: CustomCreationFee @derivedFrom(field: "underlyingToken")
  customTransferFee: CustomTransferFee @derivedFrom(field: "underlyingToken")
  customClaimFee: CustomClaimFee @derivedFrom(field: "underlyingToken")
  # Permanent fees
  permanentFees: UnderlyingTokenPermanentFees @derivedFrom(field: "underlyingToken")
}

# VestingToken
type VestingToken @entity {
  id: String! # address
  name: String!
  symbol: String!
  decimals: Int!
  underlyingToken: UnderlyingToken! # address
  # Milestones
  milestones: [Milestone!]! @derivedFrom(field: "vestingToken")
  # Deployer
  deployer: String!
  # Vesting balance
  balance: VestingBalance! @derivedFrom(field: "vestingToken")
  # Holders
  holdersCount: Int!
  recipientsCount: Int!
  holders: [HolderBalance!]! @derivedFrom(field: "vestingToken")
  # DistributionBatches
  distributionBatches: [DistributionBatch!]! @derivedFrom(field: "vestingToken")
  # Tx info
  blockNumber: BigInt!
  blockTimestamp: BigInt!
  transactionHash: Bytes!
  # Permanent fees
  permanentFees: VestingTokenPermanentFees @derivedFrom(field: "vestingToken")
  # Misc
  version: ProtocolVersion!
}

type Claim @entity(immutable: true) {
  id: Bytes!
  vestingToken: VestingToken
  claimer: Bytes! # address
  amount: BigInt! # uint256
  blockNumber: BigInt!
  blockTimestamp: BigInt!
  transactionHash: Bytes!
}

type Burn @entity(immutable: true) {
  id: Bytes!
  vestingToken: VestingToken
  burner: Bytes! # address
  amount: BigInt! # uint256
  blockNumber: BigInt!
  blockTimestamp: BigInt!
  transactionHash: Bytes!
}

type Transfer @entity(immutable: true) {
  id: Bytes!
  vestingToken: VestingToken
  from: Bytes! # address
  to: Bytes! # address
  value: BigInt! # uint256
  blockNumber: BigInt!
  blockTimestamp: BigInt!
  transactionHash: Bytes!
  distributionBatch: DistributionBatch # Optional. Not all transfers will have a distribution batch. Just those that were minted
}

type DistributionBatch @entity(immutable: false) {
  id: String!
  vestingToken: VestingToken!
  totalAmount: BigInt!
  from: Bytes! # address
  recipients: [Transfer!]! @derivedFrom(field: "distributionBatch")
  blockNumber: BigInt!
  blockTimestamp: BigInt!
  transactionHash: Bytes!
}

type VestingBalance @entity {
  id: String!
  vestingToken: VestingToken!
  allocation: BigInt!
  claimed: BigInt!
  claimable: BigInt!
  locked: BigInt!
  updatedAt: BigInt!
  lastClaimedAt: BigInt
}

type HolderBalance @entity {
  id: String!
  user: String!
  vestingToken: VestingToken!
  isRecipient: Boolean!
  allocation: BigInt!
  claimed: BigInt!
  claimable: BigInt!
  locked: BigInt!
  balance: BigInt!
  updatedAt: BigInt!
  lastClaimedAt: BigInt
  transferredIn: BigInt!
  transferredOut: BigInt!
}

type Milestone @entity {
  id: String!
  vestingToken: VestingToken!
  timestamp: BigInt
  ramp: Int
  percentage: BigInt
}