πŸ’‘Examples Overview

Simple, focused examples to get you started with Somnia Agent Kit.

πŸ“‹ Examples

1. Quickstart

File: 01-quickstart/index.ts What it does: Initialize SDK, connect to network, query agents Run: npx ts-node 01-quickstart/index.ts

2. Register Agent

File: 02-register-agent/index.ts What it does: Register a new AI agent on-chain Run: npx ts-node 02-register-agent/index.ts

3. AI Agent

File: 03-ai-agent/index.ts What it does: Use FREE local AI (Ollama) with agent Setup: Install Ollama first (see file comments) Run: npx ts-node 03-ai-agent/index.ts

4. Task Execution

File: 04-task-execution/index.ts What it does: Create, start, and complete tasks Run: npx ts-node 04-task-execution/index.ts

5. Monitoring

File: 05-monitoring/index.ts What it does: Use Logger, Metrics, and Dashboard Run: npx ts-node 05-monitoring/index.ts

6. MultiCall Batch Operations πŸ†•

File: 06-multicall-batch/index.ts What it does: Batch multiple contract calls into 1 RPC request (80-90% faster!) Features: Balance checks, token metadata, block aggregation Run: npx ts-node 06-multicall-batch/index.ts

7. Token Management πŸ†•

File: 07-token-management/index.ts What it does: Manage ERC20, ERC721, and native tokens Features: Balances, transfers, approvals, NFT operations Run: npx ts-node 07-token-management/index.ts

8. Convenience API Demo πŸ†•

File: 08-convenience-api/index.ts What it does: Demonstrate new convenient getter methods for all SDK modules Features: Easy access to all managers (tokens, multicall, IPFS, WebSocket, deployment, wallets) Run: npx ts-node 08-convenience-api/index.ts


πŸš€ Quick Start

1. Setup Environment

Create .env file in project root:

2. Install Dependencies

3. Run Examples


πŸ“ Notes

  • Quickstart: No private key needed (read-only)

  • Register Agent: Requires private key

  • AI Agent: Requires Ollama installed

  • Task Execution: Requires private key + existing agent

  • Monitoring: No blockchain needed

  • MultiCall Batch πŸ†•: Requires valid ERC20 token address

  • Token Management πŸ†•: Works with any token/NFT on Somnia testnet

  • Convenience API πŸ†•: No special requirements, demonstrates all module access



Happy coding! πŸš€

Last updated