@1inch/swap-vm-sdk 0.1.0

package/dist/swap-vm/programs/regular-program-builder.d.ts

@@ -0,0 +1,187 @@
+import type { DataFor } from '@1inch/sdk-core';
+import { ProgramBuilder } from './program-builder';
+import type { SwapVmProgram } from './swap-vm-program';
+import * as balances from '../instructions/balances';
+import * as controls from '../instructions/controls';
+import * as invalidators from '../instructions/invalidators';
+import * as concentrate from '../instructions/concentrate';
+import * as decay from '../instructions/decay';
+import * as limitSwap from '../instructions/limit-swap';
+import * as minRate from '../instructions/min-rate';
+import * as dutchAuction from '../instructions/dutch-auction';
+import * as oraclePriceAdjuster from '../instructions/oracle-price-adjuster';
+import * as baseFeeAdjuster from '../instructions/base-fee-adjuster';
+import * as twapSwap from '../instructions/twap-swap';
+import * as fee from '../instructions/fee';
+import * as extruction from '../instructions/extruction';
+export declare class RegularProgramBuilder extends ProgramBuilder {
+    constructor();
+    static decode(program: SwapVmProgram): RegularProgramBuilder;
+    /**
+     * Enables debug mode for the program
+     * WARNING: Debug instructions will throw an error if debug mode is not enabled
+     */
+    withDebug(): this;
+    /**
+     * Sets initial token balances for the swap program
+     **/
+    staticBalancesXD(data: DataFor<balances.BalancesArgs>): this;
+    /**
+     * Reads token balances from program data or contract storage
+     **/
+    dynamicBalancesXD(data: DataFor<balances.BalancesArgs>): this;
+    /**
+     * Unconditional jump to specified program counter
+     **/
+    jump(data: DataFor<controls.JumpArgs>): this;
+    /**
+     * Jumps if tokenIn is the specified token
+     **/
+    jumpIfTokenIn(data: DataFor<controls.JumpIfTokenArgs>): this;
+    /**
+     * Jumps if tokenOut is the specified token
+     **/
+    jumpIfTokenOut(data: DataFor<controls.JumpIfTokenArgs>): this;
+    /**
+     * Reverts if the deadline has been reached
+     **/
+    deadline(data: DataFor<controls.DeadlineArgs>): this;
+    /**
+     * Requires taker to hold any amount of specified token (supports NFTs)
+     **/
+    onlyTakerTokenBalanceNonZero(data: DataFor<controls.OnlyTakerTokenBalanceNonZeroArgs>): this;
+    /**
+     * Requires taker to hold at least specified amount of token
+     **/
+    onlyTakerTokenBalanceGte(data: DataFor<controls.OnlyTakerTokenBalanceGteArgs>): this;
+    /**
+     * Requires taker to hold at least specified share of token's total supply
+     **/
+    onlyTakerTokenSupplyShareGte(data: DataFor<controls.OnlyTakerTokenSupplyShareGteArgs>): this;
+    /**
+     * No-op instruction used to add uniqueness to order hashes (prevents replay attacks)
+     **/
+    salt(data: DataFor<controls.SaltArgs>): this;
+    /**
+     * Invalidates a specific bit index for order uniqueness
+     **/
+    invalidateBit1D(data: DataFor<invalidators.InvalidateBit1DArgs>): this;
+    /**
+     * Invalidates order by token input to prevent re-use
+     **/
+    invalidateTokenIn1D(): this;
+    /**
+     * Invalidates order by token output to prevent re-use
+     **/
+    invalidateTokenOut1D(): this;
+    /**
+     * Basic swap using constant product formula (x*y=k)
+     **/
+    xycSwapXD(): this;
+    /**
+     * Concentrates liquidity within price bounds for multiple tokens
+     **/
+    concentrateGrowLiquidityXD(data: DataFor<concentrate.ConcentrateGrowLiquidityXDArgs>): this;
+    /**
+     * Concentrates liquidity within price bounds for two tokens
+     **/
+    concentrateGrowLiquidity2D(data: DataFor<concentrate.ConcentrateGrowLiquidity2DArgs>): this;
+    /**
+     * Applies time-based decay to balance adjustments
+     **/
+    decayXD(data: DataFor<decay.DecayXDArgs>): this;
+    /**
+     * Limit order swap with proportional execution
+     **/
+    limitSwap1D(data: DataFor<limitSwap.LimitSwapDirectionArgs>): this;
+    /**
+     * Limit order swap requiring full amount execution
+     **/
+    limitSwapOnlyFull1D(data: DataFor<limitSwap.LimitSwapDirectionArgs>): this;
+    /**
+     * Enforces minimum exchange rate or reverts
+     **/
+    requireMinRate1D(data: DataFor<minRate.MinRateArgs>): this;
+    /**
+     * Adjusts swap amounts to meet minimum rate if needed
+     **/
+    adjustMinRate1D(data: DataFor<minRate.MinRateArgs>): this;
+    /**
+     * Dutch auction with time-based decay on amountIn
+     **/
+    dutchAuctionBalanceIn1D(data: DataFor<dutchAuction.DutchAuctionArgs>): this;
+    /**
+     * Dutch auction with time-based decay on amountOut
+     **/
+    dutchAuctionBalanceOut1D(data: DataFor<dutchAuction.DutchAuctionArgs>): this;
+    /**
+     * Adjusts swap prices based on Chainlink oracle feeds
+     **/
+    oraclePriceAdjuster1D(data: DataFor<oraclePriceAdjuster.OraclePriceAdjusterArgs>): this;
+    /**
+     * Adjusts swap prices based on network gas costs
+     **/
+    baseFeeAdjuster1D(data: DataFor<baseFeeAdjuster.BaseFeeAdjusterArgs>): this;
+    /**
+     * TWAP trading with exponential dutch auction and illiquidity handling
+     **/
+    twap(data: DataFor<twapSwap.TWAPSwapArgs>): this;
+    /**
+     * Calls external contract to perform custom logic
+     **/
+    extruction(data: DataFor<extruction.ExtructionArgs>): this;
+    /**
+     * Applies fee to amountIn
+     **/
+    flatFeeAmountInXD(data: DataFor<fee.FlatFeeArgs>): this;
+    /**
+     * Applies fee to amountOut
+     **/
+    flatFeeAmountOutXD(data: DataFor<fee.FlatFeeArgs>): this;
+    /**
+     * Applies progressive fee to amountIn
+     **/
+    progressiveFeeInXD(data: DataFor<fee.FlatFeeArgs>): this;
+    /**
+     * Applies progressive fee to amountOut
+     **/
+    progressiveFeeOutXD(data: DataFor<fee.FlatFeeArgs>): this;
+    /**
+     * Applies protocol fee to amountOut with direct transfer
+     **/
+    protocolFeeAmountOutXD(data: DataFor<fee.ProtocolFeeArgs>): this;
+    /**
+     * Applies protocol fee to amountOut through Aqua protocol
+     **/
+    aquaProtocolFeeAmountOutXD(data: DataFor<fee.ProtocolFeeArgs>): this;
+    /**
+     * DEBUG: Prints current swap registers (amounts and tokens)
+     * WARNING: Requires withDebug() to be called first, otherwise will throw an error
+     */
+    debugPrintSwapRegisters(): this;
+    /**
+     * DEBUG: Prints current swap query state
+     * WARNING: Requires withDebug() to be called first, otherwise will throw an error
+     */
+    debugPrintSwapQuery(): this;
+    /**
+     * DEBUG: Prints execution context information
+     * WARNING: Requires withDebug() to be called first, otherwise will throw an error
+     */
+    debugPrintContext(): this;
+    /**
+     * DEBUG: Prints calculated amount for swap
+     * WARNING: Requires withDebug() to be called first, otherwise will throw an error
+     */
+    debugPrintAmountForSwap(): this;
+    /**
+     * DEBUG: Prints current free memory pointer value
+     * WARNING: Requires withDebug() to be called first, otherwise will throw an error
+     */
+    debugPrintFreeMemoryPointer(): this;
+    /**
+     * DEBUG: Prints remaining gas
+     * WARNING: Requires withDebug() to be called first, otherwise will throw an error
+     */
+    debugPrintGasLeft(): this;
+}

