Added average RPL/ETH to network node balance checkpoint.

Author: VGR-GIT

generated/schema.ts

@@ -22,6 +22,10 @@ export class RocketPoolProtocol extends Entity {
     this.set("stakers", Value.fromStringArray(new Array(0)));
     this.set("nodes", Value.fromStringArray(new Array(0)));
     this.set("nodeTimezones", Value.fromStringArray(new Array(0)));
+    this.set(
+      "networkNodeBalanceCheckpoints",
+      Value.fromStringArray(new Array(0))
+    );
   }
 
   save(): void {
@@ -153,6 +157,15 @@ export class RocketPoolProtocol extends Entity {
       );
     }
   }
+
+  get networkNodeBalanceCheckpoints(): Array<string> {
+    let value = this.get("networkNodeBalanceCheckpoints");
+    return value!.toStringArray();
+  }
+
+  set networkNodeBalanceCheckpoints(value: Array<string>) {
+    this.set("networkNodeBalanceCheckpoints", Value.fromStringArray(value));
+  }
 }
 
 export class Staker extends Entity {
@@ -1566,6 +1579,7 @@ export class NetworkNodeBalanceCheckpoint extends Entity {
     this.set("averageNodeTotalRewardsClaimed", Value.fromBigInt(BigInt.zero()));
     this.set("averageNodeRewardClaim", Value.fromBigInt(BigInt.zero()));
     this.set("rplPriceInETH", Value.fromBigInt(BigInt.zero()));
+    this.set("averageRplPriceInETH", Value.fromBigInt(BigInt.zero()));
     this.set("queuedMinipools", Value.fromBigInt(BigInt.zero()));
     this.set("stakingMinipools", Value.fromBigInt(BigInt.zero()));
     this.set("stakingUnbondedMinipools", Value.fromBigInt(BigInt.zero()));
@@ -1786,6 +1800,15 @@ export class NetworkNodeBalanceCheckpoint extends Entity {
     this.set("rplPriceInETH", Value.fromBigInt(value));
   }
 
+  get averageRplPriceInETH(): BigInt {
+    let value = this.get("averageRplPriceInETH");
+    return value!.toBigInt();
+  }
+
+  set averageRplPriceInETH(value: BigInt) {
+    this.set("averageRplPriceInETH", Value.fromBigInt(value));
+  }
+
   get queuedMinipools(): BigInt {
     let value = this.get("queuedMinipools");
     return value!.toBigInt();

schema.graphql

@@ -26,6 +26,9 @@ type RocketPoolProtocol @entity {
 
   # Last known node network balance checkpoint.
   lastNetworkNodeBalanceCheckPoint: NetworkNodeBalanceCheckpoint
+
+  # All node network balance checkpoints for the RocketPool protocol.
+  networkNodeBalanceCheckpoints: [NetworkNodeBalanceCheckpoint!]!
 }
 
 # An address that is/was associated with an rETH balance.
@@ -452,6 +455,9 @@ type NetworkNodeBalanceCheckpoint @entity {
   # The RPL price in ETH at this checkpoint.
   rplPriceInETH: BigInt!
 
+  # The average RPL price in ETH up to this checkpoint.
+  averageRplPriceInETH: BigInt!
+
   # Current queued minipools accross all nodes at this checkpoint.
   queuedMinipools: BigInt!
 

src/entityfactory.ts

@@ -31,6 +31,7 @@ class RocketPoolEntityFactory {
     protocol.nodeTimezones = new Array<string>(0)
     protocol.lastRPLRewardInterval = null
     protocol.lastNetworkNodeBalanceCheckPoint = null
+    protocol.networkNodeBalanceCheckpoints =new Array<string>(0)
     return protocol
   }
 
@@ -354,6 +355,7 @@ class RocketPoolEntityFactory {
     checkpoint.averageNodeTotalRewardsClaimed = BigInt.fromI32(0) // Will be calculated.
     checkpoint.averageNodeRewardClaim = BigInt.fromI32(0) // Will be calculated.
     checkpoint.rplPriceInETH = newRplPriceInETH // From the associated price update.
+    checkpoint.averageRplPriceInETH = BigInt.fromI32(0) // Will be calculated.
     checkpoint.queuedMinipools = BigInt.fromI32(0) // Will be calculated.
     checkpoint.stakingMinipools = BigInt.fromI32(0) // Will be calculated.
     checkpoint.stakingUnbondedMinipools = BigInt.fromI32(0) // Will be calculated.

src/mappings/rocketNetworkPricesMapping.ts

@@ -3,7 +3,11 @@ import { rocketNetworkFees } from '../../generated/rocketNetworkPrices/rocketNet
 import { rocketDAOProtocolSettingsMinipool } from '../../generated/rocketNetworkPrices/rocketDAOProtocolSettingsMinipool'
 import { rocketDAOProtocolSettingsNode } from '../../generated/rocketNetworkPrices/rocketDAOProtocolSettingsNode'
 import { rocketNodeStaking } from '../../generated/rocketNetworkPrices/rocketNodeStaking'
-import { Node, NetworkNodeBalanceCheckpoint } from '../../generated/schema'
+import {
+  Node,
+  NetworkNodeBalanceCheckpoint,
+  RocketPoolProtocol,
+} from '../../generated/schema'
 import { generalUtilities } from '../utilities/generalUtilities'
 import { rocketPoolEntityFactory } from '../entityfactory'
 import { NetworkNodeBalanceMetadata } from '../models/networkNodeBalanceMetadata'
@@ -16,6 +20,7 @@ import {
 import { BigInt, Address } from '@graphprotocol/graph-ts'
 import { nodeUtilities } from '../utilities/nodeutilities'
 import { EffectiveMinipoolRPLBounds } from '../models/effectiveMinipoolRPLBounds'
+import { ONE_ETHER_IN_WEI } from '../constants/generalconstants'
 
 /**
  * When enough ODAO members submitted their votes and a consensus threshold is reached, a new RPL price is comitted to the smart contracts.
@@ -94,9 +99,18 @@ export function handlePricesUpdated(event: PricesUpdated): void {
     metadata.rplMetadata,
   )
 
+  // Determine the average RPL/ETH ratio for the current network node balance checkpoint.
+  setAverageRplEthRatio(protocol, checkpoint);
+
   // Update the link so the protocol points to the last network node balance checkpoint.
   protocol.lastNetworkNodeBalanceCheckPoint = checkpoint.id
 
+  // Add the new network node balance checkpoint to the protocol collection.
+  let nodeBalanceCheckpoints = protocol.networkNodeBalanceCheckpoints
+  if (nodeBalanceCheckpoints.indexOf(checkpoint.id) == -1)
+    nodeBalanceCheckpoints.push(checkpoint.id)
+  protocol.networkNodeBalanceCheckpoints = nodeBalanceCheckpoints
+
   // Index these changes.
   checkpoint.save()
   if (previousCheckpoint !== null) previousCheckpoint.save()
@@ -184,6 +198,73 @@ function generateNodeBalanceCheckpoints(
   return networkMetadata
 }
 
+/**
+ * Loops through all network node balance checkpoints and determines the new average RPL price.
+ */
+function setAverageRplEthRatio(
+  protocol: RocketPoolProtocol,
+  currentCheckpoint: NetworkNodeBalanceCheckpoint,
+): void {
+  // Preliminary null checks.
+  if (
+    protocol === null ||
+    currentCheckpoint === null ||
+    currentCheckpoint.rplPriceInETH == BigInt.fromI32(0)
+  )
+    return
+
+  // We will use this to calculate the average RPL/ETH price accross all the network node balance checkpoints.
+  let totalRplPriceInEth = BigInt.fromI32(0)
+  let totalCheckpointsWithAnRplPriceInETH = BigInt.fromI32(0)
+
+  // Loop through all of the node balance checkpoints up until this time.
+  for (
+    let index = 0;
+    index < protocol.networkNodeBalanceCheckpoints.length;
+    index++
+  ) {
+    // Determine current network node balance checkpoint ID.
+    let networkNodeBalanceCheckpointId = <string>(
+      protocol.networkNodeBalanceCheckpoints[index]
+    )
+    if (networkNodeBalanceCheckpointId == null) continue
+
+    // Load the indexed network node balance checkpoint.
+    let activeIterationCheckpoint = NetworkNodeBalanceCheckpoint.load(
+      networkNodeBalanceCheckpointId,
+    )
+    if (
+      activeIterationCheckpoint === null ||
+      activeIterationCheckpoint.rplPriceInETH == BigInt.fromI32(0)
+    )
+      continue
+
+    // Increment running totals.
+    totalCheckpointsWithAnRplPriceInETH = totalCheckpointsWithAnRplPriceInETH.plus(
+      BigInt.fromI32(1),
+    )
+    totalRplPriceInEth = totalRplPriceInEth.plus(
+      activeIterationCheckpoint.rplPriceInETH.div(ONE_ETHER_IN_WEI),
+    )
+  }
+
+  // Calculate the average rpl/eth price for the current node network balance checkpoint.
+  if (
+    totalRplPriceInEth > BigInt.fromI32(0) &&
+    totalCheckpointsWithAnRplPriceInETH > BigInt.fromI32(0)
+  ) {
+    currentCheckpoint.averageRplPriceInETH = totalRplPriceInEth.div(
+      totalCheckpointsWithAnRplPriceInETH,
+    ).times(ONE_ETHER_IN_WEI)
+  } else {
+    /*
+     If we didn't succeed in determining the average rpl/eth price from the history,
+     then our average price is the current one.
+    */
+    currentCheckpoint.averageRplPriceInETH = currentCheckpoint.rplPriceInETH
+  }
+}
+
 /**
  * Returns the minimum and maximum RPL needed to collateralize a new minipool based on the current smart contract state.
  */