intentkit 0.5.0__py3-none-any.whl → 0.5.2__py3-none-any.whl

intentkit/skills/defillama/fees/fetch_fees_overview.py

@@ -0,0 +1,130 @@
+"""Tool for fetching fees overview data via DeFi Llama API."""
+
+from typing import Dict, List, Optional, Type
+
+from langchain.schema.runnable import RunnableConfig
+from pydantic import BaseModel, Field
+
+from intentkit.skills.defillama.api import fetch_fees_overview
+from intentkit.skills.defillama.base import DefiLlamaBaseTool
+
+FETCH_FEES_OVERVIEW_PROMPT = """
+This tool fetches comprehensive overview data for protocol fees from DeFi Llama.
+Returns detailed metrics including:
+- Total fees across different timeframes
+- Change percentages
+- Protocol-specific data
+- Chain breakdowns
+"""
+
+
+class ProtocolMethodology(BaseModel):
+    """Model representing protocol methodology data."""
+
+    UserFees: Optional[str] = Field(None, description="Description of user fees")
+    Fees: Optional[str] = Field(None, description="Description of fees")
+    Revenue: Optional[str] = Field(None, description="Description of revenue")
+    ProtocolRevenue: Optional[str] = Field(
+        None, description="Description of protocol revenue"
+    )
+    HoldersRevenue: Optional[str] = Field(
+        None, description="Description of holders revenue"
+    )
+    SupplySideRevenue: Optional[str] = Field(
+        None, description="Description of supply side revenue"
+    )
+
+
+class Protocol(BaseModel):
+    """Model representing protocol data."""
+
+    name: str = Field(..., description="Protocol name")
+    displayName: str = Field(..., description="Display name of protocol")
+    category: str = Field(..., description="Protocol category")
+    logo: str = Field(..., description="Logo URL")
+    chains: List[str] = Field(..., description="Supported chains")
+    module: str = Field(..., description="Protocol module")
+    total24h: Optional[float] = Field(None, description="24-hour total fees")
+    total7d: Optional[float] = Field(None, description="7-day total fees")
+    total30d: Optional[float] = Field(None, description="30-day total fees")
+    total1y: Optional[float] = Field(None, description="1-year total fees")
+    totalAllTime: Optional[float] = Field(None, description="All-time total fees")
+    change_1d: Optional[float] = Field(None, description="24-hour change percentage")
+    change_7d: Optional[float] = Field(None, description="7-day change percentage")
+    change_1m: Optional[float] = Field(None, description="30-day change percentage")
+    methodology: Optional[ProtocolMethodology] = Field(
+        None, description="Protocol methodology"
+    )
+    breakdown24h: Optional[Dict[str, Dict[str, float]]] = Field(
+        None, description="24-hour breakdown by chain"
+    )
+    breakdown30d: Optional[Dict[str, Dict[str, float]]] = Field(
+        None, description="30-day breakdown by chain"
+    )
+
+
+class FetchFeesOverviewResponse(BaseModel):
+    """Response schema for fees overview data."""
+
+    total24h: float = Field(..., description="Total fees in last 24 hours")
+    total7d: float = Field(..., description="Total fees in last 7 days")
+    total30d: float = Field(..., description="Total fees in last 30 days")
+    total1y: float = Field(..., description="Total fees in last year")
+    change_1d: float = Field(..., description="24-hour change percentage")
+    change_7d: float = Field(..., description="7-day change percentage")
+    change_1m: float = Field(..., description="30-day change percentage")
+    allChains: List[str] = Field(..., description="List of all chains")
+    protocols: List[Protocol] = Field(..., description="List of protocols")
+    error: Optional[str] = Field(None, description="Error message if any")
+
+
+class DefiLlamaFetchFeesOverview(DefiLlamaBaseTool):
+    """Tool for fetching fees overview data from DeFi Llama.
+
+    This tool retrieves comprehensive data about protocol fees,
+    including fee metrics, change percentages, and detailed protocol information.
+
+    Example:
+        overview_tool = DefiLlamaFetchFeesOverview(
+            skill_store=store,
+            agent_id="agent_123",
+            agent_store=agent_store
+        )
+        result = await overview_tool._arun()
+    """
+
+    name: str = "defillama_fetch_fees_overview"
+    description: str = FETCH_FEES_OVERVIEW_PROMPT
+
+    class EmptyArgsSchema(BaseModel):
+        """Empty schema for no input parameters."""
+
+        pass
+
+    args_schema: Type[BaseModel] = EmptyArgsSchema
+
+    async def _arun(self, config: RunnableConfig) -> FetchFeesOverviewResponse:
+        """Fetch overview data for protocol fees.
+
+        Returns:
+            FetchFeesOverviewResponse containing comprehensive fee data or error
+        """
+        try:
+            # Check rate limiting
+            context = self.context_from_config(config)
+            is_rate_limited, error_msg = await self.check_rate_limit(context)
+            if is_rate_limited:
+                return FetchFeesOverviewResponse(error=error_msg)
+
+            # Fetch fees data from API
+            result = await fetch_fees_overview()
+
+            # Check for API errors
+            if isinstance(result, dict) and "error" in result:
+                return FetchFeesOverviewResponse(error=result["error"])
+
+            # Return the parsed response
+            return FetchFeesOverviewResponse(**result)
+
+        except Exception as e:
+            return FetchFeesOverviewResponse(error=str(e))

