waitForWithdrawSettlement

Polls getWithdrawStatus until the withdrawal reaches a settlement terminal state: sync work finished, or async legs are in cooldown or already claiming. Use this right after withdrawFunds when you need to know whether the call can return without waiting through a multi-day async cooldown. If the terminal status is async_cooldown or async_claiming, follow with waitForWithdrawComplete to wait until funds land on the EOA. If the terminal status is completed, the withdrawal is already done. Requires connectAccount() on the same ZyfaiSDK instance.

Signature

waitForWithdrawSettlement(
  withdrawalId: string,
  chainId: SupportedChainId,
  options?: WaitForWithdrawSettlementOptions,
): Promise<WithdrawLifecycleResponse>

Parameters

Parameter	Type	Required	Description
`withdrawalId`	`string`	✅	Lifecycle UUID from `withdrawFunds().lifecycle.id`
`chainId`	`SupportedChainId`	✅	Chain withdrawn on (`1`, `8453`, or `42161`)
`options`	`WaitForWithdrawSettlementOptions`	❌	Poll interval and timeout overrides

interface WaitForWithdrawSettlementOptions {
  intervalMs?: number;
  timeoutMs?: number;
}

Default polling matches waitForDepositPosition: Ethereum 4s / 180s, Base and Arbitrum 1s / 90s.

Terminal statuses

This helper returns when status is one of:

Status	Meaning
`completed`	Entire withdrawal finished (including async claim when applicable)
`async_cooldown`	Async redemption requested; protocol cooldown in progress
`async_claiming`	Claim in flight (for example resume after cooldown)

Statuses such as accepted, redeeming, transferring, and async_requesting keep polling until one of the terminal states above or failed.

Treat async_claiming as terminal for this short poll so integrations that poll again after cooldown do not hit a spurious timeout while claim is already running.

Errors

Condition	Error
`status === "failed"`	`Withdraw {id} failed: {lastError}`
Timeout	`Timed out waiting for withdraw lifecycle {id} to settle` (`WithdrawSettlementTimeoutError`)

Example

const withdrawn = await sdk.withdrawFunds(userAddress, 8453);
const withdrawalId = withdrawn.lifecycle!.id;

const settled = await sdk.waitForWithdrawSettlement(withdrawalId, 8453);

if (settled.status === "completed") {
  console.log("Withdrawal complete");
} else {
  const completed = await sdk.waitForWithdrawComplete(withdrawalId, 8453);
  console.log(completed.status);
}

waitForWithdrawComplete — long poll through async cooldown
getWithdrawStatus — single fetch

Getting Started

Smart Wallet API

Intelligence Layer

Signature

Parameters

Terminal statuses

Errors

Example

​Signature

​Parameters

​Terminal statuses

​Errors

​Example

​Related methods

Signature

Parameters

Terminal statuses

Errors

Example

Related methods