@1inch/swap-vm-sdk 0.1.0

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

@@ -0,0 +1,214 @@
+import type { DataFor } from '@1inch/sdk-core';
+import { Address, HexString } from '@1inch/sdk-core';
+/**
+ * TakerTraits encodes taker-specific parameters and flags for swap execution.
+ * It defines how the taker wants the swap to be executed, including thresholds,
+ * callbacks, hooks, and other execution parameters.
+ */
+export declare class TakerTraits {
+    /**
+     * If true, the taker specifies the exact input amount.
+     * If false, the taker specifies the exact output amount.
+     */
+    readonly exactIn: boolean;
+    /**
+     * If true, WETH proceeds are unwrapped into native currency when
+     * the order is settled.
+     */
+    readonly shouldUnwrap: boolean;
+    /**
+     * If true, enables pre-transfer-in callback to the taker contract.
+     * The callback flag is automatically set based on preTransferInCallbackData presence.
+     */
+    readonly preTransferInCallbackEnabled: boolean;
+    /**
+     * If true, enables pre-transfer-out callback to the taker contract.
+     * The callback flag is automatically set based on preTransferOutCallbackData presence.
+     */
+    readonly preTransferOutCallbackEnabled: boolean;
+    /**
+     * If true, requires the exact threshold amount (no slippage tolerance).
+     * If false, allows better rates than threshold.
+     */
+    readonly strictThreshold: boolean;
+    /**
+     * If true, the first transfer is from the taker.
+     * If false, it may be from another source (e.g., via Aqua).
+     */
+    readonly firstTransferFromTaker: boolean;
+    /**
+     * If true, uses transferFrom and Aqua push mechanism.
+     * If false, uses standard transfer mechanism.
+     */
+    readonly useTransferFromAndAquaPush: boolean;
+    /**
+     * Minimum output amount (for exactIn) or maximum input amount (for exactOut).
+     * Set to 0n for no threshold.
+     */
+    readonly threshold: bigint;
+    /**
+     * Custom receiver address for the swap output.
+     * Defaults to zero address (meaning taker receives funds).
+     */
+    readonly customReceiver: Address;
+    /**
+     * Optional data passed to the maker's pre-transfer-in hook.
+     */
+    readonly preTransferInHookData: HexString;
+    /**
+     * Optional data passed to the maker's post-transfer-in hook.
+     */
+    readonly postTransferInHookData: HexString;
+    /**
+     * Optional data passed to the maker's pre-transfer-out hook.
+     */
+    readonly preTransferOutHookData: HexString;
+    /**
+     * Optional data passed to the maker's post-transfer-out hook.
+     */
+    readonly postTransferOutHookData: HexString;
+    /**
+     * Optional callback data for taker's pre-transfer-in callback.
+     */
+    readonly preTransferInCallbackData: HexString;
+    /**
+     * Optional callback data for taker's pre-transfer-out callback.
+     */
+    readonly preTransferOutCallbackData: HexString;
+    /**
+     * Optional arguments for VM instructions execution.
+     */
+    readonly instructionsArgs: HexString;
+    /**
+     * ECDSA signature for order validation (65 bytes typically).
+     * Can be empty when using Aqua authentication.
+     */
+    readonly signature: HexString;
+    private static readonly IS_EXACT_IN_BIT_FLAG;
+    private static readonly SHOULD_UNWRAP_BIT_FLAG;
+    private static readonly HAS_PRE_TRANSFER_IN_CALLBACK_BIT_FLAG;
+    private static readonly HAS_PRE_TRANSFER_OUT_CALLBACK_BIT_FLAG;
+    private static readonly IS_STRICT_THRESHOLD_BIT_FLAG;
+    private static readonly IS_FIRST_TRANSFER_FROM_TAKER_BIT_FLAG;
+    private static readonly USE_TRANSFER_FROM_AND_AQUA_PUSH_FLAG;
+    constructor(
+    /**
+     * If true, the taker specifies the exact input amount.
+     * If false, the taker specifies the exact output amount.
+     */
+    exactIn: boolean, 
+    /**
+     * If true, WETH proceeds are unwrapped into native currency when
+     * the order is settled.
+     */
+    shouldUnwrap: boolean, 
+    /**
+     * If true, enables pre-transfer-in callback to the taker contract.
+     * The callback flag is automatically set based on preTransferInCallbackData presence.
+     */
+    preTransferInCallbackEnabled: boolean, 
+    /**
+     * If true, enables pre-transfer-out callback to the taker contract.
+     * The callback flag is automatically set based on preTransferOutCallbackData presence.
+     */
+    preTransferOutCallbackEnabled: boolean, 
+    /**
+     * If true, requires the exact threshold amount (no slippage tolerance).
+     * If false, allows better rates than threshold.
+     */
+    strictThreshold: boolean, 
+    /**
+     * If true, the first transfer is from the taker.
+     * If false, it may be from another source (e.g., via Aqua).
+     */
+    firstTransferFromTaker: boolean, 
+    /**
+     * If true, uses transferFrom and Aqua push mechanism.
+     * If false, uses standard transfer mechanism.
+     */
+    useTransferFromAndAquaPush: boolean, 
+    /**
+     * Minimum output amount (for exactIn) or maximum input amount (for exactOut).
+     * Set to 0n for no threshold.
+     */
+    threshold?: bigint, 
+    /**
+     * Custom receiver address for the swap output.
+     * Defaults to zero address (meaning taker receives funds).
+     */
+    customReceiver?: Address, 
+    /**
+     * Optional data passed to the maker's pre-transfer-in hook.
+     */
+    preTransferInHookData?: HexString, 
+    /**
+     * Optional data passed to the maker's post-transfer-in hook.
+     */
+    postTransferInHookData?: HexString, 
+    /**
+     * Optional data passed to the maker's pre-transfer-out hook.
+     */
+    preTransferOutHookData?: HexString, 
+    /**
+     * Optional data passed to the maker's post-transfer-out hook.
+     */
+    postTransferOutHookData?: HexString, 
+    /**
+     * Optional callback data for taker's pre-transfer-in callback.
+     */
+    preTransferInCallbackData?: HexString, 
+    /**
+     * Optional callback data for taker's pre-transfer-out callback.
+     */
+    preTransferOutCallbackData?: HexString, 
+    /**
+     * Optional arguments for VM instructions execution.
+     */
+    instructionsArgs?: HexString, 
+    /**
+     * ECDSA signature for order validation (65 bytes typically).
+     * Can be empty when using Aqua authentication.
+     */
+    signature?: HexString);
+    /**
+     * Creates a new TakerTraits instance with the specified data.
+     * Provides default values for unspecified fields.
+     */
+    static new(data?: Partial<DataFor<TakerTraits>>): TakerTraits;
+    /**
+     * Creates a default TakerTraits instance with standard settings.
+     * - exactIn mode
+     * - No unwrapping
+     * - No callbacks
+     * - No custom receiver
+     * - transferFromAndAquaPush enabled
+     */
+    static default(): TakerTraits;
+    /**
+     * Decodes a packed TakerTraits from a hex string.
+     * The packed format consists of:
+     * - 18 bytes: 9 uint16 offsets for data sections
+     * - 2 bytes: uint16 flags
+     * - Variable: data sections (threshold, to, hook data, callback data, etc.)
+     * - Variable: signature
+     */
+    static decode(packed: HexString): TakerTraits;
+    /**
+     * Creates a new instance with updated fields.
+     * Useful for creating modified versions of existing TakerTraits.
+     */
+    with(data: Partial<DataFor<TakerTraits>>): this;
+    /**
+     * Encodes the TakerTraits into a packed hex string format.
+     * The encoding includes offsets, flags, data sections, and signature.
+     * Callback flags are automatically set based on callback data presence.
+     */
+    encode(): HexString;
+    /**
+     * Validates the swap amounts against the threshold settings.
+     * @param amountIn - The input amount of the swap
+     * @param amountOut - The output amount of the swap
+     * @throws Error if the amounts don't meet the threshold requirements
+     */
+    validate(amountIn: bigint, amountOut: bigint): void;
+}

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

