Skip to content

docs: add Universal Usernames developer how-to - #21

Merged
HAPPYS1NGH merged 3 commits into
mainfrom
docs/universal-usernames-developer-guide
Nov 12, 2026
Merged

HAPPYS1NGH merged 3 commits into
mainfrom
docs/universal-usernames-developer-guide

Conversation

@HAPPYS1NGH

@HAPPYS1NGH HAPPYS1NGH commented Nov 11, 2026 •

Copy link
Copy Markdown
Collaborator

Changes

  • Add "Connect your usernames to ENS" under How to guides: how a lookup travels from wallet to resolver, gateway and the brand's adapter, then the two setup phases.
  • Step 1, build the adapter: endpoint URL rules, the request, status codes, profile JSON, an example route and curl tests.
  • Step 2, connect it in the App: save the endpoint, check real usernames, set the resolver (with records transfer and the route-switch warning).
  • Reference sections for addresses (coin types, default EVM fallback, buildAddresses), text records and contenthash, plus pros and cons and security practices.
  • Reuse the overview's FlowExplainer diagram.

Notes

  • Describes HybridResolverV2 route 4, which ships with thenamespace/ccip-gateway#28, thenamespace/offchain-manager#61 and thenamespace/webapp#96. Don't merge until route 4 is registered onchain.
  • Verified: mint validate, mint broken-links and check:content pass. addresses.ts and route.ts type-check under strict mode, and running them returns the documented JSON, 404 for unknown users and 401 for a wrong token.

🤖 Generated with Claude Code

HAPPYS1NGH and others added 3 commits November 12, 2026 04:22
Document the brand endpoint contract for HybridResolverV2 route 4: request
and response rules, profile JSON v1, coin types and address formats, text
records, contenthash schemes, caching, gateway reason codes, security and
testing. Link it from the overview and the How to guides group.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Keep the flow diagram, the endpoint response, coin types, connecting in the
app and a quick test. Drop the reference-level detail and the extra overview
card.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…d steps

Explain the lookup path from wallet to resolver, gateway and adapter, then
walk through building the adapter (URL, request, status, profile, example
route) and connecting it in the App (save, check usernames, set resolver).
Add sections on addresses, text records, contenthash, pros and cons, and
security practices. Drop the gateway reason-code tables.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@HAPPYS1NGH
HAPPYS1NGH marked this pull request as ready for review November 11, 2026 23:08
@HAPPYS1NGH
HAPPYS1NGH merged commit 5150a3f into main Nov 12, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant