# markets
Documentation: next (source: develop).

Install the preview: `pnpm add @aephia/atlas-kit@next`. These docs follow develop and may include changes not yet published to npm.

Markdown source of https://develop.atlas-kit-docs.pages.dev/reference/markets/ — see https://develop.atlas-kit-docs.pages.dev/ai/ for the full machine-readable surface.

## Interfaces

<a id="factionmarketoffersnapshot"></a>

### FactionMarketOfferSnapshot

Defined in: [packages/sage/src/markets/index.ts:139](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L139)

One cargo offer in a Faction Market.

#### Example

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

#### Extends

- [`CargoDefinitionSummary`](/reference/#cargodefinitionsummary)

#### Properties

<a id="canbuyfromfaction"></a>

##### canBuyFromFaction

```ts
readonly canBuyFromFaction: boolean;
```

Defined in: [packages/sage/src/markets/index.ts:140](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L140)

<a id="canselltofaction"></a>

##### canSellToFaction

```ts
readonly canSellToFaction: boolean;
```

Defined in: [packages/sage/src/markets/index.ts:141](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L141)

<a id="categoryid"></a>

##### categoryId

```ts
readonly categoryId: number;
```

Defined in: [packages/sage/src/registry/index.ts:105](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/registry/index.ts#L105)

###### Inherited from

[`CargoDefinitionSummary`](/reference/#cargodefinitionsummary).[`categoryId`](/reference/#cargodefinitionsummary)

<a id="id"></a>

##### id

```ts
readonly id: number;
```

Defined in: [packages/sage/src/registry/index.ts:106](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/registry/index.ts#L106)

###### Inherited from

[`CargoDefinitionSummary`](/reference/#cargodefinitionsummary).[`id`](/reference/#cargodefinitionsummary)

<a id="mint"></a>

##### mint

```ts
readonly mint: Address;
```

Defined in: [packages/sage/src/registry/index.ts:107](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/registry/index.ts#L107)

###### Inherited from

[`CargoDefinitionSummary`](/reference/#cargodefinitionsummary).[`mint`](/reference/#cargodefinitionsummary)

<a id="name"></a>

##### name

```ts
readonly name: string;
```

Defined in: [packages/sage/src/registry/index.ts:108](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/registry/index.ts#L108)

###### Inherited from

[`CargoDefinitionSummary`](/reference/#cargodefinitionsummary).[`name`](/reference/#cargodefinitionsummary)

<a id="priceatlas"></a>

##### priceAtlas

```ts
readonly priceAtlas: number;
```

Defined in: [packages/sage/src/markets/index.ts:143](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L143)

<a id="priceraw"></a>

##### priceRaw

```ts
readonly priceRaw: bigint;
```

Defined in: [packages/sage/src/markets/index.ts:142](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L142)

<a id="remainingquantityraw"></a>

##### remainingQuantityRaw

```ts
readonly remainingQuantityRaw: bigint;
```

Defined in: [packages/sage/src/markets/index.ts:144](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L144)

<a id="storagecost"></a>

##### storageCost

```ts
readonly storageCost: number;
```

Defined in: [packages/sage/src/registry/index.ts:109](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/registry/index.ts#L109)

###### Inherited from

[`CargoDefinitionSummary`](/reference/#cargodefinitionsummary).[`storageCost`](/reference/#cargodefinitionsummary)

***

<a id="factionmarketsnapshot"></a>

### FactionMarketSnapshot

Defined in: [packages/sage/src/markets/index.ts:154](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L154)

Immutable Faction Market configuration, lifecycle, and offers snapshot.

#### Example

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

#### Extends

- `Omit`\<`FactionMarketAccountData`, `"game"` \| `"offers"` \| `"system"`\>

#### Extended by

- [`FactionMarketView`](/reference/#factionmarketview)

#### Properties

<a id="address"></a>

##### address

```ts
readonly address: Address;
```

Defined in: [packages/sage/src/markets/index.ts:159](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L159)

<a id="atlasburnbasispoints"></a>

##### atlasBurnBasisPoints

```ts
readonly atlasBurnBasisPoints: number;
```

Defined in: [packages/sage/src/internal/c4/market.ts:179](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/market.ts#L179)

###### Inherited from

```ts
Omit.atlasBurnBasisPoints
```

<a id="authoredtargetquantityraw"></a>

##### authoredTargetQuantityRaw

```ts
readonly authoredTargetQuantityRaw: bigint;
```

Defined in: [packages/sage/src/internal/c4/market.ts:176](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/market.ts#L176)

###### Inherited from

```ts
Omit.authoredTargetQuantityRaw
```

<a id="bump"></a>

##### bump

```ts
readonly bump: number;
```

Defined in: [packages/sage/src/internal/c4/market.ts:167](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/market.ts#L167)

###### Inherited from

```ts
Omit.bump
```

<a id="factionid"></a>

##### factionId

```ts
readonly factionId: number;
```

Defined in: [packages/sage/src/internal/c4/market.ts:169](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/market.ts#L169)

###### Inherited from

```ts
Omit.factionId
```

<a id="faucetenabled"></a>

##### faucetEnabled

```ts
readonly faucetEnabled: boolean;
```

Defined in: [packages/sage/src/internal/c4/market.ts:181](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/market.ts#L181)

###### Inherited from

```ts
Omit.faucetEnabled
```

<a id="game"></a>

##### game

```ts
readonly game: EntityRef<"game">;
```

Defined in: [packages/sage/src/markets/index.ts:160](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L160)

<a id="kind"></a>

##### kind

```ts
readonly kind: "factionMarket";
```

Defined in: [packages/sage/src/markets/index.ts:158](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L158)

<a id="lastrestockedatunixseconds"></a>

##### lastRestockedAtUnixSeconds

```ts
readonly lastRestockedAtUnixSeconds: bigint;
```

Defined in: [packages/sage/src/internal/c4/market.ts:178](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/market.ts#L178)

###### Inherited from

```ts
Omit.lastRestockedAtUnixSeconds
```

<a id="minimumstandingtobuy"></a>

##### minimumStandingToBuy

```ts
readonly minimumStandingToBuy: number;
```

Defined in: [packages/sage/src/internal/c4/market.ts:173](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/market.ts#L173)

###### Inherited from

```ts
Omit.minimumStandingToBuy
```

<a id="minimumstandingtosell"></a>

##### minimumStandingToSell

```ts
readonly minimumStandingToSell: number;
```

Defined in: [packages/sage/src/internal/c4/market.ts:174](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/market.ts#L174)

###### Inherited from

```ts
Omit.minimumStandingToSell
```

<a id="offers"></a>

##### offers

```ts
readonly offers: readonly FactionMarketOfferSnapshot[];
```

Defined in: [packages/sage/src/markets/index.ts:162](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L162)

<a id="pricetierbasispoints"></a>

##### priceTierBasisPoints

```ts
readonly priceTierBasisPoints: readonly number[];
```

Defined in: [packages/sage/src/internal/c4/market.ts:175](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/market.ts#L175)

###### Inherited from

```ts
Omit.priceTierBasisPoints
```

<a id="restockperiodseconds"></a>

##### restockPeriodSeconds

```ts
readonly restockPeriodSeconds: number;
```

Defined in: [packages/sage/src/internal/c4/market.ts:177](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/market.ts#L177)

###### Inherited from

```ts
Omit.restockPeriodSeconds
```

<a id="standingbasispoints"></a>

##### standingBasisPoints

```ts
readonly standingBasisPoints: number;
```

Defined in: [packages/sage/src/internal/c4/market.ts:180](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/market.ts#L180)

###### Inherited from

```ts
Omit.standingBasisPoints
```

<a id="starbasesequenceid"></a>

##### starbaseSequenceId

```ts
readonly starbaseSequenceId: bigint;
```

Defined in: [packages/sage/src/internal/c4/market.ts:171](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/market.ts#L171)

###### Inherited from

```ts
Omit.starbaseSequenceId
```

<a id="status"></a>

##### status

```ts
readonly status: "active" | "draft";
```

Defined in: [packages/sage/src/internal/c4/market.ts:172](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/market.ts#L172)

###### Inherited from

```ts
Omit.status
```

<a id="system"></a>

##### system

```ts
readonly system: EntityRef<"starSystem">;
```

Defined in: [packages/sage/src/markets/index.ts:161](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L161)

<a id="version"></a>

##### version

```ts
readonly version: number;
```

Defined in: [packages/sage/src/internal/c4/market.ts:166](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/market.ts#L166)

###### Inherited from

```ts
Omit.version
```

#### Methods

<a id="tojson"></a>

##### toJSON()

```ts
toJSON(): unknown;
```

Defined in: [packages/sage/src/markets/index.ts:163](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L163)

###### Returns

`unknown`

***

<a id="localmarketmakerstatesnapshot"></a>

### LocalMarketMakerStateSnapshot

Defined in: [packages/sage/src/markets/index.ts:94](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L94)

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

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

#### Extends

- `LocalMarketMakerData`

#### Properties

<a id="cargoraw"></a>

##### cargoRaw

```ts
readonly cargoRaw: bigint;
```

Defined in: [packages/sage/src/internal/c4/market.ts:134](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/market.ts#L134)

###### Inherited from

```ts
LocalMarketMakerData.cargoRaw
```

<a id="character"></a>

##### character

```ts
readonly character: Address;
```

Defined in: [packages/sage/src/internal/c4/market.ts:129](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/market.ts#L129)

###### Inherited from

```ts
LocalMarketMakerData.character
```

<a id="characterref"></a>

##### characterRef

```ts
readonly characterRef: EntityRef<"character">;
```

Defined in: [packages/sage/src/markets/index.ts:95](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L95)

<a id="escrowedorreleasedatlas"></a>

##### escrowedOrReleasedAtlas

```ts
readonly escrowedOrReleasedAtlas: number;
```

Defined in: [packages/sage/src/internal/c4/market.ts:133](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/market.ts#L133)

###### Inherited from

```ts
LocalMarketMakerData.escrowedOrReleasedAtlas
```

<a id="escrowedorreleasedatlasraw"></a>

##### escrowedOrReleasedAtlasRaw

```ts
readonly escrowedOrReleasedAtlasRaw: bigint;
```

Defined in: [packages/sage/src/internal/c4/market.ts:132](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/market.ts#L132)

###### Inherited from

```ts
LocalMarketMakerData.escrowedOrReleasedAtlasRaw
```

<a id="openordercount"></a>

##### openOrderCount

```ts
readonly openOrderCount: number;
```

Defined in: [packages/sage/src/internal/c4/market.ts:130](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/market.ts#L130)

###### Inherited from

```ts
LocalMarketMakerData.openOrderCount
```

<a id="rentbytesownedraw"></a>

##### rentBytesOwnedRaw

```ts
readonly rentBytesOwnedRaw: bigint;
```

Defined in: [packages/sage/src/internal/c4/market.ts:131](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/market.ts#L131)

###### Inherited from

```ts
LocalMarketMakerData.rentBytesOwnedRaw
```

***

<a id="localmarketorderbooksnapshot"></a>

### LocalMarketOrderBookSnapshot

Defined in: [packages/sage/src/markets/index.ts:105](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L105)

One translated side of a Local Market order book.

#### Example

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

#### Properties

<a id="makers"></a>

##### makers

```ts
readonly makers: readonly LocalMarketMakerStateSnapshot[];
```

Defined in: [packages/sage/src/markets/index.ts:107](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L107)

<a id="nextorderidraw"></a>

##### nextOrderIdRaw

```ts
readonly nextOrderIdRaw: bigint;
```

Defined in: [packages/sage/src/markets/index.ts:106](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L106)

<a id="orders"></a>

##### orders

```ts
readonly orders: readonly LocalMarketOrderSnapshot[];
```

Defined in: [packages/sage/src/markets/index.ts:108](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L108)

***

<a id="localmarketordersnapshot"></a>

### LocalMarketOrderSnapshot

Defined in: [packages/sage/src/markets/index.ts:78](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L78)

One translated Local Market order.

#### Example

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

#### Extends

- `LocalMarketOrderData`

#### Properties

<a id="maker"></a>

##### maker

```ts
readonly maker: Address;
```

Defined in: [packages/sage/src/internal/c4/market.ts:121](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/market.ts#L121)

###### Inherited from

```ts
LocalMarketOrderData.maker
```

<a id="makerref"></a>

##### makerRef

```ts
readonly makerRef: EntityRef<"character">;
```

Defined in: [packages/sage/src/markets/index.ts:79](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L79)

<a id="orderid"></a>

##### orderId

```ts
readonly orderId: bigint;
```

Defined in: [packages/sage/src/internal/c4/market.ts:120](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/market.ts#L120)

###### Inherited from

```ts
LocalMarketOrderData.orderId
```

<a id="priceatlas-1"></a>

##### priceAtlas

```ts
readonly priceAtlas: number;
```

Defined in: [packages/sage/src/internal/c4/market.ts:123](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/market.ts#L123)

###### Inherited from

```ts
LocalMarketOrderData.priceAtlas
```

<a id="priceraw-1"></a>

##### priceRaw

```ts
readonly priceRaw: bigint;
```

Defined in: [packages/sage/src/internal/c4/market.ts:122](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/market.ts#L122)

###### Inherited from

```ts
LocalMarketOrderData.priceRaw
```

<a id="quantityraw"></a>

##### quantityRaw

```ts
readonly quantityRaw: bigint;
```

Defined in: [packages/sage/src/internal/c4/market.ts:124](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/market.ts#L124)

###### Inherited from

```ts
LocalMarketOrderData.quantityRaw
```

<a id="side"></a>

##### side

```ts
readonly side: "bid" | "ask";
```

Defined in: [packages/sage/src/internal/c4/market.ts:125](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/market.ts#L125)

###### Inherited from

```ts
LocalMarketOrderData.side
```

***

<a id="localmarketsnapshot"></a>

### LocalMarketSnapshot

Defined in: [packages/sage/src/markets/index.ts:118](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L118)

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

#### Example

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

#### Extends

- `Omit`\<`LocalMarketAccountData`, `"asks"` \| `"bids"` \| `"cargo"` \| `"initializerProfile"` \| `"system"`\>

#### Extended by

- [`LocalMarketView`](/reference/#localmarketview)

#### Properties

<a id="address-1"></a>

##### address

```ts
readonly address: Address;
```

Defined in: [packages/sage/src/markets/index.ts:123](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L123)

<a id="asks"></a>

##### asks

```ts
readonly asks: LocalMarketOrderBookSnapshot;
```

Defined in: [packages/sage/src/markets/index.ts:128](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L128)

<a id="bids"></a>

##### bids

```ts
readonly bids: LocalMarketOrderBookSnapshot;
```

Defined in: [packages/sage/src/markets/index.ts:127](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L127)

<a id="bump-1"></a>

##### bump

```ts
readonly bump: number;
```

Defined in: [packages/sage/src/internal/c4/market.ts:147](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/market.ts#L147)

###### Inherited from

```ts
Omit.bump
```

<a id="cargo"></a>

##### cargo

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

Defined in: [packages/sage/src/markets/index.ts:126](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L126)

###### Type Declaration

###### amountRaw

```ts
readonly amountRaw: bigint;
```

<a id="initializerprofile"></a>

##### initializerProfile

```ts
readonly initializerProfile: EntityRef<"profile">;
```

Defined in: [packages/sage/src/markets/index.ts:125](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L125)

<a id="kind-1"></a>

##### kind

```ts
readonly kind: "localMarket";
```

Defined in: [packages/sage/src/markets/index.ts:122](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L122)

<a id="starbasesequenceid-1"></a>

##### starbaseSequenceId

```ts
readonly starbaseSequenceId: bigint;
```

Defined in: [packages/sage/src/internal/c4/market.ts:146](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/market.ts#L146)

###### Inherited from

```ts
Omit.starbaseSequenceId
```

<a id="system-1"></a>

##### system

```ts
readonly system: EntityRef<"starSystem">;
```

Defined in: [packages/sage/src/markets/index.ts:124](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L124)

<a id="vaultatlas"></a>

##### vaultAtlas

```ts
readonly vaultAtlas: number;
```

Defined in: [packages/sage/src/internal/c4/market.ts:151](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/market.ts#L151)

###### Inherited from

```ts
Omit.vaultAtlas
```

<a id="vaultraw"></a>

##### vaultRaw

```ts
readonly vaultRaw: bigint;
```

Defined in: [packages/sage/src/internal/c4/market.ts:150](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/market.ts#L150)

###### Inherited from

```ts
Omit.vaultRaw
```

<a id="version-1"></a>

##### version

```ts
readonly version: number;
```

Defined in: [packages/sage/src/internal/c4/market.ts:144](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/market.ts#L144)

###### Inherited from

```ts
Omit.version
```

#### Methods

<a id="tojson-1"></a>

##### toJSON()

```ts
toJSON(): unknown;
```

Defined in: [packages/sage/src/markets/index.ts:129](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L129)

###### Returns

`unknown`

***

<a id="marketdiscoveryoptions"></a>

### MarketDiscoveryOptions

Defined in: [packages/sage/src/markets/index.ts:67](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L67)

Discovery controls for Local Market finders.

#### Example

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

#### Extends

- [`ReadOptions`](/reference/client/#readoptions)

#### Properties

<a id="commitment"></a>

##### commitment?

```ts
readonly optional commitment?: Commitment;
```

Defined in: [packages/sage/src/client/contracts.ts:179](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/client/contracts.ts#L179)

###### Inherited from

[`ReadOptions`](/reference/client/#readoptions).[`commitment`](/reference/client/#readoptions)

<a id="maxagems"></a>

##### maxAgeMs?

```ts
readonly optional maxAgeMs?: number;
```

Defined in: [packages/sage/src/client/contracts.ts:481](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/client/contracts.ts#L481)

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`](/reference/client/#readoptions).[`maxAgeMs`](/reference/client/#readoptions)

<a id="policy"></a>

##### policy?

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

Defined in: [packages/sage/src/client/contracts.ts:482](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/client/contracts.ts#L482)

###### Inherited from

[`ReadOptions`](/reference/client/#readoptions).[`policy`](/reference/client/#readoptions)

<a id="refresh"></a>

##### refresh?

```ts
readonly optional refresh?: boolean;
```

Defined in: [packages/sage/src/client/contracts.ts:475](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/client/contracts.ts#L475)

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`](/reference/client/#readoptions).[`refresh`](/reference/client/#readoptions)

<a id="signal"></a>

##### signal?

```ts
readonly optional signal?: AbortSignal;
```

Defined in: [packages/sage/src/markets/index.ts:68](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L68)

###### Overrides

[`ReadOptions`](/reference/client/#readoptions).[`signal`](/reference/client/#readoptions)

## Functions

<a id="derivefactionmarketaddress"></a>

### deriveFactionMarketAddress()

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

Defined in: [packages/sage/src/markets/index.ts:53](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L53)

Derives a Faction Market PDA from its verified generated seeds.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `game` | [`Address`](/reference/#address-20) |
| `system` | [`Address`](/reference/#address-20) |
| `starbaseSequenceId` | `bigint` |

#### Returns

`Promise`\<[`Address`](/reference/#address-20)\>

#### Example

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

***

<a id="derivelocalmarketaddress"></a>

### deriveLocalMarketAddress()

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

Defined in: [packages/sage/src/markets/index.ts:37](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L37)

Derives a Local Market PDA from its verified generated seeds.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `system` | [`Address`](/reference/#address-20) |
| `cargoId` | `number` |
| `starbaseSequenceId` | `bigint` |

#### Returns

`Promise`\<[`Address`](/reference/#address-20)\>

#### Example

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

***

<a id="getfactionmarket"></a>

### getFactionMarket()

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

Defined in: [packages/sage/src/markets/index.ts:464](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L464)

Reads one required Faction Market by address.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `context` | [`SageContext`](/reference/#sagecontext) |
| `address` | [`Address`](/reference/#address-20) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

#### Returns

`Promise`\<[`FactionMarketSnapshot`](/reference/markets/#factionmarketsnapshot)\>

#### Example

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

***

<a id="getfactionmarketforsystem"></a>

### getFactionMarketForSystem()

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

Defined in: [packages/sage/src/markets/index.ts:508](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L508)

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

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `context` | [`SageContext`](/reference/#sagecontext) |
| `system` | [`Address`](/reference/#address-20) |
| `starbaseSequenceId` | `bigint` |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

#### Returns

`Promise`\<[`FactionMarketSnapshot`](/reference/markets/#factionmarketsnapshot)\>

#### Example

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

***

<a id="getlocalmarket"></a>

### getLocalMarket()

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

Defined in: [packages/sage/src/markets/index.ts:325](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L325)

Reads one required Local Market by address.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `context` | [`SageContext`](/reference/#sagecontext) |
| `address` | [`Address`](/reference/#address-20) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

#### Returns

`Promise`\<[`LocalMarketSnapshot`](/reference/markets/#localmarketsnapshot)\>

#### Example

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

***

<a id="getlocalmarketforcargo"></a>

### getLocalMarketForCargo()

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

Defined in: [packages/sage/src/markets/index.ts:367](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L367)

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

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `context` | [`SageContext`](/reference/#sagecontext) |
| `system` | [`Address`](/reference/#address-20) |
| `cargoId` | `number` |
| `starbaseSequenceId` | `bigint` |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

#### Returns

`Promise`\<[`LocalMarketSnapshot`](/reference/markets/#localmarketsnapshot)\>

#### Example

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

***

<a id="getlocalmarketordersbycharacter"></a>

### getLocalMarketOrdersByCharacter()

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

Defined in: [packages/sage/src/markets/index.ts:423](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L423)

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`](/reference/#sagecontext) |
| `market` | [`Address`](/reference/#address-20) |
| `character` | [`Address`](/reference/#address-20) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

#### Returns

`Promise`\<readonly [`LocalMarketOrderSnapshot`](/reference/markets/#localmarketordersnapshot) & \{
  `makerState`: [`LocalMarketMakerStateSnapshot`](/reference/markets/#localmarketmakerstatesnapshot);
\}[]\>

#### Example

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

***

<a id="getlocalmarketsbysystem"></a>

### getLocalMarketsBySystem()

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

Defined in: [packages/sage/src/markets/index.ts:389](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L389)

Discovers all Local Markets stored for one Star System.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `context` | [`SageContext`](/reference/#sagecontext) |
| `system` | [`Address`](/reference/#address-20) |
| `options?` | [`MarketDiscoveryOptions`](/reference/markets/#marketdiscoveryoptions) |

#### Returns

`Promise`\<readonly [`LocalMarketSnapshot`](/reference/markets/#localmarketsnapshot)[]\>

#### Example

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

***

<a id="maybegetfactionmarket"></a>

### maybeGetFactionMarket()

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

Defined in: [packages/sage/src/markets/index.ts:484](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L484)

Reads one optional Faction Market by address.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `context` | [`SageContext`](/reference/#sagecontext) |
| `address` | [`Address`](/reference/#address-20) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

#### Returns

`Promise`\<
  \| [`FactionMarketSnapshot`](/reference/markets/#factionmarketsnapshot)
  \| `undefined`\>

#### Example

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

***

<a id="maybegetlocalmarket"></a>

### maybeGetLocalMarket()

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

Defined in: [packages/sage/src/markets/index.ts:344](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L344)

Reads one optional Local Market by address.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `context` | [`SageContext`](/reference/#sagecontext) |
| `address` | [`Address`](/reference/#address-20) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

#### Returns

`Promise`\<
  \| [`LocalMarketSnapshot`](/reference/markets/#localmarketsnapshot)
  \| `undefined`\>

#### Example

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