starbases/actions

Interfaces

PlanRegisterStarbasePlayerOptions

Defined in: packages/sage/src/starbases/actions/index.ts:69

Address-only StarbasePlayer registration input.

The funder is the sole required signer and pays account rent. Reusing the later assembly fee payer is convenient, but the planner does not require the two addresses to match.

Example

declare const funder: Address;
const options: PlanRegisterStarbasePlayerOptions = { funder };

Properties

funder

readonly funder: Address;

Defined in: packages/sage/src/starbases/actions/index.ts:70

Functions

planRegisterStarbasePlayer()

function planRegisterStarbasePlayer(
   ctx,
   character,
   system,
input): Promise<Plan>;

Defined in: packages/sage/src/starbases/actions/index.ts:136

Plans one StarbasePlayer registration without signing, assembly, or writes.

The Character and Star System must already be loaded public snapshots. The planner derives and directly validates every plumbing account and returns a Plan only when the canonical StarbasePlayer address is absent. The Starbase FactionOwnership sidecar is always passed by address; when it is uninitialized the chain admits by the legacy Starbase owner, and the Plan guards that it stays unallocated. Optional faction expansion accounts use the generated omitted-account convention.

Parameters

Parameter	Type
ctx	SageContext
character	CharacterSnapshot
system	StarSystemSnapshot
input	PlanRegisterStarbasePlayerOptions

Returns

Promise<Plan>

Example

declare const ctx: SageContext;
declare const character: CharacterSnapshot;
declare const system: StarSystemSnapshot;
declare const funder: Address;
const plan = await planRegisterStarbasePlayer(
  ctx,
  character,
  system,
  { funder },
);
console.log(plan.describe());