@gauntlet-xyz/sdk 2.5.0 → 3.1.1

package/src/api/generated.ts

@@ -113,7 +113,7 @@ export interface paths {
         };
         /**
          * Get live aggregate TVL
-         * @description Returns live aggregate Gauntlet TVL composed from indexed Gaia vault data and configured external TVL sources. Source totals are always returned; pass `?include_breakdown=true` for chain and external-source explainability rows.
+         * @description Returns live aggregate Gauntlet TVL composed from indexed Gaia vault data and configured external TVL sources. `totals` always carries three coarse tranches: `vault_curation` (indexed non-Aera vaults, Symbiotic and Solana), `aera_v2` and `aera` (Aera V3). The `vault_curation` row spans several protocols. The Aera generations are separate product lines, not part of `vault_curation`. Pass `?mode=chain` for one `breakdown` row per chain, `?mode=protocol` for rows that map to Aera, Morpho V1, Morpho V2, Lista, Kamino and curated Symbiotic TVL, or `?mode=strategy` for one row per curated strategy from the admin registry, with indexed vaults no strategy claims under `uncategorized`. Protocol mode combines Aera V2 and V3 as `aera` and names the Solana source `kamino`. Symbiotic reads onchain `activeStake()`. Other modes keep these sources separate. The rows always sum to the headline total. Without `mode` no `breakdown` is returned.
          */
         get: operations["get_tvl"];
         put?: never;
