identity

Interfaces

CharacterAccountData

Defined in: packages/sage/src/internal/c4/identity.ts:231

SDK-owned decoded Character data.

Example

declare const character: CharacterAccountData;
const atlas = character.atlas;

Properties

atlas

readonly atlas: number;

Defined in: packages/sage/src/internal/c4/identity.ts:242

atlasRaw

readonly atlasRaw: bigint;

Defined in: packages/sage/src/internal/c4/identity.ts:241

bump

readonly bump: number;

Defined in: packages/sage/src/internal/c4/identity.ts:235

checkIn

readonly checkIn: {
  lastCheckInTime: bigint;
  streak: number;
};

Defined in: packages/sage/src/internal/c4/identity.ts:236

lastCheckInTime

readonly lastCheckInTime: bigint;

streak

readonly streak: number;

counts

readonly counts: {
  claimStakes: number;
  craftingHabs: number;
  fleets: number;
};

Defined in: packages/sage/src/internal/c4/identity.ts:243

claimStakes

readonly claimStakes: number;

craftingHabs

readonly craftingHabs: number;

fleets

readonly fleets: number;

game

readonly game: Address;

Defined in: packages/sage/src/internal/c4/identity.ts:234

modifiers

readonly modifiers: CharacterModifiersData;

Defined in: packages/sage/src/internal/c4/identity.ts:254

pilotXpBudget

readonly pilotXpBudget: {
  available: number;
  fractionalCarry: number;
  fractionalCarryRaw: bigint;
  lastAccrualTime: bigint;
};

Defined in: packages/sage/src/internal/c4/identity.ts:248

available

readonly available: number;

fractionalCarry

readonly fractionalCarry: number;

fractionalCarryRaw

readonly fractionalCarryRaw: bigint;

lastAccrualTime

readonly lastAccrualTime: bigint;

playerProfile

readonly playerProfile: Address;

Defined in: packages/sage/src/internal/c4/identity.ts:233

version

readonly version: number;

Defined in: packages/sage/src/internal/c4/identity.ts:232

xp

readonly xp: CharacterXpData;

Defined in: packages/sage/src/internal/c4/identity.ts:240

---

CharacterModifierData

Defined in: packages/sage/src/internal/c4/identity.ts:171

SDK-owned translation of Character modifier values.

Example

declare const modifiers: CharacterModifierData;
const fleetLimit = modifiers.fleetSize;

Properties

cargoCategories

readonly cargoCategories: readonly number[];

Defined in: packages/sage/src/internal/c4/identity.ts:202

craftingEfficiencyModifier

readonly craftingEfficiencyModifier: number;

Defined in: packages/sage/src/internal/c4/identity.ts:184

craftingEfficiencyModifierRaw

readonly craftingEfficiencyModifierRaw: bigint;

Defined in: packages/sage/src/internal/c4/identity.ts:185

craftingJobConcurrencyBonus

readonly craftingJobConcurrencyBonus: number;

Defined in: packages/sage/src/internal/c4/identity.ts:188

craftingTimeModifier

readonly craftingTimeModifier: number;

Defined in: packages/sage/src/internal/c4/identity.ts:186

craftingTimeModifierRaw

readonly craftingTimeModifierRaw: bigint;

Defined in: packages/sage/src/internal/c4/identity.ts:187

enemyFactionZoneAccess

readonly enemyFactionZoneAccess: boolean;

Defined in: packages/sage/src/internal/c4/identity.ts:194

fleetConcurrency

readonly fleetConcurrency: number;

Defined in: packages/sage/src/internal/c4/identity.ts:173

fleetSize

readonly fleetSize: number;

Defined in: packages/sage/src/internal/c4/identity.ts:172

maxDailyStreakLength

readonly maxDailyStreakLength: number;

Defined in: packages/sage/src/internal/c4/identity.ts:195

maxProductivePlots

readonly maxProductivePlots: number;

Defined in: packages/sage/src/internal/c4/identity.ts:192

maxProductivePlotTier?

