@armada/sdk / index / PreflightParams

Interface: PreflightParams

Defined in: src/tx/preflight.ts:54

Properties

plan

readonly plan: Plan

Defined in: src/tx/preflight.ts:55

---

nullifiers

readonly nullifiers: readonly object[]

Defined in: src/tx/preflight.ts:57

The plan's input-note nullifiers (tree, nullifier) — the wallet derives these from its key.

---

queries

readonly queries: PreflightQueries

Defined in: src/tx/preflight.ts:58

---

feeQuote?

readonly optional feeQuote?: object

Defined in: src/tx/preflight.ts:60

When present, checks the fee quote hasn't expired (a local, no-RPC check).

expiresAt

readonly expiresAt: number

---

now

readonly now: number

Defined in: src/tx/preflight.ts:62

Current time (ms) — injected for deterministic testing of the expiry check.

---

cctpLiveness?

readonly optional cctpLiveness?: () => Promise<boolean>

Defined in: src/tx/preflight.ts:68

Cross-chain-unshield liveness: resolves true if the CCTP messenger is a live contract. Provided by the wallet only when the plan is a cross-chain unshield (a CCTP adaptParams binding); adds a cctp-liveness finding so a plan targeting a dead/misconfigured messenger fails preflight, not later.

Returns

Promise<boolean>

---

shieldsPaused?

readonly optional shieldsPaused?: () => Promise<boolean>

Defined in: src/tx/preflight.ts:74

Shield-pause: resolves true if shields are currently paused (ShieldPauseController.shieldsPaused). Only relevant for the SHIELD path (not transfer/unshield plans), so the wallet's transfer preflight does not provide it; a shield builder can, adding a shield-pause finding (ok = NOT paused).

Returns

Promise<boolean>