@whisk/steakhouse 0.0.4 → 0.0.6

package/src/queries/getVaults.ts

@@ -1,28 +1,77 @@
-import { graphql, type ResultOf } from "@whisk/graphql"
-import type { VariablesOf } from "gql.tada"
+import { graphql } from "@whisk/graphql"
 import type { SteakhouseClient } from "../client.js"
-import { vaultFragment } from "./fragments/vault.js"
+import { STEAKHOUSE_VAULTS } from "../metadata/generated/vaults.js"
+import type { Address, VaultConfig } from "../metadata/types.js"
+import { type VaultDetail, vaultDetailFragment } from "./fragments/vaultDetail.js"
+import { buildSteakhouseMetadata, type SteakhouseMetadata } from "./steakhouseMetadata.js"
 
-export const vaultQuery = graphql(
+/** GraphQL query for fetching Steakhouse vaults */
+export const vaultsQuery = graphql(
   `
-    query GetVaults($limit: Int!) {
-      morphoVaults(limit: $limit) {
+    query GetVaults($where: Erc4626VaultFilter, $limit: Int) {
+      erc4626Vaults(where: $where, limit: $limit) {
         items {
-          ...VaultFragment
+          ...VaultDetailFragment
         }
       }
     }
   `,
-  [vaultFragment],
+  [vaultDetailFragment],
 )
 
-export type GetVaultsVariables = VariablesOf<typeof vaultQuery>
-export type GetVaultsResult = ResultOf<typeof vaultQuery>["morphoVaults"]["items"]
+export type GetVaultsVariables = {
+  /** Filter by chain ID */
+  chainId?: number
+}
+
+/** Vault with Steakhouse metadata */
+export type VaultWithMetadata = VaultDetail & {
+  steakhouseMetadata?: SteakhouseMetadata
+}
 
+export type GetVaultsResult = VaultWithMetadata[]
+
+/**
+ * Get all Steakhouse-curated vaults.
+ * Results are filtered to the SDK whitelist and augmented with Steakhouse metadata.
+ */
 export async function getVaults(
   client: SteakhouseClient,
-  variables: GetVaultsVariables,
+  variables: GetVaultsVariables = {},
 ): Promise<GetVaultsResult> {
-  const result = await client.query(vaultQuery, variables)
-  return result.morphoVaults.items
+  const { chainId } = variables
+
+  const filteredVaults = chainId
+    ? STEAKHOUSE_VAULTS.filter((v) => v.chainId === chainId)
+    : STEAKHOUSE_VAULTS
+
+  if (filteredVaults.length === 0) {
+    return []
+  }
+
+  // Build keys array for erc4626Vaults filter
+  const keys = filteredVaults.map((v) => ({
+    chainId: v.chainId,
+    vaultAddress: v.address,
+    protocol: v.protocol,
+  }))
+
+  const result = await client.query(vaultsQuery, {
+    where: { keys },
+    limit: keys.length,
+  })
+
+  const metadataMap = new Map<Address, VaultConfig>(
+    filteredVaults.map((v) => [v.address.toLowerCase() as Address, v]),
+  )
+
+  return result.erc4626Vaults.items
+    .filter((vault): vault is NonNullable<typeof vault> => vault !== null)
+    .map((vault) => {
+      const config = metadataMap.get(vault.vaultAddress.toLowerCase() as Address)
+      if (config) {
+        return { ...vault, steakhouseMetadata: buildSteakhouseMetadata(config) }
+      }
+      return vault
+    })
 }

package/src/queries/index.ts

@@ -1,8 +1,10 @@
-export { type Vault, vaultFragment } from "./fragments/vault.js"
-export {
-  type GetVaultsResult,
-  type GetVaultsVariables,
-  getVaults,
-  vaultQuery,
-} from "./getVaults.js"
+// Fragments
+export { type VaultDetail, vaultDetailFragment } from "./fragments/vaultDetail.js"
+// Queries
+export * from "./getDetailedVault.js"
+export * from "./getVaults.js"
+// Shared
+export { buildSteakhouseMetadata, type SteakhouseMetadata } from "./steakhouseMetadata.js"
+
+// Types
 export type { SteakhouseQueryFn } from "./types.js"

package/src/queries/steakhouseMetadata.ts

@@ -0,0 +1,19 @@
+import type { VaultConfig } from "../metadata/types.js"
+
+/** Steakhouse-specific metadata augmented onto vault data */
+export type SteakhouseMetadata = {
+  name?: string
+  description?: string
+  type?: VaultConfig["type"]
+  protocol: VaultConfig["protocol"]
+}
+
+/** Build metadata object from vault config */
+export function buildSteakhouseMetadata(config: VaultConfig): SteakhouseMetadata {
+  return {
+    protocol: config.protocol,
+    ...(config.name !== undefined && { name: config.name }),
+    ...(config.description !== undefined && { description: config.description }),
+    ...(config.type !== undefined && { type: config.type }),
+  }
+}

package/src/react/hooks/index.ts

@@ -1,2 +1,3 @@
+export { useDetailedVault } from "./useDetailedVault.js"
 export { useSteakhouseQuery } from "./useSteakhouseQuery.js"
 export { useVaults } from "./useVaults.js"

package/src/react/hooks/useDetailedVault.ts

@@ -0,0 +1,19 @@
+"use client"
+
+import type { UseQueryResult } from "@tanstack/react-query"
+import {
+  type GetDetailedVaultResult,
+  type GetDetailedVaultVariables,
+  getDetailedVault,
+} from "../../queries/getDetailedVault.js"
+import { useSteakhouseQuery } from "./useSteakhouseQuery.js"
+
+export function useDetailedVault(
+  variables: GetDetailedVaultVariables,
+): UseQueryResult<GetDetailedVaultResult, Error> {
+  return useSteakhouseQuery({
+    queryName: "detailedVault",
+    queryFn: getDetailedVault,
+    variables,
+  })
+}

package/src/react/hooks/useSteakhouseQuery.ts

@@ -1,6 +1,6 @@
 "use client"
 
-import { useQuery } from "@tanstack/react-query"
+import { type UseQueryResult, useQuery } from "@tanstack/react-query"
 import type { SteakhouseQueryFn } from "../../queries/types.js"
 import { useSteakhouse } from "../provider.js"
 
@@ -8,10 +8,10 @@ export function useSteakhouseQuery<TData, TVariables>(options: {
   queryName: string
   queryFn: SteakhouseQueryFn<TData, TVariables>
   variables: TVariables
-}) {
+}): UseQueryResult<TData, Error> {
   const { client } = useSteakhouse()
   return useQuery({
-    queryKey: [options.queryName, options.variables],
+    queryKey: ["steakhouse", options.queryName, options.variables],
     queryFn: () => options.queryFn(client, options.variables),
   })
 }

