Class GmOrderbookService

Establishes a connection to the Galactic Marketplace and maintains an up-to-date real time snapshot of all open marketplace orders.

Param: rpcUrl

Solana RPC Provider Url

Param: programId

The Galactic Marketplace program PublicKey

Param: commitment

Optional Solana commitment level, defaults to confirmed

Constructors

constructor

new GmOrderbookService(connection, programId, healthcheckThresholdSeconds?): GmOrderbookService
Parameters
- connection: Connection
- programId: PublicKey
- healthcheckThresholdSeconds: number = 60
Returns GmOrderbookService
- Defined in src/marketplace/services/GmOrderbookService.ts:35

Properties

`Protected` changeObserverDisposer

changeObserverDisposer: IDisposer = null

`Protected` connection

connection: Connection

`Protected` eventCallBacks

eventCallBacks: GmEventHandler[] = []

`Protected` gmClientService

gmClientService: GmClientService = ...

`Protected` gmEventService

gmEventService: GmEventService

`Protected` healthcheckThreshold

healthcheckThreshold: number

`Protected` healthcheckTimer

healthcheckTimer: Timer

`Protected` isReloading

isReloading: boolean = false

`Protected` lastEventTimestamp

lastEventTimestamp: number = ...

`Protected` marketplaceProgramId

marketplaceProgramId: PublicKey

`Protected` orderCacheService

orderCacheService: OrderCacheService

`Static` `Private` HEALTH_CHECK_RATE

HEALTH_CHECK_RATE: number = 5000

Methods

addOnEventHandler

addOnEventHandler(eventHandler): void
Parameters
- eventHandler: GmEventHandler
Returns void
- Defined in src/marketplace/services/GmOrderbookService.ts:162

addOrderToCache

addOrderToCache(order): Order
Parameters
- order: Order
Returns Order
- Defined in src/marketplace/services/GmOrderbookService.ts:187

end

end(): Promise<boolean>
Returns Promise<boolean>
- Defined in src/marketplace/services/GmOrderbookService.ts:80

`Protected` filterOrdersByCurrency

filterOrdersByCurrency(currencyMint, orders): Order[]
Parameters
- currencyMint: string
- orders: Order[]
Returns Order[]
- Defined in src/marketplace/services/GmOrderbookService.ts:249

getAllMints

getAllMints(): string[]
Returns string[]
- Defined in src/marketplace/services/GmOrderbookService.ts:283

getAllOrdersByItemMint

getAllOrdersByItemMint(mint): Map<string, Order>
Parameters
- mint: string
Returns Map<string, Order>
- Defined in src/marketplace/services/GmOrderbookService.ts:262

getAllOrdersForUserAddress

getAllOrdersForUserAddress(publicKey): Order[]
Parameters
- publicKey: string
Returns Order[]
- Defined in src/marketplace/services/GmOrderbookService.ts:287

getBuyOrders

getBuyOrders(): Map<string, Map<string, Order>>
Returns Map<string, Map<string, Order>>
- Defined in src/marketplace/services/GmOrderbookService.ts:199

getBuyOrdersByCurrencyAndItem

getBuyOrdersByCurrencyAndItem(currencyMint, itemMint): Order[]
Parameters
- currencyMint: string
- itemMint: string
Returns Order[]
- Defined in src/marketplace/services/GmOrderbookService.ts:219

getBuyOrdersForMint

getBuyOrdersForMint(mint): Map<string, Order>
Parameters
- mint: string
Returns Map<string, Order>
- Defined in src/marketplace/services/GmOrderbookService.ts:203

`Protected` getIsServiceHealthy

getIsServiceHealthy(): boolean
Returns boolean
- Defined in src/marketplace/services/GmOrderbookService.ts:89

`Protected` getNow

getNow(): number
Returns number
- Defined in src/marketplace/services/GmOrderbookService.ts:334

getOrderById

getOrderById(id): Order
Parameters
- id: string
Returns Order
- Defined in src/marketplace/services/GmOrderbookService.ts:258

getOrdersByType

getOrdersByType(orderType): Map<string, Map<string, Order>>
Parameters
- orderType: "buy" | "sell"
Returns Map<string, Map<string, Order>>
- Defined in src/marketplace/services/GmOrderbookService.ts:215

getSellOrders

getSellOrders(): Map<string, Map<string, Order>>
Returns Map<string, Map<string, Order>>
- Defined in src/marketplace/services/GmOrderbookService.ts:207

getSellOrdersByCurrencyAndItem

getSellOrdersByCurrencyAndItem(currencyMint, itemMint): Order[]
Parameters
- currencyMint: string
- itemMint: string
Returns Order[]
- Defined in src/marketplace/services/GmOrderbookService.ts:234

getSellOrdersForMint