readonly optional maxProductivePlotTier?: 1 | 2 | 3 | 4 | 5;

Defined in: packages/sage/src/internal/c4/identity.ts:191

maxResidentialPlots

readonly maxResidentialPlots: number;

Defined in: packages/sage/src/internal/c4/identity.ts:190

maxResidentialPlotTier?

readonly optional maxResidentialPlotTier?: 1 | 2 | 3 | 4 | 5;

Defined in: packages/sage/src/internal/c4/identity.ts:189

maxShipSize

readonly maxShipSize: ShipSize;

Defined in: packages/sage/src/internal/c4/identity.ts:196

rareMineralDiscovery

readonly rareMineralDiscovery: readonly RareMineralDiscoveryData[];

Defined in: packages/sage/src/internal/c4/identity.ts:203

researchTags

readonly researchTags: readonly number[];

Defined in: packages/sage/src/internal/c4/identity.ts:201

respawnTimeModifier

readonly respawnTimeModifier: number;

Defined in: packages/sage/src/internal/c4/identity.ts:174

respawnTimeModifierRaw

readonly respawnTimeModifierRaw: bigint;

Defined in: packages/sage/src/internal/c4/identity.ts:175

scanCoolDownModifier

readonly scanCoolDownModifier: number;

Defined in: packages/sage/src/internal/c4/identity.ts:199

scanCoolDownModifierRaw

readonly scanCoolDownModifierRaw: bigint;

Defined in: packages/sage/src/internal/c4/identity.ts:200

scanPowerModifier

readonly scanPowerModifier: number;

Defined in: packages/sage/src/internal/c4/identity.ts:197

scanPowerModifierRaw

readonly scanPowerModifierRaw: bigint;

Defined in: packages/sage/src/internal/c4/identity.ts:198

securityZoneAccess

readonly securityZoneAccess: RiskZoneAccess;

Defined in: packages/sage/src/internal/c4/identity.ts:193

subwarpSpeedModifier

readonly subwarpSpeedModifier: number;

Defined in: packages/sage/src/internal/c4/identity.ts:180

subwarpSpeedModifierRaw

readonly subwarpSpeedModifierRaw: bigint;

Defined in: packages/sage/src/internal/c4/identity.ts:181

warpCooldownModifier

readonly warpCooldownModifier: number;

Defined in: packages/sage/src/internal/c4/identity.ts:182

warpCooldownModifierRaw

readonly warpCooldownModifierRaw: bigint;

Defined in: packages/sage/src/internal/c4/identity.ts:183

warpLaneFeeModifier

readonly warpLaneFeeModifier: number;

Defined in: packages/sage/src/internal/c4/identity.ts:176

warpLaneFeeModifierRaw

readonly warpLaneFeeModifierRaw: bigint;

Defined in: packages/sage/src/internal/c4/identity.ts:177

warpSpeedModifier

readonly warpSpeedModifier: number;

Defined in: packages/sage/src/internal/c4/identity.ts:178

warpSpeedModifierRaw

readonly warpSpeedModifierRaw: bigint;

Defined in: packages/sage/src/internal/c4/identity.ts:179

---

CharacterModifiersData

Defined in: packages/sage/src/internal/c4/identity.ts:213

SDK-owned Character modifier state from the Character account.

Example

declare const modifiers: CharacterModifiersData;
const nodes = modifiers.unlockedNodes;

Properties

nodeLevels

readonly nodeLevels: readonly {
  level: number;
  nodeId: number;
}[];

Defined in: packages/sage/src/internal/c4/identity.ts:217

seqId

readonly seqId: number;

Defined in: packages/sage/src/internal/c4/identity.ts:214

unlockedNodes

readonly unlockedNodes: readonly number[];

Defined in: packages/sage/src/internal/c4/identity.ts:216

unupdatedCount

readonly unupdatedCount: number;

Defined in: packages/sage/src/internal/c4/identity.ts:215

values

readonly values: CharacterModifierData;

Defined in: packages/sage/src/internal/c4/identity.ts:221

