@nadohq/engine-client 0.1.0-alpha.20 → 0.1.0-alpha.21

package/src/EngineQueryClient.ts

@@ -40,6 +40,7 @@ import {
   GetEngineMaxWithdrawableResponse,
   GetEngineNlpLockedBalancesParams,
   GetEngineNlpLockedBalancesResponse,
+  GetEngineNlpPoolInfoResponse,
   GetEngineOrderParams,
   GetEngineOrderResponse,
   GetEngineSubaccountFeeRatesParams,
@@ -61,6 +62,7 @@ import {
   mapEngineMarketPrice,
   mapEngineServerIsolatedPositions,
   mapEngineServerNlpLockedBalances,
+  mapEngineServerNlpPoolInfo,
   mapEngineServerOrder,
   mapEngineServerPerpProduct,
   mapEngineServerSpotProduct,
@@ -544,7 +546,7 @@ export class EngineQueryClient extends EngineBaseClient {
   }
 
   /**
-   * Gets the insurance funds in USDC.
+   * Gets the insurance funds in USDT.
    * @returns
    */
   public async getInsurance(): Promise<GetEngineInsuranceResponse> {
@@ -570,4 +572,12 @@ export class EngineQueryClient extends EngineBaseClient {
 
     return mapEngineServerNlpLockedBalances(baseResponse);
   }
+
+  /**
+   * Retrieves information about all NLP sub-pools
+   */
+  async getNlpPoolInfo(): Promise<GetEngineNlpPoolInfoResponse> {
+    const baseResponse = await this.query('nlp_pool_info', {});
+    return mapEngineServerNlpPoolInfo(baseResponse);
+  }
 }

package/src/types/clientExecuteTypes.ts

@@ -49,7 +49,7 @@ export type EnginePlaceOrderParams = WithBaseEngineExecuteParams<{
   order: EngineOrderParams;
   // If not given, engine defaults to true (leverage/borrow enabled)
   spotLeverage?: boolean;
-  // For isolated orders, this specifies whether margin can be borrowed (i.e. whether the cross account can have a negative USDC balance)
+  // For isolated orders, this specifies whether margin can be borrowed (i.e. whether the cross account can have a negative USDT balance)
   borrowMargin?: boolean;
 }>;
 
@@ -84,7 +84,14 @@ export type EngineMintNlpParams = WithBaseEngineExecuteParams<
 export type EngineBurnNlpParams =
   WithBaseEngineExecuteParams<EIP712BurnNlpParams>;
 
-export type EnginePlaceOrdersParams = EnginePlaceOrderParams[];
+export type EnginePlaceOrdersParams = {
+  orders: EnginePlaceOrderParams[];
+  /**
+   * If `true`, aborts the batch after the first failed order; if `false`, remaining orders continue to execute.
+   * If not provided, the default value is `false`.
+   */
+  cancelOnFailure?: boolean;
+};
 
 export interface EngineExecuteRequestParamsByType {
   burn_nlp: EngineBurnNlpParams;

package/src/types/clientQueryTypes.ts

@@ -19,11 +19,11 @@ import {
   EngineServerTimeResponse,
 } from './serverQueryTypes';
 
-export type GetEngineSubaccountSummaryResponse = {
+export interface GetEngineSubaccountSummaryResponse {
   exists: boolean;
   balances: BalanceWithProduct[];
   health: HealthStatusByType;
-};
+}
 
 export type GetEngineSubaccountSummaryParams = Subaccount;
 
@@ -277,3 +277,15 @@ export interface GetEngineNlpLockedBalancesResponse {
   balanceLocked: EngineNlpBalance;
   balanceUnlocked: EngineNlpBalance;
 }
+
+export interface NlpPool {
+  poolId: number;
+  subaccount: Subaccount;
+  balanceWeight: BigDecimal;
+  subaccountInfo: GetEngineSubaccountSummaryResponse;
+  openOrders: EngineOrder[];
+}
+
+export interface GetEngineNlpPoolInfoResponse {
+  nlpPools: NlpPool[];
+}

package/src/types/serverExecuteTypes.ts

@@ -73,7 +73,7 @@ export interface EngineServerPlaceOrderParams {
   signature: string;
   // Engine defaults this to true
   spot_leverage: boolean | null;
-  // For isolated orders, this specifies whether margin can be borrowed (i.e. whether the cross account can have a negative USDC balance)
+  // For isolated orders, this specifies whether margin can be borrowed (i.e. whether the cross account can have a negative USDT balance)
   borrow_margin: boolean | null;
 }
 
@@ -111,7 +111,14 @@ export interface EngineServerExecuteRequestByType {
   liquidate_subaccount: SignedTx<EIP712LiquidateSubaccountValues>;
   mint_nlp: WithSpotLeverage<SignedTx<EIP712MintNlpValues>>;
   place_order: EngineServerPlaceOrderParams;
-  place_orders: EngineServerPlaceOrderParams[];
+  place_orders: {
+    orders: EngineServerPlaceOrderParams[];
+    /**
+     * If `true`, aborts the batch after the first failed order; if `false`, remaining orders continue to execute.
+     * If `null`, the default value is `false`.
+     */
+    cancel_on_failure: boolean | null;
+  };
   transfer_quote: SignedTx<EIP712TransferQuoteValues>;
   withdraw_collateral: WithSpotLeverage<
     SignedTx<EIP712WithdrawCollateralValues>

package/src/types/serverQueryModelTypes.ts

@@ -81,3 +81,28 @@ export interface EngineServerPerpBalance {
 }
 
 export type EngineServerProductType = 'perp' | 'spot';
+
+export interface EngineServerOrder {
+  product_id: number;
+  sender: string;
+  price_x18: string;
+  amount: string;
+  expiration: string;
+  nonce: string;
+  unfilled_amount: string;
+  digest: string;
+  placed_at: number;
+  order_type: string;
+  appendix: string;
+}
+
+export interface EngineServerNlpBalance {
+  product_id: number;
+  balance: {
+    amount: string;
+  };
+}
+export interface EngineServerNlpLockedBalance {
+  unlocked_at: number;
+  balance: EngineServerNlpBalance;
+}

package/src/types/serverQueryTypes.ts

@@ -1,6 +1,9 @@
 import { HealthStatus } from '@nadohq/shared';
 import {
   EngineServerHealthBreakdown,
+  EngineServerNlpBalance,
+  EngineServerNlpLockedBalance,
+  EngineServerOrder,
   EngineServerPerpBalance,
   EngineServerPerpProduct,
   EngineServerProductType,
@@ -129,6 +132,7 @@ export interface EngineServerQueryRequestByType {
   max_nlp_mintable: EngineServerMaxMintNlpQueryParams;
   max_order_size: EngineServerMaxOrderSizeQueryParams;
   nlp_locked_balances: EngineServerNlpLockedBalancesQueryParams;
+  nlp_pool_info: Record<string, never>;
   max_withdrawable: EngineServerMaxWithdrawableQueryParams;
   nonces: EngineServerNoncesParams;
   order: EngineServerGetOrderQueryParams;
@@ -282,20 +286,6 @@ export interface EngineServerMarketPricesResponse {
   market_prices: EngineServerMarketPrice[];
 }
 
-export interface EngineServerOrder {
-  product_id: number;
-  sender: string;
-  price_x18: string;
-  amount: string;
-  expiration: string;
-  nonce: string;
-  unfilled_amount: string;
-  digest: string;
-  placed_at: number;
-  order_type: string;
-  appendix: string;
-}
-
 export type EngineServerOrderResponse = EngineServerOrder;
 
 export interface EngineServerValidateOrderResponse {
@@ -340,23 +330,25 @@ export interface EngineServerMaxMintNlpResponse {
   max_quote_amount: string;
 }
 
-export interface EngineServerNlpBalance {
-  product_id: number;
-  balance: {
-    amount: string;
-  };
-}
-
-export interface EngineServerNlpLockedBalance extends EngineServerNlpBalance {
-  unlocked_at: number;
-}
-
 export interface EngineServerNlpLockedBalancesResponse {
   balance_locked: EngineServerNlpBalance;
   balance_unlocked: EngineServerNlpBalance;
   locked_balances: EngineServerNlpLockedBalance[];
 }
 
+export interface EngineServerNlpPool {
+  pool_id: number;
+  subaccount: string;
+  owner: string;
+  balance_weight_x18: string;
+  subaccount_info: EngineServerSubaccountInfoResponse;
+  open_orders: EngineServerOrder[];
+}
+
+export interface EngineServerNlpPoolInfoResponse {
+  nlp_pools: EngineServerNlpPool[];
+}
+
 export interface EngineServerQueryResponseByType {
   all_products: EngineServerAllProductsResponse;
   contracts: EngineServerContractsResponse;
@@ -373,6 +365,7 @@ export interface EngineServerQueryResponseByType {
   max_nlp_mintable: EngineServerMaxMintNlpResponse;
   max_order_size: EngineServerMaxOrderSizeResponse;
   nlp_locked_balances: EngineServerNlpLockedBalancesResponse;
+  nlp_pool_info: EngineServerNlpPoolInfoResponse;
   max_withdrawable: EngineServerMaxWithdrawableResponse;
   nonces: EngineServerNoncesResponse;
   order: EngineServerOrderResponse;

package/src/utils/queryDataMappers.ts

@@ -19,6 +19,7 @@ import {
   EngineServerIsolatedPositionsResponse,
   EngineServerMarketPrice,
   EngineServerNlpLockedBalancesResponse,
+  EngineServerNlpPoolInfoResponse,
   EngineServerOrderResponse,
   EngineServerPerpProduct,
   EngineServerPriceTickLiquidity,
@@ -30,6 +31,7 @@ import {
   EngineSymbolsResponse,
   GetEngineIsolatedPositionsResponse,
   GetEngineNlpLockedBalancesResponse,
+  GetEngineNlpPoolInfoResponse,
   GetEngineSubaccountSummaryResponse,
 } from '../types';
 import { mapEngineServerProductType } from './productEngineTypeMappers';
@@ -297,8 +299,8 @@ export function mapEngineServerNlpLockedBalances(
 ): GetEngineNlpLockedBalancesResponse {
   const lockedBalances: EngineNlpLockedBalance[] =
     baseResponse.locked_balances.map((lockedBalance) => ({
-      productId: lockedBalance.product_id,
-      balance: toBigDecimal(lockedBalance.balance.amount),
+      productId: lockedBalance.balance.product_id,
+      balance: toBigDecimal(lockedBalance.balance.balance.amount),
       unlockedAt: lockedBalance.unlocked_at,
     }));
 
@@ -314,3 +316,20 @@ export function mapEngineServerNlpLockedBalances(
     },
   };
 }
+
+export function mapEngineServerNlpPoolInfo(
+  baseResponse: EngineServerNlpPoolInfoResponse,
+): GetEngineNlpPoolInfoResponse {
+  return {
+    nlpPools: baseResponse.nlp_pools.map((pool) => ({
+      poolId: pool.pool_id,
+      subaccount: {
+        subaccountOwner: pool.owner,
+        subaccountName: pool.subaccount,
+      },
+      balanceWeight: removeDecimals(pool.balance_weight_x18),
+      subaccountInfo: mapSubaccountSummary(pool.subaccount_info),
+      openOrders: pool.open_orders.map(mapEngineServerOrder),
+    })),
+  };
+}