intentkit 0.6.13.dev2__py3-none-any.whl → 0.8.17__py3-none-any.whl

intentkit/skills/defillama/yields/fetch_pools.py

@@ -1,7 +1,5 @@
 """Tool for fetching pool data via DeFi Llama API."""
 
-from typing import Optional
-
 from pydantic import BaseModel, Field
 
 from intentkit.skills.defillama.api import fetch_pools
@@ -21,13 +19,13 @@ Returns data including:
 class PredictionData(BaseModel):
     """Model representing prediction data for a pool."""
 
-    predictedClass: Optional[str] = Field(
+    predictedClass: str | None = Field(
         None, description="Predicted direction of APY movement"
     )
-    predictedProbability: Optional[float] = Field(
+    predictedProbability: float | None = Field(
         None, description="Probability of the prediction"
     )
-    binnedConfidence: Optional[int] = Field(None, description="Confidence level bucket")
+    binnedConfidence: int | None = Field(None, description="Confidence level bucket")
 
 
 class PoolData(BaseModel):
@@ -37,38 +35,36 @@ class PoolData(BaseModel):
     project: str = Field(..., description="Protocol or project name")
     symbol: str = Field(..., description="Token or pool symbol")
     tvlUsd: float = Field(..., description="Total Value Locked in USD")
-    apyBase: Optional[float] = Field(None, description="Base APY without rewards")
-    apyReward: Optional[float] = Field(None, description="Additional APY from rewards")
-    apy: Optional[float] = Field(None, description="Total APY including rewards")
-    rewardTokens: Optional[list[str]] = Field(
+    apyBase: float | None = Field(None, description="Base APY without rewards")
+    apyReward: float | None = Field(None, description="Additional APY from rewards")
+    apy: float | None = Field(None, description="Total APY including rewards")
+    rewardTokens: list[str] | None = Field(
         None, description="List of reward token addresses"
     )
-    pool: Optional[str] = Field(None, description="Pool identifier")
-    apyPct1D: Optional[float] = Field(None, description="1-day APY percentage change")
-    apyPct7D: Optional[float] = Field(None, description="7-day APY percentage change")
-    apyPct30D: Optional[float] = Field(None, description="30-day APY percentage change")
+    pool: str | None = Field(None, description="Pool identifier")
+    apyPct1D: float | None = Field(None, description="1-day APY percentage change")
+    apyPct7D: float | None = Field(None, description="7-day APY percentage change")
+    apyPct30D: float | None = Field(None, description="30-day APY percentage change")
     stablecoin: bool = Field(False, description="Whether pool involves stablecoins")
     ilRisk: str = Field("no", description="Impermanent loss risk assessment")
     exposure: str = Field("single", description="Asset exposure type")
-    predictions: Optional[PredictionData] = Field(
+    predictions: PredictionData | None = Field(
         None, description="APY movement predictions"
     )
-    poolMeta: Optional[str] = Field(None, description="Additional pool metadata")
-    mu: Optional[float] = Field(None, description="Mean APY value")
-    sigma: Optional[float] = Field(None, description="APY standard deviation")
-    count: Optional[int] = Field(None, description="Number of data points")
+    poolMeta: str | None = Field(None, description="Additional pool metadata")
+    mu: float | None = Field(None, description="Mean APY value")
+    sigma: float | None = Field(None, description="APY standard deviation")
+    count: int | None = Field(None, description="Number of data points")
     outlier: bool = Field(False, description="Whether pool is an outlier")
-    underlyingTokens: Optional[list[str]] = Field(
+    underlyingTokens: list[str] | None = Field(
         None, description="List of underlying token addresses"
     )
-    il7d: Optional[float] = Field(None, description="7-day impermanent loss")
-    apyBase7d: Optional[float] = Field(None, description="7-day base APY")
-    apyMean30d: Optional[float] = Field(None, description="30-day mean APY")
-    volumeUsd1d: Optional[float] = Field(None, description="24h volume in USD")
-    volumeUsd7d: Optional[float] = Field(None, description="7-day volume in USD")
-    apyBaseInception: Optional[float] = Field(
-        None, description="Base APY since inception"
-    )
+    il7d: float | None = Field(None, description="7-day impermanent loss")
+    apyBase7d: float | None = Field(None, description="7-day base APY")
+    apyMean30d: float | None = Field(None, description="30-day mean APY")
+    volumeUsd1d: float | None = Field(None, description="24h volume in USD")
+    volumeUsd7d: float | None = Field(None, description="7-day volume in USD")
+    apyBaseInception: float | None = Field(None, description="Base APY since inception")
 
 
 class FetchPoolsResponse(BaseModel):
@@ -76,7 +72,7 @@ class FetchPoolsResponse(BaseModel):
 
     status: str = Field("success", description="Response status")
     data: list[PoolData] = Field(default_factory=list, description="List of pool data")
-    error: Optional[str] = Field(None, description="Error message if any")
+    error: str | None = Field(None, description="Error message if any")
 
 
 class DefiLlamaFetchPools(DefiLlamaBaseTool):
@@ -87,9 +83,9 @@ class DefiLlamaFetchPools(DefiLlamaBaseTool):
 
     Example:
         pools_tool = DefiLlamaFetchPools(
-            skill_store=store,
+            ,
             agent_id="agent_123",
-            agent_store=agent_store
+            agent=agent
         )
         result = await pools_tool._arun()
     """

intentkit/skills/dexscreener/README.md

@@ -0,0 +1,154 @@
+# DexScreener Skill
+
+The DexScreener skill provides integration with the DexScreener API to search for cryptocurrency token pairs and retrieve market data including prices, volume, liquidity, and other trading metrics.
+
+## Overview
+
+DexScreener is a popular platform for tracking decentralized exchange (DEX) trading pairs across multiple blockchain networks. This skill enables your agent to search for token information and provide users with real-time market data.
+
+## Skills Available
+
+### `search_token`
+
+Searches DexScreener for token pairs matching a query string. Supports searching by:
+
+- Token symbol (e.g., "WIF", "DOGE")
+- Token name (e.g., "Dogwifhat")
+- Token address (e.g., "0x...")
+- Exact ticker matching with "$" prefix (e.g., "$WIF")
+- Pair address
+
+**Parameters:**
+
+- `query` (required): The search query string
+- `sort_by` (optional): Sort results by "liquidity" (default) or "volume"
+- `volume_timeframe` (optional): When sorting by volume, use "24_hour" (default), "6_hour", "1_hour", or "5_minutes"
+
+### `get_pair_info`
+
+Retrieves detailed information about a specific trading pair using chain ID and pair address.
+
+**Parameters:**
+
+- `chain_id` (required): The blockchain chain ID (e.g., "ethereum", "solana", "bsc", "polygon", "arbitrum", "base", "avalanche")
+- `pair_address` (required): The trading pair contract address
+
+### `get_token_pairs`
+
+Finds all trading pairs for a specific token using chain ID and token address.
+
+**Parameters:**
+
+- `chain_id` (required): The blockchain chain ID
+- `token_address` (required): The token contract address
+
+### `get_tokens_info`
+
+Retrieves detailed trading pair information for multiple tokens at once (up to 30 tokens).
+
+**Parameters:**
+
+- `chain_id` (required): The blockchain chain ID
+- `token_addresses` (required): List of token contract addresses (maximum 30)
+
+## Configuration
+
+Add to your agent configuration:
+
+```yaml
+skills:
+  dexscreener:
+    enabled: true
+    states:
+      search_token: public # or "private" or "disabled"
+      get_pair_info: public # or "private" or "disabled"
+      get_token_pairs: public # or "private" or "disabled"
+      get_tokens_info: public # or "private" or "disabled"
+```
+
+## Example Prompts
+
+Here are some example prompts that will trigger the DexScreener skill:
+
+### Basic Token Search
+
+- "What's the current price of WIF?"
+- "Show me information about Dogwifhat token"
+- "Find trading pairs for PEPE"
+- "Search for Solana tokens with high volume"
+
+### Address-Based Search
+
+- "Get token info for address 0x1234567890abcdef1234567890abcdef12345678"
+- "Look up this token contract: 0xabc123..."
+- "Find pairs for token address 0x..."
+
+### Exact Ticker Matching
+
+- "Show me all $WIF pairs" (matches only tokens with symbol "WIF")
+- "Find $DOGE trading data"
+- "$SOL price and volume information"
+
+### Sorting and Filtering
+
+- "Find highest volume tokens in the last hour"
+- "Show me tokens sorted by liquidity"
+- "Get 6-hour volume data for trending tokens"
+
+### Market Analysis
+
+- "What are the most liquid trading pairs right now?"
+- "Find new token launches with high volume"
+- "Show me tokens with significant price changes in the last 24 hours"
+- "Compare liquidity across different DEXes for a token"
+
+### Specific Pair Analysis
+
+- "Get detailed info for pair address 0x1234... on Ethereum"
+- "Show me the liquidity and volume for this Uniswap pair"
+- "Analyze this specific trading pair on Solana"
+- "What's the current price and 24h change for pair 0xabc..."
+
+### Token Pair Discovery
+
+- "Find all trading pairs for token 0x1234... on Ethereum"
+- "Where can I trade this token? Show me all available pairs"
+- "List all DEXes that have liquidity for this token address"
+- "Find the best liquidity pools for token 0xabc..."
+
+### Multi-Token Analysis
+
+- "Compare these 5 token addresses: [list of addresses]"
+- "Get trading data for my entire portfolio: [token addresses]"
+- "Analyze liquidity across these tokens on Ethereum"
+- "Show me pair information for these 10 tokens at once"
+
+### Portfolio Research
+
+- "Research this token before I invest: [token name/symbol]"
+- "Is this token legitimate? Check its social links"
+- "What DEXes is this token trading on?"
+- "Show me the trading activity for this pair"
+
+## Response Format
+
+The skill returns structured JSON data containing:
+
+- Token pair information (base/quote tokens)
+- Current prices in USD and native currency
+- Volume data across different timeframes
+- Liquidity information
+- Price change percentages
+- Market cap and fully diluted valuation
+- Social links and website information
+- Trading transaction counts
+
+## Rate Limits
+
+- 300 requests per minute across all users
+- Built-in rate limiting prevents exceeding API limits
+- Requests are queued and processed efficiently
+
+## Data Sources
+
+All data is sourced from the official DexScreener API, which aggregates information from major decentralized exchanges across multiple blockchain networks including Ethereum, Solana, Binance Smart Chain, and others.

intentkit/skills/dexscreener/__init__.py

@@ -1,93 +1,97 @@
-import logging
-from typing import Optional, TypedDict
-
-from intentkit.abstracts.skill import SkillStoreABC
-from intentkit.skills.base import SkillConfig, SkillState
-from intentkit.skills.dexscreener.base import DexScreenerBaseTool
-from intentkit.skills.dexscreener.search_token import SearchToken
-
-# Cache skills at the system level, because they are stateless
-_cache: dict[str, DexScreenerBaseTool] = {}
-
-logger = logging.getLogger(__name__)
-
-
-class SkillStates(TypedDict):
-    search_token: SkillState
-
-
-_SKILL_NAME_TO_CLASS_MAP: dict[str, type[DexScreenerBaseTool]] = {
-    "search_token": SearchToken,
-}
-
-
-class Config(SkillConfig):
-    """Configuration for DexScreener skills."""
-
-    enabled: bool
-    states: SkillStates
-
-
-async def get_skills(
-    config: "Config",
-    is_private: bool,
-    store: SkillStoreABC,
-    **_,
-) -> list[DexScreenerBaseTool]:
-    """Get all DexScreener skills.
-
-    Args:
-        config: The configuration for DexScreener skills.
-        is_private: Whether to include private skills.
-        store: The skill store for persisting data.
-
-    Returns:
-        A list of DexScreener skills.
-    """
-
-    available_skills = []
-
-    # Include skills based on their state
-    for skill_name, state in config["states"].items():
-        if state == "disabled":
-            continue
-        elif state == "public" or (state == "private" and is_private):
-            available_skills.append(skill_name)
-
-    logger.debug(f"Available Skills {available_skills}")
-    logger.debug(f"Hardcoded Skills {_SKILL_NAME_TO_CLASS_MAP}")
-
-    # Get each skill using the cached getter
-    result = []
-    for name in available_skills:
-        skill = get_dexscreener_skills(name, store)
-        if skill:
-            result.append(skill)
-    return result
-
-
-def get_dexscreener_skills(
-    name: str,
-    store: SkillStoreABC,
-) -> Optional[DexScreenerBaseTool]:
-    """Get a DexScreener skill by name.
-
-    Args:
-        name: The name of the skill to get
-        store: The skill store for persisting data
-
-    Returns:
-        The requested DexScreener skill
-    """
-
-    # Return from cache immediately if already exists
-    if name in _cache:
-        return _cache[name]
-
-    skill_class = _SKILL_NAME_TO_CLASS_MAP.get(name)
-    if not skill_class:
-        logger.warning(f"Unknown Dexscreener skill: {name}")
-        return None
-
-    _cache[name] = skill_class(skill_store=store)
-    return _cache[name]
+import logging
+from typing import TypedDict
+
+from intentkit.skills.base import SkillConfig, SkillState
+from intentkit.skills.dexscreener.base import DexScreenerBaseTool
+from intentkit.skills.dexscreener.get_pair_info import GetPairInfo
+from intentkit.skills.dexscreener.get_token_pairs import GetTokenPairs
+from intentkit.skills.dexscreener.get_tokens_info import GetTokensInfo
+from intentkit.skills.dexscreener.search_token import SearchToken
+
+# Cache skills at the system level, because they are stateless
+_cache: dict[str, DexScreenerBaseTool] = {}
+
+logger = logging.getLogger(__name__)
+
+
+class SkillStates(TypedDict):
+    search_token: SkillState
+    get_pair_info: SkillState
+    get_token_pairs: SkillState
+    get_tokens_info: SkillState
+
+
+_SKILL_NAME_TO_CLASS_MAP: dict[str, type[DexScreenerBaseTool]] = {
+    "search_token": SearchToken,
+    "get_pair_info": GetPairInfo,
+    "get_token_pairs": GetTokenPairs,
+    "get_tokens_info": GetTokensInfo,
+}
+
+
+class Config(SkillConfig):
+    """Configuration for DexScreener skills."""
+
+    enabled: bool
+    states: SkillStates
+
+
+async def get_skills(
+    config: "Config",
+    is_private: bool,
+    **_,
+) -> list[DexScreenerBaseTool]:
+    """Get all DexScreener skills.
+
+    Args:
+        config: The configuration for DexScreener skills.
+        is_private: Whether to include private skills.
+
+    Returns:
+        A list of DexScreener skills.
+    """
+
+    available_skills = []
+
+    # Include skills based on their state
+    for skill_name, state in config["states"].items():
+        if state == "disabled":
+            continue
+        elif state == "public" or (state == "private" and is_private):
+            available_skills.append(skill_name)
+
+    logger.debug(f"Available Skills {available_skills}")
+    logger.debug(f"Hardcoded Skills {_SKILL_NAME_TO_CLASS_MAP}")
+
+    # Get each skill using the cached getter
+    result = []
+    for name in available_skills:
+        skill = get_dexscreener_skills(name)
+        if skill:
+            result.append(skill)
+    return result
+
+
+def get_dexscreener_skills(
+    name: str,
+) -> DexScreenerBaseTool | None:
+    """Get a DexScreener skill by name.
+
+    Args:
+        name: The name of the skill to get
+
+    Returns:
+        The requested DexScreener skill
+    """
+
+    # Return from cache immediately if already exists
+    if name in _cache:
+        return _cache[name]
+
+    skill_class = _SKILL_NAME_TO_CLASS_MAP.get(name)
+    if not skill_class:
+        logger.warning(f"Unknown Dexscreener skill: {name}")
+        return None
+
+    _cache[name] = skill_class()
+    return _cache[name]