---

CharacterProgressionSnapshot

Defined in: packages/sage/src/identity/index.ts:138

Character XP and pilot state joined to sequence-matched Game XP rules.

Example

declare const ctx: SageContext;
declare const profileAddress: Address;
const progression: CharacterProgressionSnapshot =
  await getCharacterProgressionForProfile(ctx, profileAddress);
console.log(progression.xp.pilot.level);

Properties

character

readonly character: EntityRef<"character">;

Defined in: packages/sage/src/identity/index.ts:140

kind

readonly kind: "characterProgression";

Defined in: packages/sage/src/identity/index.ts:139

pilotXpBudget

readonly pilotXpBudget: {
  available: number;
  fractionalCarry: number;
  fractionalCarryRaw: bigint;
  lastAccrualTime: bigint;
};

Defined in: packages/sage/src/identity/index.ts:142

available

readonly available: number;

fractionalCarry

readonly fractionalCarry: number;

fractionalCarryRaw

readonly fractionalCarryRaw: bigint;

lastAccrualTime

readonly lastAccrualTime: bigint;

xp

readonly xp: CharacterXpData;

Defined in: packages/sage/src/identity/index.ts:141

xpDefinitions

readonly xpDefinitions: GameXpDefinitionsSectionData;

Defined in: packages/sage/src/identity/index.ts:143

Methods

toJSON()

toJSON(): unknown;

Defined in: packages/sage/src/identity/index.ts:144

Returns

unknown

---

CharacterSnapshot

Defined in: packages/sage/src/identity/index.ts:117

Immutable Character snapshot derived from a Player Profile and Game.

Example

declare const ctx: SageContext;
declare const profileAddress: Address;
const character: CharacterSnapshot = await getCharacterForProfile(ctx, profileAddress);
console.log(character.profile.address);

Extends

• Omit<CharacterAccountData, "playerProfile">

Extended by

• CharacterView

Properties

address

readonly address: Address;

Defined in: packages/sage/src/identity/index.ts:122

atlas

readonly atlas: number;

Defined in: packages/sage/src/internal/c4/identity.ts:242

Inherited from

CharacterAccountData.atlas

atlasRaw

readonly atlasRaw: bigint;

Defined in: packages/sage/src/internal/c4/identity.ts:241

Inherited from

CharacterAccountData.atlasRaw

bump

readonly bump: number;

Defined in: packages/sage/src/internal/c4/identity.ts:235

Inherited from

CharacterAccountData.bump

checkIn

readonly checkIn: {
  lastCheckInTime: bigint;
  streak: number;
};

Defined in: packages/sage/src/internal/c4/identity.ts:236

lastCheckInTime

readonly lastCheckInTime: bigint;

streak

readonly streak: number;

Inherited from

CharacterAccountData.checkIn

counts

readonly counts: {
  claimStakes: number;
  craftingHabs: number;
  fleets: number;
};

Defined in: packages/sage/src/internal/c4/identity.ts:243

claimStakes

readonly claimStakes: number;

craftingHabs

readonly craftingHabs: number;

fleets

readonly fleets: number;

Inherited from

CharacterAccountData.counts

game

readonly game: Address;

Defined in: packages/sage/src/internal/c4/identity.ts:234

Inherited from

CharacterAccountData.game

kind

readonly kind: "character";

Defined in: packages/sage/src/identity/index.ts:121

modifiers

readonly modifiers: CharacterModifiersData;

Defined in: packages/sage/src/internal/c4/identity.ts:254

Inherited from

CharacterAccountData.modifiers

pilotXpBudget

readonly pilotXpBudget: {
  available: number;
  fractionalCarry: number;
  fractionalCarryRaw: bigint;
  lastAccrualTime: bigint;
};

Defined in: packages/sage/src/internal/c4/identity.ts:248

available

readonly available: number;

fractionalCarry

readonly fractionalCarry: number;

fractionalCarryRaw

readonly fractionalCarryRaw: bigint;

lastAccrualTime

