AINad

Description

AINad is a powerful tool designed to interact with Monad network following the principles of the PostWeb by Outlier Ventures. It leverages OpenAI's GPT-4o-mini model to provide a conversational interface for users to perform various blockchain operations, such as checking wallet balances, sending transactions, and more. For example, you can do an arbitrage process using USDC with different tokens in the network.

Video demo: https://youtu.be/WJ3ctFTT0-Q

What is the problem?

Blockchain networks have brought many new opportunities to millions (if not billions) of people, but the problem lies in the interaction, since Web3 has not managed to popularize such opportunities because it is complex to use for non-technical users (managing wallets, signing transactions, many approvals before spending, among others).

AI appears as an opportunity not only to reach non-technical users, but also to reduce the time and steps for each interaction, that is, to do a lot with few instructions.

AINad was born to solve this problem

There are already many frameworks designed to connect AI agents to Blockchain, but AINad goes one step further, with the following features:

• Lightweight, with few dependencies needed.

• Focused on the Monad ecosystem (already integrated with some protocols and extensible in a few steps).

• Ability to execute several on-chain actions with a single instruction (for example: "swap 0.3 USDC to MON and then use that MON to stake it").

Mode

For now, AINad works in a CLI mode, in the future, it will be available to integrate in other platforms, such as messaging.

Features

• Conversational Interface: Engage with the assistant to perform blockchain operations through natural language.

• Wallet Operations: Check wallet balances, last transactions, retrieve connected wallet addresses, and more.

• Transaction Management: Send transactions (coins and tokens) with customizable parameters.

• Trading Management: Ask for prices and make swaps using 0x Swap API.

• Staking Management: Check your staked tokens, stake and unstake using aPriori Protocol.

• Error Handling: Robust error handling and feedback for failed operations.

Getting Started

Prerequisites

• Node.js (version 14 or higher)

• TypeScript

• OpenAI API key to enable the AI agent.

• 0x API Key to query prices and swaps.

• BlockVision API Key to query wallet transactions and balances.

Installation

1. Clone the repository:

   git clone https://github.com/techgethr/ainad.git
   cd ainad

2. Install dependencies:

3. Set up environment variables: Create a .env file in the root directory and add your OpenAI API key, wallet key file and other information for the network:

    OPENAI_API_KEY=************ enter your OpenAI key here
    WALLET_PRIVATE_KEY=**************** enter your wallet private key here (without the "0x" part, just the rest)
    ASSISTANT_NAME=******************* a name for your AI assistant
    ZeroX_API_KEY=************** enter the api key from 0x
    BLOCKVISION_API_KEY=********** enter your api key from Blockvision.org
   

Usage

To start the assistant, run:

bun run src/index.ts

You can then interact with the assistant in the command line. Type "exit" to end the conversation.

Tools

The assistant has access to various tools for performing blockchain operations:

Read Operations

• get_balance: Check wallet balance (in MON)

• get_wallet_address: Retrieve the connected wallet's address

• get_tokens_account: Get all the available tokens and balances using BlockVision

• get_price_to_swap: Get the price for a swap between 2 tokens/coins (From and To) and a specified amount (the token to swap) using 0x

• get_sources_for_swap: Get the available sources (DEXs) to swap with 0x

• get_activities_account: Get the last activities of the wallet using BlockVision

• get_staking_balance: Get the balance in staking (staked balance, in aprMON) in the aPriori Protocol

• get_staking_rate_from_mon: Fetch the rate to get the amount of aprMON if an amount in MON is staked

• get_staking_rate_from_aprmon: Fetch the rate to get the amount of MON if an amount in aprMON is unstaked

Write Operations

• send_transaction: Send transactions with customizable parameters including:

  • Transaction value in MON or any token

  • Address.

• deploy_erc20: Deploy ERC20 tokens with a name, symbol and supply.

• execute_swap: Execute/make a swap between coins/tokens using 0x

• stake_mon: Stake an amount of MON to receive aprMON using aPriori Protocol

• unstake_mon: Unstake an amount of MON using aPriori Protocol

How to extend

1. Create the actions in the src folder

2. Create a new tool file in the tools folder.

3. Add the function in the tool with unique name.

4. Register the tool in allTools

5. Update the prompt (in the prompt file inside the constants folder) for the assistant to understand when it must run the tool.