@whisk/steakhouse 0.0.5 → 0.0.7

package/dist/queries/index.d.ts

@@ -1,9 +1,4 @@
-export { VaultDetail, vaultDetailFragment } from './fragments/vaultDetail.js';
-export { DetailedVault, GetDetailedVaultResult, GetDetailedVaultVariables, getDetailedVault, vaultQuery, vaultWithHistoricalQuery } from './getDetailedVault.js';
-export { GetVaultsResult, GetVaultsVariables, VaultWithMetadata, getVaults, vaultsQuery } from './getVaults.js';
-export { SteakhouseMetadata, buildSteakhouseMetadata } from './steakhouseMetadata.js';
-export { SteakhouseQueryFn } from './types.js';
+export { GetTvlResult, getTvl, tvlQuery } from './getTvl.js';
 import '@whisk/client';
 import 'gql.tada';
 import '@whisk/graphql';
-import '../metadata/types.js';

package/dist/queries/index.js

@@ -1,9 +1,2 @@
-import { vaultDetailFragment } from "./fragments/vaultDetail.js";
-export * from "./getDetailedVault.js";
-export * from "./getVaults.js";
-import { buildSteakhouseMetadata } from "./steakhouseMetadata.js";
-export {
-  buildSteakhouseMetadata,
-  vaultDetailFragment
-};
+export * from "./getTvl.js";
 //# sourceMappingURL=index.js.map

package/dist/queries/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/queries/index.ts"],"sourcesContent":["// Fragments\nexport { type VaultDetail, vaultDetailFragment } from \"./fragments/vaultDetail.js\"\n// Queries\nexport * from \"./getDetailedVault.js\"\nexport * from \"./getVaults.js\"\n// Shared\nexport { buildSteakhouseMetadata, type SteakhouseMetadata } from \"./steakhouseMetadata.js\"\n\n// Types\nexport type { SteakhouseQueryFn } from \"./types.js\"\n"],"mappings":"AACA,SAA2B,2BAA2B;AAEtD,cAAc;AACd,cAAc;AAEd,SAAS,+BAAwD;","names":[]}
+{"version":3,"sources":["../../src/queries/index.ts"],"sourcesContent":["export * from \"./getTvl.js\"\n"],"mappings":"AAAA,cAAc;","names":[]}

package/dist/react/hooks/index.d.ts

@@ -1,13 +1,6 @@
-export { useDetailedVault } from './useDetailedVault.js';
-export { useSteakhouseQuery } from './useSteakhouseQuery.js';
-export { useVaults } from './useVaults.js';
+export { useTvl } from './useTvl.js';
 import '@tanstack/react-query';
-import '../../queries/getDetailedVault.js';
-import 'gql.tada';
+import '../../queries/getTvl.js';
 import '@whisk/client';
-import '../../metadata/types.js';
-import '../../queries/fragments/vaultDetail.js';
+import 'gql.tada';
 import '@whisk/graphql';
-import '../../queries/steakhouseMetadata.js';
-import '../../queries/types.js';
-import '../../queries/getVaults.js';

package/dist/react/hooks/index.js

@@ -1,9 +1,5 @@
-import { useDetailedVault } from "./useDetailedVault.js";
-import { useSteakhouseQuery } from "./useSteakhouseQuery.js";
-import { useVaults } from "./useVaults.js";
+import { useTvl } from "./useTvl.js";
 export {
-  useDetailedVault,
-  useSteakhouseQuery,
-  useVaults
+  useTvl
 };
 //# sourceMappingURL=index.js.map

package/dist/react/hooks/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/react/hooks/index.ts"],"sourcesContent":["export { useDetailedVault } from \"./useDetailedVault.js\"\nexport { useSteakhouseQuery } from \"./useSteakhouseQuery.js\"\nexport { useVaults } from \"./useVaults.js\"\n"],"mappings":"AAAA,SAAS,wBAAwB;AACjC,SAAS,0BAA0B;AACnC,SAAS,iBAAiB;","names":[]}
+{"version":3,"sources":["../../../src/react/hooks/index.ts"],"sourcesContent":["export { useTvl } from \"./useTvl.js\"\n"],"mappings":"AAAA,SAAS,cAAc;","names":[]}

