Implement operator snapshot (#34)

* Implement operator snapshot

* Rename operator snapshot to operator allocation

* Fix allocation ID

Author: tsudmi

packages/constants/index.template.ts

@@ -2,6 +2,7 @@ import { Address, BigInt, Bytes } from "@graphprotocol/graph-ts";
 
 export let ADDRESS_ZERO = Address.zero();
 export let BIG_INT_ZERO = BigInt.zero();
+export let BIG_INT_ONE = BigInt.fromString("1");
 export let BIG_INT_1E18 = BigInt.fromString("1000000000000000000");
 export let BIG_INT_1E6 = BigInt.fromString("1000000");
 export let BYTES_ZERO = Bytes.empty();

subgraphs/stakewise/schema.graphql

@@ -82,6 +82,20 @@ type DepositActivation @entity {
     amount: BigInt!
 }
 
+"""
+StakeWise Operator keys allocation
+"""
+type OperatorAllocation @entity {
+    "Set to `operator.id-operator.allocationsCount`"
+    id: ID!
+
+    "The operator"
+    operator: Operator!
+
+    "The allocation's total number of staked validators"
+    validatorsCount: BigInt!
+}
+
 """
 StakeWise Operator
 """
@@ -128,8 +142,14 @@ type Operator @entity {
     "The last update timestamp"
     updatedAtTimestamp: BigInt!
 
+    "The total number of validator keys allocations"
+    allocationsCount: BigInt!
+
     "The operator validators"
     validators: [Validator!]! @derivedFrom(field: "operator")
+
+    "The operator keys allocations"
+    allocations: [OperatorAllocation!]! @derivedFrom(field: "operator")
 }
 
 """

subgraphs/stakewise/src/entities/poolValidators.ts

@@ -1,6 +1,10 @@
 import { Address, BigInt, Bytes } from "@graphprotocol/graph-ts";
 import { BIG_INT_ZERO, BYTES_ZERO } from "const";
-import { Operator, Validator } from "../../generated/schema";
+import {
+  Operator,
+  Validator,
+  OperatorAllocation,
+} from "../../generated/schema";
 import {
   calculateDistributorPoints,
   createOrLoadMerkleDistributor,
@@ -24,6 +28,7 @@ export function createOrLoadOperator(
     operator.committed = false;
     operator.locked = false;
     operator.validatorsCount = BIG_INT_ZERO;
+    operator.allocationsCount = BIG_INT_ZERO;
     operator.depositDataIndex = BIG_INT_ZERO;
     operator.revenueShare = BIG_INT_ZERO;
     operator.distributorPoints = BIG_INT_ZERO;
@@ -43,6 +48,22 @@ export function createOrLoadOperator(
   return operator as Operator;
 }
 
+export function createOrLoadOperatorAllocation(
+  operator: Operator
+): OperatorAllocation {
+  let allocationId = operator.id
+    .concat("-")
+    .concat(operator.allocationsCount.toString());
+  let allocation = OperatorAllocation.load(allocationId);
+  if (allocation == null) {
+    allocation = new OperatorAllocation(allocationId);
+    allocation.validatorsCount = BIG_INT_ZERO;
+    allocation.operator = operator.id;
+    allocation.save();
+  }
+  return allocation as OperatorAllocation;
+}
+
 export function createOrLoadValidator(publicKey: Bytes): Validator {
   let validatorId = publicKey.toHexString();
   let validator = Validator.load(validatorId);

subgraphs/stakewise/src/mappings/oracles.ts

@@ -1,5 +1,6 @@
-import { BigInt, log, store } from "@graphprotocol/graph-ts";
+import { log, store } from "@graphprotocol/graph-ts";
 
+import { BIG_INT_ONE } from "const";
 import { createOrLoadOracle, createOrLoadNetwork } from "../entities";
 import {
   InitializeValidatorVoteSubmitted,
@@ -51,7 +52,7 @@ export function handleOracleRemoved(event: OracleRemoved): void {
 export function handleRewardsVoteSubmitted(event: RewardsVoteSubmitted): void {
   let network = createOrLoadNetwork();
 
-  network.oraclesRewardsNonce = event.params.nonce.plus(BigInt.fromString("1"));
+  network.oraclesRewardsNonce = event.params.nonce.plus(BIG_INT_ONE);
   network.save();
 
   log.info("[Oracles] RewardsVoteSubmitted nonce={} oracle={} sender={}", [
@@ -66,7 +67,7 @@ export function handleMerkleRootVoteSubmitted(
 ): void {
   let network = createOrLoadNetwork();
 
-  network.oraclesRewardsNonce = event.params.nonce.plus(BigInt.fromString("1"));
+  network.oraclesRewardsNonce = event.params.nonce.plus(BIG_INT_ONE);
   network.save();
 
   log.info("[Oracles] MerkleRootVoteSubmitted nonce={} oracle={} sender={}", [
@@ -81,9 +82,7 @@ export function handleInitializeValidatorVoteSubmitted(
 ): void {
   let network = createOrLoadNetwork();
 
-  network.oraclesValidatorsNonce = event.params.nonce.plus(
-    BigInt.fromString("1")
-  );
+  network.oraclesValidatorsNonce = event.params.nonce.plus(BIG_INT_ONE);
   network.save();
 
   log.info(
@@ -101,9 +100,7 @@ export function handleFinalizeValidatorVoteSubmitted(
 ): void {
   let network = createOrLoadNetwork();
 
-  network.oraclesValidatorsNonce = event.params.nonce.plus(
-    BigInt.fromString("1")
-  );
+  network.oraclesValidatorsNonce = event.params.nonce.plus(BIG_INT_ONE);
   network.save();
 
   log.info(

subgraphs/stakewise/src/mappings/pool.ts

@@ -1,6 +1,6 @@
 import { BigInt, log, store } from "@graphprotocol/graph-ts";
 
-import { BIG_INT_1E18 } from "const";
+import { BIG_INT_1E18, BIG_INT_ONE } from "const";
 import {
   Activated,
   ActivatedValidatorsUpdated,
@@ -19,6 +19,7 @@ import {
   createOrLoadDepositActivation,
   createOrLoadNetwork,
   createOrLoadOperator,
+  createOrLoadOperatorAllocation,
   createOrLoadPool,
   createOrLoadValidator,
   getDepositActivationId,
@@ -175,9 +176,11 @@ export function handleValidatorInitialized(event: ValidatorInitialized): void {
   validator.registrationStatus = "Initialized";
   validator.save();
 
-  operator.validatorsCount = operator.validatorsCount.plus(
-    BigInt.fromString("1")
-  );
+  let allocation = createOrLoadOperatorAllocation(operator);
+  allocation.validatorsCount = allocation.validatorsCount.plus(BIG_INT_ONE);
+  allocation.save();
+
+  operator.validatorsCount = operator.validatorsCount.plus(BIG_INT_ONE);
   operator.locked = true;
   operator.updatedAtBlock = event.block.number;
   operator.updatedAtTimestamp = event.block.timestamp;
@@ -202,24 +205,24 @@ export function handleValidatorRegistered(event: ValidatorRegistered): void {
   let validator = createOrLoadValidator(event.params.publicKey);
 
   let pool = createOrLoadPool();
-  pool.pendingValidators = pool.pendingValidators.plus(BigInt.fromString("1"));
+  pool.pendingValidators = pool.pendingValidators.plus(BIG_INT_ONE);
 
   if (validator.registrationStatus == "Uninitialized") {
     // compatibility with v1 contracts
     pool.balance = pool.balance.minus(
       BigInt.fromString("32").times(BIG_INT_1E18)
     );
-    operator.validatorsCount = operator.validatorsCount.plus(
-      BigInt.fromString("1")
-    );
+    operator.validatorsCount = operator.validatorsCount.plus(BIG_INT_ONE);
+
+    let allocation = createOrLoadOperatorAllocation(operator);
+    allocation.validatorsCount = allocation.validatorsCount.plus(BIG_INT_ONE);
+    allocation.save();
   } else {
     // finalization is done with 31 ether deposit to the eth2 contract
     pool.balance = pool.balance.minus(
       BigInt.fromString("31").times(BIG_INT_1E18)
     );
-    operator.depositDataIndex = operator.depositDataIndex.plus(
-      BigInt.fromString("1")
-    );
+    operator.depositDataIndex = operator.depositDataIndex.plus(BIG_INT_ONE);
     operator.locked = false;
   }
   pool.save();

subgraphs/stakewise/src/mappings/poolValidators.ts

@@ -1,9 +1,10 @@
-import { BigInt, log } from "@graphprotocol/graph-ts";
-import { BIG_INT_ZERO, BYTES_ZERO } from "const";
+import { log } from "@graphprotocol/graph-ts";
+import { BIG_INT_ONE, BIG_INT_ZERO, BYTES_ZERO } from "const";
 import {
   createOrLoadOperator,
   createOrLoadNetwork,
   createOrLoadValidator,
+  createOrLoadOperatorAllocation,
 } from "../entities";
 import {
   OperatorCommitted,
@@ -30,6 +31,7 @@ export function handleOperatorAdded(event: OperatorAdded): void {
   operator.depositDataIndex = BIG_INT_ZERO;
   operator.updatedAtBlock = event.block.number;
   operator.updatedAtTimestamp = event.block.timestamp;
+  operator.allocationsCount = operator.allocationsCount.plus(BIG_INT_ONE);
   operator.save();
 
   log.info(
@@ -73,6 +75,10 @@ export function handleOperatorSlashed(event: OperatorSlashed): void {
     event.block.number
   );
 
+  let allocation = createOrLoadOperatorAllocation(operator);
+  allocation.validatorsCount = allocation.validatorsCount.minus(BIG_INT_ONE);
+  allocation.save();
+
   operator.initializeMerkleRoot = BYTES_ZERO;
   operator.initializeMerkleProofs = "";
   operator.finalizeMerkleRoot = BYTES_ZERO;
@@ -83,9 +89,7 @@ export function handleOperatorSlashed(event: OperatorSlashed): void {
   operator.committed = false;
   operator.locked = false;
   operator.collateral = operator.collateral.minus(event.params.refundedAmount);
-  operator.validatorsCount = operator.validatorsCount.minus(
-    BigInt.fromString("1")
-  );
+  operator.validatorsCount = operator.validatorsCount.minus(BIG_INT_ONE);
   operator.save();
 
   let validator = createOrLoadValidator(event.params.publicKey);

subgraphs/stakewise/subgraph.template.yaml

@@ -23,6 +23,7 @@ dataSources:
         - Referrer
         - DepositActivation
         - Operator
+        - OperatorSnapshot
         - Validator
         - Network
       abis:
@@ -68,6 +69,7 @@ dataSources:
       file: ./src/mappings/poolValidators.ts
       entities:
         - Operator
+        - OperatorSnapshot
         - MerkleDistributor
         - Validator
         - Network