Skip to main content

SwapExecutionStepSettlement<Chain, AdditionalStatuses>

type SwapExecutionStepSettlement<Chain, AdditionalStatuses> = object;

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

Execution step describing payout or settlement on the destination side of the swap.

Type Parameters

Type ParameterDefault type
Chain extends stringstring
AdditionalStatuses extends "awaiting_automatic" | "awaiting_manual" | "soft_settled""awaiting_automatic" | "awaiting_manual" | "soft_settled"

Properties

chain

chain: Chain;

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


description

description: string;

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


initTxId?

optional initTxId: string;

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


settleTxId?

optional settleTxId: string;

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


side

side: "destination";

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


status

status:
| "inactive"
| "waiting_lp"
| "soft_expired"
| "settled"
| "expired"
| AdditionalStatuses;

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

Current status of the settlement step.

  • inactive: The settlement step is not yet active because a previous step must complete first.
  • waiting_lp: The swap is waiting for the intermediary (LP) to create or process the destination-side payout.
  • awaiting_automatic: The swap is waiting for automatic settlement by watchtowers.
  • awaiting_manual: The swap is ready for manual destination-side settlement by the user.
  • soft_settled: The user already received the payout, but the swap is not yet fully finalized on the source side.
  • soft_expired: The settlement should be treated as expired by the user, but it may still progress because of in-flight or background processing.
  • settled: The settlement completed successfully.
  • expired: Settlement is no longer possible because the swap expired or failed.

title

title: string;

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


type

type: "Settlement";

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