@@ -0,0 +1,22 @@
+import { Address } from '@1inch/sdk-core';
+export type MakerTraitsBuildArgs = {
+    shouldUnwrapWeth?: boolean;
+    hasPreTransferOutHook?: boolean;
+    hasPostTransferInHook?: boolean;
+    useAquaInsteadOfSignature?: boolean;
+    ignoreAquaForTransferIn?: boolean;
+    expiration?: bigint;
+    receiver?: Address;
+    preTransferOutDataLength?: bigint;
+    postTransferInDataLength?: bigint;
+};
+export type TakerTraitsBuildArgs = {
+    isExactIn?: boolean;
+    shouldUnwrapWeth?: boolean;
+    hasPreTransferInHook?: boolean;
+    isStrictThresholdAmount?: boolean;
+    isFirstTransferFromTaker?: boolean;
+    useTransferFromAndAquaPush?: boolean;
+    threshold?: bigint;
+    customReceiver?: Address;
+};

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

@@ -0,0 +1,22 @@
+import { Address } from '@1inch/sdk-core';
+export type MakerTraitsBuildArgs = {
+    shouldUnwrapWeth?: boolean;
+    hasPreTransferOutHook?: boolean;
+    hasPostTransferInHook?: boolean;
+    useAquaInsteadOfSignature?: boolean;
+    ignoreAquaForTransferIn?: boolean;
+    expiration?: bigint;
+    receiver?: Address;
+    preTransferOutDataLength?: bigint;
+    postTransferInDataLength?: bigint;
+};
+export type TakerTraitsBuildArgs = {
+    isExactIn?: boolean;
+    shouldUnwrapWeth?: boolean;
+    hasPreTransferInHook?: boolean;
+    isStrictThresholdAmount?: boolean;
+    isFirstTransferFromTaker?: boolean;
+    useTransferFromAndAquaPush?: boolean;
+    threshold?: bigint;
+    customReceiver?: Address;
+};