@@ -124,6 +124,30 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/tvl/timeseries": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get the daily aggregate TVL timeseries
+         * @description Returns a fixed trailing 3-month daily series of aggregate Gauntlet TVL. Without `mode` each point's `sources` carry the same three coarse tranches the live `/v1/tvl` totals report: `vault_curation` (indexed non-Aera vaults, Symbiotic and Solana), `aera_v2` and `aera` (Aera V3). Pass `?mode=strategy` for a per-point `sources` breakdown with one entry per curated strategy (`prime_lending`, `balanced_lending`, `frontier_lending`, …), or `?mode=chain` for one entry per chain, or `?mode=protocol` for one entry per tracked vault protocol; indexed vaults that no curated strategy claims roll up under `uncategorized`. Protocol mode combines Aera V2 and V3 as `aera` and names the Solana source `kamino`. Other modes keep `aera` (Aera V3), `aera_v2`, `solana` and `symbiotic` as separate rows. The last three come from the `tvl_history` table. The hourly TVL job writes them. Symbiotic history starts with the first recorded snapshot. The rest is derived at read time from indexed Envio vault history plus historical USD pricing. Every point carries the same source ids in the same order, and they sum to that point's total, which does not depend on `mode`. A day with no data for a source contributes 0 to that day's total rather than carrying the last known value forward.
+         *
+         *     Served from a cached snapshot that is refreshed off the request path, so no caller pays for a recompute. `meta.data_as_of` is set when the snapshot is past its refresh window and a refresh is running behind the response; it is absent when the series is current.
+         *
+         *     A numeraire token with no USD price for part of the window is named in `meta.partial_errors`, and the balances it backs are excluded from the totals on those days. `TOKEN_PRICE_UNAVAILABLE` is a gap that should close, so it is retried on the next read; `TOKEN_PRICE_UNAVAILABLE_ACCEPTED` is one that cannot, with the reason in its message. Both mean the totals are short by that token; only the first is worth alerting on.
+         */
+        get: operations["get_tvl_timeseries"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/users/{wallet_address}/activity": {
         parameters: {
             query?: never;
@@ -256,6 +280,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/vaults/{vault_id}/allocations": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get current vault allocations
+         * @description Returns current allocations through a Gaia-owned, source-independent contract. Aera API is the initial source, but its metric-group schema is normalized into flat allocation values with discriminated targets. Use `/{vault_id}` or `/{vault_id}/timeseries` for vault-level metrics.
+         */
+        get: operations["get_vault_allocations"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/vaults/{vault_id}/definition": {
         parameters: {
             query?: never;
@@ -316,10 +360,106 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/vaults/slug/{slug}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get vault deployments by slug
+         * @description Returns every indexed deployment associated with one exact Admin vault slug. The lookup serves visible and hidden enabled vaults without making hidden vaults enumerable; disabled and unknown slugs return 404. Each item has the same shape as an item from `GET /v1/vaults`.
+         */
+        get: operations["get_vaults_by_slug"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/vaults/slug/{slug}/primary/timeseries": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get primary deployment timeseries by vault slug
+         * @description Returns historical metric data for the Admin-selected primary deployment of an enabled logical vault. `meta.resolved_vault_id` identifies the concrete deployment. The response and query parameters are otherwise identical to `/{vault_id}/timeseries`; use this route when callers know the stable public vault slug but should not depend on its current chain or address.
+         */
+        get: operations["get_primary_vault_timeseries_by_slug"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/vaults/slug/{slug}/timeseries": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get vault history by slug
+         * @description Returns USD TVL and outstanding share supply summed across every currently linked deployment of an enabled logical vault, including hidden vaults. Uses UTC-aligned snapshots and timestamp pagination. A deployment contributes zero before its indexed creation time; after creation, missing snapshots or USD prices produce null TVL, never a partial sum. Does not carry values forward. Missing supply or a missing snapshot after deployment creation produces null total_supply, independent of USD price availability. APY and unit_price come from the Admin-selected primary deployment at the same timestamp, identified by meta.resolved_vault_id. Missing primary snapshots yield null primary metrics; APY respects Admin visibility. TVL is USD-only because deployment numeraires may differ; native TVL remains available on the primary/per-deployment endpoints. This is a sum of deployment TVLs, not the legacy asset-position valuation. Unknown or disabled slugs return 404; incomplete deployment metadata returns 503.
+         */
+        get: operations["get_vault_timeseries_by_slug"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
 }
 export type webhooks = Record<string, never>;
 export interface components {
     schemas: {
+        Allocation: {
+            /**
+             * Format: double
+             * @description Fraction of the parent vault allocated to this target (1.0 = 100%).
+             */
+            allocation?: number | null;
+            /** Format: double */
+            amount?: number | null;
+            /** Format: double */
+            amount_usd?: number | null;
+            /** @description Source-independent category used by consumers to select allocation sections. */
+            category: string;
+            target: components["schemas"]["AllocationTarget"];
+        };
+        AllocationFlow: {
+            kind: components["schemas"]["AllocationFlowKind"];
+            target_vault_address: string;
+        };
+        /** @enum {string} */
+        AllocationFlowKind: "pending_deposit" | "pending_redemption";
+        AllocationProtocol: {
+            id: string;
+            name: string;
+        };
+        AllocationTarget: {
+            address: string;
+            /** Format: int64 */
+            chain_id: number;
+            flow?: null | components["schemas"]["AllocationFlow"];
+            /** @enum {string} */
+            kind: "asset";
+            name?: string | null;
+            protocol?: null | components["schemas"]["AllocationProtocol"];
+            strategy_type: string;
+            symbol: string;
+        };
         /**
          * @description Decimal-string metric paired across native (numeraire-token) and USD.
          *     `native` is always present; `usd` is JSON null when pricing is unavailable.
@@ -376,7 +516,8 @@ export interface components {
             /**
              * Format: double
              * @description Highest 7-day APY across the vault's deployments, fraction
-             *     (0.0573 = 5.73%). `null` while every window is warming up.
+             *     (0.0573 = 5.73%). `null` while every window is warming up or APY
+             *     display is disabled for this vault.
              */
             apy_7d_max?: number | null;
             /**
@@ -516,6 +657,20 @@ export interface components {
             /** Format: double */
             usd: number;
         };
+        /**
+         * @description Deployment-local metrics. Null when the primary has no snapshot at this
+         *     timestamp; APY also respects the Admin visibility setting.
+         */
+        PrimaryVaultTimeseriesMetrics: {
+            /** Format: double */
+            apy_7d?: number | null;
+            /** Format: double */
+            apy_30d?: number | null;
+            /** Format: double */
+            apy_90d?: number | null;
+            /** @description Numeraire-token units per share on the primary deployment. */
+            unit_price?: string | null;
+        };
         /**
          * @description JSON-number ratio paired across native (in-kind) and USD denominations.
          *     Null when event history is unavailable or cannot support ROI replay.
@@ -531,7 +686,8 @@ export interface components {
              * Format: double
              * @description Highest 7-day APY across the strategy's vaults ("APY Up To"),
              *     fraction (0.0953 = 9.53%). `null` while every vault's window is
-             *     still warming up.
+             *     still warming up. Vaults with APY display disabled do not
+             *     contribute to this aggregate.
              */
             apy_7d_max?: number | null;
             /**
@@ -612,6 +768,12 @@ export interface components {
             /** Format: date-time */
             refreshed_at: string;
             request_id: string;
+            /**
+             * @description Primary deployment selected for deployment-local metrics by a slug
+             *     route. The aggregate slug route still sums TVL and supply across deployments.
+             *     Omitted when the deployment is already identified in the request path.
+             */
+            resolved_vault_id?: string | null;
             /**
              * Format: date-time
              * @description Window bounds the response covers (echoes the request when set).
@@ -642,6 +804,12 @@ export interface components {
             /** Format: date-time */
             updated_at: string;
         };
+        /**
+         * @description Which partition of indexed vault TVL the caller asked for. Absent
+         *     from a request means the headline figures only, with no breakdown.
+         * @enum {string}
+         */
+        TvlBreakdownMode: "chain" | "strategy" | "protocol";
         TvlResponse: {
             data: components["schemas"]["TvlSummary"];
             meta: components["schemas"]["BasicMeta"];
@@ -653,6 +821,33 @@ export interface components {
             /** Format: date-time */
             updated_at: string;
         };
+        TvlTimeseriesPoint: {
+            /**
+             * @description The day's breakdown. `?mode=` picks how it is partitioned; the
+             *     total above never depends on that choice.
+             */
+            sources: components["schemas"]["TvlTimeseriesSourceAmount"][];
+            /** Format: date-time */
+            timestamp: string;
+            tvl: components["schemas"]["TvlAmount"];
+        };
+        TvlTimeseriesResponse: {
+            data: components["schemas"]["TvlTimeseriesPoint"][];
+            meta: components["schemas"]["WindowMeta"];
+        };
+        /**
+         * @description One series of the day's breakdown. `id` is a curated strategy id
+         *     (`prime_lending`, `balanced_lending`, `frontier_lending`, …) in
+         *     `mode=strategy`, an admin chain slug (`ethereum`, `base`, …) in
+         *     `mode=chain`, or one of the reserved ids `aera`, `aera_v2`,
+         *     `solana`, `uncategorized`. Every point carries the same ids in the
+         *     same order, and they sum to the point's `tvl`.
+         */
+        TvlTimeseriesSourceAmount: {
+            id: string;
+            label: string;
+            tvl: components["schemas"]["TvlAmount"];
+        };
         TvlTotal: {
             id: string;
             label: string;
@@ -806,6 +1001,16 @@ export interface components {
             data: components["schemas"]["PositionTimeseriesPoint"][];
             meta: components["schemas"]["TimeseriesMeta"];
         };
+        VaultAllocations: {
+            allocations: components["schemas"]["Allocation"][];
+            /** Format: date-time */
+            as_of?: string | null;
+            vault_id: string;
+        };
+        VaultAllocationsResponse: {
+            data: components["schemas"]["VaultAllocations"];
+            meta: components["schemas"]["BasicMeta"];
+        };
         VaultDetail: {
             address: string;
             /** Format: int64 */
@@ -815,6 +1020,12 @@ export interface components {
             name: string;
             numeraire_token: components["schemas"]["TokenRef"];
             strategy?: null | components["schemas"]["StrategyRef"];
+            /**
+             * @description CAIP id of the vault that replaces this one on the same chain
+             *     (Morpho V1 to V2 today); `null` when there is no visible
+             *     successor. Consumers use it to point holders at the new vault.
+             */
+            successor_vault_id?: string | null;
             symbol: string;
             vault_id: string;
             vault_type: string;
@@ -838,6 +1049,24 @@ export interface components {
             /** @description Unique, curator-managed public route (`stgusda`). */
             slug: string;
         };
+        VaultGroupTimeseriesPoint: components["schemas"]["PrimaryVaultTimeseriesMetrics"] & {
+            /** Format: date-time */
+            timestamp: string;
+            /**
+             * @description Outstanding shares summed across linked deployments. Null if an existing
+             *     deployment has a missing snapshot or supply; independent of USD pricing.
+             */
+            total_supply?: string | null;
+            /**
+             * @description Sum across all linked deployments. Null if an existing deployment
+             *     has a missing snapshot or USD price; never a partial sum.
+             */
+            tvl: components["schemas"]["CuratedTvl"];
+        };
+        VaultGroupTimeseriesResponse: {
+            data: components["schemas"]["VaultGroupTimeseriesPoint"][];
+            meta: components["schemas"]["TimeseriesMeta"];
+        };
         VaultListResponse: {
             data: components["schemas"]["VaultDetail"][];
             meta: components["schemas"]["ListMeta"];
@@ -872,6 +1101,39 @@ export interface components {
             data: components["schemas"]["VaultTimeseriesPoint"][];
             meta: components["schemas"]["TimeseriesMeta"];
         };
+        /**
+         * @description Doc type for a windowed timeseries served as one fixed grid: every
+         *     point in the window, so there is no page cap and no cursor. Split
+         *     from [`TimeseriesMeta`], whose required `limit` those handlers leave
+         *     `None`. That would put a never-populated required field in the
+         *     generated SDK types.
+         */
+        WindowMeta: {
+            /**
+             * Format: int64
+             * @description Number of points in this response.
+             */
+            count: number;
+            /**
+             * Format: date-time
+             * @description When the served data was computed, on endpoints that serve a
+             *     cached snapshot past its refresh window while a refresh runs
+             *     behind the response. Absent means the data is current.
+             */
+            data_as_of?: string | null;
+            /** Format: date-time */
+            end: string;
+            /** @description Item-scoped failures isolated from an aggregate response. */
+            partial_errors?: components["schemas"]["PartialResponseError"][] | null;
+            /** Format: date-time */
+            refreshed_at: string;
+            request_id: string;
+            /**
+             * Format: date-time
+             * @description Window bounds the response covers.
+             */
+            start: string;
+        };
     };
     responses: never;
     parameters: never;
@@ -1037,10 +1299,8 @@ export interface operations {
     get_tvl: {
         parameters: {
             query?: {
-                /** @description Include chain and external-source TVL breakdown rows. */
-                include_breakdown?: boolean;
-                /** @description Deprecated alias for include_breakdown. */
-                include_sources?: boolean;
+                /** @description Breakdown to return: `chain`, `protocol` or `strategy`. Omit for the headline figures only. */
+                mode?: components["schemas"]["TvlBreakdownMode"];
             };
             header?: never;
             path?: never;
@@ -1077,6 +1337,47 @@ export interface operations {
             };
         };
     };
+    get_tvl_timeseries: {
+        parameters: {
+            query?: {
+                /** @description Per-point breakdown to return: `chain`, `protocol` or `strategy`. Omit for the daily total only. */
+                mode?: components["schemas"]["TvlBreakdownMode"];
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Daily aggregate TVL timeseries */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["TvlTimeseriesResponse"];
+                };
+            };
+            /** @description Missing or invalid auth */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Data source unavailable */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+        };
+    };
     get_user_activity: {
         parameters: {
             query?: {
@@ -1362,6 +1663,74 @@ export interface operations {
             };
         };
     };
+    get_vault_allocations: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Vault identifier (CAIP-10 `chainId:address`) */
+                vault_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Current vault allocations */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["VaultAllocationsResponse"];
+                };
+            };
+            /** @description Missing or invalid auth */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Vault not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Invalid vault identifier or non-Aera vault */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Allocation data source unavailable */
+            502: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Vault metadata source unavailable */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+        };
+    };
     get_vault_definition: {
         parameters: {
             query?: never;
@@ -1502,4 +1871,198 @@ export interface operations {
             };
         };
     };
+    get_vaults_by_slug: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Admin-curated public vault slug */
+                slug: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Deployments for the vault slug */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["VaultListResponse"];
+                };
+            };
+            /** @description Missing or invalid auth */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Vault slug not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Data source unavailable */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+        };
+    };
+    get_primary_vault_timeseries_by_slug: {
+        parameters: {
+            query?: {
+                /** @description Window end: ISO 8601 date or RFC 3339 timestamp. */
+                end?: string;
+                /** @description Sampling granularity: `day` (default), `hour`, `week`, or `month`. */
+                granularity?: string;
+                /** @description Page size (1–10000, default 1000). */
+                limit?: number;
+                /** @description Opaque cursor from previous `meta.next_cursor`. */
+                next?: string;
+                /** @description Sort direction: `asc` (default) or `desc`. */
+                order?: string;
+                /** @description Window start: ISO 8601 date or RFC 3339 timestamp. */
+                start?: string;
+            };
+            header?: never;
+            path: {
+                /** @description Admin-curated public vault slug */
+                slug: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Primary deployment timeseries data points */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["VaultTimeseriesResponse"];
+                };
+            };
+            /** @description Missing or invalid auth */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Vault slug not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Invalid parameters */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Data source or vault curation unavailable */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+        };
+    };
+    get_vault_timeseries_by_slug: {
+        parameters: {
+            query?: {
+                /** @description Window end: ISO 8601 date or RFC 3339 timestamp. */
+                end?: string;
+                /** @description Sampling granularity: `day` (default), `hour`, `week`, or `month`. */
+                granularity?: string;
+                /** @description Page size (1–10000, default 1000). */
+                limit?: number;
+                /** @description Opaque cursor from previous `meta.next_cursor`. */
+                next?: string;
+                /** @description Sort direction: `asc` (default) or `desc`. */
+                order?: string;
+                /** @description Window start: ISO 8601 date or RFC 3339 timestamp. */
+                start?: string;
+            };
+            header?: never;
+            path: {
+                /** @description Admin-curated public vault slug */
+                slug: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Aggregate USD TVL and share supply with primary deployment metrics */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["VaultGroupTimeseriesResponse"];
+                };
+            };
+            /** @description Missing or invalid auth */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Vault slug not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Invalid parameters */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Data source or vault curation unavailable */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+        };
+    };
 }