Agent Engine для создания мощных и безопасных агентов ИИ на базе Starknet. Доступно как пакет NPM и готовый к использованию бэкэнд.
Быстрый старт
Предпосылки
- Кошелек Starknet (рекомендуется: Argent X )
- Ключ API поставщика ИИ (Anthropic/OpenAI/Google Gemini/Ollama)
- Node.js и pnpm установлены
Установка
git clone https://github.com/kasarlabs/snak.git
cd snak
pnpm install
Конфигурация
- Создайте файл
.env , скопировав .env.example :
Затем заполните необходимые значения в вашем файле .env :
# --- Starknet configuration (mandatory) ---
STARKNET_PUBLIC_ADDRESS="YOUR_STARKNET_PUBLIC_ADDRESS"
STARKNET_PRIVATE_KEY="YOUR_STARKNET_PRIVATE_KEY"
STARKNET_RPC_URL="YOUR_STARKNET_RPC_URL"
# --- AI Model API Keys (mandatory) ---
# Add the API keys for the specific AI providers you use in config/models/default.models.json
# The agent will automatically load the correct key based on the provider name.
# Example for OpenAI:
OPENAI_API_KEY="YOUR_OPENAI_API_KEY" # (e.g., sk-...)
# Example for Anthropic:
ANTHROPIC_API_KEY="YOUR_ANTHROPIC_API_KEY" # (e.g., sk-ant-...)
# Example for Google Gemini:
GEMINI_API_KEY="YOUR_GEMINI_API_KEY"
# Example for DeepSeek:
DEEPSEEK_API_KEY="YOUR_DEEPSEEK_API_KEY"
# Note: You do not need an API key if using a local Ollama model.
# --- General Agent Configuration (mandatory) ---
SERVER_API_KEY="YOUR_SERVER_API_KEY" # A secret key for your agent server API
SERVER_PORT="3001"
# --- PostgreSQL Database Configuration (mandatory) ---
POSTGRES_USER="admin"
POSTGRES_PASSWORD="admin"
POSTGRES_ROOT_DB="postgres" # Database used to create/manage the application database
POSTGRES_HOST="localhost"
POSTGRES_PORT="5454"
# --- LangSmith Tracing (Optional) ---
# Set LANGSMITH_TRACING=true to enable tracing
LANGSMITH_TRACING=false
LANGSMITH_ENDPOINT="https://api.smith.langchain.com"
LANGSMITH_API_KEY="YOUR_LANGSMITH_API_KEY" # (Only needed if LANGSMITH_TRACING=true)
LANGSMITH_PROJECT="Snak" # (Optional project name for LangSmith)
# --- Node Environment ---
NODE_ENV="development" # "development" or "production"
- Настройка моделей ИИ (необязательно): Файл
config/models/default.models.json определяет модели ИИ по умолчанию, используемые для различных задач ( fast , smart , cheap ). Вы можете настроить этот файл или создать новые конфигурации моделей (например, my_models.json ) и указать их при запуске агента. Структуру см. в config/models/example.models.json .Агент использует поле provider в конфигурации модели, чтобы определить, какой ключ API следует загрузить из файла .env (например, если provider является openai , он загружает OPENAI_API_KEY ). - Создайте файл конфигурации агента (например,
default.agent.json или my_agent.json ) в каталоге config/agents/ :
{
"name": "Your Agent name",
"group": "Your Agent group",
"description": "Your AI Agent Description",
"lore": ["Some lore of your AI Agent 1", "Some lore of your AI Agent 1"],
"objectives": [
"first objective that your AI Agent need to follow",
"second objective that your AI Agent need to follow"
],
"knowledge": [
"first knowledge of your AI Agent",
"second knowledge of your AI Agent"
],
"interval": "Your agent interval beetween each transaction of the Agent in ms,",
"chatId": "Your Agent Chat-id for isolating memory",
"maxIterations": "The number of iterations your agent will execute before stopping",
"mode": "The mode of your agent, can be interactive, autonomous or hybrid",
"memory": {
"enabled": "true or false to enable or disable memory",
"shortTermMemorySize": "The number of messages your agent will remember"
},
"plugins": ["Your first plugin", "Your second plugin"],
"mcpServers": {
"nxp_server_example": {
"command": "npx",
"args": ["-y", "@npm_package_example/npx_server_example"],
"env": {
"API_KEY": "YOUR_API_KEY"
}
},
"local_server_example": {
"command": "node",
"args": ["node /path/to/local_server/dist/index.js"]
}
}
}
Вы можете просто создать свою собственную конфигурацию агента, используя наш инструмент на snakagent
Использование
Режим подсказки
Запустите команду:
# start with the default.agent.json
pnpm run start
# start with your custom configuration
pnpm run start --agent="name_of_your_config.json" --models="name_of_your_config.json"
Режим сервера
Запустите сервер:
# start with the default.agent.json
pnpm run start:server
# start with your custom configuration
pnpm run start:server --agent="name_of_your_config.json" --models="name_of_your_config.json"
Доступные режимы
|Интерактивный режим|Автономный режим|
|---|---|---|
|Режим подсказки|✅|✅|
|Режим сервера|✅|✅|
Внедрите Snak в свой проект
- Установить пакет snak
#using npm
npm install @snakagent
# using pnpm
pnpm add @snakagent
- Создайте свой экземпляр агента
import { SnakAgent } from 'starknet-agent-kit';
const agent = new SnakAgent({
provider: new RpcProvider({ nodeUrl: process.env.STARKNET_RPC_URL }),
accountPrivateKey: process.env.STARKNET_PRIVATE_KEY,
accountPublicKey: process.env.STARKNET_PUBLIC_ADDRESS,
aiModel: process.env.AI_MODEL,
aiProvider: process.env.AI_PROVIDER,
aiProviderApiKey: process.env.AI_PROVIDER_API_KEY,
signature: 'key',
agentMode: 'interactive',
agentconfig: y,
});
const response = await agent.execute("What's my ETH balance?");
Действия
Чтобы узнать больше о действиях, вы можете прочитать этот раздел документа . Комплексный интерфейс в Kit предоставит простой в навигации каталог всех доступных плагинов и их действий, что упрощает обнаружение и использование.
Чтобы добавить действия в своего агента, вы можете легко следовать пошаговому руководству здесь.
Внося вклад
Вклады приветствуются! Не стесняйтесь отправлять запрос на извлечение.
Лицензия
Лицензия MIT — подробности см. в файле LICENSE.
Подробную документацию можно найти на docs.kasar.io