Getting Started with GitMyABI
This guide walks you through connecting a smart contract GitHub repository to GitMyABI, running your first build, and consuming the published ABI JSON files and generated TypeScript bindings package.
GitMyABI is a smart contract ABI platform that automates the extraction, versioning, and CDN delivery of Application Binary Interfaces (ABIs) from your blockchain development repositories.
Instead of manually building, extracting, and hosting your contract ABIs, GitMyABI:
- Connects to your GitHub repository
- Automatically compiles your smart contracts when code changes
- Extracts and versions your ABIs
- Delivers them via a fast, global CDN
Projects
A project connects GitMyABI to a specific GitHub repository containing your smart contracts. Each project can be configured with framework-specific build settings (Hardhat or Foundry).
Builds
A build is the process of compiling your smart contracts and extracting ABIs. Builds can be triggered manually, automatically on commits, or from specific releases and tags.
ABIs
Application Binary Interfaces define how to interact with your smart contracts. GitMyABI makes these available via permanent CDN URLs that you can reference in your frontend applications.
Build References
You can generate ABIs from different sources: a specific branch (auto-updating), a release, a tag, or a specific commit hash (static).
Sign in with GitHub
Click "Sign in with GitHub" and authorize GitMyABI to access your repositories. We use GitHub OAuth for secure authentication.
Create a Project
From your dashboard, click "Create Project" and select a GitHub repository that contains smart contracts. GitMyABI supports the Hardhat and Foundry frameworks.
Configure Build Settings
Choose your build source (branch, release, tag, or commit) and configure any necessary environment variables for your build process.
Trigger Your First Build
Click "Trigger Build" to start compiling your contracts. You can monitor the build progress in real-time and view detailed logs.
Access Your ABIs
Once the build completes successfully, your ABIs are available via CDN URLs. Copy these URLs and use them directly in your frontend applications.
Need Help?
Can't find what you're looking for? Check out our FAQ or troubleshooting guides.
Related
- What GitMyABI does
Plain-language summary of the product, its inputs, and its outputs.
- Connect GitHub and create a project
Authorize the GitMyABI GitHub app and configure a project for a contract repository.
- Configure builds
Trigger builds, watch logs, and download build artifacts.
- Projects and builds
How a GitMyABI project maps to a GitHub repository and how builds produce artifacts.