clicks-crewai 0.1.0__tar.gz

clicks_crewai-0.1.0/PKG-INFO

@@ -0,0 +1,237 @@
+Metadata-Version: 2.4
+Name: clicks-crewai
+Version: 0.1.0
+Summary: Clicks Protocol yield management tools for CrewAI agent crews on Base
+Author-email: Clicks Protocol <dev@clicksprotocol.xyz>
+License: MIT
+Project-URL: Homepage, https://clicksprotocol.xyz
+Project-URL: Repository, https://github.com/clicks-protocol/clicks-crewai
+Project-URL: Documentation, https://docs.clicksprotocol.xyz/integrations/crewai
+Keywords: crewai,defi,yield,base,usdc,ai-agents,clicks-protocol
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: crewai>=0.28.0
+Requires-Dist: crewai-tools>=0.4.0
+Requires-Dist: pydantic>=2.0
+
+# Clicks Protocol — CrewAI Integration
+
+On-chain yield management tools for CrewAI agent crews on Base.
+
+Powered by [Clicks Protocol](https://clicksprotocol.xyz)
+
+## What It Does
+
+Gives your CrewAI agents the ability to manage idle USDC as a team. A Treasury Manager agent monitors balances, an Investment Analyst evaluates yield rates, and together they autonomously split funds 80/20: 80% liquid, 20% earning 4-8% APY on Base.
+
+## Installation
+
+```bash
+pip install clicks-crewai
+```
+
+Or from source:
+
+```bash
+git clone https://github.com/clicks-protocol/clicks-crewai
+cd clicks-crewai
+pip install -e .
+```
+
+### Prerequisites
+
+- Python >= 3.9
+- Node.js >= 18 (for SDK bridge)
+- `@clicks-protocol/sdk` installed: `npm install @clicks-protocol/sdk`
+
+### Environment Variables
+
+```bash
+export CLICKS_PRIVATE_KEY="your-agent-wallet-private-key"
+export CLICKS_RPC_URL="https://mainnet.base.org"        # optional
+export CLICKS_SDK_PATH="/path/to/sdk"                     # optional
+```
+
+## Quick Start
+
+```python
+from crewai import Agent, Task, Crew
+from clicks_crewai import (
+    ClicksCheckBalanceTool,
+    ClicksActivateYieldTool,
+    ClicksGetAPYTool,
+    ClicksSimulateSplitTool,
+    ClicksWithdrawYieldTool,
+)
+
+AGENT_ADDRESS = "0xYourAgentAddress"
+
+# Create tools
+balance_tool = ClicksCheckBalanceTool()
+yield_tool = ClicksActivateYieldTool()
+apy_tool = ClicksGetAPYTool()
+simulate_tool = ClicksSimulateSplitTool()
+withdraw_tool = ClicksWithdrawYieldTool()
+
+# Define agents
+treasury_manager = Agent(
+    role="Treasury Manager",
+    goal="Maximize yield on idle USDC while maintaining operational liquidity",
+    backstory=(
+        "You are an autonomous treasury manager for an AI agent. "
+        "Your job is to ensure idle USDC earns yield via Clicks Protocol "
+        "while keeping enough liquid for operations. You never risk funds "
+        "needed for imminent transactions."
+    ),
+    tools=[balance_tool, yield_tool, withdraw_tool, simulate_tool],
+    verbose=True,
+)
+
+investment_analyst = Agent(
+    role="Investment Analyst",
+    goal="Monitor yield rates and recommend optimal treasury allocation",
+    backstory=(
+        "You analyze DeFi yield rates and market conditions to advise "
+        "the Treasury Manager. You track Clicks Protocol APY and recommend "
+        "when to activate, hold, or withdraw yield positions."
+    ),
+    tools=[apy_tool, balance_tool, simulate_tool],
+    verbose=True,
+)
+
+# Define tasks
+analysis_task = Task(
+    description=(
+        f"Analyze the current treasury position for {AGENT_ADDRESS}. "
+        "Check the current APY rate, simulate a split for any idle funds, "
+        "and provide a recommendation on whether to activate yield."
+    ),
+    expected_output=(
+        "A treasury analysis report with: current balances, APY rate, "
+        "simulated split breakdown, and a clear recommendation."
+    ),
+    agent=investment_analyst,
+)
+
+execution_task = Task(
+    description=(
+        f"Based on the analyst's recommendation, take action on {AGENT_ADDRESS}. "
+        "If yield activation is recommended and APY > 4%, activate yield on idle funds. "
+        "If withdrawal is recommended, withdraw. Always check balance first."
+    ),
+    expected_output=(
+        "Confirmation of action taken with transaction details, or explanation "
+        "of why no action was taken."
+    ),
+    agent=treasury_manager,
+    context=[analysis_task],
+)
+
+# Run the crew
+crew = Crew(
+    agents=[investment_analyst, treasury_manager],
+    tasks=[analysis_task, execution_task],
+    verbose=True,
+)
+
+result = crew.kickoff()
+print(result)
+```
+
+## Available Tools
+
+| Tool | Description | Best For |
+|------|-------------|----------|
+| `ClicksCheckBalanceTool` | View liquid vs. yield balances | Treasury Manager |
+| `ClicksActivateYieldTool` | Split USDC 80/20 to earn yield | Treasury Manager |
+| `ClicksWithdrawYieldTool` | Withdraw all yield + deposits | Treasury Manager |
+| `ClicksGetAPYTool` | Get current APY rate | Investment Analyst |
+| `ClicksSimulateSplitTool` | Preview split without moving funds | Both |
+
+## Configuration
+
+```python
+from clicks_crewai import configure_sdk
+
+# Configure before creating tools
+configure_sdk(
+    rpc_url="https://mainnet.base.org",
+    private_key="your-key",
+    sdk_path="/path/to/sdk",
+)
+```
+
+Or use environment variables (recommended):
+
+```bash
+export CLICKS_PRIVATE_KEY="..."
+export CLICKS_RPC_URL="https://mainnet.base.org"
+```
+
+## Example: Scheduled Treasury Optimization
+
+```python
+import schedule
+import time
+from crewai import Agent, Task, Crew
+from clicks_crewai import get_all_tools
+
+AGENT_ADDRESS = "0xYourAgentAddress"
+
+def run_treasury_check():
+    tools = get_all_tools()
+    
+    manager = Agent(
+        role="Treasury Manager",
+        goal="Optimize USDC yield allocation",
+        backstory="Autonomous treasury manager using Clicks Protocol on Base.",
+        tools=tools,
+    )
+    
+    task = Task(
+        description=(
+            f"Check treasury status for {AGENT_ADDRESS}. "
+            "If idle USDC > 500 and APY > 4%, activate yield. "
+            "Report current status."
+        ),
+        expected_output="Treasury status and actions taken.",
+        agent=manager,
+    )
+    
+    crew = Crew(agents=[manager], tasks=[task])
+    return crew.kickoff()
+
+# Run every 6 hours
+schedule.every(6).hours.do(run_treasury_check)
+
+while True:
+    schedule.run_pending()
+    time.sleep(60)
+```
+
+## Contract Addresses (Base Mainnet)
+
+| Contract | Address |
+|----------|---------|
+| Registry | `0x23bb0Ea69b2BD2e527D5DbA6093155A6E1D0C0a3` |
+| Splitter | `0xc96C1a566a8ed7A39040a34927fEe952bAB8Ad1D` |
+| YieldRouter | `0x053167a233d18E05Bc65a8d5F3F8808782a3EECD` |
+| ClicksReferral | `0x1E5Ab896D3b3A542C5E91852e221b2D849944ccC` |
+| USDC | `0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913` |
+
+## License
+
+MIT
+
+---
+
+Built for autonomous AI agents. Powered by [Clicks Protocol](https://clicksprotocol.xyz).

clicks_crewai-0.1.0/README.md

@@ -0,0 +1,212 @@
+# Clicks Protocol — CrewAI Integration
+
+On-chain yield management tools for CrewAI agent crews on Base.
+
+Powered by [Clicks Protocol](https://clicksprotocol.xyz)
+
+## What It Does
+
+Gives your CrewAI agents the ability to manage idle USDC as a team. A Treasury Manager agent monitors balances, an Investment Analyst evaluates yield rates, and together they autonomously split funds 80/20: 80% liquid, 20% earning 4-8% APY on Base.
+
+## Installation
+
+```bash
+pip install clicks-crewai
+```
+
+Or from source:
+
+```bash
+git clone https://github.com/clicks-protocol/clicks-crewai
+cd clicks-crewai
+pip install -e .
+```
+
+### Prerequisites
+
+- Python >= 3.9
+- Node.js >= 18 (for SDK bridge)
+- `@clicks-protocol/sdk` installed: `npm install @clicks-protocol/sdk`
+
+### Environment Variables
+
+```bash
+export CLICKS_PRIVATE_KEY="your-agent-wallet-private-key"
+export CLICKS_RPC_URL="https://mainnet.base.org"        # optional
+export CLICKS_SDK_PATH="/path/to/sdk"                     # optional
+```
+
+## Quick Start
+
+```python
+from crewai import Agent, Task, Crew
+from clicks_crewai import (
+    ClicksCheckBalanceTool,
+    ClicksActivateYieldTool,
+    ClicksGetAPYTool,
+    ClicksSimulateSplitTool,
+    ClicksWithdrawYieldTool,
+)
+
+AGENT_ADDRESS = "0xYourAgentAddress"
+
+# Create tools
+balance_tool = ClicksCheckBalanceTool()
+yield_tool = ClicksActivateYieldTool()
+apy_tool = ClicksGetAPYTool()
+simulate_tool = ClicksSimulateSplitTool()
+withdraw_tool = ClicksWithdrawYieldTool()
+
+# Define agents
+treasury_manager = Agent(
+    role="Treasury Manager",
+    goal="Maximize yield on idle USDC while maintaining operational liquidity",
+    backstory=(
+        "You are an autonomous treasury manager for an AI agent. "
+        "Your job is to ensure idle USDC earns yield via Clicks Protocol "
+        "while keeping enough liquid for operations. You never risk funds "
+        "needed for imminent transactions."
+    ),
+    tools=[balance_tool, yield_tool, withdraw_tool, simulate_tool],
+    verbose=True,
+)
+
+investment_analyst = Agent(
+    role="Investment Analyst",
+    goal="Monitor yield rates and recommend optimal treasury allocation",
+    backstory=(
+        "You analyze DeFi yield rates and market conditions to advise "
+        "the Treasury Manager. You track Clicks Protocol APY and recommend "
+        "when to activate, hold, or withdraw yield positions."
+    ),
+    tools=[apy_tool, balance_tool, simulate_tool],
+    verbose=True,
+)
+
+# Define tasks
+analysis_task = Task(
+    description=(
+        f"Analyze the current treasury position for {AGENT_ADDRESS}. "
+        "Check the current APY rate, simulate a split for any idle funds, "
+        "and provide a recommendation on whether to activate yield."
+    ),
+    expected_output=(
+        "A treasury analysis report with: current balances, APY rate, "
+        "simulated split breakdown, and a clear recommendation."
+    ),
+    agent=investment_analyst,
+)
+
+execution_task = Task(
+    description=(
+        f"Based on the analyst's recommendation, take action on {AGENT_ADDRESS}. "
+        "If yield activation is recommended and APY > 4%, activate yield on idle funds. "
+        "If withdrawal is recommended, withdraw. Always check balance first."
+    ),
+    expected_output=(
+        "Confirmation of action taken with transaction details, or explanation "
+        "of why no action was taken."
+    ),
+    agent=treasury_manager,
+    context=[analysis_task],
+)
+
+# Run the crew
+crew = Crew(
+    agents=[investment_analyst, treasury_manager],
+    tasks=[analysis_task, execution_task],
+    verbose=True,
+)
+
+result = crew.kickoff()
+print(result)
+```
+
+## Available Tools
+
+| Tool | Description | Best For |
+|------|-------------|----------|
+| `ClicksCheckBalanceTool` | View liquid vs. yield balances | Treasury Manager |
+| `ClicksActivateYieldTool` | Split USDC 80/20 to earn yield | Treasury Manager |
+| `ClicksWithdrawYieldTool` | Withdraw all yield + deposits | Treasury Manager |
+| `ClicksGetAPYTool` | Get current APY rate | Investment Analyst |
+| `ClicksSimulateSplitTool` | Preview split without moving funds | Both |
+
+## Configuration
+
+```python
+from clicks_crewai import configure_sdk
+
+# Configure before creating tools
+configure_sdk(
+    rpc_url="https://mainnet.base.org",
+    private_key="your-key",
+    sdk_path="/path/to/sdk",
+)
+```
+
+Or use environment variables (recommended):
+
+```bash
+export CLICKS_PRIVATE_KEY="..."
+export CLICKS_RPC_URL="https://mainnet.base.org"
+```
+
+## Example: Scheduled Treasury Optimization
+
+```python
+import schedule
+import time
+from crewai import Agent, Task, Crew
+from clicks_crewai import get_all_tools
+
+AGENT_ADDRESS = "0xYourAgentAddress"
+
+def run_treasury_check():
+    tools = get_all_tools()
+    
+    manager = Agent(
+        role="Treasury Manager",
+        goal="Optimize USDC yield allocation",
+        backstory="Autonomous treasury manager using Clicks Protocol on Base.",
+        tools=tools,
+    )
+    
+    task = Task(
+        description=(
+            f"Check treasury status for {AGENT_ADDRESS}. "
+            "If idle USDC > 500 and APY > 4%, activate yield. "
+            "Report current status."
+        ),
+        expected_output="Treasury status and actions taken.",
+        agent=manager,
+    )
+    
+    crew = Crew(agents=[manager], tasks=[task])
+    return crew.kickoff()
+
+# Run every 6 hours
+schedule.every(6).hours.do(run_treasury_check)
+
+while True:
+    schedule.run_pending()
+    time.sleep(60)
+```
+
+## Contract Addresses (Base Mainnet)
+
+| Contract | Address |
+|----------|---------|
+| Registry | `0x23bb0Ea69b2BD2e527D5DbA6093155A6E1D0C0a3` |
+| Splitter | `0xc96C1a566a8ed7A39040a34927fEe952bAB8Ad1D` |
+| YieldRouter | `0x053167a233d18E05Bc65a8d5F3F8808782a3EECD` |
+| ClicksReferral | `0x1E5Ab896D3b3A542C5E91852e221b2D849944ccC` |
+| USDC | `0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913` |
+
+## License
+
+MIT
+
+---
+
+Built for autonomous AI agents. Powered by [Clicks Protocol](https://clicksprotocol.xyz).

clicks_crewai-0.1.0/clicks_crewai.egg-info/PKG-INFO

@@ -0,0 +1,237 @@
+Metadata-Version: 2.4
+Name: clicks-crewai
+Version: 0.1.0
+Summary: Clicks Protocol yield management tools for CrewAI agent crews on Base
+Author-email: Clicks Protocol <dev@clicksprotocol.xyz>
+License: MIT
+Project-URL: Homepage, https://clicksprotocol.xyz
+Project-URL: Repository, https://github.com/clicks-protocol/clicks-crewai
+Project-URL: Documentation, https://docs.clicksprotocol.xyz/integrations/crewai
+Keywords: crewai,defi,yield,base,usdc,ai-agents,clicks-protocol
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: crewai>=0.28.0
+Requires-Dist: crewai-tools>=0.4.0
+Requires-Dist: pydantic>=2.0
+
+# Clicks Protocol — CrewAI Integration
+
+On-chain yield management tools for CrewAI agent crews on Base.
+
+Powered by [Clicks Protocol](https://clicksprotocol.xyz)
+
+## What It Does
+
+Gives your CrewAI agents the ability to manage idle USDC as a team. A Treasury Manager agent monitors balances, an Investment Analyst evaluates yield rates, and together they autonomously split funds 80/20: 80% liquid, 20% earning 4-8% APY on Base.
+
+## Installation
+
+```bash
+pip install clicks-crewai
+```
+
+Or from source:
+
+```bash
+git clone https://github.com/clicks-protocol/clicks-crewai
+cd clicks-crewai
+pip install -e .
+```
+
+### Prerequisites
+
+- Python >= 3.9
+- Node.js >= 18 (for SDK bridge)
+- `@clicks-protocol/sdk` installed: `npm install @clicks-protocol/sdk`
+
+### Environment Variables
+
+```bash
+export CLICKS_PRIVATE_KEY="your-agent-wallet-private-key"
+export CLICKS_RPC_URL="https://mainnet.base.org"        # optional
+export CLICKS_SDK_PATH="/path/to/sdk"                     # optional
+```
+
+## Quick Start
+
+```python
+from crewai import Agent, Task, Crew
+from clicks_crewai import (
+    ClicksCheckBalanceTool,
+    ClicksActivateYieldTool,
+    ClicksGetAPYTool,
+    ClicksSimulateSplitTool,
+    ClicksWithdrawYieldTool,
+)
+
+AGENT_ADDRESS = "0xYourAgentAddress"
+
+# Create tools
+balance_tool = ClicksCheckBalanceTool()
+yield_tool = ClicksActivateYieldTool()
+apy_tool = ClicksGetAPYTool()
+simulate_tool = ClicksSimulateSplitTool()
+withdraw_tool = ClicksWithdrawYieldTool()
+
+# Define agents
+treasury_manager = Agent(
+    role="Treasury Manager",
+    goal="Maximize yield on idle USDC while maintaining operational liquidity",
+    backstory=(
+        "You are an autonomous treasury manager for an AI agent. "
+        "Your job is to ensure idle USDC earns yield via Clicks Protocol "
+        "while keeping enough liquid for operations. You never risk funds "
+        "needed for imminent transactions."
+    ),
+    tools=[balance_tool, yield_tool, withdraw_tool, simulate_tool],
+    verbose=True,
+)
+
+investment_analyst = Agent(
+    role="Investment Analyst",
+    goal="Monitor yield rates and recommend optimal treasury allocation",
+    backstory=(
+        "You analyze DeFi yield rates and market conditions to advise "
+        "the Treasury Manager. You track Clicks Protocol APY and recommend "
+        "when to activate, hold, or withdraw yield positions."
+    ),
+    tools=[apy_tool, balance_tool, simulate_tool],
+    verbose=True,
+)
+
+# Define tasks
+analysis_task = Task(
+    description=(
+        f"Analyze the current treasury position for {AGENT_ADDRESS}. "
+        "Check the current APY rate, simulate a split for any idle funds, "
+        "and provide a recommendation on whether to activate yield."
+    ),
+    expected_output=(
+        "A treasury analysis report with: current balances, APY rate, "
+        "simulated split breakdown, and a clear recommendation."
+    ),
+    agent=investment_analyst,
+)
+
+execution_task = Task(
+    description=(
+        f"Based on the analyst's recommendation, take action on {AGENT_ADDRESS}. "
+        "If yield activation is recommended and APY > 4%, activate yield on idle funds. "
+        "If withdrawal is recommended, withdraw. Always check balance first."
+    ),
+    expected_output=(
+        "Confirmation of action taken with transaction details, or explanation "
+        "of why no action was taken."
+    ),
+    agent=treasury_manager,
+    context=[analysis_task],
+)
+
+# Run the crew
+crew = Crew(
+    agents=[investment_analyst, treasury_manager],
+    tasks=[analysis_task, execution_task],
+    verbose=True,
+)
+
+result = crew.kickoff()
+print(result)
+```
+
+## Available Tools
+
+| Tool | Description | Best For |
+|------|-------------|----------|
+| `ClicksCheckBalanceTool` | View liquid vs. yield balances | Treasury Manager |
+| `ClicksActivateYieldTool` | Split USDC 80/20 to earn yield | Treasury Manager |
+| `ClicksWithdrawYieldTool` | Withdraw all yield + deposits | Treasury Manager |
+| `ClicksGetAPYTool` | Get current APY rate | Investment Analyst |
+| `ClicksSimulateSplitTool` | Preview split without moving funds | Both |
+
+## Configuration
+
+```python
+from clicks_crewai import configure_sdk
+
+# Configure before creating tools
+configure_sdk(
+    rpc_url="https://mainnet.base.org",
+    private_key="your-key",
+    sdk_path="/path/to/sdk",
+)
+```
+
+Or use environment variables (recommended):
+
+```bash
+export CLICKS_PRIVATE_KEY="..."
+export CLICKS_RPC_URL="https://mainnet.base.org"
+```
+
+## Example: Scheduled Treasury Optimization
+
+```python
+import schedule
+import time
+from crewai import Agent, Task, Crew
+from clicks_crewai import get_all_tools
+
+AGENT_ADDRESS = "0xYourAgentAddress"
+
+def run_treasury_check():
+    tools = get_all_tools()
+    
+    manager = Agent(
+        role="Treasury Manager",
+        goal="Optimize USDC yield allocation",
+        backstory="Autonomous treasury manager using Clicks Protocol on Base.",
+        tools=tools,
+    )
+    
+    task = Task(
+        description=(
+            f"Check treasury status for {AGENT_ADDRESS}. "
+            "If idle USDC > 500 and APY > 4%, activate yield. "
+            "Report current status."
+        ),
+        expected_output="Treasury status and actions taken.",
+        agent=manager,
+    )
+    
+    crew = Crew(agents=[manager], tasks=[task])
+    return crew.kickoff()
+
+# Run every 6 hours
+schedule.every(6).hours.do(run_treasury_check)
+
+while True:
+    schedule.run_pending()
+    time.sleep(60)
+```
+
+## Contract Addresses (Base Mainnet)
+
+| Contract | Address |
+|----------|---------|
+| Registry | `0x23bb0Ea69b2BD2e527D5DbA6093155A6E1D0C0a3` |
+| Splitter | `0xc96C1a566a8ed7A39040a34927fEe952bAB8Ad1D` |
+| YieldRouter | `0x053167a233d18E05Bc65a8d5F3F8808782a3EECD` |
+| ClicksReferral | `0x1E5Ab896D3b3A542C5E91852e221b2D849944ccC` |
+| USDC | `0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913` |
+
+## License
+
+MIT
+
+---
+
+Built for autonomous AI agents. Powered by [Clicks Protocol](https://clicksprotocol.xyz).

clicks_crewai-0.1.0/clicks_crewai.egg-info/SOURCES.txt

@@ -0,0 +1,8 @@
+README.md
+clicks_crewai.py
+pyproject.toml
+clicks_crewai.egg-info/PKG-INFO
+clicks_crewai.egg-info/SOURCES.txt
+clicks_crewai.egg-info/dependency_links.txt
+clicks_crewai.egg-info/requires.txt
+clicks_crewai.egg-info/top_level.txt

clicks_crewai-0.1.0/clicks_crewai.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

clicks_crewai-0.1.0/clicks_crewai.egg-info/requires.txt

@@ -0,0 +1,3 @@
+crewai>=0.28.0
+crewai-tools>=0.4.0
+pydantic>=2.0

clicks_crewai-0.1.0/clicks_crewai.egg-info/top_level.txt

@@ -0,0 +1 @@
+clicks_crewai

clicks_crewai-0.1.0/clicks_crewai.py

@@ -0,0 +1,422 @@
+"""
+Clicks Protocol CrewAI Tools
+==============================
+On-chain yield management tools for CrewAI agent crews on Base.
+Powered by Clicks Protocol (clicksprotocol.xyz)
+
+These tools enable CrewAI agents (e.g. Treasury Managers, Investment Analysts)
+to autonomously manage idle USDC by splitting funds 80/20:
+80% stays liquid for operations, 20% earns 4-8% APY on-chain.
+
+Usage:
+    from clicks_crewai import ClicksCheckBalanceTool, ClicksActivateYieldTool
+    treasury_agent = Agent(
+        role="Treasury Manager",
+        tools=[ClicksCheckBalanceTool(), ClicksActivateYieldTool()],
+    )
+"""
+
+import os
+import json
+import subprocess
+from typing import Optional, Type
+from pydantic import BaseModel, Field
+from crewai_tools import BaseTool
+
+
+# ---------------------------------------------------------------------------
+# Contract addresses (Base Mainnet)
+# ---------------------------------------------------------------------------
+CONTRACTS = {
+    "registry": "0x23bb0Ea69b2BD2e527D5DbA6093155A6E1D0C0a3",
+    "splitter": "0xc96C1a566a8ed7A39040a34927fEe952bAB8Ad1D",
+    "yield_router": "0x053167a233d18E05Bc65a8d5F3F8808782a3EECD",
+    "fee": "0xc47B162D3c456B6C56a3cE6EE89A828CFd34E6bE",
+    "referral": "0x1E5Ab896D3b3A542C5E91852e221b2D849944ccC",
+    "usdc": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
+}
+
+
+class ClicksSDKBridge:
+    """
+    Bridge to the @clicks-protocol/sdk Node.js package.
+    
+    Requires:
+        - Node.js >= 18
+        - @clicks-protocol/sdk installed
+        - CLICKS_RPC_URL env var (Base RPC endpoint)
+        - CLICKS_PRIVATE_KEY env var (agent wallet private key)
+    """
+
+    def __init__(
+        self,
+        rpc_url: Optional[str] = None,
+        private_key: Optional[str] = None,
+        sdk_path: Optional[str] = None,
+    ):
+        self.rpc_url = rpc_url or os.environ.get("CLICKS_RPC_URL", "https://mainnet.base.org")
+        self.private_key = private_key or os.environ.get("CLICKS_PRIVATE_KEY", "")
+        self.sdk_path = sdk_path or os.environ.get("CLICKS_SDK_PATH", ".")
+
+        if not self.private_key:
+            raise ValueError(
+                "No private key. Set CLICKS_PRIVATE_KEY env var or pass private_key."
+            )
+
+    def _call_sdk(self, method: str, **kwargs) -> dict:
+        """Execute an SDK method via Node.js subprocess."""
+        args_str = ", ".join(
+            f"'{v}'" if isinstance(v, str) else str(v) for v in kwargs.values()
+        )
+        script = f"""
+        const {{ ClicksClient }} = require('@clicks-protocol/sdk');
+        const {{ ethers }} = require('ethers');
+        (async () => {{
+            const provider = new ethers.JsonRpcProvider('{self.rpc_url}');
+            const wallet = new ethers.Wallet('{self.private_key}', provider);
+            const sdk = new ClicksClient(wallet);
+            try {{
+                const result = await sdk.{method}({args_str});
+                console.log(JSON.stringify({{ success: true, data: result }}, (k, v) => typeof v === 'bigint' ? v.toString() : v));
+            }} catch (e) {{
+                console.log(JSON.stringify({{ success: false, error: e.message }}));
+            }}
+        }})();
+        """
+        try:
+            result = subprocess.run(
+                ["node", "-e", script],
+                capture_output=True, text=True, timeout=60, cwd=self.sdk_path,
+            )
+            if result.returncode != 0:
+                return {"success": False, "error": result.stderr.strip()}
+            return json.loads(result.stdout.strip())
+        except subprocess.TimeoutExpired:
+            return {"success": False, "error": "SDK call timed out (60s)"}
+        except json.JSONDecodeError:
+            return {"success": False, "error": f"Invalid response: {result.stdout[:200]}"}
+
+    def quick_start(self, amount: str, agent_address: str) -> dict:
+        return self._call_sdk("quickStart", amount=amount, agentAddress=agent_address)
+
+    def withdraw_yield(self, agent_address: str) -> dict:
+        return self._call_sdk("withdrawYield", agentAddress=agent_address)
+
+    def simulate_split(self, amount: str, agent_address: str) -> dict:
+        return self._call_sdk("simulateSplit", amount=amount, agentAddress=agent_address)
+
+    def get_agent_info(self, agent_address: str) -> dict:
+        """Get agent registration info + yield balance combined."""
+        script = f"""
+        const {{ ClicksClient }} = require('@clicks-protocol/sdk');
+        const {{ ethers }} = require('ethers');
+        (async () => {{
+            const provider = new ethers.JsonRpcProvider('{self.rpc_url}');
+            const wallet = new ethers.Wallet('{self.private_key}', provider);
+            const sdk = new ClicksClient(wallet);
+            try {{
+                const [info, yieldBal, usdcBal] = await Promise.all([
+                    sdk.getAgentInfo('{agent_address}'),
+                    sdk.getAgentYieldBalance('{agent_address}'),
+                    sdk.getUSDCBalance('{agent_address}'),
+                ]);
+                console.log(JSON.stringify({{ success: true, data: {{
+                    isRegistered: info.isRegistered,
+                    operator: info.operator,
+                    liquidBalance: usdcBal.toString(),
+                    depositedBalance: yieldBal.deposited.toString(),
+                    accruedYield: yieldBal.yieldEarned.toString(),
+                    yieldPct: info.yieldPct.toString(),
+                }} }}));
+            }} catch (e) {{
+                console.log(JSON.stringify({{ success: false, error: e.message }}));
+            }}
+        }})();
+        """
+        try:
+            result = subprocess.run(
+                ["node", "-e", script],
+                capture_output=True, text=True, timeout=60, cwd=self.sdk_path,
+            )
+            if result.returncode != 0:
+                return {"success": False, "error": result.stderr.strip()}
+            return json.loads(result.stdout.strip())
+        except subprocess.TimeoutExpired:
+            return {"success": False, "error": "SDK call timed out (60s)"}
+        except json.JSONDecodeError:
+            return {"success": False, "error": f"Invalid response: {result.stdout[:200]}"}
+
+    def get_yield_info(self) -> dict:
+        return self._call_sdk("getYieldInfo")
+
+    def get_current_apy(self) -> dict:
+        """Get current APY from the active yield protocol."""
+        script = f"""
+        const {{ ClicksClient }} = require('@clicks-protocol/sdk');
+        const {{ ethers }} = require('ethers');
+        (async () => {{
+            const provider = new ethers.JsonRpcProvider('{self.rpc_url}');
+            const wallet = new ethers.Wallet('{self.private_key}', provider);
+            const sdk = new ClicksClient(wallet);
+            try {{
+                const info = await sdk.getYieldInfo();
+                const apy = info.activeProtocol === 1 ? info.aaveAPY : info.morphoAPY;
+                const apyPct = (Number(apy) / 100).toFixed(2);
+                console.log(JSON.stringify({{ success: true, data: apyPct }}));
+            }} catch (e) {{
+                console.log(JSON.stringify({{ success: false, error: e.message }}));
+            }}
+        }})();
+        """
+        try:
+            result = subprocess.run(
+                ["node", "-e", script],
+                capture_output=True, text=True, timeout=60, cwd=self.sdk_path,
+            )
+            if result.returncode != 0:
+                return {"success": False, "error": result.stderr.strip()}
+            return json.loads(result.stdout.strip())
+        except subprocess.TimeoutExpired:
+            return {"success": False, "error": "SDK call timed out (60s)"}
+        except json.JSONDecodeError:
+            return {"success": False, "error": f"Invalid response: {result.stdout[:200]}"}
+
+
+# ---------------------------------------------------------------------------
+# Shared SDK instance (lazy init)
+# ---------------------------------------------------------------------------
+_sdk_instance: Optional[ClicksSDKBridge] = None
+
+
+def _get_sdk() -> ClicksSDKBridge:
+    global _sdk_instance
+    if _sdk_instance is None:
+        _sdk_instance = ClicksSDKBridge()
+    return _sdk_instance
+
+
+def configure_sdk(
+    rpc_url: Optional[str] = None,
+    private_key: Optional[str] = None,
+    sdk_path: Optional[str] = None,
+):
+    """Configure the shared SDK instance. Call before using tools."""
+    global _sdk_instance
+    _sdk_instance = ClicksSDKBridge(rpc_url, private_key, sdk_path)
+
+
+# ---------------------------------------------------------------------------
+# CrewAI Tools
+# ---------------------------------------------------------------------------
+
+class ClicksCheckBalanceTool(BaseTool):
+    """Check how much USDC is liquid vs. earning yield on Clicks Protocol.
+    
+    Use this tool when you need to understand the agent's treasury position
+    before making spending or allocation decisions. Returns liquid balance,
+    deposited amount, accrued yield, and registration status.
+    """
+    
+    name: str = "Check USDC Balance & Yield Status"
+    description: str = (
+        "Check the agent's USDC treasury on Clicks Protocol: liquid funds "
+        "(available immediately), deposited amount (earning yield), accrued "
+        "earnings, and current APY. Use BEFORE making any treasury decision."
+    )
+
+    def _run(self, agent_address: str) -> str:
+        """
+        Args:
+            agent_address: Ethereum address of the agent wallet on Base
+        """
+        sdk = _get_sdk()
+        info = sdk.get_agent_info(agent_address)
+        apy = sdk.get_current_apy()
+
+        if not info.get("success"):
+            return f"Balance check failed: {info.get('error', 'Unknown error')}"
+
+        data = info.get("data", {})
+        apy_rate = apy.get("data", "N/A") if apy.get("success") else "N/A"
+
+        return (
+            f"Treasury Status for {agent_address}:\n"
+            f"  Liquid USDC: {data.get('liquidBalance', '0')} (available now)\n"
+            f"  Deposited:   {data.get('depositedBalance', '0')} (earning yield)\n"
+            f"  Accrued:     {data.get('accruedYield', '0')} (yield earned so far)\n"
+            f"  Current APY: {apy_rate}%\n"
+            f"  Registered:  {data.get('isRegistered', False)}\n"
+            f"  Protocol:    Clicks Protocol on Base"
+        )
+
+
+class ClicksActivateYieldTool(BaseTool):
+    """Activate yield on idle USDC via Clicks Protocol.
+    
+    Use this tool when the agent has USDC sitting idle that won't be needed
+    immediately. Splits funds 80/20: 80% stays liquid for operations,
+    20% earns 4-8% APY on-chain on Base.
+    
+    DO NOT use when:
+    - All funds are needed for an imminent transaction
+    - The amount is very small (gas may exceed yield)
+    - The agent is not on Base network
+    """
+    
+    name: str = "Activate USDC Yield"
+    description: str = (
+        "Split idle USDC 80/20 via Clicks Protocol. 80% stays liquid, "
+        "20% earns 4-8% APY on Base. Provide the USDC amount and agent address."
+    )
+
+    def _run(self, amount: str, agent_address: str) -> str:
+        """
+        Args:
+            amount: USDC amount to split (e.g. '5000')
+            agent_address: Ethereum address of the agent wallet on Base
+        """
+        sdk = _get_sdk()
+
+        # Simulate first
+        sim = sdk.simulate_split(amount, agent_address)
+        if not sim.get("success"):
+            return f"Simulation failed: {sim.get('error')}. Aborting."
+
+        result = sdk.quick_start(amount, agent_address)
+        if result.get("success"):
+            data = result.get("data", {})
+            liquid = float(amount) * 0.8
+            yield_amt = float(amount) * 0.2
+            return (
+                f"Yield activated on {amount} USDC:\n"
+                f"  Liquid (80%): {liquid:.2f} USDC — available immediately\n"
+                f"  Yield (20%):  {yield_amt:.2f} USDC — earning APY on Base\n"
+                f"  TX: {data.get('txHash', 'pending')}\n"
+                f"  Protocol: Clicks Protocol"
+            )
+        return f"Activation failed: {result.get('error', 'Unknown error')}"
+
+
+class ClicksWithdrawYieldTool(BaseTool):
+    """Withdraw earned yield and deposits from Clicks Protocol.
+    
+    Use when the agent needs maximum liquidity, wants to consolidate funds,
+    or when APY has dropped below acceptable levels. All accrued yield and
+    the deposited 20% are returned to the agent's wallet.
+    """
+    
+    name: str = "Withdraw Yield"
+    description: str = (
+        "Withdraw all earned yield and deposited funds from Clicks Protocol "
+        "back to the agent wallet. Use when maximum liquidity is needed."
+    )
+
+    def _run(self, agent_address: str) -> str:
+        """
+        Args:
+            agent_address: Ethereum address of the agent wallet on Base
+        """
+        sdk = _get_sdk()
+        result = sdk.withdraw_yield(agent_address)
+
+        if result.get("success"):
+            data = result.get("data", {})
+            return (
+                f"Withdrawal successful:\n"
+                f"  Amount returned: {data.get('amount', 'N/A')} USDC\n"
+                f"  TX: {data.get('txHash', 'pending')}\n"
+                f"  All funds are now liquid. No yield is being earned."
+            )
+        return f"Withdrawal failed: {result.get('error', 'Unknown error')}"
+
+
+class ClicksGetAPYTool(BaseTool):
+    """Get the current APY rate from Clicks Protocol.
+    
+    Use to evaluate whether activating yield is worthwhile, to compare
+    rates over time, or to report current earnings potential.
+    Typically returns 4-8% APY.
+    """
+    
+    name: str = "Get Current APY"
+    description: str = (
+        "Get the current annual percentage yield (APY) from Clicks Protocol. "
+        "Returns the live rate (typically 4-8%). Use to evaluate yield potential."
+    )
+
+    def _run(self) -> str:
+        sdk = _get_sdk()
+        result = sdk.get_current_apy()
+
+        if result.get("success"):
+            apy = result["data"]
+            assessment = ""
+            try:
+                apy_float = float(apy)
+                if apy_float >= 6:
+                    assessment = " (strong yield, recommended to activate)"
+                elif apy_float >= 4:
+                    assessment = " (healthy yield)"
+                else:
+                    assessment = " (below average, consider waiting)"
+            except (ValueError, TypeError):
+                pass
+            return f"Current Clicks Protocol APY: {apy}%{assessment}"
+        return f"Could not fetch APY: {result.get('error', 'Unknown error')}"
+
+
+class ClicksSimulateSplitTool(BaseTool):
+    """Preview how a USDC amount would be split before committing.
+    
+    Use for planning and analysis. Shows the 80/20 breakdown and
+    estimated annual yield. No funds are moved. This is read-only.
+    """
+    
+    name: str = "Simulate USDC Split"
+    description: str = (
+        "Preview how USDC would be split 80/20 without moving any funds. "
+        "Shows liquid amount, yield amount, and estimated earnings. "
+        "Use for planning before activating yield."
+    )
+
+    def _run(self, amount: str, agent_address: str) -> str:
+        """
+        Args:
+            amount: USDC amount to simulate (e.g. '10000')
+            agent_address: Ethereum address of the agent wallet on Base
+        """
+        sdk = _get_sdk()
+        result = sdk.simulate_split(amount, agent_address)
+
+        if result.get("success"):
+            data = result.get("data", {})
+            liquid = float(amount) * 0.8
+            yield_amt = float(amount) * 0.2
+            return (
+                f"Split Simulation for {amount} USDC:\n"
+                f"  Liquid (80%): {liquid:.2f} USDC — stays available\n"
+                f"  Yield (20%):  {yield_amt:.2f} USDC — earns APY\n"
+                f"  Est. Annual:  {data.get('estimatedYield', 'N/A')} USDC\n"
+                f"  No funds moved. Use 'Activate USDC Yield' to proceed."
+            )
+        return f"Simulation failed: {result.get('error', 'Unknown error')}"
+
+
+def get_all_tools() -> list:
+    """
+    Get all Clicks Protocol tools for a CrewAI crew.
+    
+    Returns:
+        List of CrewAI tools for treasury management
+        
+    Example:
+        from clicks_crewai import get_all_tools
+        tools = get_all_tools()
+    """
+    return [
+        ClicksCheckBalanceTool(),
+        ClicksActivateYieldTool(),
+        ClicksWithdrawYieldTool(),
+        ClicksGetAPYTool(),
+        ClicksSimulateSplitTool(),
+    ]

clicks_crewai-0.1.0/pyproject.toml

@@ -0,0 +1,39 @@
+[build-system]
+requires = ["setuptools>=68.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "clicks-crewai"
+version = "0.1.0"
+description = "Clicks Protocol yield management tools for CrewAI agent crews on Base"
+readme = "README.md"
+license = {text = "MIT"}
+requires-python = ">=3.9"
+authors = [
+    {name = "Clicks Protocol", email = "dev@clicksprotocol.xyz"},
+]
+keywords = ["crewai", "defi", "yield", "base", "usdc", "ai-agents", "clicks-protocol"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Software Development :: Libraries",
+]
+dependencies = [
+    "crewai>=0.28.0",
+    "crewai-tools>=0.4.0",
+    "pydantic>=2.0",
+]
+
+[project.urls]
+Homepage = "https://clicksprotocol.xyz"
+Repository = "https://github.com/clicks-protocol/clicks-crewai"
+Documentation = "https://docs.clicksprotocol.xyz/integrations/crewai"
+
+[tool.setuptools]
+py-modules = ["clicks_crewai"]

clicks_crewai-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+