feat: treat-list-metadata-as-stringified-json-instead-of-ipfs-uri

Author: tractorss

contracts/README.md

@@ -16,9 +16,9 @@ Refresh the list of deployed contracts by running `./scripts/generateDeployments
 
 #### Arbitrum Sepolia
 
-- [CurateFactory](https://sepolia.arbiscan.io/address/0xcfd2315053763f6ae964f721e8a6Ea44286a9baF)
-- [CurateV2](https://sepolia.arbiscan.io/address/0xd9ea52247FeBd2258823Ff9f4fC49C9cD53fe8de)
-- [CurateView](https://sepolia.arbiscan.io/address/0x2532DBf9a2877C1FDd8286f8f9ef51b76184604F)
+- [CurateFactory](https://sepolia.arbiscan.io/address/0x3F5768ca9a36d49a8f102E903e44D32a8b84a29F)
+- [CurateV2](https://sepolia.arbiscan.io/address/0x7eC8b337bb297c6429794CD888EdcBB3e54A2D20)
+- [CurateView](https://sepolia.arbiscan.io/address/0xC153EDAbA561Be9F7E12ACce4079D4a7475d508E)
 
 #### Sepolia
 

contracts/deploy/00-curate-v2.ts

@@ -54,6 +54,34 @@ const removalTemplate = `{
 }
 `;
 
+const listMetadata = `{
+  "title": "Kleros Storytelling - Standard Impact",
+  "description": "A list of Standard Tier submissions for the Kleros Storytelling Reward Program.",
+  "columns": [
+    {
+      "label": "Title",
+      "description": "The submission title.",
+      "type": "text",
+      "isIdentifier": true
+    },
+    {
+      "label": "Author",
+      "description": "To easily search submissions by author. This can be a social media handle or a nickname.",
+      "type": "text",
+      "isIdentifier": true
+    },
+    {
+      "label": "Link",
+      "description": "A link to the submission.",
+      "type": "link"
+    }
+  ],
+  "itemName": "story",
+  "itemNamePlural": "stories",
+  "logoURI": "/ipfs/QmQN9ZPubns9kpW3jxZefyt8sNbeUzj8KEcsT7i81SiXFf/standard-impact-logo-.png",
+  "isTCRofTCRs": false
+}`;
+
 // General court, 3 jurors
 const extraData =
   "0x00000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000003";
@@ -87,12 +115,11 @@ const deploy: DeployFunction = async (hre: HardhatRuntimeEnvironment) => {
     extraData,
     evidenceModule.address,
     ethers.ZeroAddress, // _connectedTCR
-    [registrationTemplate, ""],
-    [removalTemplate, ""],
-    disputeTemplateRegistry.address,
+    [disputeTemplateRegistry.address, [registrationTemplate, ""], [removalTemplate, ""]],
     [fee, fee, fee, fee],
     timeout,
-    deployer
+    deployer,
+    listMetadata
   );
 
   await deploy("CurateFactory", {

contracts/deployments/arbitrumSepoliaDevnet/CurateFactory.json

@@ -17,17 +17,16 @@ contract CurateFactory {
     // *              Events               * //
     // ************************************* //
 
-    /// @dev Emitted when a new Curate contract is deployed using this factory. TODO: change TCR mentions.
+    /// @dev Emitted when a new Curate contract is deployed using this factory.
     /// @param _address The address of the newly deployed Curate contract.
-    /// @param _listMetadata A link to registry / list metadata (title,description) using its URI
-    event NewList(CurateV2 indexed _address, string _listMetadata);
+    event NewList(CurateV2 indexed _address);
 
     // ************************************* //
     // *         Enums / Structs           * //
     // ************************************* //
 
     struct TemplateRegistryParams {
-        address templateRegistry; // The current status of the item.
+        address templateRegistry; // Template registry address.
         string[2] registrationTemplateParameters; // Template and data mappings json for registration requests.
         string[2] removalTemplateParameters; // Template and data mappings json for removal requests.
     }
@@ -70,7 +69,7 @@ contract CurateFactory {
     /// - The base deposit to challenge a removal request.
     /// @param _challengePeriodDuration The time in seconds parties have to challenge a request.
     /// @param _relayerContract The address of the relay contract to add/remove items directly.
-    /// @param _listMetadata A link to registry / list metadata (title,description) using its URI
+    /// @param _listMetadata Stringified JSON object containing list metadata (title, description, isListOfLists, etc.). Example at :-  https://cloudflare-ipfs.com/ipfs/QmekLsbXtQfm2jJjdeC5TF1cJcr5qxarZ9bhKmCS9s3ebK/list-metadata.json
     function deploy(
         address _governor,
         IArbitratorV2 _arbitrator,
@@ -90,15 +89,18 @@ contract CurateFactory {
             _arbitratorExtraData,
             _evidenceModule,
             _connectedList,
-            _templateRegistryParams.registrationTemplateParameters,
-            _templateRegistryParams.removalTemplateParameters,
-            _templateRegistryParams.templateRegistry,
+            CurateV2.TemplateRegistryParams(
+                _templateRegistryParams.templateRegistry,
+                _templateRegistryParams.registrationTemplateParameters,
+                _templateRegistryParams.removalTemplateParameters
+            ),
             _baseDeposits,
             _challengePeriodDuration,
-            _relayerContract
+            _relayerContract,
+            _listMetadata
         );
         instances.push(instance);
-        emit NewList(instance, _listMetadata);
+        emit NewList(instance);
     }
 
     /// @notice Adaptation of https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/contracts/proxy/Clones.sol.

contracts/deployments/arbitrumSepoliaDevnet/CurateV2.json

@@ -72,6 +72,12 @@ contract CurateV2 is IArbitrableV2 {
         EvidenceModule evidenceModule; // The evidence module for the arbitrator.
     }
 
+    struct TemplateRegistryParams {
+        address templateRegistry; // Dispute Template registry address
+        string[2] registrationTemplateParameters; // Template and data mappings json for registration requests.
+        string[2] removalTemplateParameters; // Template and data mappings json for removal requests.
+    }
+
     // ************************************* //
     // *             Storage               * //
     // ************************************* //
@@ -119,7 +125,7 @@ contract CurateV2 is IArbitrableV2 {
 
     /// @dev Emitted when someone submits an item for the first time.
     /// @param _itemID The ID of the new item.
-    /// @param _data The item data URI.
+    /// @param _data Stringified JSON Object containing item data. Example at :- https://cloudflare-ipfs.com/ipfs/QmTypFX9416z5V87Fsnf6A89rrskh2X8BSVdaKhwzXNiDb/item.json.
     /// @param _addedDirectly Whether the item was added via `addItemDirectly`.
     event NewItem(bytes32 indexed _itemID, string _data, bool _addedDirectly);
 
@@ -146,28 +152,29 @@ contract CurateV2 is IArbitrableV2 {
     /// @param _arbitratorExtraData Extra data for the trusted arbitrator contract.
     /// @param _evidenceModule The evidence contract for the arbitrator.
     /// @param _connectedList The address of the Curate contract that stores related Curate addresses. This parameter can be left empty.
-    /// @param _registrationTemplateParameters Template and data mappings json for registration requests.
-    /// @param _removalTemplateParameters Template and data mappings json for removal requests.
-    /// @param _templateRegistry The dispute template registry.
+    /// @param _templateRegistryParams The dispute template registry.
+    /// - templateRegistry : The dispute template registry.
+    /// - registrationTemplateParameters : Template and data mappings json for registration requests.
+    /// - removalTemplateParameters : Template and data mappings json for removal requests.
     /// @param _baseDeposits The base deposits for requests/challenges as follows:
     /// - The base deposit to submit an item.
     /// - The base deposit to remove an item.
     /// - The base deposit to challenge a submission.
     /// - The base deposit to challenge a removal request.
     /// @param _challengePeriodDuration The time in seconds parties have to challenge a request.
     /// @param _relayerContract The address of the relayer contract to add/remove items directly.
+    /// @param _listMetadata Stringified JSON object containing list metadata (title, description, isListOfLists, etc.). Example at :-  https://cloudflare-ipfs.com/ipfs/QmekLsbXtQfm2jJjdeC5TF1cJcr5qxarZ9bhKmCS9s3ebK/list-metadata.json
     function initialize(
         address _governor,
         IArbitratorV2 _arbitrator,
         bytes calldata _arbitratorExtraData,
         EvidenceModule _evidenceModule,
         address _connectedList,
-        string[2] calldata _registrationTemplateParameters,
-        string[2] calldata _removalTemplateParameters,
-        address _templateRegistry,
+        TemplateRegistryParams calldata _templateRegistryParams,
         uint256[4] calldata _baseDeposits,
         uint256 _challengePeriodDuration,
-        address _relayerContract
+        address _relayerContract,
+        string calldata _listMetadata
     ) external {
         require(!initialized, "Already initialized.");
         initialized = true;
@@ -180,16 +187,16 @@ contract CurateV2 is IArbitrableV2 {
         challengePeriodDuration = _challengePeriodDuration;
         relayerContract = _relayerContract;
 
-        templateRegistry = IDisputeTemplateRegistry(_templateRegistry);
+        templateRegistry = IDisputeTemplateRegistry(_templateRegistryParams.templateRegistry);
         templateIdRegistration = templateRegistry.setDisputeTemplate(
             "Registration",
-            _registrationTemplateParameters[0],
-            _registrationTemplateParameters[1]
+            _templateRegistryParams.registrationTemplateParameters[0],
+            _templateRegistryParams.registrationTemplateParameters[1]
         );
         templateIdRemoval = templateRegistry.setDisputeTemplate(
             "Removal",
-            _removalTemplateParameters[0],
-            _removalTemplateParameters[1]
+            _templateRegistryParams.removalTemplateParameters[0],
+            _templateRegistryParams.removalTemplateParameters[1]
         );
 
         arbitrationParamsChanges.push(
@@ -203,6 +210,8 @@ contract CurateV2 is IArbitrableV2 {
         if (_connectedList != address(0)) {
             emit ConnectedListSet(_connectedList);
         }
+
+        emit ListMetadataSet(_listMetadata);
     }
 
     // ************************************* //
@@ -317,7 +326,7 @@ contract CurateV2 is IArbitrableV2 {
     // ************************************* //
 
     /// @dev Directly add an item to the list bypassing request-challenge. Can only be used by the relayer contract.
-    /// @param _item The URI to the item data.
+    /// @param _item Stringified JSON Object containing Item data
     function addItemDirectly(string calldata _item) external onlyRelayer {
         bytes32 itemID = keccak256(abi.encodePacked(_item));
         Item storage item = items[itemID];
@@ -334,7 +343,7 @@ contract CurateV2 is IArbitrableV2 {
     }
 
     /// @dev Directly remove an item from the list bypassing request-challenge. Can only be used by the relayer contract.
-    /// @param _itemID The ID of the item to remove.
+    /// @param _itemID The ID of the item to remove. Example at :- https://cloudflare-ipfs.com/ipfs/QmTypFX9416z5V87Fsnf6A89rrskh2X8BSVdaKhwzXNiDb/item.json
     function removeItemDirectly(bytes32 _itemID) external onlyRelayer {
         Item storage item = items[_itemID];
         require(item.status == Status.Registered, "Item must be registered to be removed.");
@@ -345,7 +354,7 @@ contract CurateV2 is IArbitrableV2 {
     }
 
     /// @dev Submit a request to register an item. Accepts enough ETH to cover the deposit, reimburses the rest.
-    /// @param _item The URI to the item data.
+    /// @param _item Stringified JSON object containing item data. Example at :- https://cloudflare-ipfs.com/ipfs/QmTypFX9416z5V87Fsnf6A89rrskh2X8BSVdaKhwzXNiDb/item.json
     function addItem(string calldata _item) external payable {
         bytes32 itemID = keccak256(abi.encodePacked(_item));
         Item storage item = items[itemID];

contracts/deployments/arbitrumSepoliaDevnet/CurateView.json

@@ -64,8 +64,8 @@ type Registry @entity {
   itemName: String
   "Plural item name for items in registry."
   itemNamePlural: String
-  "Ipfs uri pointing to file containing the list metadata."
-  metadataURI: String!
+  "Stringified JSON data containing registry metadata"
+  metadata: String
   "The parsed data describing the fields in Registry."
   fieldProps: [FieldProp!]! @derivedFrom(field: "registry")
 }

contracts/src/CurateFactory.sol

@@ -1,6 +1,6 @@
 /* eslint-disable prefer-const */
-import { log } from "@graphprotocol/graph-ts";
-import { Item, Request, Registry } from "../generated/schema";
+import { json, log } from "@graphprotocol/graph-ts";
+import { Item, Request, Registry, FieldProp } from "../generated/schema";
 
 import {
   ItemStatusChange,
@@ -12,11 +12,10 @@ import {
   ConnectedListSet,
   ListMetadataSet,
 } from "../generated/templates/Curate/Curate";
-import { ItemStatus, ONE, ZERO, getFinalRuling, getStatus } from "./utils";
+import { ItemStatus, JSONValueToBool, JSONValueToMaybeString, ONE, ZERO, getFinalRuling, getStatus } from "./utils";
 import { createRequestFromEvent } from "./entities/Request";
 import { createItemFromEvent } from "./entities/Item";
 import { ensureUser } from "./entities/User";
-import { updateRegistryMetadata } from "./CurateFactory";
 
 // Items on a List can be in 1 of 4 states:
 // - (0) Absent: The item is not registered on the List and there are no pending requests.
@@ -140,9 +139,61 @@ export function handleListMetadataSet(event: ListMetadataSet): void {
     log.error(`Registry {} not found.`, [event.address.toHexString()]);
     return;
   }
-  registry.metadataURI = event.params._listMetadata;
 
-  updateRegistryMetadata(registry.id, event.params._listMetadata);
+  registry.metadata = event.params._listMetadata;
+
+  let jsonObjValueAndSuccess = json.try_fromString(event.params._listMetadata);
+  if (!jsonObjValueAndSuccess.isOk) {
+    log.error(`Error getting json object value for registry metadata {}`, [registry.id]);
+    registry.save();
+    return;
+  }
+
+  let jsonObj = jsonObjValueAndSuccess.value.toObject();
+  if (!jsonObj) {
+    log.error(`Error converting object for registry metadata {}`, [registry.id]);
+    registry.save();
+    return;
+  }
+
+  registry.title = JSONValueToMaybeString(jsonObj.get("title"));
+  registry.description = JSONValueToMaybeString(jsonObj.get("description"));
+  registry.logoURI = JSONValueToMaybeString(jsonObj.get("logoURI"));
+  registry.policyURI = JSONValueToMaybeString(jsonObj.get("policyURI"));
+  registry.itemName = JSONValueToMaybeString(jsonObj.get("itemName"));
+  registry.itemNamePlural = JSONValueToMaybeString(jsonObj.get("itemNamePlural"));
+  registry.isListOfLists = JSONValueToBool(jsonObj.get("isListOfLists"));
+
+  let columnsValue = jsonObj.get("columns");
+  if (!columnsValue) {
+    log.error(`Error getting column values for registry {}`, [registry.id]);
+    registry.save();
+    return;
+  }
+  let columns = columnsValue.toArray();
+
+  for (let i = 0; i < columns.length; i++) {
+    let col = columns[i];
+    let colObj = col.toObject();
+
+    let label = colObj.get("label");
+
+    let checkedLabel = label ? label.toString() : "missing-label".concat(i.toString());
+
+    let description = colObj.get("description");
+    let _type = colObj.get("type");
+    let isIdentifier = colObj.get("isIdentifier");
+    let fieldPropId = registry.id + "@" + checkedLabel;
+    let fieldProp = new FieldProp(fieldPropId);
+
+    fieldProp.type = JSONValueToMaybeString(_type);
+    fieldProp.label = JSONValueToMaybeString(label);
+    fieldProp.description = JSONValueToMaybeString(description);
+    fieldProp.isIdentifier = JSONValueToBool(isIdentifier);
+    fieldProp.registry = registry.id;
+
+    fieldProp.save();
+  }
 
   registry.save();
 }