From 60cc0a07b11a117d821f257e637b64c031769e84 Mon Sep 17 00:00:00 2001 From: aryan Date: Sat, 21 Dec 2024 00:01:21 +0530 Subject: [PATCH] feat: readme --- README.md | 61 +++++++++++++++++++++++++++++++--------------------- package.json | 4 ++-- 2 files changed, 38 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 2013b60..675b162 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,48 @@ # Solana Agent Kit -A powerful toolkit for interacting with the Solana blockchain, providing easy-to-use functions for token operations, NFT management, and trading. Now integrated with LangChain for enhanced functionality. +A powerful toolkit for connecting AI agents to Solana protocols, enabling autonomous blockchain interactions through LangChain integration. Built for developers and AI researchers looking to empower their agents with on-chain capabilities. -## Features +## 🤖 AI Integration Features -- 🪙 Token Operations +- **LangChain Integration** + - Ready-to-use LangChain tools for blockchain operations + - Autonomous agent support with React framework + - Memory management for persistent interactions + - Streaming responses for real-time feedback - - Deploy new SPL tokens - - Transfer SOL and SPL tokens - - Check token balances +- **Autonomous Modes** + - Interactive chat mode for guided operations + - Autonomous mode for independent agent actions + - Configurable action intervals + - Built-in error handling and recovery + +- **AI Tools** + - DALL-E integration for NFT artwork generation + - Natural language processing for blockchain commands + - Price feed integration for market analysis + - Automated decision-making capabilities + +## 🔧 Core Blockchain Features + +- **Token Operations** + - Deploy SPL tokens + - Transfer assets + - Balance checks - Stake SOL -- 🖼️ NFT Management +- **NFT Management** + - Collection deployment + - NFT minting + - Metadata management + - Royalty configuration - - Deploy NFT collections - - Mint NFTs to collections - - Manage metadata and royalties +- **DeFi Integration** + - Jupiter Exchange swaps + - Raydium pool creation (CPMM, CLMM, AMMv4) + - Orca whirlpool integration + - Openbook market creation -- 💱 Trading - - - Integrated Jupiter Exchange support - - Token swaps with customizable slippage - - Direct routing options - -- 🏦 Yield Farming - - - Lend idle assets to earn interest with Lulo - -- 🔗 LangChain Integration - - Utilize LangChain tools for enhanced blockchain interactions - - Access a suite of tools for balance checks, transfers, token deployments, and more - -## Installation +## 📦 Installation ```bash npm install solana-agent-kit diff --git a/package.json b/package.json index 32d0411..53165fb 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "solana-agent-kit", - "version": "1.1.1", - "description": "A toolkit for interacting with the Solana blockchain using LangChain", + "version": "1.2.0", + "description": "connect any ai agents to solana protocols", "main": "dist/index.js", "types": "dist/index.d.ts", "scripts": {