rewards

Interfaces

AtlasRewardConfigSnapshot

Defined in: packages/sage/src/rewards/index.ts:86

Cargo-resolved immutable ATLAS reward configuration version.

Example

declare const config: AtlasRewardConfigSnapshot;
console.log(config.configVersion, config.status);

Properties

activeMedallion

readonly activeMedallion:
  | {
  buyerPriceAtlasRaw: bigint;
  cargo: CargoDefinitionSummary;
  generation: number;
}
  | undefined;

Defined in: packages/sage/src/rewards/index.ts:109

address

readonly address: Address;

Defined in: packages/sage/src/rewards/index.ts:88

atlasBankInactivityExpirySeconds

readonly atlasBankInactivityExpirySeconds: bigint;

Defined in: packages/sage/src/rewards/index.ts:99

bump

readonly bump: number;

Defined in: packages/sage/src/rewards/index.ts:90

claimSettlementWindowSeconds

readonly claimSettlementWindowSeconds: number;

Defined in: packages/sage/src/rewards/index.ts:98

configVersion

readonly configVersion: number;

Defined in: packages/sage/src/rewards/index.ts:93

createdAtUnixSeconds

readonly createdAtUnixSeconds: bigint;

Defined in: packages/sage/src/rewards/index.ts:95

effectiveEpoch

readonly effectiveEpoch: bigint;

Defined in: packages/sage/src/rewards/index.ts:94

epochLengthSeconds

readonly epochLengthSeconds: number;

Defined in: packages/sage/src/rewards/index.ts:97

factionPoolLeverRaw

readonly factionPoolLeverRaw: bigint;

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

game

readonly game: EntityRef<"game">;

Defined in: packages/sage/src/rewards/index.ts:92

kind

readonly kind: "atlasRewardConfig";

Defined in: packages/sage/src/rewards/index.ts:87

kingSystemCurveRaw

readonly kingSystemCurveRaw: readonly readonly bigint[][];

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

lossModelTargetBps

readonly lossModelTargetBps: readonly number[];

Defined in: packages/sage/src/rewards/index.ts:107

medallionBuybackCapPerEpochRaw

readonly medallionBuybackCapPerEpochRaw: bigint;

Defined in: packages/sage/src/rewards/index.ts:116

pveLpRateBps

readonly pveLpRateBps: number;

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

pvpMedallionRateBps

readonly pvpMedallionRateBps: number;

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

repairKitLpRateRaw

readonly repairKitLpRateRaw: bigint;

Defined in: packages/sage/src/rewards/index.ts:106

rewardLootReclaimSeconds

readonly rewardLootReclaimSeconds: bigint;

Defined in: packages/sage/src/rewards/index.ts:100

rewardReserveLowBalanceThresholdRaw

readonly rewardReserveLowBalanceThresholdRaw: bigint;

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

salvageEntries

readonly salvageEntries: readonly {
  cargo: CargoDefinitionSummary;
  referenceValueAtlasRaw: bigint;
  weight: number;
}[];

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

salvageEvRateBps

readonly salvageEvRateBps: number;

Defined in: packages/sage/src/rewards/index.ts:105

sourceFlags

readonly sourceFlags: number;

Defined in: packages/sage/src/rewards/index.ts:96

starbaseDestructionMedallionsRaw

readonly starbaseDestructionMedallionsRaw: readonly bigint[];

Defined in: packages/sage/src/rewards/index.ts:108

status

readonly status: "enabled" | "disabled";

Defined in: packages/sage/src/rewards/index.ts:91

upgradeLpRates

readonly upgradeLpRates: readonly {
  cargo: CargoDefinitionSummary;
  lpPerRawUnit: bigint;
}[];

Defined in: packages/sage/src/rewards/index.ts:118

version

readonly version: number;

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

Methods

toJSON()

toJSON(): unknown;

Defined in: packages/sage/src/rewards/index.ts:127

Returns

unknown

---

AtlasRewardRegistrySnapshot

Defined in: packages/sage/src/rewards/index.ts:61

Immutable per-Game ATLAS reward registry and epoch selector.

Example

declare const registry: AtlasRewardRegistrySnapshot;
console.log(registry.currentEpoch, registry.activeConfigVersion);

Properties

activeConfigVersion

readonly activeConfigVersion: number;

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

address

readonly address: Address;

Defined in: packages/sage/src/rewards/index.ts:63

bump

readonly bump: number;

Defined in: packages/sage/src/rewards/index.ts:65

