waitForDepositPosition - Zyfai Documentation

Polls getDepositStatus until the deposit reaches a terminal allocation state. Call this after waitForDepositCredit when your UI needs to know that rebalance into a protocol position finished (or was skipped). Requires connectAccount() on the same ZyfaiSDK instance.

Signature

waitForDepositPosition(
  depositId: string,
  chainId: SupportedChainId,
  options?: WaitForDepositPositionOptions,
): Promise<DepositLifecycleResponse>

Parameters

Parameter	Type	Required	Description
`depositId`	`string`	✅	Lifecycle UUID from `logDeposit().deposit.id` or `sendDeposit().registration.id`
`chainId`	`SupportedChainId`	✅	Chain the deposit was registered on (`1`, `8453`, or `42161`) — selects default poll interval and timeout
`options`	`WaitForDepositPositionOptions`	❌	Poll interval and timeout overrides

interface WaitForDepositPositionOptions {
  intervalMs?: number;  // default: chain-specific (see below)
  timeoutMs?: number;   // default: chain-specific (see below)
}

Default polling by chain:

Chain	`intervalMs`	`timeoutMs`
Ethereum (`1`)	4000 ms	180000 ms (3 minutes)
Base (`8453`)	1000 ms	90000 ms (1.5 minutes)
Arbitrum (`42161`)	1000 ms	90000 ms (1.5 minutes)

When it resolves

Condition	Meaning
`status === "positioned"`	Funds allocated to a protocol position on the registration chain
`positionOutcome === "skipped"`	Credit completed but allocation was skipped (for example below minimum deploy)
`crosschain === true` and `executionTxHash` set	Crosschain deposit: bridge transaction recorded. Destination-chain allocation is not tracked on this lifecycle.

Credit alone is not enough: the first poll after waitForDepositCredit may already show position_pending or positioned.

Errors

Condition	Error
`positionOutcome === "failed"`	`Deposit {id} position allocation failed (status=…)`
`status === "recovered_to_eoa"`	`Deposit {id} recovered to EOA; position was not opened`
Timeout	`Timed out waiting for deposit {id} to reach a position` (`DepositPositionTimeoutError`)
Poll failure	Original error from `getDepositStatus`

Example

const sent = await sdk.sendDeposit(userAddress, 8453, "100000000", "USDC");

await sdk.waitForDepositCredit(sent.registration.id, 8453);

const positioned = await sdk.waitForDepositPosition(
  sent.registration.id,
  8453,
);

console.log(positioned.status, positioned.positionOutcome);

waitForDepositCredit — wait until the Safe balance is credited
getDepositStatus — single status fetch