@panoptic-eng/sdk 1.0.38 → 1.0.39

package/dist/cow/index.d.ts

@@ -1,5 +1,804 @@
-import { APP_DATA_DOC$1 as APP_DATA_DOC, APP_DATA_HASH$1 as APP_DATA_HASH, BestVenue, COW_API_URLS$1 as COW_API_URLS, COW_CANCELLATION_TYPES$1 as COW_CANCELLATION_TYPES, COW_NATIVE_ETH$1 as COW_NATIVE_ETH, COW_ORDER_TYPES$1 as COW_ORDER_TYPES, COW_SETTLEMENT$1 as COW_SETTLEMENT, COW_VAULT_RELAYER$1 as COW_VAULT_RELAYER, CowApiError$1 as CowApiError, CowNativeTokenError$1 as CowNativeTokenError, CowOrderTooSmallError$1 as CowOrderTooSmallError, CowTokenInfo, CowUnsupportedChainError$1 as CowUnsupportedChainError, DEFAULT_VALID_FOR_SECONDS$1 as DEFAULT_VALID_FOR_SECONDS, FindCowTokenParams, PickBestVenueParams, SwapVenue, XSTOCK_WRAPPERS$1 as XSTOCK_WRAPPERS, XstockWrapperInfo, XstockWrapperRegistry, approveErc20ForCow$1 as approveErc20ForCow, cancelCowOrder$1 as cancelCowOrder, checkCowApproval$1 as checkCowApproval, cowDomain$1 as cowDomain, findCowToken$1 as findCowToken, getCowOrderStatus$1 as getCowOrderStatus, getXstockUnderlying$1 as getXstockUnderlying, getXstockWrapper$1 as getXstockWrapper, isCowSupportedChain$1 as isCowSupportedChain, isXstockUnderlying$1 as isXstockUnderlying, isXstockWrapper$1 as isXstockWrapper, pickBestVenue$1 as pickBestVenue, quoteCowSwap$1 as quoteCowSwap, signAndSubmitCowOrder$1 as signAndSubmitCowOrder } from "../index-CttjEZ-S.js";
-import "../index-Bo9tHtD7.js";
-import "../irm-D5plRhpB.js";
-import { ApproveErc20ForCowParams, CancelCowOrderParams, CheckCowApprovalParams, CowApprovalStatus, CowOrderKind, CowOrderResult, CowOrderState, CowOrderStatus, CowQuote, GetCowOrderStatusParams, QuoteCowSwapParams, SignAndSubmitCowOrderParams } from "../types-DM0nxlZr.js";
-export { APP_DATA_DOC, APP_DATA_HASH, ApproveErc20ForCowParams, BestVenue, COW_API_URLS, COW_CANCELLATION_TYPES, COW_NATIVE_ETH, COW_ORDER_TYPES, COW_SETTLEMENT, COW_VAULT_RELAYER, CancelCowOrderParams, CheckCowApprovalParams, CowApiError, CowApprovalStatus, CowNativeTokenError, CowOrderKind, CowOrderResult, CowOrderState, CowOrderStatus, CowOrderTooSmallError, CowQuote, CowTokenInfo, CowUnsupportedChainError, DEFAULT_VALID_FOR_SECONDS, FindCowTokenParams, GetCowOrderStatusParams, PickBestVenueParams, QuoteCowSwapParams, SignAndSubmitCowOrderParams, SwapVenue, XSTOCK_WRAPPERS, XstockWrapperInfo, XstockWrapperRegistry, approveErc20ForCow, cancelCowOrder, checkCowApproval, cowDomain, findCowToken, getCowOrderStatus, getXstockUnderlying, getXstockWrapper, isCowSupportedChain, isXstockUnderlying, isXstockWrapper, pickBestVenue, quoteCowSwap, signAndSubmitCowOrder };
+import { Address, Hash, Hex, PublicClient, WalletClient } from "viem";
+
+//#region src/cow/addresses.d.ts
+/** GPv2Settlement — EIP-712 verifying contract for signed orders. */
+
+/** GPv2Settlement — EIP-712 verifying contract for signed orders. */
+declare const COW_SETTLEMENT: Address;
+/** GPv2VaultRelayer — the ERC20 approval target (NOT the settlement contract). */
+declare const COW_VAULT_RELAYER: Address;
+/**
+ * Buy-token marker for native ETH. Orders buying this sentinel settle in
+ * native ETH (the settlement contract unwraps WETH). Only valid on the buy
+ * side — selling native ETH requires the eth-flow contract (unsupported here).
+ */
+declare const COW_NATIVE_ETH: Address;
+/** Order-book API base URL per chain. */
+declare const COW_API_URLS: Partial<Record<number, string>>;
+/** Whether CoW Protocol has an order book for the chain. */
+declare function isCowSupportedChain(chainId: bigint | number): boolean; //#endregion
+//#region src/panoptic/v2/types/meta.d.ts
+/**
+ * Block metadata types for the Panoptic v2 SDK.
+ * @module v2/types/meta
+ */
+/**
+ * Block metadata attached to all RPC responses.
+ * Used for freshness checks and reorg detection.
+ */
+interface BlockMeta {
+  /** Block number when the data was fetched */
+  blockNumber: bigint;
+  /** Block timestamp in Unix seconds */
+  blockTimestamp: bigint;
+  /** Block hash for reorg detection */
+  blockHash: `0x${string}`;
+  /** Whether the data is considered stale */
+  isStale?: boolean;
+}
+
+//#endregion
+//#region src/panoptic/v2/types/events.d.ts
+/**
+ * Supported Panoptic event types.
+ */
+type PanopticEventType = 'OptionMinted' | 'OptionBurnt' | 'AccountLiquidated' | 'ForcedExercised' | 'PremiumSettled' | 'Deposit' | 'Withdraw' | 'BorrowRateUpdated' | 'LiquidityChunkUpdated' | 'ProtocolLossRealized' | 'ModifyLiquidity' | 'Swap' | 'Donate';
+/**
+ * Base event data common to all events.
+ */
+interface BaseEvent {
+  /** Event type */
+  type: PanopticEventType;
+  /** Transaction hash */
+  transactionHash: Hash;
+  /** Block number */
+  blockNumber: bigint;
+  /** Block hash */
+  blockHash: Hash;
+  /** Log index within the block */
+  logIndex: bigint;
+}
+/**
+ * OptionMinted event data.
+ */
+interface OptionMintedEvent extends BaseEvent {
+  type: 'OptionMinted';
+  /** Recipient of the minted position */
+  recipient: Address;
+  /** TokenId of the minted position */
+  tokenId: bigint;
+  /** Position size */
+  positionSize: bigint;
+  /** Pool utilization for token 0 at mint */
+  poolUtilization0: bigint;
+  /** Pool utilization for token 1 at mint */
+  poolUtilization1: bigint;
+  /** Tick at mint */
+  tickAtMint: bigint;
+  /** Timestamp at mint (Unix seconds) */
+  timestampAtMint: bigint;
+  /** Block number at mint */
+  blockAtMint: bigint;
+  /** Whether a swap happened at mint */
+  swapAtMint: boolean;
+}
+/**
+ * OptionBurnt event data.
+ */
+interface OptionBurntEvent extends BaseEvent {
+  type: 'OptionBurnt';
+  /** Recipient (owner) of the burnt position */
+  recipient: Address;
+  /** TokenId of the burnt position */
+  tokenId: bigint;
+  /** Position size that was burnt */
+  positionSize: bigint;
+  /** Premia settled for each leg (token0 right, token1 left per leg) */
+  premiaByLeg: readonly [bigint, bigint, bigint, bigint];
+}
+/**
+ * AccountLiquidated event data.
+ */
+interface AccountLiquidatedEvent extends BaseEvent {
+  type: 'AccountLiquidated';
+  /** Address of the liquidator */
+  liquidator: Address;
+  /** Address of the liquidated account */
+  liquidatee: Address;
+  /** Bonus paid to liquidator for token 0 */
+  bonusAmount0: bigint;
+  /** Bonus paid to liquidator for token 1 */
+  bonusAmount1: bigint;
+}
+/**
+ * ForcedExercised event data.
+ */
+interface ForcedExercisedEvent extends BaseEvent {
+  type: 'ForcedExercised';
+  /** Address of the exerciser */
+  exercisor: Address;
+  /** Address of the position owner */
+  user: Address;
+  /** TokenId of the exercised position */
+  tokenId: bigint;
+  /** Exercise fee for token 0 (negative = cost to exerciser) */
+  exerciseFee0: bigint;
+  /** Exercise fee for token 1 (negative = cost to exerciser) */
+  exerciseFee1: bigint;
+}
+/**
+ * PremiumSettled event data.
+ */
+interface PremiumSettledEvent extends BaseEvent {
+  type: 'PremiumSettled';
+  /** Position owner */
+  user: Address;
+  /** TokenId */
+  tokenId: bigint;
+  /** Leg index that was settled */
+  legIndex: bigint;
+  /** Settled amount for token 0 */
+  settledAmount0: bigint;
+  /** Settled amount for token 1 */
+  settledAmount1: bigint;
+}
+/**
+ * Deposit event data (ERC4626).
+ */
+interface DepositEvent extends BaseEvent {
+  type: 'Deposit';
+  /** Sender address */
+  sender: Address;
+  /** Owner address */
+  owner: Address;
+  /** Assets deposited */
+  assets: bigint;
+  /** Shares minted */
+  shares: bigint;
+}
+/**
+ * Withdraw event data (ERC4626).
+ */
+interface WithdrawEvent extends BaseEvent {
+  type: 'Withdraw';
+  /** Sender address */
+  sender: Address;
+  /** Receiver address */
+  receiver: Address;
+  /** Owner address */
+  owner: Address;
+  /** Assets withdrawn */
+  assets: bigint;
+  /** Shares burned */
+  shares: bigint;
+}
+/**
+ * BorrowRateUpdated event data (RiskEngine).
+ */
+interface BorrowRateUpdatedEvent extends BaseEvent {
+  type: 'BorrowRateUpdated';
+  /** Collateral token address */
+  collateralToken: Address;
+  /** Average borrow rate */
+  avgBorrowRate: bigint;
+  /** Rate at target utilization */
+  rateAtTarget: bigint;
+}
+/**
+ * LiquidityChunkUpdated event data (SFPM).
+ */
+interface LiquidityChunkUpdatedEvent extends BaseEvent {
+  type: 'LiquidityChunkUpdated';
+  /** Pool ID (bytes32) */
+  poolId: Hash;
+  /** Owner address */
+  owner: Address;
+  /** Token type (0 or 1) */
+  tokenType: bigint;
+  /** Lower tick */
+  tickLower: number;
+  /** Upper tick */
+  tickUpper: number;
+  /** Liquidity delta (positive = added, negative = removed) */
+  liquidityDelta: bigint;
+}
+/**
+ * ProtocolLossRealized event data (CollateralTracker).
+ */
+interface ProtocolLossRealizedEvent extends BaseEvent {
+  type: 'ProtocolLossRealized';
+  /** Liquidated account */
+  liquidatee: Address;
+  /** Liquidator address */
+  liquidator: Address;
+  /** Protocol loss in assets */
+  protocolLossAssets: bigint;
+  /** Protocol loss in shares */
+  protocolLossShares: bigint;
+}
+/**
+ * ModifyLiquidity event data (v4 PoolManager).
+ */
+interface ModifyLiquidityEvent extends BaseEvent {
+  type: 'ModifyLiquidity';
+  /** Pool ID (bytes32) */
+  id: Hash;
+  /** Sender address */
+  sender: Address;
+  /** Lower tick */
+  tickLower: number;
+  /** Upper tick */
+  tickUpper: number;
+  /** Liquidity delta */
+  liquidityDelta: bigint;
+  /** Salt */
+  salt: Hash;
+}
+/**
+ * Swap event data (v4 PoolManager).
+ */
+interface SwapEvent extends BaseEvent {
+  type: 'Swap';
+  /** Pool ID (bytes32) */
+  id: Hash;
+  /** Sender address */
+  sender: Address;
+  /** Amount of token 0 */
+  amount0: bigint;
+  /** Amount of token 1 */
+  amount1: bigint;
+  /** Square root price X96 */
+  sqrtPriceX96: bigint;
+  /** Liquidity */
+  liquidity: bigint;
+  /** Tick */
+  tick: number;
+  /** Fee */
+  fee: number;
+}
+/**
+ * Donate event data (v4 PoolManager).
+ */
+interface DonateEvent extends BaseEvent {
+  type: 'Donate';
+  /** Pool ID (bytes32) */
+  id: Hash;
+  /** Sender address */
+  sender: Address;
+  /** Amount of token 0 */
+  amount0: bigint;
+  /** Amount of token 1 */
+  amount1: bigint;
+}
+/**
+ * Union of all Panoptic event types.
+ */
+type PanopticEvent = OptionMintedEvent | OptionBurntEvent | AccountLiquidatedEvent | ForcedExercisedEvent | PremiumSettledEvent | DepositEvent | WithdrawEvent | BorrowRateUpdatedEvent | LiquidityChunkUpdatedEvent | ProtocolLossRealizedEvent | ModifyLiquidityEvent | SwapEvent | DonateEvent; //#endregion
+//#region src/panoptic/v2/types/tx.d.ts
+
+/**
+ * Leg update data from events.
+ */
+/**
+ * Transaction result returned by write functions.
+ * Provides immediate access to hash and a wait function for confirmation.
+ */
+interface TxResult {
+  /** Transaction hash, available immediately */
+  hash: Hash;
+  /** Wait for transaction confirmation */
+  wait: (confirmations?: bigint) => Promise<TxReceipt>;
+}
+/**
+ * Transaction result with receipt already awaited.
+ * Returned by *AndWait convenience functions.
+ */
+
+/**
+ * Transaction receipt after confirmation.
+ */
+interface TxReceipt {
+  /** Transaction hash */
+  hash: Hash;
+  /** Block number */
+  blockNumber: bigint;
+  /** Block hash */
+  blockHash: Hash;
+  /** Gas used */
+  gasUsed: bigint;
+  /** Transaction status */
+  status: 'success' | 'reverted';
+  /** Parsed Panoptic events from the transaction */
+  events: PanopticEvent[];
+}
+/**
+ * Transaction broadcaster interface for private transaction support.
+ * Allows plugging in Flashbots or other MEV protection services.
+ */
+interface TxBroadcaster {
+  /**
+   * Broadcast a signed transaction.
+   * @param signedTx - The signed transaction bytes
+   * @returns The transaction hash
+   */
+  broadcast: (signedTx: `0x${string}`) => Promise<Hash>;
+}
+/**
+ * Gas and transaction overrides for write operations.
+ * Supports EIP-1559 gas parameters, explicit nonce, and custom broadcasters.
+ */
+interface TxOverrides {
+  /** EIP-1559 max fee per gas */
+  maxFeePerGas?: bigint;
+  /** EIP-1559 max priority fee per gas (tip) */
+  maxPriorityFeePerGas?: bigint;
+  /** Gas limit override */
+  gas?: bigint;
+  /** Explicit nonce (for concurrent tx submission) */
+  nonce?: bigint;
+  /** Custom broadcaster for MEV protection (Flashbots, private mempool) */
+  broadcaster?: TxBroadcaster;
+}
+
+//#endregion
+//#region src/panoptic/v2/errors/base.d.ts
+/**
+ * Nonce manager for concurrent transaction submission.
+ */
+/**
+ * Base error class for the Panoptic v2 SDK.
+ * @module v2/errors/base
+ */
+/**
+ * Base error class for all Panoptic SDK errors.
+ * All errors thrown by the SDK extend this class.
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   await openPosition(config, params)
+ * } catch (error) {
+ *   if (error instanceof PanopticError) {
+ *     console.log('Panoptic error:', error.name, error.message)
+ *     console.log('Original cause:', error.cause)
+ *   }
+ * }
+ * ```
+ */
+declare class PanopticError extends Error {
+  readonly cause?: Error | undefined;
+  readonly name: string;
+  /** The Solidity error name (e.g. 'PriceBoundFail', 'InputListFail'). Set by the parser. */
+  errorName?: string;
+  /**
+   * Creates a new PanopticError.
+   *
+   * @param message - Human-readable error message
+   * @param cause - Optional underlying error that caused this error
+   */
+  constructor(message: string, cause?: Error | undefined);
+}
+
+//#endregion
+//#region src/panoptic/v2/types/simulation.d.ts
+/**
+ * Token flow data from simulation.
+ * Measures collateral asset changes via getAssetsOf-dispatch-getAssetsOf pattern
+ * using PanopticPool.multicall.
+ */
+interface TokenFlow {
+  /** Token 0 collateral change (negative = user deposits, positive = user receives) */
+  delta0: bigint;
+  /** Token 1 collateral change (negative = user deposits, positive = user receives) */
+  delta1: bigint;
+  /** Collateral assets in token 0 before the call */
+  balanceBefore0: bigint;
+  /** Collateral assets in token 1 before the call */
+  balanceBefore1: bigint;
+  /** Collateral assets in token 0 after the call */
+  balanceAfter0: bigint;
+  /** Collateral assets in token 1 after the call */
+  balanceAfter1: bigint;
+  /** Pool tick before the operation */
+  tickBefore: bigint | null;
+  /** Pool tick after the operation */
+  tickAfter: bigint | null;
+}
+/**
+ * Simulation result discriminated union.
+ * Success case returns data, failure case returns error.
+ *
+ * Note: tokenFlow is optional because some simulations (deposit/withdraw)
+ * don't use the PanopticPool.multicall token flow measurement.
+ */
+type SimulationResult<T> = {
+  success: true;
+  data: T;
+  gasEstimate: bigint;
+  tokenFlow?: TokenFlow;
+  _meta: BlockMeta;
+} | {
+  success: false;
+  error: PanopticError;
+  _meta: BlockMeta;
+};
+
+//#endregion
+//#region src/cow/types.d.ts
+/**
+ * Open position simulation result data.
+ */
+/** Order kind: 'sell' = exact-in, 'buy' = exact-out. */
+type CowOrderKind = 'sell' | 'buy';
+/** Order-book lifecycle states. */
+type CowOrderStatus = 'presignaturePending' | 'open' | 'fulfilled' | 'cancelled' | 'expired';
+/** Parameters for {@link quoteCowSwap}. */
+interface QuoteCowSwapParams {
+  /** Chain ID (selects the order-book API). */
+  chainId: bigint;
+  /** ERC20 token to sell (native ETH not supported). */
+  sellToken: Address;
+  /** Token to buy. The zero address (native ETH) maps to the CoW buy sentinel. */
+  buyToken: Address;
+  /** 'sell' = exact-in (amount is sellAmountBeforeFee), 'buy' = exact-out (amount is buyAmountAfterFee). */
+  kind: CowOrderKind;
+  /** Exact amount being quoted (see `kind`). */
+  amount: bigint;
+  /** Order owner — the API validates balances/fees against this account. */
+  from: Address;
+  /** Slippage tolerance in bps applied to the signed limit amounts. */
+  slippageBps: bigint;
+  /** Order validity window in seconds (drives `validTo`). Defaults to 30 minutes. */
+  validForSeconds?: bigint;
+  /** Override the order-book API base URL (e.g. tests). */
+  apiUrl?: string;
+}
+/**
+ * Quote result data (carried inside a `SimulationResult`).
+ *
+ * `orderSellAmount`/`orderBuyAmount` are the limit amounts to sign: fee folded
+ * into the sell side (`feeAmount` is signed as 0 per the current fee model)
+ * and slippage applied to the non-exact side.
+ */
+interface CowQuote {
+  kind: CowOrderKind;
+  sellToken: Address;
+  buyToken: Address;
+  /** Quoted sell amount, excluding fee. */
+  sellAmount: bigint;
+  /** Quoted buy amount (net). */
+  buyAmount: bigint;
+  /** Quoted protocol fee, in the sell token. */
+  feeAmount: bigint;
+  /** Total sell-token outflow at the quoted price (sellAmount + feeAmount). */
+  sellAmountTotal: bigint;
+  /** Sell amount to sign (sell orders: gross; buy orders: slippage-padded max). */
+  orderSellAmount: bigint;
+  /** Buy amount to sign (sell orders: slippage-reduced min; buy orders: exact). */
+  orderBuyAmount: bigint;
+  /** Order expiry (unix seconds, uint32). */
+  validTo: bigint;
+  /** Order-book quote id, echoed on order submission for tracing. */
+  quoteId: number | null;
+}
+/** Parameters for {@link signAndSubmitCowOrder}. */
+interface SignAndSubmitCowOrderParams {
+  walletClient: WalletClient;
+  /** Order owner (signer). */
+  account: Address;
+  chainId: bigint;
+  /** Quote to turn into a signed order. */
+  quote: CowQuote;
+  /** Recipient of the buy token. Defaults to `account`. */
+  receiver?: Address;
+  /** Override the order-book API base URL (e.g. tests). */
+  apiUrl?: string;
+}
+/** Result of posting an order: the order-book UID (not a tx hash). */
+interface CowOrderResult {
+  orderUid: Hex;
+}
+/** Parameters for {@link cancelCowOrder}. */
+interface CancelCowOrderParams {
+  walletClient: WalletClient;
+  account: Address;
+  chainId: bigint;
+  orderUid: Hex;
+  apiUrl?: string;
+}
+/** Parameters for {@link getCowOrderStatus}. */
+interface GetCowOrderStatusParams {
+  chainId: bigint;
+  orderUid: Hex;
+  apiUrl?: string;
+}
+/** Result of {@link getCowOrderStatus}. */
+interface CowOrderState {
+  status: CowOrderStatus;
+  /** Cumulative executed amounts (partial fills included). */
+  executedSellAmount: bigint;
+  executedBuyAmount: bigint;
+  /** Settlement tx hash, available once at least one trade has executed. */
+  settlementTxHash?: Hex;
+}
+/** Parameters for {@link checkCowApproval}. */
+interface CheckCowApprovalParams {
+  client: PublicClient;
+  /** ERC20 token being sold. */
+  sellToken: Address;
+  /** Token owner. */
+  owner: Address;
+  /** Amount that must be spendable by the vault relayer. */
+  amount: bigint;
+}
+/** Result of {@link checkCowApproval}. */
+interface CowApprovalStatus {
+  needsApproval: boolean;
+  /** Current ERC20 → VaultRelayer allowance. */
+  allowance: bigint;
+}
+/** Parameters for {@link approveErc20ForCow}. */
+interface ApproveErc20ForCowParams {
+  client: PublicClient;
+  walletClient: WalletClient;
+  account: Address;
+  /** ERC20 token to approve to the vault relayer. */
+  sellToken: Address;
+  /** Amount to approve. Defaults to uint256 max. */
+  amount?: bigint;
+  txOverrides?: TxOverrides;
+}
+
+//#endregion
+//#region src/cow/approval.d.ts
+/** Check whether the vault relayer can pull `amount` of the sell token. */
+declare function checkCowApproval(params: CheckCowApprovalParams): Promise<CowApprovalStatus>;
+/** Approve the sell token to the vault relayer (defaults to unlimited). */
+declare function approveErc20ForCow(params: ApproveErc20ForCowParams): Promise<TxResult>;
+
+//#endregion
+//#region src/cow/compare.d.ts
+/**
+ * Venue selection between the Uniswap v4 router and CoW Swap.
+ *
+ * Pure amount comparison so it stays testable and reusable outside React.
+ * Gas cost of the router tx is not factored in (CoW ERC20 sells are gasless);
+ * TODO: optionally discount the Uniswap side by gasEstimate × gas price.
+ *
+ * @module cow/compare
+ */
+/** Swap venues the UI can route through. */
+type SwapVenue = 'uniswap' | 'cow';
+/** Parameters for {@link pickBestVenue}. */
+interface PickBestVenueParams {
+  /** 'sell' = exact-in (maximize output), 'buy' = exact-out (minimize input). */
+  kind: 'sell' | 'buy';
+  /** Uniswap quote amounts; omit when the quote failed or is unavailable. */
+  uniswap?: {
+    /** Quoted output (exact-in). */
+    amountOut?: bigint;
+    /** Quoted input (exact-out). */
+    amountIn?: bigint;
+  };
+  /** CoW quote amounts; omit when the quote failed or is unavailable. */
+  cow?: {
+    /** Quoted net output (exact-in). */
+    buyAmount?: bigint;
+    /** Quoted gross input including fee (exact-out). */
+    sellAmountTotal?: bigint;
+  };
+}
+/** Result of {@link pickBestVenue}. */
+interface BestVenue {
+  winner: SwapVenue;
+  /** Price advantage of the winner over the loser in bps (only when both quoted). */
+  advantageBps?: bigint;
+}
+/**
+ * Pick the venue with the better effective price. Exact-in compares net
+ * output (higher wins); exact-out compares gross input (lower wins). With a
+ * single usable quote that venue wins; ties go to Uniswap (instant
+ * settlement); with no usable quotes Uniswap wins by default.
+ */
+declare function pickBestVenue(params: PickBestVenueParams): BestVenue;
+
+//#endregion
+//#region src/cow/eip712.d.ts
+/** GPv2 `Order` struct, in EIP-712 typed-data form. */
+declare const COW_ORDER_TYPES: {
+  readonly Order: readonly [{
+    readonly name: "sellToken";
+    readonly type: "address";
+  }, {
+    readonly name: "buyToken";
+    readonly type: "address";
+  }, {
+    readonly name: "receiver";
+    readonly type: "address";
+  }, {
+    readonly name: "sellAmount";
+    readonly type: "uint256";
+  }, {
+    readonly name: "buyAmount";
+    readonly type: "uint256";
+  }, {
+    readonly name: "validTo";
+    readonly type: "uint32";
+  }, {
+    readonly name: "appData";
+    readonly type: "bytes32";
+  }, {
+    readonly name: "feeAmount";
+    readonly type: "uint256";
+  }, {
+    readonly name: "kind";
+    readonly type: "string";
+  }, {
+    readonly name: "partiallyFillable";
+    readonly type: "bool";
+  }, {
+    readonly name: "sellTokenBalance";
+    readonly type: "string";
+  }, {
+    readonly name: "buyTokenBalance";
+    readonly type: "string";
+  }];
+};
+/** GPv2 order-cancellation struct (batch of order UIDs). */
+declare const COW_CANCELLATION_TYPES: {
+  readonly OrderCancellations: readonly [{
+    readonly name: "orderUids";
+    readonly type: "bytes[]";
+  }];
+};
+/** EIP-712 domain for GPv2Settlement on the given chain. */
+declare function cowDomain(chainId: bigint | number): {
+  name: string;
+  version: string;
+  chainId: number;
+  verifyingContract: Address;
+};
+/**
+ * Full appData JSON document attached to orders. The order itself carries only
+ * its keccak256 hash; the API stores the document when it accompanies the
+ * order POST. Must stay byte-identical to {@link APP_DATA_HASH}.
+ */
+declare const APP_DATA_DOC = "{\"appCode\":\"panoptic\",\"metadata\":{},\"version\":\"1.3.0\"}";
+/** keccak256 of {@link APP_DATA_DOC} — the `appData` field signed in the order. */
+declare const APP_DATA_HASH: `0x${string}`;
+
+//#endregion
+//#region src/cow/errors.d.ts
+/** The chain has no CoW order book. */
+declare class CowUnsupportedChainError extends PanopticError {
+  readonly chainId: bigint;
+  readonly name = "CowUnsupportedChainError";
+  constructor(chainId: bigint, cause?: Error);
+}
+/** The order-book API rejected a request (non-2xx response). */
+declare class CowApiError extends PanopticError {
+  /** Machine-readable API error type, e.g. 'SellAmountDoesNotCoverFee'. */
+  readonly errorType: string;
+  readonly status: number;
+  readonly name: string;
+  constructor(/** Machine-readable API error type, e.g. 'SellAmountDoesNotCoverFee'. */
+  errorType: string, message: string, status: number, cause?: Error);
+}
+/** The sell amount is too small to cover the protocol fee (dust order). */
+declare class CowOrderTooSmallError extends CowApiError {
+  readonly name = "CowOrderTooSmallError";
+  constructor(message: string, status: number, cause?: Error);
+}
+/** Selling native ETH requires the eth-flow contract (unsupported here); buying it is fine. */
+declare class CowNativeTokenError extends PanopticError {
+  readonly name = "CowNativeTokenError";
+  constructor(cause?: Error);
+}
+
+//#endregion
+//#region src/cow/order.d.ts
+/**
+ * Build the final order from a quote, sign it (EIP-712) and POST it to the
+ * order book. The signed `feeAmount` is 0 — the fee is already folded into the
+ * quote's `orderSellAmount`.
+ */
+declare function signAndSubmitCowOrder(params: SignAndSubmitCowOrderParams): Promise<CowOrderResult>;
+/**
+ * Cancel an open order off-chain (free, signed cancellation). Cancellation is
+ * best-effort: an order already committed to a solver batch can still settle.
+ */
+declare function cancelCowOrder(params: CancelCowOrderParams): Promise<void>;
+
+//#endregion
+//#region src/cow/quote.d.ts
+/** Default order validity window (30 minutes). */
+declare const DEFAULT_VALID_FOR_SECONDS = 1800n;
+/**
+ * Quote a swap via the CoW order book.
+ *
+ * For `kind: 'sell'` (exact-in) `amount` is the sell amount before fee; for
+ * `kind: 'buy'` (exact-out) it is the exact buy amount. The returned
+ * `orderSellAmount`/`orderBuyAmount` are ready to sign: the fee is folded into
+ * the sell side (orders are placed with `feeAmount: 0` under the current fee
+ * model) and `slippageBps` is applied to the non-exact side.
+ */
+declare function quoteCowSwap(params: QuoteCowSwapParams): Promise<SimulationResult<CowQuote>>;
+
+//#endregion
+//#region src/cow/status.d.ts
+/**
+ * Fetch an order's lifecycle state. Once any trade has executed, the
+ * settlement tx hash is included (fetched from the trades endpoint).
+ */
+declare function getCowOrderStatus(params: GetCowOrderStatusParams): Promise<CowOrderState>;
+
+//#endregion
+//#region src/cow/tokens.d.ts
+/** Resolved token-list entry. */
+interface CowTokenInfo {
+  chainId: number;
+  address: Address;
+  symbol: string;
+  name: string;
+  decimals: number;
+  logoURI?: string;
+}
+/** Parameters for {@link findCowToken}. */
+interface FindCowTokenParams {
+  /** Chain to resolve on. */
+  chainId: bigint;
+  /** Token symbol, case-insensitive (e.g. 'nvdax'). */
+  symbol: string;
+  /** Override the token-list URLs (e.g. tests). */
+  listUrls?: string[];
+}
+/**
+ * Find a token by symbol on the given chain across CoW's token lists. The
+ * first list containing a (case-insensitive) symbol match wins; within a
+ * list the first match wins, which favors canonical entries on collisions.
+ * Returns null when no list resolves the symbol (or all fetches fail).
+ *
+ * Resolution only proves the token is listed — whether solvers can actually
+ * fill a given pair/size is answered by `quoteCowSwap`.
+ */
+declare function findCowToken(params: FindCowTokenParams): Promise<CowTokenInfo | null>;
+
+//#endregion
+//#region src/cow/xstockWrappers.generated.d.ts
+declare const XSTOCK_WRAPPERS: XstockWrapperRegistry;
+
+//#endregion
+//#region src/cow/xstockWrappers.d.ts
+/** A single xStock → wrapper mapping entry. */
+interface XstockWrapperInfo {
+  /** ERC4626 wrapper (the token Panoptic/Uniswap pools trade). */
+  wrapper: Address;
+  /** Underlying rebasing xStock (`asset()` of the wrapper; the CoW-traded token). */
+  underlying: Address;
+  /** Wrapper symbol, e.g. `wNVDAx`. */
+  symbol: string;
+  /** Wrapper name, e.g. `Wrapped NVIDIA xStock`. */
+  name: string;
+  /** Wrapper (and underlying) ERC20 decimals. */
+  decimals: number;
+}
+/** Generated registry keyed by chainId. */
+type XstockWrapperRegistry = Partial<Record<number, XstockWrapperInfo[]>>;
+/**
+ * Resolve the wrapper for an unwrapped xStock. Returns `undefined` when the
+ * address isn't a known xStock underlying on this chain.
+ */
+declare function getXstockWrapper(chainId: number, underlying: Address): XstockWrapperInfo | undefined;
+/**
+ * Resolve the underlying xStock for a wrapper address. Returns `undefined` when
+ * the address isn't a known xStock wrapper on this chain.
+ */
+declare function getXstockUnderlying(chainId: number, wrapper: Address): XstockWrapperInfo | undefined;
+/** True if `address` is a known unwrapped xStock on this chain. */
+declare function isXstockUnderlying(chainId: number, address: Address): boolean;
+/** True if `address` is a known xStock wrapper on this chain. */
+declare function isXstockWrapper(chainId: number, address: Address): boolean;
+
+//#endregion
+export { APP_DATA_DOC, APP_DATA_HASH, ApproveErc20ForCowParams, BestVenue, COW_API_URLS, COW_CANCELLATION_TYPES, COW_NATIVE_ETH, COW_ORDER_TYPES, COW_SETTLEMENT, COW_VAULT_RELAYER, CancelCowOrderParams, CheckCowApprovalParams, CowApiError, CowApprovalStatus, CowNativeTokenError, CowOrderKind, CowOrderResult, CowOrderState, CowOrderStatus, CowOrderTooSmallError, CowQuote, CowTokenInfo, CowUnsupportedChainError, DEFAULT_VALID_FOR_SECONDS, FindCowTokenParams, GetCowOrderStatusParams, PickBestVenueParams, QuoteCowSwapParams, SignAndSubmitCowOrderParams, SwapVenue, XSTOCK_WRAPPERS, XstockWrapperInfo, XstockWrapperRegistry, approveErc20ForCow, cancelCowOrder, checkCowApproval, cowDomain, findCowToken, getCowOrderStatus, getXstockUnderlying, getXstockWrapper, isCowSupportedChain, isXstockUnderlying, isXstockWrapper, pickBestVenue, quoteCowSwap, signAndSubmitCowOrder };
+//# sourceMappingURL=index.d.ts.map