Merge pull request #91 from webmass/inverse-firm-add-susde-lp-markets

integration: refacto firm & add susde lp markets

Author: FJ-Riveros

abi/curve_stable_swap_ng_lp.json

@@ -1,7 +1,26 @@
 from web3 import Web3
 
 FIRM_SUSDE_DEPLOYMENT_BLOCK = 20441987
+FIRM_SUSDE_DOLA_CLP_DEPLOYMENT_BLOCK = 21311218
+FIRM_YV_SUSDE_DOLA_CLP_DEPLOYMENT_BLOCK = 21311218
 
 SUSDE_MARKET_ADDRESS = Web3.to_checksum_address(
     "0x79eF6d28C41e47A588E2F2ffB4140Eb6d952AEc4"
 )
+
+# SUSDE DOLA Curve LP
+SUSDE_DOLA_CLP_ADDRESS = Web3.to_checksum_address(
+    "0x744793B5110f6ca9cC7CDfe1CE16677c3Eb192ef"
+)
+# SUSDE DOLA Curve LP Convex Firm Market
+SUSDE_DOLA_CLP_MARKET_ADDRESS = Web3.to_checksum_address(
+    "0xb427fC22561f3963B04202F9bb5BCEbd76c14A99"
+)
+# SUSDE DOLA Curve LP Yearn Firm Market
+YV_SUSDE_DOLA_CLP_MARKET_ADDRESS = Web3.to_checksum_address(
+    "0x4E264618dC015219CD83dbc53B31251D73c2db1a"
+)
+# SUSDE DOLA Yearn Vault Token
+YV_SUSDE_DOLA_ADDRESS = Web3.to_checksum_address(
+    "0x1Fc80CfCF5B345b904A0fB36d4222196Ed9eB8a5"
+)

abi/yearn_v2_vault.json

@@ -0,0 +1,40 @@
+from typing import List, Optional, Set
+from constants.chains import Chain
+from integrations.integration_ids import IntegrationID
+from integrations.integration import Integration
+from constants.firm import FIRM_SUSDE_DOLA_CLP_DEPLOYMENT_BLOCK, SUSDE_DOLA_CLP_MARKET_ADDRESS
+from utils.firm import get_firm_market_participants, get_firm_user_balance
+from utils.web3_utils import w3
+
+
+class Firm(Integration):
+    def __init__(self):
+        super().__init__(
+            IntegrationID.FIRM_SUSDE_DOLA_CLP,
+            FIRM_SUSDE_DOLA_CLP_DEPLOYMENT_BLOCK,
+            Chain.ETHEREUM,
+            [],
+            20,
+            1,
+            None,
+            None,
+        )
+
+    def get_balance(self, user: str, block: int) -> float:
+        balance = get_firm_user_balance(user, SUSDE_DOLA_CLP_MARKET_ADDRESS, block)
+        return balance / 1e18
+
+    def get_participants(
+        self,
+        blocks: Optional[List[int]],
+    ) -> Set[str]:
+        return get_firm_market_participants(FIRM_SUSDE_DOLA_CLP_DEPLOYMENT_BLOCK, SUSDE_DOLA_CLP_MARKET_ADDRESS)
+
+
+if __name__ == "__main__":
+    firm = Firm()
+    participants = firm.get_participants(None)
+    print("participants", participants)
+    currentBlock = w3.eth.get_block_number()
+    if len(participants) > 0:
+        print(firm.get_balance(list(participants)[len(participants) - 1], currentBlock))

constants/firm.py

@@ -2,9 +2,9 @@
 from constants.chains import Chain
 from integrations.integration_ids import IntegrationID
 from integrations.integration import Integration
-from constants.firm import FIRM_SUSDE_DEPLOYMENT_BLOCK
-from utils.firm import get_escrow_contract, firm_susde_market_contract
-from utils.web3_utils import w3, fetch_events_logs_with_retry, call_with_retry
+from constants.firm import FIRM_SUSDE_DEPLOYMENT_BLOCK, SUSDE_MARKET_ADDRESS
+from utils.firm import get_firm_market_participants, get_firm_user_balance
+from utils.web3_utils import w3
 
 
 class Firm(Integration):
@@ -21,36 +21,14 @@ def __init__(self):
         )
 
     def get_balance(self, user: str, block: int) -> float:
-        # get user escrow
-        escrow_contract = get_escrow_contract(user)
-        # get the balance from the escrow
-        balance = call_with_retry(
-            escrow_contract.functions.balance(),
-            block,
-        )
+        balance = get_firm_user_balance(user, SUSDE_MARKET_ADDRESS, block)
         return balance / 1e18
 
     def get_participants(
         self,
         blocks: Optional[List[int]],
     ) -> Set[str]:
-        page_size = 1900
-        start_block = FIRM_SUSDE_DEPLOYMENT_BLOCK
-        target_block = w3.eth.get_block_number()
-
-        all_users = set()
-        while start_block < target_block:
-            to_block = min(start_block + page_size, target_block)
-            escrow_creations = fetch_events_logs_with_retry(
-                f"Inverse Finance FiRM users from {start_block} to {to_block}",
-                firm_susde_market_contract.events.CreateEscrow(),
-                start_block,
-                to_block,
-            )
-            for escrow_creation in escrow_creations:
-                all_users.add(escrow_creation["args"]["user"])
-            start_block += page_size
-        return all_users
+        return get_firm_market_participants(FIRM_SUSDE_DEPLOYMENT_BLOCK, SUSDE_MARKET_ADDRESS)
 
 
 if __name__ == "__main__":

integrations/firm_dola_susde_clp.py

