Skip to content

SuperSonic is an innovative open-source project revolutionizing the Sonic DeFi landscape through AI-powered agent swarms.

Notifications You must be signed in to change notification settings

nicoware-dev/supersonic

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

40 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SuperSonic: Sonic DeFi Agent Swarm

SuperSonic Logo

Revolutionizing Sonic DeFi with AI-Powered Agent Swarms

Simplify your Sonic DeFi experience with the power of Multi-Agent Systems (MAS)

Discord X Demo Video Linktree Website Gitbook

💥 Sonic World — DeFAI Hackathon 💥

📚 Table of Contents

🌟 Overview

SuperSonic is an innovative open-source project revolutionizing the Sonic DeFi landscape through AI-powered agent swarms. By employing a sophisticated multi-agent system, SuperSonic streamlines and automates DeFi operations, offering users a seamless and efficient experience on Sonic. Its modular design ensures scalability and adaptability, empowering users to navigate the complexities of DeFi with ease and confidence.

You can find detailed information in our system overview, and complete whitepaper.

Why Multi-Agent Systems (MAS)?

Our platform leverages a Multi-Agent System architecture where each agent specializes in specific tasks—from fetching metrics to executing trades—enabling modular, scalable, and efficient operations. This approach ensures:

  • 🎯 Specialization: Optimized performance through task-specific agents
  • 📈 Scalability: Easy addition of new agents and features
  • 🛡️ Robustness: Continued operation even if individual agents fail
  • ⚡ Efficiency: Parallel task execution for improved performance
  • 🔄 Adaptability: Seamless integration with new protocols and APIs

Learn more about our agent system in the agents documentation.

SuperSonic Architecture

SuperSonic Architecture

✨ Features

Core Features

  • 💬 Natural language processing
  • 🔍 RAG (Retrieval-Augmented Generation) Knowledge Base
  • 🤖 Multi-Agent System (MAS): 18 AI Agents included.
  • 🔅 Integrated Website & Web App
  • 🛠️ Full-featured Discord, Twitter and Telegram connectors
  • 🔗 Support for every model (Llama, Grok, OpenAI, Anthropic, etc.)
  • 👥 Multi-agent and room support
  • 📚 Easily ingest and interact with your documents
  • 💾 Retrievable memory and document store
  • 💰 Real-time prices using CoinGecko API
  • 🚀 Real-time TVL using DefiLlama API
  • 📊 Real-time Pools data using GeckoTerminal
  • 📝 Text generation and analysis
  • 🎨 Image generation and description
  • 🗣️ Speech synthesis and recognition
  • 📊 Data visualization
  • 🌐 Web browsing capabilities
  • 🚀 Highly extensible - create your own actions and clients

Sonic Features

  • 💰 Wallet management
  • 💸 Token transfers (S, USDT, and custom tokens)
  • 💱 Token swapping on Beets DEX
  • 🔍 Transaction tracking
  • 💸 Lending & Borrowing on Silo Finance
  • 🌐 Bridge tokens using deBridge
  • 💧 LiquidStaking on Beets LST
  • 🌾 Yield Farming on Beets DEX (WIP)

🖥️ Web App Features

  • 🚀 Landing page
  • 🎨 Modern, responsive design
  • 📄 Agents Directory
  • 🤖 Chat with Agent Swarm through web interface
  • 👛 Sonic wallet connector (MetaMask)
  • 📊 Portfolio & Analytics dashboard (WIP)
  • 📝 Transaction History (TBD)
  • 🌐 Token Gating (TBD)
SuperSonic Client Interface

SuperSonic Web Client

🧰 Tech Stack

  • ElizaOS
  • Vite
  • TailwindCSS
  • ShadcnUI
  • Typescript
  • Python
  • NodeJS
  • n8n (Workflow Automation and agent orchestration)

🤖 Agent Categories

For complete details about each agent's capabilities and use cases, see our agents documentation.

🏢 Internal Agents (Platform Operations)

  1. 💼 Sales Agent: Customer relations and onboarding
  2. 🎨 Meme Agent: Social media marketing agents promoting SuperSonic
  3. 🎮 Demo Agent: Interactive platform demonstration and feature showcase

🌐 Public Agents (Shared Services)

  1. 📊 Metrics Agent: Provides protocol TVL, prices, and performance metrics
  2. 🔍 Alpha Agent: Market opportunities, Twitter and Web Scraping
  3. 📈 Analyst Agent: Risks, performance, and market analysis
  4. 🖼️ NFTs Agent: NFT intelligence and market analysis
  5. 📣 KOL Agent: Social media service
  6. 📝 Token Deployer: Token and liquidity pool deployment
  7. 🎨 NFT Deployer: NFT Collection deployment
  8. 🔷 Sonic Expert: Documentation, resources, tips and advice for Sonic users and devs
  9. 🎮 Predictions Agent: Trend analysis and predictions

