@nadohq/engine-client 0.15.0 → 0.17.0

package/dist/EngineQueryClient-DQwCRaYl.d.ts

@@ -0,0 +1,147 @@
+import { q as EngineServerStatusResponse } from "./serverQueryTypes-B3vC8vxT.js";
+import { A as GetEngineMaxOrderSizeParams, B as GetEngineOrderResponse, C as GetEngineMarketPriceResponse, D as GetEngineMaxBurnNlpAmountResponse, E as GetEngineMaxBurnNlpAmountParams, F as GetEngineNlpLockedBalancesResponse, G as GetEngineSubaccountProductOrdersParams, H as GetEngineSubaccountFeeRatesResponse, I as GetEngineNlpPoolInfoResponse, J as GetEngineSubaccountSummaryResponse, K as GetEngineSubaccountProductOrdersResponse, M as GetEngineMaxWithdrawableParams, N as GetEngineMaxWithdrawableResponse, O as GetEngineMaxMintNlpAmountParams, P as GetEngineNlpLockedBalancesParams, S as GetEngineMarketPriceParams, T as GetEngineMarketPricesResponse, U as GetEngineSubaccountOrdersParams, V as GetEngineSubaccountFeeRatesParams, W as GetEngineSubaccountOrdersResponse, Y as GetEngineSymbolsParams, _ as GetEngineIsolatedPositionsResponse, at as ValidateSignedEngineOrderParams, b as GetEngineMarketLiquidityParams, c as EngineSymbolsResponse, f as GetEngineEstimatedSubaccountSummaryParams, g as GetEngineIsolatedPositionsParams, it as ValidateEngineOrderResponse, j as GetEngineMaxOrderSizeResponse, k as GetEngineMaxMintNlpAmountResponse, l as GetEngineAllMarketsResponse, m as GetEngineInsuranceResponse, p as GetEngineHealthGroupsResponse, q as GetEngineSubaccountSummaryParams, rt as ValidateEngineOrderParams, u as GetEngineContractsResponse, v as GetEngineLinkedSignerParams, w as GetEngineMarketPricesParams, x as GetEngineMarketLiquidityResponse, y as GetEngineLinkedSignerResponse, z as GetEngineOrderParams } from "./clientQueryTypes-DuRgEeBT.js";
+import { t as EngineBaseClient } from "./EngineBaseClient-DOOXIhnZ.js";
+import { MarketWithProduct } from "@nadohq/shared";
+
+//#region src/EngineQueryClient.d.ts
+declare class EngineQueryClient extends EngineBaseClient {
+  /**
+   * Retrieves the set of contracts that the engine is interfacing with
+   */
+  getContracts(): Promise<GetEngineContractsResponse>;
+  /**
+   * Retrieves current engine status
+   */
+  getStatus(): Promise<EngineServerStatusResponse>;
+  /**
+   * Retrieves a subaccount summary reflective of the state within the offchain engine. This adheres to the
+   * same return interface as the contract version
+   *
+   * @param params
+   */
+  getSubaccountSummary(params: GetEngineSubaccountSummaryParams): Promise<GetEngineSubaccountSummaryResponse>;
+  /**
+   * Retrieves a list of isolated positions
+   *
+   * @param params
+   */
+  getIsolatedPositions(params: GetEngineIsolatedPositionsParams): Promise<GetEngineIsolatedPositionsResponse>;
+  /**
+   * Retrieves an estimated subaccount summary with the applied transactions
+   *
+   * @param params
+   */
+  getEstimatedSubaccountSummary(params: GetEngineEstimatedSubaccountSummaryParams): Promise<GetEngineSubaccountSummaryResponse>;
+  /**
+   * Retrieves symbols and product info
+   *
+   * @param params
+   */
+  getSymbols(params: GetEngineSymbolsParams): Promise<EngineSymbolsResponse>;
+  /**
+   * Retrieves all market states as per the offchain engine. Same return interface as contracts
+   */
+  getAllMarkets(): Promise<GetEngineAllMarketsResponse>;
+  /**
+   * Retrieves all markets by chain id.
+   */
+  getEdgeAllMarkets(): Promise<Record<number, MarketWithProduct[]>>;
+  /**
+   * Retrieves all health groups (linked spot & perp products) from the engine
+   */
+  getHealthGroups(): Promise<GetEngineHealthGroupsResponse>;
+  /**
+   * Retrieves an order from the offchain engine
+   *
+   * @param params
+   */
+  getOrder(params: GetEngineOrderParams): Promise<GetEngineOrderResponse>;
+  /**
+   * Signs and validates with the engine that the order is valid to be submitted (i.e. does not violate health reqs)
+   *
+   * @param params
+   */
+  validateOrderParams(params: ValidateEngineOrderParams): Promise<ValidateEngineOrderResponse>;
+  /**
+   * Validates an existing signed order with the engine as a pre-check for health
+   *
+   * @param params
+   */
+  validateSignedOrderParams(params: ValidateSignedEngineOrderParams): Promise<ValidateEngineOrderResponse>;
+  /**
+   * Get all subaccount orders from the engine, per product ID
+   * @param params
+   */
+  getSubaccountOrders(params: GetEngineSubaccountOrdersParams): Promise<GetEngineSubaccountOrdersResponse>;
+  /**
+   * Get all subaccount orders from the engine, for multiple products
+   * @param params
+   */
+  getSubaccountMultiProductOrders(params: GetEngineSubaccountProductOrdersParams): Promise<GetEngineSubaccountProductOrdersResponse>;
+  /**
+   * Gets maker & taker fee rates for order fees
+   * @param params
+   */
+  getSubaccountFeeRates(params: GetEngineSubaccountFeeRatesParams): Promise<GetEngineSubaccountFeeRatesResponse>;
+  /**
+   * Gets "price ticks" for a given market, useful for constructing liquidity levels at each price
+   * @param params
+   */
+  getMarketLiquidity(params: GetEngineMarketLiquidityParams): Promise<GetEngineMarketLiquidityResponse>;
+  /**
+   * Retrieves the latest price for a given market
+   * @param params
+   */
+  getMarketPrice(params: GetEngineMarketPriceParams): Promise<GetEngineMarketPriceResponse>;
+  /**
+   * Retrieves the latest prices for provided markets
+   * @param params
+   */
+  getMarketPrices(params: GetEngineMarketPricesParams): Promise<GetEngineMarketPricesResponse>;
+  /**
+   * Retrieves the estimated max order size for a product
+   * @param params
+   */
+  getMaxOrderSize(params: GetEngineMaxOrderSizeParams): Promise<GetEngineMaxOrderSizeResponse>;
+  /**
+   * Retrieves the estimated max withdrawal size for a product
+   * @param params
+   */
+  getMaxWithdrawable(params: GetEngineMaxWithdrawableParams): Promise<GetEngineMaxWithdrawableResponse>;
+  /**
+   * Retrieves the estimated max quote amount for minting NLP.
+   *
+   * @param params
+   */
+  getMaxMintNlpAmount(params: GetEngineMaxMintNlpAmountParams): Promise<GetEngineMaxMintNlpAmountResponse>;
+  /**
+   * Retrieves the max amount of NLP that can be burned.
+   *
+   * @param params
+   */
+  getMaxBurnNlpAmount(params: GetEngineMaxBurnNlpAmountParams): Promise<GetEngineMaxBurnNlpAmountResponse>;
+  /**
+   * Gets the currently linked signer for the subaccount
+   * @param params
+   * @returns
+   */
+  getLinkedSigner(params: GetEngineLinkedSignerParams): Promise<GetEngineLinkedSignerResponse>;
+  /**
+   * Gets the insurance funds in USDT.
+   * @returns
+   */
+  getInsurance(): Promise<GetEngineInsuranceResponse>;
+  /**
+   * Retrieves the NLP locked and unlocked balances for a subaccount.
+   *
+   * @param params
+   */
+  getNlpLockedBalances(params: GetEngineNlpLockedBalancesParams): Promise<GetEngineNlpLockedBalancesResponse>;
+  /**
+   * Retrieves information about all NLP sub-pools
+   */
+  getNlpPoolInfo(): Promise<GetEngineNlpPoolInfoResponse>;
+}
+//#endregion
+export { EngineQueryClient as t };
+//# sourceMappingURL=EngineQueryClient-DQwCRaYl.d.ts.map