intentkit/skills/defillama/schema.json

@@ -0,0 +1,383 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "title": "DeFiLlama",
+  "x-icon": "https://ai.service.crestal.dev/skills/defillama/defillama.jpeg",
+  "description": "Integration with DeFi Llama API providing comprehensive decentralized finance data including token prices, protocol TVL, DEX volumes, and stablecoin metrics",
+  "properties": {
+    "enabled": {
+      "type": "boolean",
+      "title": "Enabled",
+      "description": "Whether this skill is enabled",
+      "default": false
+    },
+    "states": {
+      "type": "object",
+      "properties": {
+        "fetch_batch_historical_prices": {
+          "type": "string",
+          "enum": [
+            "disabled",
+            "public",
+            "private"
+          ],
+          "x-enum-title": [
+            "Disabled",
+            "Agent Owner + All Users",
+            "Agent Owner Only"
+          ],
+          "description": "Fetch batch historical prices",
+          "default": "disabled"
+        },
+        "fetch_block": {
+          "type": "string",
+          "enum": [
+            "disabled",
+            "public",
+            "private"
+          ],
+          "x-enum-title": [
+            "Disabled",
+            "Agent Owner + All Users",
+            "Agent Owner Only"
+          ],
+          "description": "Fetch block",
+          "default": "disabled"
+        },
+        "fetch_current_prices": {
+          "type": "string",
+          "enum": [
+            "disabled",
+            "public",
+            "private"
+          ],
+          "x-enum-title": [
+            "Disabled",
+            "Agent Owner + All Users",
+            "Agent Owner Only"
+          ],
+          "description": "Fetch current prices",
+          "default": "disabled"
+        },
+        "fetch_first_price": {
+          "type": "string",
+          "enum": [
+            "disabled",
+            "public",
+            "private"
+          ],
+          "x-enum-title": [
+            "Disabled",
+            "Agent Owner + All Users",
+            "Agent Owner Only"
+          ],
+          "description": "Retrieves inaugural trading price data for assets with historical context",
+          "default": "disabled"
+        },
+        "fetch_historical_prices": {
+          "type": "string",
+          "enum": [
+            "disabled",
+            "public",
+            "private"
+          ],
+          "x-enum-title": [
+            "Disabled",
+            "Agent Owner + All Users",
+            "Agent Owner Only"
+          ],
+          "description": "Fetch historical prices",
+          "default": "disabled"
+        },
+        "fetch_price_chart": {
+          "type": "string",
+          "enum": [
+            "disabled",
+            "public",
+            "private"
+          ],
+          "x-enum-title": [
+            "Disabled",
+            "Agent Owner + All Users",
+            "Agent Owner Only"
+          ],
+          "description": "Fetch price chart",
+          "default": "disabled"
+        },
+        "fetch_price_percentage": {
+          "type": "string",
+          "enum": [
+            "disabled",
+            "public",
+            "private"
+          ],
+          "x-enum-title": [
+            "Disabled",
+            "Agent Owner + All Users",
+            "Agent Owner Only"
+          ],
+          "description": "Fetch price percentage",
+          "default": "disabled"
+        },
+        "fetch_fees_overview": {
+          "type": "string",
+          "title": "Fetch Fees Overview",
+          "enum": [
+            "disabled",
+            "public",
+            "private"
+          ],
+          "x-enum-title": [
+            "Disabled",
+            "Agent Owner + All Users",
+            "Agent Owner Only"
+          ],
+          "description": "Provides aggregated fee statistics across DEXs, lending protocols, and other fee-generating DeFi primitives",
+          "default": "disabled"
+        },
+        "fetch_stablecoin_chains": {
+          "type": "string",
+          "enum": [
+            "disabled",
+            "public",
+            "private"
+          ],
+          "x-enum-title": [
+            "Disabled",
+            "Agent Owner + All Users",
+            "Agent Owner Only"
+          ],
+          "description": "Shows blockchain distribution of stablecoin supply with chain-specific circulation metrics",
+          "default": "disabled"
+        },
+        "fetch_stablecoin_charts": {
+          "type": "string",
+          "enum": [
+            "disabled",
+            "public",
+            "private"
+          ],
+          "x-enum-title": [
+            "Disabled",
+            "Agent Owner + All Users",
+            "Agent Owner Only"
+          ],
+          "description": "Generates historical charts for stablecoin market cap, supply changes, and chain dominance",
+          "default": "disabled"
+        },
+        "fetch_stablecoin_prices": {
+          "type": "string",
+          "enum": [
+            "disabled",
+            "public",
+            "private"
+          ],
+          "x-enum-title": [
+            "Disabled",
+            "Agent Owner + All Users",
+            "Agent Owner Only"
+          ],
+          "description": "Fetch stablecoin prices",
+          "default": "disabled"
+        },
+        "fetch_stablecoins": {
+          "type": "string",
+          "enum": [
+            "disabled",
+            "public",
+            "private"
+          ],
+          "x-enum-title": [
+            "Disabled",
+            "Agent Owner + All Users",
+            "Agent Owner Only"
+          ],
+          "description": "Fetch stablecoins",
+          "default": "disabled"
+        },
+        "fetch_chain_historical_tvl": {
+          "type": "string",
+          "enum": [
+            "disabled",
+            "public",
+            "private"
+          ],
+          "x-enum-title": [
+            "Disabled",
+            "Agent Owner + All Users",
+            "Agent Owner Only"
+          ],
+          "description": "Retrieves historical TVL data for specific blockchain chains with daily granularity",
+          "default": "disabled"
+        },
+        "fetch_chains": {
+          "type": "string",
+          "enum": [
+            "disabled",
+            "public",
+            "private"
+          ],
+          "x-enum-title": [
+            "Disabled",
+            "Agent Owner + All Users",
+            "Agent Owner Only"
+          ],
+          "description": "Fetch chains",
+          "default": "disabled"
+        },
+        "fetch_historical_tvl": {
+          "type": "string",
+          "enum": [
+            "disabled",
+            "public",
+            "private"
+          ],
+          "x-enum-title": [
+            "Disabled",
+            "Agent Owner + All Users",
+            "Agent Owner Only"
+          ],
+          "description": "Provides historical TVL trends for the entire DeFi ecosystem or specific protocol categories",
+          "default": "disabled"
+        },
+        "fetch_protocol": {
+          "type": "string",
+          "enum": [
+            "disabled",
+            "public",
+            "private"
+          ],
+          "x-enum-title": [
+            "Disabled",
+            "Agent Owner + All Users",
+            "Agent Owner Only"
+          ],
+          "description": "Fetch protocol",
+          "default": "disabled"
+        },
+        "fetch_protocol_current_tvl": {
+          "type": "string",
+          "enum": [
+            "disabled",
+            "public",
+            "private"
+          ],
+          "x-enum-title": [
+            "Disabled",
+            "Agent Owner + All Users",
+            "Agent Owner Only"
+          ],
+          "description": "Fetch protocol current TVL",
+          "default": "disabled"
+        },
+        "fetch_protocols": {
+          "type": "string",
+          "enum": [
+            "disabled",
+            "public",
+            "private"
+          ],
+          "x-enum-title": [
+            "Disabled",
+            "Agent Owner + All Users",
+            "Agent Owner Only"
+          ],
+          "description": "Retrieves comprehensive list of all tracked DeFi protocols with their category, chain, and TVL data",
+          "default": "disabled"
+        },
+        "fetch_dex_overview": {
+          "type": "string",
+          "enum": [
+            "disabled",
+            "public",
+            "private"
+          ],
+          "x-enum-title": [
+            "Disabled",
+            "Agent Owner + All Users",
+            "Agent Owner Only"
+          ],
+          "description": "Provides aggregated DEX metrics including total volume, top trading pairs, and liquidity distribution",
+          "default": "disabled"
+        },
+        "fetch_dex_summary": {
+          "type": "string",
+          "enum": [
+            "disabled",
+            "public",
+            "private"
+          ],
+          "x-enum-title": [
+            "Disabled",
+            "Agent Owner + All Users",
+            "Agent Owner Only"
+          ],
+          "description": "Fetch dex summary",
+          "default": "disabled"
+        },
+        "fetch_options_overview": {
+          "type": "string",
+          "enum": [
+            "disabled",
+            "public",
+            "private"
+          ],
+          "x-enum-title": [
+            "Disabled",
+            "Agent Owner + All Users",
+            "Agent Owner Only"
+          ],
+          "description": "Fetch options overview",
+          "default": "disabled"
+        },
+        "fetch_pool_chart": {
+          "type": "string",
+          "enum": [
+            "disabled",
+            "public",
+            "private"
+          ],
+          "x-enum-title": [
+            "Disabled",
+            "Agent Owner + All Users",
+            "Agent Owner Only"
+          ],
+          "description": "Fetch pool chart",
+          "default": "disabled"
+        },
+        "fetch_pools": {
+          "type": "string",
+          "enum": [
+            "disabled",
+            "public",
+            "private"
+          ],
+          "x-enum-title": [
+            "Disabled",
+            "Agent Owner + All Users",
+            "Agent Owner Only"
+          ],
+          "description": "Fetch pools",
+          "default": "disabled"
+        }
+      },
+      "description": "States for each Defillama skill (disabled, public, or private)"
+    },
+    "api_key_provider": {
+      "type": "string",
+      "title": "API Key Provider",
+      "description": "Who provides the API key",
+      "enum": [
+        "platform"
+      ],
+      "x-enum-title": [
+        "Nation Hosted"
+      ],
+      "default": "platform"
+    }
+  },
+  "required": [
+    "states",
+    "enabled"
+  ]
+}