package/dist/swap-vm/programs/swap-vm-program.d.mts

@@ -0,0 +1,6 @@
+import { HexString } from '@1inch/sdk-core';
+/**
+ * Represents encoded SwapVM program bytecode
+ **/
+export declare class SwapVmProgram extends HexString {
+}

package/dist/swap-vm/programs/swap-vm-program.d.ts

@@ -0,0 +1,6 @@
+import { HexString } from '@1inch/sdk-core';
+/**
+ * Represents encoded SwapVM program bytecode
+ **/
+export declare class SwapVmProgram extends HexString {
+}

package/dist/swap-vm/strategies/aqua-amm-strategy.d.mts

@@ -0,0 +1,32 @@
+import type { Address } from '@1inch/sdk-core';
+import type { SwapVmProgram } from '../programs';
+/**
+ * Aqua AMM Strategy builder that mirrors AquaAMM.sol
+ * @see https://github.com/1inch/swap-vm/blob/main/src/strategies/AquaAMM.sol
+ */
+export declare class AquaAMMStrategy {
+    readonly tokenA: Address;
+    readonly tokenB: Address;
+    feeBpsIn?: number;
+    deltas?: {
+        a: bigint;
+        b: bigint;
+    };
+    decayPeriod?: bigint;
+    protocolFee?: {
+        bps: number;
+        receiver: Address;
+    };
+    salt?: bigint;
+    constructor(tokenA: Address, tokenB: Address);
+    static new(tokens: {
+        tokenA: Address;
+        tokenB: Address;
+    }): AquaAMMStrategy;
+    withProtocolFee(bps: number, receiver: Address): this;
+    withDeltas(a: bigint, b: bigint): this;
+    withDecayPeriod(decayPeriod: bigint): this;
+    withFeeTokenIn(bps: number): this;
+    withSalt(salt: bigint): this;
+    build(): SwapVmProgram;
+}

