Class OrdersAPI

Represents a class for handling Orderbook (OB) related operations.

Hierarchy

BaseAPI
- OrdersAPI

Constructors

constructor

new OrdersAPI(premia): OrdersAPI
Construct a new BaseAPI object.
Parameters
- premia: Premia
  
  An instance of the Premia SDK.
Returns OrdersAPI
Inherited from BaseAPI.constructor
- Defined in src/api/baseAPI.ts:25

Properties

`Readonly` premia

premia: Premia

The Premia SDK instance.

`Protected` streamIndex

streamIndex: number = 0

The current index of quote streams. Used to cancel stale streams.

Methods

`Private` bestQuote

bestQuote(quotes, size, minimumSize?, taker?, provider?): Promise<null | OrderbookQuote>
Private
Selects the best quote from a list of quotes based on a pricing strategy.
Parameters
- quotes: OrderbookQuote[]
  
  An array of quotes.
- size: BigNumberish
  
  The size of the trade.
- Optional minimumSize: BigNumberish
  
  The minimum size of the trade (optional).
- Optional taker: string
  
  The address of the taker (optional).
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns Promise<null | OrderbookQuote>
- A promise resolving to the best quote from the array of quotes, or null if no valid quote is found.
- Defined in src/api/ordersAPI.ts:50

calculateQuoteHash

calculateQuoteHash(quote, poolAddress): string
Calculates the hash of a quote.

Method
calculateQuoteHash
Parameters
- quote: QuoteT
  
  The quote to hash.
- poolAddress: string
  
  The address of the pool.
Returns string
The calculated hash of the quote.
- Defined in src/api/ordersAPI.ts:720

cancelAllStreams

cancelAllStreams(): Promise<void>
Cancels all active quotes streams.

Returns Promise<void>
Overrides BaseAPI.cancelAllStreams
- Defined in src/api/ordersAPI.ts:432

cancelQuoteStream

cancelQuoteStream(): void
Cancels the quotes stream for orderbook quotes.

Returns void
- Defined in src/api/ordersAPI.ts:423

isQuoteValid

isQuoteValid(quote, size?, taker?, throwError?, provider?): Promise<boolean>
Checks whether a quote is valid. Can optionally throw an error if the quote is invalid.
Parameters
- quote: OrderbookQuote
  
  The quote to check.
- Optional size: BigNumberish
  
  The size of the trade (optional).
- Optional taker: string
  
  The address of the taker (optional).
- Optional throwError: boolean = false
  
  Whether to throw an error if the quote is invalid (default is false).
- Optional provider: Provider
  
  The custom provider to use for this call (optional).
Returns Promise<boolean>
- A promise that resolves to a boolean indicating whether the quote is valid.
- Defined in src/api/ordersAPI.ts:200

publishQuote

publishQuote(quote, provider?): Promise<null | TransactionReceipt>
Publishes a quote.
Parameters
- quote: QuoteWithSignatureT
  
  The quote to publish.
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns Promise<null | TransactionReceipt>
A promise that resolves to the transaction receipt or null if failed.
- Defined in src/api/ordersAPI.ts:540

publishQuoteWithApiKey

publishQuoteWithApiKey(quote): Promise<OrderbookQuote[]>
Publishes a quote using an API key.
Parameters
- quote: QuoteWithSignatureT
  
  The quote to publish.
Returns Promise<OrderbookQuote[]>
- A promise that resolves to the published quote.
- Defined in src/api/ordersAPI.ts:445

publishQuotes

publishQuotes(quotes, provider?): Promise<null | TransactionReceipt>
Publishes a list of quotes.
Parameters
- quotes: QuoteWithSignatureT[]
  
  The list of quotes to publish.
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns Promise<null | TransactionReceipt>
A promise that resolves to the transaction receipt or null if failed.
- Defined in src/api/ordersAPI.ts:554

publishQuotesWithApiKey

publishQuotesWithApiKey(quotes): Promise<OrderbookQuote[]>
Publishes a list of quotes with an API key.
Parameters
- quotes: QuoteWithSignatureT[]
  
  The list of quotes to publish.
Returns Promise<OrderbookQuote[]>
A promise that resolves to the list of returned OB quotes.
- Defined in src/api/ordersAPI.ts:457

publishUnsignedQuote

publishUnsignedQuote(poolAddress, quote, provider?): Promise<null | TransactionReceipt>
Publishes an unsigned quote.
Parameters
- poolAddress: string
  
  The address of the pool.
