@whisk/steakhouse 0.0.5 → 0.0.6

package/dist/queries/getVaults.js

@@ -1,5 +1,5 @@
 import { graphql } from "@whisk/graphql";
-import { ALL_VAULTS } from "../metadata/vaults.js";
+import { STEAKHOUSE_VAULTS } from "../metadata/generated/vaults.js";
 import { vaultDetailFragment } from "./fragments/vaultDetail.js";
 import { buildSteakhouseMetadata } from "./steakhouseMetadata.js";
 const vaultsQuery = graphql(
@@ -16,9 +16,7 @@ const vaultsQuery = graphql(
 );
 async function getVaults(client, variables = {}) {
   const { chainId } = variables;
-  const filteredVaults = ALL_VAULTS.filter(
-    (v) => !v.isHidden && (!chainId || v.chainId === chainId)
-  );
+  const filteredVaults = chainId ? STEAKHOUSE_VAULTS.filter((v) => v.chainId === chainId) : STEAKHOUSE_VAULTS;
   if (filteredVaults.length === 0) {
     return [];
   }

package/dist/queries/getVaults.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/queries/getVaults.ts"],"sourcesContent":["import { graphql } from \"@whisk/graphql\"\nimport type { SteakhouseClient } from \"../client.js\"\nimport type { Address, VaultConfig } from \"../metadata/types.js\"\nimport { ALL_VAULTS } from \"../metadata/vaults.js\"\nimport { type VaultDetail, vaultDetailFragment } from \"./fragments/vaultDetail.js\"\nimport { buildSteakhouseMetadata, type SteakhouseMetadata } from \"./steakhouseMetadata.js\"\n\n/** GraphQL query for fetching Steakhouse vaults */\nexport const vaultsQuery = graphql(\n  `\n    query GetVaults($where: Erc4626VaultFilter, $limit: Int) {\n      erc4626Vaults(where: $where, limit: $limit) {\n        items {\n          ...VaultDetailFragment\n        }\n      }\n    }\n  `,\n  [vaultDetailFragment],\n)\n\nexport type GetVaultsVariables = {\n  /** Filter by chain ID */\n  chainId?: number\n}\n\n/** Vault with Steakhouse metadata */\nexport type VaultWithMetadata = VaultDetail & {\n  steakhouseMetadata?: SteakhouseMetadata\n}\n\nexport type GetVaultsResult = VaultWithMetadata[]\n\n/**\n * Get all Steakhouse-curated vaults.\n * Results are filtered to the SDK whitelist and augmented with Steakhouse metadata.\n */\nexport async function getVaults(\n  client: SteakhouseClient,\n  variables: GetVaultsVariables = {},\n): Promise<GetVaultsResult> {\n  const { chainId } = variables\n\n  const filteredVaults = ALL_VAULTS.filter(\n    (v) => !v.isHidden && (!chainId || v.chainId === chainId),\n  )\n\n  if (filteredVaults.length === 0) {\n    return []\n  }\n\n  // Build keys array for erc4626Vaults filter\n  const keys = filteredVaults.map((v) => ({\n    chainId: v.chainId,\n    vaultAddress: v.address,\n    protocol: v.protocol,\n  }))\n\n  const result = await client.query(vaultsQuery, {\n    where: { keys },\n    limit: keys.length,\n  })\n\n  const metadataMap = new Map<Address, VaultConfig>(\n    filteredVaults.map((v) => [v.address.toLowerCase() as Address, v]),\n  )\n\n  return result.erc4626Vaults.items\n    .filter((vault): vault is NonNullable<typeof vault> => vault !== null)\n    .map((vault) => {\n      const config = metadataMap.get(vault.vaultAddress.toLowerCase() as Address)\n      if (config) {\n        return { ...vault, steakhouseMetadata: buildSteakhouseMetadata(config) }\n      }\n      return vault\n    })\n}\n"],"mappings":"AAAA,SAAS,eAAe;AAGxB,SAAS,kBAAkB;AAC3B,SAA2B,2BAA2B;AACtD,SAAS,+BAAwD;AAG1D,MAAM,cAAc;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,CAAC,mBAAmB;AACtB;AAkBA,eAAsB,UACpB,QACA,YAAgC,CAAC,GACP;AAC1B,QAAM,EAAE,QAAQ,IAAI;AAEpB,QAAM,iBAAiB,WAAW;AAAA,IAChC,CAAC,MAAM,CAAC,EAAE,aAAa,CAAC,WAAW,EAAE,YAAY;AAAA,EACnD;AAEA,MAAI,eAAe,WAAW,GAAG;AAC/B,WAAO,CAAC;AAAA,EACV;AAGA,QAAM,OAAO,eAAe,IAAI,CAAC,OAAO;AAAA,IACtC,SAAS,EAAE;AAAA,IACX,cAAc,EAAE;AAAA,IAChB,UAAU,EAAE;AAAA,EACd,EAAE;AAEF,QAAM,SAAS,MAAM,OAAO,MAAM,aAAa;AAAA,IAC7C,OAAO,EAAE,KAAK;AAAA,IACd,OAAO,KAAK;AAAA,EACd,CAAC;AAED,QAAM,cAAc,IAAI;AAAA,IACtB,eAAe,IAAI,CAAC,MAAM,CAAC,EAAE,QAAQ,YAAY,GAAc,CAAC,CAAC;AAAA,EACnE;AAEA,SAAO,OAAO,cAAc,MACzB,OAAO,CAAC,UAA8C,UAAU,IAAI,EACpE,IAAI,CAAC,UAAU;AACd,UAAM,SAAS,YAAY,IAAI,MAAM,aAAa,YAAY,CAAY;AAC1E,QAAI,QAAQ;AACV,aAAO,EAAE,GAAG,OAAO,oBAAoB,wBAAwB,MAAM,EAAE;AAAA,IACzE;AACA,WAAO;AAAA,EACT,CAAC;AACL;","names":[]}
+{"version":3,"sources":["../../src/queries/getVaults.ts"],"sourcesContent":["import { graphql } from \"@whisk/graphql\"\nimport type { SteakhouseClient } from \"../client.js\"\nimport { STEAKHOUSE_VAULTS } from \"../metadata/generated/vaults.js\"\nimport type { Address, VaultConfig } from \"../metadata/types.js\"\nimport { type VaultDetail, vaultDetailFragment } from \"./fragments/vaultDetail.js\"\nimport { buildSteakhouseMetadata, type SteakhouseMetadata } from \"./steakhouseMetadata.js\"\n\n/** GraphQL query for fetching Steakhouse vaults */\nexport const vaultsQuery = graphql(\n  `\n    query GetVaults($where: Erc4626VaultFilter, $limit: Int) {\n      erc4626Vaults(where: $where, limit: $limit) {\n        items {\n          ...VaultDetailFragment\n        }\n      }\n    }\n  `,\n  [vaultDetailFragment],\n)\n\nexport type GetVaultsVariables = {\n  /** Filter by chain ID */\n  chainId?: number\n}\n\n/** Vault with Steakhouse metadata */\nexport type VaultWithMetadata = VaultDetail & {\n  steakhouseMetadata?: SteakhouseMetadata\n}\n\nexport type GetVaultsResult = VaultWithMetadata[]\n\n/**\n * Get all Steakhouse-curated vaults.\n * Results are filtered to the SDK whitelist and augmented with Steakhouse metadata.\n */\nexport async function getVaults(\n  client: SteakhouseClient,\n  variables: GetVaultsVariables = {},\n): Promise<GetVaultsResult> {\n  const { chainId } = variables\n\n  const filteredVaults = chainId\n    ? STEAKHOUSE_VAULTS.filter((v) => v.chainId === chainId)\n    : STEAKHOUSE_VAULTS\n\n  if (filteredVaults.length === 0) {\n    return []\n  }\n\n  // Build keys array for erc4626Vaults filter\n  const keys = filteredVaults.map((v) => ({\n    chainId: v.chainId,\n    vaultAddress: v.address,\n    protocol: v.protocol,\n  }))\n\n  const result = await client.query(vaultsQuery, {\n    where: { keys },\n    limit: keys.length,\n  })\n\n  const metadataMap = new Map<Address, VaultConfig>(\n    filteredVaults.map((v) => [v.address.toLowerCase() as Address, v]),\n  )\n\n  return result.erc4626Vaults.items\n    .filter((vault): vault is NonNullable<typeof vault> => vault !== null)\n    .map((vault) => {\n      const config = metadataMap.get(vault.vaultAddress.toLowerCase() as Address)\n      if (config) {\n        return { ...vault, steakhouseMetadata: buildSteakhouseMetadata(config) }\n      }\n      return vault\n    })\n}\n"],"mappings":"AAAA,SAAS,eAAe;AAExB,SAAS,yBAAyB;AAElC,SAA2B,2BAA2B;AACtD,SAAS,+BAAwD;AAG1D,MAAM,cAAc;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,CAAC,mBAAmB;AACtB;AAkBA,eAAsB,UACpB,QACA,YAAgC,CAAC,GACP;AAC1B,QAAM,EAAE,QAAQ,IAAI;AAEpB,QAAM,iBAAiB,UACnB,kBAAkB,OAAO,CAAC,MAAM,EAAE,YAAY,OAAO,IACrD;AAEJ,MAAI,eAAe,WAAW,GAAG;AAC/B,WAAO,CAAC;AAAA,EACV;AAGA,QAAM,OAAO,eAAe,IAAI,CAAC,OAAO;AAAA,IACtC,SAAS,EAAE;AAAA,IACX,cAAc,EAAE;AAAA,IAChB,UAAU,EAAE;AAAA,EACd,EAAE;AAEF,QAAM,SAAS,MAAM,OAAO,MAAM,aAAa;AAAA,IAC7C,OAAO,EAAE,KAAK;AAAA,IACd,OAAO,KAAK;AAAA,EACd,CAAC;AAED,QAAM,cAAc,IAAI;AAAA,IACtB,eAAe,IAAI,CAAC,MAAM,CAAC,EAAE,QAAQ,YAAY,GAAc,CAAC,CAAC;AAAA,EACnE;AAEA,SAAO,OAAO,cAAc,MACzB,OAAO,CAAC,UAA8C,UAAU,IAAI,EACpE,IAAI,CAAC,UAAU;AACd,UAAM,SAAS,YAAY,IAAI,MAAM,aAAa,YAAY,CAAY;AAC1E,QAAI,QAAQ;AACV,aAAO,EAAE,GAAG,OAAO,oBAAoB,wBAAwB,MAAM,EAAE;AAAA,IACzE;AACA,WAAO;AAAA,EACT,CAAC;AACL;","names":[]}

