@anywalletkit/names-ens

ENS names for wallets built on Any Wallet Kit: vitalik.eth, name.base.eth, alice.cb.id → the address for one chain, verified primary names, avatars, and the warnings a user should see next to a name.

Install

npm install @anywalletkit/names-ens @anywalletkit/core
# or: pnpm add @anywalletkit/names-ens @anywalletkit/core  ·  yarn add @anywalletkit/names-ens @anywalletkit/core

On npm: @anywalletkit/names-ens, published from the release workflow with provenance.

Implements the NameResolver interface from @anywalletkit/core, so SNS (.sol), TON DNS (.ton) and NEAR accounts can sit behind the same nameResolvers([...]) later.

What it does

Normalization per ENSIP-15 (viem’s normalize, i.e. @adraffy/ens-normalize). Invalid names and illegal script mixtures are refused with the reason as the message, before any I/O.
Forward resolution through the Universal Resolver: wildcard names (ENSIP-10) and off-chain resolvers via CCIP-Read (cb.id, uni.eth, Basenames) work out of the box.
One chain per call (ENSIP-9/11). resolve(name, 'eip155:8453') reads the Base record (coin type 0x80000000 | 8453), bip122:… reads the Bitcoin script record, solana:… the Solana key. A name with no record for that chain is no-address-for-chain. It never falls back to the Ethereum address — sending vitalik’s mainnet address to Base is the bug this guards against.
Reverse / primary name, including L2 primary names (ENSIP-19) by coin type. A primary name counts only when it resolves forward to the same address.
Avatars (ENSIP-12): https / ipfs / NFT, returned as a URL. Fetch it through your own proxy; the resolver never fetches the image.
Warnings on every resolution: confusable (a label written in Cyrillic lookalikes of Latin letters), mixed-script, punycode.
Cache with a TTL (default 5 min), bounded.
Signing-time check: assertNameUnchanged(resolver, name, chain, address) re-resolves and throws changed if the address moved.

Usage

import { ensResolver } from '@anywalletkit/names-ens'
import { assertNameUnchanged, isNameLike, NameError } from '@anywalletkit/core'

const ens = ensResolver({ rpcUrl: 'https://ethereum-rpc.publicnode.com' }) // or { client } (viem PublicClient on mainnet)

if (isNameLike(input) && ens.supports(input)) {
  try {
    const r = await ens.resolve(input, 'eip155:8453')
    // r.address (checksummed), r.name (normalized), r.warnings[] to show
  } catch (e) {
    if (e instanceof NameError) console.log(e.code) // invalid-name | not-found | no-address-for-chain | unsupported | lookup-failed
  }
}

await ens.reverse('0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045', 'eip155:1') // 'vitalik.eth'
await ens.avatar('vitalik.eth') // 'https://euc.li/vitalik.eth'

// right before signing:
await assertNameUnchanged(ens, 'vitalik.eth', 'eip155:1', addressShownToUser)

Options: client / rpcUrl (mainnet; required), ccip (how gateways are asked, below), cacheTtlMs, ipfsGateway (point it at your proxy), foreignTlds (TLDs left to other resolvers; default sol, near, ton, me).

