Interface ProgrammaticTxOptions

interface ProgrammaticTxOptions {
    confirm?: ConfirmHook | "auto" | "manual";
    maxFee?: string | number;
    wait?: boolean;
    waitOptions?: {
        pollIntervalMs?: number;
        timeoutMs?: number;
    };
}

Properties

confirm? maxFee? wait? waitOptions?

Properties

Optionalconfirm

confirm?: ConfirmHook | "auto" | "manual"

Confirmation strategy:

  • "auto" (default): broadcast automatically, subject to maxFee.
  • "manual": build + sign + confirm only; return the validity data without broadcasting (the classic three-step flow, collapsed to one call for the confirm stage).
  • a ConfirmHook: called with the fee/validity snapshot; the tx is broadcast only if it returns true. maxFee is not auto-enforced in this mode — the callback is the sole authority.

OptionalmaxFee

maxFee?: string | number

Fee ceiling, in DEM. When the confirmed fee exceeds this in "auto" mode the runner throws FeeCapExceededError rather than broadcasting. Defaults to DEFAULT_MAX_FEE_DEM (5 DEM). Pass null or Infinity to disable the cap entirely.

Optionalwait

wait?: boolean

When broadcasting, wait for on-chain inclusion via broadcastAndWait instead of returning after the broadcast RPC. Defaults to false.

OptionalwaitOptions

waitOptions?: {
    pollIntervalMs?: number;
    timeoutMs?: number;
}

Options forwarded to broadcastAndWait when wait is true.

Settings

Member Visibility

On This Page

Properties