Merge pull request #82 from murka/feat/evaa-protocol

feat: add EVAA Protocol L2 integration

Author: FJ-Riveros

campaign/campaign.py

@@ -1,5 +1,5 @@
 from typing import List
-from web3 import Web3
+
 from integrations.beefy_cached_balance_example_integration import (
     BeefyCachedBalanceIntegration,
 )
@@ -10,11 +10,18 @@
 from integrations.ratex_l2_delegation_example_integration import (
     RatexL2DelegationExampleIntegration,
 )
+
+from constants.chains import Chain
+from constants.pendle import PENDLE_USDE_JULY_DEPLOYMENT_BLOCK
+from constants.summary_columns import SummaryColumn
+from web3 import Web3
+from constants.evaa import EVAA_USDE_START_BLOCK, EVAA_SUSDE_START_BLOCK
 from integrations.stonfi_integration import StonFiIntegration
 from integrations.integration import Integration
 from integrations.integration_ids import IntegrationID
 from integrations.pendle_lpt_integration import PendleLPTIntegration
 from integrations.pendle_yt_integration import PendleYTIntegration
+from integrations.evaa_integration import EvaaIntegration
 from integrations.template import ProtocolNameIntegration
 from utils import pendle
 
@@ -53,6 +60,20 @@
         },
         end_block=40000000,
     ),
