@1inch/swap-vm-sdk 0.1.0

package/dist/swap-vm/instructions/twap-swap/twap-swap-args.d.mts

@@ -0,0 +1,71 @@
+import type { HexString } from '@1inch/sdk-core';
+import type { IArgsData } from '../types';
+/**
+ * @notice TWAP Hook with exponential dutch auction and illiquidity handling
+ * @dev Implements a TWAP (Time-Weighted Average Price) selling strategy with the following features:
+ * - Linear liquidity unlocking over time
+ * - Exponential price decay (dutch auction) for better price discovery
+ * - Automatic price bump after periods of insufficient liquidity
+ * - Minimum trade size enforcement during TWAP duration
+ *
+ * Minimum Trade Size (minTradeAmountOut):
+ * The minimum trade size protects against gas cost impact on execution price.
+ * It should be set 1000x+ larger than the expected transaction fees on the deployment network.
+ *
+ * For example:
+ * - Ethereum mainnet with $50 gas cost → minTradeAmountOut should be $50,000+
+ * - Arbitrum/Optimism with $0.50 gas cost → minTradeAmountOut should be $500+
+ * - BSC/Polygon with $0.05 gas cost → minTradeAmountOut should be $50+
+ *
+ * This ensures gas costs remain negligible (<0.1%) relative to trade value.
+ *
+ * Price Bump Configuration Guidelines:
+ *
+ * The priceBumpAfterIlliquidity compensates for mandatory waiting periods due to linear unlocking.
+ * Time to unlock minTradeAmountOut = (minTradeAmountOut / balance0) * duration
+ *
+ * Examples:
+ * - minTradeAmountOut = 0.1% of balance0, duration = 24h → 14.4 min to unlock each min trade
+ *   Recommended bump: 1.05e18 - 1.10e18 (5-10%)
+ *
+ * - minTradeAmountOut = 1% of balance0, duration = 24h → 14.4 min to unlock each min trade
+ *   Recommended bump: 1.10e18 - 1.20e18 (10-20%)
+ *
+ * - minTradeAmountOut = 5% of balance0, duration = 24h → 1.2 hours to unlock each min trade
+ *   Recommended bump: 1.30e18 - 1.50e18 (30-50%)
+ *
+ * - minTradeAmountOut = 10% of balance0, duration = 24h → 2.4 hours to unlock each min trade
+ *   Recommended bump: 1.50e18 - 2.00e18 (50-100%)
+ *
+ * Additional factors to consider:
+ * - Network gas costs: Higher gas requires larger bumps
+ * - Pair volatility: Volatile pairs need larger bumps to compensate for price risk
+ * - Market depth: Thin markets may need higher bumps to attract arbitrageurs
+ *
+ * The bump should ensure profitability after the mandatory waiting period.
+ *
+ * @see https://github.com/1inch/swap-vm/blob/main/src/instructions/TWAPSwap.sol#L104
+ */
+export declare class TWAPSwapArgs implements IArgsData {
+    readonly balanceIn: bigint;
+    readonly balanceOut: bigint;
+    readonly startTime: bigint;
+    readonly duration: bigint;
+    readonly priceBumpAfterIlliquidity: bigint;
+    readonly minTradeAmountOut: bigint;
+    static readonly CODER: any;
+    /**
+     * balanceIn - expected amount of token1 for initial price (uint256)
+     * balanceOut - total amount of token0 for TWAP (uint256)
+     * startTime - TWAP start time (uint256)
+     * duration - TWAP duration (uint256)
+     * priceBumpAfterIlliquidity - price jump when liquidity insufficient, e.g. 1.10e18 = +10% (uint256)
+     * minTradeAmountOut - minimum trade size for token0 (uint256)
+     **/
+    constructor(balanceIn: bigint, balanceOut: bigint, startTime: bigint, duration: bigint, priceBumpAfterIlliquidity: bigint, minTradeAmountOut: bigint);
+    /**
+     * Decodes hex data into TWAPSwapArgs instance
+     **/
+    static decode(data: HexString): TWAPSwapArgs;
+    toJSON(): Record<string, unknown>;
+}

