mining

Interfaces

FleetMiningOutput

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

One selected and registry-resolved output of an active mining Fleet.

Example

declare const output: FleetMiningOutput;
console.log(output.cargo.name, output.unitsPerSecond);

Extends

ResourceDepositItem

Properties

activeMinerCountRaw

readonly activeMinerCountRaw: bigint;

Defined in: packages/sage/src/mining/index.ts:55

Inherited from

ResourceDepositItem.activeMinerCountRaw

amountMinedUnitsRaw

readonly amountMinedUnitsRaw: bigint;

Defined in: packages/sage/src/mining/index.ts:54

Inherited from

ResourceDepositItem.amountMinedUnitsRaw

cargo

readonly cargo: CargoDefinitionSummary;

Defined in: packages/sage/src/mining/index.ts:52

Inherited from

ResourceDepositItem.cargo

richness

readonly richness: WorldFixedValue;

Defined in: packages/sage/src/mining/index.ts:53

Inherited from

ResourceDepositItem.richness

unitsPerSecond

readonly unitsPerSecond: number;

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

FleetMiningSnapshot

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

Immutable current extraction relationship for one active mining Fleet.

Example

declare const mining: FleetMiningSnapshot;
console.log(mining.outputs);

Properties

asteroid

readonly asteroid: EntityRef<"celestialBody">;

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

fleet

readonly fleet: EntityRef<"fleet">;

Defined in: packages/sage/src/mining/index.ts:120

kind

readonly kind: "fleetMining";

Defined in: packages/sage/src/mining/index.ts:119

lastUpdatedAtUnixSeconds

readonly lastUpdatedAtUnixSeconds: bigint;

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

miningRate

readonly miningRate: {
  raw: bigint;
  unitsPerSecond: number;
};

Defined in: packages/sage/src/mining/index.ts:125

raw

readonly raw: bigint;

unitsPerSecond

readonly unitsPerSecond: number;

outputs

readonly outputs: readonly FleetMiningOutput[];

Defined in: packages/sage/src/mining/index.ts:129

ownerProfile

readonly ownerProfile: EntityRef<"profile">;

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

regionXpModifier

readonly regionXpModifier: WorldFixedValue;

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

Methods

toJSON()

toJSON(): unknown;

Defined in: packages/sage/src/mining/index.ts:130

Returns

unknown

MiningOutputRate

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

One richness-adjusted resource output in cargo units per second.

Example

const rate: MiningOutputRate = { cargoId: 8, unitsPerSecond: 4.5 };

Properties

cargoId

readonly cargoId: number;

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

unitsPerSecond

readonly unitsPerSecond: number;

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

MiningOutputRateInput

Defined in: packages/sage/src/mining/index.ts:84

A pure rate input pairing one cargo id with Asteroid richness.

Example

const input: MiningOutputRateInput = { cargoId: 8, richness: 1.5 };

Properties

cargoId

readonly cargoId: number;

Defined in: packages/sage/src/mining/index.ts:85

richness

readonly richness: number;

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

ResourceDepositItem

Defined in: packages/sage/src/mining/index.ts:51

One registry-resolved resource row nested in an Asteroid deposit.

Example

declare const resource: ResourceDepositItem;
console.log(resource.cargo.name, resource.richness.value);

Extended by

FleetMiningOutput

Properties

activeMinerCountRaw

readonly activeMinerCountRaw: bigint;

Defined in: packages/sage/src/mining/index.ts:55

amountMinedUnitsRaw

readonly amountMinedUnitsRaw: bigint;

Defined in: packages/sage/src/mining/index.ts:54

cargo

readonly cargo: CargoDefinitionSummary;

Defined in: packages/sage/src/mining/index.ts:52

richness

readonly richness: WorldFixedValue;

Defined in: packages/sage/src/mining/index.ts:53

ResourceDepositSnapshot

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

Immutable, translated Asteroid resource-deposit snapshot.

Example

declare const deposit: ResourceDepositSnapshot;
console.log(deposit.resources);

Properties

address

readonly address: Address;

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

bodyId

readonly bodyId: number;

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

game

readonly game: Address;

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

kind

readonly kind: "resourceDeposit";

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

lastSyncedAtUnixSeconds

readonly lastSyncedAtUnixSeconds: bigint;

Defined in: packages/sage/src/mining/index.ts:73

name

readonly name: string;

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

resources

readonly resources: readonly ResourceDepositItem[];

