diff --git a/.changeset/chatty-oranges-rest.md b/.changeset/chatty-oranges-rest.md new file mode 100644 index 0000000000..8f287f9657 --- /dev/null +++ b/.changeset/chatty-oranges-rest.md @@ -0,0 +1,5 @@ +--- +"viem": patch +--- + +Exported ENS-related utility functions `packetToBytes` and `parseAvatarRecord`.` diff --git a/src/ens/index.ts b/src/ens/index.ts index 8ace941220..1ea56f3606 100644 --- a/src/ens/index.ts +++ b/src/ens/index.ts @@ -31,3 +31,11 @@ export { } from '../actions/ens/getEnsText.js' export { type LabelhashErrorType, labelhash } from '../utils/ens/labelhash.js' export { type NamehashErrorType, namehash } from '../utils/ens/namehash.js' +export { + parseAvatarRecord, + type ParseAvatarRecordErrorType, +} from '../utils/ens/avatar/parseAvatarRecord.js' +export { + packetToBytes, + type PacketToBytesErrorType, +} from '../utils/ens/packetToBytes.js' diff --git a/src/utils/ens/avatar/parseAvatarRecord.ts b/src/utils/ens/avatar/parseAvatarRecord.ts index 888b1ee990..be88ec7f30 100644 --- a/src/utils/ens/avatar/parseAvatarRecord.ts +++ b/src/utils/ens/avatar/parseAvatarRecord.ts @@ -24,6 +24,16 @@ export type ParseAvatarRecordErrorType = | ParseAvatarUriErrorType | ErrorType +/* + * @description Parses an ENS avatar record. + * + * @example + * parseAvatarRecord('eip155:1/erc1155:0xb32979486938aa9694bfc898f35dbed459f44424/10063') + * 'https://ipfs.io/ipfs/QmSP4nq9fnN9dAiCj42ug9Wa79rqmQerZXZch82VqpiH7U/image.gif' + * + * @see https://docs.ens.domains/web/avatars + * + */ export async function parseAvatarRecord( client: Client, { diff --git a/src/utils/ens/packetToBytes.ts b/src/utils/ens/packetToBytes.ts index d7b37d199a..4969394a1d 100644 --- a/src/utils/ens/packetToBytes.ts +++ b/src/utils/ens/packetToBytes.ts @@ -19,6 +19,13 @@ export type PacketToBytesErrorType = /* * @description Encodes a DNS packet into a ByteArray containing a UDP payload. + * + * @example + * packetToBytes('awkweb.eth') + * '0x0661776b7765620365746800' + * + * @see https://docs.ens.domains/resolution/names#dns + * */ export function packetToBytes(packet: string): ByteArray { // strip leading and trailing `.`