package/dist/EngineQueryClient-DQwCRaYl.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EngineQueryClient-DQwCRaYl.d.ts","names":[],"sources":["../src/src/EngineQueryClient.ts"],"mappings":";;;;;;cAyEa,iBAAA,SAA0B,gBAAA;;;;EAI/B,YAAA,CAAA,GAAgB,OAAA,CAAQ,0BAAA;EAJD;;;EAevB,SAAA,CAAA,GAAa,OAAA,CAAQ,0BAAA;EAAA;;;;;;EAUrB,oBAAA,CACJ,MAAA,EAAQ,gCAAA,GACP,OAAA,CAAQ,kCAAA;EAmBR;;;;;EAFG,oBAAA,CACJ,MAAA,EAAQ,gCAAA,GACP,OAAA,CAAQ,kCAAA;EAgER;;;;;EA/CG,6BAAA,CACJ,MAAA,EAAQ,yCAAA,GACP,OAAA,CAAQ,kCAAA;EAiGsB;;;;;EAtD3B,UAAA,CACJ,MAAA,EAAQ,sBAAA,GACP,OAAA,CAAQ,qBAAA;EA0FA;;;EA5EL,aAAA,CAAA,GAAiB,OAAA,CAAQ,2BAAA;EAmG5B;;;EAlFG,iBAAA,CAAA,GAAqB,OAAA,CAAQ,MAAA,SAAe,iBAAA;EAwHxC;;;EAnGJ,eAAA,CAAA,GAAmB,OAAA,CAAQ,6BAAA;EA6HtB;;;;;EAzGL,QAAA,CACJ,MAAA,EAAQ,oBAAA,GACP,OAAA,CAAQ,sBAAA;EAmKA;;;;;EArJL,mBAAA,CACJ,MAAA,EAAQ,yBAAA,GACP,OAAA,CAAQ,2BAAA;EA+KA;;;;;EA1JL,yBAAA,CACJ,MAAA,EAAQ,+BAAA,GACP,OAAA,CAAQ,2BAAA;EA+MA;;;;EA/LL,mBAAA,CACJ,MAAA,EAAQ,+BAAA,GACP,OAAA,CAAQ,iCAAA;EAkOD;;;;EA/MJ,+BAAA,CACJ,MAAA,EAAQ,sCAAA,GACP,OAAA,CAAQ,wCAAA;EA2OD;;;;EApNJ,qBAAA,CACJ,MAAA,EAAQ,iCAAA,GACP,OAAA,CAAQ,mCAAA;EA/R0B;;;;EAwU/B,kBAAA,CACJ,MAAA,EAAQ,8BAAA,GACP,OAAA,CAAQ,gCAAA;EAtUW;;;;EAqVhB,cAAA,CACJ,MAAA,EAAQ,0BAAA,GACP,OAAA,CAAQ,4BAAA;EAlUL;;;;EA6UA,eAAA,CACJ,MAAA,EAAQ,2BAAA,GACP,OAAA,CAAQ,6BAAA;EA5TL;;;;EAyUA,eAAA,CACJ,MAAA,EAAQ,2BAAA,GACP,OAAA,CAAQ,6BAAA;EAxTL;;;;EAwVA,kBAAA,CACJ,MAAA,EAAQ,8BAAA,GACP,OAAA,CAAQ,gCAAA;EA7SL;;;;;EAgUA,mBAAA,CACJ,MAAA,EAAQ,+BAAA,GACP,OAAA,CAAQ,iCAAA;EAlTY;;;;;EAoUjB,mBAAA,CACJ,MAAA,EAAQ,+BAAA,GACP,OAAA,CAAQ,iCAAA;EAhSL;;;;;EAgTO,eAAA,CACX,MAAA,EAAQ,2BAAA,GACP,OAAA,CAAQ,6BAAA;EA5RR;;;;EA6SU,YAAA,CAAA,GAAgB,OAAA,CAAQ,0BAAA;EA7RlC;;;;;EAwSG,oBAAA,CACJ,MAAA,EAAQ,gCAAA,GACP,OAAA,CAAQ,kCAAA;EAnRA;;;EAiSL,cAAA,CAAA,GAAkB,OAAA,CAAQ,4BAAA;AAAA"}