@saberhq/sail/src/hooks/usePubkey.ts

Account caching and batched loading for React-based Solana applications.

import { PublicKey } from "@solana/web3.js";
import { useMemo } from "react";

import { serializeKeys } from "../utils";

/**
 * Parses a Pubkey.
 * @param raw The string or Pubkey representation of the key.
 * @returns
 */
export const usePubkey = (
  raw: PublicKey | string | null | undefined
): PublicKey | null | undefined => {
  return useMemo(() => {
    if (raw === undefined) {
      return raw;
    }
    if (!raw) {
      return null;
    }
    if (raw instanceof PublicKey) {
      return raw;
    }
    try {
      return new PublicKey(raw);
    } catch (e) {
      return null;
    }
  }, [raw]);
};

/**
 * Uses a {@link PublicKey}, ensuring the reference does not change if the key changes.
 * @param raw The string or Pubkey representation of the key.
 * @returns
 */
export const usePubkeyMemo = (
  raw: PublicKey | string | null | undefined
): PublicKey | null | undefined => {
  const keyNoMemo = usePubkey(raw);
  return useMemo(() => {
    return keyNoMemo;
    // eslint-disable-next-line react-hooks/exhaustive-deps
  }, [keyNoMemo?.toString()]);
};

/**
 * Loads and parses multiple {@link PublicKey}s, preserving the reference.
 */
export const usePubkeysMemo = (
  keys: (PublicKey | string | null | undefined)[]
): (PublicKey | null | undefined)[] => {
  return useMemo(() => {
    return keys.map((k) => {
      if (typeof k === "string") {
        try {
          return new PublicKey(k);
        } catch (e) {
          return null;
        }
      } else {
        return k;
      }
    });
    // eslint-disable-next-line react-hooks/exhaustive-deps
  }, [JSON.stringify(serializeKeys(keys))]);
};