package/dist/swap-vm-contract/constants.d.mts

@@ -0,0 +1,13 @@
+import { Address, NetworkEnum } from '@1inch/sdk-core';
+/**
+ * AquaSwapVMRouter contract addresses by chain ID
+ * These addresses supports only AQUA instructions set
+ *
+ * Deployed with next params
+ * - name    = `AquaSwapVMRouter`
+ * - version = `1.0.0`
+ *
+ * @see https://github.com/1inch/swap-vm/blob/8cc4c467374959af9efdb6e2b67d32d3c1083e1e/src/routers/AquaSwapVMRouter.sol#L11
+ * @see "../swap-vm/programs/aqua-program-builder"
+ */
+export declare const AQUA_SWAP_VM_CONTRACT_ADDRESSES: Record<NetworkEnum, Address>;

package/dist/swap-vm-contract/constants.d.ts

@@ -0,0 +1,13 @@
+import { Address, NetworkEnum } from '@1inch/sdk-core';
+/**
+ * AquaSwapVMRouter contract addresses by chain ID
+ * These addresses supports only AQUA instructions set
+ *
+ * Deployed with next params
+ * - name    = `AquaSwapVMRouter`
+ * - version = `1.0.0`
+ *
+ * @see https://github.com/1inch/swap-vm/blob/8cc4c467374959af9efdb6e2b67d32d3c1083e1e/src/routers/AquaSwapVMRouter.sol#L11
+ * @see "../swap-vm/programs/aqua-program-builder"
+ */
+export declare const AQUA_SWAP_VM_CONTRACT_ADDRESSES: Record<NetworkEnum, Address>;

package/dist/swap-vm-contract/events/index.d.mts

@@ -0,0 +1 @@
+export * from './swapped-event';

package/dist/swap-vm-contract/events/index.d.ts

@@ -0,0 +1 @@
+export * from './swapped-event';

package/dist/swap-vm-contract/events/swapped-event.d.mts

@@ -0,0 +1,19 @@
+import type { DataFor, LogLike } from '@1inch/sdk-core';
+import { Address, HexString } from '@1inch/sdk-core';
+export declare class SwappedEvent {
+    readonly orderHash: HexString;
+    readonly maker: Address;
+    readonly taker: Address;
+    readonly tokenIn: Address;
+    readonly tokenOut: Address;
+    readonly amountIn: bigint;
+    readonly amountOut: bigint;
+    static TOPIC: HexString;
+    constructor(orderHash: HexString, maker: Address, taker: Address, tokenIn: Address, tokenOut: Address, amountIn: bigint, amountOut: bigint);
+    static new(data: DataFor<SwappedEvent>): SwappedEvent;
+    /**
+     * Creates a SwappedEvent
+     * @throws Error if the log data is invalid or doesn't match the expected event structure
+     */
+    static fromLog(log: LogLike): SwappedEvent;
+}

