Add makeQueryKey util for consistency in hyperdrive/core

delvtech · DannyDelott · Jul 20, 2023 · Jul 20, 2023 · Jul 20, 2023 · Jul 20, 2023
commit d8989098736dcf33873bde8a3936d5adc229dfae
diff --git a/packages/hyperdrive/src/amm/getPoolConfig.ts b/packages/hyperdrive/src/amm/getPoolConfig.ts
@@ -7,6 +7,7 @@ import {
 } from "viem";
 import { HyperdriveABI } from "src/abis/Hyperdrive";
 import { QueryObserverOptions } from "@tanstack/query-core";
+import { makeQueryKey } from "src/makeQueryKey";
 
 interface GetPoolConfigOptions {
   hyperdriveAddress: Address;
@@ -36,7 +37,7 @@ export function getPoolConfigQuery({
 
   return {
     enabled: queryEnabled,
-    queryKey: ["@hyperdrive/core", "getPoolConfig", { hyperdriveAddress }],
+    queryKey: makeQueryKey("getPoolConfig", { hyperdriveAddress }),
     queryFn: queryEnabled
       ? async () =>
           getPoolConfig({

diff --git a/packages/hyperdrive/src/amm/getPoolInfo.ts b/packages/hyperdrive/src/amm/getPoolInfo.ts
@@ -7,6 +7,7 @@ import {
 } from "viem";
 import { HyperdriveABI } from "src/abis/Hyperdrive";
 import { QueryObserverOptions } from "@tanstack/query-core";
+import { makeQueryKey } from "src/makeQueryKey";
 
 interface GetPoolInfoOptions {
   hyperdriveAddress: Address;
@@ -36,7 +37,7 @@ export function getPoolInfoQuery({
 
   return {
     enabled: queryEnabled,
-    queryKey: ["@hyperdrive/core", "getPoolInfo", { hyperdriveAddress }],
+    queryKey: makeQueryKey("getPoolInfo", { hyperdriveAddress }),
     queryFn: queryEnabled
       ? async () =>
           getPoolInfo({

diff --git a/packages/hyperdrive/src/amm/liquidity/getLiquidity.ts b/packages/hyperdrive/src/amm/liquidity/getLiquidity.ts
@@ -1,4 +1,5 @@
 import { Address, Chain, PublicClient, Transport, formatUnits } from "viem";
+import { makeQueryKey } from "src/makeQueryKey";
 
 import { QueryObserverOptions } from "@tanstack/query-core";
 import { getPoolInfo } from "src/amm/getPoolInfo";
@@ -43,7 +44,9 @@ export function getLiquidityQuery({
   publicClient,
 }: GetLiquidityQueryOptions): QueryObserverOptions<GetLiquidityReturnType> {
   return {
-    queryKey: ["liquidity", { hyperdriveAddress, publicClient }],
+    queryKey: makeQueryKey("get-liquidity", {
+      hyperdriveAddress,
+    }),
     queryFn: () => getLiquidity(hyperdriveAddress as Address, publicClient),
   };
 }
diff --git a/packages/hyperdrive/src/amm/longs/getClosedLongs.ts b/packages/hyperdrive/src/amm/longs/getClosedLongs.ts
@@ -2,6 +2,7 @@ import { QueryObserverOptions } from "@tanstack/query-core";
 import { PublicClient, Address, Transport, Chain } from "viem";
 import { ClosedLong } from "./types";
 import { getCloseLongEvents } from "src/amm/longs/getCloseLongEvents";
+import { makeQueryKey } from "src/makeQueryKey";
 
 export interface GetClosedLongsOptions {
   traderAddress: Address;
@@ -61,11 +62,7 @@ export function getCloseLongsQuery({
   const queryEnabled = !!account && !!hyperdriveAddress && !!publicClient;
   return {
     enabled: queryEnabled,
-    queryKey: [
-      "@hyperdrive/core",
-      "closed-longs",
-      { hyperdriveAddress, account },
-    ],
+    queryKey: makeQueryKey("closed-longs", { hyperdriveAddress, account }),
     queryFn: queryEnabled
       ? () =>
           getClosedLongs({

diff --git a/packages/hyperdrive/src/amm/lp/getLpShares.ts b/packages/hyperdrive/src/amm/lp/getLpShares.ts
@@ -2,6 +2,7 @@ import { PublicClient, Address, Transport, Chain } from "viem";
 import { HyperdriveABI } from "src/abis/Hyperdrive";
 import { LP_ASSET_ID } from "./constants";
 import { QueryObserverOptions } from "@tanstack/query-core";
+import { makeQueryKey } from "src/makeQueryKey";
 
 export interface GetLpSharesOptions {
   account: Address;
@@ -40,7 +41,7 @@ export function getLpSharesQuery({
   const queryEnabled = !!account && !!hyperdriveAddress && !!publicClient;
   return {
     enabled: queryEnabled,
-    queryKey: ["@hyperdrive/core", "lp-shares", { hyperdriveAddress, account }],
+    queryKey: makeQueryKey("lp-shares", { hyperdriveAddress, account }),
     queryFn: queryEnabled
       ? () => getLpShares({ account, hyperdriveAddress, publicClient })
       : undefined,

diff --git a/packages/hyperdrive/src/makeQueryKey.ts b/packages/hyperdrive/src/makeQueryKey.ts
@@ -0,0 +1,13 @@
+import { QueryKey } from "@tanstack/query-core";
+
+/**
+ * This is a factory function for generating query keys. By using this function,
+ * we enforce a consistent namespacing across our queries and prevent a
+ * potential collision with existing queries within the application.
+
+ * Recommended use: All queries should leverage this function for query key
+ * creation to maintain namespace integrity.
+ */
+export function makeQueryKey<T>(queryName: string, options: T): QueryKey {
+  return ["@hyperdrive/core", queryName, options];
+}
diff --git a/packages/hyperdrive/src/token/getDecimals.ts b/packages/hyperdrive/src/token/getDecimals.ts
@@ -1,5 +1,6 @@
 import { QueryObserverOptions } from "@tanstack/query-core";
 import { ERC20MintableABI } from "src/abis/ERC20Mintable";
+import { makeQueryKey } from "src/makeQueryKey";
 import { Address, Chain, PublicClient, Transport } from "viem";
 
 interface GetDecimalsOptions {
@@ -28,7 +29,7 @@ export function getDecimalsQuery({
 
   return {
     enabled: queryEnabled,
-    queryKey: ["@hyperdrive/core", "getDecimals", { tokenAddress }],
+    queryKey: makeQueryKey("getDecimals", { tokenAddress }),
     queryFn: queryEnabled
       ? () =>
           getDecimals({