package/src/react/hooks/useVaults.ts

@@ -1,9 +1,14 @@
 "use client"
 
-import { type GetVaultsVariables, getVaults } from "../../queries/getVaults.js"
+import type { UseQueryResult } from "@tanstack/react-query"
+import {
+  type GetVaultsResult,
+  type GetVaultsVariables,
+  getVaults,
+} from "../../queries/getVaults.js"
 import { useSteakhouseQuery } from "./useSteakhouseQuery.js"
 
-export function useVaults(variables: GetVaultsVariables) {
+export function useVaults(variables: GetVaultsVariables): UseQueryResult<GetVaultsResult, Error> {
   return useSteakhouseQuery({
     queryName: "vaults",
     queryFn: getVaults,

package/src/react/index.ts

@@ -1,7 +1,2 @@
 export * from "./hooks/index.js"
-export {
-  type SteakhouseContextValue,
-  SteakhouseProvider,
-  type SteakhouseProviderProps,
-  useSteakhouse,
-} from "./provider.js"
+export * from "./provider.js"

package/dist/metadata/chains.d.ts

@@ -1,7 +0,0 @@
-import { ChainConfig } from './types.js';
-
-declare const MAINNET: ChainConfig;
-declare const BASE: ChainConfig;
-declare const SUPPORTED_CHAINS: readonly [ChainConfig, ChainConfig];
-
-export { BASE, MAINNET, SUPPORTED_CHAINS };

package/dist/metadata/chains.js

@@ -1,15 +0,0 @@
-const MAINNET = {
-  id: 1,
-  name: "Ethereum Mainnet"
-};
-const BASE = {
-  id: 8453,
-  name: "Base"
-};
-const SUPPORTED_CHAINS = [MAINNET, BASE];
-export {
-  BASE,
-  MAINNET,
-  SUPPORTED_CHAINS
-};
-//# sourceMappingURL=chains.js.map

package/dist/metadata/chains.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/metadata/chains.ts"],"sourcesContent":["import type { ChainConfig } from \"./types.js\"\n\nexport const MAINNET: ChainConfig = {\n  id: 1,\n  name: \"Ethereum Mainnet\",\n}\n\nexport const BASE: ChainConfig = {\n  id: 8453,\n  name: \"Base\",\n}\n\nexport const SUPPORTED_CHAINS = [MAINNET, BASE] as const\n"],"mappings":"AAEO,MAAM,UAAuB;AAAA,EAClC,IAAI;AAAA,EACJ,MAAM;AACR;AAEO,MAAM,OAAoB;AAAA,EAC/B,IAAI;AAAA,EACJ,MAAM;AACR;AAEO,MAAM,mBAAmB,CAAC,SAAS,IAAI;","names":[]}

package/dist/metadata/vaults.d.ts

@@ -1,7 +0,0 @@
-import { VaultConfig } from './types.js';
-
-declare const MAINNET_VAULTS: readonly VaultConfig[];
-declare const BASE_VAULTS: readonly VaultConfig[];
-declare const ALL_VAULTS: readonly VaultConfig[];
-
-export { ALL_VAULTS, BASE_VAULTS, MAINNET_VAULTS };

package/dist/metadata/vaults.js

@@ -1,24 +0,0 @@
-const MAINNET_VAULTS = [
-  // Example placeholder vault
-  // {
-  //   address: "0x...",
-  //   protocol: "steakhouse",
-  //   name: "Steakhouse USDC Vault",
-  //   tag: "featured",
-  // },
-];
-const BASE_VAULTS = [
-  // Example placeholder vault
-  // {
-  //   address: "0x...",
-  //   protocol: "steakhouse",
-  //   name: "Steakhouse USDC Vault",
-  // },
-];
-const ALL_VAULTS = [...MAINNET_VAULTS, ...BASE_VAULTS];
-export {
-  ALL_VAULTS,
-  BASE_VAULTS,
-  MAINNET_VAULTS
-};
-//# sourceMappingURL=vaults.js.map

package/dist/metadata/vaults.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/metadata/vaults.ts"],"sourcesContent":["import type { VaultConfig } from \"./types.js\"\n\n// Mainnet vault configurations\n// TODO: Add real Steakhouse vault addresses\nexport const MAINNET_VAULTS: readonly VaultConfig[] = [\n  // Example placeholder vault\n  // {\n  //   address: \"0x...\",\n  //   protocol: \"steakhouse\",\n  //   name: \"Steakhouse USDC Vault\",\n  //   tag: \"featured\",\n  // },\n] as const\n\n// Base vault configurations\n// TODO: Add real Steakhouse vault addresses\nexport const BASE_VAULTS: readonly VaultConfig[] = [\n  // Example placeholder vault\n  // {\n  //   address: \"0x...\",\n  //   protocol: \"steakhouse\",\n  //   name: \"Steakhouse USDC Vault\",\n  // },\n] as const\n\n// All vaults across all chains\nexport const ALL_VAULTS = [...MAINNET_VAULTS, ...BASE_VAULTS] as const\n"],"mappings":"AAIO,MAAM,iBAAyC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAQtD;AAIO,MAAM,cAAsC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAOnD;AAGO,MAAM,aAAa,CAAC,GAAG,gBAAgB,GAAG,WAAW;","names":[]}

