feat(subgraph): notification schema

Author: shotaronowhere

subgraph/schema.graphql

@@ -66,6 +66,7 @@ type User @entity {
   shifts: [TokenAndETHShift!]! @derivedFrom(field: "juror")
   draws: [Draw!]! @derivedFrom(field: "juror")
   activeDisputes: BigInt!
+  rounds: [Round!]!
   disputes: [Dispute!]!
   resolvedDisputes: [Dispute!]!
   totalResolvedDisputes: BigInt!
@@ -118,6 +119,9 @@ type Court @entity {
   id: ID!
   policy: String
   name: String
+  description: String
+  summary: String
+  requiredSkills: String
   parent: Court
   hiddenVotes: Boolean!
   children: [Court!]! @derivedFrom(field: "parent")
@@ -142,16 +146,20 @@ type Court @entity {
 
 type Dispute @entity {
   id: ID!
+  disputeID: BigInt!
   court: Court!
   arbitrated: Arbitrable!
   period: Period!
   ruled: Boolean!
   currentRuling: BigInt!
   tied: Boolean!
   overridden: Boolean!
-  lastPeriodChange: BigInt!
+  periodDeadline: BigInt! # uint256j
+  periodNotificationIndex: BigInt!
+  lastPeriodChangeTs: BigInt!
+  users: [User!]!
+  lastPeriodChangeBlock: BigInt!
   lastPeriodChangeBlockNumber: BigInt!
-  periodDeadline: BigInt!
   rounds: [Round!]! @derivedFrom(field: "dispute")
   currentRound: Round!
   currentRoundIndex: BigInt!
@@ -160,12 +168,18 @@ type Dispute @entity {
   disputeKitDispute: DisputeKitDispute @derivedFrom(field: "coreDispute")
 }
 
+type PeriodIndexCounter @entity {
+  id: String!
+  counter: BigInt!
+}
+
 type Round @entity {
   id: ID! # dispute.id-dispute.rounds.length
   disputeKit: DisputeKit!
   tokensAtStakePerJuror: BigInt!
   totalFeesForJurors: BigInt!
   nbVotes: BigInt!
+  isCurrentRound: Boolean!
   repartitions: BigInt!
   penalties: BigInt!
   drawnJurors: [Draw!]! @derivedFrom(field: "round")
@@ -181,6 +195,7 @@ type Draw @entity(immutable: true) {
   juror: User!
   voteID: BigInt!
   vote: Vote @derivedFrom(field: "draw")
+  drawNotificationIndex: BigInt
 }
 
 type DisputeKit @entity {

subgraph/src/KlerosCore.ts

@@ -25,7 +25,7 @@ import { updateJurorDelayedStake, updateJurorStake } from "./entities/JurorToken
 import { createDrawFromEvent } from "./entities/Draw";
 import { updateTokenAndEthShiftFromEvent } from "./entities/TokenAndEthShift";
 import { updateArbitrableCases } from "./entities/Arbitrable";
-import { Court, Dispute, User } from "../generated/schema";
+import { Court, Dispute, User, PeriodIndexCounter } from "../generated/schema";
 import { BigInt } from "@graphprotocol/graph-ts";
 import { updatePenalty } from "./entities/Penalty";
 import { ensureFeeToken } from "./entities/FeeToken";
@@ -126,7 +126,19 @@ export function handleNewPeriod(event: NewPeriod): void {
   }
 
   dispute.period = newPeriod;
-  dispute.lastPeriodChange = event.block.timestamp;
+  dispute.lastPeriodChangeTs = event.block.timestamp;
+  dispute.lastPeriodChangeBlock = event.block.number;
+  let counter = PeriodIndexCounter.load(newPeriod);
+  if (!counter) {
+    counter = new PeriodIndexCounter(newPeriod);
+    counter.counter = BigInt.fromI32(0);
+  }
+  dispute.periodNotificationIndex = counter.counter;
+  const contract = KlerosCore.bind(event.address);
+  const courtContractState = contract.getTimesPerPeriod(BigInt.fromString(dispute.court));
+  dispute.periodDeadline = event.block.timestamp.plus(courtContractState[event.params._period]);
+  counter.counter = counter.counter.plus(ONE);
+  counter.save();
   dispute.lastPeriodChangeBlockNumber = event.block.number;
   if (newPeriod !== "execution") {
     dispute.periodDeadline = event.block.timestamp.plus(court.timesPerPeriod[event.params._period]);

subgraph/src/PolicyRegistry.ts

@@ -1,12 +1,49 @@
 import { PolicyUpdate } from "../generated/PolicyRegistry/PolicyRegistry";
 import { Court } from "../generated/schema";
+import { ipfs, log, json, Bytes } from "@graphprotocol/graph-ts";
 
 export function handlePolicyUpdate(event: PolicyUpdate): void {
   const courtID = event.params._courtID.toString();
   const court = Court.load(courtID);
   if (court) {
     court.policy = event.params._policy;
     court.name = event.params._courtName;
+
+    let jsonStr = ipfs.cat(event.params._policy);
+    if (!jsonStr) {
+      log.error("Failed to fetch policy #{} SubcourtID: {}", [event.params._policy, event.params._courtID.toString()]);
+      court.save();
+      return;
+    }
+
+    let jsonObjValueAndSuccess = json.try_fromBytes(jsonStr as Bytes);
+    if (!jsonObjValueAndSuccess.isOk) {
+      log.error(`Error getting json object value for policy #{} SubcourtID: {}`, [
+        event.params._policy,
+        event.params._courtID.toString(),
+      ]);
+      court.save();
+      return;
+    }
+
+    let jsonObj = jsonObjValueAndSuccess.value.toObject();
+    if (!jsonObj) {
+      log.error(`Error converting object value for policy #{} SubcourtID: {}`, [
+        event.params._policy,
+        event.params._courtID.toString(),
+      ]);
+      court.save();
+      return;
+    }
+
+    const name = jsonObj.get("name");
+    court.name = name ? name.toString() : null;
+
+    const description = jsonObj.get("description");
+    court.description = description ? description.toString() : null;
+
+    const requiredSkills = jsonObj.get("requiredSkills");
+    court.requiredSkills = requiredSkills ? requiredSkills.toString() : null;
     court.save();
   }
 }

subgraph/src/entities/Dispute.ts

@@ -1,6 +1,7 @@
 import { KlerosCore, DisputeCreation } from "../../generated/KlerosCore/KlerosCore";
-import { Court, Dispute } from "../../generated/schema";
-import { ZERO } from "../utils";
+import { Court, Dispute, PeriodIndexCounter } from "../../generated/schema";
+import { ZERO, ONE } from "../utils";
+import { BigInt } from "@graphprotocol/graph-ts";
 
 export function createDisputeFromEvent(event: DisputeCreation): void {
   const contract = KlerosCore.bind(event.address);
@@ -9,14 +10,25 @@ export function createDisputeFromEvent(event: DisputeCreation): void {
   const dispute = new Dispute(disputeID.toString());
   const courtID = disputeContractState.value0.toString();
   dispute.court = courtID;
+  dispute.disputeID = disputeID;
   dispute.arbitrated = event.params._arbitrable.toHexString();
   dispute.period = "evidence";
   dispute.ruled = false;
   dispute.currentRuling = ZERO;
   dispute.tied = true;
   dispute.overridden = false;
-  dispute.lastPeriodChange = event.block.timestamp;
+  dispute.users = [];
+  dispute.lastPeriodChangeTs = event.block.timestamp;
+  dispute.lastPeriodChangeBlock = event.block.timestamp;
   dispute.lastPeriodChangeBlockNumber = event.block.number;
+  let counter = PeriodIndexCounter.load("evidence");
+  if (!counter) {
+    counter = new PeriodIndexCounter("evidence");
+    counter.counter = BigInt.fromI32(0);
+  }
+  dispute.periodNotificationIndex = counter.counter;
+  counter.counter = counter.counter.plus(ONE);
+  counter.save();
   const court = Court.load(courtID);
   if (!court) return;
   dispute.periodDeadline = event.block.timestamp.plus(court.timesPerPeriod[0]);

subgraph/src/entities/Draw.ts

@@ -1,5 +1,6 @@
 import { Draw as DrawEvent } from "../../generated/KlerosCore/KlerosCore";
-import { Draw } from "../../generated/schema";
+import { Draw, PeriodIndexCounter, User } from "../../generated/schema";
+import { BigInt } from "@graphprotocol/graph-ts";
 
 export function createDrawFromEvent(event: DrawEvent): void {
   const disputeID = event.params._disputeID.toString();
@@ -9,6 +10,20 @@ export function createDrawFromEvent(event: DrawEvent): void {
   const drawID = `${disputeID}-${roundIndex.toString()}-${voteID.toString()}`;
   const draw = new Draw(drawID);
   draw.blockNumber = event.block.number;
+  let counter = PeriodIndexCounter.load("draw");
+  if (!counter) {
+    counter = new PeriodIndexCounter("draw");
+    counter.counter = BigInt.fromI32(0);
+  }
+  const user = User.load(event.params._address.toHexString());
+  if (user) {
+    const duplicateNotification = user.disputes.includes(disputeID);
+    if (!duplicateNotification) {
+      draw.drawNotificationIndex = counter.counter;
+      counter.counter = counter.counter.plus(BigInt.fromI32(1));
+      counter.save();
+    }
+  }
   draw.dispute = disputeID;
   draw.round = roundID;
   draw.juror = event.params._address.toHexString();

subgraph/src/entities/Round.ts

@@ -9,6 +9,7 @@ export function createRoundFromRoundInfo(
 ): void {
   const roundID = `${disputeID.toString()}-${roundIndex.toString()}`;
   const round = new Round(roundID);
+  round.isCurrentRound = true;
   const feeToken = roundInfo.feeToken.toHexString();
   round.feeToken = feeToken === "0x0000000000000000000000000000000000000000" ? null : feeToken;
   round.disputeKit = roundInfo.disputeKitID.toString();

subgraph/src/entities/User.ts

@@ -1,5 +1,5 @@
-import { BigInt } from "@graphprotocol/graph-ts";
-import { User } from "../../generated/schema";
+import { BigInt, log } from "@graphprotocol/graph-ts";
+import { User, Dispute } from "../../generated/schema";
 import { ONE, ZERO } from "../utils";
 
 export function ensureUser(id: string): User {
@@ -18,6 +18,7 @@ export function createUserFromAddress(id: string): User {
   user.totalDelayed = ZERO;
   user.activeDisputes = ZERO;
   user.disputes = [];
+  user.rounds = [];
   user.resolvedDisputes = [];
   user.totalResolvedDisputes = ZERO;
   user.totalAppealingDisputes = ZERO;
@@ -34,6 +35,15 @@ export function addUserActiveDispute(id: string, disputeID: string): void {
     return;
   }
   user.disputes = user.disputes.concat([disputeID]);
+  const dispute = Dispute.load(disputeID);
+  if (!dispute) {
+    log.error("Dispute {} not found", [disputeID]);
+    return;
+  } else {
+    dispute.users.push(id);
+    dispute.save();
+  }
+
   user.activeDisputes = user.activeDisputes.plus(ONE);
   user.totalDisputes = user.totalDisputes.plus(ONE);
   user.save();

subgraph/subgraph.yaml

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