Offchain names (CCIP-Read, EIP-3668) make the device fetch gateway URLs that the name’s resolver chooses. The client built from rpcUrl asks only https gateway URLs whose host, as written, is not a private one (ensCcipRead: no http://, no localhost / LAN / link-local / CGNAT address in any spelling, redirects refused). Where the host resolves depends on the runtime: on Node (no ccip.fetch), each gateway goes through the pinned transport of createEnsCcipHandler, in process — every DNS answer checked, the connection pinned to it — so a public-looking name that resolves to 127.0.0.1 or a LAN address is not asked; a gateway host whose records mix public and private addresses is refused, and behind a corporate split-horizon DNS or an outbound proxy you pass ccip.fetch. In a browser (and any other runtime) the global fetch connects: the URL text is checked, the resolved address is not — there is no DNS-level isolation; use ensCcipViaProxy where that matters. React Native: below. If you pass your own client, create it with ccipRead: ensCcipRead (or ccipRead: false), or viem’s default fetches whatever URL a resolver names, http://192.168.1.1/… included. A gateway’s answer is read to at most ccip.maxResponseBytes (1 MiB; status and declared size are checked before any byte is read), and ccip.timeoutMs (10 s) covers each gateway’s request and whole answer.

avatar returns the avatar text record when it is an https URL on a public host, or an ipfs:// one through ipfsGateway (an origin, /ipfs/<cid> appended, or a prefix ending in /ipfs/; avatarUrl(record, gateway) is the same filter). Everything else comes back null: NFT avatars (eip155:1/erc721:…; resolving one means fetching the metadata URL its issuer chose), and http://, data:, ipns:// and ar:// ones. Nothing is fetched to decide.

React Native: CCIP-Read through your server

React Native’s fetch follows redirects whatever redirect: 'error' says, so a gateway’s redirect would send the device’s request to a LAN or loopback host before the final URL can be checked. There, offchain names are off by default: they fail with lookup-failed, reason: 'ccip-proxy-required', and the message says what to set. The safe path is one route on your server:

// server (Node): POST /ccip, behind your auth and rate limits
import { createEnsCcipHandler } from '@anywalletkit/names-ens/server'
const ccip = createEnsCcipHandler() // { allowHosts, denyHosts, timeoutMs, maxResponseBytes, maxRequestBytes }
// in the route: const out = await ccip(JSON.parse(rawBody)); reply out.status with JSON out.body

// app (Hermes): the resolver asks gateways through that route
import { ensCcipViaProxy, ensResolver } from '@anywalletkit/names-ens'
const ens = ensResolver({
  rpcUrl: ETHEREUM_RPC,
  ccip: { fetch: ensCcipViaProxy('https://api.example.com/ccip', { headers: { authorization: `Bearer ${token}` } }) },
})

createEnsCcipHandler takes { url, method, body? } (what ensCcipViaProxy sends) and returns { status, body } ({ data } or { error }). It asks only https gateways on public hosts; resolves the host and refuses it when any address is private, loopback, link-local, CGNAT, multicast or an IPv6 address carrying one (mapped, NAT64, 6to4); connects to the checked address with node:https (TLS still verifies the host name), so a second DNS answer cannot move it; never follows a redirect; applies a timeout (10 s) and an answer cap (1 MiB); sends GET, or POST with exactly { sender, data }; forwards none of the caller’s headers or cookies. It does not authenticate or rate-limit: your route does. lookup and fetch options replace DNS and the connection in tests (with fetch, the connection is not pinned). The reference server in examples/server has it at POST /ccip.

ensCcipViaProxy(proxyUrl, { headers, timeoutMs, fetch, allowInsecureProxyUrl }) needs an https proxy URL (http only for localhost with allowInsecureProxyUrl), uses no Node API and no AbortSignal.timeout, and turns the server’s refusal into the lookup’s error.

Without a server, ccip: { allowRedirectFollowingFetch: true } asks gateways directly: a redirecting gateway can then make the device send one blind request to a host on the user’s network. With your own client: ccipRead: createEnsCcipRead({ … }).

Tests

pnpm test — unit tests over a stubbed client, the CCIP-Read proxy over local servers with stubbed DNS, plus the conformance namesSuite. pnpm verify:live — mainnet via a public RPC: vitalik.eth forward / reverse / avatar, jesse.base.eth through CCIP-Read on the Base coin type, a name without a Base record, unregistered and invalid names.

@anywalletkit/names-ens

@anywalletkit/names-ens

Install

What it does

Usage

React Native: CCIP-Read through your server

Tests

Classes

Interfaces

Type Aliases

Variables

Functions