(fix) Added extra logic to allow the tokens initialization to accept tokens with repeated symbol but different denom as different tokens

Author: abel

pyinjective/async_client.py

@@ -1067,32 +1067,22 @@ async def _initialize_tokens_and_markets(self):
 
         for market_info in markets_info:
             base_token_symbol, quote_token_symbol = market_info.ticker.split(constant.TICKER_TOKENS_SEPARATOR)
-            base_token = tokens.get(base_token_symbol, None)
-            if base_token is None:
-                base_token = Token(
-                    name=market_info.base_token_meta.name,
-                    symbol=base_token_symbol,
-                    denom=market_info.base_denom,
-                    address=market_info.base_token_meta.address,
-                    decimals=market_info.base_token_meta.decimals,
-                    logo=market_info.base_token_meta.logo,
-                    updated=market_info.base_token_meta.updated_at,
-                )
-                tokens[base_token_symbol] = base_token
+            base_token = self._token_representation(
+                symbol=base_token_symbol,
+                token_meta=market_info.base_token_meta,
+                denom=market_info.base_denom,
+                all_tokens=tokens,
+            )
+            if base_token.denom not in tokens_by_denom:
                 tokens_by_denom[base_token.denom] = base_token
 
-            quote_token = tokens.get(quote_token_symbol, None)
-            if quote_token is None:
-                quote_token = Token(
-                    name=market_info.quote_token_meta.name,
-                    symbol=quote_token_symbol,
-                    denom=market_info.quote_denom,
-                    address=market_info.quote_token_meta.address,
-                    decimals=market_info.quote_token_meta.decimals,
-                    logo=market_info.quote_token_meta.logo,
-                    updated=market_info.quote_token_meta.updated_at,
-                )
-                tokens[quote_token_symbol] = quote_token
+            quote_token = self._token_representation(
+                symbol=quote_token_symbol,
+                token_meta=market_info.quote_token_meta,
+                denom=market_info.quote_denom,
+                all_tokens=tokens,
+            )
+            if quote_token.denom not in tokens_by_denom:
                 tokens_by_denom[quote_token.denom] = quote_token
 
             market = SpotMarket(
@@ -1114,18 +1104,13 @@ async def _initialize_tokens_and_markets(self):
         for market_info in markets_info:
             quote_token_symbol = market_info.quote_token_meta.symbol
 
-            quote_token = tokens.get(quote_token_symbol, None)
-            if quote_token is None:
-                quote_token = Token(
-                    name=market_info.quote_token_meta.name,
-                    symbol=quote_token_symbol,
-                    denom=market_info.quote_denom,
-                    address=market_info.quote_token_meta.address,
-                    decimals=market_info.quote_token_meta.decimals,
-                    logo=market_info.quote_token_meta.logo,
-                    updated=market_info.quote_token_meta.updated_at,
-                )
-                tokens[quote_token_symbol] = quote_token
+            quote_token = self._token_representation(
+                symbol=quote_token_symbol,
+                token_meta=market_info.quote_token_meta,
+                denom=market_info.quote_denom,
+                all_tokens=tokens,
+            )
+            if quote_token.denom not in tokens_by_denom:
                 tokens_by_denom[quote_token.denom] = quote_token
 
             market = DerivativeMarket(
@@ -1176,3 +1161,26 @@ async def _initialize_tokens_and_markets(self):
         self._spot_markets = spot_markets
         self._derivative_markets = derivative_markets
         self._binary_option_markets = binary_option_markets
+
+    def _token_representation(self, symbol: str, token_meta, denom: str, all_tokens: Dict[str, Token]) -> Token:
+        token = Token(
+            name=token_meta.name,
+            symbol=symbol,
+            denom=denom,
+            address=token_meta.address,
+            decimals=token_meta.decimals,
+            logo=token_meta.logo,
+            updated=token_meta.updated_at,
+        )
+
+        existing_token = all_tokens.get(token.symbol, None)
+        if existing_token is None:
+            all_tokens[token.symbol] = token
+            existing_token = token
+        elif existing_token.denom != denom:
+            existing_token = all_tokens.get(token.name, None)
+            if existing_token is None:
+                all_tokens[token.name] = token
+                existing_token = token
+
+        return existing_token

pyinjective/denoms_testnet.ini

@@ -36,7 +36,7 @@ min_display_quantity_tick_size = 1e-13
 
 [0x1c315bd2cfcc769a8d8eca49ce7b1bc5fb0353bfcb9fa82895fe0c1c2a62306e]
 description = 'Testnet Spot WBTC/USDT'
-base = 6
+base = 8
 quote = 6
 min_price_tick_size = 0.00001
 min_display_price_tick_size = 0.001
@@ -56,25 +56,7 @@ min_display_quantity_tick_size = 0.1
 description = 'Testnet Derivative INJ/USDT PERP'
 base = 0
 quote = 6
-min_price_tick_size = 100000
-min_display_price_tick_size = 0.1
-min_quantity_tick_size = 0.0001
-min_display_quantity_tick_size = 0.0001
-
-[0xd5e4b12b19ecf176e4e14b42944731c27677819d2ed93be4104ad7025529c7ff]
-description = 'Testnet Derivative ETH/USDT PERP'
-base = 0
-quote = 6
-min_price_tick_size = 100000
-min_display_price_tick_size = 0.1
-min_quantity_tick_size = 0.0001
-min_display_quantity_tick_size = 0.0001
-
-[0x90e662193fa29a3a7e6c07be4407c94833e762d9ee82136a2cc712d6b87d7de3]
-description = 'Testnet Derivative BTC/USDT PERP'
-base = 0
-quote = 6
-min_price_tick_size = 100000
+min_price_tick_size = 100
 min_display_price_tick_size = 0.1
 min_quantity_tick_size = 0.0001
 min_display_quantity_tick_size = 0.0001

pyinjective/utils/metadata_validation.py

@@ -10,6 +10,7 @@
 
 def find_metadata_inconsistencies(network: Network) -> Tuple[List[Any]]:
     client = AsyncClient(network, insecure=False)
+    ini_config = constant.CONFIGS[network.string()]
 
     spot_markets = asyncio.get_event_loop().run_until_complete(client.all_spot_markets())
     derivative_markets = asyncio.get_event_loop().run_until_complete(client.all_derivative_markets())
@@ -21,7 +22,7 @@ def find_metadata_inconsistencies(network: Network) -> Tuple[List[Any]]:
     peggy_denoms_not_found = []
     peggy_denoms_with_diffs = []
 
-    for config_key in constant.mainnet_config:
+    for config_key in ini_config:
         if config_key.startswith("0x"):
             denom = constant.Denom.load_market(network=network.string(), market_id=config_key)
             if config_key in spot_markets:

tests/rpc_fixtures/markets_fixtures.py

@@ -46,6 +46,21 @@ def usdt_token_meta():
 
     return token
 
+@pytest.fixture
+def usdt_token_meta_second_denom():
+    from pyinjective.proto.exchange.injective_spot_exchange_rpc_pb2 import TokenMeta
+
+    token = TokenMeta(
+        name="USDT Second Denom",
+        address="0x0000000000000000000000000000000000000000",
+        symbol="USDT",
+        logo="https://static.alchemyapi.io/images/assets/826.png",
+        decimals=6,
+        updated_at=1691739137645
+    )
+
+    return token
+
 
 @pytest.fixture
 def usdt_perp_token_meta():
@@ -64,7 +79,7 @@ def usdt_perp_token_meta():
 
 
 @pytest.fixture
-def ape_usdt_spot_market(ape_token_meta, usdt_token_meta):
+def ape_usdt_spot_market_meta(ape_token_meta, usdt_token_meta_second_denom):
     from pyinjective.proto.exchange.injective_spot_exchange_rpc_pb2 import SpotMarketInfo
 
     market = SpotMarketInfo(
@@ -73,8 +88,8 @@ def ape_usdt_spot_market(ape_token_meta, usdt_token_meta):
         ticker="APE/USDT",
         base_denom="peggy0x44C21afAaF20c270EBbF5914Cfc3b5022173FEB7",
         base_token_meta=ape_token_meta,
-        quote_denom="peggy0x87aB3B4C8661e07D6372361211B96ed4Dc36B1B5",
-        quote_token_meta=usdt_token_meta,
+        quote_denom="factory/peggy0x87aB3B4C8661e07D6372361211B96ed4Dc300000",
+        quote_token_meta=usdt_token_meta_second_denom,
         maker_fee_rate="-0.0001",
         taker_fee_rate="0.001",
         service_provider_fee="0.4",
@@ -85,7 +100,7 @@ def ape_usdt_spot_market(ape_token_meta, usdt_token_meta):
     return market
 
 @pytest.fixture
-def inj_usdt_spot_market(inj_token_meta, usdt_token_meta):
+def inj_usdt_spot_market_meta(inj_token_meta, usdt_token_meta):
     from pyinjective.proto.exchange.injective_spot_exchange_rpc_pb2 import SpotMarketInfo
 
     market = SpotMarketInfo(
@@ -106,7 +121,7 @@ def inj_usdt_spot_market(inj_token_meta, usdt_token_meta):
     return market
 
 @pytest.fixture
-def btc_usdt_perp_market(usdt_perp_token_meta):
+def btc_usdt_perp_market_meta(usdt_perp_token_meta):
     from pyinjective.proto.exchange.injective_derivative_exchange_rpc_pb2 import (
         DerivativeMarketInfo,
         PerpetualMarketInfo,
@@ -150,7 +165,7 @@ def btc_usdt_perp_market(usdt_perp_token_meta):
     return market
 
 @pytest.fixture
-def first_match_bet_market(inj_usdt_spot_market):
+def first_match_bet_market_meta(inj_usdt_spot_market_meta):
     from pyinjective.proto.exchange.injective_derivative_exchange_rpc_pb2 import BinaryOptionsMarketInfo
 
     market = BinaryOptionsMarketInfo(
@@ -163,7 +178,7 @@ def first_match_bet_market(inj_usdt_spot_market):
         oracle_scale_factor=6,
         expiration_timestamp=1707800399,
         settlement_timestamp=1707843599,
-        quote_denom=inj_usdt_spot_market.quote_denom,
+        quote_denom=inj_usdt_spot_market_meta.quote_denom,
         maker_fee_rate="0",
         taker_fee_rate="0",
         service_provider_fee="0.4",

tests/test_async_client.py

@@ -12,11 +12,12 @@
     inj_token_meta,
     ape_token_meta,
     usdt_token_meta,
+    usdt_token_meta_second_denom,
     usdt_perp_token_meta,
-    inj_usdt_spot_market,
-    ape_usdt_spot_market,
-    btc_usdt_perp_market,
-    first_match_bet_market,
+    inj_usdt_spot_market_meta,
+    ape_usdt_spot_market_meta,
+    btc_usdt_perp_market_meta,
+    first_match_bet_market_meta,
 )
 from tests.rpc_fixtures.configurable_servicers import ConfigurableInjectiveDerivativeExchangeRPCServicer, \
     ConfigurableInjectiveSpotExchangeRPCServicer
@@ -114,20 +115,20 @@ async def test_initialize_tokens_and_markets(
             self,
             spot_servicer,
             derivative_servicer,
-            inj_usdt_spot_market,
-            ape_usdt_spot_market,
-            btc_usdt_perp_market,
-            first_match_bet_market,
+            inj_usdt_spot_market_meta,
+            ape_usdt_spot_market_meta,
+            btc_usdt_perp_market_meta,
+            first_match_bet_market_meta,
     ):
         spot_servicer.markets_queue.append(injective_spot_exchange_rpc_pb2.MarketsResponse(
-            markets=[inj_usdt_spot_market, ape_usdt_spot_market]
+            markets=[inj_usdt_spot_market_meta, ape_usdt_spot_market_meta]
         ))
         derivative_servicer.markets_queue.append(injective_derivative_exchange_rpc_pb2.MarketsResponse(
-            markets=[btc_usdt_perp_market]
+            markets=[btc_usdt_perp_market_meta]
         ))
         derivative_servicer.binary_option_markets_queue.append(
             injective_derivative_exchange_rpc_pb2.BinaryOptionsMarketsResponse(
-                markets=[first_match_bet_market]
+                markets=[first_match_bet_market_meta]
         ))
 
         client = AsyncClient(
@@ -141,24 +142,26 @@ async def test_initialize_tokens_and_markets(
         await client._initialize_tokens_and_markets()
 
         all_tokens = await client.all_tokens()
-        assert(4 == len(all_tokens))
-        inj_symbol, usdt_symbol = inj_usdt_spot_market.ticker.split("/")
-        ape_symbol, _ = ape_usdt_spot_market.ticker.split("/")
-        usdt_perp_symbol = btc_usdt_perp_market.quote_token_meta.symbol
-        assert(any((inj_symbol == token.symbol for _, token in all_tokens.items())))
-        assert (any((usdt_symbol == token.symbol for _, token in all_tokens.items())))
-        assert (any((ape_symbol == token.symbol for _, token in all_tokens.items())))
-        assert (any((usdt_perp_symbol == token.symbol for _, token in all_tokens.items())))
+        assert(5 == len(all_tokens))
+        inj_symbol, usdt_symbol = inj_usdt_spot_market_meta.ticker.split("/")
+        ape_symbol, _ = ape_usdt_spot_market_meta.ticker.split("/")
+        alternative_usdt_name = ape_usdt_spot_market_meta.quote_token_meta.name
+        usdt_perp_symbol = btc_usdt_perp_market_meta.quote_token_meta.symbol
+        assert(inj_symbol in all_tokens)
+        assert(usdt_symbol in all_tokens)
+        assert(alternative_usdt_name in all_tokens)
+        assert(ape_symbol in all_tokens)
+        assert(usdt_perp_symbol in all_tokens)
 
         all_spot_markets = await client.all_spot_markets()
         assert (2 == len(all_spot_markets))
-        assert (any((inj_usdt_spot_market.market_id == market.id for market in all_spot_markets.values())))
-        assert (any((ape_usdt_spot_market.market_id == market.id for market in all_spot_markets.values())))
+        assert (any((inj_usdt_spot_market_meta.market_id == market.id for market in all_spot_markets.values())))
+        assert (any((ape_usdt_spot_market_meta.market_id == market.id for market in all_spot_markets.values())))
 
         all_derivative_markets = await client.all_derivative_markets()
         assert (1 == len(all_derivative_markets))
-        assert (any((btc_usdt_perp_market.market_id == market.id for market in all_derivative_markets.values())))
+        assert (any((btc_usdt_perp_market_meta.market_id == market.id for market in all_derivative_markets.values())))
 
         all_binary_option_markets = await client.all_binary_option_markets()
         assert (1 == len(all_binary_option_markets))
-        assert (any((first_match_bet_market.market_id == market.id for market in all_binary_option_markets.values())))
+        assert (any((first_match_bet_market_meta.market_id == market.id for market in all_binary_option_markets.values())))