feat(web): add-counters-and-user-entity

Author: tractorss

subgraph/schema.graphql

@@ -1,12 +1,12 @@
 enum Status {
   "The item is not registered on the TCR and there are no pending requests."
-  Absent
+  absent
   "The item is registered and there are no pending requests."
-  Registered
+  registered
   "The item is not registered on the TCR, but there is a pending registration request."
-  RegistrationRequested
+  registrationRequested
   "The item is registered on the TCR, but there is a pending removal request. These are sometimes also called removal requests."
-  ClearingRequested
+  clearingRequested
 }
 
 enum Ruling {
@@ -23,26 +23,33 @@ type Arbitrator @entity {
   id: ID!
 }
 
+type Counter @entity {
+  id: ID!
+  totalRegistries: BigInt!
+  totalItems: BigInt!
+  totalDeposits: BigInt!
+  numberOfCurators: BigInt!
+}
+
+type User @entity {
+  id: ID! # address
+  registry: [Registry!]! @derivedFrom(field: "registerer")
+  items: [Item!]! @derivedFrom(field: "registerer")
+  requests: [Request!]! @derivedFrom(field: "requester")
+  challenges: [Request!]! @derivedFrom(field: "challenger")
+}
+
 type Registry @entity {
   "The registry address"
   id: ID!
   "The items submitted to this list"
   items: [Item!]! @derivedFrom(field: "registry")
   "The requests submitted to this list"
   requests: [Request!]! @derivedFrom(field: "registry")
-  "The total number of items in absent state."
-  numberOfAbsent: BigInt!
-  "The total number of items in registered state."
-  numberOfRegistered: BigInt!
-  "The total number of items in the registration requested state."
-  numberOfRegistrationRequested: BigInt!
-  numberOfClearingRequested: BigInt!
-  "The total number of items in the challenged registration state."
-  numberOfChallengedRegistrations: BigInt!
-  "The total number of items in the challenged removal state."
-  numberOfChallengedClearing: BigInt!
   "Connected TCR. Can be the 0 address. In practice, will never be null."
   connectedTCR: Bytes
+  "The address that registered the curate"
+  registerer: User!
 }
 
 type Item @entity {
@@ -83,9 +90,11 @@ type Item @entity {
   "Whether the item is currently disputed."
   disputed: Boolean!
   "The account that made the latest request to the item."
-  latestRequester: Bytes!
+  latestRequester: User
   "The account that challenged the latest request, if any."
-  latestChallenger: Bytes!
+  latestChallenger: User
+  "The user that requested the first request / registration"
+  registerer: User!
 }
 
 type _Schema_
@@ -117,10 +126,10 @@ type Request @entity {
   submissionTime: BigInt!
   "True if the request was executed and/or any raised disputes were resolved."
   resolved: Boolean!
-  "The address of the party that made a request"
-  requester: Bytes!
-  "The address of the party that challenged the request"
-  challenger: Bytes!
+  "The party that made a request"
+  requester: User!
+  "The party that challenged the request"
+  challenger: User
   "The arbitrator trusted to solve disputes for this request."
   arbitrator: Bytes!
   "The extra data for the trusted arbitrator of this request."

subgraph/src/Counters.ts

@@ -1,6 +1,6 @@
 /* eslint-disable prefer-const */
 import { log } from "@graphprotocol/graph-ts";
-import { Item, ItemProp, Request, Registry } from "../generated/schema";
+import { Item, Request, Registry } from "../generated/schema";
 
 import {
   ItemStatusChange,
@@ -11,18 +11,10 @@ import {
   Curate,
   DisputeRequest,
 } from "../generated/templates/Curate/Curate";
-import {
-  CLEARING_REQUESTED_CODE,
-  ONE,
-  REGISTRATION_REQUESTED_CODE,
-  ZERO,
-  getExtendedStatus,
-  getFinalRuling,
-  getStatus,
-} from "./utils";
-import { updateCounters } from "./Counters";
+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.
@@ -68,37 +60,13 @@ export function handleRequestSubmitted(event: RequestSubmitted): void {
     return;
   }
 
-  // `previousStatus` and `newStatus` are used for accounting.
-  // Note that if this is the very first request of an item,
-  // item.status and item.dispute are dirty because they were set by
-  // handleNewItem, executed before this handler and so `previousStatus`
-  // would be wrong. We use a condition to detect if its the very
-  // first request and if so, ignore its contents (see below in accounting).
-  let previousStatus = getExtendedStatus(item.disputed, item.status);
-  let newStatus = getExtendedStatus(item.disputed, item.status); // TODO
-
   item.numberOfRequests = item.numberOfRequests.plus(ONE);
   item.status = getStatus(itemInfo.value0);
-  item.latestRequester = event.transaction.from;
+  item.latestRequester = ensureUser(event.transaction.from.toHexString()).id;
   item.latestRequestResolutionTime = ZERO;
   item.latestRequestSubmissionTime = event.block.timestamp;
 
   createRequestFromEvent(event);
-
-  // Accounting.
-  if (itemInfo.value1.equals(ONE)) {
-    let registry = Registry.load(event.address.toHexString());
-    if (!registry) {
-      log.error(`Registry at address {} not found`, [event.address.toHexString()]);
-      return;
-    }
-    // This is the first request for this item, which must be
-    // a registration request.
-    registry.numberOfRegistrationRequested = registry.numberOfRegistrationRequested.plus(ONE);
-    registry.save();
-  } else {
-    updateCounters(previousStatus, newStatus, event.address);
-  }
   item.save();
 }
 
@@ -107,7 +75,7 @@ export function handleStatusUpdated(event: ItemStatusChange): void {
   // All other status updates are handled elsewhere.
   let curate = Curate.bind(event.address);
   let itemInfo = curate.getItemInfo(event.params._itemID);
-  if (itemInfo.value0 == REGISTRATION_REQUESTED_CODE || itemInfo.value0 == CLEARING_REQUESTED_CODE) {
+  if (itemInfo.value0 == ItemStatus.REGISTRATION_REQUESTED || itemInfo.value0 == ItemStatus.CLEARING_REQUESTED) {
     // Request not yet resolved. No-op as changes are handled
     // elsewhere. (RequestSubmitted handler)
     return;
@@ -120,16 +88,8 @@ export function handleStatusUpdated(event: ItemStatusChange): void {
     return;
   }
 
-  // We take the previous and new extended statuses for accounting purposes.
-  let previousStatus = getExtendedStatus(item.disputed, item.status);
   item.status = getStatus(itemInfo.value0);
   item.disputed = false;
-  let newStatus = getExtendedStatus(item.disputed, item.status);
-
-  if (previousStatus != newStatus) {
-    // Accounting.
-    updateCounters(previousStatus, newStatus, event.address);
-  }
 
   if (event.params._updatedDirectly) {
     // Direct actions (e.g. addItemDirectly and removeItemDirectly)
@@ -204,11 +164,9 @@ export function handleRequestChallenged(event: DisputeRequest): void {
     return;
   }
   let itemInfo = curate.getItemInfo(itemID);
-  let previousStatus = getExtendedStatus(item.disputed, item.status);
   item.disputed = true;
-  item.latestChallenger = event.transaction.from;
+  item.latestChallenger = ensureUser(event.transaction.from.toHexString()).id;
   item.status = getStatus(itemInfo.value0);
-  let newStatus = getExtendedStatus(item.disputed, item.status);
 
   let requestIndex = item.numberOfRequests.minus(ONE);
   let requestID = graphItemID + "-" + requestIndex.toString();
@@ -219,12 +177,9 @@ export function handleRequestChallenged(event: DisputeRequest): void {
   }
 
   request.disputed = true;
-  request.challenger = event.transaction.from;
+  request.challenger = ensureUser(event.transaction.from.toHexString()).id;
   request.disputeID = event.params._arbitrableDisputeID;
 
-  // Accounting.
-  updateCounters(previousStatus, newStatus, event.address);
-
   request.save();
   item.save();
 }

subgraph/src/Curate.ts

@@ -1,19 +1,23 @@
 /* eslint-disable prefer-const */
 import { NewGTCR } from "../generated/CurateFactory/CurateFactory";
-import { Registry } from "../generated/schema";
+import { Registry, User } from "../generated/schema";
 import { Curate } from "../generated/templates";
-import { ZERO } from "./utils";
+import { ensureCounter } from "./entities/Counters";
+import { ensureUser } from "./entities/User";
+import { ONE } from "./utils";
 
 export function handleNewCurate(event: NewGTCR): void {
   Curate.create(event.params._address);
 
   let registry = new Registry(event.params._address.toHexString());
+  let counter = ensureCounter();
 
-  registry.numberOfAbsent = ZERO;
-  registry.numberOfRegistered = ZERO;
-  registry.numberOfRegistrationRequested = ZERO;
-  registry.numberOfClearingRequested = ZERO;
-  registry.numberOfChallengedRegistrations = ZERO;
-  registry.numberOfChallengedClearing = ZERO;
+  counter.totalRegistries = counter.totalRegistries.plus(ONE);
+  let doesCuratorExist = User.load(event.transaction.from.toHexString());
+  if (!doesCuratorExist) counter.numberOfCurators = counter.numberOfCurators.plus(ONE);
+
+  registry.registerer = ensureUser(event.transaction.from.toHexString()).id;
+
+  counter.save();
   registry.save();
 }

subgraph/src/CurateFactory.ts

@@ -0,0 +1,15 @@
+import { Counter } from "../../generated/schema";
+import { ZERO } from "../utils";
+
+export function ensureCounter(): Counter {
+  const counter = Counter.load("0");
+  if (counter) return counter;
+
+  let newCounter = new Counter("0");
+  newCounter.totalDeposits = ZERO;
+  newCounter.totalItems = ZERO;
+  newCounter.totalRegistries = ZERO;
+  newCounter.numberOfCurators = ZERO;
+  newCounter.save();
+  return newCounter;
+}

subgraph/src/entities/Counters.ts

@@ -1,17 +1,17 @@
 import { Bytes, ipfs, json, log } from "@graphprotocol/graph-ts";
-import { Item, ItemProp, Registry } from "../../generated/schema";
+import { Item, ItemProp, Registry, User } from "../../generated/schema";
 import { Curate, NewItem } from "../../generated/templates/Curate/Curate";
-import { JSONValueToBool, JSONValueToMaybeString, ZERO, ZERO_ADDRESS, getStatus } from "../utils";
+import { JSONValueToBool, JSONValueToMaybeString, ONE, ZERO, ZERO_ADDRESS, getStatus } from "../utils";
+import { ensureCounter } from "./Counters";
+import { ensureUser } from "./User";
 
 export function createItemFromEvent(event: NewItem): void {
   // We assume this is an item added via addItemDirectly and care
   // only about saving the item json data.
   // If it was emitted via addItem, all the missing/wrong data regarding
   // things like submission time, arbitrator and deposit will be set in
   // handleRequestSubmitted.
-  //
-  // Accounting for items added or removed directly is done
-  // inside handleStatusUpdated.
+
   let graphItemID = event.params._itemID.toHexString() + "@" + event.address.toHexString();
   let curate = Curate.bind(event.address);
   let registry = Registry.load(event.address.toHexString());
@@ -20,6 +20,13 @@ export function createItemFromEvent(event: NewItem): void {
     return;
   }
 
+  let counter = ensureCounter();
+
+  counter.totalItems = counter.totalItems.plus(ONE);
+  let doesCuratorExist = User.load(event.transaction.from.toHexString());
+  if (!doesCuratorExist) counter.numberOfCurators = counter.numberOfCurators.plus(ONE);
+  counter.save();
+
   let itemInfo = curate.getItemInfo(event.params._itemID);
 
   let item = new Item(graphItemID);
@@ -30,8 +37,7 @@ export function createItemFromEvent(event: NewItem): void {
   item.registryAddress = event.address;
   item.disputed = false;
   item.status = getStatus(itemInfo.value0);
-  item.latestRequester = ZERO_ADDRESS;
-  item.latestChallenger = ZERO_ADDRESS;
+  item.registerer = ensureUser(event.transaction.from.toHexString()).id;
   item.latestRequestResolutionTime = ZERO;
   item.latestRequestSubmissionTime = ZERO;