package/dist/swap-vm-contract/events/swapped-event.d.ts

@@ -0,0 +1,19 @@
+import type { DataFor, LogLike } from '@1inch/sdk-core';
+import { Address, HexString } from '@1inch/sdk-core';
+export declare class SwappedEvent {
+    readonly orderHash: HexString;
+    readonly maker: Address;
+    readonly taker: Address;
+    readonly tokenIn: Address;
+    readonly tokenOut: Address;
+    readonly amountIn: bigint;
+    readonly amountOut: bigint;
+    static TOPIC: HexString;
+    constructor(orderHash: HexString, maker: Address, taker: Address, tokenIn: Address, tokenOut: Address, amountIn: bigint, amountOut: bigint);
+    static new(data: DataFor<SwappedEvent>): SwappedEvent;
+    /**
+     * Creates a SwappedEvent
+     * @throws Error if the log data is invalid or doesn't match the expected event structure
+     */
+    static fromLog(log: LogLike): SwappedEvent;
+}

package/dist/swap-vm-contract/index.d.mts

@@ -0,0 +1,4 @@
+export * from './swap-vm-contract';
+export * from './types';
+export * from './constants';
+export * from './events';

package/dist/swap-vm-contract/index.d.ts

@@ -0,0 +1,4 @@
+export * from './swap-vm-contract';
+export * from './types';
+export * from './constants';
+export * from './events';

package/dist/swap-vm-contract/swap-vm-contract.d.mts

@@ -0,0 +1,38 @@
+import type { CallInfo, Address } from '@1inch/sdk-core';
+import { HexString } from '@1inch/sdk-core';
+import type { QuoteArgs, SwapArgs } from './types';
+import type { Order } from '../swap-vm/order';
+/**
+ * SwapVM contract encoding/decoding utilities
+ */
+export declare class SwapVMContract {
+    readonly address: Address;
+    constructor(address: Address);
+    /**
+     * Encode quote function call data
+     * @see https://github.com/1inch/swap-vm/blob/main/src/SwapVM.sol#L84
+     */
+    static encodeQuoteCallData(args: QuoteArgs): HexString;
+    /**
+     * Encode `hashOrder` function call data
+     * @see https://github.com/1inch/swap-vm/blob/main/src/SwapVM.sol#L70
+     */
+    static encodeHashOrderCallData(order: Order): HexString;
+    /**
+     * Encode swap function call data
+     * @see https://github.com/1inch/swap-vm/blob/main/src/SwapVM.sol#L124
+     */
+    static encodeSwapCallData(args: SwapArgs): HexString;
+    /**
+     * Build quote transaction
+     */
+    static buildQuoteTx(contractAddress: Address, args: QuoteArgs): CallInfo;
+    /**
+     * Build swap transaction
+     */
+    static buildSwapTx(contractAddress: Address, args: SwapArgs): CallInfo;
+    static buildHashOrderTx(contractAddress: Address, order: Order): CallInfo;
+    swap(args: SwapArgs): CallInfo;
+    quote(args: QuoteArgs): CallInfo;
+    hashOrder(order: Order): CallInfo;
+}

package/dist/swap-vm-contract/swap-vm-contract.d.ts