package/dist/swap-vm/instructions/twap-swap/twap-swap-args.d.ts

@@ -0,0 +1,71 @@
+import type { HexString } from '@1inch/sdk-core';
+import type { IArgsData } from '../types';
+/**
+ * @notice TWAP Hook with exponential dutch auction and illiquidity handling
+ * @dev Implements a TWAP (Time-Weighted Average Price) selling strategy with the following features:
+ * - Linear liquidity unlocking over time
+ * - Exponential price decay (dutch auction) for better price discovery
+ * - Automatic price bump after periods of insufficient liquidity
+ * - Minimum trade size enforcement during TWAP duration
+ *
+ * Minimum Trade Size (minTradeAmountOut):
+ * The minimum trade size protects against gas cost impact on execution price.
+ * It should be set 1000x+ larger than the expected transaction fees on the deployment network.
+ *
+ * For example:
+ * - Ethereum mainnet with $50 gas cost → minTradeAmountOut should be $50,000+
+ * - Arbitrum/Optimism with $0.50 gas cost → minTradeAmountOut should be $500+
+ * - BSC/Polygon with $0.05 gas cost → minTradeAmountOut should be $50+
+ *
+ * This ensures gas costs remain negligible (<0.1%) relative to trade value.
+ *
+ * Price Bump Configuration Guidelines:
+ *
+ * The priceBumpAfterIlliquidity compensates for mandatory waiting periods due to linear unlocking.
+ * Time to unlock minTradeAmountOut = (minTradeAmountOut / balance0) * duration
+ *
+ * Examples:
+ * - minTradeAmountOut = 0.1% of balance0, duration = 24h → 14.4 min to unlock each min trade
+ *   Recommended bump: 1.05e18 - 1.10e18 (5-10%)
+ *
+ * - minTradeAmountOut = 1% of balance0, duration = 24h → 14.4 min to unlock each min trade
+ *   Recommended bump: 1.10e18 - 1.20e18 (10-20%)
+ *
+ * - minTradeAmountOut = 5% of balance0, duration = 24h → 1.2 hours to unlock each min trade
+ *   Recommended bump: 1.30e18 - 1.50e18 (30-50%)
+ *
+ * - minTradeAmountOut = 10% of balance0, duration = 24h → 2.4 hours to unlock each min trade
+ *   Recommended bump: 1.50e18 - 2.00e18 (50-100%)
+ *
+ * Additional factors to consider:
+ * - Network gas costs: Higher gas requires larger bumps
+ * - Pair volatility: Volatile pairs need larger bumps to compensate for price risk
+ * - Market depth: Thin markets may need higher bumps to attract arbitrageurs
+ *
+ * The bump should ensure profitability after the mandatory waiting period.
+ *
+ * @see https://github.com/1inch/swap-vm/blob/main/src/instructions/TWAPSwap.sol#L104
+ */
+export declare class TWAPSwapArgs implements IArgsData {
+    readonly balanceIn: bigint;
+    readonly balanceOut: bigint;
+    readonly startTime: bigint;
+    readonly duration: bigint;
+    readonly priceBumpAfterIlliquidity: bigint;
+    readonly minTradeAmountOut: bigint;
+    static readonly CODER: any;
+    /**
+     * balanceIn - expected amount of token1 for initial price (uint256)
+     * balanceOut - total amount of token0 for TWAP (uint256)
+     * startTime - TWAP start time (uint256)
+     * duration - TWAP duration (uint256)
+     * priceBumpAfterIlliquidity - price jump when liquidity insufficient, e.g. 1.10e18 = +10% (uint256)
+     * minTradeAmountOut - minimum trade size for token0 (uint256)
+     **/
+    constructor(balanceIn: bigint, balanceOut: bigint, startTime: bigint, duration: bigint, priceBumpAfterIlliquidity: bigint, minTradeAmountOut: bigint);
+    /**
+     * Decodes hex data into TWAPSwapArgs instance
+     **/
+    static decode(data: HexString): TWAPSwapArgs;
+    toJSON(): Record<string, unknown>;
+}

