factions/actions

Interfaces

PlanChooseFactionOptions

Defined in: packages/sage/src/factions/actions/index.ts:45

Explicit initial faction choice and address-only Profile authorization; no independent payer.

Example

declare const authorization: PlanAuthorization;
const options: PlanChooseFactionOptions = { faction:'ustur', authorization };

Properties

authorization

readonly authorization: PlanAuthorization;

Defined in: packages/sage/src/factions/actions/index.ts:47

faction

readonly faction: PlayableFaction;

Defined in: packages/sage/src/factions/actions/index.ts:46

Type Aliases

PlayableFaction

type PlayableFaction = "mud" | "oni" | "ustur";

Defined in: packages/sage/src/factions/actions/index.ts:37

Playable factions offered for initial enrollment; the raw unaligned enum is intentionally excluded.

Example

const faction: PlayableFaction = 'ustur';

Functions

planChooseFaction()

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

Defined in: packages/sage/src/factions/actions/index.ts:107

Plans initial faction enrollment, spending only the existing Profile vault’s observed storage funding. No account is created or funded until explicit execution. Existing enrollment is never changed. Delegated authority requires an existing certificate account; certificate validity remains chain-authoritative. A valid direct authority ignores an unused certificate.

Parameters

Parameter	Type
ctx	SageContext
options	PlanChooseFactionOptions

Returns

Promise<Plan>

Example

declare const ctx: SageContext;
declare const authorization: PlanAuthorization;
const plan=await planChooseFaction(ctx,{faction:'ustur',authorization});
console.log(plan.describe());

References

PlanAuthorization

Re-exports PlanAuthorization