@whisk/steakhouse 0.0.2 → 0.0.5

package/dist/react/provider.d.ts

@@ -1,14 +1,12 @@
 import React, { PropsWithChildren } from 'react';
-import { SteakhouseClient } from '../client.js';
-import '@urql/core';
-import '@whisk/client';
+import { WhiskClient } from '@whisk/client';
 
 interface SteakhouseContextValue {
-    client: SteakhouseClient;
+    client: WhiskClient;
 }
 declare function useSteakhouse(): SteakhouseContextValue;
 interface SteakhouseProviderProps extends PropsWithChildren {
-    client: SteakhouseClient;
+    client: WhiskClient;
 }
 declare function SteakhouseProvider({ children, client, }: SteakhouseProviderProps): React.JSX.Element;
 

package/package.json

@@ -1,6 +1,11 @@
 {
   "name": "@whisk/steakhouse",
-  "version": "0.0.2",
+  "version": "0.0.5",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/office-supply-ventures/whisk-sdk.git",
+    "directory": "packages/steakhouse"
+  },
   "type": "module",
   "main": "./dist/index.js",
   "license": "MIT",
@@ -29,10 +34,10 @@
     }
   },
   "dependencies": {
-    "@urql/core": "^6.0.1",
+    "@urql/core": "6.0.1",
     "gql.tada": "1.9.0",
-    "@whisk/client": "0.0.7",
-    "@whisk/graphql": "0.0.7"
+    "@whisk/client": "0.0.10",
+    "@whisk/graphql": "0.0.10"
   },
   "peerDependencies": {
     "graphql": ">=16",

package/src/client.ts

@@ -1,19 +1,3 @@
-import type { AnyVariables, TypedDocumentNode } from "@urql/core"
-import { WhiskClient, type WhiskClientConfig } from "@whisk/client"
-
-export interface SteakhouseClientConfig extends WhiskClientConfig {}
-
-export class SteakhouseClient {
-  private readonly client: WhiskClient
-
-  constructor(config: SteakhouseClientConfig) {
-    this.client = new WhiskClient(config)
-  }
-
-  public async query<TValue, TVariables extends AnyVariables>(
-    document: TypedDocumentNode<TValue, TVariables>,
-    variables: TVariables,
-  ): Promise<TValue> {
-    return this.client.query(document, variables)
-  }
-}
+// Re-export from @whisk/client
+export type { WhiskClientConfig as SteakhouseClientConfig } from "@whisk/client"
+export { WhiskClient as SteakhouseClient } from "@whisk/client"

package/src/index.ts

@@ -1,3 +1,2 @@
-export { SteakhouseClient, type SteakhouseClientConfig } from "./client.js"
+export * from "./client.js"
 export * from "./queries/index.js"
-export type { SteakhouseQueryFn } from "./queries/types.js"

package/src/metadata/types.ts

@@ -1,10 +1,12 @@
 export type Address = `0x${string}`
 
-export type VaultProtocol = "morpho" | "steakhouse"
+/** Protocol type matching Erc4626VaultProtocol enum */
+export type VaultProtocol = "morpho_v1" | "morpho_v2" | "generic" | "box"
 
 export type VaultTag = "featured" | "new" | "deprecated"
 
 export interface VaultConfig {
+  readonly chainId: number
   readonly address: Address
   readonly protocol: VaultProtocol
   readonly name?: string

package/src/metadata/vaults.ts

@@ -1,27 +1,27 @@
 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",
-  // },
+  {
+    chainId: 1,
+    address: "0xBEEF01735c132Ada46AA9aA4c54623cAA92A64CB",
+    protocol: "morpho_v1",
+  },
+  {
+    chainId: 1,
+    address: "0xbeef0046fcab1dE47E41fB75BB3dC4Dfc94108E3",
+    protocol: "morpho_v2",
+    tag: "featured",
+  },
+  {
+    chainId: 1,
+    address: "0xbeeff2C5bF38f90e3482a8b19F12E5a6D2FCa757",
+    protocol: "morpho_v2",
+  },
 ] 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
+export const BASE_VAULTS: readonly VaultConfig[] = [] as const
 
 // All vaults across all chains
 export const ALL_VAULTS = [...MAINNET_VAULTS, ...BASE_VAULTS] as const

package/src/queries/fragments/vaultDetail.ts

@@ -0,0 +1,151 @@
+import { type FragmentOf, graphql } from "@whisk/graphql"
+
+/**
+ * Full fragment for vault detail view.
+ * Uses inline fragments to handle both MorphoVault (v1) and MorphoVaultV2.
+ */
+export const vaultDetailFragment = graphql(`
+  fragment VaultDetailFragment on Erc4626Vault {
+    chain {
+      id
+      name
+      icon
+    }
+    vaultAddress
+    name
+    symbol
+    decimals
+    asset {
+      address
+      symbol
+      name
+      icon
+      priceUsd
+      decimals
+    }
+    totalAssets {
+      raw
+      formatted
+      usd
+    }
+    apy(timeframe: seven_days) {
+      base
+      total
+      rewards {
+        asset {
+          symbol
+          icon
+        }
+        apr
+      }
+      fee
+    }
+    ... on MorphoVault {
+      totalLiquidity {
+        formatted
+        usd
+      }
+      v1PerformanceFee: performanceFee
+      feeRecipientAddress
+      ownerAddress
+      curatorAddress
+      guardianAddress
+      metadata {
+        description
+        image
+        forumLink
+        curator {
+          name
+          image
+          url
+        }
+        curators {
+          name
+          image
+          url
+        }
+      }
+      marketAllocations {
+        market {
+          marketId
+          name
+          loanAsset {
+            symbol
+            icon
+          }
+          collateralAsset {
+            symbol
+            icon
+          }
+          isIdle
+        }
+        enabled
+        supplyCap {
+          formatted
+          usd
+        }
+        vaultSupplyShare
+        marketSupplyShare
+        position {
+          supplyAmount {
+            formatted
+            usd
+          }
+        }
+      }
+      riskAssessment {
+        steakhouse {
+          score
+          rating
+        }
+      }
+    }
+    ... on MorphoVaultV2 {
+      curatorAddress
+      ownerAddress
+      metadata {
+        description
+        image
+        forumLink
+        curator {
+          name
+          image
+          url
+        }
+        curators {
+          name
+          image
+          url
+        }
+      }
+      liquidityAssets {
+        formatted
+        usd
+      }
+      idleAssets {
+        formatted
+        usd
+      }
+      v2PerformanceFee: performanceFee {
+        formatted
+      }
+      managementFee {
+        formatted
+      }
+      adapters {
+        ... on MarketV1Adapter {
+          adapterAddress
+          name
+        }
+      }
+      riskAssessment {
+        steakhouse {
+          score
+          rating
+        }
+      }
+    }
+  }
+`)
+
+export type VaultDetail = FragmentOf<typeof vaultDetailFragment>

package/src/queries/getDetailedVault.test.ts

@@ -0,0 +1,212 @@
+import { beforeEach, describe, expect, it, vi } from "vitest"
+import { createMockClient } from "../../test/mocks.js"
+import { getDetailedVault } from "./getDetailedVault.js"
+
+// Mock the metadata module
+vi.mock("../metadata/vaults.js", () => ({
+  ALL_VAULTS: [
+    {
+      chainId: 1,
+      address: "0x1111111111111111111111111111111111111111",
+      protocol: "morpho_v1",
+      name: "Steakhouse USDC",
+      description: "A USDC vault",
+      tag: "featured",
+    },
+    {
+      chainId: 1,
+      address: "0x2222222222222222222222222222222222222222",
+      protocol: "morpho_v1",
+      isHidden: true, // Should be excluded
+    },
+  ],
+}))
+
+function createMockVaultDetailResponse(vault: { vaultAddress: string } | null) {
+  if (!vault) {
+    return { erc4626Vaults: { items: [] } }
+  }
+
+  return {
+    erc4626Vaults: {
+      items: [
+        {
+          chain: { id: 1, name: "Ethereum", icon: "https://eth.icon" },
+          vaultAddress: vault.vaultAddress,
+          name: "API Vault Name",
+          symbol: "VAULT",
+          decimals: 18,
+          asset: {
+            address: "0xasset",
+            symbol: "USDC",
+            name: "USD Coin",
+            icon: "https://icon.url",
+            priceUsd: 1.0,
+            decimals: 6,
+          },
+          totalAssets: { raw: "1000000000000", formatted: "1000000", usd: 1000000 },
+          totalLiquidity: { formatted: "500000", usd: 500000 },
+          apy: {
+            base: 0.05,
+            total: 0.08,
+            rewards: [{ token: { symbol: "MORPHO", icon: "https://morpho.icon" }, apr: 0.03 }],
+            fee: 0.01,
+          },
+          performanceFee: 0.1,
+          feeRecipientAddress: "0xfee",
+          ownerAddress: "0xowner",
+          curatorAddress: "0xcurator",
+          guardianAddress: "0xguardian",
+          metadata: {
+            description: "API description",
+            image: "https://image.url",
+            forumLink: "https://forum.url",
+            curator: {
+              name: "Curator",
+              image: "https://curator.image",
+              url: "https://curator.url",
+            },
+            curators: [],
+          },
+          marketAllocations: [],
+          riskAssessment: { steakhouse: { score: 0.8, rating: "A" } },
+          // Historical data (only in historical query)
+          historical: {
+            daily: [
+              {
+                bucketTimestamp: 1704067200,
+                totalSupplied: { formatted: "1000000", usd: 1000000 },
+                supplyApy7d: { total: 0.08 },
+              },
+            ],
+          },
+        },
+      ],
+    },
+  }
+}
+
+describe("getDetailedVault", () => {
+  beforeEach(() => {
+    vi.clearAllMocks()
+  })
+
+  it("returns null for vault not in whitelist", async () => {
+    const client = createMockClient({})
+
+    const result = await getDetailedVault(client, {
+      chainId: 1,
+      address: "0x9999999999999999999999999999999999999999",
+    })
+
+    expect(result).toBeNull()
+    expect(client.query).not.toHaveBeenCalled()
+  })
+
+  it("returns null for hidden vault", async () => {
+    const client = createMockClient({})
+
+    const result = await getDetailedVault(client, {
+      chainId: 1,
+      address: "0x2222222222222222222222222222222222222222",
+    })
+
+    expect(result).toBeNull()
+    expect(client.query).not.toHaveBeenCalled()
+  })
+
+  it("returns null for vault on wrong chain", async () => {
+    const client = createMockClient({})
+
+    const result = await getDetailedVault(client, {
+      chainId: 8453, // Wrong chain
+      address: "0x1111111111111111111111111111111111111111",
+    })
+
+    expect(result).toBeNull()
+    expect(client.query).not.toHaveBeenCalled()
+  })
+
+  it("returns vault with historical data by default", async () => {
+    const client = createMockClient(
+      createMockVaultDetailResponse({
+        vaultAddress: "0x1111111111111111111111111111111111111111",
+      }),
+    )
+
+    const result = await getDetailedVault(client, {
+      chainId: 1,
+      address: "0x1111111111111111111111111111111111111111",
+    })
+
+    expect(result).not.toBeNull()
+    expect(result?.historical).toBeDefined()
+  })
+
+  it("can exclude historical data", async () => {
+    const mockResponse = createMockVaultDetailResponse({
+      vaultAddress: "0x1111111111111111111111111111111111111111",
+    })
+    // Remove historical from response
+    delete (mockResponse.erc4626Vaults.items[0] as Record<string, unknown>).historical
+
+    const client = createMockClient(mockResponse)
+
+    const result = await getDetailedVault(client, {
+      chainId: 1,
+      address: "0x1111111111111111111111111111111111111111",
+      historical: false,
+    })
+
+    expect(result).not.toBeNull()
+    // Different query should be called (without historical fragment)
+    expect(client.query).toHaveBeenCalled()
+  })
+
+  it("augments result with steakhouse metadata", async () => {
+    const client = createMockClient(
+      createMockVaultDetailResponse({
+        vaultAddress: "0x1111111111111111111111111111111111111111",
+      }),
+    )
+
+    const result = await getDetailedVault(client, {
+      chainId: 1,
+      address: "0x1111111111111111111111111111111111111111",
+    })
+
+    expect(result?.steakhouseMetadata).toEqual({
+      name: "Steakhouse USDC",
+      description: "A USDC vault",
+      tag: "featured",
+      protocol: "morpho_v1",
+    })
+  })
+
+  it("handles case-insensitive address matching", async () => {
+    const client = createMockClient(
+      createMockVaultDetailResponse({
+        vaultAddress: "0x1111111111111111111111111111111111111111",
+      }),
+    )
+
+    const result = await getDetailedVault(client, {
+      chainId: 1,
+      // Uppercase address
+      address: "0x1111111111111111111111111111111111111111".toUpperCase() as `0x${string}`,
+    })
+
+    expect(result).not.toBeNull()
+  })
+
+  it("returns null when API returns no results", async () => {
+    const client = createMockClient(createMockVaultDetailResponse(null))
+
+    const result = await getDetailedVault(client, {
+      chainId: 1,
+      address: "0x1111111111111111111111111111111111111111",
+    })
+
+    expect(result).toBeNull()
+  })
+})

package/src/queries/getDetailedVault.ts

@@ -0,0 +1,132 @@
+import { graphql } from "@whisk/graphql"
+import type { SteakhouseClient } from "../client.js"
+import type { Address } from "../metadata/types.js"
+import { ALL_VAULTS } from "../metadata/vaults.js"
+import { type VaultDetail, vaultDetailFragment } from "./fragments/vaultDetail.js"
+import { buildSteakhouseMetadata, type SteakhouseMetadata } from "./steakhouseMetadata.js"
+
+/** Historical data fragment for vault charts (works for both v1 and v2) */
+const vaultHistoricalFragment = graphql(`
+  fragment VaultHistoricalFragment on Erc4626Vault {
+    ... on MorphoVault {
+      historical {
+        daily {
+          bucketTimestamp
+          totalSupplied {
+            formatted
+            usd
+          }
+          supplyApy7d {
+            total
+          }
+        }
+      }
+    }
+    ... on MorphoVaultV2 {
+      historical {
+        daily {
+          bucketTimestamp
+          totalSupplied {
+            formatted
+            usd
+          }
+          supplyApy7d {
+            total
+          }
+        }
+      }
+    }
+  }
+`)
+
+/** Historical data type extracted from the fragment */
+type VaultHistoricalData = {
+  daily: Array<{
+    bucketTimestamp: number
+    totalSupplied: { formatted: string; usd: number | null }
+    supplyApy7d: { total: number }
+  }>
+}
+
+/** Query for fetching a single vault without historical data */
+export const vaultQuery = graphql(
+  `
+    query GetVault($where: Erc4626VaultFilter) {
+      erc4626Vaults(where: $where, limit: 1) {
+        items {
+          ...VaultDetailFragment
+        }
+      }
+    }
+  `,
+  [vaultDetailFragment],
+)
+
+/** Query for fetching a single vault with historical data */
+export const vaultWithHistoricalQuery = graphql(
+  `
+    query GetVaultWithHistorical($where: Erc4626VaultFilter) {
+      erc4626Vaults(where: $where, limit: 1) {
+        items {
+          ...VaultDetailFragment
+          ...VaultHistoricalFragment
+        }
+      }
+    }
+  `,
+  [vaultDetailFragment, vaultHistoricalFragment],
+)
+
+export type GetDetailedVaultVariables = {
+  chainId: number
+  address: Address
+  /** Include historical data for charts (default: true) */
+  historical?: boolean
+}
+
+/** Vault detail with Steakhouse metadata and optional historical data */
+export type DetailedVault = VaultDetail & {
+  historical?: VaultHistoricalData | null
+  steakhouseMetadata: SteakhouseMetadata
+}
+
+export type GetDetailedVaultResult = DetailedVault | null
+
+/**
+ * Get full details for a single Steakhouse vault with optional historical data.
+ * Returns null if the vault is not in the whitelist.
+ */
+export async function getDetailedVault(
+  client: SteakhouseClient,
+  variables: GetDetailedVaultVariables,
+): Promise<GetDetailedVaultResult> {
+  const { chainId, address, historical = true } = variables
+
+  const vaultConfig = ALL_VAULTS.find(
+    (v) =>
+      v.chainId === chainId && v.address.toLowerCase() === address.toLowerCase() && !v.isHidden,
+  )
+
+  if (!vaultConfig) {
+    return null
+  }
+
+  const where = {
+    keys: [
+      {
+        chainId,
+        vaultAddress: address,
+        protocol: vaultConfig.protocol,
+      },
+    ],
+  }
+  const query = historical ? vaultWithHistoricalQuery : vaultQuery
+  const result = await client.query(query, { where })
+  const vault = result.erc4626Vaults.items[0]
+
+  if (!vault) {
+    return null
+  }
+
+  return { ...vault, steakhouseMetadata: buildSteakhouseMetadata(vaultConfig) }
+}