package/dist/swap-vm/instructions/types.d.mts

@@ -0,0 +1,18 @@
+import type { HexString } from '@1inch/sdk-core';
+export interface IArgsCoder<T> {
+    decode(data: HexString): T;
+    encode(data: T): HexString;
+}
+export interface IArgsData {
+    toJSON(): Record<string | number, unknown> | null;
+}
+export interface IOpcode<T extends IArgsData = IArgsData> {
+    id: symbol;
+    argsCoder(): IArgsCoder<T>;
+    createIx(args: T): IInstruction<T>;
+}
+export interface IInstruction<T extends IArgsData = IArgsData> {
+    args: T;
+    opcode: IOpcode<T>;
+    toJSON(): Record<string | number, unknown>;
+}

package/dist/swap-vm/instructions/types.d.ts

@@ -0,0 +1,18 @@
+import type { HexString } from '@1inch/sdk-core';
+export interface IArgsCoder<T> {
+    decode(data: HexString): T;
+    encode(data: T): HexString;
+}
+export interface IArgsData {
+    toJSON(): Record<string | number, unknown> | null;
+}
+export interface IOpcode<T extends IArgsData = IArgsData> {
+    id: symbol;
+    argsCoder(): IArgsCoder<T>;
+    createIx(args: T): IInstruction<T>;
+}
+export interface IInstruction<T extends IArgsData = IArgsData> {
+    args: T;
+    opcode: IOpcode<T>;
+    toJSON(): Record<string | number, unknown>;
+}

package/dist/swap-vm/instructions/xyc-swap/index.d.mts

@@ -0,0 +1,2 @@
+export * from './opcodes';
+export { XycSwapXDArgs } from './xyc-swap-xd-args';

package/dist/swap-vm/instructions/xyc-swap/index.d.ts

@@ -0,0 +1,2 @@
+export * from './opcodes';
+export { XycSwapXDArgs } from './xyc-swap-xd-args';

package/dist/swap-vm/instructions/xyc-swap/opcodes.d.mts

@@ -0,0 +1,5 @@
+/**
+ * Basic swap using constant product formula (x*y=k)
+ * @see https://github.com/1inch/swap-vm/blob/main/src/instructions/XYCSwap.sol#L15
+ **/
+export declare const xycSwapXD: any;

package/dist/swap-vm/instructions/xyc-swap/opcodes.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Basic swap using constant product formula (x*y=k)
+ * @see https://github.com/1inch/swap-vm/blob/main/src/instructions/XYCSwap.sol#L15
+ **/
+export declare const xycSwapXD: any;

package/dist/swap-vm/instructions/xyc-swap/xyc-swap-xd-args-coder.d.mts

@@ -0,0 +1,7 @@
+import { HexString } from '@1inch/sdk-core';
+import { XycSwapXDArgs } from './xyc-swap-xd-args';
+import type { IArgsCoder } from '../types';
+export declare class XycSwapXDArgsCoder implements IArgsCoder<XycSwapXDArgs> {
+    encode(_args: XycSwapXDArgs): HexString;
+    decode(_data: HexString): XycSwapXDArgs;
+}

package/dist/swap-vm/instructions/xyc-swap/xyc-swap-xd-args-coder.d.ts

@@ -0,0 +1,7 @@
+import { HexString } from '@1inch/sdk-core';
+import { XycSwapXDArgs } from './xyc-swap-xd-args';
+import type { IArgsCoder } from '../types';
+export declare class XycSwapXDArgsCoder implements IArgsCoder<XycSwapXDArgs> {
+    encode(_args: XycSwapXDArgs): HexString;
+    decode(_data: HexString): XycSwapXDArgs;
+}

package/dist/swap-vm/instructions/xyc-swap/xyc-swap-xd-args.d.mts

@@ -0,0 +1,15 @@
+import type { HexString } from '@1inch/sdk-core';
+import type { IArgsData } from '../types';
+/**
+ * Arguments for xycSwapXD instruction (no arguments required)
+ * @see https://github.com/1inch/swap-vm/blob/main/src/instructions/XYCSwap.sol#L15
+ **/
+export declare class XycSwapXDArgs implements IArgsData {
+    static readonly CODER: any;
+    constructor();
+    /**
+     * Decodes hex data into XycSwapXDArgs instance
+     **/
+    static decode(data: HexString): XycSwapXDArgs;
+    toJSON(): Record<string, unknown>;
+}

