Update

Author: kien-ngo

packages/thirdweb/src/extensions/unstoppable-domains/read/resolveAddress.ts

@@ -8,13 +8,48 @@ import { getMany } from "../__generated__/UnstoppableDomains/read/getMany.js";
 import { namehash } from "../__generated__/UnstoppableDomains/read/namehash.js";
 import { UD_POLYGON_MAINNET } from "../consts.js";
 
+/**
+ * @extension UNSTOPPABLE-DOMAINS
+ */
 export type ResolveAddressOptions = {
   client: ThirdwebClient;
   name: string;
   resolverAddress?: string;
   resolverChain?: Chain;
 };
 
+/**
+ * Resolve an Unstoppable-Domain domain to an Ethereum address
+ * @param options - The options for resolving an UD domain
+ * @returns The Ethereum address associated with the domain name. [Learn more](https://docs.unstoppabledomains.com/reverse-resolution/)
+ * @example
+ *
+ * ### Basic usage
+ * ```ts
+ * import { resolveAddress } from "thirdweb/extension/unstoppable-domains";
+ *
+ * const address = await resolveAddress({
+ *   client,
+ *   name: "thirdweb.crypto",
+ * });
+ * ```
+ *
+ * ### Custom resolver
+ * By default this extension will try to resolve the name on Polygon mainnet,
+ * you can decide to customize the resolver contract by specifying `resolverAddress` and `resolverChain`
+ * ```ts
+ * import { ethereum } from "thirdweb/chains";
+ *
+ * const address = await resolveAddress({
+ *   client,
+ *   name: "thirdweb.crypto",
+ *   resolverAddress: "0x...",
+ *   resolverChain: ethereum,
+ * });
+ * ```
+ *
+ * @extension UNSTOPPABLE-DOMAINS
+ */
 export async function resolveAddress(
   options: ResolveAddressOptions,
 ): Promise<string> {

packages/thirdweb/src/extensions/unstoppable-domains/read/resolveName.ts

@@ -6,13 +6,46 @@ import { withCache } from "../../../utils/promise/withCache.js";
 import { reverseNameOf } from "../__generated__/UnstoppableDomains/read/reverseNameOf.js";
 import { UD_POLYGON_MAINNET } from "../consts.js";
 
+/**
+ * @extension UNSTOPPABLE-DOMAINS
+ */
 export type ResolveUDNameOptions = {
   client: ThirdwebClient;
   address: string;
   resolverAddress?: string;
   resolverChain?: Chain;
 };
 
+/**
+ * Resolves the primary Untoppable-Domains name for a specified address.
+ * @param options - The options for resolving an UD domain
+ * @example
+ *
+ * ### Basic usage
+ * ```ts
+ * import { resolveName } from "thirdweb/extension/unstoppable-domains";
+ *
+ * const name = await resolveName({
+ *   client,
+ *   address: "0x...",
+ * });
+ * ```
+ *
+ * ### Custom resolver
+ * By default this extension will try to resolve the address on Polygon mainnet,
+ * you can decide to customize the resolver contract by specifying `resolverAddress` and `resolverChain`
+ * ```ts
+ * import { ethereum } from "thirdweb/chains";
+ *
+ * const address = await resolveName({
+ *   client,
+ *   address: "0x...",
+ *   resolverAddress: "0x...",
+ *   resolverChain: ethereum,
+ * });
+ * ```
+ * @extension UNSTOPPABLE-DOMAINS
+ */
 export async function resolveName(
   options: ResolveUDNameOptions,
 ): Promise<string> {