package/dist/swap-vm/strategies/aqua-amm-strategy.d.ts

@@ -0,0 +1,32 @@
+import type { Address } from '@1inch/sdk-core';
+import type { SwapVmProgram } from '../programs';
+/**
+ * Aqua AMM Strategy builder that mirrors AquaAMM.sol
+ * @see https://github.com/1inch/swap-vm/blob/main/src/strategies/AquaAMM.sol
+ */
+export declare class AquaAMMStrategy {
+    readonly tokenA: Address;
+    readonly tokenB: Address;
+    feeBpsIn?: number;
+    deltas?: {
+        a: bigint;
+        b: bigint;
+    };
+    decayPeriod?: bigint;
+    protocolFee?: {
+        bps: number;
+        receiver: Address;
+    };
+    salt?: bigint;
+    constructor(tokenA: Address, tokenB: Address);
+    static new(tokens: {
+        tokenA: Address;
+        tokenB: Address;
+    }): AquaAMMStrategy;
+    withProtocolFee(bps: number, receiver: Address): this;
+    withDeltas(a: bigint, b: bigint): this;
+    withDecayPeriod(decayPeriod: bigint): this;
+    withFeeTokenIn(bps: number): this;
+    withSalt(salt: bigint): this;
+    build(): SwapVmProgram;
+}

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

@@ -0,0 +1 @@
+export * from './aqua-amm-strategy';

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

@@ -0,0 +1 @@
+export * from './aqua-amm-strategy';

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

@@ -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;
+}