package/dist/queries/fragments/vault.d.ts

@@ -1,19 +0,0 @@
-import * as gql_tada from 'gql.tada';
-import { FragmentOf } from '@whisk/graphql';
-
-declare const vaultFragment: gql_tada.TadaDocumentNode<{
-    chain: {
-        id: number;
-    };
-    vaultAddress: `0x${string}`;
-    totalSupplied: {
-        raw: bigint;
-    };
-}, {}, {
-    fragment: "VaultFragment";
-    on: "MorphoVault";
-    masked: false;
-}>;
-type Vault = FragmentOf<typeof vaultFragment>;
-
-export { type Vault, vaultFragment };

package/dist/queries/fragments/vault.js

@@ -1,16 +0,0 @@
-import { graphql } from "@whisk/graphql";
-const vaultFragment = graphql(`
-  fragment VaultFragment on MorphoVault {
-    chain {
-      id
-    }
-    vaultAddress
-    totalSupplied {
-      raw
-    }
-  }
-`);
-export {
-  vaultFragment
-};
-//# sourceMappingURL=vault.js.map

package/dist/queries/fragments/vault.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../src/queries/fragments/vault.ts"],"sourcesContent":["import { type FragmentOf, graphql } from \"@whisk/graphql\"\n\nexport const vaultFragment = graphql(`\n  fragment VaultFragment on MorphoVault {\n    chain {\n      id\n    }\n    vaultAddress\n    totalSupplied {\n      raw\n    }\n  }\n`)\n\nexport type Vault = FragmentOf<typeof vaultFragment>\n"],"mappings":"AAAA,SAA0B,eAAe;AAElC,MAAM,gBAAgB,QAAQ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,CAUpC;","names":[]}

