Documentation for building on The Gavel Protocol — a permissionless, oracle-free, auction-based lending protocol on Arbitrum One. If you want to integrate with the protocol, build a custom frontend or curation layer, consume its market data, or understand where it's heading, you're in the right place.
This repository is the build-on-it companion to The-Gavel-Protocol, which is the use-it repository — the canonical contracts, deployed addresses, verified source, and the direct-access guide live there. These docs assume that as the source of truth for addresses and contract source, and link to it rather than duplicating it.
- v1 build details — how the live contracts work and how to build against them: architecture, a full contract reference, integration flows, deploying your own instance, building a curation layer, and building a frontend.
- Data access — how to consume the Aletheia API and how to read the protocol's data directly on-chain.
- v2 vision — where the protocol is going: the substrate/primitive/composition architecture and what it will let you build.
These docs cover how to consume the protocol and its data API. They deliberately do not cover Aletheia's proprietary data internals (the pipeline, indicator computation, or infrastructure) — the API is documented as a product, not as an implementation.
- Architecture — the model: layers, the two stacks, access paths, the loan lifecycle, and the properties you can rely on. Start here.
- Contract Reference — function-level reference for every contract: signatures, structs, events, and errors.
- Integration Guide — worked ethers v6 flows for borrowing, lending, and trading positions, plus the operator pattern.
- Deployment Guide — deploy your own instance of the contracts, including the proxy model and wiring.
- Build Your Own Curation Layer — run an independent whitelist/router over the permissionless core.
- Frontend Guide — build a UI against the contracts and the public API.
- Aletheia API — the REST API for the yield curve, credit surface, and indicators: endpoints, access, and examples.
- On-Chain Data — read the raw data directly via RPC and events, or through the public MCP server.
- v2 Roadmap & Vision — the vault substrate, the credit and spot primitives, the committed path to native BTC, and the open composition catalogue.
- Just want to call the contracts? Architecture → Integration Guide, with the Direct Access Guide for the no-code path.
- Building a product on top? Architecture → Build Your Own Curation Layer, and the operator pattern in the Integration Guide.
- Building a frontend or analytics? Frontend Guide, Aletheia API, and On-Chain Data.
- Planning for v2? v2 Roadmap & Vision.
MIT.