intentkit/skills/defillama/stablecoins/fetch_stablecoin_chains.py

@@ -0,0 +1,100 @@
+"""Tool for fetching stablecoin chains data via DeFi Llama API."""
+
+from typing import List, Optional
+
+from langchain.schema.runnable import RunnableConfig
+from pydantic import BaseModel, Field
+
+from intentkit.skills.defillama.api import fetch_stablecoin_chains
+from intentkit.skills.defillama.base import DefiLlamaBaseTool
+
+FETCH_STABLECOIN_CHAINS_PROMPT = """
+This tool fetches stablecoin distribution data across all chains from DeFi Llama.
+Returns:
+- List of chains with stablecoin circulating amounts
+- Token information for each chain
+- Peg type circulating amounts (USD, EUR, etc.)
+"""
+
+
+class CirculatingUSD(BaseModel):
+    """Model representing circulating amounts in different pegs."""
+
+    peggedUSD: Optional[float] = Field(None, description="Amount pegged to USD")
+    peggedEUR: Optional[float] = Field(None, description="Amount pegged to EUR")
+    peggedVAR: Optional[float] = Field(None, description="Amount in variable pegs")
+    peggedJPY: Optional[float] = Field(None, description="Amount pegged to JPY")
+    peggedCHF: Optional[float] = Field(None, description="Amount pegged to CHF")
+    peggedCAD: Optional[float] = Field(None, description="Amount pegged to CAD")
+    peggedGBP: Optional[float] = Field(None, description="Amount pegged to GBP")
+    peggedAUD: Optional[float] = Field(None, description="Amount pegged to AUD")
+    peggedCNY: Optional[float] = Field(None, description="Amount pegged to CNY")
+    peggedREAL: Optional[float] = Field(
+        None, description="Amount pegged to Brazilian Real"
+    )
+
+
+class ChainData(BaseModel):
+    """Model representing stablecoin data for a single chain."""
+
+    gecko_id: Optional[str] = Field(None, description="CoinGecko ID of the chain")
+    totalCirculatingUSD: CirculatingUSD = Field(
+        ..., description="Total circulating amounts in different pegs"
+    )
+    tokenSymbol: Optional[str] = Field(None, description="Native token symbol")
+    name: str = Field(..., description="Chain name")
+
+
+class FetchStablecoinChainsResponse(BaseModel):
+    """Response schema for stablecoin chains data."""
+
+    chains: List[ChainData] = Field(
+        default_factory=list, description="List of chains with their stablecoin data"
+    )
+    error: Optional[str] = Field(None, description="Error message if any")
+
+
+class DefiLlamaFetchStablecoinChains(DefiLlamaBaseTool):
+    """Tool for fetching stablecoin distribution across chains from DeFi Llama.
+
+    This tool retrieves data about how stablecoins are distributed across different
+    blockchain networks, including circulation amounts and token information.
+
+    Example:
+        chains_tool = DefiLlamaFetchStablecoinChains(
+            skill_store=store,
+            agent_id="agent_123",
+            agent_store=agent_store
+        )
+        result = await chains_tool._arun()
+    """
+
+    name: str = "defillama_fetch_stablecoin_chains"
+    description: str = FETCH_STABLECOIN_CHAINS_PROMPT
+    args_schema: None = None  # No input parameters needed
+
+    async def _arun(self, config: RunnableConfig) -> FetchStablecoinChainsResponse:
+        """Fetch stablecoin distribution data across chains.
+
+        Returns:
+            FetchStablecoinChainsResponse containing chain data or error
+        """
+        try:
+            # Check rate limiting
+            context = self.context_from_config(config)
+            is_rate_limited, error_msg = await self.check_rate_limit(context)
+            if is_rate_limited:
+                return FetchStablecoinChainsResponse(error=error_msg)
+
+            # Fetch chains data from API
+            result = await fetch_stablecoin_chains()
+
+            # Check for API errors
+            if isinstance(result, dict) and "error" in result:
+                return FetchStablecoinChainsResponse(error=result["error"])
+
+            # Return the response matching the API structure
+            return FetchStablecoinChainsResponse(chains=result)
+
+        except Exception as e:
+            return FetchStablecoinChainsResponse(error=str(e))