@@ -0,0 +1,38 @@
+import type { CallInfo, Address } from '@1inch/sdk-core';
+import { HexString } from '@1inch/sdk-core';
+import type { QuoteArgs, SwapArgs } from './types';
+import type { Order } from '../swap-vm/order';
+/**
+ * SwapVM contract encoding/decoding utilities
+ */
+export declare class SwapVMContract {
+    readonly address: Address;
+    constructor(address: Address);
+    /**
+     * Encode quote function call data
+     * @see https://github.com/1inch/swap-vm/blob/main/src/SwapVM.sol#L84
+     */
+    static encodeQuoteCallData(args: QuoteArgs): HexString;
+    /**
+     * Encode `hashOrder` function call data
+     * @see https://github.com/1inch/swap-vm/blob/main/src/SwapVM.sol#L70
+     */
+    static encodeHashOrderCallData(order: Order): HexString;
+    /**
+     * Encode swap function call data
+     * @see https://github.com/1inch/swap-vm/blob/main/src/SwapVM.sol#L124
+     */
+    static encodeSwapCallData(args: SwapArgs): HexString;
+    /**
+     * Build quote transaction
+     */
+    static buildQuoteTx(contractAddress: Address, args: QuoteArgs): CallInfo;
+    /**
+     * Build swap transaction
+     */
+    static buildSwapTx(contractAddress: Address, args: SwapArgs): CallInfo;
+    static buildHashOrderTx(contractAddress: Address, order: Order): CallInfo;
+    swap(args: SwapArgs): CallInfo;
+    quote(args: QuoteArgs): CallInfo;
+    hashOrder(order: Order): CallInfo;
+}

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

@@ -0,0 +1,22 @@
+import type { Address, HexString } from '@1inch/sdk-core';
+import type { TakerTraits } from '../swap-vm';
+import type { Order } from '../swap-vm/order';
+type SwapVmSwapInfo = {
+    order: Order;
+    tokenIn: Address;
+    tokenOut: Address;
+    amount: bigint;
+    takerTraits: TakerTraits;
+};
+export type QuoteArgs = SwapVmSwapInfo;
+export type SwapArgs = SwapVmSwapInfo;
+export type QuoteResult = {
+    amountIn: bigint;
+    amountOut: bigint;
+};
+export type SwapResult = {
+    amountIn: bigint;
+    amountOut: bigint;
+    orderHash: HexString;
+};
+export {};

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

@@ -0,0 +1,22 @@
+import type { Address, HexString } from '@1inch/sdk-core';
+import type { TakerTraits } from '../swap-vm';
+import type { Order } from '../swap-vm/order';
+type SwapVmSwapInfo = {
+    order: Order;
+    tokenIn: Address;
+    tokenOut: Address;
+    amount: bigint;
+    takerTraits: TakerTraits;
+};
+export type QuoteArgs = SwapVmSwapInfo;
+export type SwapArgs = SwapVmSwapInfo;
+export type QuoteResult = {
+    amountIn: bigint;
+    amountOut: bigint;
+};
+export type SwapResult = {
+    amountIn: bigint;
+    amountOut: bigint;
+    orderHash: HexString;
+};
+export {};

package/package.json

@@ -0,0 +1,72 @@
+{
+  "name": "@1inch/swap-vm-sdk",
+  "version": "0.1.0",
+  "description": "1inch Swap VM SDK",
+  "author": "@1inch",
+  "license": "LicenseRef-Degensoft-SwapVM-1.1",
+  "repository": {
+    "type": "git",
+    "url": "ssh://git@github.com:1inch/sdks.git"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "LICENSE",
+    "README.md",
+    "package.json"
+  ],
+  "keywords": [
+    "1inch",
+    "swap-vm",
+    "sdk",
+    "defi",
+    "swap",
+    "virtual-machine"
+  ],
+  "peerDependencies": {
+    "viem": "^2.21.0"
+  },
+  "dependencies": {
+    "@1inch/byte-utils": "^3.1.7",
+    "tslib": "^2.8.1",
+    "@1inch/sdk-core": "0.1.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.13.0",
+    "dotenv": "17.2.3",
+    "eslint-plugin-license-header": "0.8.0",
+    "tsdown": "^0.2.17",
+    "typescript": "^5.7.3",
+    "vitest": "^3.2.4"
+  },
+  "volta": {
+    "node": "22.13.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "rm -rf dist && tsdown",
+    "test": "vitest run",
+    "test:e2e": "vitest run --config vitest.e2e.config.mts",
+    "test:watch": "vitest watch",
+    "test:coverage": "vitest run --coverage",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "format": "prettier --write \"src/**/*.ts\"",
+    "format:check": "prettier --check \"src/**/*.ts\"",
+    "type-check": "tsc --noEmit",
+    "clean": "rimraf dist node_modules",
+    "changelog:generate": "changelog generate -a"
+  }
+}