- quote: QuoteSaltOptionalT
  
  The unsigned quote to publish.
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns Promise<null | TransactionReceipt>
A promise that resolves to the transaction receipt or null if failed.
- Defined in src/api/ordersAPI.ts:506

publishUnsignedQuoteWithApiKey

publishUnsignedQuoteWithApiKey(poolAddress, quote): Promise<OrderbookQuote[]>
Publishes an unsigned quote with an API key.
Parameters
- poolAddress: string
  
  The address of the pool.
- quote: QuoteSaltOptionalT
  
  The unsigned quote to publish.
Returns Promise<OrderbookQuote[]>
A promise that resolves to the list of returned OB quotes.
- Defined in src/api/ordersAPI.ts:472

publishUnsignedQuotes

publishUnsignedQuotes(poolAddress, quotes, provider?): Promise<null | TransactionReceipt>
Publishes a list of unsigned quotes.
Parameters
- poolAddress: string
  
  The address of the pool.
- quotes: QuoteSaltOptionalT[]
  
  The list of unsigned quotes to publish.
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns Promise<null | TransactionReceipt>
A promise that resolves to the transaction receipt or null if failed.
- Defined in src/api/ordersAPI.ts:522

publishUnsignedQuotesWithApiKey

publishUnsignedQuotesWithApiKey(poolAddress, quotes): Promise<OrderbookQuote[]>
Publishes a list of unsigned quotes with an API key.
Parameters
- poolAddress: string
  
  The address of the pool.
- quotes: QuoteSaltOptionalT[]
  
  The list of unsigned quotes to publish.
Returns Promise<OrderbookQuote[]>
A promise that resolves to the list of returned OB quotes.
- Defined in src/api/ordersAPI.ts:486

quote

quote(poolAddress, size, isBuy, minimumSize?, referrer?, taker?, provider?, pool?): Promise<null | FillableQuote>
Fetches the best quote for a specified pool address and trade size.
Parameters
- poolAddress: string
  
  The address of the pool.
- size: BigNumberish
  
  The size of the trade.
- isBuy: boolean
  
  Whether it's a buy or a sell.
- Optional minimumSize: BigNumberish
  
  The minimum size of the trade (optional).
- Optional referrer: string
  
  The address of the referrer (optional).
- Optional taker: string
  
  The address of the taker (optional).
- Optional provider: Provider
  
  The custom provider to use for this call (optional).
- Optional pool: PoolMinimal
  
  The pool to stream quotes from, passed for optimization purposes (optional).
Returns Promise<null | FillableQuote>
- The best fillable quote, or null if no quotes available.
- Defined in src/api/ordersAPI.ts:240

signQuote

signQuote(poolAddress, quote): Promise<QuoteWithSignature>
Signs a quote.
Parameters
- poolAddress: string
  
  The address of the pool.
- quote: QuoteSaltOptionalT
  
  The quote to be signed.
Returns Promise<QuoteWithSignature>
A promise that resolves to the signed quote.
- Defined in src/api/ordersAPI.ts:571

streamQuotes

streamQuotes(options, callback): Promise<void>
Streams quotes for the given options and executes a callback for the best quote.
Parameters
- options: {
      forceSendRFQ?: boolean;
      isBuy: boolean;
      minimumSize?: BigNumberish;
      pool?: PoolMinimal;
      poolAddress: string;
      poolKey?: PoolKey;
      provider?: Provider;
      referrer?: string;
      size: BigNumberish;
      taker?: string;
  }
  
  The options for the quotes stream:
  - Optional forceSendRFQ?: boolean
    
    Whether to force sending/listening for Request-for-Quotes (optional).
  - isBuy: boolean
    
    Whether it's a buy or a sell.
  - Optional minimumSize?: BigNumberish
    
    The minimum size of the trade (optional).
  - Optional pool?: PoolMinimal
    
    The pool to stream quotes from, passed for optimization purposes (optional).
  - poolAddress: string
    
    The address of the pool.
  - Optional poolKey?: PoolKey
    
    The pool key to stream quotes from, passed for optimization purposes (optional).
  - Optional provider?: Provider
    
    The custom provider to use for this call (optional).
  - Optional referrer?: string
    
    The address of the referrer (optional).
  - size: BigNumberish
    
    The size of the trade.
  - Optional taker?: string
    
    The address of the taker (optional).
- callback: ((quote) => void)
  
  The callback to execute for the best quote.
  - - (quote): void
    - Parameters
      
      quote: null | FillableQuote
      
      Returns void
Returns Promise<void>
- Defined in src/api/ordersAPI.ts:301