🔒 Private Agents (Custom Deployments)

  1. 🎨 Coordinator Agent: Advanced orchestration system implemented in n8n for multi-agent operations. Features voice and text interactions via Telegram, with the ability to delegate tasks to specialized agents across different frameworks.
  2. 💱 DeFi Agent: Manages DeFi operations (Staking, Lending, Borrowing, Yield Farming, etc.)
  3. 📈 Trading Agent: Manages trading operations (Swaps, position management, rebalancing, strategies, etc.)
  4. 👛 Wallet Agent: Manages Sonic wallet operations (Transfers, Signatures, etc.)
  5. 🏛️ DAO Agent: Manages DAO operations (Treasury management, proposal management, DAO metrics, etc.)
  6. 💡 Advisor Agent: Manages strategy planning and provides advice

🏠 Self-Hosting (Recommended)

SuperSonic is and will always be open source! We strongly encourage users to self-host their own instance of SuperSonic. This gives you full control over your data and agents while learning about the technology.

For detailed implementation guidance, see our plugin documentation.

Requirements for Self-Hosting

  • Server or cloud instance (e.g., AWS, DigitalOcean, or your local machine)
  • API keys for required services.
  • Basic knowledge of TypeScript/Node.js for customization

Support

While self-hosting is a DIY approach, we provide:

  • Detailed documentation
  • Community support via Discord
  • GitHub issues for bug reports
  • Basic setup guidance

Service Packages

Note: The following service packages are not yet launched but will be available soon through early access. For now, we recommend self-hosting your own instance!

For detailed service descriptions and future offerings, see our services documentation.

🚀 Quick Start

Prerequisites

Note for Windows Users: WSL 2 and Visual Studio Build Tools are required.

Installation

# Clone the repository
git clone https://github.com/nicoware-dev/supersonic
cd supersonic/eliza

# Install dependencies
pnpm install --no-frozen-lockfile

# Copy environment file
cp .env.example .env

Configuration

Edit .env file and add your credentials:

# Required for Sonic operations
EVM_PRIVATE_KEY=your_private_key
EVM_PROVIDER_URL=https://sonic.drpc.org

# Choose an API provider and add the API_KEY on the env file
OPENAI_API_KEY=                # OpenAI API key, starting with sk-
ANTHROPIC_API_KEY=             # For Claude (optional)

# Client Configuration
DISCORD_APPLICATION_ID=        # Discord bot ID
DISCORD_API_TOKEN=             # Discord bot token
TELEGRAM_BOT_TOKEN=            # Telegram bot token
TWITTER_USERNAME=              # Twitter username
TWITTER_PASSWORD=              # Twitter password
TWITTER_EMAIL=                 # Twitter email

Running the Agent

# Build the project
pnpm build

# Start a single agent (Recommended for testing)
pnpm start --characters="characters/demo-agent.character.json"

# Start demo agents (5)
pnpm start --characters="characters/demo-agent.character.json,characters/metrics-agent.character.json,characters/sales-agent.character.json,characters/meme-agent.character.json,characters/sonic-expert-agent.character.json"

# Start all agents (18)
pnpm start --characters="characters/coordinator.character.json,characters/metrics-agent.character.json,characters/sales-agent.character.json,characters/meme-agent.character.json,characters/nfts-agent.character.json,characters/alpha-agent.character.json,characters/analyst-agent.character.json,characters/trading-agent.character.json,characters/wallet-agent.character.json,characters/dao-agent.character.json,characters/defi-agent.character.json,characters/demo-agent.character.json,characters/kol-agent.character.json,characters/token-deployer-agent.character.json,characters/nft-deployer-agent.character.json,characters/sonic-expert-agent.character.json,characters/predictions-agent.character.json,characters/advisor-agent.character.json"

Running the Web Client

In a new terminal, run the following command:

cd client
pnpm run dev

🧪 How to use?

For comprehensive usage examples and advanced features, see our plugin documentation.

Interact with the agents with these example prompts:

Network Information

What is Sonic?

Web Search

Search the web for latest news on Sonic Labs and its L1 Blockchain Ecosystem

TVL Metrics

Get detailed TVL metrics for Sonic and global DeFi
What are the top 5 protocols by TVL in the Sonic ecosystem?

Price Metrics (CoinGecko)

Get prices for ETH, BTC, S, Shadow, Beets and USDC

Pools Data (GeckoTerminal)

Show me TVL and Volume of the top pools on Sonic network

Tokens Provider

Show me information about wETH and stS tokens

Market Analysis Provider

Show me the top gainers and losers in the Sonic network

Wallet Operations

Show me my Sonic wallet address and S balance
Show my portfolio

Explorer Provider

