Merge pull request #81 from AlehNat/fiva-integration

add FIVA (TON) integration

Author: FJ-Riveros

constants/chains.py

@@ -14,6 +14,6 @@ class Chain(Enum):
     SWELL = "Swell"
     SOLANA = "Solana"
     APTOS = "Aptos"
-    TON = "TON"
     BASE = "Base"
-    SEPOLIA = "Sepolia"
+    SEPOLIA = "Sepolia"
+    TON = "Ton"

constants/example_integrations.py

@@ -22,3 +22,5 @@
 ECHELON_SUSDE_COLLATERAL_START_BLOCK = 2379805052
 
 RATEX_EXAMPLE_USDE_START_BLOCK = 21202656
+
+FIVA_EXAMPLE_USDE_START_BLOCK = 22370179

constants/summary_columns.py

@@ -55,6 +55,8 @@ class SummaryColumn(Enum):
 
     RATEX_EXAMPLE_PTS = ("ratex_example_pts", SummaryColumnType.ETHENA_PTS)
 
+    FIVA_EXAMPLE_PTS = ("fiva_example_pts", SummaryColumnType.ETHENA_PTS)
+
     STONFI_USDE_PTS = ("stonfi_usde_pts", SummaryColumnType.ETHENA_PTS)
 
     VENUS_SUSDE_PTS = ("venus_susde_pts", SummaryColumnType.ETHENA_PTS)

integrations/fiva_l2_delegation_example_integration.py

@@ -0,0 +1,135 @@
+import logging
+
+from typing import Dict, List, Optional
+from constants.example_integrations import FIVA_EXAMPLE_USDE_START_BLOCK
+from constants.integration_token import Token
+from integrations.l2_delegation_integration import L2DelegationIntegration
+from utils.web3_utils import get_block_date
+from constants.chains import Chain
+from constants.summary_columns import SummaryColumn
+from integrations.integration_ids import IntegrationID
+from utils.request_utils import requests_retry_session
+from utils.slack import slack_message
+
+FIVA_ENDPOINT = "http://api2.thefiva.com/ethena_points"
+
+TOKEN_TO_METHOD = {
+    Token.USDE: "queryUSDEPoints",
+}
+
+
+def get_fiva_payload(
+    trade_date: str, method: str = "queryUSDEPoints", page_num: int = 0
+) -> dict:
+    return {
+        "method": method,
+        "content": {
+            "trade_date": trade_date,
+            "page_num": page_num,
+            "page_size": 200,
+        },
+    }
+
+
+class FivaL2DelegationExampleIntegration(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.FIVA_EXAMPLE_PTS,
+                ]
+            ),
+            reward_multiplier=reward_multiplier,
+            end_block=end_block,
+        )
+        self.token = integration_id.get_token()
+
+    def get_l2_block_balances(
+        self, cached_data: Dict[int, Dict[str, float]], blocks: List[int]
+    ) -> Dict[int, Dict[str, float]]:
+        logging.info(
+            f"Getting block data for FIVA L2 (TON) delegation example and blocks {blocks}..."
+        )
+
+        data_per_block: Dict[int, Dict[str, float]] = {}
+
+        for target_block in blocks:
+            if self.start_block > target_block or (
+                self.end_block and target_block > self.end_block
+            ):
+                data_per_block[target_block] = {}
+                continue
+            data_per_block[target_block] = self.get_participants_data(target_block)
+        return data_per_block
+
+    def get_participants_data(self, block: int) -> Dict[str, float]:
+        logging.info(
+            f"Fetching participants data for FIVA L2 (TON) delegation example at block {block}..."
+        )
+        block_data: Dict[str, int | float] = {}
+        target_date = get_block_date(block, self.chain, adjustment=3600)
+        page_num = 0
+        while True:
+            try:
+                res = requests_retry_session().get(
+                    FIVA_ENDPOINT,
+                    json=get_fiva_payload(
+                        trade_date=target_date,
+                        method=TOKEN_TO_METHOD[self.token],
+                        page_num=page_num,
+                    ),
+                    timeout=60,
+                )
+                response = res.json()
+                if len(block_data) >= response["total_size"] :
+                    break
+                for pos_data in response["data"]:
+                    if (
+                        pos_data["market_indicator"].upper()
+                        != self.integration_id.get_token().value.upper()
+                    ):
+                        continue
+                    user_address = pos_data["user_id"]
+                    block_data[user_address] = round(pos_data["token_amount"], 4)
+                page_num += 1
+            except Exception as e:
+                err_msg = f"Error getting participants data for FIVA L2 (TON) delegation example: {e}"
+                logging.error(err_msg)
+                slack_message(err_msg)
+                break
+
+        return block_data
+
+
+if __name__ == "__main__":
+    example_integration = FivaL2DelegationExampleIntegration(
+        integration_id=IntegrationID.FIVA_USDE_EXAMPLE,
+        start_block=FIVA_EXAMPLE_USDE_START_BLOCK,
+        summary_cols=[
+            SummaryColumn.FIVA_EXAMPLE_PTS,
+        ],
+        chain=Chain.TON,
+        reward_multiplier=1,
+    )
+
+    example_integration_output = example_integration.get_l2_block_balances(
+        cached_data={}, blocks=[22370718, 22370728]
+    )
+
+    print("=" * 120)
+    print("Run without cached data", example_integration_output)
+    print("=" * 120, "\n" * 5)

integrations/integration_ids.py

@@ -436,9 +436,12 @@ class IntegrationID(Enum):
 
     RATEX_USDE_EXAMPLE = ("ratex_usde_example", "Ratex USDe Example", Token.USDE)
 
+    FIVA_USDE_EXAMPLE = ("fiva_usde_example", "Fiva USDe Example", Token.USDE)
+
     # STON.fi
     STONFI_USDE = ("stonfi_usde", "STON.fi USDe", Token.USDE)
 
+
     # Upshift sUSDe
     UPSHIFT_UPSUSDE = ("upshift_upsusde", "Upshift upsUSDe", Token.SUSDE)
 

utils/web3_utils.py

@@ -78,6 +78,9 @@
     Chain.SEPOLIA: {
         "w3": w3_sepolia,
     },
+    Chain.TON: {
+        "w3": w3,
+    },
 }