package/dist/queries/steakhouseMetadata.d.ts

@@ -1,10 +1,11 @@
 import { VaultConfig } from '../metadata/types.js';
+import '@whisk/graphql';
 
 /** Steakhouse-specific metadata augmented onto vault data */
 type SteakhouseMetadata = {
     name?: string;
     description?: string;
-    tag?: VaultConfig["tag"];
+    type?: VaultConfig["type"];
     protocol: VaultConfig["protocol"];
 };
 /** Build metadata object from vault config */

package/dist/queries/steakhouseMetadata.js

@@ -3,7 +3,7 @@ function buildSteakhouseMetadata(config) {
     protocol: config.protocol,
     ...config.name !== void 0 && { name: config.name },
     ...config.description !== void 0 && { description: config.description },
-    ...config.tag !== void 0 && { tag: config.tag }
+    ...config.type !== void 0 && { type: config.type }
   };
 }
 export {

package/dist/queries/steakhouseMetadata.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/queries/steakhouseMetadata.ts"],"sourcesContent":["import type { VaultConfig } from \"../metadata/types.js\"\n\n/** Steakhouse-specific metadata augmented onto vault data */\nexport type SteakhouseMetadata = {\n  name?: string\n  description?: string\n  tag?: VaultConfig[\"tag\"]\n  protocol: VaultConfig[\"protocol\"]\n}\n\n/** Build metadata object from vault config */\nexport function buildSteakhouseMetadata(config: VaultConfig): SteakhouseMetadata {\n  return {\n    protocol: config.protocol,\n    ...(config.name !== undefined && { name: config.name }),\n    ...(config.description !== undefined && { description: config.description }),\n    ...(config.tag !== undefined && { tag: config.tag }),\n  }\n}\n"],"mappings":"AAWO,SAAS,wBAAwB,QAAyC;AAC/E,SAAO;AAAA,IACL,UAAU,OAAO;AAAA,IACjB,GAAI,OAAO,SAAS,UAAa,EAAE,MAAM,OAAO,KAAK;AAAA,IACrD,GAAI,OAAO,gBAAgB,UAAa,EAAE,aAAa,OAAO,YAAY;AAAA,IAC1E,GAAI,OAAO,QAAQ,UAAa,EAAE,KAAK,OAAO,IAAI;AAAA,EACpD;AACF;","names":[]}
+{"version":3,"sources":["../../src/queries/steakhouseMetadata.ts"],"sourcesContent":["import type { VaultConfig } from \"../metadata/types.js\"\n\n/** Steakhouse-specific metadata augmented onto vault data */\nexport type SteakhouseMetadata = {\n  name?: string\n  description?: string\n  type?: VaultConfig[\"type\"]\n  protocol: VaultConfig[\"protocol\"]\n}\n\n/** Build metadata object from vault config */\nexport function buildSteakhouseMetadata(config: VaultConfig): SteakhouseMetadata {\n  return {\n    protocol: config.protocol,\n    ...(config.name !== undefined && { name: config.name }),\n    ...(config.description !== undefined && { description: config.description }),\n    ...(config.type !== undefined && { type: config.type }),\n  }\n}\n"],"mappings":"AAWO,SAAS,wBAAwB,QAAyC;AAC/E,SAAO;AAAA,IACL,UAAU,OAAO;AAAA,IACjB,GAAI,OAAO,SAAS,UAAa,EAAE,MAAM,OAAO,KAAK;AAAA,IACrD,GAAI,OAAO,gBAAgB,UAAa,EAAE,aAAa,OAAO,YAAY;AAAA,IAC1E,GAAI,OAAO,SAAS,UAAa,EAAE,MAAM,OAAO,KAAK;AAAA,EACvD;AACF;","names":[]}

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

