SwapExecutionStepRefund<Chain>
type SwapExecutionStepRefund<Chain> = object;
Defined in: atomiq-sdk/src/types/SwapExecutionStep.ts:183
Execution step describing a source-side refund path after a failed swap.
Type Parameters
| Type Parameter | Default type |
|---|---|
Chain extends string | string |
Properties
chain
chain: Chain;
Defined in: atomiq-sdk/src/types/SwapExecutionStep.ts:186
description
description: string;
Defined in: atomiq-sdk/src/types/SwapExecutionStep.ts:188
refundTxId?
optional refundTxId: string;
Defined in: atomiq-sdk/src/types/SwapExecutionStep.ts:197
side
side: "source";
Defined in: atomiq-sdk/src/types/SwapExecutionStep.ts:185
status
status: "inactive" | "awaiting" | "refunded";
Defined in: atomiq-sdk/src/types/SwapExecutionStep.ts:196
Current status of the refund step.
inactive: The refund path is not currently available.awaiting: The swap can be refunded and the user may perform the refund action.refunded: The refund was completed successfully.
title
title: string;
Defined in: atomiq-sdk/src/types/SwapExecutionStep.ts:187
type
type: "Refund";
Defined in: atomiq-sdk/src/types/SwapExecutionStep.ts:184