Class EngineQueryClient

Base client for all engine requests

Hierarchy (View Summary)

EngineBaseClient
- EngineQueryClient

Constructors

constructor

new EngineQueryClient(opts: EngineClientOpts): EngineQueryClient
Parameters
- opts: EngineClientOpts
Returns EngineQueryClient
Inherited from EngineBaseClient.constructor
- Defined in EngineBaseClient.ts:48

Properties

`Readonly`opts

opts: EngineClientOpts

`Readonly`axiosInstance

axiosInstance: AxiosInstance

Methods

setLinkedSigner

setLinkedSigner(linkedSignerWalletClient: {} | null): void
Sets the linked signer for execute requests
Parameters
- linkedSignerWalletClient: {} | null
  The linkedSigner to use for all signatures. Set to null to revert to the chain signer
Returns void
Inherited from EngineBaseClient.setLinkedSigner
- Defined in EngineBaseClient.ts:62

getTxNonce

getTxNonce(address?: string): Promise<string>
Parameters
- Optionaladdress: string
Returns Promise<string>
Inherited from EngineBaseClient.getTxNonce
- Defined in EngineBaseClient.ts:68

execute

execute<TRequestType extends keyof EngineServerExecuteRequestByType>(
requestType: TRequestType,
params: EngineServerExecuteRequestByType[TRequestType],
): Promise<EngineServerExecuteSuccessResult<TRequestType>>
POSTs an execute message to the engine and returns the successful response. Throws the failure response wrapped in an EngineServerFailureError on failure.
Type Parameters
- TRequestType extends keyof EngineServerExecuteRequestByType
Parameters
- requestType: TRequestType
- params: EngineServerExecuteRequestByType[TRequestType]
Returns Promise<EngineServerExecuteSuccessResult<TRequestType>>
Inherited from EngineBaseClient.execute
- Defined in EngineBaseClient.ts:145

getExecuteRequest

getExecuteRequest<TRequestType extends keyof EngineServerExecuteRequestByType>(
requestType: TRequestType,
params: EngineServerExecuteRequestByType[TRequestType],
): EngineExecuteRequestBody
A simple, typechecked fn for constructing an execute request in the format expected by the server.
Type Parameters
- TRequestType extends keyof EngineServerExecuteRequestByType
Parameters
- requestType: TRequestType
- params: EngineServerExecuteRequestByType[TRequestType]
Returns EngineExecuteRequestBody
Inherited from EngineBaseClient.getExecuteRequest
- Defined in EngineBaseClient.ts:167

sign

sign<T extends keyof SignableRequestTypeToParams>(
    requestType: T,
    verifyingContract: string,
    chainId: number,
    params: SignableRequestTypeToParams[T],
): Promise<`0x${string}`>
Signs a given request with the signer provided to the engine
Type Parameters
- T extends keyof SignableRequestTypeToParams
Parameters
- requestType: T
- verifyingContract: string
- chainId: number
- params: SignableRequestTypeToParams[T]
Returns Promise<`0x${string}`>
Inherited from EngineBaseClient.sign
- Defined in EngineBaseClient.ts:185

getContracts

getContracts(): Promise<GetEngineContractsResponse>
Retrieves the set of contracts that the engine is interfacing with

Returns Promise<GetEngineContractsResponse>
- Defined in EngineQueryClient.ts:78

getStatus

getStatus(): Promise<
    | "started"
    | "active"
    | "stopping"
    | "syncing"
    | "live_syncing"
    | "failed",
>
Retrieves current engine status

Returns Promise<
    | "started"
    | "active"
    | "stopping"
    | "syncing"
    | "live_syncing"
    | "failed",
>
- Defined in EngineQueryClient.ts:89

getSubaccountSummary

getSubaccountSummary(
params: Subaccount,
): Promise<GetEngineSubaccountSummaryResponse>
Retrieves a subaccount summary reflective of the state within the offchain engine. This adheres to the same return interface as the contract version
Parameters
- params: Subaccount
Returns Promise<GetEngineSubaccountSummaryResponse>
- Defined in EngineQueryClient.ts:99

getIsolatedPositions

getIsolatedPositions(
params: Subaccount,
): Promise<GetEngineIsolatedPositionsResponse>
Retrieves a list of isolated positions
Parameters
- params: Subaccount
Returns Promise<GetEngineIsolatedPositionsResponse>
- Defined in EngineQueryClient.ts:118

getEstimatedSubaccountSummary