package/dist/swap-vm/instructions/xyc-swap/xyc-swap-xd-args.d.ts

@@ -0,0 +1,15 @@
+import type { HexString } from '@1inch/sdk-core';
+import type { IArgsData } from '../types';
+/**
+ * Arguments for xycSwapXD instruction (no arguments required)
+ * @see https://github.com/1inch/swap-vm/blob/main/src/instructions/XYCSwap.sol#L15
+ **/
+export declare class XycSwapXDArgs implements IArgsData {
+    static readonly CODER: any;
+    constructor();
+    /**
+     * Decodes hex data into XycSwapXDArgs instance
+     **/
+    static decode(data: HexString): XycSwapXDArgs;
+    toJSON(): Record<string, unknown>;
+}

package/dist/swap-vm/maker-traits.d.mts

@@ -0,0 +1,206 @@
+import type { DataFor } from '@1inch/sdk-core';
+import { Interaction, HexString, Address } from '@1inch/sdk-core';
+/**
+ * Maker-side order configuration packed into a single `uint256` and an optional hooks data blob.
+ *
+ * This class mirrors the on-chain `MakerTraits` bit layout and encoding used by the SwapVM
+ * contracts. It is responsible for:
+ *
+ * - maker preferences (unwrap WETH, allow zero amount in, Aqua vs signature)
+ * - selecting an optional custom receiver
+ * - wiring pre/post transfer hooks and their optional targets/payloads
+ *
+ * The ABI-level representation is:
+ * - `traits`  – a `uint256` where:
+ *   - high bits 245–255 store boolean flags
+ *   - bits 160–223 store cumulative offsets for hook data slices (4 × `uint16`)
+ *   - bits   0–159 store the receiver address (0 means "maker")
+ * - `hooksData` – concatenation of hook payloads in the order:
+ *   `preTransferIn`, `postTransferIn`, `preTransferOut`, `postTransferOut`
+ */
+export declare class MakerTraits {
+    /**
+     * If true, maker WETH proceeds are unwrapped into the native currency when
+     * the order is settled.
+     */
+    readonly shouldUnwrap: boolean;
+    /**
+     * If true, the order is intended to be authenticated via Aqua (push-based
+     * mechanism) instead of a traditional ECDSA signature.
+     */
+    readonly useAquaInsteadOfSignature: boolean;
+    /**
+     * If true, the order accepts `amountIn = 0`. This is useful for flows
+     * where the effective input is determined by hooks or Aqua rather than the
+     * taker-supplied amount.
+     */
+    readonly allowZeroAmountIn: boolean;
+    /**
+     * Optional receiver of the maker's output assets. When omitted or equal to
+     * the zero address, the maker address is used as the receiver.
+     */
+    readonly customReceiver?: Address;
+    /**
+     * Optional hook executed before tokens are transferred *into* the maker
+     * side of the swap. The `Interaction` can carry both target and calldata.
+     * When the hook should be called on the maker itself, `Interaction.target`
+     * must be the zero address.
+     */
+    readonly preTransferInHook?: Interaction;
+    /**
+     * Optional hook executed after tokens are transferred *into* the maker
+     * side of the swap. When the hook should be called on the maker itself,
+     * `Interaction.target` must be the zero address.
+     */
+    readonly postTransferInHook?: Interaction;
+    /**
+     * Optional hook executed before tokens are transferred *out of* the maker
+     * side of the swap. When the hook should be called on the maker itself,
+     * `Interaction.target` must be the zero address.
+     */
+    readonly preTransferOutHook?: Interaction;
+    /**
+     * Optional hook executed after tokens are transferred *out of* the maker
+     * side of the swap. When the hook should be called on the maker itself,
+     * `Interaction.target` must be the zero address.
+     */
+    readonly postTransferOutHook?: Interaction;
+    private static HOOKS;
+    private static SHOULD_UNWRAP_BIT_FLAG;
+    private static USE_AQUA_INSTEAD_OF_SIGNATURE_BIT_FLAG;
+    private static ALLOW_ZERO_AMOUNT_IN;
+    private static HAS_PRE_TRANSFER_IN_HOOK_BIT_FLAG;
+    private static HAS_POST_TRANSFER_IN_HOOK_BIT_FLAG;
+    private static HAS_PRE_TRANSFER_OUT_HOOK_BIT_FLAG;
+    private static HAS_POST_TRANSFER_OUT_HOOK_BIT_FLAG;
+    private static PRE_TRANSFER_IN_HOOK_HAS_TARGET;
+    private static POST_TRANSFER_IN_HOOK_HAS_TARGET;
+    private static PRE_TRANSFER_OUT_HOOK_HAS_TARGET;
+    private static POST_TRANSFER_OUT_HOOK_HAS_TARGET;
+    private static CUSTOM_RECEIVER_MASK;
+    private static HOOKS_DATA_OFFSETS_MASK;
+    constructor(
+    /**
+     * If true, maker WETH proceeds are unwrapped into the native currency when
+     * the order is settled.
+     */
+    shouldUnwrap: boolean, 
+    /**
+     * If true, the order is intended to be authenticated via Aqua (push-based
+     * mechanism) instead of a traditional ECDSA signature.
+     */
+    useAquaInsteadOfSignature: boolean, 
+    /**
+     * If true, the order accepts `amountIn = 0`. This is useful for flows
+     * where the effective input is determined by hooks or Aqua rather than the
+     * taker-supplied amount.
+     */
+    allowZeroAmountIn: boolean, 
+    /**
+     * Optional receiver of the maker's output assets. When omitted or equal to
+     * the zero address, the maker address is used as the receiver.
+     */
+    customReceiver?: Address, 
+    /**
+     * Optional hook executed before tokens are transferred *into* the maker
+     * side of the swap. The `Interaction` can carry both target and calldata.
+     * When the hook should be called on the maker itself, `Interaction.target`
+     * must be the zero address.
+     */
+    preTransferInHook?: Interaction, 
+    /**
+     * Optional hook executed after tokens are transferred *into* the maker
+     * side of the swap. When the hook should be called on the maker itself,
+     * `Interaction.target` must be the zero address.
+     */
+    postTransferInHook?: Interaction, 
+    /**
+     * Optional hook executed before tokens are transferred *out of* the maker
+     * side of the swap. When the hook should be called on the maker itself,
+     * `Interaction.target` must be the zero address.
+     */
+    preTransferOutHook?: Interaction, 
+    /**
+     * Optional hook executed after tokens are transferred *out of* the maker
+     * side of the swap. When the hook should be called on the maker itself,
+     * `Interaction.target` must be the zero address.
+     */
+    postTransferOutHook?: Interaction);
+    /**
+     * Construct traits from a plain data object.
+     */
+    static new(data: DataFor<MakerTraits>): MakerTraits;
+    /**
+     * Create traits with library defaults that match the on-chain SwapVM expectations:
+     * - `useAquaInsteadOfSignature` = `true`
+     * - `shouldUnwrap`             = `false`
+     * - `allowZeroAmountIn`        = `false`
+     * - no receiver or hooks configured.
+     */
+    static default(): MakerTraits;
+    /**
+     * Decode ABI-level representation into a `MakerTraits` instance.
+     *
+     * @param traits    Packed `uint256` bitfield as produced by {@link encode}.
+     * @param hooksData Concatenated hooks payloads in the format expected by SwapVM
+     *                  contracts (may be `HexString.EMPTY` when no hooks are present).
+     *
+     * Both arguments are typically obtained from contract storage / ABI and must
+     * follow the bit layout described in the class-level documentation.
+     */
+    static decode(traits: bigint, hooksData?: any): MakerTraits;
+    static hooksDataEndsAtByte(traits: bigint): number;
+    /**
+     * Mutate the traits instance in-place with a partial update and return it.
+     *
+     * This is primarily used for fluent-style construction in tests and examples, e.g.:
+     *
+     * `MakerTraits.default().with({ shouldUnwrap: true })`
+     *
+     * Only fields present in `data` are updated; flags, receiver, and hooks can be
+     * changed independently.
+     */
+    with(data: Partial<DataFor<MakerTraits>>): this;
+    /**
+     * Encode traits into the ABI format expected by SwapVM contracts.
+     *
+     * @param maker - Maker address for this order. This parameter is required only
+     *                for gas/size optimisation; if omitted, any non-zero hook `target`
+     *                is treated as an explicit target.
+     *
+     * @returns An object containing:
+     *   - `traits`    - Packed `uint256` bitfield with flags, receiver and offsets
+     *   - `hooksData` - Concatenation of hook segments for all configured hooks
+     *
+     * ## Bit Layout of `traits` (uint256)
+     *
+     * ```
+     * 255                                                          0
+     * +------------+----------------------------+------------------+
+     * | Flags      | Hook Offsets (4×uint16)    | Receiver Address |
+     * | [255-245]  | [223-160]                  | [159-0]          |
+     * +------------+----------------------------+------------------+
+     * ```
+     *
+     * ## Flags (by bit index)
+     *
+     * | Bit | Flag Name                                |
+     * |-----|------------------------------------------|
+     * | 255 | SHOULD_UNWRAP_BIT_FLAG                   |
+     * | 254 | USE_AQUA_INSTEAD_OF_SIGNATURE_BIT_FLAG   |
+     * | 253 | ALLOW_ZERO_AMOUNT_IN                     |
+     * | 252 | HAS_PRE_TRANSFER_IN_HOOK_BIT_FLAG        |
+     * | 251 | HAS_POST_TRANSFER_IN_HOOK_BIT_FLAG       |
+     * | 250 | HAS_PRE_TRANSFER_OUT_HOOK_BIT_FLAG       |
+     * | 249 | HAS_POST_TRANSFER_OUT_HOOK_BIT_FLAG      |
+     * | 248 | PRE_TRANSFER_IN_HOOK_HAS_TARGET          |
+     * | 247 | POST_TRANSFER_IN_HOOK_HAS_TARGET         |
+     * | 246 | PRE_TRANSFER_OUT_HOOK_HAS_TARGET         |
+     * | 245 | POST_TRANSFER_OUT_HOOK_HAS_TARGET        |
+     */
+    encode(maker?: Address): {
+        traits: bigint;
+        hooksData: HexString;
+    };
+    private hasTargetForHook;
+}