`Private` tradeQuoteToFillable

tradeQuoteToFillable(poolAddress, size, quote, createdAt?, referrer?, provider?, pool?): Promise<FillableQuote>
Private
Converts a quote into a fillable quote, with additional properties required for execution.
Parameters
- poolAddress: string
  
  The address of the pool.
- size: BigNumberish
  
  The size of the trade.
- quote: OrderbookQuote
  
  The orderbook quote to be converted.
- Optional createdAt: number
  
  The timestamp of the quote's creation (optional).
- Optional referrer: string
  
  The address of the referrer (optional).
- Optional provider: Provider
  
  The custom provider to use for this call.
- Optional pool: PoolMinimal
Returns Promise<FillableQuote>
- A promise resolving to the fillable quote.
- Defined in src/api/ordersAPI.ts:109

`Static` calculateQuoteHash

calculateQuoteHash(quote, poolAddress, chainId): string
Calculates the hash of a quote. This is a static method.
Parameters
- quote: QuoteT
  
  The quote to hash.
- poolAddress: string
  
  The address of the pool.
- chainId: number
  
  The id of the chain.
Returns string
The calculated hash of the quote.
- Defined in src/api/ordersAPI.ts:640

Class OrdersAPI

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

premia: Premia

Returns OrdersAPI

Properties

Readonly premia

Protected streamIndex

Methods

Private bestQuote

Parameters

quotes: OrderbookQuote[]

size: BigNumberish

Optional minimumSize: BigNumberish

Optional taker: string

Optional provider: Provider

Returns Promise<null | OrderbookQuote>

calculateQuoteHash

Method

Parameters

quote: QuoteT

poolAddress: string

Returns string

cancelAllStreams

Returns Promise<void>

cancelQuoteStream

Returns void

isQuoteValid

Parameters

quote: OrderbookQuote

Optional size: BigNumberish

Optional taker: string

Optional throwError: boolean = false

Optional provider: Provider

Returns Promise<boolean>

publishQuote

Parameters

quote: QuoteWithSignatureT

Optional provider: Provider

Returns Promise<null | TransactionReceipt>

publishQuoteWithApiKey

Parameters

quote: QuoteWithSignatureT

Returns Promise<OrderbookQuote[]>

publishQuotes

Parameters

quotes: QuoteWithSignatureT[]

Optional provider: Provider

Returns Promise<null | TransactionReceipt>

publishQuotesWithApiKey

Parameters

quotes: QuoteWithSignatureT[]

Returns Promise<OrderbookQuote[]>

publishUnsignedQuote

Parameters

poolAddress: string

quote: QuoteSaltOptionalT

Optional provider: Provider

Returns Promise<null | TransactionReceipt>

publishUnsignedQuoteWithApiKey

Parameters

poolAddress: string

quote: QuoteSaltOptionalT

Returns Promise<OrderbookQuote[]>

publishUnsignedQuotes

Parameters

poolAddress: string

quotes: QuoteSaltOptionalT[]

Optional provider: Provider

Returns Promise<null | TransactionReceipt>

publishUnsignedQuotesWithApiKey

Parameters

poolAddress: string

quotes: QuoteSaltOptionalT[]

`Readonly` premia

`Protected` streamIndex

`Private` bestQuote

`Optional` minimumSize: BigNumberish

`Optional` taker: string

`Optional` provider: Provider

`Optional` size: BigNumberish

`Optional` taker: string

`Optional` throwError: boolean = false

`Optional` provider: Provider

`Optional` provider: Provider

`Optional` provider: Provider

`Optional` provider: Provider

`Optional` provider: Provider

`Optional` minimumSize: BigNumberish

`Optional` referrer: string

`Optional` taker: string

`Optional` provider: Provider

`Optional` pool: PoolMinimal

options: {
forceSendRFQ?: boolean;
isBuy: boolean;
minimumSize?: BigNumberish;
pool?: PoolMinimal;
poolAddress: string;
poolKey?: PoolKey;
provider?: Provider;
referrer?: string;
size: BigNumberish;
taker?: string;
}

`Optional` forceSendRFQ?: boolean

`Optional` minimumSize?: BigNumberish

`Optional` pool?: PoolMinimal

`Optional` poolKey?: PoolKey

`Optional` provider?: Provider

`Optional` referrer?: string

`Optional` taker?: string

`Private` tradeQuoteToFillable

`Optional` createdAt: number

`Optional` referrer: string

`Optional` provider: Provider

`Optional` pool: PoolMinimal

`Static` calculateQuoteHash