@aptos-labs/react/src/queries/useNameFromAddress.ts

React library for Aptos applications.

// Copyright © Aptos
// SPDX-License-Identifier: Apache-2.0

import { useQuery } from "@tanstack/react-query";
import { useAptosCore } from "../AptosJSCoreProvider.js";
import {
  FetchNameFromAddressParameters,
  FetchNameFromAddressResult,
} from "@aptos-labs/js-pro";
import { UseQueryOptions } from "../types/queries.js";
import { AccountAddress, AccountAddressInput } from "@aptos-labs/ts-sdk";
import { MissingRequiredArgumentError } from "../errors/common.js";

export const getUseNameFromAddressQueryKey = (params: {
  network: string;
  address?: AccountAddressInput;
}) => [
  "name-from-address",
  params.network,
  params.address && AccountAddress.from(params.address).toString(),
];

export type UseNameFromAddressQueryParameters =
  Partial<FetchNameFromAddressParameters> &
    UseQueryOptions<FetchNameFromAddressResult>;

export function useNameFromAddress({
  network,
  address,
  ...queryOptions
}: UseNameFromAddressQueryParameters) {
  const core = useAptosCore();

  const activeNetwork = network ?? core.network;

  const enabled = Boolean(address && (queryOptions.enabled ?? true));

  return useQuery({
    queryKey: getUseNameFromAddressQueryKey({
      network: activeNetwork.network,
      address,
    }),
    queryFn: () => {
      if (!address) throw new MissingRequiredArgumentError("address");
      return core.client.fetchNameFromAddress({ network, address }) ?? null;
    },
    ...queryOptions,
    enabled,
  });
}