readonly lastAccrualTime: bigint;

Inherited from

CharacterAccountData.pilotXpBudget

profile

readonly profile: EntityRef<"profile">;

Defined in: packages/sage/src/identity/index.ts:123

version

readonly version: number;

Defined in: packages/sage/src/internal/c4/identity.ts:232

Inherited from

CharacterAccountData.version

xp

readonly xp: CharacterXpData;

Defined in: packages/sage/src/internal/c4/identity.ts:240

Inherited from

CharacterAccountData.xp

Methods

toJSON()

toJSON(): unknown;

Defined in: packages/sage/src/identity/index.ts:124

Returns

unknown

---

CharacterXpCategoryData

Defined in: packages/sage/src/internal/c4/identity.ts:101

SDK-owned XP values for one Character category.

Example

declare const category: CharacterXpCategoryData;
const level = category.level;

Properties

earned

readonly earned: bigint;

Defined in: packages/sage/src/internal/c4/identity.ts:103

level

readonly level: number;

Defined in: packages/sage/src/internal/c4/identity.ts:104

spent

readonly spent: bigint;

Defined in: packages/sage/src/internal/c4/identity.ts:102

---

CharacterXpData

Defined in: packages/sage/src/internal/c4/identity.ts:114

SDK-owned Character XP state.

Example

declare const xp: CharacterXpData;
const pilotLevel = xp.pilot.level;

Properties

building

readonly building: CharacterXpCategoryData;

Defined in: packages/sage/src/internal/c4/identity.ts:121

combat

readonly combat: CharacterXpCategoryData;

Defined in: packages/sage/src/internal/c4/identity.ts:123

councilRank

readonly councilRank: CharacterXpCategoryData;

Defined in: packages/sage/src/internal/c4/identity.ts:116

councilRankLevelCarry

readonly councilRankLevelCarry: number;

Defined in: packages/sage/src/internal/c4/identity.ts:124

crafting

readonly crafting: CharacterXpCategoryData;

Defined in: packages/sage/src/internal/c4/identity.ts:122

dailyXp

readonly dailyXp: CharacterXpCategoryData;

Defined in: packages/sage/src/internal/c4/identity.ts:117

dataRunner

readonly dataRunner: CharacterXpCategoryData;

Defined in: packages/sage/src/internal/c4/identity.ts:119

mining

readonly mining: CharacterXpCategoryData;

Defined in: packages/sage/src/internal/c4/identity.ts:120

pilot

readonly pilot: CharacterXpCategoryData;

Defined in: packages/sage/src/internal/c4/identity.ts:118

seqId

readonly seqId: number;

Defined in: packages/sage/src/internal/c4/identity.ts:115

---

ProfileAccountData

Defined in: packages/sage/src/internal/c4/identity.ts:85

SDK-owned decoded Player Profile data.

Example

declare const profile: ProfileAccountData;
const keys = profile.keys;

Extended by

• ProfileSnapshot

Properties

authKeyCount

readonly authKeyCount: number;

Defined in: packages/sage/src/internal/c4/identity.ts:87

createdAt

readonly createdAt: bigint;

Defined in: packages/sage/src/internal/c4/identity.ts:90

keys

readonly keys: readonly ProfileKeyData[];

Defined in: packages/sage/src/internal/c4/identity.ts:91

keyThreshold

readonly keyThreshold: number;

Defined in: packages/sage/src/internal/c4/identity.ts:88

nextSeqId

readonly nextSeqId: bigint;

Defined in: packages/sage/src/internal/c4/identity.ts:89

version

readonly version: number;

Defined in: packages/sage/src/internal/c4/identity.ts:86

---

ProfileKeyData

Defined in: packages/sage/src/internal/c4/identity.ts:69

SDK-owned representation of one Player Profile key.

Example

declare const key: ProfileKeyData;
const expiresAt = key.expiresAt;

Properties

address

readonly address: Address;

Defined in: packages/sage/src/internal/c4/identity.ts:70

expiresAt?

readonly optional expiresAt?: bigint;