package/src/client.test.ts

@@ -1,27 +0,0 @@
-import { describe, expect, it } from "vitest"
-import { SteakhouseClient } from "./client.js"
-
-describe("SteakhouseClient", () => {
-  it("creates client with config", () => {
-    const client = new SteakhouseClient({
-      apiKey: "test-key",
-    })
-    expect(client).toBeDefined()
-  })
-
-  it("creates client with custom url", () => {
-    const client = new SteakhouseClient({
-      apiKey: "test-key",
-      url: "https://custom.api.example.com/graphql",
-    })
-    expect(client).toBeDefined()
-  })
-
-  it("creates client with debug mode", () => {
-    const client = new SteakhouseClient({
-      apiKey: "test-key",
-      debug: true,
-    })
-    expect(client).toBeDefined()
-  })
-})

package/src/metadata/chains.ts

@@ -1,13 +0,0 @@
-import type { ChainConfig } from "./types.js"
-
-export const MAINNET: ChainConfig = {
-  id: 1,
-  name: "Ethereum Mainnet",
-}
-
-export const BASE: ChainConfig = {
-  id: 8453,
-  name: "Base",
-}
-
-export const SUPPORTED_CHAINS = [MAINNET, BASE] as const

package/src/metadata/vaults.ts

@@ -1,27 +0,0 @@
-import type { VaultConfig } from "./types.js"
-
-// Mainnet vault configurations
-// TODO: Add real Steakhouse vault addresses
-export const MAINNET_VAULTS: readonly VaultConfig[] = [
-  // Example placeholder vault
-  // {
-  //   address: "0x...",
-  //   protocol: "steakhouse",
-  //   name: "Steakhouse USDC Vault",
-  //   tag: "featured",
-  // },
-] as const
-
-// Base vault configurations
-// TODO: Add real Steakhouse vault addresses
-export const BASE_VAULTS: readonly VaultConfig[] = [
-  // Example placeholder vault
-  // {
-  //   address: "0x...",
-  //   protocol: "steakhouse",
-  //   name: "Steakhouse USDC Vault",
-  // },
-] as const
-
-// All vaults across all chains
-export const ALL_VAULTS = [...MAINNET_VAULTS, ...BASE_VAULTS] as const

package/src/queries/fragments/vault.ts

@@ -1,15 +0,0 @@
-import { type FragmentOf, graphql } from "@whisk/graphql"
-
-export const vaultFragment = graphql(`
-  fragment VaultFragment on MorphoVault {
-    chain {
-      id
-    }
-    vaultAddress
-    totalSupplied {
-      raw
-    }
-  }
-`)
-
-export type Vault = FragmentOf<typeof vaultFragment>