@@ -6,8 +6,8 @@ import '../../queries/getDetailedVault.js';
 import 'gql.tada';
 import '@whisk/client';
 import '../../metadata/types.js';
-import '../../queries/fragments/vaultDetail.js';
 import '@whisk/graphql';
+import '../../queries/fragments/vaultDetail.js';
 import '../../queries/steakhouseMetadata.js';
 import '../../queries/types.js';
 import '../../queries/getVaults.js';

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

@@ -3,8 +3,8 @@ import { GetDetailedVaultVariables, GetDetailedVaultResult } from '../../queries
 import 'gql.tada';
 import '@whisk/client';
 import '../../metadata/types.js';
-import '../../queries/fragments/vaultDetail.js';
 import '@whisk/graphql';
+import '../../queries/fragments/vaultDetail.js';
 import '../../queries/steakhouseMetadata.js';
 
 declare function useDetailedVault(variables: GetDetailedVaultVariables): UseQueryResult<GetDetailedVaultResult, Error>;

package/dist/react/index.d.ts

@@ -7,8 +7,8 @@ import '../queries/getDetailedVault.js';
 import 'gql.tada';
 import '@whisk/client';
 import '../metadata/types.js';
-import '../queries/fragments/vaultDetail.js';
 import '@whisk/graphql';
+import '../queries/fragments/vaultDetail.js';
 import '../queries/steakhouseMetadata.js';
 import '../queries/types.js';
 import '../queries/getVaults.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@whisk/steakhouse",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "repository": {
     "type": "git",
     "url": "https://github.com/office-supply-ventures/whisk-sdk.git",
@@ -40,10 +40,10 @@
     "@whisk/graphql": "0.0.10"
   },
   "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.