@gauntlet-xyz/sdk 2.3.0 → 3.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gauntlet-xyz/sdk",
-  "version": "2.3.0",
+  "version": "3.0.1",
   "description": "Official Gauntlet SDK for vault deposits, withdrawals, and attribution",
   "license": "MIT",
   "keywords": [
@@ -28,12 +28,44 @@
   "types": "./dist/index.d.ts",
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js"
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/index.d.ts",
+        "default": "./dist/cjs/index.js"
+      }
     },
     "./evm": {
-      "types": "./dist/evm/index.d.ts",
-      "import": "./dist/evm/index.js"
+      "import": {
+        "types": "./dist/evm/index.d.ts",
+        "default": "./dist/evm/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/evm/index.d.ts",
+        "default": "./dist/cjs/evm/index.js"
+      }
+    },
+    "./api": {
+      "import": {
+        "types": "./dist/api/index.d.ts",
+        "default": "./dist/api/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/api/index.d.ts",
+        "default": "./dist/cjs/api/index.js"
+      }
+    },
+    "./privy": {
+      "import": {
+        "types": "./dist/privy/index.d.ts",
+        "default": "./dist/privy/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/privy/index.d.ts",
+        "default": "./dist/cjs/privy/index.js"
+      }
     }
   },
   "files": [
@@ -42,14 +74,15 @@
     "manifest"
   ],
   "scripts": {
-    "build": "tsc --project tsconfig.json",
-    "dev": "tsc --project tsconfig.json --watch",
+    "build": "node scripts/build.mjs",
+    "dev": "node scripts/build.mjs --watch",
     "test": "vitest run",
     "test:watch": "vitest",
     "lint": "eslint --ext=tsx,ts,js src && echo-cli '✔ No ESLint warnings or errors'",
     "format": "eslint --fix --quiet --ext=tsx,ts,js src && echo-cli '✔ No ESLint warnings or errors'",
     "typecheck": "npx tsc --noEmit",
-    "clean": "rm -rf dist .turbo"
+    "clean": "rm -rf dist .turbo",
+    "test:node": "node --test tests/package.test.mjs"
   },
   "peerDependencies": {
     "viem": ">=2.0.0"
@@ -62,7 +95,8 @@
     "eslint": "^8.57.0",
     "typescript": "~5.6.3",
     "viem": "2.30.1",
-    "vitest": "^4.1.2"
+    "vitest": "^4.1.2",
+    "esbuild": "^0.25.0"
   },
   "engines": {
     "npm": ">=11.5.1",

package/src/api/client.ts

@@ -12,10 +12,22 @@ export type UserPositionsTimeseriesResponse = Schemas['UserPositionsTimeseriesRe
 export type PositionTimeseriesPoint = Schemas['PositionTimeseriesPoint'];
 export type VaultDetail = Schemas['VaultDetail'];
 export type VaultDetailResponse = Schemas['VaultDetailResponse'];
+export type VaultListResponse = Schemas['VaultListResponse'];
+export type VaultAllocations = Schemas['VaultAllocations'];
+export type VaultAllocationsResponse = Schemas['VaultAllocationsResponse'];
 export type VaultTimeseriesResponse = Schemas['VaultTimeseriesResponse'];
+export type VaultGroupTimeseriesResponse = Schemas['VaultGroupTimeseriesResponse'];
+export type VaultGroupTimeseriesPoint = Schemas['VaultGroupTimeseriesPoint'];
 export type VaultTimeseriesPoint = Schemas['VaultTimeseriesPoint'];
 export type VaultMetrics = Schemas['VaultMetrics'];
+export type FeaturedVault = Schemas['FeaturedVault'];
+export type FeaturedVaultsResponse = Schemas['FeaturedVaultsResponse'];
+export type StrategyCard = Schemas['StrategyCard'];
+export type StrategyListResponse = Schemas['StrategyListResponse'];
 export type TvlResponse = Schemas['TvlResponse'];
+export type TvlBreakdownMode = Schemas['TvlBreakdownMode'];
+export type TvlTimeseriesResponse = Schemas['TvlTimeseriesResponse'];
+export type TvlTimeseriesPoint = Schemas['TvlTimeseriesPoint'];
 export type LatestPriceResponse = Schemas['LatestPriceResponse'];
 export type PriceTimeseriesResponse = Schemas['TimeseriesResponse'];
 export type TokenRef = Schemas['TokenRef'];
@@ -42,6 +54,28 @@ export interface TimeWindowOptions extends PageOptions {
 export interface ActivityOptions extends PageOptions {
   /** CAIP-10 vault id (`"{chainId}:{address}"`). Omit for wallet-wide activity. */
   vaultId?: string;
+  /**
+   * Wallet-wide feeds only: include activity in hidden (enabled but unlisted)
+   * vaults alongside visible ones. Activity in disabled vaults is never
+   * returned. Ignored when `vaultId` is set.
+   */
+  includeHidden?: boolean;
+}
+
+export interface PositionsOptions extends PageOptions {
+  /**
+   * Include positions in hidden (enabled but unlisted) vaults alongside
+   * visible ones. Positions in disabled vaults are never returned.
+   */
+  includeHidden?: boolean;
+}
+
+export interface VaultsOptions extends PageOptions {
+  /**
+   * Include hidden (enabled but unlisted) vaults alongside visible ones.
+   * Disabled vaults are never listed.
+   */
+  includeHidden?: boolean;
 }
 
 export interface LatestPriceOptions {
@@ -99,8 +133,47 @@ export class GauntletApi {
   }
 
   /** GET /v1/vaults — all indexed vaults with live metrics (TVL, APY, unit price). */
-  vaults(options: PageOptions = {}): Promise<{ data: VaultDetail[]; meta: TimeseriesMeta }> {
-    return this.get('/v1/vaults', { next: options.next, limit: options.limit });
+  vaults(options: VaultsOptions = {}): Promise<{ data: VaultDetail[]; meta: TimeseriesMeta }> {
+    return this.get('/v1/vaults', {
+      next: options.next,
+      limit: options.limit,
+      include_hidden: options.includeHidden,
+    });
+  }
+
+  /** GET /v1/vaults/slug/{slug} — all enabled deployments for one exact vault slug. */
+  vaultsBySlug(slug: string): Promise<VaultListResponse> {
+    return this.get(`/v1/vaults/slug/${encodeURIComponent(slug)}`);
+  }
+
+  /** GET /v1/vaults/slug/{slug}/timeseries — aggregate USD TVL and supply, plus primary-deployment metrics.
+   * APY and unit price come from meta.resolved_vault_id; null marks missing data.
+   */
+  vaultTimeseriesBySlug(
+    slug: string,
+    options: TimeWindowOptions = {}
+  ): Promise<VaultGroupTimeseriesResponse> {
+    return this.get(`/v1/vaults/slug/${encodeURIComponent(slug)}/timeseries`, { ...options });
+  }
+
+  /** GET /v1/vaults/slug/{slug}/primary/timeseries — primary deployment history. */
+  primaryVaultTimeseriesBySlug(
+    slug: string,
+    options: TimeWindowOptions = {}
+  ): Promise<VaultTimeseriesResponse> {
+    return this.get(`/v1/vaults/slug/${encodeURIComponent(slug)}/primary/timeseries`, {
+      ...options,
+    });
+  }
+
+  /** GET /v1/vaults/featured — admin-curated featured vault cards. */
+  featuredVaults(): Promise<FeaturedVaultsResponse> {
+    return this.get('/v1/vaults/featured');
+  }
+
+  /** GET /v1/strategies — admin-curated strategy cards. */
+  strategies(): Promise<StrategyListResponse> {
+    return this.get('/v1/strategies');
   }
 
   /** GET /v1/vaults/{vault_id} — one vault with live metrics. `vaultId` is CAIP-10. */
@@ -113,6 +186,11 @@ export class GauntletApi {
     return this.get(`/v1/vaults/${encodeURIComponent(vaultId)}/definition`);
   }
 
+  /** GET /v1/vaults/{vault_id}/allocations — current Aera allocations with source lineage. */
+  vaultAllocations(vaultId: string): Promise<VaultAllocationsResponse> {
+    return this.get(`/v1/vaults/${encodeURIComponent(vaultId)}/allocations`);
+  }
+
   /** GET /v1/vaults/{vault_id}/timeseries — TVL / unit-price / APY history. */
   vaultTimeseries(
     vaultId: string,
@@ -122,10 +200,14 @@ export class GauntletApi {
   }
 
   /** GET /v1/users/{wallet}/positions — all of a wallet's indexed positions with PnL. */
-  positions(walletAddress: string, options: PageOptions = {}): Promise<UserAllPositionsResponse> {
+  positions(
+    walletAddress: string,
+    options: PositionsOptions = {}
+  ): Promise<UserAllPositionsResponse> {
     return this.get(`/v1/users/${encodeURIComponent(walletAddress)}/positions`, {
       next: options.next,
       limit: options.limit,
+      include_hidden: options.includeHidden,
     });
   }
 
@@ -150,9 +232,10 @@ export class GauntletApi {
 
   /** GET /v1/users/{wallet}/activity — one page of the wallet's immutable event log. */
   activity(walletAddress: string, options: ActivityOptions = {}): Promise<UserActivityResponse> {
-    const { vaultId, ...page } = options;
+    const { vaultId, includeHidden, ...page } = options;
     return this.get(`/v1/users/${encodeURIComponent(walletAddress)}/activity`, {
       vault_id: vaultId,
+      include_hidden: includeHidden,
       ...page,
     });
   }
@@ -173,9 +256,23 @@ export class GauntletApi {
     } while (next);
   }
 
-  /** GET /v1/tvl — aggregate Gauntlet TVL, optionally with per-source breakdown. */
-  tvl(options: { includeBreakdown?: boolean } = {}): Promise<TvlResponse> {
-    return this.get('/v1/tvl', { include_breakdown: options.includeBreakdown });
+  /**
+   * GET /v1/tvl — aggregate Gauntlet TVL. Pass `mode` for a `breakdown`:
+   * `chain` for one row per chain, `strategy` for one row per curated
+   * strategy. Omit it for the headline totals only.
+   */
+  tvl(options: { mode?: TvlBreakdownMode } = {}): Promise<TvlResponse> {
+    return this.get('/v1/tvl', { mode: options.mode });
+  }
+
+  /**
+   * GET /v1/tvl/timeseries — daily aggregate Gauntlet TVL over a fixed
+   * 3-month trailing window. `mode` partitions each point's `sources` the
+   * same way `tvl()` partitions its `breakdown`; a point's total never
+   * depends on it.
+   */
+  tvlTimeseries(options: { mode?: TvlBreakdownMode } = {}): Promise<TvlTimeseriesResponse> {
+    return this.get('/v1/tvl/timeseries', { mode: options.mode });
   }
 
   /** GET /v1/prices — latest USD price for a token. */