@@ -0,0 +1,47 @@
+from typing import List, Optional, Set
+from constants.chains import Chain
+from integrations.integration_ids import IntegrationID
+from integrations.integration import Integration
+from constants.firm import FIRM_YV_SUSDE_DOLA_CLP_DEPLOYMENT_BLOCK, YV_SUSDE_DOLA_ADDRESS, YV_SUSDE_DOLA_CLP_MARKET_ADDRESS
+from utils.firm import get_firm_market_participants, get_firm_user_balance, get_yearn_vault_v2_contract
+from utils.web3_utils import w3, call_with_retry
+
+
+class Firm(Integration):
+    def __init__(self):
+        super().__init__(
+            IntegrationID.FIRM_YV_SUSDE_DOLA_CLP,
+            FIRM_YV_SUSDE_DOLA_CLP_DEPLOYMENT_BLOCK,
+            Chain.ETHEREUM,
+            [],
+            20,
+            1,
+            None,
+            None,
+        )
+
+    def get_balance(self, user: str, block: int) -> float:
+        balance = get_firm_user_balance(user, YV_SUSDE_DOLA_CLP_MARKET_ADDRESS, block)
+        # Yearn-specific logic
+        yearn_vault_v2_contract = get_yearn_vault_v2_contract(YV_SUSDE_DOLA_ADDRESS)
+        # get the price_per_share to then get the underlying lp balance
+        price_per_share = call_with_retry(
+            yearn_vault_v2_contract.functions.pricePerShare(),
+            block,
+        )
+        return balance / 1e18 * price_per_share / 1e18
+
+    def get_participants(
+        self,
+        blocks: Optional[List[int]],
+    ) -> Set[str]:
+        return get_firm_market_participants(FIRM_YV_SUSDE_DOLA_CLP_DEPLOYMENT_BLOCK, YV_SUSDE_DOLA_CLP_MARKET_ADDRESS)
+
+
+if __name__ == "__main__":
+    firm = Firm()
+    participants = firm.get_participants(None)
+    print("participants", participants)
+    currentBlock = w3.eth.get_block_number()
+    if len(participants) > 0:
+        print(firm.get_balance(list(participants)[len(participants) - 1], currentBlock))

integrations/firm_susde.py

@@ -398,6 +398,8 @@ class IntegrationID(Enum):
 
     # Inverse Finance FiRM
     FIRM_SUSDE = ("firm_susde", "Inverse Finance FiRM sUSDe", Token.SUSDE)
+    FIRM_SUSDE_DOLA_CLP = ("firm_susde_dola_clp", "Inverse Finance FiRM sUSDe/DOLA CLP", Token.SUSDE)
+    FIRM_YV_SUSDE_DOLA_CLP = ("firm_yv_susde_dola_clp", "Inverse Finance FiRM YV sUSDe/DOLA CLP", Token.SUSDE)
 
     # Hyperdrive
     HYPERDRIVE_SUSDE = (

integrations/firm_yv_dola_susde_clp.py

@@ -1,6 +1,9 @@
 import json
+from typing import Any, Set
 from web3 import Web3
 from utils.web3_utils import (
+    call_with_retry,
+    fetch_events_logs_with_retry,
     w3,
 )
 
@@ -12,16 +15,64 @@
 with open("abi/firm_simple_escrow.json") as f:
     firm_simple_escrow_abi = json.load(f)
 
+with open("abi/curve_stable_swap_ng_lp.json") as f:
+    curve_stable_swap_ng_lp_abi = json.load(f)
 
-firm_susde_market_contract = w3.eth.contract(
-    address=SUSDE_MARKET_ADDRESS, abi=firm_market_abi
-)
+with open("abi/yearn_v2_vault.json") as f:
+    yearn_v2_vault_abi = json.load(f)
 
+def get_firm_market_contract(marketAddress: str):
+    return w3.eth.contract(
+        address=Web3.to_checksum_address(marketAddress), abi=firm_market_abi
+    )
 
-def get_escrow_contract(user_address: str):
-    escrow_address: str = firm_susde_market_contract.functions.escrows(
+def get_escrow_contract(user_address: str, marketAddress: str):
+    escrow_address: str = get_firm_market_contract(marketAddress).functions.escrows(
         user_address
     ).call()
     return w3.eth.contract(
         address=Web3.to_checksum_address(escrow_address), abi=firm_simple_escrow_abi
     )
+
+def get_curve_lp_contract(lpAddress: str):
+    return w3.eth.contract(
+        address=Web3.to_checksum_address(lpAddress), abi=curve_stable_swap_ng_lp_abi
+    )
+
+def get_yearn_vault_v2_contract(yvAddress: str):
+    return w3.eth.contract(
+        address=Web3.to_checksum_address(yvAddress), abi=yearn_v2_vault_abi
+    )
+
+def get_firm_user_balance(user: str, marketAddress: str, block: int) -> Any:
+        # get user escrow
+        escrow_contract = get_escrow_contract(user, marketAddress)
+        # get the balance from the escrow
+        balance = call_with_retry(
+            escrow_contract.functions.balance(),
+            block,
+        )
+        return balance
+
+def get_firm_market_participants(
+        start_block: int,
+        marketAddress: str,
+    ) -> Set[str]:
+        page_size = 1900
+        target_block = w3.eth.get_block_number()
+
+        firm_market_contract = get_firm_market_contract(marketAddress)
+
+        all_users = set()
+        while start_block < target_block:
+            to_block = min(start_block + page_size, target_block)
+            escrow_creations = fetch_events_logs_with_retry(
+                f"Inverse Finance FiRM users from {start_block} to {to_block}",
+                firm_market_contract.events.CreateEscrow(),
+                start_block,
+                to_block,
+            )
+            for escrow_creation in escrow_creations:
+                all_users.add(escrow_creation["args"]["user"])
+            start_block += page_size
+        return all_users