Skip to main content
Version: 1.16.1

Type Alias: LaneStatus

LaneStatus = { status: "ok"; } | { direction: "outbound" | "inbound"; scope: "global" | "token" | "chain"; status: "paused"; } | { missing: LaneRecordType[]; status: "incomplete"; }

Defined in: chain.ts:685

Whether a token pool lets a transfer of a token on a lane go through now, for one direction.

Remarks​

  • 'ok': no pause and no missing config record stops the transfer. Rate limits, finality and the token's own checks (e.g. a blocklist) can still reject it.
  • 'paused': a pause stops it. scope is the broadest pause that applies: 'global' (every token and chain of the pool's stores), 'chain' (every token to or from the remote chain) or 'token' (this token on every chain).
  • 'incomplete': the lane lacks the listed config records, so the transfer reverts.