markets

Interfaces

FactionMarketOfferSnapshot

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

One cargo offer in a Faction Market.

Example

declare const offer: FactionMarketOfferSnapshot;
console.log(offer.name, offer.priceAtlas);

Extends

• CargoDefinitionSummary

Properties

canBuyFromFaction

readonly canBuyFromFaction: boolean;

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

canSellToFaction

readonly canSellToFaction: boolean;

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

categoryId

readonly categoryId: number;

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

Inherited from

CargoDefinitionSummary.categoryId

id

readonly id: number;

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

Inherited from

CargoDefinitionSummary.id

mint

readonly mint: Address;

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

Inherited from

CargoDefinitionSummary.mint

name

readonly name: string;

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

Inherited from

CargoDefinitionSummary.name

priceAtlas

readonly priceAtlas: number;

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

priceRaw

readonly priceRaw: bigint;

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

remainingQuantityRaw

readonly remainingQuantityRaw: bigint;

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

storageCost

readonly storageCost: number;

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

Inherited from

CargoDefinitionSummary.storageCost

---

FactionMarketSnapshot

Defined in: packages/sage/src/markets/index.ts:154

Immutable Faction Market configuration, lifecycle, and offers snapshot.

Example

declare const market: FactionMarketSnapshot;
console.log(market.status, market.offers);

Extends

• Omit<FactionMarketAccountData, "game" | "offers" | "system">

Extended by

• FactionMarketView

Properties

address

readonly address: Address;

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

atlasBurnBasisPoints

readonly atlasBurnBasisPoints: number;

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

Inherited from

Omit.atlasBurnBasisPoints

authoredTargetQuantityRaw

readonly authoredTargetQuantityRaw: bigint;

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

Inherited from

Omit.authoredTargetQuantityRaw

bump

readonly bump: number;

Defined in: packages/sage/src/internal/c4/market.ts:167

Inherited from

Omit.bump

factionId

readonly factionId: number;

Defined in: packages/sage/src/internal/c4/market.ts:169

Inherited from

Omit.factionId

faucetEnabled

readonly faucetEnabled: boolean;

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

Inherited from

Omit.faucetEnabled

game

readonly game: EntityRef<"game">;

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

kind

readonly kind: "factionMarket";

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

lastRestockedAtUnixSeconds

readonly lastRestockedAtUnixSeconds: bigint;

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

Inherited from

Omit.lastRestockedAtUnixSeconds

minimumStandingToBuy

readonly minimumStandingToBuy: number;

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

Inherited from

Omit.minimumStandingToBuy

minimumStandingToSell

readonly minimumStandingToSell: number;

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

Inherited from

Omit.minimumStandingToSell

offers

readonly offers: readonly FactionMarketOfferSnapshot[];

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

priceTierBasisPoints

readonly priceTierBasisPoints: readonly number[];

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

Inherited from

Omit.priceTierBasisPoints

restockPeriodSeconds

readonly restockPeriodSeconds: number;

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

Inherited from

Omit.restockPeriodSeconds

standingBasisPoints

readonly standingBasisPoints: number;

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

Inherited from

Omit.standingBasisPoints

starbaseSequenceId

readonly starbaseSequenceId: bigint;

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

Inherited from

Omit.starbaseSequenceId

status

readonly status: "active" | "draft";

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

Inherited from

Omit.status

system

readonly system: EntityRef<"starSystem">;

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

version

readonly version: number;

Defined in: packages/sage/src/internal/c4/market.ts:166

Inherited from

Omit.version

Methods

toJSON()

toJSON(): unknown;

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

Returns

unknown

---

LocalMarketMakerStateSnapshot

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

One Character’s maker state on one order-book side.

escrowedOrReleasedAtlas is escrowed ATLAS for bids and ATLAS released from completed sales for asks. It does not establish that either amount is currently withdrawable.

Example