Defined in: packages/sage/src/internal/c4/identity.ts:73

expiresAtRaw

readonly expiresAtRaw: bigint;

Defined in: packages/sage/src/internal/c4/identity.ts:72

permissions

readonly permissions: readonly ProfilePermission[];

Defined in: packages/sage/src/internal/c4/identity.ts:75

permissionsRaw

readonly permissionsRaw: bigint;

Defined in: packages/sage/src/internal/c4/identity.ts:74

scope

readonly scope: Address;

Defined in: packages/sage/src/internal/c4/identity.ts:71

---

ProfileSnapshot

Defined in: packages/sage/src/identity/index.ts:101

Immutable, translated Player Profile snapshot.

Example

declare const ctx: SageContext;
declare const profileAddress: Address;
const profile: ProfileSnapshot = await getProfile(ctx, profileAddress);
console.log(profile.address, profile.keys.length);

Extends

• ProfileAccountData

Extended by

• ProfileView

Properties

address

readonly address: Address;

Defined in: packages/sage/src/identity/index.ts:103

authKeyCount

readonly authKeyCount: number;

Defined in: packages/sage/src/internal/c4/identity.ts:87

Inherited from

ProfileAccountData.authKeyCount

createdAt

readonly createdAt: bigint;

Defined in: packages/sage/src/internal/c4/identity.ts:90

Inherited from

ProfileAccountData.createdAt

keys

readonly keys: readonly ProfileKeyData[];

Defined in: packages/sage/src/internal/c4/identity.ts:91

Inherited from

ProfileAccountData.keys

keyThreshold

readonly keyThreshold: number;

Defined in: packages/sage/src/internal/c4/identity.ts:88

Inherited from

ProfileAccountData.keyThreshold

kind

readonly kind: "profile";

Defined in: packages/sage/src/identity/index.ts:102

nextSeqId

readonly nextSeqId: bigint;

Defined in: packages/sage/src/internal/c4/identity.ts:89

Inherited from

ProfileAccountData.nextSeqId

version

readonly version: number;

Defined in: packages/sage/src/internal/c4/identity.ts:86

Inherited from

ProfileAccountData.version

Methods

toJSON()

toJSON(): unknown;

Defined in: packages/sage/src/identity/index.ts:104

Returns

unknown

---

RareMineralDiscoveryData

Defined in: packages/sage/src/internal/c4/identity.ts:158

One translated cargo-specific research modifier.

Example

declare const discovery: RareMineralDiscoveryData;
const multiplier = discovery.multiplier;

Properties

cargoId

readonly cargoId: number;

Defined in: packages/sage/src/internal/c4/identity.ts:159

multiplier

readonly multiplier: number;

Defined in: packages/sage/src/internal/c4/identity.ts:160

multiplierRaw

readonly multiplierRaw: bigint;

Defined in: packages/sage/src/internal/c4/identity.ts:161

---

ResearchCatalogSnapshot

Defined in: packages/sage/src/identity/index.ts:156

Independent Game research catalog without Character perk or unlock claims.

Example

declare const ctx: SageContext;
const catalog: ResearchCatalogSnapshot = await getResearchCatalog(ctx);
console.log(catalog.nodes.length);

Properties

game

readonly game: EntityRef<"game">;

Defined in: packages/sage/src/identity/index.ts:158

kind

readonly kind: "researchCatalog";

Defined in: packages/sage/src/identity/index.ts:157

nodes

readonly nodes: readonly GameResearchNodeData[];

Defined in: packages/sage/src/identity/index.ts:159

sequenceId

readonly sequenceId: number;

Defined in: packages/sage/src/identity/index.ts:160

Methods

toJSON()

toJSON(): unknown;

Defined in: packages/sage/src/identity/index.ts:161

Returns

unknown

Type Aliases

ProfilePermission

type ProfilePermission =
  | "authenticate"
  | "addKeys"
  | "removeKeys"
  | "changeName"
  | "createRole"
  | "removeRole"
  | "setAuthorizer"
  | "joinRole"
  | "leaveRole"
  | "toggleAcceptingNewMembers"
  | "addMember"
  | "removeMember"
  | "drainSolVault";

