chore: map the withdrawal and execution of submissions in subgraph

Author: epiqueras

README.md

@@ -3,4 +3,5 @@
 - chore: build subgraph schema ([9810923](https://github.com/kleros/governor-web/commit/9810923))
 - chore: generate first changelog ([2e41de7](https://github.com/kleros/governor-web/commit/2e41de7))
 - chore: map governance functions in subgraph ([360d007](https://github.com/kleros/governor-web/commit/360d007))
+- chore: map list submissions in subgraph ([8cbbe41](https://github.com/kleros/governor-web/commit/8cbbe41))
 - chore: set up project and architecture ([d28fb74](https://github.com/kleros/governor-web/commit/d28fb74))

subgraph/schema.graphql

@@ -180,6 +180,10 @@ type Submission @entity {
   """
   approvalTime: BigInt
   """
+  True, if the submission was withdrawn.
+  """
+  withdrawn: Boolean!
+  """
   Transactions.
   """
   transactions: [Transaction!]! @derivedFrom(field: "submission")

subgraph/src/mapping.ts

@@ -10,13 +10,16 @@ import {
   ChangeSubmissionTimeoutCall,
   ChangeWinnerMultiplierCall,
   ChangeWithdrawTimeoutCall,
+  ExecuteSubmissionsCall,
   Governor,
   SetMetaEvidenceCall,
   SubmitListCall,
+  WithdrawTransactionListCall,
 } from "../generated/Governor/Governor";
 import {
   Contract,
   MetaEvidence,
+  Round,
   Session,
   Submission,
   Transaction,
@@ -36,6 +39,23 @@ function concatByteArrays(a: ByteArray, b: ByteArray): ByteArray {
   return out as ByteArray;
 }
 
+function newSession(contract: Contract, creationTime: BigInt): Session {
+  let session = new Session(contract.sessionsLength.toHexString());
+  session.creationTime = creationTime;
+  session.sumDeposit = BigInt.fromI32(0);
+  session.status = getStatus(0);
+  session.durationOffset = BigInt.fromI32(0);
+  session.submissionsLength = BigInt.fromI32(0);
+  session.roundsLength = BigInt.fromI32(0);
+  session.save();
+
+  contract.sessionsLength.plus(BigInt.fromI32(1));
+  contract.save();
+
+  // Something is broken with The Graph's null type guards so we need these explicit casts in some places.
+  return session as Session;
+}
+
 function initializeContract(
   address: Address,
   deployer: Address,
@@ -60,22 +80,41 @@ function initializeContract(
   contract.lastApprovalTime = governor.lastApprovalTime();
   contract.metaEvidenceUpdates = governor.metaEvidenceUpdates();
   contract.metaEvidence = contract.metaEvidenceUpdates.toHexString();
-  contract.sessionsLength = BigInt.fromI32(1);
+  contract.sessionsLength = BigInt.fromI32(0);
   contract.submissionsLength = BigInt.fromI32(0);
   contract.save();
 
-  let session = new Session("0");
-  session.creationTime = creationTime;
-  session.sumDeposit = BigInt.fromI32(0);
-  session.status = getStatus(0);
-  session.durationOffset = BigInt.fromI32(0);
-  session.submissionsLength = BigInt.fromI32(0);
-  session.roundsLength = BigInt.fromI32(0);
-  session.save();
+  newSession(contract as Contract, creationTime);
 
   return contract as Contract;
 }
 
+function newRound(session: Session, creationTime: BigInt): Round {
+  let round = new Round(
+    crypto
+      .keccak256(
+        concatByteArrays(
+          ByteArray.fromUTF8(session.id),
+          ByteArray.fromUTF8(session.roundsLength.toString())
+        )
+      )
+      .toHexString()
+  );
+  round.creationTime = creationTime;
+  round.session = session.id;
+  round.paidFees = [];
+  round.hasPaid = [];
+  round.feeRewards = BigInt.fromI32(0);
+  round.successfullyPaid = BigInt.fromI32(0);
+  round.contributionsLength = BigInt.fromI32(0);
+  round.save();
+
+  session.roundsLength = session.roundsLength.plus(BigInt.fromI32(1));
+  session.save();
+
+  return round as Round;
+}
+
 export function setMetaEvidence(call: SetMetaEvidenceCall): void {
   let contract = initializeContract(call.to, call.from, call.block.timestamp);
 
@@ -156,8 +195,8 @@ export function changeMetaEvidence(call: ChangeMetaEvidenceCall): void {
 }
 
 export function submitList(call: SubmitListCall): void {
-  let contract = initializeContract(call.to, call.from, call.block.timestamp);
   let governor = Governor.bind(call.to);
+  let contract = initializeContract(call.to, call.from, call.block.timestamp);
 
   let submission = new Submission(contract.submissionsLength.toHexString());
   let _submission = governor.submissions(contract.submissionsLength);
@@ -169,6 +208,7 @@ export function submitList(call: SubmitListCall): void {
   submission.deposit = _submission.value1;
   submission.listHash = _submission.value2;
   submission.approved = _submission.value4;
+  submission.withdrawn = false;
   submission.transactionsLength = BigInt.fromI32(call.inputs._target.length);
   submission.save();
 
@@ -207,3 +247,65 @@ export function submitList(call: SubmitListCall): void {
     );
   session.save();
 }
+
+export function withdrawTransactionList(
+  call: WithdrawTransactionListCall
+): void {
+  let governor = Governor.bind(call.to);
+  let contract = initializeContract(call.to, call.from, call.block.timestamp);
+  contract.reservedETH = governor.reservedETH();
+  contract.save();
+
+  let submission = Submission.load(call.inputs._submissionID.toHexString());
+  submission.withdrawn = true;
+  submission.save();
+
+  let session = Session.load(submission.session);
+  session.sumDeposit = session.sumDeposit.minus(submission.deposit);
+  session.save();
+}
+
+export function executeSubmissions(call: ExecuteSubmissionsCall): void {
+  let governor = Governor.bind(call.to);
+  let contract = initializeContract(call.to, call.from, call.block.timestamp);
+
+  let sessionID = contract.sessionsLength.minus(BigInt.fromI32(1));
+  let session = Session.load(sessionID.toHexString());
+  if (session.submissionsLength.equals(BigInt.fromI32(0))) {
+    contract.lastApprovalTime = call.block.timestamp;
+    contract.save();
+
+    session.status = getStatus(2);
+    session.save();
+
+    newSession(contract as Contract, call.block.timestamp);
+  } else if (session.submissionsLength.equals(BigInt.fromI32(1))) {
+    contract.reservedETH = governor.reservedETH();
+    contract.lastApprovalTime = call.block.timestamp;
+    contract.save();
+
+    session.sumDeposit = BigInt.fromI32(0);
+    session.status = getStatus(2);
+    session.save();
+
+    let submission = Submission.load(
+      contract.submissionsLength.minus(BigInt.fromI32(1)).toHexString()
+    );
+    submission.approved = true;
+    submission.approvalTime = call.block.timestamp;
+    submission.save();
+
+    newSession(contract as Contract, call.block.timestamp);
+  } else {
+    contract.reservedETH = governor.reservedETH();
+    contract.save();
+
+    let _session = governor.sessions(sessionID);
+    session.disputeID = _session.value1;
+    session.sumDeposit = _session.value2;
+    session.status = getStatus(0);
+    session.save();
+
+    newRound(session as Session, call.block.timestamp);
+  }
+}

subgraph/subgraph.template.yaml

@@ -41,4 +41,8 @@ dataSources:
           handler: changeMetaEvidence
         - function: submitList(address[],uint256[],bytes,uint256[],string)
           handler: submitList
+        - function: withdrawTransactionList(uint256,bytes32)
+          handler: withdrawTransactionList
+        - function: executeSubmissions()
+          handler: executeSubmissions
       file: ./src/mapping.ts