feat: better-list-metadata-handling

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/0x5D03d22229899cd7Af84a3F0f9c39B24F51c8E21)
-- [CurateV2](https://sepolia.arbiscan.io/address/0x091Ba21a03aab5b4cfee5A770667cc53EF2cB1bc)
-- [CurateView](https://sepolia.arbiscan.io/address/0x7152126B8F9f9A9Bd20A37072D198F59773E61dA)
+- [CurateFactory](https://sepolia.arbiscan.io/address/0xcfd2315053763f6ae964f721e8a6Ea44286a9baF)
+- [CurateV2](https://sepolia.arbiscan.io/address/0xd9ea52247FeBd2258823Ff9f4fC49C9cD53fe8de)
+- [CurateView](https://sepolia.arbiscan.io/address/0x2532DBf9a2877C1FDd8286f8f9ef51b76184604F)
 
 #### Sepolia
 

contracts/deployments/arbitrumSepoliaDevnet/CurateFactory.json

@@ -132,6 +132,10 @@ contract CurateV2 is IArbitrableV2 {
     /// @param _connectedList The address of the connected Curate.
     event ConnectedListSet(address indexed _connectedList);
 
+    /// @dev Emitted when the list metadata ipfs uri is updated.
+    /// @param _listMetadata Ipfs uri to list metadata.
+    event ListMetadataSet(string _listMetadata);
+
     // ************************************* //
     // *            Initializer            * //
     // ************************************* //
@@ -247,6 +251,12 @@ contract CurateV2 is IArbitrableV2 {
         emit ConnectedListSet(_connectedList);
     }
 
+    /// @dev Update list metadata ipfs uri.
+    /// @param _listMetadata Ipfs uri to list metadata
+    function changeListMetadata(string calldata _listMetadata) external onlyGovernor {
+        emit ListMetadataSet(_listMetadata);
+    }
+
     /// @dev Change the address of the relay contract.
     /// @param _relayerContract The new address of the relay contract.
     function changeRelayerContract(address _relayerContract) external onlyGovernor {

contracts/deployments/arbitrumSepoliaDevnet/CurateV2.json

@@ -50,12 +50,24 @@ type Registry @entity {
   connectedList: Bytes
   "The address that registered the curate"
   registerer: User!
-  "Registry metadata"
+  "Registry's Title"
   title: String
+  "Registry's description"
   description: String
+  "A link to registry's logo."
   logoURI: String
+  "A link to file describing registry's policy."
   policyURI: String
+  "Field to identify if a list is a 'List of Lists.'"
+  isListOfLists: Boolean
+  "Item name for a item in registry."
+  itemName: String
+  "Plural item name for items in registry."
+  itemNamePlural: String
+  "Ipfs uri pointing to file containing the list metadata."
   metadataURI: String!
+  "The parsed data describing the fields in Registry."
+  fieldProps: [FieldProp!]! @derivedFrom(field: "registry")
 }
 
 type Item @entity {
@@ -121,6 +133,15 @@ type ItemProp @entity {
   item: Item!
 }
 
+type FieldProp @entity {
+  id: ID!
+  type: String!
+  label: String!
+  description: String!
+  isIdentifier: Boolean!
+  registry: Registry!
+}
+
 type Request @entity {
   "The item ID (which is the keccak256 hash of its data)."
   id: ID!

contracts/deployments/arbitrumSepoliaDevnet/CurateView.json

@@ -10,11 +10,13 @@ import {
   Curate,
   DisputeRequest,
   ConnectedListSet,
+  ListMetadataSet,
 } 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";
+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.
@@ -132,6 +134,19 @@ export function handleConnectedListSet(event: ConnectedListSet): void {
   registry.save();
 }
 
+export function handleListMetadataSet(event: ListMetadataSet): void {
+  let registry = Registry.load(event.address.toHexString());
+  if (!registry) {
+    log.error(`Registry {} not found.`, [event.address.toHexString()]);
+    return;
+  }
+  registry.metadataURI = event.params._listMetadata;
+
+  updateRegistryMetadata(registry.id, event.params._listMetadata);
+
+  registry.save();
+}
+
 export function handleRuling(event: Ruling): void {
   let curate = Curate.bind(event.address);
   let itemID = curate.arbitratorDisputeIDToItemID(event.params._arbitrator, event.params._disputeID);

contracts/src/CurateV2.sol

@@ -1,11 +1,11 @@
 /* eslint-disable prefer-const */
 import { Bytes, ipfs, json, log } from "@graphprotocol/graph-ts";
 import { NewList } from "../generated/CurateFactory/CurateFactory";
-import { Registry, User } from "../generated/schema";
+import { FieldProp, Registry, User } from "../generated/schema";
 import { Curate } from "../generated/templates";
 import { ensureCounter } from "./entities/Counters";
 import { ensureUser } from "./entities/User";
-import { JSONValueToMaybeString, ONE } from "./utils";
+import { JSONValueToBool, JSONValueToMaybeString, ONE } from "./utils";
 
 export function handleNewCurate(event: NewList): void {
   Curate.create(event.params._address);
@@ -20,9 +20,24 @@ export function handleNewCurate(event: NewList): void {
   registry.registerer = ensureUser(event.transaction.from.toHexString()).id;
   registry.metadataURI = event.params._listMetadata;
 
-  let jsonStr = ipfs.cat(registry.metadataURI);
+  counter.save();
+  registry.save();
+  updateRegistryMetadata(registry.id, event.params._listMetadata);
+}
+
+export function updateRegistryMetadata(registryID: string, metadataURI: string): void {
+  let registry = Registry.load(registryID);
+
+  if (!registry) {
+    log.error(`Registry {} not found.`, [registryID]);
+    return;
+  }
+
+  registry.metadataURI = metadataURI;
+
+  let jsonStr = ipfs.cat(metadataURI);
   if (!jsonStr) {
-    log.error("Failed to fetch registry metadata #{} JSON: {}", [registry.id, registry.metadataURI]);
+    log.error("Failed to fetch registry metadata #{} JSON: {}", [registry.id, metadataURI]);
     registry.save();
     return;
   }
@@ -45,7 +60,40 @@ export function handleNewCurate(event: NewList): void {
   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 {}`, [registryID]);
+    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 = registryID + "@" + 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();
+  }
 
-  counter.save();
   registry.save();
 }

subgraph/schema.graphql

@@ -11,9 +11,9 @@ dataSources:
     name: CurateFactory
     network: arbitrum-sepolia
     source:
-      address: "0xF5B335323e1b8c219A9e0bF798a2bFf8325e1cE1"
+      address: "0xcfd2315053763f6ae964f721e8a6Ea44286a9baF"
       abi: CurateFactory
-      startBlock: 23023734
+      startBlock: 23394953
     mapping:
       kind: ethereum/events
       apiVersion: 0.0.6
@@ -57,4 +57,6 @@ templates:
           handler: handleRuling
         - event: ConnectedListSet(indexed address)
           handler: handleConnectedListSet
+        - event: ListMetadataSet(string)
+          handler: handleListMetadataSet
       file: ./src/Curate.ts