getEstimatedSubaccountSummary(
params: GetEngineEstimatedSubaccountSummaryParams,
): Promise<GetEngineSubaccountSummaryResponse>
Retrieves an estimated subaccount summary with the applied transactions
Parameters
- params: GetEngineEstimatedSubaccountSummaryParams
Returns Promise<GetEngineSubaccountSummaryResponse>
- Defined in EngineQueryClient.ts:137

getSymbols

getSymbols(params: GetEngineSymbolsParams): Promise<EngineSymbolsResponse>
Retrieves symbols and product info
Parameters
- params: GetEngineSymbolsParams
Returns Promise<EngineSymbolsResponse>
- Defined in EngineQueryClient.ts:182

getAllMarkets

getAllMarkets(): Promise<GetEngineAllMarketsResponse>
Retrieves all market states as per the offchain engine. Same return interface as contracts

Returns Promise<GetEngineAllMarketsResponse>
- Defined in EngineQueryClient.ts:198

getEdgeAllMarkets

getEdgeAllMarkets(): Promise<Record<number, MarketWithProduct[]>>
Retrieves all markets by chain id.

Returns Promise<Record<number, MarketWithProduct[]>>
- Defined in EngineQueryClient.ts:215

getHealthGroups

getHealthGroups(): Promise<GetEngineHealthGroupsResponse>
Retrieves all health groups (linked spot & perp products) from the engine

Returns Promise<GetEngineHealthGroupsResponse>
- Defined in EngineQueryClient.ts:236

getOrder

getOrder(params: GetEngineOrderParams): Promise<EngineOrder>
Retrieves an order from the offchain engine
Parameters
- params: GetEngineOrderParams
Returns Promise<EngineOrder>
- Defined in EngineQueryClient.ts:256

validateOrderParams

validateOrderParams(
params: ValidateEngineOrderParams,
): Promise<ValidateEngineOrderResponse>
Signs and validates with the engine that the order is valid to be submitted (i.e. does not violate health reqs)
Parameters
- params: ValidateEngineOrderParams
Returns Promise<ValidateEngineOrderResponse>
- Defined in EngineQueryClient.ts:272

validateSignedOrderParams

validateSignedOrderParams(
params: ValidateSignedEngineOrderParams,
): Promise<ValidateEngineOrderResponse>
Validates an existing signed order with the engine as a pre-check for health
Parameters
- params: ValidateSignedEngineOrderParams
Returns Promise<ValidateEngineOrderResponse>
- Defined in EngineQueryClient.ts:295

getSubaccountOrders

getSubaccountOrders(
params: GetEngineSubaccountOrdersParams,
): Promise<EngineSubaccountOrders>
Get all subaccount orders from the engine, per product ID
Parameters
- params: GetEngineSubaccountOrdersParams
Returns Promise<EngineSubaccountOrders>
- Defined in EngineQueryClient.ts:313

getSubaccountMultiProductOrders

getSubaccountMultiProductOrders(
params: GetEngineSubaccountProductOrdersParams,
): Promise<GetEngineSubaccountProductOrdersResponse>
Get all subaccount orders from the engine, for multiple products
Parameters
- params: GetEngineSubaccountProductOrdersParams
Returns Promise<GetEngineSubaccountProductOrdersResponse>
- Defined in EngineQueryClient.ts:334

getSubaccountFeeRates

getSubaccountFeeRates(
params: Subaccount,
): Promise<GetEngineSubaccountFeeRatesResponse>
Gets maker & taker fee rates for order fees
Parameters
- params: Subaccount
Returns Promise<GetEngineSubaccountFeeRatesResponse>
- Defined in EngineQueryClient.ts:359

getMarketLiquidity

getMarketLiquidity(
params: GetEngineMarketLiquidityParams,
): Promise<GetEngineMarketLiquidityResponse>
Gets "price ticks" for a given market, useful for constructing liquidity levels at each price
Parameters
- params: GetEngineMarketLiquidityParams
Returns Promise<GetEngineMarketLiquidityResponse>
- Defined in EngineQueryClient.ts:402

getMarketPrice

getMarketPrice(params: GetEngineMarketPriceParams): Promise<EngineMarketPrice>
Retrieves the latest price for a given market
Parameters
- params: GetEngineMarketPriceParams
Returns Promise<EngineMarketPrice>
- Defined in EngineQueryClient.ts:419

getMarketPrices

getMarketPrices(
params: GetEngineMarketPricesParams,
): Promise<GetEngineMarketPricesResponse>
Retrieves the latest prices for provided markets
Parameters
- params: GetEngineMarketPricesParams
Returns Promise<GetEngineMarketPricesResponse>
- Defined in EngineQueryClient.ts:432

getMaxOrderSize

