Refactor/evidence refactors

contracts/src/arbitration/evidence/EvidenceModule.sol

@@ -64,7 +64,7 @@ contract EvidenceModule is IEvidence, Initializable, UUPSProxiable {
 
     /// @dev Submits evidence for a dispute.
     /// @param _externalDisputeID Unique identifier for this dispute outside Kleros. It's the submitter responsability to submit the right evidence group ID.
-    /// @param _evidence IPFS path to evidence, example: '/ipfs/Qmarwkf7C9RuzDEJNnarT3WZ7kem5bk8DZAzx78acJjMFH/evidence.json'.
+    /// @param _evidence Stringified evidence object, example: '{"name" : "Justification", "description" : "Description", "fileURI" : "/ipfs/QmWQV5ZFFhEJiW8Lm7ay2zLxC2XS4wx1b2W7FfdrLMyQQc"}'.
     function submitEvidence(uint256 _externalDisputeID, string calldata _evidence) external {
         emit Evidence(_externalDisputeID, msg.sender, _evidence);
     }

contracts/src/arbitration/evidence/ModeratedEvidenceModule.sol

@@ -84,7 +84,7 @@ contract ModeratedEvidenceModule is IArbitrableV2 {
     /// @param _arbitrator The arbitrator of the contract.
     /// @param _externalDisputeID Unique identifier for this dispute outside Kleros. It's the submitter responsability to submit the right evidence group ID.
     /// @param _party The address of the party submiting the evidence. Note that 0x0 refers to evidence not submitted by any party.
-    /// @param _evidence IPFS path to evidence, example: '/ipfs/Qmarwkf7C9RuzDEJNnarT3WZ7kem5bk8DZAzx78acJjMFH/evidence.json'
+    /// @param _evidence Stringified evidence object, example: '{"name" : "Justification", "description" : "Description", "fileURI" : "/ipfs/QmWQV5ZFFhEJiW8Lm7ay2zLxC2XS4wx1b2W7FfdrLMyQQc"}'.
     event ModeratedEvidence(
         IArbitratorV2 indexed _arbitrator,
         uint256 indexed _externalDisputeID,
@@ -201,7 +201,7 @@ contract ModeratedEvidenceModule is IArbitrableV2 {
 
     /// @dev Submits evidence.
     /// @param _evidenceGroupID Unique identifier of the evidence group the evidence belongs to. It's the submitter responsability to submit the right evidence group ID.
-    /// @param _evidence IPFS path to evidence, example: '/ipfs/Qmarwkf7C9RuzDEJNnarT3WZ7kem5bk8DZAzx78acJjMFH/evidence.json'.
+    /// @param _evidence Stringified evidence object, example: '{"name" : "Justification", "description" : "Description", "fileURI" : "/ipfs/QmWQV5ZFFhEJiW8Lm7ay2zLxC2XS4wx1b2W7FfdrLMyQQc"}'.
     function submitEvidence(uint256 _evidenceGroupID, string calldata _evidence) external payable {
         // Optimization opportunity: map evidenceID to an incremental index that can be safely assumed to be less than a small uint.
         bytes32 evidenceID = keccak256(abi.encodePacked(_evidenceGroupID, _evidence));

contracts/src/arbitration/interfaces/IEvidence.sol

@@ -7,6 +7,6 @@ interface IEvidence {
     /// @dev To be raised when evidence is submitted. Should point to the resource (evidences are not to be stored on chain due to gas considerations).
     /// @param _externalDisputeID Unique identifier for this dispute outside Kleros. It's the submitter responsability to submit the right external dispute ID.
     /// @param _party The address of the party submiting the evidence. Note that 0x0 refers to evidence not submitted by any party.
-    /// @param _evidence IPFS path to evidence, example: '/ipfs/Qmarwkf7C9RuzDEJNnarT3WZ7kem5bk8DZAzx78acJjMFH/evidence.json'
+    /// @param _evidence Stringified evidence object, example: '{"name" : "Justification", "description" : "Description", "fileURI" : "/ipfs/QmWQV5ZFFhEJiW8Lm7ay2zLxC2XS4wx1b2W7FfdrLMyQQc"}'.
     event Evidence(uint256 indexed _externalDisputeID, address indexed _party, string _evidence);
 }

subgraph/core-neo/subgraph.yaml

@@ -1,6 +1,9 @@
 specVersion: 0.0.4
 schema:
   file: ./schema.graphql
+features:
+  - fullTextSearch
+
 dataSources:
   - kind: ethereum
     name: KlerosCore

subgraph/core-university/subgraph.yaml

@@ -1,6 +1,9 @@
 specVersion: 0.0.4
 schema:
   file: ./schema.graphql
+features:
+  - fullTextSearch
+
 dataSources:
   - kind: ethereum
     name: KlerosCore

subgraph/core/schema.graphql

@@ -52,8 +52,14 @@ interface Evidence {
   id: ID!
   evidence: String!
   evidenceGroup: EvidenceGroup!
+  evidenceIndex: String!
   sender: User!
+  senderAddress: String!
   timestamp: BigInt!
+  name: String
+  description: String
+  fileURI: String
+  fileTypeExtension: String
 }
 
 ############
@@ -292,12 +298,18 @@ type ClassicEvidenceGroup implements EvidenceGroup @entity {
   nextEvidenceIndex: BigInt!
 }
 
-type ClassicEvidence implements Evidence @entity {
+type ClassicEvidence implements Evidence @entity(immutable: true) {
   id: ID! # classicEvidenceGroup.id-nextEvidenceIndex
   evidence: String!
   evidenceGroup: EvidenceGroup!
+  evidenceIndex: String!
   sender: User!
+  senderAddress: String!
   timestamp: BigInt!
+  name: String
+  description: String
+  fileURI: String
+  fileTypeExtension: String
 }
 
 type ClassicContribution implements Contribution @entity {
@@ -311,3 +323,11 @@ type ClassicContribution implements Contribution @entity {
   choice: BigInt!
   rewardWithdrawn: Boolean!
 }
+
+type _Schema_
+  @fulltext(
+    name: "evidenceSearch"
+    language: en
+    algorithm: rank
+    include: [{ entity: "ClassicEvidence", fields: [{ name: "name" }, { name: "description" },{ name: "senderAddress"},{ name: "evidenceIndex"}] }]
+  )

subgraph/core/src/EvidenceModule.ts

@@ -1,21 +1,63 @@
+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 { ensureUser } from "./entities/User";
 import { ONE } from "./utils";
+import { JSONValueToMaybeString } from "../../utils";
 
 export function handleEvidenceEvent(event: EvidenceEvent): void {
   const evidenceGroupID = event.params._externalDisputeID.toString();
   const evidenceGroup = ensureClassicEvidenceGroup(evidenceGroupID);
   const evidenceIndex = evidenceGroup.nextEvidenceIndex;
   evidenceGroup.nextEvidenceIndex = evidenceGroup.nextEvidenceIndex.plus(ONE);
   evidenceGroup.save();
-  const evidence = new ClassicEvidence(`${evidenceGroupID}-${evidenceIndex.toString()}`);
+  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.evidence = event.params._evidence;
   evidence.evidenceGroup = evidenceGroupID.toString();
   evidence.sender = userId;
+  evidence.senderAddress = userId;
   ensureUser(userId);
+
+  let jsonObjValueAndSuccess = json.try_fromString(event.params._evidence);
+  if (!jsonObjValueAndSuccess.isOk || jsonObjValueAndSuccess.isError) {
+    log.error(`Error getting json object for evidenceId {}`, [evidenceId]);
+    evidence.save();
+    return;
+  }
+
+  if (jsonObjValueAndSuccess.value.isNull() || jsonObjValueAndSuccess.value.kind !== JSONValueKind.OBJECT) {
+    log.error(`Encountered invalid parsed value for evidenceId {}`, [evidenceId]);
+    evidence.save();
+    return;
+  }
+
+  let jsonObj = jsonObjValueAndSuccess.value.toObject();
+  if (!jsonObj) {
+    log.error(`Error converting json object for evidenceId {}`, [evidenceId]);
+    evidence.save();
+    return;
+  }
+
+  let name = jsonObj.get("name");
+  let description = jsonObj.get("description");
+  let fileURI = jsonObj.get("fileURI");
+  let fileTypeExtension = jsonObj.get("fileTypeExtension");
+
+  evidence.name = JSONValueToMaybeString(name);
+  evidence.description = JSONValueToMaybeString(description);
+
+  if (fileURI) {
+    evidence.fileURI = JSONValueToMaybeString(fileURI);
+  }
+
+  if (fileTypeExtension) {
+    evidence.fileTypeExtension = JSONValueToMaybeString(fileTypeExtension);
+  }
+
   evidence.save();
 }

subgraph/core/subgraph.yaml

@@ -1,6 +1,9 @@
 specVersion: 0.0.4
 schema:
   file: ./schema.graphql
+features:
+  - fullTextSearch
+
 dataSources:
   - kind: ethereum
     name: KlerosCore

subgraph/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kleros/kleros-v2-subgraph",
-  "version": "0.5.1",
+  "version": "0.7.0",
   "license": "MIT",
   "scripts": {
     "update:core:arbitrum-sepolia-devnet": "./scripts/update.sh arbitrumSepoliaDevnet arbitrum-sepolia core/subgraph.yaml",

subgraph/utils/index.ts

@@ -0,0 +1,26 @@
+import { JSONValue, JSONValueKind } from "@graphprotocol/graph-ts";
+
+export function JSONValueToMaybeString(value: JSONValue | null, _default: string = "-"): string {
+  // Subgraph considers an empty string to be null and
+  // the handler crashes when attempting to save the entity.
+  // This is a security vulnerability because an adversary
+  // could manually craft an item with missing columns
+  // and the item would not show up in the UI, passing
+  // the challenge period unoticed.
+  //
+  // We fix this by setting the field manually to a hifen.
+  if (value == null || value.isNull()) {
+    return "-";
+  }
+
+  switch (value.kind) {
+    case JSONValueKind.BOOL:
+      return value.toBool() == true ? "true" : "false";
+    case JSONValueKind.STRING:
+      return value.toString();
+    case JSONValueKind.NUMBER:
+      return value.toBigInt().toHexString();
+    default:
+      return _default;
+  }
+}

web/src/components/EvidenceCard.tsx

@@ -9,11 +9,12 @@ import { Card } from "@kleros/ui-components-library";
 
 import AttachmentIcon from "svgs/icons/attachment.svg";
 
-import { useIPFSQuery } from "hooks/useIPFSQuery";
 import { formatDate } from "utils/date";
 import { getIpfsUrl } from "utils/getIpfsUrl";
 import { shortenAddress } from "utils/shortenAddress";
 
+import { type Evidence } from "src/graphql/graphql";
+
 import { landscapeStyle } from "styles/landscapeStyle";
 import { responsiveSize } from "styles/responsiveSize";
 
@@ -61,20 +62,6 @@ const BottomShade = styled.div`
   }
 `;
 
-const StyledA = styled.a`
-  display: flex;
-  margin-left: auto;
-  gap: ${responsiveSize(5, 6)};
-  ${landscapeStyle(
-    () => css`
-      > svg {
-        width: 16px;
-        fill: ${({ theme }) => theme.primaryBlue};
-      }
-    `
-  )}
-`;
-
 const AccountContainer = styled.div`
   display: flex;
   flex-direction: row;
@@ -136,24 +123,20 @@ const AttachedFileText: React.FC = () => (
   </>
 );
 
-interface IEvidenceCard {
-  evidence: string;
+interface IEvidenceCard extends Pick<Evidence, "evidence" | "timestamp" | "name" | "description" | "fileURI"> {
   sender: string;
   index: number;
-  timestamp: string;
 }
 
-const EvidenceCard: React.FC<IEvidenceCard> = ({ evidence, sender, index, timestamp }) => {
-  const { data } = useIPFSQuery(evidence);
-
+const EvidenceCard: React.FC<IEvidenceCard> = ({ evidence, sender, index, timestamp, name, description, fileURI }) => {
   return (
     <StyledCard>
       <TextContainer>
         <Index>#{index}:</Index>
-        {data ? (
+        {name && description ? (
           <>
-            <h3>{data.name}</h3>
-            <StyledReactMarkdown>{data.description}</StyledReactMarkdown>
+            <h3>{name}</h3>
+            <StyledReactMarkdown>{description}</StyledReactMarkdown>
           </>
         ) : (
           <p>{evidence}</p>
@@ -165,8 +148,8 @@ const EvidenceCard: React.FC<IEvidenceCard> = ({ evidence, sender, index, timest
           <p>{shortenAddress(sender)}</p>
         </AccountContainer>
         <Timestamp>{formatDate(Number(timestamp), true)}</Timestamp>
-        {data && typeof data.fileURI !== "undefined" && (
-          <StyledLink to={`attachment/?url=${getIpfsUrl(data.fileURI)}`}>
+        {fileURI && (
+          <StyledLink to={`attachment/?url=${getIpfsUrl(fileURI)}`}>
             <AttachmentIcon />
             <AttachedFileText />
           </StyledLink>

web/src/hooks/queries/useEvidences.ts

@@ -4,35 +4,60 @@ import { REFETCH_INTERVAL } from "consts/index";
 import { useGraphqlBatcher } from "context/GraphqlBatcher";
 
 import { graphql } from "src/graphql";
-import { EvidencesQuery } from "src/graphql/graphql";
+import { EvidenceDetailsFragment, EvidencesQuery } from "src/graphql/graphql";
 export type { EvidencesQuery };
 
+export const evidenceFragment = graphql(`
+  fragment EvidenceDetails on ClassicEvidence {
+    id
+    evidence
+    sender {
+      id
+    }
+    timestamp
+    name
+    description
+    fileURI
+    fileTypeExtension
+    evidenceIndex
+  }
+`);
+
 const evidencesQuery = graphql(`
   query Evidences($evidenceGroupID: String) {
-    evidences(where: { evidenceGroup: $evidenceGroupID }, orderBy: timestamp, orderDirection: desc) {
-      id
-      evidence
-      sender {
-        id
-      }
-      timestamp
+    evidences(where: { evidenceGroup: $evidenceGroupID }, orderBy: timestamp, orderDirection: asc) {
+      ...EvidenceDetails
     }
   }
 `);
 
-export const useEvidences = (evidenceGroup?: string) => {
+const evidenceSearchQuery = graphql(`
+  query EvidenceSearch($keywords: String!, $evidenceGroupID: String) {
+    evidenceSearch(text: $keywords, where: { evidenceGroup: $evidenceGroupID }) {
+      ...EvidenceDetails
+    }
+  }
+`);
+
+export const useEvidences = (evidenceGroup?: string, keywords?: string) => {
   const isEnabled = evidenceGroup !== undefined;
   const { graphqlBatcher } = useGraphqlBatcher();
 
-  return useQuery({
-    queryKey: [`evidencesQuery${evidenceGroup}`],
+  const document = keywords ? evidenceSearchQuery : evidencesQuery;
+  return useQuery<{ evidences: EvidenceDetailsFragment[] }>({
+    queryKey: [
+      keywords ? `evidenceSearchQuery${evidenceGroup}-${keywords}` : `evidencesQuery${evidenceGroup}`,
+    ],
     enabled: isEnabled,
     refetchInterval: REFETCH_INTERVAL,
-    queryFn: async () =>
-      await graphqlBatcher.fetch({
+    queryFn: async () => {
+      const result = await graphqlBatcher.fetch({
         id: crypto.randomUUID(),
-        document: evidencesQuery,
-        variables: { evidenceGroupID: evidenceGroup?.toString() },
-      }),
+        document: document,
+        variables: { evidenceGroupID: evidenceGroup?.toString(), keywords: keywords },
+      });
+
+      return keywords ? { evidences: [...result.evidenceSearch] } : result;
+    },
   });
 };