Defined in: packages/sage/src/internal/c4/identity.ts:47

Stable labels for Player Profile key permissions.

Example

const permission: ProfilePermission = 'authenticate';

---

ResearchNodeDefinition

type ResearchNodeDefinition = GameResearchNodeData;

Defined in: packages/sage/src/identity/index.ts:89

One Game research node definition with no claimed player unlock state.

Example

declare const node: ResearchNodeDefinition;
console.log(node.name, node.maxLevel);

---

RiskZoneAccess

type RiskZoneAccess = "low" | "medium" | "high";

Defined in: packages/sage/src/internal/c4/identity.ts:149

Stable risk-zone labels translated from generated numeric enums.

Example

const access: RiskZoneAccess = 'low';

---

ShipSize

type ShipSize =
  | "xx-small"
  | "x-small"
  | "small"
  | "medium"
  | "large"
  | "capital"
  | "commander"
  | "titan";

Defined in: packages/sage/src/internal/c4/identity.ts:133

Stable ship-size labels translated from generated numeric enums.

Example

const size: ShipSize = 'medium';

---

WalletProfileDiscoveryOptions

type WalletProfileDiscoveryOptions =
  | Omit<ReadOptions, "maxAgeMs" | "refresh"> & {
  addresses: readonly Address[];
  strategy: "known-addresses";
}
  | Omit<ReadOptions, "maxAgeMs" | "refresh"> & {
  addresses?: never;
  strategy: "provider";
};

Defined in: packages/sage/src/identity/index.ts:179

Explicit strategy and read controls for wallet-to-Profile discovery.

Known addresses and provider hints follow the same direct on-chain validation path. The strategy is required so callers never mistake a known application mapping for provider discovery.

Example

declare const profileAddress: Address;
const options: WalletProfileDiscoveryOptions = {
  strategy: 'known-addresses',
  addresses: [profileAddress],
};

---

XpCategory

type XpCategory = GameXpCategory;

Defined in: packages/sage/src/identity/index.ts:62

Stable gameplay label for one Game XP category.

Example

const category: XpCategory = 'pilot';

---

XpDefinitions

type XpDefinitions = GameXpDefinitionsSectionData;

Defined in: packages/sage/src/identity/index.ts:80

Sequence-versioned Game XP rules joined to Character XP.

Example

declare const definitions: XpDefinitions;
console.log(definitions.sequenceId);

---

XpLevelThreshold

type XpLevelThreshold = GameXpLevelThresholdData;

Defined in: packages/sage/src/identity/index.ts:71

Exact XP thresholds for one level across every category.

Example

declare const threshold: XpLevelThreshold;
console.log(threshold.pilot);

Functions

getCharacterForProfile()

function getCharacterForProfile(
   ctx,
   profileAddress,
options?): Promise<CharacterSnapshot>;

Defined in: packages/sage/src/identity/index.ts:458

Derives and reads the Character associated with a known Player Profile.

Parameters

Parameter	Type
ctx	SageContext
profileAddress	Address
options?	ReadOptions

Returns

Promise<CharacterSnapshot>

Example

declare const ctx: SageContext;
declare const profileAddress: Address;
const character = await getCharacterForProfile(ctx, profileAddress);

---

getCharacterProgressionForProfile()

function getCharacterProgressionForProfile(
   ctx,
   profileAddress,
options?): Promise<CharacterProgressionSnapshot>;

Defined in: packages/sage/src/identity/index.ts:377

Reads a derived Character and joins its XP state to matching Game rules.

The Profile-to-Character PDA remains the canonical discovery path. Game XP rules are loaded lazily and must carry the Character’s exact sequence id.

Parameters

Parameter	Type
ctx	SageContext
profileAddress	Address
options?	ReadOptions

Returns

Promise<CharacterProgressionSnapshot>

Example