declare const makerState: LocalMarketMakerStateSnapshot;
console.log(makerState.escrowedOrReleasedAtlas);

Extends

• LocalMarketMakerData

Properties

cargoRaw

readonly cargoRaw: bigint;

Defined in: packages/sage/src/internal/c4/market.ts:134

Inherited from

LocalMarketMakerData.cargoRaw

character

readonly character: Address;

Defined in: packages/sage/src/internal/c4/market.ts:129

Inherited from

LocalMarketMakerData.character

characterRef

readonly characterRef: EntityRef<"character">;

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

escrowedOrReleasedAtlas

readonly escrowedOrReleasedAtlas: number;

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

Inherited from

LocalMarketMakerData.escrowedOrReleasedAtlas

escrowedOrReleasedAtlasRaw

readonly escrowedOrReleasedAtlasRaw: bigint;

Defined in: packages/sage/src/internal/c4/market.ts:132

Inherited from

LocalMarketMakerData.escrowedOrReleasedAtlasRaw

openOrderCount

readonly openOrderCount: number;

Defined in: packages/sage/src/internal/c4/market.ts:130

Inherited from

LocalMarketMakerData.openOrderCount

rentBytesOwnedRaw

readonly rentBytesOwnedRaw: bigint;

Defined in: packages/sage/src/internal/c4/market.ts:131

Inherited from

LocalMarketMakerData.rentBytesOwnedRaw

---

LocalMarketOrderBookSnapshot

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

One translated side of a Local Market order book.

Example

declare const book: LocalMarketOrderBookSnapshot;
console.log(book.orders.length);

Properties

makers

readonly makers: readonly LocalMarketMakerStateSnapshot[];

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

nextOrderIdRaw

readonly nextOrderIdRaw: bigint;

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

orders

readonly orders: readonly LocalMarketOrderSnapshot[];

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

---

LocalMarketOrderSnapshot

Defined in: packages/sage/src/markets/index.ts:78

One translated Local Market order.

Example

declare const order: LocalMarketOrderSnapshot;
console.log(order.side, order.priceAtlas);

Extends

• LocalMarketOrderData

Properties

maker

readonly maker: Address;

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

Inherited from

LocalMarketOrderData.maker

makerRef

readonly makerRef: EntityRef<"character">;

Defined in: packages/sage/src/markets/index.ts:79

orderId

readonly orderId: bigint;

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

Inherited from

LocalMarketOrderData.orderId

priceAtlas

readonly priceAtlas: number;

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

Inherited from

LocalMarketOrderData.priceAtlas

priceRaw

readonly priceRaw: bigint;

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

Inherited from

LocalMarketOrderData.priceRaw

quantityRaw

readonly quantityRaw: bigint;

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

Inherited from

LocalMarketOrderData.quantityRaw

side

readonly side: "bid" | "ask";

Defined in: packages/sage/src/internal/c4/market.ts:125

Inherited from

LocalMarketOrderData.side

---

LocalMarketSnapshot

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

Immutable Local Market, order book, escrow, and maker-state snapshot.

Example

declare const market: LocalMarketSnapshot;
console.log(market.cargo.name, market.asks.orders);

Extends

• Omit<LocalMarketAccountData, "asks" | "bids" | "cargo" | "initializerProfile" | "system">

Extended by

• LocalMarketView

Properties

address

readonly address: Address;

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

asks

readonly asks: LocalMarketOrderBookSnapshot;

Defined in: packages/sage/src/markets/index.ts:128

bids

readonly bids: LocalMarketOrderBookSnapshot;

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

bump

readonly bump: number;

Defined in: packages/sage/src/internal/c4/market.ts:147

Inherited from

Omit.bump

cargo

readonly cargo: CargoDefinitionSummary & {
  amountRaw: bigint;
};

Defined in: packages/sage/src/markets/index.ts:126

Type Declaration

amountRaw

readonly amountRaw: bigint;

initializerProfile

