feat: new-list-metadata-flow

Author: tractorss

contracts/deployments/arbitrumSepoliaDevnet/CurateFactory.json

@@ -19,7 +19,18 @@ contract CurateFactory {
 
     /// @dev Emitted when a new Curate contract is deployed using this factory. TODO: change TCR mentions.
     /// @param _address The address of the newly deployed Curate contract.
-    event NewGTCR(CurateV2 indexed _address);
+    /// @param _listMetadata A link to registry / list metadata (title,description) using its URI
+    event NewList(CurateV2 indexed _address, string _listMetadata);
+
+    // ************************************* //
+    // *         Enums / Structs           * //
+    // ************************************* //
+
+    struct TemplateRegistryParams {
+        address templateRegistry; // The current status of the item.
+        string[2] registrationTemplateParameters; // Template and data mappings json for registration requests.
+        string[2] removalTemplateParameters; // Template and data mappings json for removal requests.
+    }
 
     // ************************************* //
     // *             Storage               * //
@@ -47,46 +58,47 @@ contract CurateFactory {
     /// @param _arbitrator Arbitrator to resolve potential disputes. The arbitrator is trusted to support appeal periods and not reenter.
     /// @param _arbitratorExtraData Extra data for the trusted arbitrator contract.
     /// @param _evidenceModule The evidence contract for the arbitrator.
-    /// @param _connectedTCR 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 _connectedList The address of the Curate contract that stores related Curate addresses. This parameter can be left empty.
+    /// @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 relay contract to add/remove items directly.
+    /// @param _listMetadata A link to registry / list metadata (title,description) using its URI
     function deploy(
         address _governor,
         IArbitratorV2 _arbitrator,
         bytes calldata _arbitratorExtraData,
         EvidenceModule _evidenceModule,
-        address _connectedTCR,
-        string[2] calldata _registrationTemplateParameters,
-        string[2] calldata _removalTemplateParameters,
-        address _templateRegistry,
+        address _connectedList,
+        TemplateRegistryParams calldata _templateRegistryParams,
         uint256[4] calldata _baseDeposits,
         uint256 _challengePeriodDuration,
-        address _relayerContract
+        address _relayerContract,
+        string memory _listMetadata
     ) public {
         CurateV2 instance = clone(curate);
         instance.initialize(
             _governor,
             _arbitrator,
             _arbitratorExtraData,
             _evidenceModule,
-            _connectedTCR,
-            _registrationTemplateParameters,
-            _removalTemplateParameters,
-            _templateRegistry,
+            _connectedList,
+            _templateRegistryParams.registrationTemplateParameters,
+            _templateRegistryParams.removalTemplateParameters,
+            _templateRegistryParams.templateRegistry,
             _baseDeposits,
             _challengePeriodDuration,
             _relayerContract
         );
         instances.push(instance);
-        emit NewGTCR(instance);
+        emit NewList(instance, _listMetadata);
     }
 
     /// @notice Adaptation of https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/contracts/proxy/Clones.sol.

contracts/deployments/arbitrumSepoliaDevnet/CurateV2.json

@@ -129,8 +129,8 @@ contract CurateV2 is IArbitrableV2 {
     event RequestSubmitted(bytes32 indexed _itemID, uint256 _requestID);
 
     /// @dev Emitted when the address of the connected Curate contract is set. The Curate is an instance of the Curate contract where each item is the address of a Curate contract related to this one.
-    /// @param _connectedTCR The address of the connected Curate. TODO: change TCR mentions.
-    event ConnectedTCRSet(address indexed _connectedTCR);
+    /// @param _connectedList The address of the connected Curate.
+    event ConnectedListSet(address indexed _connectedList);
 
     // ************************************* //
     // *            Initializer            * //
@@ -141,7 +141,7 @@ contract CurateV2 is IArbitrableV2 {
     /// @param _arbitrator Arbitrator to resolve potential disputes. The arbitrator is trusted to support appeal periods and not reenter.
     /// @param _arbitratorExtraData Extra data for the trusted arbitrator contract.
     /// @param _evidenceModule The evidence contract for the arbitrator.
-    /// @param _connectedTCR The address of the Curate contract that stores related Curate addresses. This parameter can be left empty.
+    /// @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.
@@ -157,7 +157,7 @@ contract CurateV2 is IArbitrableV2 {
         IArbitratorV2 _arbitrator,
         bytes calldata _arbitratorExtraData,
         EvidenceModule _evidenceModule,
-        address _connectedTCR,
+        address _connectedList,
         string[2] calldata _registrationTemplateParameters,
         string[2] calldata _removalTemplateParameters,
         address _templateRegistry,
@@ -196,8 +196,8 @@ contract CurateV2 is IArbitrableV2 {
             })
         );
 
-        if (_connectedTCR != address(0)) {
-            emit ConnectedTCRSet(_connectedTCR);
+        if (_connectedList != address(0)) {
+            emit ConnectedListSet(_connectedList);
         }
     }
 
@@ -241,10 +241,10 @@ contract CurateV2 is IArbitrableV2 {
         governor = _governor;
     }
 
-    /// @dev Change the address of connectedTCR, the Curate instance that stores addresses of Curate contracts related to this one.
-    /// @param _connectedTCR The address of the connectedTCR contract to use.
-    function changeConnectedTCR(address _connectedTCR) external onlyGovernor {
-        emit ConnectedTCRSet(_connectedTCR);
+    /// @dev Change the address of connectedList, the Curate instance that stores addresses of Curate contracts related to this one.
+    /// @param _connectedList The address of the connectedList contract to use.
+    function changeConnectedList(address _connectedList) external onlyGovernor {
+        emit ConnectedListSet(_connectedList);
     }
 
     /// @dev Change the address of the relay contract.

contracts/deployments/arbitrumSepoliaDevnet/CurateView.json

@@ -24,10 +24,10 @@
     "node": "20.11.0"
   },
   "dependencies": {
-    "@graphprotocol/graph-ts": "^0.32.0"
+    "@graphprotocol/graph-ts": "^0.33.0"
   },
   "devDependencies": {
-    "@graphprotocol/graph-cli": "0.64.0",
+    "@graphprotocol/graph-cli": "0.68.5",
     "@kleros/curate-v2-eslint-config": "workspace:^",
     "@kleros/curate-v2-prettier-config": "workspace:^",
     "gluegun": "^5.1.2",

contracts/src/CurateFactory.sol

@@ -1,11 +1,11 @@
 enum Status {
-  "The item is not registered on the TCR and there are no pending requests."
+  "The item is not registered on the List and there are no pending requests."
   absent
   "The item is registered and there are no pending requests."
   registered
-  "The item is not registered on the TCR, but there is a pending registration request."
+  "The item is not registered on the List, but there is a pending registration request."
   registrationRequested
-  "The item is registered on the TCR, but there is a pending removal request. These are sometimes also called removal requests."
+  "The item is registered on the List, but there is a pending removal request. These are sometimes also called removal requests."
   clearingRequested
 }
 
@@ -46,10 +46,16 @@ type Registry @entity {
   items: [Item!]! @derivedFrom(field: "registry")
   "The requests submitted to this list"
   requests: [Request!]! @derivedFrom(field: "registry")
-  "Connected TCR. Can be the 0 address. In practice, will never be null."
-  connectedTCR: Bytes
+  "Connected List. Can be the 0 address. In practice, will never be null."
+  connectedList: Bytes
   "The address that registered the curate"
   registerer: User!
+  "Registry metadata"
+  title: String
+  description: String
+  logoURI: String
+  policyURI: String
+  metadataURI: String!
 }
 
 type Item @entity {

contracts/src/CurateV2.sol

@@ -7,21 +7,21 @@ import {
   RequestSubmitted,
   NewItem,
   Ruling,
-  ConnectedTCRSet as ConnectedTCRSetEvent,
   Curate,
   DisputeRequest,
+  ConnectedListSet,
 } from "../generated/templates/Curate/Curate";
 import { ItemStatus, ONE, ZERO, getFinalRuling, getStatus } from "./utils";
 import { createRequestFromEvent } from "./entities/Request";
 import { createItemFromEvent } from "./entities/Item";
 import { ensureUser } from "./entities/User";
 
-// Items on a TCR can be in 1 of 4 states:
-// - (0) Absent: The item is not registered on the TCR and there are no pending requests.
+// 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.
 // - (1) Registered: The item is registered and there are no pending requests.
-// - (2) Registration Requested: The item is not registered on the TCR, but there is a pending
+// - (2) Registration Requested: The item is not registered on the List, but there is a pending
 //       registration request.
-// - (3) Clearing Requested: The item is registered on the TCR, but there is a pending removal
+// - (3) Clearing Requested: The item is registered on the List, but there is a pending removal
 //       request. These are sometimes also called removal requests.
 //
 // Registration and removal requests can be challenged. Once the request resolves (either by
@@ -35,7 +35,7 @@ import { ensureUser } from "./entities/User";
 //
 // Example:
 // requestIndex: 0
-// requestID: <itemID>@<tcrAddress>-0
+// requestID: <itemID>@<listAddress>-0
 //
 // The only exception to this rule is the itemID, which is the in-contract itemID.
 //
@@ -121,13 +121,13 @@ export function handleStatusUpdated(event: ItemStatusChange): void {
   request.save();
 }
 
-export function handleConnectedTCRSet(event: ConnectedTCRSetEvent): void {
+export function handleConnectedListSet(event: ConnectedListSet): void {
   let registry = Registry.load(event.address.toHexString());
   if (!registry) {
     log.error(`Registry {} not found.`, [event.address.toHexString()]);
     return;
   }
-  registry.connectedTCR = event.params._connectedTCR;
+  registry.connectedList = event.params._connectedList;
 
   registry.save();
 }

subgraph/package.json

@@ -1,12 +1,13 @@
 /* eslint-disable prefer-const */
-import { NewGTCR } from "../generated/CurateFactory/CurateFactory";
+import { Bytes, ipfs, json, log } from "@graphprotocol/graph-ts";
+import { NewList } from "../generated/CurateFactory/CurateFactory";
 import { Registry, User } from "../generated/schema";
 import { Curate } from "../generated/templates";
 import { ensureCounter } from "./entities/Counters";
 import { ensureUser } from "./entities/User";
-import { ONE } from "./utils";
+import { JSONValueToMaybeString, ONE } from "./utils";
 
-export function handleNewCurate(event: NewGTCR): void {
+export function handleNewCurate(event: NewList): void {
   Curate.create(event.params._address);
 
   let registry = new Registry(event.params._address.toHexString());
@@ -17,6 +18,33 @@ export function handleNewCurate(event: NewGTCR): void {
   if (!doesCuratorExist) counter.numberOfCurators = counter.numberOfCurators.plus(ONE);
 
   registry.registerer = ensureUser(event.transaction.from.toHexString()).id;
+  registry.metadataURI = event.params._listMetadata;
+
+  let jsonStr = ipfs.cat(registry.metadataURI);
+  if (!jsonStr) {
+    log.error("Failed to fetch registry metadata #{} JSON: {}", [registry.id, registry.metadataURI]);
+    registry.save();
+    return;
+  }
+
+  let jsonObjValueAndSuccess = json.try_fromBytes(jsonStr as Bytes);
+  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"));
 
   counter.save();
   registry.save();

subgraph/schema.graphql

@@ -1,4 +1,4 @@
-specVersion: 0.0.4
+specVersion: 0.0.7
 description: Curate
 features:
   - fullTextSearch
@@ -11,9 +11,9 @@ dataSources:
     name: CurateFactory
     network: arbitrum-sepolia
     source:
-      address: "0x5D03d22229899cd7Af84a3F0f9c39B24F51c8E21"
+      address: "0xF5B335323e1b8c219A9e0bF798a2bFf8325e1cE1"
       abi: CurateFactory
-      startBlock: 14782094
+      startBlock: 23023734
     mapping:
       kind: ethereum/events
       apiVersion: 0.0.6
@@ -24,7 +24,7 @@ dataSources:
         - name: CurateFactory
           file: ./../contracts/deployments/arbitrumSepoliaDevnet/CurateFactory.json
       eventHandlers:
-        - event: NewGTCR(indexed address)
+        - event: NewList(indexed address,string)
           handler: handleNewCurate
       file: ./src/CurateFactory.ts
 templates:
@@ -55,6 +55,6 @@ templates:
           handler: handleStatusUpdated
         - event: Ruling(indexed address,indexed uint256,uint256)
           handler: handleRuling
-        - event: ConnectedTCRSet(indexed address)
-          handler: handleConnectedTCRSet
+        - event: ConnectedListSet(indexed address)
+          handler: handleConnectedListSet
       file: ./src/Curate.ts