Merge pull request #48 from macalinao/igm/ata-stuff

Supply addresses in useAccount and derivatives

Author: macalinao

.changeset/tidy-apples-stare.md

@@ -0,0 +1,5 @@
+---
+"@macalinao/grill": patch
+---
+
+Add addresses to useAccount

packages/grill/src/hooks/create-decoded-account-hook.ts

@@ -7,7 +7,9 @@ import { useAccount } from "./use-account.js";
  */
 export type UseDecodedAccountHook<TData extends object> = (args: {
   address: Address | null | undefined;
-}) => UseQueryResult<Account<TData> | null>;
+}) => UseQueryResult<Account<TData> | null> & {
+  address: Address | null | undefined;
+};
 
 /**
  * Generic helper to create a hook for fetching and decoding accounts
@@ -21,7 +23,9 @@ export function createDecodedAccountHook<TData extends object>(
     address,
   }: {
     address: Address | null | undefined;
-  }): UseQueryResult<Account<TData> | null> {
+  }): UseQueryResult<Account<TData> | null> & {
+    address: Address | null | undefined;
+  } {
     return useAccount({
       address,
       decoder,

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

@@ -45,16 +45,21 @@ export function useAccount<
 }: UseAccountInput<
   TConfig,
   TDecodedData
->): UseQueryResult<Account<TDecodedData> | null> {
+>): UseQueryResult<Account<TDecodedData> | null> & {
+  address: Address | null | undefined;
+} {
   const { accountLoader } = useGrillContext();
   // TODO(igm): improve the types here and somehow ensure the decoder is the same
   // for each query of an account
-  return useQuery({
-    networkMode: "offlineFirst",
-    ...options,
-    // eslint-disable-next-line @tanstack/query/exhaustive-deps
-    queryKey: address ? createAccountQueryKey(address) : [null],
-    queryFn: () => fetchAndDecodeAccount(address, accountLoader, decoder),
-    enabled: !!address,
-  }) as UseQueryResult<Account<TDecodedData> | null>;
+  return {
+    ...(useQuery({
+      networkMode: "offlineFirst",
+      ...options,
+      // eslint-disable-next-line @tanstack/query/exhaustive-deps
+      queryKey: address ? createAccountQueryKey(address) : [null],
+      queryFn: () => fetchAndDecodeAccount(address, accountLoader, decoder),
+      enabled: !!address,
+    }) as UseQueryResult<Account<TDecodedData> | null>),
+    address,
+  };
 }

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

@@ -35,10 +35,12 @@ export type UseAccountsResult<TDecodedData extends object> =
   | {
       isLoading: true;
       data: (Account<TDecodedData> | null | undefined)[];
+      addresses: (Address | null | undefined)[];
     }
   | {
       isLoading: false;
       data: (Account<TDecodedData> | null)[];
+      addresses: (Address | null | undefined)[];
     };
 
 /**
@@ -87,13 +89,15 @@ export function useAccounts<
         return {
           isLoading: true,
           data: results.map((result) => result.data),
+          addresses,
         };
       }
       return {
         isLoading: false,
         data: results
           .map((result) => result.data)
           .filter((r) => r !== undefined),
+        addresses,
       };
     },
   });

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

@@ -57,7 +57,9 @@ export interface UseAssociatedTokenAccountResult {
  */
 export function useAssociatedTokenAccount(
   options: UseAssociatedTokenAccountOptions,
-): UseQueryResult<Account<Token> | null> {
+): UseQueryResult<Account<Token> | null> & {
+  address: Address | null | undefined;
+} {
   const { mint, owner, tokenProgram = TOKEN_PROGRAM_ADDRESS } = options;
 
   // Compute the ATA address
@@ -72,7 +74,12 @@ export function useAssociatedTokenAccount(
   );
 
   // Fetch the token account data
-  return useTokenAccount({
+  const accountResult = useTokenAccount({
     address: ataAddress,
   });
+
+  return {
+    ...accountResult,
+    address: ataAddress,
+  };
 }

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

@@ -25,6 +25,7 @@ export function useTokenMetadataAccount({
   mint: Address | null | undefined;
 }): UseQueryResult<Account<Metadata> | null> & {
   pda: Address | null | undefined;
+  address: Address | null | undefined;
 } {
   const pda = useMetadataPda(mint ? { mint } : null);
 
@@ -36,5 +37,6 @@ export function useTokenMetadataAccount({
   return {
     ...accountResult,
     pda,
+    address: pda,
   };
 }