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:58

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:289

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:356

disconnect

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

getAvailableLiquidity

getAvailableLiquidity(requestParams): Promise<GroupByMaturityResponse[] | GroupByStrikeResponse[]>
Parameters
- requestParams: GroupByMaturityRequest | GroupByStrikeRequest
Returns Promise<GroupByMaturityResponse[] | GroupByStrikeResponse[]>
- Defined in src/services/orderbookV1/index.ts:223

getOrders

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

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:115

getRequest

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

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:134

isConnected

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

isDisconnected

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

publishQuotes

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

publishRFQ

publishRFQ(messageBody, callback?): Promise<void>
Parameters
- messageBody: {
      chainId: string;
      poolKey: PoolKey;
      side: "bid" | "ask";
      size: string;
      taker: string;
  }
  - chainId: string
  - poolKey: PoolKey
  - side: "bid" | "ask"
  - size: string
  - taker: string
- Optional callback: ((data) => void)
  - - (data): void
    - Parameters
      
      data: WSInfoMessage | WSErrorMessage
      
      Returns void
Returns Promise<void>
- Defined in src/services/orderbookV1/index.ts:420

serializeQuote

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

serializeQuotesWithSignature

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

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:384

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:401

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:334

Class OrderbookV1

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

baseUri: string

wsUri: string

apiKey: string

chainId: number

Returns OrderbookV1

Properties

apiKey

See

chainId

uri

See

Private Optional ws

wsUri

See

Methods

connect

Parameters

Optional callback: ((data) => void)

Parameters

data: WSInfoMessage | WSErrorMessage

Returns void

Returns Promise<unknown>

connectIfNotConnected

Parameters

Optional callback: ((data) => void)

Parameters

data: WSInfoMessage | WSErrorMessage

Returns void

Returns Promise<undefined | boolean>

disconnect

Returns void

getAvailableLiquidity

Parameters

requestParams: GroupByMaturityRequest | GroupByStrikeRequest

Returns Promise<GroupByMaturityResponse[] | GroupByStrikeResponse[]>

getOrders

Parameters

Optional poolAddress: string

Optional size: string

Optional side: "bid" | "ask"

Optional provider: string

chainId: string = ...

Returns Promise<GetOrdersResponse>

getQuotes

Parameters

poolAddress: string

size: string

side: "bid" | "ask"

Optional provider: string

Optional taker: string

chainId: string = ...

Returns Promise<OrderbookQuote[]>

getRequest

Parameters

_url: string

Returns Promise<any>

getRfqQuotes

Parameters

poolAddress: string

side: "bid" | "ask"

taker: string

chainId: string = ...

Returns Promise<OrderbookQuote[]>

isConnected

Returns boolean

isDisconnected

Returns boolean

publishQuotes

Parameters

quotes: QuoteWithSignatureT[]

Returns Promise<PublishQuoteResponse>

`Private` `Optional` ws

`Optional` callback: ((data) => void)

`Optional` callback: ((data) => void)

`Optional` poolAddress: string

`Optional` size: string

`Optional` side: "bid" | "ask"

`Optional` provider: string

`Optional` provider: string

`Optional` taker: string

messageBody: {
chainId: string;
poolKey: PoolKey;
side: "bid" | "ask";
size: string;
taker: string;
}

`Optional` callback: ((data) => void)

`Optional` callback: ((data) => void)