chore: readme

This commit is contained in:
aryan
2024-11-18 00:00:35 +07:00
parent 9195e2ff06
commit 8d355378e0

View File

@@ -1,6 +1,6 @@
# Solana Agent Kit # Solana Agent Kit
A powerful toolkit for interacting with the Solana blockchain, providing easy-to-use functions for token operations, NFT management, and trading. 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.
## Features ## Features
@@ -19,6 +19,10 @@ A powerful toolkit for interacting with the Solana blockchain, providing easy-to
- Token swaps with customizable slippage - Token swaps with customizable slippage
- Direct routing options - Direct routing options
- 🔗 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 ```bash
@@ -28,13 +32,16 @@ npm install solana-agent-kit
## Quick Start ## Quick Start
```typescript ```typescript
import { SolanaAgentKit } from 'solana-agent-kit'; import { SolanaAgentKit, createSolanaTools } from 'solana-agent-kit';
// Initialize with private key and optional RPC URL // Initialize with private key and optional RPC URL
const agent = new SolanaAgentKit( const agent = new SolanaAgentKit(
'your-private-key', 'your-private-key',
'https://api.mainnet-beta.solana.com' 'https://api.mainnet-beta.solana.com'
); );
// Create LangChain tools
const tools = createSolanaTools(agent);
``` ```
## Usage Examples ## Usage Examples
@@ -128,4 +135,4 @@ ISC License
## Security ## Security
This toolkit handles private keys and transactions. Always ensure you're using it in a secure environment and never share your private keys. This toolkit handles private keys and transactions. Always ensure you're using it in a secure environment and never share your private keys.