SankofaDeployOptions class

Per-module options for Sankofa Deploy (OTA updates).

Passed to Sankofa.init as deployOptions: when enableDeploy: true. The apiKey + endpoint are inherited from the parent Sankofa.init call so the host never has to repeat them.

Constructors

SankofaDeployOptions({Duration appReadyTimeout = const Duration(seconds: 10), bool autoCheckOnStartup = true, String? signingPubkeyB64, String? engineVersion, String? platformOverride})

const

Properties

appReadyTimeout → Duration

Maximum time we'll wait for the host's Sankofa.deploy.notifyAppReady() call before assuming the new patch boot-looped and triggering a rollback. Mirrors the same timer in the Rust updater's notify_app_ready_timeout field.

final

autoCheckOnStartup → bool

When true, the SDK fires off an update check during init — equivalent to calling Sankofa.deploy.checkForUpdate() manually at startup. Defaults to true because the common case is "ship patches on launch."

final

engineVersion → String?

Sankofa-engine identity this app was built against (e.g. 3.44.0+sankofa-1). Used as the default engineVersion passed to /api/deploy/check whenever the host calls Sankofa.deploy.checkForKbcUpdate() / downloadKbcUpdate / fetchAndApplyKbcPatch without an explicit override.

final

hashCode → int

The hash code for this object.

no setter, inherited

platformOverride → String?

Default platform string sent to /api/deploy/check when the host doesn't override it. When null, the SDK derives it from Platform.isIOS / Platform.isAndroid at call time. Override only when running on an exotic host the SDK can't detect (e.g. integration tests with a faked Platform).

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

signingPubkeyB64 → String?

v2 envelope MVP — Ed25519 public key (base64 of the raw 32-byte point) that authorizes patches for this app. When set, the SDK rejects any KBC patch whose envelope is unsigned, signed with a different algorithm, or whose signature does not verify.

final

Methods

copyWith({Duration? appReadyTimeout, bool? autoCheckOnStartup, String? signingPubkeyB64, String? engineVersion, String? platformOverride}) → SankofaDeployOptions

Returns a copy with engineVersion overridden — used by SankofaBootstrap.run to bind the engine version read from sankofa.yaml without making the host re-construct the options object themselves.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toMap({required String apiKey, required String endpoint}) → Map<String, dynamic>

Serialized form sent over the platform channel to the Kotlin/Swift side. Keys mirror the receiving SankofaDeployPlugin.kt parameter names exactly. signingPubkeyB64 is NOT forwarded — the Dart side is the only consumer (envelope verification happens before bytes hit the platform plugin).

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited