chore: evidence-and-withdrawal-event-updates

Author: tractorss

subgraph/core/schema.graphql

@@ -42,17 +42,11 @@ interface Contribution {
   contributor: User!
 }
 
-interface EvidenceGroup {
-  id: ID!
-  evidences: [Evidence!]! @derivedFrom(field: "evidenceGroup")
-  nextEvidenceIndex: BigInt!
-}
-
 interface Evidence {
   id: ID!
   evidence: String!
-  evidenceGroup: EvidenceGroup!
-  evidenceIndex: String!
+  evidenceIndex: BigInt!
+  dispute: Dispute!
   sender: User!
   senderAddress: String!
   timestamp: BigInt!
@@ -63,7 +57,6 @@ interface Evidence {
   fileTypeExtension: String
 }
 
-
 ############
 # Entities #
 ############
@@ -88,7 +81,7 @@ type User @entity {
   coherenceScore: BigInt!
   votes: [Vote!]! @derivedFrom(field: "juror")
   contributions: [Contribution!]! @derivedFrom(field: "contributor")
-  evidences: [Evidence!]! @derivedFrom(field: "sender")
+  evidences: [ClassicEvidence!]! @derivedFrom(field: "sender")
   penalties: [Penalty!]! @derivedFrom(field: "juror")
 }
 
@@ -182,11 +175,14 @@ type Dispute @entity {
   shifts: [JurorRewardPenalty!]! @derivedFrom(field: "dispute")
   disputeKitDispute: [DisputeKitDispute!]! @derivedFrom(field: "coreDispute")
   isCrossChain: Boolean
-  arbitrableChainId:BigInt
-  externalDisputeId:BigInt
-  templateId:BigInt
-  rulingTimestamp:BigInt
-  rulingTransactionHash:String
+  arbitrableChainId: BigInt
+  externalDisputeId: BigInt
+  templateId: BigInt
+  rulingTimestamp: BigInt
+  rulingTransactionHash: String
+  # required to keep evidence unique
+  evidenceCount: BigInt!
+  evidences: [ClassicEvidence!]! @derivedFrom(field: "dispute")
 }
 
 type PeriodIndexCounter @entity {
@@ -285,7 +281,7 @@ type Answer @entity {
   count: BigInt!
   paidFee: BigInt!
   funded: Boolean!
-  localRound: ClassicRound! 
+  localRound: ClassicRound!
 }
 
 type ClassicRound implements DisputeKitRound @entity {
@@ -332,17 +328,11 @@ type ClassicJustification @entity {
   timestamp: BigInt!
 }
 
-type ClassicEvidenceGroup implements EvidenceGroup @entity {
-  id: ID!
-  evidences: [Evidence!]! @derivedFrom(field: "evidenceGroup")
-  nextEvidenceIndex: BigInt!
-}
-
 type ClassicEvidence implements Evidence @entity(immutable: true) {
   id: ID! # classicEvidenceGroup.id-nextEvidenceIndex
   evidence: String!
-  evidenceGroup: EvidenceGroup!
-  evidenceIndex: String!
+  evidenceIndex: BigInt!
+  dispute: Dispute!
   sender: User!
   senderAddress: String!
   timestamp: BigInt!
@@ -370,5 +360,10 @@ type _Schema_
     name: "evidenceSearch"
     language: en
     algorithm: rank
-    include: [{ entity: "ClassicEvidence", fields: [{ name: "name" }, { name: "description" },{ name: "senderAddress"},{ name: "evidenceIndex"}] }]
-  )
+    include: [
+      {
+        entity: "ClassicEvidence"
+        fields: [{ name: "name" }, { name: "description" }, { name: "senderAddress" }, { name: "evidenceIndex" }]
+      }
+    ]
+  )

subgraph/core/src/DisputeKitClassic.ts

@@ -113,7 +113,7 @@ export function handleVoteCast(event: VoteCast): void {
 }
 
 export function handleContributionEvent(event: ContributionEvent): void {
-  ensureClassicContributionFromEvent(event);
+  ensureClassicContributionFromEvent(event, event.params._coreRoundID);
   updateChoiceFundingFromContributionEvent(event);
 }
 
@@ -174,36 +174,37 @@ export function handleChoiceFunded(event: ChoiceFunded): void {
 }
 
 export function handleWithdrawal(event: Withdrawal): void {
-  const contribution = ensureClassicContributionFromEvent(event);
-  if (!contribution) return;
-  contribution.rewardWithdrawn = true;
-  contribution.rewardAmount = event.params._amount;
-
   // check if all appeal fees have been withdrawn
   const coreDisputeID = event.params._coreDisputeID.toString();
-
-  // TODO: handle the removal of _coreRoundID from the event
-  const coreRoundIndex = 0; // event.params._coreRoundID.toString();
-
   const coreDispute = Dispute.load(coreDisputeID);
   if (!coreDispute) return;
 
-  const roundId = `${coreDisputeID}-${coreRoundIndex}`;
-  const coreRound = Round.load(roundId);
-  if (!coreRound) return;
-  const disputeKitID = coreRound.disputeKit;
+  const numberOfRounds = coreDispute.currentRoundIndex.toI32();
+  for (let i = 0; i < numberOfRounds; i++) {
+    const coreRoundIndex = i;
 
-  const roundID = `${disputeKitID}-${coreDisputeID}-${coreRoundIndex}`;
+    const contribution = ensureClassicContributionFromEvent(event, new BigInt(coreRoundIndex));
+    if (!contribution) return;
+    contribution.rewardWithdrawn = true;
+    contribution.rewardAmount = event.params._amount;
 
-  const localRound = ClassicRound.load(roundID);
-  if (!localRound) return;
+    const roundId = `${coreDisputeID}-${coreRoundIndex}`;
+    const coreRound = Round.load(roundId);
+    if (!coreRound) return;
+    const disputeKitID = coreRound.disputeKit;
 
-  localRound.totalFeeDispersed = localRound.totalFeeDispersed.plus(event.params._amount);
+    const roundID = `${disputeKitID}-${coreDisputeID}-${coreRoundIndex}`;
 
-  if (localRound.totalFeeDispersed.equals(localRound.feeRewards)) {
-    localRound.appealFeesDispersed = true;
-  }
+    const localRound = ClassicRound.load(roundID);
+    if (!localRound) return;
 
-  contribution.save();
-  localRound.save();
+    localRound.totalFeeDispersed = localRound.totalFeeDispersed.plus(event.params._amount);
+
+    if (localRound.totalFeeDispersed.equals(localRound.feeRewards)) {
+      localRound.appealFeesDispersed = true;
+    }
+
+    contribution.save();
+    localRound.save();
+  }
 }

subgraph/core/src/EvidenceModule.ts

@@ -1,30 +1,34 @@
 import { json, JSONValueKind, log } from "@graphprotocol/graph-ts";
 import { Evidence as EvidenceEvent } from "../generated/EvidenceModule/EvidenceModule";
-import { ClassicEvidence } from "../generated/schema";
-import { ensureClassicEvidenceGroup } from "./entities/ClassicEvidenceGroup";
+import { ClassicEvidence, Dispute } from "../generated/schema";
 import { ensureUser } from "./entities/User";
 import { ONE } from "./utils";
 import { JSONValueToMaybeString } from "../../utils";
 
 export function handleEvidenceEvent(event: EvidenceEvent): void {
-  // TODO: handle the replacement of _externalDisputeID with _arbitratorDisputeID
-  // TODO: no more evidenceGroupID
-  const evidenceGroupID = event.params._arbitratorDisputeID.toString();
+  const coreDisputeID = event.params._arbitratorDisputeID;
+  const dispute = Dispute.load(coreDisputeID.toString());
+
+  if (!dispute) {
+    log.error(`EvidenceEvent: Dispute not found for id: {}`, [coreDisputeID.toString()]);
+    return;
+  }
+
+  dispute.evidenceCount = dispute.evidenceCount.plus(ONE);
+  dispute.save();
+
+  const numberOfEvidences = dispute.evidenceCount;
+  const evidenceId = `${coreDisputeID}-${numberOfEvidences.toString()}`;
 
-  const evidenceGroup = ensureClassicEvidenceGroup(evidenceGroupID);
-  const evidenceIndex = evidenceGroup.nextEvidenceIndex;
-  evidenceGroup.nextEvidenceIndex = evidenceGroup.nextEvidenceIndex.plus(ONE);
-  evidenceGroup.save();
-  const evidenceId = `${evidenceGroupID}-${evidenceIndex.toString()}`;
   const evidence = new ClassicEvidence(evidenceId);
-  evidence.evidenceIndex = evidenceIndex.plus(ONE).toString();
   const userId = event.params._party.toHexString();
+
   evidence.timestamp = event.block.timestamp;
   evidence.transactionHash = event.transaction.hash;
   evidence.evidence = event.params._evidence;
-  evidence.evidenceGroup = evidenceGroupID.toString();
   evidence.sender = userId;
   evidence.senderAddress = userId;
+  evidence.evidenceIndex = numberOfEvidences;
   ensureUser(userId);
 
   let jsonObjValueAndSuccess = json.try_fromString(event.params._evidence);

subgraph/core/src/entities/ClassicContribution.ts

@@ -1,14 +1,12 @@
 import { ClassicContribution, Dispute, Round } from "../../generated/schema";
 import { Contribution as ContributionEvent, Withdrawal } from "../../generated/DisputeKitClassic/DisputeKitClassic";
 import { ensureUser } from "./User";
+import { BigInt } from "@graphprotocol/graph-ts";
 
-export function ensureClassicContributionFromEvent<T>(event: T): ClassicContribution | null {
+export function ensureClassicContributionFromEvent<T>(event: T, coreRoundIndex: BigInt): ClassicContribution | null {
   if (!(event instanceof ContributionEvent) && !(event instanceof Withdrawal)) return null;
   const coreDisputeID = event.params._coreDisputeID.toString();
 
-  // TODO: handle the removal of _coreRoundID from the event
-  const coreRoundIndex = 0; // event.params._coreRoundID.toString();
-
   const coreDispute = Dispute.load(coreDisputeID);
   if (!coreDispute) return null;
 

subgraph/core/src/entities/ClassicEvidenceGroup.ts

@@ -22,6 +22,7 @@ export function createDisputeFromEvent(event: DisputeCreation): void {
   dispute.lastPeriodChangeBlockNumber = event.block.number;
   dispute.periodNotificationIndex = getAndIncrementPeriodCounter(dispute.period);
   dispute.transactionHash = event.transaction.hash.toHexString();
+  dispute.evidenceCount = ZERO;
   const court = Court.load(courtID);
   if (!court) return;
   dispute.periodDeadline = event.block.timestamp.plus(court.timesPerPeriod[0]);

subgraph/core/src/entities/Dispute.ts

@@ -15,48 +15,48 @@ export const evidenceFragment = graphql(`
     sender {
       id
     }
+    evidenceIndex
     timestamp
     transactionHash
     name
     description
     fileURI
     fileTypeExtension
-    evidenceIndex
   }
 `);
 
 const evidencesQuery = graphql(`
-  query Evidences($evidenceGroupID: String) {
-    evidences(where: { evidenceGroup: $evidenceGroupID }, orderBy: timestamp, orderDirection: asc) {
+  query Evidences($disputeID: String) {
+    evidences(where: { dispute: $disputeID }, orderBy: timestamp, orderDirection: asc) {
       ...EvidenceDetails
     }
   }
 `);
 
 const evidenceSearchQuery = graphql(`
-  query EvidenceSearch($keywords: String!, $evidenceGroupID: String) {
-    evidenceSearch(text: $keywords, where: { evidenceGroup: $evidenceGroupID }) {
+  query EvidenceSearch($keywords: String!, $disputeID: String) {
+    evidenceSearch(text: $keywords, where: { dispute: $disputeID }) {
       ...EvidenceDetails
     }
   }
 `);
 
-export const useEvidences = (evidenceGroup?: string, keywords?: string) => {
-  const isEnabled = evidenceGroup !== undefined;
+export const useEvidences = (disputeID?: string, keywords?: string) => {
+  const isEnabled = disputeID !== undefined;
   const { graphqlBatcher } = useGraphqlBatcher();
 
   const document = keywords ? evidenceSearchQuery : evidencesQuery;
   const transformedKeywords = transformSearch(keywords);
 
   return useQuery<{ evidences: EvidenceDetailsFragment[] }>({
-    queryKey: [keywords ? `evidenceSearchQuery${evidenceGroup}-${keywords}` : `evidencesQuery${evidenceGroup}`],
+    queryKey: keywords ? [`EvidenceSearchQuery`, disputeID, keywords] : [`EvidencesQuery`, disputeID],
     enabled: isEnabled,
     refetchInterval: REFETCH_INTERVAL,
     queryFn: async () => {
       const result = await graphqlBatcher.fetch({
         id: crypto.randomUUID(),
         document: document,
-        variables: { evidenceGroupID: evidenceGroup?.toString(), keywords: transformedKeywords },
+        variables: { disputeID, keywords: transformedKeywords },
       });
 
       return keywords ? { evidences: [...result.evidenceSearch] } : result;

web/src/hooks/queries/useEvidences.ts

@@ -85,9 +85,9 @@ const Evidence: React.FC = () => {
   const [search, setSearch] = useState<string>();
   const [debouncedSearch, setDebouncedSearch] = useState<string>();
   const [showSpam, setShowSpam] = useState(false);
-  const { data: spamEvidences } = useSpamEvidence(disputeData?.dispute?.externalDisputeId?.toString());
+  const { data: spamEvidences } = useSpamEvidence(id!);
 
-  const { data } = useEvidences(disputeData?.dispute?.externalDisputeId?.toString(), debouncedSearch);
+  const { data } = useEvidences(id!, debouncedSearch);
 
   useDebounce(() => setDebouncedSearch(search), 500, [search]);