Snak

🚀 Snak (Alpha Version)

Snak is a toolkit for creating AI agents that can interact with the Starknet blockchain. It is provided as an NPM package, accompanied by a pre - built NestJS server and a web interface. It supports multiple AI providers, including Anthropic, OpenAI, Google Gemini, and Ollama.

🚀 Quick Start

Prerequisites

• A Starknet wallet (Recommended: Argent X)
• API keys for AI service providers
• Node.js and pnpm installed

Installation

git clone https://github.com/kasarlabs/snak.git
cd snak
pnpm install

📦 Configuration

Step 1: Create a .env file

# Starknet configuration (Required)
STARKNET_PUBLIC_ADDRESS="Your Starknet public address"
STARKNET_PRIVATE_KEY="Your Starknet private key"
STARKNET_RPC_URL="Your Starknet RPC URL"

# AI provider configuration (Required)
AI_PROVIDER_API_KEY="Your AI provider API key"
AI_MODEL="The AI model you are using"
AI_PROVIDER="The AI provider you have chosen"

# NestJS server configuration
SERVER_API_KEY="Your server API key"
SERVER_PORT="Your server port"

# Node environment configuration (Optional, default is development)
NODE_ENV="development"
PORT=3000

Step 2: Create an agent.config.ts file

export default defineConfig({
  provider: {
    type: 'rpc',
    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,
});

💻 Usage Examples

Mode Overview

Integrating Snak into Your Project

Step 1: Install the Snak package

# Using npm
npm install @snakagent

# Or using pnpm
pnpm add @snakagent

Step 2: Create an AI agent instance

import { StarknetAgent } from 'starknet-agent-kit';

const agent = new StarknetAgent({
  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: 'auto',
});

const response = await agent.execute("What's my ETH balance?");

📚 Documentation

For more detailed information, please refer to docs.kasar.io

For more detailed documentation, visit docs.kasar.io