Skip to main content
Version: 1.5.0

Type Alias: FinalityRequested

FinalityRequested = "finalized" | "safe" | number

Defined in: extra-args.ts:70

Requested finality configuration for cross-chain messages.

Determines how long to wait on the source chain before relaying the message:

  • 'finalized' — wait for full finality (safest, default).
  • 'safe' — wait for the safe head tag.
  • number — wait for this many block confirmations [1..65535].

Example

TypeScript
// Wait for full finality (default)
const finality: FinalityRequested = 'finalized'

// Wait for the safe tag
const safe: FinalityRequested = 'safe'

// Wait for 5 block confirmations
const blocks: FinalityRequested = 5