Defined in: packages/sage/src/mining/index.ts:74

system

readonly system: EntityRef<"starSystem">;

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

systemSequenceId

readonly systemSequenceId: bigint;

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

Methods

toJSON()

toJSON(): unknown;

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

Returns

unknown

Type Aliases

MiningDiscoveryOptions

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

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

Options supported by owner-scoped active-mining discovery.

Example

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

Functions

deriveMiningOutputRates()

function deriveMiningOutputRates(fleetUnitsPerSecond, outputs): readonly MiningOutputRate[];

Defined in: packages/sage/src/mining/index.ts:317

Derives each selected output rate as Fleet units/second times deposit richness.

Parameters

Parameter	Type
`fleetUnitsPerSecond`	`number`
`outputs`	readonly `MiningOutputRateInput`[]

Returns

readonly MiningOutputRate[]

Example

const rates = deriveMiningOutputRates(2, [{ cargoId: 8, richness: 1.5 }]);

deriveMiningStateAgeSeconds()

function deriveMiningStateAgeSeconds(lastUpdatedAtUnixSeconds, atUnixSeconds): number;

Defined in: packages/sage/src/mining/index.ts:300

Derives mining-state age in whole seconds and clamps future timestamps.

Parameters

Parameter	Type
`lastUpdatedAtUnixSeconds`	`bigint`
`atUnixSeconds`	`bigint`

Returns

number

Example

const age = deriveMiningStateAgeSeconds(100n, 112n); // 12

getFleetMiningState()

function getFleetMiningState(
   context,
   fleet,
   options?): Promise<
  | FleetMiningSnapshot
| undefined>;

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

Reads a Fleet and returns its active extraction relationship, if mining.

Parameters

Parameter	Type
`context`	`SageContext`
`fleet`	`Address`
`options?`	`ReadOptions`

Returns

Promise< | FleetMiningSnapshot | undefined>

Example

declare const ctx: SageContext;
declare const fleet: Address;
const mining = await getFleetMiningState(ctx, fleet);

getFleetMiningStatesByOwner()

function getFleetMiningStatesByOwner(
   context,
   owner,
options?): Promise<readonly FleetMiningSnapshot[]>;

Defined in: packages/sage/src/mining/index.ts:505

Finds active mining Fleets for one owner through stable Fleet filters.

Parameters

Parameter	Type
`context`	`SageContext`
`owner`	`Address`
`options?`	`MiningDiscoveryOptions`

Returns

Promise<readonly FleetMiningSnapshot[]>

Example

declare const ctx: SageContext;
declare const owner: Address;
const mining = await getFleetMiningStatesByOwner(ctx, owner);

getResourceDeposit()

function getResourceDeposit(
   context,
   asteroid,
options?): Promise<ResourceDepositSnapshot>;

Defined in: packages/sage/src/mining/index.ts:253

Reads a required Asteroid resource deposit by CelestialBody address.

Parameters

Parameter	Type
`context`	`SageContext`
`asteroid`	`Address`
`options?`	`ReadOptions`

Returns

Promise<ResourceDepositSnapshot>

Example

declare const ctx: SageContext;
declare const asteroid: Address;
const deposit = await getResourceDeposit(ctx, asteroid);

maybeGetResourceDeposit()

function maybeGetResourceDeposit(
   context,
   asteroid,
   options?): Promise<
  | ResourceDepositSnapshot
| undefined>;

Defined in: packages/sage/src/mining/index.ts:278

Reads an optional Asteroid resource deposit by CelestialBody address.

Returns undefined only when the account does not exist. A present non-Asteroid CelestialBody throws AccountDecodeError because it is not a resource deposit.

Parameters

Parameter	Type
`context`	`SageContext`
`asteroid`	`Address`
`options?`	`ReadOptions`

Returns

Promise< | ResourceDepositSnapshot | undefined>

Example

declare const ctx: SageContext;
declare const asteroid: Address;
const deposit = await maybeGetResourceDeposit(ctx, asteroid);

projectMiningOutputUnits()

function projectMiningOutputUnits(unitsPerSecond, elapsedSeconds): number;

Defined in: packages/sage/src/mining/index.ts:351

Projects nominal output units from a rate and elapsed seconds.

Parameters

Parameter	Type
`unitsPerSecond`	`number`
`elapsedSeconds`	`number`

Returns

number

Example

const units = projectMiningOutputUnits(4.5, 20); // 90