package/dist/react/hooks/useTvl.d.ts

@@ -0,0 +1,9 @@
+import { UseQueryResult } from '@tanstack/react-query';
+import { GetTvlResult } from '../../queries/getTvl.js';
+import '@whisk/client';
+import 'gql.tada';
+import '@whisk/graphql';
+
+declare function useTvl(): UseQueryResult<GetTvlResult, Error>;
+
+export { useTvl };

package/dist/react/hooks/useTvl.js

@@ -0,0 +1,15 @@
+"use client";
+import { useQuery } from "@tanstack/react-query";
+import { getTvl } from "../../queries/getTvl.js";
+import { useSteakhouse } from "../provider.js";
+function useTvl() {
+  const { client } = useSteakhouse();
+  return useQuery({
+    queryKey: ["steakhouse", "tvl"],
+    queryFn: () => getTvl(client)
+  });
+}
+export {
+  useTvl
+};
+//# sourceMappingURL=useTvl.js.map

package/dist/react/hooks/useTvl.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/react/hooks/useTvl.ts"],"sourcesContent":["\"use client\"\n\nimport type { UseQueryResult } from \"@tanstack/react-query\"\nimport { useQuery } from \"@tanstack/react-query\"\nimport { type GetTvlResult, getTvl } from \"../../queries/getTvl.js\"\nimport { useSteakhouse } from \"../provider.js\"\n\nexport function useTvl(): UseQueryResult<GetTvlResult, Error> {\n  const { client } = useSteakhouse()\n  return useQuery({\n    queryKey: [\"steakhouse\", \"tvl\"],\n    queryFn: () => getTvl(client),\n  })\n}\n"],"mappings":";AAGA,SAAS,gBAAgB;AACzB,SAA4B,cAAc;AAC1C,SAAS,qBAAqB;AAEvB,SAAS,SAA8C;AAC5D,QAAM,EAAE,OAAO,IAAI,cAAc;AACjC,SAAO,SAAS;AAAA,IACd,UAAU,CAAC,cAAc,KAAK;AAAA,IAC9B,SAAS,MAAM,OAAO,MAAM;AAAA,EAC9B,CAAC;AACH;","names":[]}

package/dist/react/index.d.ts

@@ -1,15 +1,8 @@
-export { useDetailedVault } from './hooks/useDetailedVault.js';
-export { useSteakhouseQuery } from './hooks/useSteakhouseQuery.js';
-export { useVaults } from './hooks/useVaults.js';
+export { useTvl } from './hooks/useTvl.js';
 export { SteakhouseContextValue, SteakhouseProvider, SteakhouseProviderProps, useSteakhouse } from './provider.js';
 import '@tanstack/react-query';
-import '../queries/getDetailedVault.js';
-import 'gql.tada';
+import '../queries/getTvl.js';
 import '@whisk/client';
-import '../metadata/types.js';
-import '../queries/fragments/vaultDetail.js';
+import 'gql.tada';
 import '@whisk/graphql';
-import '../queries/steakhouseMetadata.js';
-import '../queries/types.js';
-import '../queries/getVaults.js';
 import 'react';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@whisk/steakhouse",
