refactor(ecosystem): move hardcoded addresses to settings for consistency

Author: hitarthkhurana

src/flare_ai_kit/ecosystem/applications/cyclo.py

@@ -1,6 +1,6 @@
 """Cyclo protocol connector for non-liquidating leverage on Flare."""
 
-from typing import TYPE_CHECKING, Final, Self
+from typing import TYPE_CHECKING, Self
 
 import structlog
 from eth_typing import ChecksumAddress
@@ -21,16 +21,8 @@ class Cyclo(Flare):
 
     Cyclo allows users to lock collateral (sFLR) and mint cy* tokens that trade
     between $0-$1. Users can unlock collateral by burning cy* tokens + receipt NFTs.
-
-    Contract addresses (Flare mainnet):
-    - cysFLR Vault: 0x19831cfB53A0dbeAD9866C43557C1D48DfF76567
-    - cysFLR Receipt: 0xd387FC43E19a63036d8FCeD559E81f5dDeF7ef09
     """
 
-    # Cyclo contract addresses on Flare mainnet
-    CYSFLR_VAULT: Final[str] = "0x19831cfB53A0dbeAD9866C43557C1D48DfF76567"
-    CYSFLR_RECEIPT: Final[str] = "0xd387FC43E19a63036d8FCeD559E81f5dDeF7ef09"
-
     def __init__(self, settings: EcosystemSettings) -> None:
         """Initialize Cyclo connector."""
         super().__init__(settings)
@@ -56,22 +48,38 @@ async def create(cls, settings: EcosystemSettings) -> Self:
         logger.info("Initializing Cyclo...")
 
         try:
+            # Get addresses from settings
+            vault_address = (
+                settings.contracts.coston2.cyclo_cysflr_vault
+                if settings.is_testnet
+                else settings.contracts.flare.cyclo_cysflr_vault
+            )
+            receipt_address = (
+                settings.contracts.coston2.cyclo_cysflr_receipt
+                if settings.is_testnet
+                else settings.contracts.flare.cyclo_cysflr_receipt
+            )
+
+            if not vault_address or not receipt_address:
+                msg = "Cyclo contract addresses not configured in settings"
+                raise CycloError(msg)
+
             # Initialize cysFLR vault contract
             instance.vault_contract = instance.w3.eth.contract(  # pyright: ignore[reportUnknownMemberType, reportAttributeAccessIssue]
-                address=instance.w3.to_checksum_address(cls.CYSFLR_VAULT),
+                address=instance.w3.to_checksum_address(vault_address),
                 abi=load_abi("CycloVaultSFLR"),
             )
 
             # Initialize cysFLR receipt contract (ERC1155)
             instance.receipt_contract = instance.w3.eth.contract(  # pyright: ignore[reportUnknownMemberType, reportAttributeAccessIssue]
-                address=instance.w3.to_checksum_address(cls.CYSFLR_RECEIPT),
+                address=instance.w3.to_checksum_address(receipt_address),
                 abi=load_abi("CycloReceiptSFLR"),
             )
 
             logger.debug(
                 "Cyclo initialized",
-                vault_address=cls.CYSFLR_VAULT,
-                receipt_address=cls.CYSFLR_RECEIPT,
+                vault_address=vault_address,
+                receipt_address=receipt_address,
             )
             return instance  # noqa: TRY300
 

src/flare_ai_kit/ecosystem/applications/firelight.py

@@ -1,6 +1,6 @@
 """Firelight XRP staking protocol connector for Flare Network."""
 
-from typing import TYPE_CHECKING, Final
+from typing import TYPE_CHECKING
 
 from eth_typing import ChecksumAddress
 from structlog import get_logger
@@ -20,8 +20,6 @@
 class Firelight(Flare):
     """Firelight XRP staking protocol connector (stXRP vault)."""
 
-    STXRP_VAULT: Final[str] = "0x4C18Ff3C89632c3Dd62E796c0aFA5c07c4c1B2b3"
-
     def __init__(self, settings: EcosystemSettings) -> None:
         super().__init__(settings)
         self.vault_contract: Contract | None = None
@@ -44,12 +42,22 @@ async def create(cls, settings: EcosystemSettings) -> "Self":
         instance = cls(settings)
         logger.info("Initializing Firelight stXRP vault...")
         try:
+            # Get address from settings
+            vault_address = (
+                settings.contracts.coston2.firelight_stxrp_vault
+                if settings.is_testnet
+                else settings.contracts.flare.firelight_stxrp_vault
+            )
+            if not vault_address:
+                msg = "Firelight stXRP vault address not configured in settings"
+                raise FirelightError(msg)
+
             instance.vault_contract = instance.w3.eth.contract(  # pyright: ignore[reportAttributeAccessIssue]
-                address=instance.w3.to_checksum_address(cls.STXRP_VAULT),
+                address=instance.w3.to_checksum_address(vault_address),
                 abi=load_abi("FirelightVault_Implementation"),  # Use implementation ABI
             )
             logger.debug(
-                "Firelight stXRP vault initialized", contract_address=cls.STXRP_VAULT
+                "Firelight stXRP vault initialized", contract_address=vault_address
             )
             return instance  # noqa: TRY300
         except Exception as e:

src/flare_ai_kit/ecosystem/applications/kinetic.py

@@ -1,6 +1,6 @@
 """Kinetic lending protocol connector for Flare Network."""
 
-from typing import TYPE_CHECKING, Final
+from typing import TYPE_CHECKING
 
 from eth_typing import ChecksumAddress
 from structlog import get_logger
@@ -20,8 +20,6 @@
 class Kinetic(Flare):
     """Kinetic lending protocol connector (ksFLR market)."""
 
-    KSFLR_MARKET: Final[str] = "0x291487beC339c2fE5D83DD45F0a15EFC9Ac45656"
-
     def __init__(self, settings: EcosystemSettings) -> None:
         super().__init__(settings)
         self.ksflr_contract: Contract | None = None
@@ -44,12 +42,22 @@ async def create(cls, settings: EcosystemSettings) -> "Self":
         instance = cls(settings)
         logger.info("Initializing Kinetic ksFLR market...")
         try:
+            # Get address from settings
+            ksflr_address = (
+                settings.contracts.coston2.kinetic_ksflr
+                if settings.is_testnet
+                else settings.contracts.flare.kinetic_ksflr
+            )
+            if not ksflr_address:
+                msg = "Kinetic ksFLR contract address not configured in settings"
+                raise KineticError(msg)
+
             instance.ksflr_contract = instance.w3.eth.contract(  # pyright: ignore[reportAttributeAccessIssue]
-                address=instance.w3.to_checksum_address(cls.KSFLR_MARKET),
+                address=instance.w3.to_checksum_address(ksflr_address),
                 abi=load_abi("KineticKToken"),
             )
             logger.debug(
-                "Kinetic ksFLR market initialized", contract_address=cls.KSFLR_MARKET
+                "Kinetic ksFLR market initialized", contract_address=ksflr_address
             )
             return instance  # noqa: TRY300
         except Exception as e:

src/flare_ai_kit/ecosystem/applications/sceptre.py

@@ -1,6 +1,6 @@
 """Sceptre liquid staking connector for Flare Network."""
 
-from typing import TYPE_CHECKING, Final
+from typing import TYPE_CHECKING
 
 from eth_typing import ChecksumAddress
 from structlog import get_logger
@@ -20,8 +20,6 @@
 class Sceptre(Flare):
     """Sceptre liquid staking connector (stake FLR → receive sFLR)."""
 
-    SFLR_CONTRACT: Final[str] = "0x12e605bc104e93B45e1aD99F9e555f659051c2BB"
-
     def __init__(self, settings: EcosystemSettings) -> None:
         super().__init__(settings)
         self.sflr_contract: Contract | None = None
@@ -44,12 +42,22 @@ async def create(cls, settings: EcosystemSettings) -> "Self":
         instance = cls(settings)
         logger.info("Initializing Sceptre sFLR connector...")
         try:
+            # Get address from settings
+            sflr_address = (
+                settings.contracts.coston2.sceptre_sflr
+                if settings.is_testnet
+                else settings.contracts.flare.sceptre_sflr
+            )
+            if not sflr_address:
+                msg = "Sceptre sFLR contract address not configured in settings"
+                raise SceptreError(msg)
+
             instance.sflr_contract = instance.w3.eth.contract(  # pyright: ignore[reportAttributeAccessIssue]
-                address=instance.w3.to_checksum_address(cls.SFLR_CONTRACT),
+                address=instance.w3.to_checksum_address(sflr_address),
                 abi=load_abi("SceptreSFLR"),
             )
             logger.debug(
-                "Sceptre sFLR connector initialized", contract_address=cls.SFLR_CONTRACT
+                "Sceptre sFLR connector initialized", contract_address=sflr_address
             )
             return instance  # noqa: TRY300
         except Exception as e:

src/flare_ai_kit/ecosystem/applications/stargate.py

@@ -20,14 +20,6 @@ class Stargate(Flare):
     # Flare Network (endpointID: 30295)
     FLARE_ENDPOINT_ID: Final[int] = 30295
 
-    # Stargate OFT Token Addresses on Flare
-    STARGATE_ETH: Final[str] = "0x8e8539e4CcD69123c623a106773F2b0cbbc58746"
-    STARGATE_USDC: Final[str] = "0x77C71633C34C3784ede189d74223122422492a0f"
-    STARGATE_USDT: Final[str] = "0x1C10CC06DC6D35970d1D53B2A23c76ef370d4135"
-
-    TOKEN_MESSAGING: Final[str] = "0x45d417612e177672958dC0537C45a8f8d754Ac2E"
-    TREASURER: Final[str] = "0x090194F1EEDc134A680e3b488aBB2D212dba8c01"
-
     # Common Destination Chains
     CHAINS: Final[dict[str, int]] = {
         "ethereum": 30101,
@@ -44,6 +36,7 @@ class Stargate(Flare):
 
     def __init__(self, settings: EcosystemSettings) -> None:
         super().__init__(settings)
+        self.settings = settings
 
     @classmethod
     async def create(cls, settings: EcosystemSettings) -> "Self":
@@ -63,12 +56,28 @@ async def create(cls, settings: EcosystemSettings) -> "Self":
         instance = cls(settings)
         logger.info("Initializing Stargate bridge connector...")
         try:
+            # Verify addresses are configured
+            contracts = (
+                settings.contracts.coston2
+                if settings.is_testnet
+                else settings.contracts.flare
+            )
+            if not all(
+                [
+                    contracts.stargate_token_messaging,
+                    contracts.stargate_treasurer,
+                    contracts.stargate_eth_oft,
+                    contracts.stargate_usdc_oft,
+                    contracts.stargate_usdt_oft,
+                ]
+            ):
+                msg = "Stargate contract addresses not configured in settings"
+                raise StargateError(msg)
+
             logger.debug(
                 "Stargate connector initialized",
                 endpoint_id=cls.FLARE_ENDPOINT_ID,
-                eth_oft=cls.STARGATE_ETH,
-                usdc_oft=cls.STARGATE_USDC,
-                usdt_oft=cls.STARGATE_USDT,
+                network="testnet" if settings.is_testnet else "mainnet",
             )
             return instance  # noqa: TRY300
         except Exception as e:
@@ -94,13 +103,19 @@ def get_oft_address(self, token: str) -> str:
             >>> print(f"USDC OFT: {oft_addr}")
 
         """