Get info for wallet 0xFC6E877417D30d25AF8300460639e7c2Bc7657C6
Show me network stats
Show me the latest blocks
Show me the latest transactions

Token Transfers

Send 0.1 S to 0xFC6E877417D30d25AF8300460639e7c2Bc7657C6
Send 0.01 USDC to 0xFC6E877417D30d25AF8300460639e7c2Bc7657C6
Send 0.00001 METH to 0xFC6E877417D30d25AF8300460639e7c2Bc7657C6

Token Swaps (Beets DEX)

Swap 0.1 S for USDC
Swap 0.01 USDC for S
Swap 0.00001 WETH for USDC

Sonic Staking (Beets LST)

Stake 0.1 S with Beets
Unstake 0.1 stS from Beets
Withdraw 0.1 S from Beets

Token Lending & Borrowing (Silo Finance) (S and USDC supported)

Deposit 0.1 S to Silo Finance
Withdraw 0.1 S from Silo Finance
Borrow 0.001 USDC from Silo Finance
Repay 0.0001 USDC to Silo Finance

Add & Remove Liquidity (Beets DEX) (Work in Progress)

Add liquidity to Beets wS-stS pool with 0.1 S
Remove all liquidity from Beets wS-stS pool

Bridge Tokens (deBridge) - (WIP: Only token bridges to Arbitrum are supported for now)

Bridge 1 USDC to Arbitrum
Claim 0x711b9d0fa67c42ba8ef118e83b1bdd65bfda972dff5da71adbffacd8b1f9920a (TX HASH)

🔍 Important Notes

  • Ensure you have sufficient funds for transaction fees.
  • Always double-check addresses and amounts before executing transactions.

Project Structure

README.md                             # This file
docs/                                 # Documentation
  ├── pitch-deck.pdf                      # SuperSonic Pitch Deck
  ├── agents.md                           # Agents documentation
  ├── branding.md                         # Branding guidelines
  ├── contributing.md                     # Contribution guidelines
  ├── deployment.md                       # Deployment guide
  ├── faqs.md                            # Frequently Asked Questions
  ├── features.md                         # Features documentation
  ├── index.md                           # Documentation home
  ├── integrations.md                    # Integration guides
  ├── links.md                           # Important links
  ├── multi-agent-system.md              # MAS architecture details
  ├── n8n.md                             # n8n workflow documentation
  ├── overview.md                         # Project overview
  ├── plugin.md                          # Plugin documentation
  ├── quick-start.md                     # Quick start guide
  ├── self-hosting.md                    # Self-hosting instructions
  ├── services.md                        # Services documentation
  ├── system-overview.md                 # System architecture overview
  ├── user-guide.md                      # User guide
  ├── whitepaper.md                      # Project whitepaper
  └── resources/                         # Documentation resources
assets/                               # Branding Assets & Guidelines
eliza/                                # Eliza project
  ├── packages/
  │   ├── core/                       # Eliza core functionality
  │   ├── plugin-supersonic/              # Sonic integration
  │   │   ├── src/
  │   │   │   ├── actions/      
  │   │   │   │   ├── silo-lending/        # Lending & Borrowing Actions (Silo Finance)
  │   │   │   │   │   ├── deposit.ts
  │   │   │   │   │   ├── withdraw.ts
  │   │   │   │   │   ├── borrow.ts
  │   │   │   │   │   └── repay.ts
  │   │   │   │   ├── beets-dex/        # Beets DEX Actions
  │   │   │   │   │   ├── swapv2.ts
  │   │   │   │   │   ├── add-liquidity.ts
  │   │   │   │   │   └── remove-liquidity.ts
  │   │   │   │   ├── erc20Transfer   # ERC20 Transfer Action
  │   │   │   │   ├── transfer-eth    # S Transfer Action
  │   │   │   │   └── portfolio       # Portfolio Action
  │   │   │   ├── providers/    
  │   │   │   │   ├── coingecko       # CoinGecko Provider
  │   │   │   │   ├── defillama       # DefiLlama Provider
  │   │   │   │   └── wallet          # Sonic Wallet Provider
  │   │   │   └── ...
  │   │   ├── templates/    
  │   │   ├── types/        
  │   │   └── utils/        
  └── client/                         # Custom Web App
n8n/                       # n8n workflow configurations
  ├── coordinator-agent.json         # Main coordinator agent workflow
  ├── eliza-agent-tool.json         # Eliza agent integration
  ├── COORDINATOR_SYSTEM.md         # Coordinator system documentation
  └── other/                        # Additional workflow configurations

🤝 Contributing

  1. Fork the repository
  2. Create your feature branch
  3. Commit your changes
  4. Push to the branch
  5. Create a Pull Request

Built with ❤️ by the SuperSonic team

Discord X

About

SuperSonic is an innovative open-source project revolutionizing the Sonic DeFi landscape through AI-powered agent swarms.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published