zkApps Umstad AI Assistant, your expert guide in the world of MINA Protocol, o1js. This agent provides in-depth assistance with zkApps o1js which is specifically designed to assist developers working on zkApps development powered by the GPT language model. This project includes two main application:
- Web Application Chatbot: zkappsumstad.com
- CLI Agent: zkappumstad
The Umstad AI Assistant offers a comprehensive range of features designed to support developers in various aspects of the MINA Protocol and o1js:
-
Documentation & General Knowledge:
- Access to extensive resources including the Mina Protocol documentation, o1js guides, and Auro Wallet information.
- Integration with Mina Book and Mina Blog for up-to-date knowledge and insights.
- Availability of various project documentations to enhance understanding and application.
-
Example Codebase:
- Embedded code examples within the documentation for practical reference.
-
Projects Repositories:
- Embedded codebase of zkApps projects.
-
Community Interaction and Issue Tracking:
- Embedded and processed integration with the Mina Protocol Discord channels, specifically zkapps-developers and zkapps-questions, for community support and engagement.
- Direct access to o1js GitHub Issues, providing insights into current challenges, bugs, and solutions within the community.
-
Mainnet Blockchain Information Access:
- Direct access to Blockchain Summary, Block and Account Information utilizing Mina Explorer API.
- Current MINA Price utilizing Coingecko API(TODO: Fix Fetching issue for deployment)
-
Be Specific: Clearly state your issue or the topic you need assistance with.
-
Querying issues, errors, problems: Begin with "I have an issue ..." or "I have a problem ..." for asking about errors, issues, problems, discussion, strange questions etc in order to utilize Issue Tool which queries the Issue Vectors which includes Discord and Github data.
-
Do not extend the conversation: Even though
gpt-4-1106-previewcan handle overlong contexts, it is strongly advised that not to extend the conversation too much(For now, ideal 3 questions). Just create new chat after 2-3 questions because every query creates crowded context.
- Language and Frameworks: Built using Next.js functions, OpenAI node.js ensuring robust and scalable performance.
- Database: Uses vercel KV db.
- APIs: Uses Vercel Functions.
- Data Privacy: We store your conversations in the KV db. Do not share confidentials, private keys etc. We are not responsible for Vercel's security.
- OPENAI API KEY: Application stores your OpenAI API KEY on the browser local storage. So, if you are using shared computer, please remove your key in the settings panel.
Introducing the zkApps Umstad AI Agent, your specialized assistant in the realm of the MINA Protocol and o1js. This agent, powered by the advanced GPT language model, is tailored to support developers in creating, debugging and testing zkApps smart contracts. It offers comprehensive guidance and expertise specifically for those working on zkApps development within the MINA ecosystem.
- Python 10 or above
- Installed
zkapp-cli
pip install zkappumstadIt is suggested that before using the tool create a folder and use it inside the folder.
mkdir new_folder
cd new_folderAfter activating conda and py10 or environment that you use. Set API Key like this:
export OPENAI_API_KEY=XXXXXXXXYou must first activate a Billing Account here: https://platform.openai.com/account/billing/overview Then get your OpenAI API Key here: https://platform.openai.com/account/api-keys And need to get access GPT-4 Models
Create zk project and wait 10-15 seconds:
zkumstad-createGo into the zkapps project folder and you can optionally open the project in editor:
cd initial_project
code .Then, you can run and use the tool:
zkumstad-start