@whisk/steakhouse 0.0.4 → 0.0.6

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,6 @@
 {
   "name": "@whisk/steakhouse",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "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.9",
-    "@whisk/graphql": "0.0.9"
+    "@whisk/client": "0.0.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/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/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.

package/src/metadata/generated/vaults.ts

@@ -0,0 +1,470 @@
+// THIS FILE IS AUTO-GENERATED. DO NOT EDIT DIRECTLY.
+// Run `pnpm generate:vaults` to regenerate.
+
+import type { VaultConfig } from "../types.js"
+
+/** All Steakhouse vault configurations */
+export const STEAKHOUSE_VAULTS: readonly VaultConfig[] = [
+  {
+    chainId: 42161,
+    address: "0xBEEFFF13dD098De415e07F033daE65205B31A894",
+    protocol: "morpho_v2",
+    type: "Turbo",
+  },
+  {
+    chainId: 42161,
+    address: "0x5c0C306Aaa9F877de636f4d5822cA9F2E81563BA",
+    protocol: "morpho_v1",
+    type: "High Yield",
+  },
+  {
+    chainId: 42161,
+    address: "0xbeeff1D5dE8F79ff37a151681100B039661da518",
+    protocol: "morpho_v2",
+    type: "High Yield",
+  },
+  {
+    chainId: 42161,
+    address: "0xbeeff77CE5C059445714E6A3490E273fE7F2492F",
+    protocol: "morpho_v2",
+    type: "High Yield",
+  },
+  {
+    chainId: 8453,
+    address: "0xBeEFDebfaea8350Ce8C4b3a6B7E5FE629c9e27A8",
+    protocol: "morpho_v2",
+    type: "Prime",
+  },
+  {
+    chainId: 8453,
+    address: "0xbEEf050a7485865A7a8d8Ca0CC5f7536b7a3443e",
+    protocol: "morpho_v1",
+    type: "Prime",
+  },
+  {
+    chainId: 8453,
+    address: "0xBEeFA28D5e56d41D35df760AB53B94D9FfD7051F",
+    protocol: "morpho_v1",
+    type: "High Yield",
+  },
+  {
+    chainId: 8453,
+    address: "0xBeEF086b8807Dc5E5A1740C5E3a7C4c366eA6ab5",
+    protocol: "morpho_v1",
+    type: "Prime",
+  },
+  {
+    chainId: 8453,
+    address: "0xbeeff7aE5E00Aae3Db302e4B0d8C883810a58100",
+    protocol: "morpho_v2",
+    type: "High Yield",
+  },
+  {
+    chainId: 8453,
+    address: "0xBEEFFFdeADc2c172130Ac4C5Ae48c8D4708BFb40",
+    protocol: "morpho_v2",
+    type: "Turbo",
+  },
+  {
+    chainId: 8453,
+    address: "0xBEEFA7B88064FeEF0cEe02AAeBBd95D30df3878F",
+    protocol: "morpho_v1",
+    type: "High Yield",
+  },
+  {
+    chainId: 8453,
+    address: "0xCBeeF01994E24a60f7DCB8De98e75AD8BD4Ad60d",
+    protocol: "morpho_v1",
+    type: "High Yield",
+  },
+  {
+    chainId: 8453,
+    address: "0xbeef0e0834849aCC03f0089F01f4F1Eeb06873C9",
+    protocol: "morpho_v2",
+    type: "Prime",
+  },
+  {
+    chainId: 8453,
+    address: "0xBEEFE94c8aD530842bfE7d8B397938fFc1cb83b2",
+    protocol: "morpho_v1",
+    type: "Prime",
+  },
+  {
+    chainId: 8453,
+    address: "0xBeef2dc30633221Fa51A1C3e5299BFf8C69fc0A8",
+    protocol: "morpho_v1",
+    type: "Prime",
+  },
+  {
+    chainId: 8453,
+    address: "0xbeEFe1372c0A384aCEcBe8a0Adf3c94c389F6704",
+    protocol: "morpho_v1",
+    type: "Prime",
+  },
+  {
+    chainId: 8453,
+    address: "0xBeeFa74640a5f7c28966cbA82466EED5609444E0",
+    protocol: "morpho_v1",
+    type: "High Yield",
+  },
+  {
+    chainId: 8453,
+    address: "0xB17B070A56043e1a5a1AB7443AfAFDEbcc1168D7",
+    protocol: "morpho_v1",
+    type: "High Yield",
+  },
+  {
+    chainId: 8453,
+    address: "0xbEEfa1aBfEbE621DF50ceaEF9f54FdB73648c92C",
+    protocol: "morpho_v1",
+    type: "High Yield",
+  },
+  {
+    chainId: 8453,
+    address: "0xbEefc4aDBE58173FCa2C042097Fe33095E68C3D6",
+    protocol: "morpho_v1",
+    type: "High Yield",
+  },
+  {
+    chainId: 8453,
+    address: "0xbeeF010f9cb27031ad51e3333f9aF9C6B1228183",
+    protocol: "morpho_v1",
+    type: "Prime",
+  },
+  {
+    chainId: 747474,
+    address: "0xdE6a4F28Acfe431DD1CfA2D9c7A3d8301624a841",
+    protocol: "morpho_v1",
+    type: "High Yield",
+  },
+  {
+    chainId: 747474,
+    address: "0x1445A01a57D7B7663CfD7B4EE0a8Ec03B379aabD",
+    protocol: "morpho_v1",
+    type: "High Yield",
+  },
+  {
+    chainId: 747474,
+    address: "0x82c4C641CCc38719ae1f0FBd16A64808d838fDfD",
+    protocol: "morpho_v1",
+    type: "Prime",
+  },
+  {
+    chainId: 747474,
+    address: "0x61D4F9D3797BA4dA152238c53a6f93Fb665C3c1d",
+    protocol: "morpho_v1",
+    type: "Prime",
+  },
+  {
+    chainId: 1,
+    address: "0xBEEf3f3A04e28895f3D5163d910474901981183D",
+    protocol: "morpho_v2",
+    type: "High Yield",
+  },
+  {
+    chainId: 1,
+    address: "0x7204B7Dbf9412567835633B6F00C3Edc3a8D6330",
+    protocol: "morpho_v1",
+    type: "Prime",
+  },
+  {
+    chainId: 1,
+    address: "0xbEeFc011e94f43b8B7b455eBaB290C7Ab4E216f1",
+    protocol: "morpho_v1",
+    type: "Prime",
+  },
+  {
+    chainId: 1,
+    address: "0xBEEf050ecd6a16c4e7bfFbB52Ebba7846C4b8cD4",
+    protocol: "morpho_v1",
+    type: "Prime",
+  },
+  {
+    chainId: 1,
+    address: "0xbeEfdDbd3bef4726bCF9627a9BA3B901D4958745",
+    protocol: "morpho_v1",
+    type: "High Yield",
+  },
+  {
+    chainId: 1,
+    address: "0xBeEFC1CDAfc5b4a649b54D07AFc6bF0f75C6F4E2",
+    protocol: "morpho_v1",
+    type: "Prime",
+  },
+  {
+    chainId: 1,
+    address: "0x75741A12B36D181f44F389E0c6B1E0210311e3Ff",
+    protocol: "morpho_v1",
+    type: "Prime",
+  },
+  {
+    chainId: 1,
+    address: "0xbEeFf89ABb7815cCD5182BD1FF82C4a4F8FCb13D",
+    protocol: "morpho_v2",
+    type: "High Yield",
+  },
+  {
+    chainId: 1,
+    address: "0xbeeff2C5bF38f90e3482a8b19F12E5a6D2FCa757",
+    protocol: "morpho_v2",
+    type: "High Yield",
+  },
+  {
+    chainId: 1,
+    address: "0xbeeff07d991C04CD640DE9F15C08ba59c4FEDEb7",
+    protocol: "morpho_v2",
+    type: "High Yield",
+  },
+  {
+    chainId: 1,
+    address: "0xBEEFFFC57A26fD8D3b693Ba025ead597DbECEBfe",
+    protocol: "morpho_v2",
+    type: "Term",
+  },
+  {
+    chainId: 1,
+    address: "0xBEEFFF506B52B3323c48aFE0Cb405A284F0f9cF2",
+    protocol: "morpho_v2",
+    type: "Turbo",
+  },
+  {
+    chainId: 1,
+    address: "0xBEEFFFcbA46C49A24cfBfFc19166e8f089B59300",
+    protocol: "morpho_v2",
+    type: "Turbo",
+  },
+  {
+    chainId: 1,
+    address: "0xBEEFFF4716a49418D69c251cab8759bB107e57C8",
+    protocol: "morpho_v2",
+    type: "Turbo",
+  },
+  {
+    chainId: 1,
+    address: "0xBEeF1f5Bd88285E5B239B6AAcb991d38ccA23Ac9",
+    protocol: "morpho_v1",
+    type: "High Yield",
+  },
+  {
+    chainId: 1,
+    address: "0xbEEf11C63d7173BdCC2037e7220eE9Bd0cCDA862",
+    protocol: "morpho_v1",
+    type: "High Yield",
+  },
+  {
+    chainId: 1,
+    address: "0xa5aA40F27DAeDE9748822ef836170f202e196B5A",
+    protocol: "morpho_v1",
+    type: "Prime",
+  },
+  {
+    chainId: 1,
+    address: "0xBeeF7959aE71D4e45e1863dae0B94C35244AF816",
+    protocol: "morpho_v1",
+    type: "Prime",
+  },
+  {
+    chainId: 1,
+    address: "0xdcdCEa96147672Fe3B56dCb1AA5608332B67Ff84",
+    protocol: "morpho_v2",
+    type: "Term",
+  },
+  {
+    chainId: 1,
+    address: "0xbeef0046fcab1dE47E41fB75BB3dC4Dfc94108E3",
+    protocol: "morpho_v2",
+    type: "Prime",
+  },
+  {
+    chainId: 1,
+    address: "0xbeef0C075Da5D01112AE5cF34d257074fB5DDB2f",
+    protocol: "morpho_v2",
+    type: "Prime",
+  },
+  {
+    chainId: 1,
+    address: "0xbeef00B5d83C1188F07A5184230a805639c39f04",
+    protocol: "morpho_v2",
+    type: "Prime",
+  },
+  {
+    chainId: 1,
+    address: "0xbeef088055857739C12CD3765F20b7679Def0f51",
+    protocol: "morpho_v2",
+    type: "Prime",
+  },
+  {
+    chainId: 1,
+    address: "0xbeef003C68896c7D2c3c60d363e8d71a49Ab2bf9",
+    protocol: "morpho_v2",
+    type: "Prime",
+  },
+  {
+    chainId: 1,
+    address: "0xd8A6511979D9C5D387c819E9F8ED9F3a5C6c5379",
+    protocol: "morpho_v2",
+    type: "High Yield",
+  },
+  {
+    chainId: 1,
+    address: "0xbEEF02e5E13584ab96848af90261f0C8Ee04722a",
+    protocol: "morpho_v1",
+    type: "Prime",
+  },
+  {
+    chainId: 1,
+    address: "0xBeEf11eCb698f4B5378685C05A210bdF71093521",
+    protocol: "morpho_v1",
+    type: "Prime",
+  },
+  {
+    chainId: 1,
+    address: "0xBeEFB45B6F9acB175e70acF16dC20D6120044c70",
+    protocol: "morpho_v1",
+    type: "Prime",
+  },
+  {
+    chainId: 1,
+    address: "0xbEEf390D2e65d6E43A67875106d4A48f700F2832",
+    protocol: "morpho_v1",
+    type: "High Yield",
+  },
+  {
+    chainId: 1,
+    address: "0xbEEf0c18715ACDdC14a3123a608F491319F1C28C",
+    protocol: "morpho_v1",
+    type: "High Yield",
+  },
+  {
+    chainId: 1,
+    address: "0xBEEFF900ec6faB1465252D2fBe731db8d1Ad5FD9",
+    protocol: "morpho_v1",
+    type: "High Yield",
+  },
+  {
+    chainId: 1,
+    address: "0xbEEffF79FFA3EE2D1bfcC32dE9cFd8129528D0E4",
+    protocol: "morpho_v1",
+    type: "High Yield",
+  },
+  {
+    chainId: 1,
+    address: "0xbEeFCe6c76C7D7A8066562Fe9FF0e343a52dD92F",
+    protocol: "morpho_v1",
+    type: "Prime",
+  },
+  {
+    chainId: 1,
+    address: "0xBEeF47b9F76C9672B967A7b88d0afFf245Be13ad",
+    protocol: "morpho_v1",
+    type: "Prime",
+  },
+  {
+    chainId: 1,
+    address: "0xbEEF8DF2Ce4BaB5420123F9BF80dea4c65673257",
+    protocol: "morpho_v1",
+    type: "High Yield",
+  },
+  {
+    chainId: 1,
+    address: "0xbeeFfF68CC520D68f82641EFF84330C631E2490E",
+    protocol: "morpho_v1",
+    type: "High Yield",
+  },
+  {
+    chainId: 1,
+    address: "0xbEEF36A5C1372F8D7d211527FCE9f83FE02d8A73",
+    protocol: "morpho_v1",
+    type: "High Yield",
+  },
+  {
+    chainId: 1,
+    address: "0xBEeFFF209270748ddd194831b3fa287a5386f5bC",
+    protocol: "morpho_v1",
+    type: "High Yield",
+  },
+  {
+    chainId: 1,
+    address: "0xA0804346780b4c2e3bE118ac957D1DB82F9d7484",
+    protocol: "morpho_v1",
+    type: "High Yield",
+  },
+  {
+    chainId: 1,
+    address: "0x833AdaeF212c5cD3f78906B44bBfb18258F238F0",
+    protocol: "morpho_v1",
+    type: "High Yield",
+  },
+  {
+    chainId: 1,
+    address: "0x6D4e530B8431a52FFDA4516BA4Aadc0951897F8C",
+    protocol: "morpho_v1",
+    type: "High Yield",
+  },
+  {
+    chainId: 1,
+    address: "0xBEEF01735c132Ada46AA9aA4c54623cAA92A64CB",
+    protocol: "morpho_v1",
+    type: "Prime",
+  },
+  {
+    chainId: 1,
+    address: "0xA1b60d96e5C50dA627095B9381dc5a46AF1a9a42",
+    protocol: "morpho_v1",
+    type: "Prime",
+  },
+  {
+    chainId: 1,
+    address: "0x30881Baa943777f92DC934d53D3bFdF33382cab3",
+    protocol: "morpho_v1",
+    type: "Prime",
+  },
+  {
+    chainId: 1,
+    address: "0x097FFEDb80d4b2Ca6105a07a4D90eB739C45A666",
+    protocol: "morpho_v1",
+    type: "Prime",
+  },
+  {
+    chainId: 1,
+    address: "0xbEef047a543E45807105E51A8BBEFCc5950fcfBa",
+    protocol: "morpho_v1",
+    type: "Prime",
+  },
+  {
+    chainId: 1,
+    address: "0xBEefb9f61CC44895d8AEc381373555a64191A9c4",
+    protocol: "morpho_v1",
+    type: "Prime",
+  },
+  {
+    chainId: 1,
+    address: "0xbeEf094333AEdD535c130958c204E84f681FD9FA",
+    protocol: "morpho_v1",
+    type: "Prime",
+  },
+  {
+    chainId: 143,
+    address: "0xbeeffeA75cFC4128ebe10C8D7aE22016D215060D",
+    protocol: "morpho_v2",
+    type: "High Yield",
+  },
+  {
+    chainId: 143,
+    address: "0xbeEFf443C3CbA3E369DA795002243BeaC311aB83",
+    protocol: "morpho_v2",
+    type: "High Yield",
+  },
+  {
+    chainId: 130,
+    address: "0x0993Ae24a988c6925d80aD61344a76B81aA0D34c",
+    protocol: "morpho_v1",
+    type: "Prime",
+  },
+  {
+    chainId: 130,
+    address: "0x9E111aCef0CF3bd8C38715B88e78BE31C1109F8a",
+    protocol: "morpho_v1",
+    type: "Prime",
+  },
+] as const

package/src/metadata/index.ts

@@ -1,3 +1,5 @@
-export { BASE, MAINNET, SUPPORTED_CHAINS } from "./chains.js"
-export type { Address, ChainConfig, VaultConfig, VaultProtocol, VaultTag } from "./types.js"
-export { ALL_VAULTS, BASE_VAULTS, MAINNET_VAULTS } from "./vaults.js"
+export { STEAKHOUSE_VAULTS } from "./generated/vaults.js"
+
+export type { Address, VaultConfig, VaultProtocol, VaultType } from "./types.js"
+
+export { VAULT_TYPES } from "./types.js"

package/src/metadata/types.ts

@@ -1,19 +1,18 @@
-export type Address = `0x${string}`
+import type { VaultProtocol } from "@whisk/graphql"
 
-export type VaultProtocol = "morpho" | "steakhouse"
+export type { VaultProtocol }
+export type Address = `0x${string}`
 
-export type VaultTag = "featured" | "new" | "deprecated"
+/** Valid vault types for categorization */
+export const VAULT_TYPES = ["Prime", "High Yield", "Turbo", "Term"] as const
+export type VaultType = (typeof VAULT_TYPES)[number]
 
+/** Vault configuration with metadata */
 export interface VaultConfig {
+  readonly chainId: number
   readonly address: Address
   readonly protocol: VaultProtocol
   readonly name?: string
   readonly description?: string
-  readonly tag?: VaultTag
-  readonly isHidden?: boolean
-}
-
-export interface ChainConfig {
-  readonly id: number
-  readonly name: string
+  readonly type?: VaultType
 }