Merge pull request #57 from macalinao/igm/key-cleanup

Clean up various query keys

Author: macalinao

.changeset/gentle-jeans-fry.md

@@ -0,0 +1,5 @@
+---
+"@macalinao/grill": patch
+---
+
+Query key cleanup

.changeset/tangy-emus-enter.md

@@ -0,0 +1,5 @@
+---
+"@macalinao/grill": patch
+---
+
+Grill hook client key cleanup

CLAUDE.md

@@ -16,7 +16,7 @@ Grill is a modern Solana development kit monorepo that provides React components
 - **Routing**: @tanstack/react-router (in example-dapp)
 - **Styling**: Tailwind CSS v4 with shadcn/ui components
 - **Code Quality**: Biome for formatting, ESLint for linting
-- **Testing**: Vitest
+- **Testing**: Bun Test via `bun run test`
 
 ## Essential Commands
 

packages/grill/src/constants.ts

@@ -1,5 +1,5 @@
 import { useQuery } from "@tanstack/react-query";
-import { GRILL_HOOK_CLIENT_KEY } from "../constants.js";
+import { createPdaQueryKey } from "../query-keys.js";
 
 /**
  * A function that computes a PDA from some arguments.
@@ -44,7 +44,7 @@ export function createPdaHook<TArgs, TResult>(
     args: TArgs | null | undefined,
   ): TResult | null | undefined {
     const { data } = useQuery<TResult | null>({
-      queryKey: [GRILL_HOOK_CLIENT_KEY, "pda", queryKeyPrefix, args] as const,
+      queryKey: createPdaQueryKey(queryKeyPrefix, args),
       queryFn: async () => {
         if (!args) {
           return null;

packages/grill/src/hooks/create-pda-hook.ts

@@ -10,7 +10,7 @@ import type { GillUseRpcHook } from "./types.js";
 import { fetchAndDecodeAccount } from "@macalinao/gill-extra";
 import { useQuery } from "@tanstack/react-query";
 import { useGrillContext } from "../contexts/grill-context.js";
-import { createAccountQueryKey } from "../utils/account-helpers.js";
+import { createAccountQueryKey } from "../query-keys.js";
 
 type RpcConfig = Simplify<Omit<FetchAccountConfig, "abortSignal">>;
 

packages/grill/src/hooks/use-account.ts

@@ -9,7 +9,7 @@ import type { GillUseRpcHook } from "./types.js";
 import { fetchAndDecodeAccount } from "@macalinao/gill-extra";
 import { useQueries } from "@tanstack/react-query";
 import { useGrillContext } from "../contexts/grill-context.js";
-import { createAccountQueryKey } from "../utils/account-helpers.js";
+import { createAccountQueryKey } from "../query-keys.js";
 
 type RpcConfig = Simplify<Omit<FetchAccountConfig, "abortSignal">>;
 

packages/grill/src/hooks/use-accounts.ts

@@ -4,7 +4,7 @@ import type { UseQueryResult } from "@tanstack/react-query";
 import { createTokenInfo } from "@macalinao/token-utils";
 import { tokenMetadataSchema } from "@macalinao/zod-solana";
 import { useQuery } from "@tanstack/react-query";
-import { GRILL_HOOK_CLIENT_KEY } from "../constants.js";
+import { createTokenInfoQueryKey } from "../query-keys.js";
 import { useMintAccount } from "./use-mint-account.js";
 import { useTokenMetadataAccount } from "./use-token-metadata-account.js";
 
@@ -23,7 +23,7 @@ export function useTokenInfo({
 
   return useQuery<TokenInfo | null>({
     // eslint-disable-next-line @tanstack/query/exhaustive-deps
-    queryKey: [GRILL_HOOK_CLIENT_KEY, "tokenInfo", mint] as const,
+    queryKey: createTokenInfoQueryKey(mint),
     queryFn: async () => {
       if (!mint || decimals === undefined) {
         return null;

packages/grill/src/hooks/use-token-info.ts

@@ -2,5 +2,6 @@ export * from "@macalinao/gill-extra";
 export * from "./contexts/index.js";
 export * from "./hooks/index.js";
 export * from "./providers/index.js";
+export * from "./query-keys.js";
 export * from "./types.js";
 export * from "./utils/index.js";

packages/grill/src/index.ts

@@ -0,0 +1,47 @@
+import type { Address } from "@solana/kit";
+
+export const GRILL_REACT_QUERY_NAMESPACE = "solana" as const;
+
+// Type definitions for query keys
+export type AccountQueryKey = readonly ["solana", "account", Address];
+export type TokenInfoQueryKey = readonly [
+  "solana",
+  "tokenInfo",
+  Address | null | undefined,
+];
+export type PdaQueryKey<TArgs> = readonly [
+  "solana",
+  "pda",
+  string,
+  TArgs | null | undefined,
+];
+
+/**
+ * Create a query key for the account query
+ * @param address - The address of the account
+ * @returns The query key
+ */
+export const createAccountQueryKey = (address: Address): AccountQueryKey =>
+  [GRILL_REACT_QUERY_NAMESPACE, "account", address] as const;
+
+/**
+ * Create a query key for token info query
+ * @param mint - The mint address
+ * @returns The query key
+ */
+export const createTokenInfoQueryKey = (
+  mint: Address | null | undefined,
+): TokenInfoQueryKey =>
+  [GRILL_REACT_QUERY_NAMESPACE, "tokenInfo", mint] as const;
+
+/**
+ * Create a query key for PDA queries
+ * @param queryKeyPrefix - The PDA type prefix
+ * @param args - The arguments for the PDA
+ * @returns The query key
+ */
+export const createPdaQueryKey = <TArgs>(
+  queryKeyPrefix: string,
+  args: TArgs | null | undefined,
+): PdaQueryKey<TArgs> =>
+  [GRILL_REACT_QUERY_NAMESPACE, "pda", queryKeyPrefix, args] as const;