Commander bot UI fixes (#8)

* clean up

* clean up

* configure fallback emojis

* nuke coin emojis

* fix emissions, use generic coin icon

.env.example

@@ -21,4 +21,5 @@ SUGAR_TOKENS_CACHE_MINUTES=10
 # caching for Sugar LPs
 SUGAR_LPS_CACHE_MINUTES=10
 # caching for oracle pricing
-ORACLE_PRICES_CACHE_MINUTES=10
+ORACLE_PRICES_CACHE_MINUTES=10
+UI_POOL_STATS_THUMBNAIL=https://i.imgur.com/lGbVYac.png

.gitignore

@@ -160,4 +160,7 @@ cython_debug/
 #.idea/
 
 # VS Code
-.vscode
+.vscode
+
+# Mac
+.DS_Store

bots/commander.py

@@ -1,4 +1,4 @@
-from .data import LiquidityPool
+from .data import LiquidityPool, LiquidityPoolEpoch
 from .helpers import is_address
 from .ui import PoolsDropdown, PoolStats
 
@@ -7,6 +7,8 @@
 
 
 class _CommanderBot(commands.Bot):
+    """Commander bot instance to handle / commands"""
+
     def __init__(self):
         intents = discord.Intents.default()
         intents.message_content = True
@@ -22,21 +24,29 @@ async def on_ready(self):
 
 
 def CommanderBot() -> commands.Bot:
+    # keep our commander as a singleton
     return bot
 
 
 async def on_select_pool(
-    response: discord.InteractionResponse,
+    interaction: discord.Interaction,
     address_or_pool: str | LiquidityPool,
 ):
+    """Handle pool selection and reply with a pool stats embed
+
+    Args:
+        interaction (discord.Interaction): chat interaction
+        address_or_pool (str | LiquidityPool): pool address or instance
+    """
     pool = (
         await LiquidityPool.by_address(address_or_pool)
         if isinstance(address_or_pool, str)
         else address_or_pool
     )
     tvl = await LiquidityPool.tvl([pool])
-    await response.send_message(
-        await PoolStats().render(pool, tvl), suppress_embeds=True
+    pool_epoch = await LiquidityPoolEpoch.fetch_for_pool(pool.lp)
+    await interaction.response.send_message(
+        embed=await PoolStats(interaction.client.emojis).render(pool, tvl, pool_epoch)
     )
 
 
@@ -45,11 +55,21 @@ async def on_select_pool(
     address_or_query="Pool address or search query",
 )
 async def pool(interaction: discord.Interaction, address_or_query: str):
+    """Pool command handler: show specific pool or pool selector
+
+    Args:
+        interaction (discord.Interaction): chat interaction
+        address_or_query (str): command input
+    """
     if is_address(address_or_query):
+        # if /pool receives specific pool address,
+        # show the pool immediately or show in error
+        # message if it does not exist
+
         pool = await LiquidityPool.by_address(address_or_query)
 
         if pool is not None:
-            await on_select_pool(interaction.response, pool)
+            await on_select_pool(interaction, pool)
         else:
             await interaction.response.send_message(
                 f"No pool found with this address: {address_or_query}"
@@ -58,6 +78,15 @@ async def pool(interaction: discord.Interaction, address_or_query: str):
 
     pools = await LiquidityPool.search(address_or_query)
 
+    if len(pools) == 1:
+        # got exact match, show the pool
+        await on_select_pool(interaction, pools[0])
+        return
+
+    # search returned several pools, show them in a dropdown
     await interaction.response.send_message(
-        "Choose a pool:", view=PoolsDropdown(pools=pools, callback=on_select_pool)
+        "Choose a pool:",
+        view=PoolsDropdown(
+            interaction=interaction, pools=pools, callback=on_select_pool
+        ),
     )

bots/data.py

@@ -212,6 +212,7 @@ class LiquidityPool:
     gauge_total_supply: float
     emissions: Amount
     emissions_token: Token
+    weekly_emissions: Amount
 
     @classmethod
     def from_tuple(
@@ -224,6 +225,8 @@ def from_tuple(
         emissions_token = normalize_address(t[18])
         emissions = t[17]
 
+        seconds_in_a_week = 7 * 24 * 60 * 60
+
         return LiquidityPool(
             lp=normalize_address(t[0]),
             symbol=t[1],
@@ -240,6 +243,9 @@ def from_tuple(
             gauge_total_supply=t[12],
             emissions_token=tokens.get(emissions_token),
             emissions=Amount.build(emissions_token, emissions, tokens, prices),
+            weekly_emissions=Amount.build(
+                emissions_token, emissions * seconds_in_a_week, tokens, prices
+            ),
         )
 
     @classmethod
@@ -277,10 +283,18 @@ async def search(cls, query: str, limit: int = 10) -> List["LiquidityPool"]:
         def match_score(query: str, symbol: str):
             return fuzz.token_sort_ratio(query, symbol)
 
+        query_lowercase = query.lower()
         pools = await cls.get_pools()
         pools = list(
             filter(lambda p: p.token0 is not None and p.token1 is not None, pools)
         )
+
+        # look for exact match first, i.e. we get proper pool symbol in query (case insensitive)
+        exact_match = list(filter(lambda p: p.symbol.lower() == query_lowercase, pools))
+
+        if len(exact_match) == 1:
+            return exact_match
+
         pools_with_ratio = list(map(lambda p: (p, match_score(query, p.symbol)), pools))
         pools_with_ratio.sort(key=lambda p: p[1], reverse=True)
 
@@ -401,6 +415,15 @@ async def fetch_latest(cls):
 
         return result
 
+    @classmethod
+    async def fetch_for_pool(cls, pool_address: str) -> "LiquidityPoolEpoch":
+        pool_epochs = await cls.fetch_latest()
+        try:
+            a = normalize_address(pool_address)
+            return next(pe for pe in pool_epochs if pe.pool_address == a)
+        except Exception:
+            return None
+
     @property
     def total_fees(self) -> float:
         return sum(map(lambda fee: fee.amount_in_stable, self.fees))

bots/settings.py

@@ -41,3 +41,5 @@
 ORACLE_PRICES_CACHE_MINUTES = int(os.environ["ORACLE_PRICES_CACHE_MINUTES"])
 
 GOOD_ENOUGH_PAGINATION_LIMIT = 2000
+
+UI_POOL_STATS_THUMBNAIL = os.environ["UI_POOL_STATS_THUMBNAIL"]

bots/ui/__init__.py

@@ -1,2 +1,3 @@
 from .pools import PoolsDropdown  # noqa
 from .pool_stats import PoolStats  # noqa
+from .emojis import Emojis  # noqa

bots/ui/emojis.py

@@ -0,0 +1,30 @@
+from typing import Sequence
+from discord import Emoji
+
+
+class Emojis:
+    """Loads all custom emojis associated with current server and
+    makes them available via get method"""
+
+    def __init__(self, emojis: Sequence[Emoji]):
+        """Load all custom emojis
+
+        Args:
+            emojis (Sequence[Emoji]): custom emojis attached to a server
+        """
+        self.emojis = {}
+        for emoji in emojis:
+            # based on: https://github.com/Rapptz/discord.py/issues/390
+            self.emojis[emoji.name] = str(emoji)
+
+    def get(self, name: str, fallback: str = "*") -> str:
+        """Get custom emoji by name or return fallback string
+
+        Args:
+            name (str): name of the custom emoji to get
+            fallback (str, optional): fallback value to return. Defaults to "*".
+
+        Returns:
+            str: _description_
+        """
+        return self.emojis[name] if name in self.emojis else fallback