Skip to main content

SwapExecutionStepSetup<Chain>

type SwapExecutionStepSetup<Chain> = object;

Defined in: atomiq-sdk/src/types/SwapExecutionStep.ts:6

Execution step describing destination-side setup required before the swap can continue.

Type Parameters

Type ParameterDefault type
Chain extends stringstring

Properties

chain

chain: Chain;

Defined in: atomiq-sdk/src/types/SwapExecutionStep.ts:9


description

description: string;

Defined in: atomiq-sdk/src/types/SwapExecutionStep.ts:11


setupTxId?

optional setupTxId: string;

Defined in: atomiq-sdk/src/types/SwapExecutionStep.ts:21


side

side: "destination";

Defined in: atomiq-sdk/src/types/SwapExecutionStep.ts:8


status

status: "awaiting" | "completed" | "soft_expired" | "expired";

Defined in: atomiq-sdk/src/types/SwapExecutionStep.ts:20

Current status of the setup step.

  • awaiting: The setup transaction or action still needs to be performed.
  • completed: The setup was already completed successfully.
  • soft_expired: The setup should be treated as expired by the user, but it may still progress because of in-flight or background processing.
  • expired: The setup can no longer be performed because the swap expired.

title

title: string;

Defined in: atomiq-sdk/src/types/SwapExecutionStep.ts:10


type

type: "Setup";

Defined in: atomiq-sdk/src/types/SwapExecutionStep.ts:7