readonly initializerProfile: EntityRef<"profile">;

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

kind

readonly kind: "localMarket";

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

starbaseSequenceId

readonly starbaseSequenceId: bigint;

Defined in: packages/sage/src/internal/c4/market.ts:146

Inherited from

Omit.starbaseSequenceId

system

readonly system: EntityRef<"starSystem">;

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

vaultAtlas

readonly vaultAtlas: number;

Defined in: packages/sage/src/internal/c4/market.ts:151

Inherited from

Omit.vaultAtlas

vaultRaw

readonly vaultRaw: bigint;

Defined in: packages/sage/src/internal/c4/market.ts:150

Inherited from

Omit.vaultRaw

version

readonly version: number;

Defined in: packages/sage/src/internal/c4/market.ts:144

Inherited from

Omit.version

Methods

toJSON()

toJSON(): unknown;

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

Returns

unknown

---

MarketDiscoveryOptions

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

Discovery controls for Local Market finders.

Example

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

Extends

• ReadOptions

Properties

commitment?

readonly optional commitment?: Commitment;

Defined in: packages/sage/src/client/contracts.ts:153

Inherited from

ReadOptions.commitment

maxAgeMs?

readonly optional maxAgeMs?: number;

Defined in: packages/sage/src/client/contracts.ts:455

Maximum age of a completed cache entry in milliseconds.

Overrides the context’s defaultMaxAgeMs. Use 0 to always revalidate or Infinity to reuse completed cache entries until explicit invalidation.

Inherited from

ReadOptions.maxAgeMs

policy?

readonly optional policy?: "cache-first" | "no-store";

Defined in: packages/sage/src/client/contracts.ts:456

Inherited from

ReadOptions.policy

refresh?

readonly optional refresh?: boolean;

Defined in: packages/sage/src/client/contracts.ts:449

Bypasses a completed cache entry.

A refresh may share a compatible provider request that is already in flight, because that request has not yet produced cached state.

Inherited from

ReadOptions.refresh

signal?

readonly optional signal?: AbortSignal;

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

Overrides

ReadOptions.signal

Functions

deriveFactionMarketAddress()

function deriveFactionMarketAddress(
   game,
   system,
starbaseSequenceId): Promise<Address>;

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

Derives a Faction Market PDA from its verified generated seeds.

Parameters

Parameter	Type
game	Address
system	Address
starbaseSequenceId	bigint

Returns

Promise<Address>

Example

declare const game: Address;
declare const system: Address;
const address = await deriveFactionMarketAddress(game, system, 0n);

---

deriveLocalMarketAddress()

function deriveLocalMarketAddress(
   system,
   cargoId,
starbaseSequenceId): Promise<Address>;

Defined in: packages/sage/src/markets/index.ts:37

Derives a Local Market PDA from its verified generated seeds.

Parameters

Parameter	Type
system	Address
cargoId	number
starbaseSequenceId	bigint

Returns

Promise<Address>

Example

declare const system: Address;
const address = await deriveLocalMarketAddress(system, 1, 0n);

---

getFactionMarket()

function getFactionMarket(
   context,
   address,
options?): Promise<FactionMarketSnapshot>;

Defined in: packages/sage/src/markets/index.ts:464

Reads one required Faction Market by address.

Parameters

Parameter	Type
context	SageContext
address	Address
options?	ReadOptions

Returns

Promise<FactionMarketSnapshot>

Example

declare const ctx: SageContext;
declare const address: Address;
const market = await getFactionMarket(ctx, address);

---

getFactionMarketForSystem()

function getFactionMarketForSystem(
   context,
   system,
   starbaseSequenceId,
options?): Promise<FactionMarketSnapshot>;

Defined in: packages/sage/src/markets/index.ts:508

Derives and reads the configured Game’s Faction Market at one Starbase incarnation.

Parameters

Parameter	Type
context	SageContext
system	Address
starbaseSequenceId	bigint
options?	ReadOptions

