@iqai/plugin-atp
v0.4.3
Published
A **plugin** for interacting with **IQ ATP (Agent Tokenization Platform)** for buying, selling, and managing AI agent tokens.
Downloads
40
Readme
🎛 Plugin ATP
A plugin for interacting with IQ ATP (Agent Tokenization Platform) for buying, selling, and managing AI agent tokens.
📌 Overview
The Plugin ATP provides an interface to interact with IQ's Agent Tokenization Platform. It enables users to:
✅ View agent statistics 📊
✅ Check token holdings 💰
✅ Execute buy/sell trades for AI agent tokens 🔄
✅ View and add agent logs 📝
All trades use IQ as the base currency.
🛠 Installation
Install the plugin using pnpm:
pnpm add @iqai/plugin-atp⚙ Configuration
Set up your environment with the required wallet configuration:
| 🔧 Variable Name | 📜 Description |
|------------------------|-------------------------------------------------|
| WALLET_PRIVATE_KEY | Your wallet's private key for transaction signing 🔑 |
| API_KEY | API key for adding agent logs (required for log creation only) 🔑 |
🚀 Usage
Import and initialize the plugin:
import { createATPPlugin } from "@iqai/plugin-atp";
// Initialize the plugin
const plugin = await createATPPlugin({
walletPrivateKey: process.env.WALLET_PRIVATE_KEY,
apiKey: process.env.API_KEY // Required only for adding logs (optional)
});🎯 Actions
📊 ATP_GET_AGENT_STATS
Fetch statistics for a specific AI agent.
💬 Examples:
- "Show me stats for agent
0x1234...5678" - "Details for agent
0x1234...5678" - "What are the stats of Frax God agent?" (Works only if token contract found in previous messages)
📈 ATP_GET_POSITIONS
Retrieve your current holdings in ATP AI tokens.
💬 Examples:
- "Show my ATP holdings"
- "What positions do I have in ATP?"
- "My holdings in ATP"
🛒 ATP_BUY_AGENT
Purchase AI agent tokens using IQ as the base currency.
💬 Examples:
- "Buy 1000 IQ worth of agent
0x1234...5678" - "Purchase using 500 IQ of Frax God"
💰 ATP_SELL_AGENT
Sell AI agent tokens back to the protocol.
💬 Examples:
- "Sell 50 tokens of agent
0x1234...5678" - "Dispose 100 tokens of Frax God" (Works only if token contract found in previous messages)
- "Sell 1 million tokens of
0x1234...5678"
📋 ATP_GET_AGENTS
List available AI agents for trading.
💬 Examples:
- "List agents on atp"
- "Show me the top Agents on atp"
- "Show me top 5 agents on atp sorted by holders count"
📝 ATP_GET_AGENT_LOGS
Retrieve logs for a specific AI agent.
💬 Examples:
- "Show logs for agent
0x1234...5678" - "View recent activity for agent
0x1234...5678" - "Get agent logs for Frax God" (Works only if token contract found in previous messages)
- "Show page 2 of logs for agent
0x1234...5678" (For pagination)
✏️ ATP_ADD_AGENT_LOG
Add a new log entry for a specific AI agent. Requires API key.
💬 Examples:
- "Add log for agent
0x1234...5678: Just executed weekly yield distribution" - "Create log entry for Frax God: Updated pricing model" (Works only if token contract found in previous messages)
- "Log for agent
0x1234...5678with transaction hash0xabc...def: Distribution complete"
📜 Response Format
Actions return structured responses including:
✔ Transaction status & hash (for trades) 🔗
✔ Formatted token amounts 💲
✔ Error messages when applicable ⚠
✔ Agent addresses and statistics 🏷
✔ Formatted agent logs 📄
❌ Error Handling
The plugin handles various error scenarios:
🚨 Invalid token contracts
💸 Insufficient balances
🔄 Transaction failures
🌐 Network issues
🛑 Input validation errors
🔑 Missing API key for log creation
