onchain-agent-sdk
v1.0.1
Published
Browser-compatible SDK for onchain agent with MetaMask support
Downloads
18
Maintainers
Readme
Onchain Agent SDK
A simple SDK for interacting with blockchain using natural language queries.
Installation
npm install onchain-agent-sdk viem wagmi reactUsage
- Basic Setup
import { OnchainAgentSDK } from 'onchain-agent-sdk';
import { createConfig, WagmiProvider } from 'wagmi';
import { sepolia } from 'viem/chains';
// Initialize SDK with your configuration
const sdk = new OnchainAgentSDK({
walletClient, // From wagmi's useWalletClient
publicClient, // From wagmi's usePublicClient
openaiApiKey: 'your-openai-api-key',
moralisApiKey: 'your-moralis-api-key' // Optional
});- Using the Provided Component
import { AgentComponent } from 'onchain-agent-sdk/example';
function App() {
const { data: walletClient } = useWalletClient();
const publicClient = usePublicClient();
return (
<AgentComponent
openaiApiKey="your-openai-api-key"
moralisApiKey="your-moralis-api-key" // Optional
walletClient={walletClient}
publicClient={publicClient}
/>
);
}- Direct SDK Usage
// Process natural language queries
const result = await sdk.processQuery("What's the balance of 0x123...?");
// Use tools directly
const balance = await sdk.tools.get_balance({ wallet: "0x123..." });Features
- Natural language processing for blockchain interactions
- Wallet integration (MetaMask, etc.)
- Read operations (balances, contract data)
- Write operations (transactions, contract interactions)
- Token operations (ERC20 deployment, approvals)
- Moralis integration for additional data (optional)
Requirements
- OpenAI API Key
- Moralis API Key (optional)
- Web3 Wallet (MetaMask, etc.)
