@aegis-engine/core 0.1.3 → 0.2.0

package/dist/contract/generated/aegis-swap.d.ts

@@ -0,0 +1,720 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export interface paths {
+    "/v1/health": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Liveness check */
+        get: operations["getHealth"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/config": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get swap policy and static config
+         * @description Returns the chain list, contract registry, router and spender allowlists, quote defaults, and output fee policy that clients enforce before signing.
+         */
+        get: operations["getConfig"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/tokens": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** List curated tokens for a chain */
+        get: operations["listTokens"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/tokens/by-address": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List curated tokens by address
+         * @description Filters curated token metadata to the requested comma-separated EVM token addresses. Matching is case-insensitive and unknown addresses are omitted.
+         */
+        get: operations["listTokensByAddress"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/markets": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List curated Aegis swap markets for a chain
+         * @description Returns the backend-owned source of truth for market status, labels, pool keys, display metrics, and warnings. Metrics are display data and are not execution inputs.
+         */
+        get: operations["listMarkets"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/swap/quote": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Create an indicative swap quote
+         * @description Returns a fast, non-executable price estimate for first paint. Clients must re-quote on-chain before building or signing a transaction. Only aegis-direct-v4 markets are quoted by this backend; Kyber is quoted client-side.
+         */
+        post: operations["createIndicativeSwapQuote"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/openapi.json": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Get this OpenAPI document */
+        get: operations["getOpenApiSpec"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+}
+export type webhooks = Record<string, never>;
+export interface components {
+    schemas: {
+        /**
+         * @example 130
+         * @enum {string}
+         */
+        ChainIdQuery: "1" | "130" | "8453";
+        HealthResponse: {
+            /** @enum {boolean} */
+            ok: true;
+        };
+        ErrorResponse: {
+            error: string;
+        };
+        ServerErrorResponse: {
+            error: string;
+            details: string;
+        };
+        SwapChain: {
+            /**
+             * @example 130
+             * @enum {integer}
+             */
+            chainId: 1 | 130 | 8453;
+            slug: string;
+            name: string;
+        };
+        QuoteDefaults: {
+            /** @enum {number} */
+            ttlSeconds: 15;
+            /** @enum {number} */
+            defaultSlippageBps: 100;
+            /** @enum {number} */
+            maxSlippageBps: 2000;
+        };
+        SwapContracts: {
+            aegisRouter?: string;
+            permit2?: string;
+            v4Quoter?: string;
+            v4PoolManager?: string;
+        };
+        SwapContractsByChain: {
+            1: {
+                aegisRouter?: string;
+                permit2?: string;
+                v4Quoter?: string;
+                v4PoolManager?: string;
+            };
+            130: {
+                aegisRouter?: string;
+                permit2?: string;
+                v4Quoter?: string;
+                v4PoolManager?: string;
+            };
+            8453: {
+                aegisRouter?: string;
+                permit2?: string;
+                v4Quoter?: string;
+                v4PoolManager?: string;
+            };
+        };
+        SwapAllowlists: {
+            routers: string[];
+            spenders: string[];
+        };
+        SwapAllowlistsByChain: {
+            1: {
+                routers: string[];
+                spenders: string[];
+            };
+            130: {
+                routers: string[];
+                spenders: string[];
+            };
+            8453: {
+                routers: string[];
+                spenders: string[];
+            };
+        };
+        SwapFee: {
+            /** @enum {number} */
+            outputFeeBps: 50;
+            /** @enum {string} */
+            recipient: "0x8ea2C7de60ef1Cd4dcE64ea2DDDe2f99F0127eFC";
+        };
+        SwapConfig: {
+            /** @enum {string} */
+            schemaVersion: "1";
+            chains: {
+                /**
+                 * @example 130
+                 * @enum {integer}
+                 */
+                chainId: 1 | 130 | 8453;
+                slug: string;
+                name: string;
+            }[];
+            providers: ("aegis-direct-v4" | "kyber")[];
+            quote: {
+                /** @enum {number} */
+                ttlSeconds: 15;
+                /** @enum {number} */
+                defaultSlippageBps: 100;
+                /** @enum {number} */
+                maxSlippageBps: 2000;
+            };
+            contracts: {
+                1: {
+                    aegisRouter?: string;
+                    permit2?: string;
+                    v4Quoter?: string;
+                    v4PoolManager?: string;
+                };
+                130: {
+                    aegisRouter?: string;
+                    permit2?: string;
+                    v4Quoter?: string;
+                    v4PoolManager?: string;
+                };
+                8453: {
+                    aegisRouter?: string;
+                    permit2?: string;
+                    v4Quoter?: string;
+                    v4PoolManager?: string;
+                };
+            };
+            allowlists: {
+                1: {
+                    routers: string[];
+                    spenders: string[];
+                };
+                130: {
+                    routers: string[];
+                    spenders: string[];
+                };
+                8453: {
+                    routers: string[];
+                    spenders: string[];
+                };
+            };
+            fee: {
+                /** @enum {number} */
+                outputFeeBps: 50;
+                /** @enum {string} */
+                recipient: "0x8ea2C7de60ef1Cd4dcE64ea2DDDe2f99F0127eFC";
+            };
+        };
+        Token: {
+            id: string;
+            /**
+             * @example 130
+             * @enum {integer}
+             */
+            chainId: 1 | 130 | 8453;
+            address: string;
+            symbol: string;
+            displayName: string;
+            fullName: string;
+            decimals: number;
+            priceUsd: number;
+            iconUrl: string;
+            stable: boolean;
+        };
+        TokenList: {
+            id: string;
+            /**
+             * @example 130
+             * @enum {integer}
+             */
+            chainId: 1 | 130 | 8453;
+            address: string;
+            symbol: string;
+            displayName: string;
+            fullName: string;
+            decimals: number;
+            priceUsd: number;
+            iconUrl: string;
+            stable: boolean;
+        }[];
+        PoolKey: {
+            currency0: string;
+            currency1: string;
+            /**
+             * @description Uniswap v4 fee value. 8388608 indicates dynamic fee.
+             * @example 8388608
+             */
+            fee: number;
+            tickSpacing: number;
+            hooks: string;
+        };
+        MarketMetrics: {
+            tvlUsd: number;
+            volumeUsd7d: number;
+            feeApr7d: number;
+        };
+        Market: {
+            id: string;
+            /**
+             * @example 130
+             * @enum {integer}
+             */
+            chainId: 1 | 130 | 8453;
+            /** @enum {string} */
+            status: "enabled" | "disabled";
+            /** @enum {string} */
+            kind: "aegis-direct-v4";
+            label: string;
+            baseToken: string;
+            quoteToken: string;
+            /** @example 0x9073b65a558bdf9d0d7d0c82b468128acb847de72f5ad776bd8a4aab98781584 */
+            poolId: string;
+            poolKey: {
+                currency0: string;
+                currency1: string;
+                /**
+                 * @description Uniswap v4 fee value. 8388608 indicates dynamic fee.
+                 * @example 8388608
+                 */
+                fee: number;
+                tickSpacing: number;
+                hooks: string;
+            };
+            metrics: {
+                tvlUsd: number;
+                volumeUsd7d: number;
+                feeApr7d: number;
+            };
+            warnings: ("paused" | "surge-active" | "cap-event")[];
+        };
+        MarketList: {
+            id: string;
+            /**
+             * @example 130
+             * @enum {integer}
+             */
+            chainId: 1 | 130 | 8453;
+            /** @enum {string} */
+            status: "enabled" | "disabled";
+            /** @enum {string} */
+            kind: "aegis-direct-v4";
+            label: string;
+            baseToken: string;
+            quoteToken: string;
+            /** @example 0x9073b65a558bdf9d0d7d0c82b468128acb847de72f5ad776bd8a4aab98781584 */
+            poolId: string;
+            poolKey: {
+                currency0: string;
+                currency1: string;
+                /**
+                 * @description Uniswap v4 fee value. 8388608 indicates dynamic fee.
+                 * @example 8388608
+                 */
+                fee: number;
+                tickSpacing: number;
+                hooks: string;
+            };
+            metrics: {
+                tvlUsd: number;
+                volumeUsd7d: number;
+                feeApr7d: number;
+            };
+            warnings: ("paused" | "surge-active" | "cap-event")[];
+        }[];
+        SwapQuoteRequest: ({
+            /**
+             * @example 130
+             * @enum {integer}
+             */
+            chainId: 1 | 130 | 8453;
+            /**
+             * @example aegis-direct-v4
+             * @enum {string}
+             */
+            provider: "aegis-direct-v4" | "kyber";
+            marketId?: string;
+            tokenIn: string;
+            tokenOut: string;
+            /** @default 100 */
+            slippageBps: number;
+            account?: string | null;
+            /** @enum {string} */
+            mode: "exactIn";
+            /** @description Raw integer token amount in tokenIn base units. */
+            amountIn: string;
+        } & {
+            [key: string]: unknown;
+        }) | ({
+            /**
+             * @example 130
+             * @enum {integer}
+             */
+            chainId: 1 | 130 | 8453;
+            /**
+             * @example aegis-direct-v4
+             * @enum {string}
+             */
+            provider: "aegis-direct-v4" | "kyber";
+            marketId?: string;
+            tokenIn: string;
+            tokenOut: string;
+            /** @default 100 */
+            slippageBps: number;
+            account?: string | null;
+            /** @enum {string} */
+            mode: "exactOut";
+            /** @description Raw integer token amount in tokenOut base units. */
+            amountOut: string;
+        } & {
+            [key: string]: unknown;
+        });
+        SwapQuoteResponse: {
+            /** @enum {boolean} */
+            indicative: true;
+            /** @enum {boolean} */
+            executable: false;
+            /** @enum {string} */
+            provider: "aegis-direct-v4";
+            marketId: string;
+            /** @enum {string} */
+            mode: "exactIn";
+            tokenIn: string;
+            tokenOut: string;
+            amountIn: string;
+            amountOut: string;
+            minAmountOut: string;
+            price: number;
+            slippageBps: number;
+            fee: {
+                /** @enum {number} */
+                outputFeeBps: 50;
+                /** @enum {string} */
+                recipient: "0x8ea2C7de60ef1Cd4dcE64ea2DDDe2f99F0127eFC";
+            };
+            /**
+             * Format: date-time
+             * @example 2026-06-19T11:31:32.964Z
+             */
+            asOf: string;
+            warnings: string[];
+        };
+        OpenApiDocument: {
+            openapi: string;
+            info: {
+                [key: string]: unknown;
+            };
+            paths: {
+                [key: string]: unknown;
+            };
+        } & {
+            [key: string]: unknown;
+        };
+    };
+    responses: {
+        /** @description Missing or invalid request parameters */
+        BadRequest: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components["schemas"]["ErrorResponse"];
+            };
+        };
+        /** @description Requested resource was not found */
+        NotFound: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components["schemas"]["ErrorResponse"];
+            };
+        };
+        /** @description Server error */
+        ServerError: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components["schemas"]["ServerErrorResponse"];
+            };
+        };
+    };
+    parameters: {
+        /**
+         * @description EVM chain ID as a string query parameter. JSON response bodies use numeric chainId values.
+         * @example 130
+         */
+        ChainIdQuery: components["schemas"]["ChainIdQuery"];
+        /**
+         * @description Comma-separated EVM token addresses.
+         * @example 0x078d782b760474a361dda0af3839290b0ef57ad6,0x83f31af747189c2fa9e5deb253200c505eff6ed2
+         */
+        AddressesQuery: string;
+    };
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+export type $defs = Record<string, never>;
+export interface operations {
+    getHealth: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description API liveness status */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HealthResponse"];
+                };
+            };
+            404: components["responses"]["NotFound"];
+            500: components["responses"]["ServerError"];
+        };
+    };
+    getConfig: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Swap config */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SwapConfig"];
+                };
+            };
+            404: components["responses"]["NotFound"];
+            500: components["responses"]["ServerError"];
+        };
+    };
+    listTokens: {
+        parameters: {
+            query: {
+                /**
+                 * @description EVM chain ID as a string query parameter. JSON response bodies use numeric chainId values.
+                 * @example 130
+                 */
+                chainId: components["parameters"]["ChainIdQuery"];
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Curated token metadata */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["TokenList"];
+                };
+            };
+            400: components["responses"]["BadRequest"];
+            500: components["responses"]["ServerError"];
+        };
+    };
+    listTokensByAddress: {
+        parameters: {
+            query: {
+                /**
+                 * @description EVM chain ID as a string query parameter. JSON response bodies use numeric chainId values.
+                 * @example 130
+                 */
+                chainId: components["parameters"]["ChainIdQuery"];
+                /**
+                 * @description Comma-separated EVM token addresses.
+                 * @example 0x078d782b760474a361dda0af3839290b0ef57ad6,0x83f31af747189c2fa9e5deb253200c505eff6ed2
+                 */
+                addresses: components["parameters"]["AddressesQuery"];
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Curated token metadata */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["TokenList"];
+                };
+            };
+            400: components["responses"]["BadRequest"];
+            500: components["responses"]["ServerError"];
+        };
+    };
+    listMarkets: {
+        parameters: {
+            query: {
+                /**
+                 * @description EVM chain ID as a string query parameter. JSON response bodies use numeric chainId values.
+                 * @example 130
+                 */
+                chainId: components["parameters"]["ChainIdQuery"];
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Curated swap markets */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["MarketList"];
+                };
+            };
+            400: components["responses"]["BadRequest"];
+            500: components["responses"]["ServerError"];
+        };
+    };
+    createIndicativeSwapQuote: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["SwapQuoteRequest"];
+            };
+        };
+        responses: {
+            /** @description Indicative swap quote */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SwapQuoteResponse"];
+                };
+            };
+            400: components["responses"]["BadRequest"];
+            404: components["responses"]["NotFound"];
+            500: components["responses"]["ServerError"];
+        };
+    };
+    getOpenApiSpec: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OpenAPI 3.1 document */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OpenApiDocument"];
+                };
+            };
+            404: components["responses"]["NotFound"];
+            500: components["responses"]["ServerError"];
+        };
+    };
+}