Fix rewards calculation with total fees (#113)

* Fix rewards calculation with total fees

* Fix trailing space

* Fix tests

* Update log message

Author: tsudmi

.gitignore

@@ -5,4 +5,4 @@ dist
 .idea
 local.env
 *.env
-*jwtsecret
+*jwtsecret

oracle/oracle/common/eth1.py

@@ -113,6 +113,7 @@ async def get_voting_parameters(
     rewards = RewardsVotingParameters(
         rewards_nonce=int(network["oraclesRewardsNonce"]),
         total_rewards=Wei(int(reward_token["totalRewards"])),
+        total_fees=Wei(int(reward_token["totalFees"])),
         rewards_updated_at_timestamp=Timestamp(int(reward_token["updatedAtTimestamp"])),
     )
     distributor = DistributorVotingParameters(

oracle/oracle/rewards/controller.py

@@ -99,7 +99,7 @@ async def process(
             checkpoints = await get_finality_checkpoints(self.aiohttp_session)
 
         state_id = str(update_epoch * self.slots_per_epoch)
-        total_rewards: Wei = Wei(0)
+        total_rewards: Wei = voting_params["total_fees"]
         activated_validators = 0
         chunk_size = NETWORK_CONFIG["VALIDATORS_FETCH_CHUNK_SIZE"]
 
@@ -115,16 +115,20 @@ async def process(
                     continue
 
                 activated_validators += 1
-                total_rewards += Wei(
+                validator_reward = (
                     Web3.toWei(validator["balance"], "gwei") - self.deposit_amount
                 )
-
-        if NETWORK == GNOSIS_CHAIN:
-            # apply mGNO <-> GNO exchange rate
-            total_rewards = Wei(int(total_rewards * WAD // MGNO_RATE))
+                if NETWORK == GNOSIS_CHAIN:
+                    # apply mGNO <-> GNO exchange rate
+                    validator_reward = Wei(int(validator_reward * WAD // MGNO_RATE))
+                total_rewards += validator_reward
 
         pretty_total_rewards = self.format_ether(total_rewards)
-        logger.info(f"Retrieved pool validator rewards: total={pretty_total_rewards}")
+        logger.info(
+            f"Retrieved pool validator rewards:"
+            f" total={pretty_total_rewards},"
+            f" fees={self.format_ether(voting_params['total_fees'])}"
+        )
         if not total_rewards:
             logger.info("No staking rewards, waiting for validators to be activated...")
             return

oracle/oracle/rewards/tests/test_controller.py

@@ -82,6 +82,8 @@ async def test_process_success(self):
             session = aiohttp.ClientSession()
             rewards_nonce = faker.random_int(1000, 2000)
             total_rewards = faker.wei_amount()
+            total_fees = faker.wei_amount()
+            total_rewards += total_fees
 
             controller = RewardsController(
                 aiohttp_session=session,
@@ -92,6 +94,7 @@ async def test_process_success(self):
                 voting_params=RewardsVotingParameters(
                     rewards_nonce=rewards_nonce,
                     total_rewards=total_rewards,
+                    total_fees=total_fees,
                     rewards_updated_at_timestamp=Timestamp(1649854536),
                 ),
                 current_block_number=BlockNumber(14583706),

oracle/oracle/rewards/types.py

@@ -7,6 +7,7 @@
 class RewardsVotingParameters(TypedDict):
     rewards_nonce: int
     total_rewards: Wei
+    total_fees: Wei
     rewards_updated_at_timestamp: Timestamp