Skip to content

Latest commit

 

History

History
164 lines (124 loc) · 3.51 KB

README.md

File metadata and controls

164 lines (124 loc) · 3.51 KB

🤖 AI-Powered Blockchain Assistant for Base Network

📝 Overview

An intelligent CLI assistant that combines OpenAI's GPT capabilities with blockchain functionality, enabling users to interact with the Base network through natural language commands. Deploy tokens, mint NFTs, check balances, and perform transactions - all through simple English prompts.

✨ Features

🏦 Wallet Operations

  • Check wallet balances
  • View transaction history
  • Get wallet address
"What's my wallet balance?"
"Show me my wallet address"

💎 Token Operations (ERC20)

  • Deploy new ERC20 tokens
  • Mint tokens
  • Transfer tokens
"Deploy an ERC20 token named 'MyToken' with symbol 'MTK'"
"Create a new token with name 'Cointopper' and symbol 'CTP'"

🎨 NFT Operations (ERC721)

  • Deploy NFT collections
  • Mint new NFTs
  • Transfer NFTs
"Create an NFT collection called 'BaseApes'"
"Mint a new NFT to my wallet"

💸 Transaction Operations

  • Send ETH
  • Monitor gas fees
  • Track transaction status
"Send 0.1 ETH to 0x123..."
"Check gas fees for Base network"

🚀 Getting Started

Prerequisites

  • Node.js v18 or higher
  • npm
  • Base Sepolia testnet ETH (for testing)
  • OpenAI API key

🛠️ Installation

  1. Clone the Repository
git clone https://github.com/jaydippatel83/openai-assistant.git
cd openai-assistant
  1. Install Dependencies
npm install
  1. Configure Environment Create a .env file in the root directory:
OPENAI_API_KEY=your_openai_api_key
PRIVATE_KEY=your_wallet_private_key
RPC_URL=your_base_sepolia_rpc_url
  1. Start the Application
npm start

Example Interactions

Welcome to the Base Network Assistant!

> Deploy an ERC20 token named "GameCoin" with symbol "GC"
🔄 Processing...
✅ Token deployed successfully!
Contract Address: 0x123...
Transaction Hash: 0x456...

> Check my wallet balance
🔄 Processing...
💰 Your wallet balance:
ETH: 1.5 ETH
GameCoin (GC): 1,000,000 tokens

🔒 Security Best Practices

Wallet Security

  • Never share your private key
  • Use environment variables for sensitive data
  • Keep your seed phrase secure

Transaction Safety

  • Always verify addresses
  • Double-check transaction amounts
  • Review gas fees before confirming

Smart Contract Security

  • Contracts are verified on deployment
  • Standard security patterns implemented
  • Automatic gas estimation

🛠️ Development

Project Structure

openai-assistant/
├── src/
│   ├── index.ts                 # Entry point
│   ├── openai/                  # OpenAI integration
│   ├── tools/                   # Blockchain tools
│   ├── viem/                    # Web3 clients
│   └── utils/                   # Utilities
├── package.json
└── tsconfig.json

Common Issues

  1. OpenAI API Errors

    • Verify API key
    • Check usage limits
    • Ensure proper network connection

  2. Transaction Failures

    • Confirm sufficient gas
    • Verify wallet balance
    • Check network status

  3. Network Issues

    • Verify RPC URL
    • Check Base network status
    • Confirm wallet connection

📚 Additional Resources

🆘 Support

Made with ❤️ by [Jaydip Patel]