scanning/actions

Interfaces

PlanDetectSignalOptions

Defined in: packages/sage/src/scanning/actions/index.ts:116

Explicit choices for one Idle Fleet’s detection; setup and funding are separate.

Example

declare const profile: Address, authority: Address;
const authorization = { profile, authority, keyIndex: 0 };
const options: PlanDetectSignalOptions = { authorization, patternId: 0, focus: 'any' };

Extends

• DetectOptions

Properties

authorization

readonly authorization: PlanAuthorization;

Defined in: packages/sage/src/internal/planning/scan-detect.ts:52

Inherited from

DetectOptions.authorization

focus

readonly focus: "any" | "industrial" | "technology" | "tactical" | "exotic";

Defined in: packages/sage/src/internal/planning/scan-detect.ts:51

Inherited from

DetectOptions.focus

patternId

readonly patternId: number;

Defined in: packages/sage/src/internal/planning/scan-detect.ts:50

Inherited from

DetectOptions.patternId

---

PlanOpenScanSignalOptions

Defined in: packages/sage/src/scanning/actions/index.ts:28

Explicit address-only direct Profile authorization for signal setup. Certificates are unsupported.

Example

declare const authorization: PlanAuthorization;
const options: PlanOpenScanSignalOptions = { authorization };

Properties

authorization

readonly authorization: PlanAuthorization;

Defined in: packages/sage/src/scanning/actions/index.ts:29

---

PlanScanCompletionOptions

Defined in: packages/sage/src/scanning/actions/index.ts:165

Direct address-only authority for recovery, abandonment and receipt acknowledgement.

Example

declare const authorization: PlanAuthorization;
const options: PlanScanCompletionOptions = { authorization };

Extends

• ScanCompletionOptions

Properties

authorization

readonly authorization: PlanAuthorization;

Defined in: packages/sage/src/internal/planning/scan-completion.ts:47

Inherited from

ScanCompletionOptions.authorization

Functions

planAbandonSignal()

function planAbandonSignal(
   ctx,
   fleet,
options): Promise<Plan>;

Defined in: packages/sage/src/scanning/actions/index.ts:258

Abandon one unexpired Contact without attempting recovery. Acknowledgement remains a separate explicit action.

Parameters

Parameter	Type
ctx	SageContext
fleet	Address
options	PlanScanCompletionOptions

Returns

Promise<Plan>

Example

declare const ctx: SageContext, fleet: Address, options: PlanScanCompletionOptions;
const plan = await planAbandonSignal(ctx, fleet, options);
console.log(plan.describe());

---

planAcknowledgeScanResult()

function planAcknowledgeScanResult(
   ctx,
   fleet,
options): Promise<Plan>;

Defined in: packages/sage/src/scanning/actions/index.ts:243

Clear one terminal receipt to Empty while retaining the funded signal. Explicitly includes the Fleet for current abandoned-receipt cooldown handling.

Parameters

Parameter	Type
ctx	SageContext
fleet	Address
options	PlanScanCompletionOptions

Returns

Promise<Plan>

Example

declare const ctx: SageContext, fleet: Address, options: PlanScanCompletionOptions;
const plan = await planAcknowledgeScanResult(ctx, fleet, options);
console.log(plan.describe());

---

planDetectSignal()

function planDetectSignal(
   ctx,
   fleet,
options): Promise<Plan>;

Defined in: packages/sage/src/scanning/actions/index.ts:128

Plans one signal detection for an existing Empty signal and directly owned Idle Fleet. Reads fresh prerequisites without signing. Restricted-key sufficiency, cooldown rejection and final gameplay outcomes remain chain-authoritative; use simulatePlan. No automatic opening, deposits, loading, undocking or resolution occurs.

Parameters

Parameter	Type
ctx	SageContext
fleet	Address
options	PlanDetectSignalOptions

Returns

Promise<Plan>

Example

declare const ctx: SageContext, fleet: Address, options: PlanDetectSignalOptions;
const plan = await planDetectSignal(ctx, fleet, options);
console.log(plan.describe());

---

planExpireSignal()

function planExpireSignal(ctx, fleet): Promise<Plan>;

Defined in: packages/sage/src/scanning/actions/index.ts:273

Expire one Contact after its deadline. No gameplay authority is needed; acknowledgement remains separate.

Parameters

Parameter	Type
ctx	SageContext
fleet	Address

Returns

Promise<Plan>

Example

declare const ctx: SageContext, fleet: Address;
const plan = await planExpireSignal(ctx, fleet);
console.log(plan.describe());

---

planForfeitScanSignalEntropy()

function planForfeitScanSignalEntropy(ctx, fleet): Promise<Plan>;

Defined in: packages/sage/src/scanning/actions/index.ts:287

Forfeit one PendingEntropy attempt after the supported reveal deadline. No gameplay authority is needed; acknowledgement remains separate.

Parameters

Parameter	Type
ctx	SageContext
fleet	Address

Returns

Promise<Plan>

Example

declare const ctx: SageContext, fleet: Address;
const plan = await planForfeitScanSignalEntropy(ctx, fleet);
console.log(plan.describe());

---

planOpenScanSignal()

function planOpenScanSignal(
   ctx,
   fleet,
options): Promise<Plan>;

Defined in: packages/sage/src/scanning/actions/index.ts:43

Plans one absent canonical signal for a directly owned Fleet, including Docked Fleets. Planning reads fresh state but never signs, submits, deposits funds or detects a signal. The Profile funds signal rent while retaining its own reserve; transaction fees are separate. Restricted-key least privilege is unqualified: instruction permission acceptance remains chain-authoritative, and legacy SCAN bit 38 is not established as sufficient. Simulate before signing.

Parameters

Parameter	Type
ctx	SageContext
fleet	Address
options	PlanOpenScanSignalOptions

Returns

Promise<Plan>

Example

declare const ctx: SageContext, fleet: Address, authorization: PlanAuthorization;
const plan = await planOpenScanSignal(ctx, fleet, { authorization });
console.log(plan.describe());

---

planRecoverSignal()

function planRecoverSignal(
   ctx,
   fleet,
options): Promise<Plan>;

Defined in: packages/sage/src/scanning/actions/index.ts:228

Recover one unexpired Contact with an Idle Fleet inside its stored radius. Cargo acceptance, clipping and XP remain chain-authoritative.

Parameters

Parameter	Type
ctx	SageContext
fleet	Address
options	PlanScanCompletionOptions

Returns

Promise<Plan>

Example

declare const ctx: SageContext, fleet: Address, options: PlanScanCompletionOptions;
const plan = await planRecoverSignal(ctx, fleet, options);
console.log(plan.describe());

---

planResolveSignal()

function planResolveSignal(ctx, fleet): Promise<Plan>;

Defined in: packages/sage/src/scanning/actions/index.ts:214

Resolve one PendingEntropy signal using its committed policy and regional loot configuration. Requires current Character XP accounts; no gameplay authority is needed.

Parameters

Parameter	Type
ctx	SageContext
fleet	Address

Returns

Promise<Plan>

Example

declare const ctx: SageContext, fleet: Address;
const plan = await planResolveSignal(ctx, fleet);
console.log(plan.describe());

References

PlanAuthorization

Re-exports PlanAuthorization