getMaxOrderSize(params: GetEngineMaxOrderSizeParams): Promise<BigNumber>
Retrieves the estimated max order size for a product
Parameters
- params: GetEngineMaxOrderSizeParams
Returns Promise<BigNumber>
- Defined in EngineQueryClient.ts:447

getMaxWithdrawable

getMaxWithdrawable(params: GetEngineMaxWithdrawableParams): Promise<BigNumber>
Retrieves the estimated max withdrawal size for a product
Parameters
- params: GetEngineMaxWithdrawableParams
Returns Promise<BigNumber>
- Defined in EngineQueryClient.ts:477

getMaxMintNlpAmount

getMaxMintNlpAmount(params: GetEngineMaxMintNlpAmountParams): Promise<BigNumber>
Retrieves the estimated max quote amount for minting NLP.
Parameters
- params: GetEngineMaxMintNlpAmountParams
Returns Promise<BigNumber>
- Defined in EngineQueryClient.ts:498

getMaxBurnNlpAmount

getMaxBurnNlpAmount(params: Subaccount): Promise<BigNumber>
Retrieves the max amount of NLP that can be burned.
Parameters
- params: Subaccount
Returns Promise<BigNumber>
- Defined in EngineQueryClient.ts:518

getLinkedSigner

getLinkedSigner(params: Subaccount): Promise<GetEngineLinkedSignerResponse>
Gets the currently linked signer for the subaccount
Parameters
- params: Subaccount
Returns Promise<GetEngineLinkedSignerResponse>
- Defined in EngineQueryClient.ts:536

getInsurance

getInsurance(): Promise<BigNumber>
Gets the insurance funds in USDT.

Returns Promise<BigNumber>
- Defined in EngineQueryClient.ts:555

getNlpLockedBalances

getNlpLockedBalances(
params: Subaccount,
): Promise<GetEngineNlpLockedBalancesResponse>
Retrieves the NLP locked and unlocked balances for a subaccount.
Parameters
- params: Subaccount
Returns Promise<GetEngineNlpLockedBalancesResponse>
- Defined in EngineQueryClient.ts:566

getNlpPoolInfo

getNlpPoolInfo(): Promise<GetEngineNlpPoolInfoResponse>
Retrieves information about all NLP sub-pools

Returns Promise<GetEngineNlpPoolInfoResponse>
- Defined in EngineQueryClient.ts:582

Class EngineQueryClient

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns EngineQueryClient

Properties

Readonlyopts

ReadonlyaxiosInstance

Methods

setLinkedSigner

Parameters

Returns void

getTxNonce

Parameters

Returns Promise<string>

getNonces

Parameters

Returns Promise<GetEngineNoncesResponse>

query

Type Parameters

Parameters

Returns Promise<EngineServerQueryResponseByType[TRequestType]>

getQueryRequest

Type Parameters

Parameters

Returns EngineServerQueryRequest<TRequestType>

execute

Type Parameters

Parameters

Returns Promise<EngineServerExecuteSuccessResult<TRequestType>>

getExecuteRequest

Type Parameters

Parameters

Returns EngineExecuteRequestBody

sign

Type Parameters

Parameters

Returns Promise<`0x${string}`>

getContracts

Returns Promise<GetEngineContractsResponse>

getStatus

Returns Promise< | "started" | "active" | "stopping" | "syncing" | "live_syncing" | "failed",>

getSubaccountSummary

Parameters

Returns Promise<GetEngineSubaccountSummaryResponse>

getIsolatedPositions

Parameters

Returns Promise<GetEngineIsolatedPositionsResponse>

getEstimatedSubaccountSummary

Parameters

Returns Promise<GetEngineSubaccountSummaryResponse>

getSymbols

Parameters

Returns Promise<EngineSymbolsResponse>

getAllMarkets

Returns Promise<GetEngineAllMarketsResponse>

getEdgeAllMarkets

Returns Promise<Record<number, MarketWithProduct[]>>

getHealthGroups

Returns Promise<GetEngineHealthGroupsResponse>

getOrder

Parameters

Returns Promise<EngineOrder>

validateOrderParams

Parameters

Returns Promise<ValidateEngineOrderResponse>

validateSignedOrderParams

Parameters

Returns Promise<ValidateEngineOrderResponse>

getSubaccountOrders

Parameters

Returns Promise<EngineSubaccountOrders>

getSubaccountMultiProductOrders

Parameters

Returns Promise<GetEngineSubaccountProductOrdersResponse>

`Readonly`opts

`Readonly`axiosInstance

Returns Promise<
| "started"
| "active"
| "stopping"
| "syncing"
| "live_syncing"
| "failed",
>