getSellOrdersForMint(mint): Map<string, Order>
Parameters
- mint: string
Returns Map<string, Order>
- Defined in src/marketplace/services/GmOrderbookService.ts:211

`Protected` handleMarketplaceEvent

handleMarketplaceEvent(eventType, order): void
Parameters
- eventType: GmEventType
- order: Order
Returns void
- Defined in src/marketplace/services/GmOrderbookService.ts:314

`Protected` handleOrderAddedEvent

handleOrderAddedEvent(order): void
Parameters
- order: Order
Returns void
- Defined in src/marketplace/services/GmOrderbookService.ts:297

`Protected` handleOrderCanceledEvent

handleOrderCanceledEvent(order): void
Parameters
- order: Order
Returns void
- Defined in src/marketplace/services/GmOrderbookService.ts:310

`Protected` handleOrderModifiedEvent

handleOrderModifiedEvent(order): void
Parameters
- order: Order
Returns void
- Defined in src/marketplace/services/GmOrderbookService.ts:301

initialize

initialize(): Promise<number>
Returns Promise<number>
- Defined in src/marketplace/services/GmOrderbookService.ts:54

loadInitialOrders

loadInitialOrders(): Promise<number>
Returns Promise<number>
- Defined in src/marketplace/services/GmOrderbookService.ts:170

`Protected` refetchOrderData

refetchOrderData(): Promise<void>
Returns Promise<void>
- Defined in src/marketplace/services/GmOrderbookService.ts:121

removeOnEventHandler

removeOnEventHandler(eventHandler): void
Parameters
- eventHandler: GmEventHandler
Returns void
- Defined in src/marketplace/services/GmOrderbookService.ts:166

removeOrderFromCache

removeOrderFromCache(order): boolean
Parameters
- order: Order
Returns boolean
- Defined in src/marketplace/services/GmOrderbookService.ts:191

`Protected` resetEventService

resetEventService(): Promise<void>
Returns Promise<void>
- Defined in src/marketplace/services/GmOrderbookService.ts:108

`Protected` resetOrdersData

resetOrdersData(): Promise<void>
Returns Promise<void>
- Defined in src/marketplace/services/GmOrderbookService.ts:96

updateOrderInCache

updateOrderInCache(order): Order
Parameters
- order: Order
Returns Order
- Defined in src/marketplace/services/GmOrderbookService.ts:195

Class GmOrderbookService

Param: rpcUrl

Param: programId

Param: commitment

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GmOrderbookService

Properties

Protected changeObserverDisposer

Protected connection

Protected eventCallBacks

Protected gmClientService

Protected gmEventService

Protected healthcheckThreshold

Protected healthcheckTimer

Protected isReloading

Protected lastEventTimestamp

Protected marketplaceProgramId

Protected orderCacheService

Static Private HEALTH_CHECK_RATE

Methods

addOnEventHandler

Parameters

Returns void

addOrderToCache

Parameters

Returns Order

end

Returns Promise<boolean>

Protected filterOrdersByCurrency

Parameters

Returns Order[]

getAllMints

Returns string[]

getAllOrdersByItemMint

Parameters

Returns Map<string, Order>

getAllOrdersForUserAddress

Parameters

Returns Order[]

getBuyOrders

Returns Map<string, Map<string, Order>>

getBuyOrdersByCurrencyAndItem

Parameters

Returns Order[]

getBuyOrdersForMint

Parameters

Returns Map<string, Order>

Protected getIsServiceHealthy

Returns boolean

Protected getNow

Returns number

getOrderById

Parameters

Returns Order

getOrdersByType

Parameters

Returns Map<string, Map<string, Order>>

getSellOrders

Returns Map<string, Map<string, Order>>

getSellOrdersByCurrencyAndItem

Parameters

Returns Order[]

getSellOrdersForMint

Parameters

Returns Map<string, Order>

Protected handleMarketplaceEvent

Parameters

Returns void

Protected handleOrderAddedEvent

Parameters

Returns void

Protected handleOrderCanceledEvent

Parameters

Returns void

`Protected` changeObserverDisposer

`Protected` connection

`Protected` eventCallBacks

`Protected` gmClientService

`Protected` gmEventService

`Protected` healthcheckThreshold

`Protected` healthcheckTimer

`Protected` isReloading

`Protected` lastEventTimestamp

`Protected` marketplaceProgramId

`Protected` orderCacheService

`Static` `Private` HEALTH_CHECK_RATE

`Protected` filterOrdersByCurrency

`Protected` getIsServiceHealthy

`Protected` getNow

`Protected` handleMarketplaceEvent

`Protected` handleOrderAddedEvent

`Protected` handleOrderCanceledEvent

`Protected` handleOrderModifiedEvent

`Protected` refetchOrderData

`Protected` resetEventService

`Protected` resetOrdersData