Class OrderbookV1

Hierarchy

OrderbookV1

Index

Constructors

constructor

new OrderbookV1(baseUri, wsUri, apiKey, chainId): OrderbookV1
Parameters
- baseUri: string
- wsUri: string
- apiKey: string
- chainId: number
Returns OrderbookV1
- Defined in src/services/orderbookV1/index.ts:51

Properties

apiKey

apiKey: string

The API key to use for fetching data from the Premia API.

See

https://docs.premia.finance/api/authentication

chainId

chainId: number

This is the chain id of where orders will SETTLE (ie Arbitrum or Arbitrum Goerli)

uri

uri: string

The base URI to use for fetching data from the Premia API.

See

https://docs.premia.finance/api

`Private` `Optional` ws

ws?: WebSocket

wsUri

wsUri: string

The base websocket URI to use for streaming data from the Premia API.

See

https://docs.premia.finance/api

Methods

connect

connect(callback?): Promise<unknown>
Parameters
- Optional callback: ((data) => void)
  - - (data): void
    - Parameters
      
      data: WSInfoMessage | WSErrorMessage
      
      Returns void
Returns Promise<unknown>
- Defined in src/services/orderbookV1/index.ts:201

connectIfNotConnected

connectIfNotConnected(callback?): Promise<undefined | boolean>
Parameters
- Optional callback: ((data) => void)
  - - (data): void
    - Parameters
      
      data: WSInfoMessage | WSErrorMessage
      
      Returns void
Returns Promise<undefined | boolean>
- Defined in src/services/orderbookV1/index.ts:268

disconnect

disconnect(): void
Returns void
- Defined in src/services/orderbookV1/index.ts:290

getOrders

getOrders(poolAddress?, size?, side?, provider?, chainId?): Promise<OrderbookQuote[]>
Parameters
- Optional poolAddress: string
- Optional size: string
- Optional side: "bid" | "ask"
- Optional provider: string
- chainId: string = ...
Returns Promise<OrderbookQuote[]>
- Defined in src/services/orderbookV1/index.ts:142

getQuotes

getQuotes(poolAddress, size, side, provider?, taker?, chainId?): Promise<OrderbookQuote[]>
Parameters
- poolAddress: string
- size: string
- side: "bid" | "ask"
- Optional provider: string
- Optional taker: string
- chainId: string = ...
Returns Promise<OrderbookQuote[]>
- Defined in src/services/orderbookV1/index.ts:108

getRequest

getRequest(_url): Promise<any>
Parameters
- _url: string
Returns Promise<any>
- Defined in src/services/orderbookV1/index.ts:159

getRfqQuotes

getRfqQuotes(poolAddress, side, taker, chainId?): Promise<OrderbookQuote[]>
Parameters
- poolAddress: string
- side: "bid" | "ask"
- taker: string
- chainId: string = ...
Returns Promise<OrderbookQuote[]>
- Defined in src/services/orderbookV1/index.ts:127

isConnected

isConnected(): boolean
Returns boolean
- Defined in src/services/orderbookV1/index.ts:282

isDisconnected

isDisconnected(): boolean
Returns boolean
- Defined in src/services/orderbookV1/index.ts:286

publishQuotes

publishQuotes(quotes): Promise<OrderbookQuote[]>
Parameters
- quotes: QuoteWithSignatureT[]
Returns Promise<OrderbookQuote[]>
- Defined in src/services/orderbookV1/index.ts:183

publishRFQ

publishRFQ(message, callback?): Promise<void>
Parameters
- message: WSRFQRequest
- Optional callback: ((data) => void)
  - - (data): void
    - Parameters
      
      data: WSInfoMessage | WSErrorMessage
      
      Returns void
Returns Promise<void>
- Defined in src/services/orderbookV1/index.ts:332

serializeQuote

serializeQuote(quote): SerializedQuoteSaltOptional
Parameters
- quote: QuoteSaltOptionalT
Returns SerializedQuoteSaltOptional
- Defined in src/services/orderbookV1/index.ts:88

serializeQuotesWithSignature

serializeQuotesWithSignature(quotes): QuoteWithSignatureT[]
Parameters
- quotes: QuoteWithSignatureT[]
Returns QuoteWithSignatureT[]
- Defined in src/services/orderbookV1/index.ts:58

subscribe

subscribe(message, callback): Promise<void>
Parameters
- message: WSFilterMessage
- callback: ((data) => void)
  - - (data): void
    - Parameters
      
      data: WSRFQMessage | WSPostQuoteMessage | WSDeleteQuoteMessage | WSInfoMessage | WSErrorMessage
      
      Returns void
Returns Promise<void>
- Defined in src/services/orderbookV1/index.ts:296

unsubscribe

unsubscribe(channel, callback?): void
Parameters
- channel: ChannelType
- Optional callback: ((data) => void)
  - - (data): void
    - Parameters
      
      data: WSInfoMessage | WSErrorMessage
      
      Returns void
Returns void
- Defined in src/services/orderbookV1/index.ts:313

waitForConnection

waitForConnection(timeout?): Promise<unknown>
Waits for the websocket to connect
Parameters
- timeout: number = 10000
  
  timeout in milliseconds (default 10 seconds)
Returns Promise<unknown>
a promise that resolves to true if connected, false if not connected
- Defined in src/services/orderbookV1/index.ts:246

Generated using TypeDoc