+        contracts = (
+            self.settings.contracts.coston2
+            if self.settings.is_testnet
+            else self.settings.contracts.flare
+        )
+
         token_upper = token.upper()
         if token_upper == "ETH":
-            return self.STARGATE_ETH
+            return str(contracts.stargate_eth_oft)
         if token_upper == "USDC":
-            return self.STARGATE_USDC
+            return str(contracts.stargate_usdc_oft)
         if token_upper == "USDT":
-            return self.STARGATE_USDT
+            return str(contracts.stargate_usdt_oft)
         msg = f"Unsupported token: {token}. Supported: ETH, USDC, USDT"
         raise StargateError(msg)
 
@@ -168,11 +183,16 @@ def get_bridge_info(self) -> dict[str, str | int | list[str]]:
             >>> print(f"Flare endpoint: {info['endpoint_id']}")
 
         """
+        contracts = (
+            self.settings.contracts.coston2
+            if self.settings.is_testnet
+            else self.settings.contracts.flare
+        )
         return {  # pyright: ignore[reportReturnType]
             "network": "Flare",
             "endpoint_id": self.FLARE_ENDPOINT_ID,
-            "token_messaging": self.TOKEN_MESSAGING,
-            "treasurer": self.TREASURER,
+            "token_messaging": str(contracts.stargate_token_messaging),
+            "treasurer": str(contracts.stargate_treasurer),
             "supported_tokens": self.get_supported_tokens(),
             "supported_chains": self.get_supported_chains(),
         }

src/flare_ai_kit/ecosystem/settings.py

@@ -21,6 +21,15 @@ class ContractAddresses(BaseModel):
     sparkdex_swap_router: ChecksumAddress | None = None
     kinetic_comptroller: ChecksumAddress | None = None
     kinetic_ksflr: ChecksumAddress | None = None
+    sceptre_sflr: ChecksumAddress | None = None
+    cyclo_cysflr_vault: ChecksumAddress | None = None
+    cyclo_cysflr_receipt: ChecksumAddress | None = None
+    firelight_stxrp_vault: ChecksumAddress | None = None
+    stargate_token_messaging: ChecksumAddress | None = None
+    stargate_treasurer: ChecksumAddress | None = None
+    stargate_eth_oft: ChecksumAddress | None = None
+    stargate_usdc_oft: ChecksumAddress | None = None
+    stargate_usdt_oft: ChecksumAddress | None = None
 
 
 class Contracts(BaseModel):
@@ -40,6 +49,33 @@ class Contracts(BaseModel):
         kinetic_ksflr=cast(
             "ChecksumAddress", "0x291487beC339c2fE5D83DD45F0a15EFC9Ac45656"
         ),
+        sceptre_sflr=cast(
+            "ChecksumAddress", "0x12e605bc104e93B45e1aD99F9e555f659051c2BB"
+        ),
+        cyclo_cysflr_vault=cast(
+            "ChecksumAddress", "0x19831cfB53A0dbeAD9866C43557C1D48DfF76567"
+        ),
+        cyclo_cysflr_receipt=cast(
+            "ChecksumAddress", "0xd387FC43E19a63036d8FCeD559E81f5dDeF7ef09"
+        ),
+        firelight_stxrp_vault=cast(
+            "ChecksumAddress", "0x4C18Ff3C89632c3Dd62E796c0aFA5c07c4c1B2b3"
+        ),
+        stargate_token_messaging=cast(
+            "ChecksumAddress", "0x45d417612e177672958dC0537C45a8f8d754Ac2E"
+        ),
+        stargate_treasurer=cast(
+            "ChecksumAddress", "0x090194F1EEDc134A680e3b488aBB2D212dba8c01"
+        ),
+        stargate_eth_oft=cast(
+            "ChecksumAddress", "0x8e8539e4CcD69123c623a106773F2b0cbbc58746"
+        ),
+        stargate_usdc_oft=cast(
+            "ChecksumAddress", "0x77C71633C34C3784ede189d74223122422492a0f"
+        ),
+        stargate_usdt_oft=cast(
+            "ChecksumAddress", "0x1C10CC06DC6D35970d1D53B2A23c76ef370d4135"
+        ),
     )
     coston2: ContractAddresses = ContractAddresses()
 

tests/unit/ecosystem/applications/test_stargate.py

@@ -27,8 +27,10 @@ async def test_stargate_initialization(settings):
         stargate = await Stargate.create(settings)
 
         assert stargate.FLARE_ENDPOINT_ID == 30295
-        assert stargate.STARGATE_ETH == "0x8e8539e4CcD69123c623a106773F2b0cbbc58746"
-        assert stargate.STARGATE_USDC == "0x77C71633C34C3784ede189d74223122422492a0f"
+        # Verify addresses are loaded from settings
+        assert stargate.settings.contracts.flare.stargate_eth_oft is not None
+        assert stargate.settings.contracts.flare.stargate_usdc_oft is not None
+        assert stargate.settings.contracts.flare.stargate_usdt_oft is not None
 
 
 @pytest.mark.asyncio