currentEpoch

readonly currentEpoch: bigint;

Defined in: packages/sage/src/rewards/index.ts:67

currentEpochEndsAtUnixSeconds

readonly currentEpochEndsAtUnixSeconds: bigint;

Defined in: packages/sage/src/rewards/index.ts:69

currentEpochStartedAtUnixSeconds

readonly currentEpochStartedAtUnixSeconds: bigint;

Defined in: packages/sage/src/rewards/index.ts:68

game

readonly game: EntityRef<"game">;

Defined in: packages/sage/src/rewards/index.ts:66

initialEpochOffsetSeconds

readonly initialEpochOffsetSeconds: bigint;

Defined in: packages/sage/src/rewards/index.ts:70

kind

readonly kind: "atlasRewardRegistry";

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

latestConfigVersion

readonly latestConfigVersion: number;

Defined in: packages/sage/src/rewards/index.ts:75

pendingConfig

readonly pendingConfig:
  | {
  configVersion: number;
  effectiveEpoch: bigint;
}
  | undefined;

Defined in: packages/sage/src/rewards/index.ts:72

version

readonly version: number;

Defined in: packages/sage/src/rewards/index.ts:64

Methods

toJSON()

toJSON(): unknown;

Defined in: packages/sage/src/rewards/index.ts:76

Returns

unknown

---

AtlasRewardStateSnapshot

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

Combined active/pending reward configuration and treasury state.

Member snapshots retain their independent read metadata. The composite’s metadata reports the earliest member slot so callers can inspect slot skew.

Example

declare const state: AtlasRewardStateSnapshot;
console.log(state.registry.currentEpoch, state.activeConfig.status);

Properties

activeConfig

readonly activeConfig: AtlasRewardConfigSnapshot;

Defined in: packages/sage/src/rewards/index.ts:163

kind

readonly kind: "atlasRewardState";

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

pendingConfig

readonly pendingConfig:
  | AtlasRewardConfigSnapshot
  | undefined;

Defined in: packages/sage/src/rewards/index.ts:164

registry

readonly registry: AtlasRewardRegistrySnapshot;

Defined in: packages/sage/src/rewards/index.ts:162

treasury

readonly treasury: AtlasRewardTreasurySnapshot;

Defined in: packages/sage/src/rewards/index.ts:165

Methods

toJSON()

toJSON(): unknown;

Defined in: packages/sage/src/rewards/index.ts:166

Returns

unknown

---

AtlasRewardTreasurySnapshot

Defined in: packages/sage/src/rewards/index.ts:137

Cargo-resolved finite ATLAS reward reserve.

Example

declare const treasury: AtlasRewardTreasurySnapshot;
console.log(treasury.reserves.length);

Properties

address

readonly address: Address;

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

bump

readonly bump: number;

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

game

readonly game: EntityRef<"game">;

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

kind

readonly kind: "atlasRewardTreasury";

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

reserves

readonly reserves: readonly {
  cargo: CargoDefinitionSummary;
  quantityRaw: bigint;
}[];

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

version

readonly version: number;

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

Methods

toJSON()

toJSON(): unknown;

Defined in: packages/sage/src/rewards/index.ts:147

Returns

unknown

---

RewardCommitmentSnapshot

Defined in: packages/sage/src/rewards/index.ts:186

Reward commitment carried by Loot, linked to combat through a typed reference.

Example

declare const commitment: RewardCommitmentSnapshot;
console.log(commitment.loot.address, commitment.configVersion);

Properties

committedAtUnixSeconds

readonly committedAtUnixSeconds: bigint;

Defined in: packages/sage/src/rewards/index.ts:195

configVersion

readonly configVersion: number;

Defined in: packages/sage/src/rewards/index.ts:193

game

readonly game: EntityRef<"game">;

Defined in: packages/sage/src/rewards/index.ts:189

kind

readonly kind: "rewardCommitment";

Defined in: packages/sage/src/rewards/index.ts:187

legs

readonly legs: readonly LootRewardLeg[];

Defined in: packages/sage/src/rewards/index.ts:196

loot

readonly loot: EntityRef<"loot">;

Defined in: packages/sage/src/rewards/index.ts:188

profile

readonly profile: EntityRef<"profile">;

Defined in: packages/sage/src/rewards/index.ts:190

rawStatus?

readonly optional rawStatus?: number;

Defined in: packages/sage/src/rewards/index.ts:192

slot

readonly slot: bigint;

Defined in: packages/sage/src/rewards/index.ts:194