Returns

Promise<FactionMarketSnapshot>

Example

declare const ctx: SageContext;
declare const system: Address;
const market = await getFactionMarketForSystem(ctx, system, 0n);

---

getLocalMarket()

function getLocalMarket(
   context,
   address,
options?): Promise<LocalMarketSnapshot>;

Defined in: packages/sage/src/markets/index.ts:325

Reads one required Local Market by address.

Parameters

Parameter	Type
context	SageContext
address	Address
options?	ReadOptions

Returns

Promise<LocalMarketSnapshot>

Example

declare const ctx: SageContext;
declare const address: Address;
const market = await getLocalMarket(ctx, address);

---

getLocalMarketForCargo()

function getLocalMarketForCargo(
   context,
   system,
   cargoId,
   starbaseSequenceId,
options?): Promise<LocalMarketSnapshot>;

Defined in: packages/sage/src/markets/index.ts:367

Derives and reads a Local Market for cargo at one Starbase incarnation.

Parameters

Parameter	Type
context	SageContext
system	Address
cargoId	number
starbaseSequenceId	bigint
options?	ReadOptions

Returns

Promise<LocalMarketSnapshot>

Example

declare const ctx: SageContext;
declare const system: Address;
const market = await getLocalMarketForCargo(ctx, system, 1, 0n);

---

getLocalMarketOrdersByCharacter()

function getLocalMarketOrdersByCharacter(
   context,
   market,
   character,
   options?): Promise<readonly LocalMarketOrderSnapshot & {
  makerState: LocalMarketMakerStateSnapshot;
}[]>;

Defined in: packages/sage/src/markets/index.ts:423

Returns one Character’s open orders with that side’s maker state.

Bid-side ATLAS is escrowed for buy orders. Ask-side ATLAS was released from completed sell orders. Neither interpretation promises withdrawability.

Parameters

Parameter	Type
context	SageContext
market	Address
character	Address
options?	ReadOptions

Returns

Promise<readonly LocalMarketOrderSnapshot & { makerState: LocalMarketMakerStateSnapshot; }[]>

Example

declare const ctx: SageContext;
declare const market: Address;
declare const character: Address;
const orders = await getLocalMarketOrdersByCharacter(ctx, market, character);

---

getLocalMarketsBySystem()

function getLocalMarketsBySystem(
   context,
   system,
options?): Promise<readonly LocalMarketSnapshot[]>;

Defined in: packages/sage/src/markets/index.ts:389

Discovers all Local Markets stored for one Star System.

Parameters

Parameter	Type
context	SageContext
system	Address
options?	MarketDiscoveryOptions

Returns

Promise<readonly LocalMarketSnapshot[]>

Example

declare const ctx: SageContext;
declare const system: Address;
const markets = await getLocalMarketsBySystem(ctx, system);

---

maybeGetFactionMarket()

function maybeGetFactionMarket(
   context,
   address,
   options?): Promise<
  | FactionMarketSnapshot
| undefined>;

Defined in: packages/sage/src/markets/index.ts:484

Reads one optional Faction Market by address.

Parameters

Parameter	Type
context	SageContext
address	Address
options?	ReadOptions

Returns

Promise< | FactionMarketSnapshot | undefined>

Example

declare const ctx: SageContext;
declare const address: Address;
const market = await maybeGetFactionMarket(ctx, address);

---

maybeGetLocalMarket()

function maybeGetLocalMarket(
   context,
   address,
   options?): Promise<
  | LocalMarketSnapshot
| undefined>;

Defined in: packages/sage/src/markets/index.ts:344

Reads one optional Local Market by address.

Parameters

Parameter	Type
context	SageContext
address	Address
options?	ReadOptions

Returns

Promise< | LocalMarketSnapshot | undefined>

Example

declare const ctx: SageContext;
declare const address: Address;
const market = await maybeGetLocalMarket(ctx, address);