declare const ctx: SageContext;
declare const profileAddress: Address;
const progression = await getCharacterProgressionForProfile(ctx, profileAddress);

---

getCharactersForWallet()

function getCharactersForWallet(
   ctx,
   wallet,
options): Promise<readonly CharacterSnapshot[]>;

Defined in: packages/sage/src/identity/index.ts:645

Resolves wallet Profiles and derives every Character currently present for them.

The returned list preserves the wallet discovery strategy metadata. Profiles without a Character are omitted because Character creation is optional.

Parameters

Parameter	Type
ctx	SageContext
wallet	Address
options	WalletProfileDiscoveryOptions

Returns

Promise<readonly CharacterSnapshot[]>

Example

declare const ctx: SageContext;
declare const wallet: Address;
const characters = await getCharactersForWallet(ctx, wallet, {
  strategy: 'provider',
});

---

getProfile()

function getProfile(
   ctx,
   address,
options?): Promise<ProfileSnapshot>;

Defined in: packages/sage/src/identity/index.ts:355

Reads a required Player Profile by account address.

Parameters

Parameter	Type
ctx	SageContext
address	Address
options?	ReadOptions

Returns

Promise<ProfileSnapshot>

Example

declare const ctx: SageContext;
declare const profileAddress: Address;
const profile = await getProfile(ctx, profileAddress);

---

getProfilesForWallet()

function getProfilesForWallet(
   ctx,
   wallet,
options): Promise<readonly ProfileSnapshot[]>;

Defined in: packages/sage/src/identity/index.ts:517

Resolves and directly validates zero, one, or many Player Profiles for a wallet.

Provider and known-address results are address hints only. Every unique candidate is read through the context data plane, validated as a Player Profile, and checked for the requested wallet in its decoded key list. Stored matching keys are accepted regardless of expiry; consumers remain responsible for applying authorization policy to the returned key details. Missing candidates are treated as stale hints and omitted; a contradictory present Profile rejects the discovery.

Parameters

Parameter	Type
ctx	SageContext
wallet	Address
options	WalletProfileDiscoveryOptions

Returns

Promise<readonly ProfileSnapshot[]>

Example

declare const ctx: SageContext;
declare const wallet: Address;
const profiles = await getProfilesForWallet(ctx, wallet, {
  strategy: 'provider',
});

---

getResearchCatalog()

function getResearchCatalog(ctx): Promise<ResearchCatalogSnapshot>;

Defined in: packages/sage/src/identity/index.ts:401

Reads the Game research tree as an independent, context-cached catalog.

The result intentionally has no Character relation, unlock flags, perk state, or inferred player ownership. It also has no read metadata because the definitions registry does not expose an authoritative per-read envelope.

Parameters

Parameter	Type
ctx	SageContext

Returns

Promise<ResearchCatalogSnapshot>

Example

declare const ctx: SageContext;
const catalog = await getResearchCatalog(ctx);

---

maybeGetCharacterForProfile()

function maybeGetCharacterForProfile(
   ctx,
   profileAddress,
   options?): Promise<
  | CharacterSnapshot
| undefined>;

Defined in: packages/sage/src/identity/index.ts:481

Derives and optionally reads the Character for a known Player Profile.

Parameters

Parameter	Type
ctx	SageContext
profileAddress	Address
options?	ReadOptions

Returns

Promise< | CharacterSnapshot | undefined>

Example

declare const ctx: SageContext;
declare const profileAddress: Address;
const character = await maybeGetCharacterForProfile(ctx, profileAddress);

---

maybeGetProfile()

function maybeGetProfile(
   ctx,
   address,
options?): Promise<ProfileSnapshot | undefined>;

Defined in: packages/sage/src/identity/index.ts:436

Reads an optional Player Profile by account address.

Parameters

Parameter	Type
ctx	SageContext
address	Address
options?	ReadOptions

Returns

Promise<ProfileSnapshot | undefined>

Example

declare const ctx: SageContext;
declare const profileAddress: Address;
const profile = await maybeGetProfile(ctx, profileAddress);