+    EvaaIntegration(
+        integration_id=IntegrationID.EVAA_TON_USDE,
+        start_block=EVAA_USDE_START_BLOCK,
+        summary_cols=[SummaryColumn.EVAA_USDE_PTS],
+        chain=Chain.TON,
+        reward_multiplier=20,
+    ),
+    EvaaIntegration(
+        integration_id=IntegrationID.EVAA_TON_SUSDE,
+        start_block=EVAA_SUSDE_START_BLOCK,
+        summary_cols=[SummaryColumn.EVAA_SUSDE_PTS],
+        chain=Chain.TON,
+        reward_multiplier=5,
+    ),
     # Example integration using cached user balances for improved performance,
     # reads from previous balance snapshots
     ClaimedEnaIntegration(

constants/evaa.py

@@ -0,0 +1,15 @@
+from constants.integration_token import Token
+
+EVAA_USDE_START_BLOCK=22382834
+EVAA_SUSDE_START_BLOCK=22382834
+
+EVAA_ENDPOINT="https://api.evaa.space" 
+
+EVAA_POOLS_MAP = {
+  Token.USDE: [
+    "EQC8rUZqR_pWV1BylWUlPNBzyiTYVoBEmQkMIQDZXICfnuRr"
+  ],
+  Token.SUSDE: [
+    "EQC8rUZqR_pWV1BylWUlPNBzyiTYVoBEmQkMIQDZXICfnuRr"
+  ]
+}

constants/summary_columns.py

@@ -61,10 +61,13 @@ class SummaryColumn(Enum):
 
     VENUS_SUSDE_PTS = ("venus_susde_pts", SummaryColumnType.ETHENA_PTS)
 
+    # EVAA Protocol
+    EVAA_USDE_PTS = ("evaa_usde_pts", SummaryColumnType.ETHENA_PTS)
+    EVAA_SUSDE_PTS = ("evaa_susde_pts", SummaryColumnType.ETHENA_PTS)
+    
     # Sentiment
     SENTIMENT_USDE_PTS = ("sentiment_usde_pts", SummaryColumnType.ETHENA_PTS)
 
-
     def __init__(self, column_name: str, col_type: SummaryColumnType):
         self.column_name = column_name
         self.col_type = col_type

integrations/evaa_integration.py

@@ -0,0 +1,120 @@
+from typing import Dict, List, Optional, Tuple
+
+from constants.evaa import EVAA_POOLS_MAP, EVAA_ENDPOINT, EVAA_USDE_START_BLOCK, EVAA_SUSDE_START_BLOCK
+
+from integrations.l2_delegation_integration import L2DelegationIntegration
+from integrations.integration_ids import IntegrationID
+from utils.web3_utils import get_block_date
+from utils.request_utils import requests_retry_session
+from utils.slack import slack_message
+from constants.summary_columns import SummaryColumn
+from constants.chains import Chain
+class EvaaIntegration(L2DelegationIntegration):
+    def __init__(
+         self,
+         integration_id: IntegrationID,
+         start_block: int,
+         summary_cols: Optional[List[SummaryColumn]] = None,
+         chain: Chain = Chain.TON,
+         reward_multiplier: int = 1,
+         end_block: Optional[int] = None,
+     ):
+         super().__init__(
+             integration_id=integration_id,
+             start_block=start_block,
+             chain=chain,
+             summary_cols=summary_cols if summary_cols else [SummaryColumn.EVAA_USDE_PTS],
+             reward_multiplier=reward_multiplier,
+             end_block=end_block,
+         )
+
+    def get_l2_block_balances(
+         self,
+         cached_data: Dict[int, Dict[str, float]],
+         blocks: List[int]
+     ) -> Dict[int, Dict[str, float]]:
+        """
+        Returns a dict of the form: { block_number: { ton_address: balance } }
+        """
+        try:
+            block_balances: Dict[int, Dict[str, float]] = {}
+
+            for block_number in blocks:
+                block_balances[block_number] = {}
+                block_data = self.get_participants_data(block_number)
+                for participant in block_data:
+                    ton_address = participant["ton_address"]
+                    balance = participant["balance"]
+                    block_balances[block_number][ton_address] = balance
+
+            return block_balances
+        except Exception as e:
+            err_msg = f"Error fetching EVAA balances at block {block_number}: {e}"
+            print(err_msg)
+            slack_message(err_msg)
+
+    def get_token_symbol(self):
+         return self.integration_id.get_token()
+
+    def get_participants_data(self, block: int) -> Dict[str, float]:
+        """
+        Returns a list of "ton_address": "balance"
+        """
+
+        token = self.get_token_symbol()
+        pools_list = EVAA_POOLS_MAP[token]
+        block_data: Dict[str, float] = {}
+        target_date = get_block_date(block, self.chain, adjustment=3600, fmt="%Y-%m-%dT%H:%M:%S")
+
+
+        try:
+            for pool in pools_list:
+                res = requests_retry_session().get(
+                    EVAA_ENDPOINT + "/query/adapters/ethena",
+                    params={
+                        "pool_address": pool,
+                        "timestamp": target_date,
+                        "token": token.value
+                    },
+                    
+                    timeout=60,
+                )
+                payload = res.json()
+
+                if payload is None:
+                    raise Exception(f"Error getting participants data for EVAA Protocol token {token} at block {block}: {e}")
+
+                block_data = payload
+
+        except Exception as e:
+                err_msg = f"Error getting participants data for EVAA Protocol at block {block}: {e}"
+                slack_message(err_msg)
+
+        return block_data
+
+
+if __name__ == "__main__":
+    evaa_integration_usde = EvaaIntegration(
+        integration_id=IntegrationID.EVAA_TON_USDE,
+        start_block=EVAA_USDE_START_BLOCK,
+        summary_cols=[SummaryColumn.EVAA_USDE_PTS],
+        chain=Chain.TON,
+        reward_multiplier=20
+    )
+    evaa_integration_susde = EvaaIntegration(
+        integration_id=IntegrationID.EVAA_TON_SUSDE,
+        start_block=EVAA_SUSDE_START_BLOCK,
+        summary_cols=[SummaryColumn.EVAA_SUSDE_PTS],
+        chain=Chain.TON,
+        reward_multiplier=5
+    )
+
+    balances_usde = evaa_integration_usde.get_l2_block_balances(
+        cached_data={}, blocks=[22596292]
+    )
+    balances_susde = evaa_integration_susde.get_l2_block_balances(
+        cached_data={}, blocks=[22596292]
+    )
+
+    print("Balances USDe:", balances_usde)
+    print("Balances sUSDe:", balances_susde)

integrations/integration_ids.py

@@ -475,6 +475,10 @@ class IntegrationID(Enum):
     # Venus
     VENUS_SUSDE = ("venus_susde", "Venus sUSDe", Token.SUSDE)
 
+    # EVAA Protocol
+    EVAA_TON_USDE = ("evaa_ton_usde", "EVAA TON USDe", Token.USDE)
+    EVAA_TON_SUSDE = ("evaa_ton_susde", "EVAA TON sUSDe", Token.SUSDE)
+
     # Bulbaswap
     BULBASWAP = (
         "bulbaswap",