status

readonly status: "resolved" | "unknown" | "committed";

Defined in: packages/sage/src/rewards/index.ts:191

Methods

toJSON()

toJSON(): unknown;

Defined in: packages/sage/src/rewards/index.ts:197

Returns

unknown

Type Aliases

RewardCommitmentDiscoveryOptions

type RewardCommitmentDiscoveryOptions = Omit<DiscoveryRequest, "filters" | "strategy">;

Defined in: packages/sage/src/rewards/index.ts:49

Options supported by reward-bearing Loot discovery.

Example

const options: RewardCommitmentDiscoveryOptions = { commitment: 'confirmed' };

Functions

getAtlasRewardConfig()

function getAtlasRewardConfig(
   context,
   configVersion,
options?): Promise<AtlasRewardConfigSnapshot>;

Defined in: packages/sage/src/rewards/index.ts:370

Derives and reads one immutable ATLAS reward config version.

Parameters

Parameter	Type
context	SageContext
configVersion	number
options?	ReadOptions

Returns

Promise<AtlasRewardConfigSnapshot>

Example

declare const ctx: SageContext;
const config = await getAtlasRewardConfig(ctx, 9);

---

getAtlasRewardRegistry()

function getAtlasRewardRegistry(context, options?): Promise<AtlasRewardRegistrySnapshot>;

Defined in: packages/sage/src/rewards/index.ts:283

Derives and reads the configured Game’s ATLAS reward registry.

Parameters

Parameter	Type
context	SageContext
options?	ReadOptions

Returns

Promise<AtlasRewardRegistrySnapshot>

Example

declare const ctx: SageContext;
const registry = await getAtlasRewardRegistry(ctx);

---

getAtlasRewardState()

function getAtlasRewardState(context, options?): Promise<AtlasRewardStateSnapshot>;

Defined in: packages/sage/src/rewards/index.ts:473

Reads combined active/pending config, epoch registry, and treasury state.

Parameters

Parameter	Type
context	SageContext
options?	ReadOptions

Returns

Promise<AtlasRewardStateSnapshot>

Example

declare const ctx: SageContext;
const state = await getAtlasRewardState(ctx);

---

getAtlasRewardTreasury()

function getAtlasRewardTreasury(context, options?): Promise<AtlasRewardTreasurySnapshot>;

Defined in: packages/sage/src/rewards/index.ts:430

Derives and reads the configured Game’s finite reward treasury.

Parameters

Parameter	Type
context	SageContext
options?	ReadOptions

Returns

Promise<AtlasRewardTreasurySnapshot>

Example

declare const ctx: SageContext;
const treasury = await getAtlasRewardTreasury(ctx);

---

getRewardCommitmentsByProfile()

function getRewardCommitmentsByProfile(
   context,
   profile,
options?): Promise<readonly RewardCommitmentSnapshot[]>;

Defined in: packages/sage/src/rewards/index.ts:611

Discovers reward-bearing Loot for one Profile and returns combat-boundary refs.

Parameters

Parameter	Type
context	SageContext
profile	Address
options?	RewardCommitmentDiscoveryOptions

Returns

Promise<readonly RewardCommitmentSnapshot[]>

Example

declare const ctx: SageContext;
declare const profile: Address;
const commitments = await getRewardCommitmentsByProfile(ctx, profile);

---

maybeGetRewardCommitment()

function maybeGetRewardCommitment(
   context,
   loot,
   options?): Promise<
  | RewardCommitmentSnapshot
| undefined>;

Defined in: packages/sage/src/rewards/index.ts:587

Reads an optional reward commitment from one Loot account.

Parameters

Parameter	Type
context	SageContext
loot	Address
options?	ReadOptions

Returns

Promise< | RewardCommitmentSnapshot | undefined>

Example

declare const ctx: SageContext;
declare const loot: Address;
const commitment = await maybeGetRewardCommitment(ctx, loot);

---

selectAtlasRewardConfigVersion()

function selectAtlasRewardConfigVersion(registry, epoch): number;

Defined in: packages/sage/src/rewards/index.ts:456

Selects the config version effective for an epoch, including the pending boundary.

Parameters

Parameter	Type
registry	AtlasRewardRegistrySnapshot
epoch	bigint

Returns

number

Example

declare const registry: AtlasRewardRegistrySnapshot;
const version = selectAtlasRewardConfigVersion(registry, 20_670n);

References

LootRewardLeg

Re-exports LootRewardLeg