-  "version": "0.0.5",
+  "version": "0.0.7",
   "repository": {
     "type": "git",
     "url": "https://github.com/office-supply-ventures/whisk-sdk.git",
@@ -36,14 +36,14 @@
   "dependencies": {
     "@urql/core": "6.0.1",
     "gql.tada": "1.9.0",
-    "@whisk/client": "0.0.10",
-    "@whisk/graphql": "0.0.10"
+    "@whisk/client": "0.0.11",
+    "@whisk/graphql": "0.0.11"
   },
   "peerDependencies": {
+    "@tanstack/react-query": ">=5",
     "graphql": ">=16",
     "react": ">=18",
-    "react-dom": ">=18",
-    "@tanstack/react-query": ">=5"
+    "react-dom": ">=18"
   },
   "peerDependenciesMeta": {
     "react": {
@@ -57,14 +57,22 @@
     }
   },
   "devDependencies": {
+    "@tanstack/react-query": "5.90.10",
     "@types/react": "^19.2.0",
     "@types/react-dom": "^19.2.0",
+    "chokidar-cli": "^3.0.0",
+    "concurrently": "^9.2.1",
+    "gray-matter": "^4.0.3",
     "react": "19.2.0",
     "react-dom": "19.2.0",
-    "@tanstack/react-query": "5.90.10"
+    "tsx": "^4.20.6",
+    "viem": "^2.0.0",
+    "zod": "^3.24.0"
   },
   "scripts": {
-    "build": "tsup",
-    "dev": "tsup --watch"
+    "generate:vaults": "tsx scripts/generate-vaults.ts",
+    "generate:vaults:watch": "chokidar \"src/metadata/vaults/**/*.md\" --initial -c \"pnpm generate:vaults\"",
+    "build": "pnpm generate:vaults && tsup",
+    "dev": "concurrently -n vaults,tsup -c blue,green \"pnpm generate:vaults:watch\" \"tsup --watch\""
   }
 }

package/src/metadata/README.md

@@ -0,0 +1,93 @@
+# Vault Metadata
+
+Steakhouse vault metadata is defined in markdown files with YAML frontmatter, which are compiled into TypeScript at build time.
+
+## Adding a New Vault
+
+1. Create a `.md` file in `vaults/{chain}/`:
+
+   ```
+   vaults/mainnet/my-vault.md
+   vaults/base/my-vault.md
+   ```
+
+2. Add YAML frontmatter:
+
+   ```yaml
+   ---
+   chainId: 1
+   vaultAddress: 0x...
+   protocol: morpho_v2
+   type: Prime
+   ---
+   ```
+
+   Optionally override the on-chain name or add a description:
+
+   ```yaml
+   ---
+   chainId: 1
+   vaultAddress: 0x...
+   protocol: morpho_v2
+   type: Prime
+   name: Custom Display Name
+   ---
+
+   Custom description in markdown. Supports **formatting**, links, etc.
+   ```
+
+3. Regenerate and commit:
+
+   ```bash
+   pnpm generate:vaults
+   git add src/metadata/generated/vaults.ts
+   ```
+
+4. Verify the vault appears in `generated/vaults.ts` and commit the changes
+
+## Frontmatter Fields
+
+| Field          | Required | Description                                       |
+| -------------- | -------- | ------------------------------------------------- |
+| `chainId`      | Yes      | Chain ID (1 for mainnet, 8453 for Base, etc.)     |
+| `vaultAddress` | Yes      | Ethereum address, no quotes needed (checksummed automatically) |
+| `protocol`     | Yes      | `morpho_v1`, `morpho_v2`, `generic`, or `box`     |
+| `type`         | No       | `Prime`, `High Yield`, `Turbo`, or `Term`         |
+| `name`         | No       | Override display name (defaults to on-chain name) |
+
+The markdown body after the frontmatter becomes the `description` field (optional, defaults to morpho metadata).
+
+## Validation
+
+The build script validates:
+
+- Required fields are present
+- Valid Ethereum address format (checksummed automatically via viem)
+- Valid protocol enum value (from `@whisk/graphql`)
+- Valid type enum value (if provided)
+- No duplicate chainId + vaultAddress combinations
+
+If validation fails, the build will error with details about which file and field failed.
+
+## File Naming
+
+Use descriptive slugs that identify the vault:
+
+```
+vaults/
+  mainnet/
+    steakhouse-usdc.md
+    steakhouse-eth.md
+  base/
+    steakhouse-usdc.md
+```
+
+The filename doesn't affect the generated code - it's just for organization.
+
+## Generated Output
+
+The generator creates `src/metadata/generated/vaults.ts` with:
+
+- `STEAKHOUSE_VAULTS` - array of all vault configurations
+
+This file is committed to git for security auditability. CI verifies the committed file matches regenerated output.