Developer documentation, SDK code, API references, and examples for integrating Arc Name Service (ANS) into third-party apps.
This repository is intentionally separate from the main ANS product repository. The main ANS repo owns the web app, contracts, Supabase schema, registration flows, marketplace, and production app code. ANS Dev owns the materials external developers need to integrate ANS.
- Integration guides and quickstarts
- Public API reference
- OpenAPI specs
- SDK package source such as
@ans/core - Copy-paste examples for Node, browsers, and app backends
- Release notes for developer-facing packages
- Main ANS web app source
- Production Supabase internals
- Contract deployment scripts and private operational tooling
- Secrets,
.env.local, private keys, service role keys, or app-only config
npm install
npm run build
npm run example:resolve -- fredy.arcIf fredy.arc is not registered or has no payout address, use a registered .arc name with a configured payout record.
| Path | Purpose |
|---|---|
docs/ |
Developer docs and integration guides |
openapi/ |
Public API specifications |
packages/ans-core/ |
TypeScript SDK utilities for ANS integrations |
examples/node-resolve/ |
Minimal Node resolver example |
- HTTP API:
GET /api/resolve?name=fredy.arc - API v1 aliases:
GET /api/v1/resolve/fredy.arc - SDK:
ANSClientfrom@ans/core - Direct contract reads using the Arc Testnet resolver address
Start with docs/quickstart.md, then read docs/integration-guide.md.
Before pushing to this repository, check docs/repository-purpose.md. In short: push developer-facing docs, SDKs, examples, and specs here; push main app/product code to the ANS app repository.