@aegis-engine/core 0.9.2 → 0.10.0

package/README.md

@@ -597,6 +597,25 @@ const executableQuote = await fetchAggregatedSwapQuote(
 )
 ```
 
+Aggregated quotes are available on chains 1, 56, 130 and 8453
+(`AGGREGATED_SWAP_SUPPORTED_CHAIN_IDS`). To route only through Aegis pools
+(Uniswap v4 pools with the Aegis hook), pass `{ liquiditySources: 'aegis' }` as
+the last argument. Pass the same `liquiditySources` to `executeKyberSwap`:
+
+```ts
+const aegisQuote = await fetchAggregatedSwapQuote(
+  inputToken, outputToken, amount, slippageBps, 'exactIn',
+  null, undefined, undefined, undefined,
+  { liquiditySources: 'aegis' }
+)
+```
+
+Aegis mode sends `includedSources=uniswap-v4-aegis` and requires every hop to
+carry the `uniswap-v4-aegis` tag. It checks this before build and, in
+`executeKyberSwap`, again before signing. If there is no all-Aegis path, or a
+hop is tagged with any other source, it throws `NoAegisRouteError`
+(`reason: 'no-route' | 'non-aegis-leg'`).
+
 ## KyberSwap Execution
 
 ```ts
@@ -681,6 +700,8 @@ Execution returns:
 - User rejection errors normalize through `errorMessage(error, fallback)`.
 - Kyber temporary failures can be mapped with
   `aggregatedSwapErrorMessage(error, fallback)`.
+- `NoAegisRouteError`: Aegis-only routing found no all-Aegis path, or the
+  route included a hop outside Aegis pools.
 
 ## Publishing
 

package/dist/actions/kyberSwap.d.ts

@@ -1,6 +1,7 @@
 import { type Address, type Hex, type PublicClient } from 'viem';
 import { UserFacingError } from '../errors.js';
 import type { AegisSwapChainConfig, AegisSwapToken } from '../config/index.js';
+import type { AggregatedSwapLiquiditySources } from '../services/kyberSwap.js';
 import type { AegisSwapApprovalMode, WalletSession } from '../swap/types.js';
 import type { AggregatedSwapQuote } from '../types/aggregatedSwap.js';
 import type { AegisSwapActionCallbacks, AegisSwapActionResult } from './types.js';
@@ -36,6 +37,8 @@ export declare function executeKyberSwap(args: {
     slippageBps: number;
     displayedQuote?: AggregatedSwapQuote | null;
     approvalMode?: AegisSwapApprovalMode;
+    /** `'aegis'` routes only through Aegis pools and fails closed otherwise. Defaults to `'any'`. */
+    liquiditySources?: AggregatedSwapLiquiditySources;
     signal?: AbortSignal;
     onWalletChainId?: (chainId: number | null) => void;
 } & AegisSwapActionCallbacks): Promise<AegisSwapActionResult<AggregatedSwapQuote>>;