package/dist/swap-vm/maker-traits.d.ts

@@ -0,0 +1,206 @@
+import type { DataFor } from '@1inch/sdk-core';
+import { Interaction, HexString, Address } from '@1inch/sdk-core';
+/**
+ * Maker-side order configuration packed into a single `uint256` and an optional hooks data blob.
+ *
+ * This class mirrors the on-chain `MakerTraits` bit layout and encoding used by the SwapVM
+ * contracts. It is responsible for:
+ *
+ * - maker preferences (unwrap WETH, allow zero amount in, Aqua vs signature)
+ * - selecting an optional custom receiver
+ * - wiring pre/post transfer hooks and their optional targets/payloads
+ *
+ * The ABI-level representation is:
+ * - `traits`  – a `uint256` where:
+ *   - high bits 245–255 store boolean flags
+ *   - bits 160–223 store cumulative offsets for hook data slices (4 × `uint16`)
+ *   - bits   0–159 store the receiver address (0 means "maker")
+ * - `hooksData` – concatenation of hook payloads in the order:
+ *   `preTransferIn`, `postTransferIn`, `preTransferOut`, `postTransferOut`
+ */
+export declare class MakerTraits {
+    /**
+     * If true, maker WETH proceeds are unwrapped into the native currency when
+     * the order is settled.
+     */
+    readonly shouldUnwrap: boolean;
+    /**
+     * If true, the order is intended to be authenticated via Aqua (push-based
+     * mechanism) instead of a traditional ECDSA signature.
+     */
+    readonly useAquaInsteadOfSignature: boolean;
+    /**
+     * If true, the order accepts `amountIn = 0`. This is useful for flows
+     * where the effective input is determined by hooks or Aqua rather than the
+     * taker-supplied amount.
+     */
+    readonly allowZeroAmountIn: boolean;
+    /**
+     * Optional receiver of the maker's output assets. When omitted or equal to
+     * the zero address, the maker address is used as the receiver.
+     */
+    readonly customReceiver?: Address;
+    /**
+     * Optional hook executed before tokens are transferred *into* the maker
+     * side of the swap. The `Interaction` can carry both target and calldata.
+     * When the hook should be called on the maker itself, `Interaction.target`
+     * must be the zero address.
+     */
+    readonly preTransferInHook?: Interaction;
+    /**
+     * Optional hook executed after tokens are transferred *into* the maker
+     * side of the swap. When the hook should be called on the maker itself,
+     * `Interaction.target` must be the zero address.
+     */
+    readonly postTransferInHook?: Interaction;
+    /**
+     * Optional hook executed before tokens are transferred *out of* the maker
+     * side of the swap. When the hook should be called on the maker itself,
+     * `Interaction.target` must be the zero address.
+     */
+    readonly preTransferOutHook?: Interaction;
+    /**
+     * Optional hook executed after tokens are transferred *out of* the maker
+     * side of the swap. When the hook should be called on the maker itself,
+     * `Interaction.target` must be the zero address.
+     */
+    readonly postTransferOutHook?: Interaction;
+    private static HOOKS;
+    private static SHOULD_UNWRAP_BIT_FLAG;
+    private static USE_AQUA_INSTEAD_OF_SIGNATURE_BIT_FLAG;
+    private static ALLOW_ZERO_AMOUNT_IN;
+    private static HAS_PRE_TRANSFER_IN_HOOK_BIT_FLAG;
+    private static HAS_POST_TRANSFER_IN_HOOK_BIT_FLAG;
+    private static HAS_PRE_TRANSFER_OUT_HOOK_BIT_FLAG;
+    private static HAS_POST_TRANSFER_OUT_HOOK_BIT_FLAG;
+    private static PRE_TRANSFER_IN_HOOK_HAS_TARGET;
+    private static POST_TRANSFER_IN_HOOK_HAS_TARGET;
+    private static PRE_TRANSFER_OUT_HOOK_HAS_TARGET;
+    private static POST_TRANSFER_OUT_HOOK_HAS_TARGET;
+    private static CUSTOM_RECEIVER_MASK;
+    private static HOOKS_DATA_OFFSETS_MASK;
+    constructor(
+    /**
+     * If true, maker WETH proceeds are unwrapped into the native currency when
+     * the order is settled.
+     */
+    shouldUnwrap: boolean, 
+    /**
+     * If true, the order is intended to be authenticated via Aqua (push-based
+     * mechanism) instead of a traditional ECDSA signature.
+     */
+    useAquaInsteadOfSignature: boolean, 
+    /**
+     * If true, the order accepts `amountIn = 0`. This is useful for flows
+     * where the effective input is determined by hooks or Aqua rather than the
+     * taker-supplied amount.
+     */
+    allowZeroAmountIn: boolean, 
+    /**
+     * Optional receiver of the maker's output assets. When omitted or equal to
+     * the zero address, the maker address is used as the receiver.
+     */
+    customReceiver?: Address, 
+    /**
+     * Optional hook executed before tokens are transferred *into* the maker
+     * side of the swap. The `Interaction` can carry both target and calldata.
+     * When the hook should be called on the maker itself, `Interaction.target`
+     * must be the zero address.
+     */
+    preTransferInHook?: Interaction, 
+    /**
+     * Optional hook executed after tokens are transferred *into* the maker
+     * side of the swap. When the hook should be called on the maker itself,
+     * `Interaction.target` must be the zero address.
+     */
+    postTransferInHook?: Interaction, 
+    /**
+     * Optional hook executed before tokens are transferred *out of* the maker
+     * side of the swap. When the hook should be called on the maker itself,
+     * `Interaction.target` must be the zero address.
+     */
+    preTransferOutHook?: Interaction, 
+    /**
+     * Optional hook executed after tokens are transferred *out of* the maker
+     * side of the swap. When the hook should be called on the maker itself,
+     * `Interaction.target` must be the zero address.
+     */
+    postTransferOutHook?: Interaction);
+    /**
+     * Construct traits from a plain data object.
+     */
+    static new(data: DataFor<MakerTraits>): MakerTraits;
+    /**
+     * Create traits with library defaults that match the on-chain SwapVM expectations:
+     * - `useAquaInsteadOfSignature` = `true`
+     * - `shouldUnwrap`             = `false`
+     * - `allowZeroAmountIn`        = `false`
+     * - no receiver or hooks configured.
+     */
+    static default(): MakerTraits;
+    /**
+     * Decode ABI-level representation into a `MakerTraits` instance.
+     *
+     * @param traits    Packed `uint256` bitfield as produced by {@link encode}.
+     * @param hooksData Concatenated hooks payloads in the format expected by SwapVM
+     *                  contracts (may be `HexString.EMPTY` when no hooks are present).
+     *
+     * Both arguments are typically obtained from contract storage / ABI and must
+     * follow the bit layout described in the class-level documentation.
+     */
+    static decode(traits: bigint, hooksData?: any): MakerTraits;
+    static hooksDataEndsAtByte(traits: bigint): number;
+    /**
+     * Mutate the traits instance in-place with a partial update and return it.
+     *
+     * This is primarily used for fluent-style construction in tests and examples, e.g.:
+     *
+     * `MakerTraits.default().with({ shouldUnwrap: true })`
+     *
+     * Only fields present in `data` are updated; flags, receiver, and hooks can be
+     * changed independently.
+     */
+    with(data: Partial<DataFor<MakerTraits>>): this;
+    /**
+     * Encode traits into the ABI format expected by SwapVM contracts.
+     *
+     * @param maker - Maker address for this order. This parameter is required only
+     *                for gas/size optimisation; if omitted, any non-zero hook `target`
+     *                is treated as an explicit target.
+     *
+     * @returns An object containing:
+     *   - `traits`    - Packed `uint256` bitfield with flags, receiver and offsets
+     *   - `hooksData` - Concatenation of hook segments for all configured hooks
+     *
+     * ## Bit Layout of `traits` (uint256)
+     *
+     * ```
+     * 255                                                          0
+     * +------------+----------------------------+------------------+
+     * | Flags      | Hook Offsets (4×uint16)    | Receiver Address |
+     * | [255-245]  | [223-160]                  | [159-0]          |
+     * +------------+----------------------------+------------------+
+     * ```
+     *
+     * ## Flags (by bit index)
+     *
+     * | Bit | Flag Name                                |
+     * |-----|------------------------------------------|
+     * | 255 | SHOULD_UNWRAP_BIT_FLAG                   |
+     * | 254 | USE_AQUA_INSTEAD_OF_SIGNATURE_BIT_FLAG   |
+     * | 253 | ALLOW_ZERO_AMOUNT_IN                     |
+     * | 252 | HAS_PRE_TRANSFER_IN_HOOK_BIT_FLAG        |
+     * | 251 | HAS_POST_TRANSFER_IN_HOOK_BIT_FLAG       |
+     * | 250 | HAS_PRE_TRANSFER_OUT_HOOK_BIT_FLAG       |
+     * | 249 | HAS_POST_TRANSFER_OUT_HOOK_BIT_FLAG      |
+     * | 248 | PRE_TRANSFER_IN_HOOK_HAS_TARGET          |
+     * | 247 | POST_TRANSFER_IN_HOOK_HAS_TARGET         |
+     * | 246 | PRE_TRANSFER_OUT_HOOK_HAS_TARGET         |
+     * | 245 | POST_TRANSFER_OUT_HOOK_HAS_TARGET        |
+     */
+    encode(maker?: Address): {
+        traits: bigint;
+        hooksData: HexString;
+    };
+    private hasTargetForHook;
+}