Skip to main content

A Python toolkit for building AI agents on Solana

Project description

Solana AgentKit Documentation

Welcome to the Solana AgentKit documentation! This Python package provides tools and utilities for building AI agents that can interact with the Solana blockchain.

Quick Start

Installation

# Basic installation
pip install solana-agentkit

# With development tools
pip install solana-agentkit[dev]

# With documentation tools
pip install solana-agentkit[docs]

Basic Usage

from solana_agentkit import SolanaAgent
from solana_agentkit.tools import transfer_tokens, get_balance

# Initialize agent
agent = SolanaAgent(
    private_key="your_private_key",
    rpc_url="https://api.mainnet-beta.solana.com"
)

# Check balance
balance = await agent.get_balance()
print(f"Current balance: {balance} SOL")

# Transfer tokens
result = await agent.transfer(
    to="recipient_address",
    amount=1.0
)
print(f"Transfer successful: {result.signature}")

Features

Core Components

  • Agent Framework: Build and deploy AI agents on Solana
  • Transaction Tools: Simplified transaction creation and management
  • NFT Utilities: Create and manage NFT collections
  • Token Tools: Deploy and manage SPL tokens
  • Domain Management: Register and manage .sol domains

AI Integration

  • LangChain integration for AI capabilities
  • OpenAI integration for image generation
  • Custom agent behaviors and personalities
  • Natural language processing for commands

Blockchain Features

  • Wallet management
  • Transaction building
  • Priority fee handling
  • Multi-signature support

Development

Setup Development Environment

# Clone repository
git clone https://github.com/arhansuba/solana-agentkit
cd solana-agentkit

# Create virtual environment
python -m venv venv
source venv/bin/activate  # Unix
# or
.\venv\Scripts\activate  # Windows

# Install development dependencies
pip install -r requirements.txt

Running Tests

# Run all tests
pytest tests/

# Run with coverage
pytest --cov=solana_agentkit tests/

Code Style

We use Black for code formatting and isort for import sorting:

# Format code
black src/ tests/

# Sort imports
isort src/ tests/

Project Structure

solana-agentkit/
├── docs/               # Documentation
├── src/               # Source code
│   └── solana_agentkit/
│       ├── agent/     # Agent implementations
│       ├── tools/     # Blockchain tools
│       └── utils/     # Utility functions
├── tests/             # Test suite
└── examples/          # Usage examples

Missing Core Features:

plaintextCopysolana_agentkit/ ├── protocols/ # New module for additional DeFi protocols │ ├── jupiter/ # Jupiter DEX integration │ ├── orca/ # Orca DEX integration │ └── solend/ # Lending protocol integration ├── analytics/ # New module for on-chain analytics │ ├── price/ # Price analysis and feeds │ ├── volume/ # Volume analysis │ └── metrics/ # General protocol metrics ├── security/ # New module for security features │ ├── validation/ # Input validation │ └── verification/ # Transaction verification └── monitoring/ # New module for monitoring ├── events/ # Event monitoring └── alerts/ # Alert system

Missing Tool Categories:

plaintextCopysolana_agentkit/tools/ ├── defi/ # DeFi-specific tools │ ├── yield_farming.py │ └── liquidity_mining.py ├── governance/ # Governance tools │ ├── proposal.py │ └── vote.py ├── analytics/ # Analytics tools │ ├── market_analysis.py │ └── portfolio_tracking.py └── automation/ # Automation tools ├── strategy.py └── scheduler.py

Utility Enhancements:

plaintextCopysolana_agentkit/utils/ ├── cache/ # Caching utilities ├── rate_limiting/ # Rate limiting ├── error_handling/ # Enhanced error handling └── logging/ # Logging utilities

Testing Infrastructure:

plaintextCopytests/ ├── unit/ # Unit tests ├── integration/ # Integration tests ├── e2e/ # End-to-end tests └── fixtures/ # Test fixtures

Documentation:

plaintextCopydocs/ ├── api/ # API documentation ├── tutorials/ # Usage tutorials ├── examples/ # Example implementations └── protocols/ # Protocol documentation Key missing features:

Protocol Integrations:

Jupiter integration for optimal routing Orca integration for concentrated liquidity Solend integration for lending operations Marinade integration for liquid staking

Analytics & Monitoring:

Price feed integration Market analytics Portfolio tracking Event monitoring Alert system

Enhanced Security:

Input validation framework Transaction simulation Risk assessment Rate limiting

Advanced Tools:

Yield farming strategies Liquidity mining tools Portfolio management Governance integration Automated trading strategies

Infrastructure:

Caching system Error handling framework Logging system Rate limiting Performance monitoring

Contributing

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

Acknowledgments

  • Solana Foundation
  • LangChain team
  • All contributors# solana-agentkit

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

solana_agentkit-0.1.3.tar.gz (94.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

solana_agentkit-0.1.3-py3-none-any.whl (118.9 kB view details)

Uploaded Python 3

File details

Details for the file solana_agentkit-0.1.3.tar.gz.

File metadata

  • Download URL: solana_agentkit-0.1.3.tar.gz
  • Upload date:
  • Size: 94.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.11.0

File hashes

Hashes for solana_agentkit-0.1.3.tar.gz
Algorithm Hash digest
SHA256 d3c5ca21ff78a0503c461987aa8cbb01432b3b72673cfb7ec5fdee95cad03cbb
MD5 1120d61a922dd2ddf5d5d0749925e8f3
BLAKE2b-256 be42ed1000412c045e5f3e6530b4e20c60bc1ccee0f9dc3ee8eaf2e47bcc6e76

See more details on using hashes here.

File details

Details for the file solana_agentkit-0.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for solana_agentkit-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 2944bfdd68deef94b64e240c51218fc96a468da9902bcd950b70ef50a19e6cd2
MD5 d8f8eddddd455a5692c0fe9dcd7d2081
BLAKE2b-256 96deb08736dceb69227a9b8e08243456fdb3f9ae4d603b8dce88da95b21ece88

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page