Source code for tradingstrategy.stablecoin

"""Stablecoin filtering.

- See also :py:mod:`tradingstrategy.utils.token_filter` for more token types and filtering functionality.


"""

# Maintenance of stablecoin list moved to eth_defi package.
# Allow alias import here.
from eth_defi.token import ALL_STABLECOIN_LIKE, STABLECOIN_LIKE

def is_stablecoin_like(token_symbol: str, symbol_list=ALL_STABLECOIN_LIKE) -> bool:
    """Check if specific token symbol is likely a stablecoin.

    Useful for quickly filtering stable/stable pairs in the pools.
    However, you should never rely on this check alone.

    Note that new stablecoins might be introduced, so this check
    is never going to be future proof.

    :param token_symbol:
        Token symbol as it is written on the contract.
        May contain lower and uppercase latter.

    :param symbol_list:
        Which filtering list we use.
    """
    assert isinstance(token_symbol, str), f"We got {token_symbol}"
    return (token_symbol in symbol_list)