Skip to main content

SwapExecutionStepPayment<Chain>

type SwapExecutionStepPayment<Chain> = object;

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

Execution step describing the user payment that initiates or funds the swap.

Type Parameters​

Type ParameterDefault type
Chain extends stringstring

Properties​

chain​

chain: Chain;

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

confirmations?​

optional confirmations: object;

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

Optional confirmation progress for Bitcoin on-chain payments.

current​

current: number;

Number of confirmations currently observed for the payment.

etaSeconds​

etaSeconds: number;

Estimated remaining time in seconds until the target confirmation count is reached.

Can be -1 if the estimate is not available.

target​

target: number;

Number of confirmations required before the payment is considered final.

description​

description: string;

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

initTxId?​

optional initTxId: string;

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

settleTxId?​

optional settleTxId: string;

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

side​

side: "source";

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

status​

status: 
  | "inactive"
  | "awaiting"
  | "received"
  | "confirmed"
  | "soft_expired"
  | "expired";

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

Current status of the payment step.

  • inactive: The payment step is not yet active because a previous step must complete first.
  • awaiting: The payment is expected, but no payment transaction is known yet.
  • received: A payment transaction is known, but it is not yet fully confirmed.
  • confirmed: The payment was confirmed and fully satisfies the swap requirements.
  • soft_expired: The payment should be treated as expired by the user, but it may still progress because of in-flight or background processing.
  • expired: The payment step can no longer be completed because the swap expired.

title​

title: string;

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

type​

type: "Payment";

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