@nadohq/engine-client 0.1.0-alpha.3 → 0.1.0-alpha.31

package/src/types/clientExecuteTypes.ts

@@ -2,14 +2,13 @@ import {
   EIP712BurnNlpParams,
   EIP712CancelOrdersParams,
   EIP712CancelProductOrdersParams,
-  EIP712IsolatedOrderParams,
   EIP712LinkSignerParams,
   EIP712LiquidateSubaccountParams,
   EIP712MintNlpParams,
   EIP712OrderParams,
   EIP712TransferQuoteParams,
   EIP712WithdrawCollateralParams,
-} from '@nadohq/contracts';
+} from '@nadohq/shared';
 import { EngineServerExecuteSuccessResult } from './serverExecuteTypes';
 
 /**
@@ -50,15 +49,7 @@ export type EnginePlaceOrderParams = WithBaseEngineExecuteParams<{
   order: EngineOrderParams;
   // If not given, engine defaults to true (leverage/borrow enabled)
   spotLeverage?: boolean;
-}>;
-
-export type EngineIsolatedOrderParams = WithoutNonce<EIP712IsolatedOrderParams>;
-
-export type EnginePlaceIsolatedOrderParams = WithBaseEngineExecuteParams<{
-  id?: number;
-  productId: number;
-  order: EngineIsolatedOrderParams;
-  // Whether the cross subaccount can borrow quote for the margin transfer into the isolated subaccount. If not given, engine defaults to true.
+  // For isolated orders, this specifies whether margin can be borrowed (i.e. whether the cross account can have a negative USDT balance)
   borrowMargin?: boolean;
 }>;
 
@@ -93,6 +84,15 @@ export type EngineMintNlpParams = WithBaseEngineExecuteParams<
 export type EngineBurnNlpParams =
   WithBaseEngineExecuteParams<EIP712BurnNlpParams>;
 
+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;
   cancel_and_place: EngineCancelAndPlaceParams;
@@ -101,8 +101,8 @@ export interface EngineExecuteRequestParamsByType {
   link_signer: EngineLinkSignerParams;
   liquidate_subaccount: EngineLiquidateSubaccountParams;
   mint_nlp: EngineMintNlpParams;
-  place_isolated_order: EnginePlaceIsolatedOrderParams;
   place_order: EnginePlaceOrderParams;
+  place_orders: EnginePlaceOrdersParams;
   transfer_quote: EngineTransferQuoteParams;
   withdraw_collateral: EngineWithdrawCollateralParams;
 }
@@ -111,8 +111,3 @@ export type EnginePlaceOrderResult =
   EngineServerExecuteSuccessResult<'place_order'> & {
     orderParams: EIP712OrderParams;
   };
-
-export type EnginePlaceIsolatedOrderResult =
-  EngineServerExecuteSuccessResult<'place_isolated_order'> & {
-    orderParams: EIP712IsolatedOrderParams;
-  };

package/src/types/clientQueryTypes.ts

@@ -1,27 +1,31 @@
 import {
   BalanceHealthContributions,
   BalanceSide,
+  BalanceWithProduct,
+  BigDecimal,
   EIP712OrderParams,
-  GetAllMarketsResponse,
-  GetSubaccountSummaryParams,
   HealthGroup,
-  OrderExpirationType,
+  HealthStatusByType,
+  MarketWithProduct,
+  OrderAppendix,
   PerpBalanceWithProduct,
   ProductEngineType,
   SignedEIP712OrderParams,
   SpotBalanceWithProduct,
   Subaccount,
-  SubaccountSummaryResponse,
-} from '@nadohq/contracts';
-import { BigDecimal } from '@nadohq/utils';
+} from '@nadohq/shared';
 import {
   EngineServerNoncesParams,
   EngineServerTimeResponse,
 } from './serverQueryTypes';
 
-export type GetEngineSubaccountSummaryResponse = SubaccountSummaryResponse;
+export interface GetEngineSubaccountSummaryResponse {
+  exists: boolean;
+  balances: BalanceWithProduct[];
+  health: HealthStatusByType;
+}
 
-export type GetEngineSubaccountSummaryParams = GetSubaccountSummaryParams;
+export type GetEngineSubaccountSummaryParams = Subaccount;
 
 export type GetEngineIsolatedPositionsParams = Subaccount;
 
@@ -48,16 +52,11 @@ export interface SubaccountProductDeltaTx {
 export interface GetEngineContractsResponse {
   chainId: number;
   endpointAddr: string;
-  /**
-   * Address for the orderbook contract, with the product ID being the index
-   */
-  orderbookAddrs: string[];
 }
 
-export type GetEngineEstimatedSubaccountSummaryParams =
-  GetSubaccountSummaryParams & {
-    txs: SubaccountTx[];
-  };
+export type GetEngineEstimatedSubaccountSummaryParams = Subaccount & {
+  txs: SubaccountTx[];
+};
 
 export type GetEngineNoncesParams = EngineServerNoncesParams;
 
@@ -91,7 +90,7 @@ export interface EngineSymbol {
   longWeightMaintenance: BigDecimal;
 }
 
-export type GetEngineAllMarketsResponse = GetAllMarketsResponse;
+export type GetEngineAllMarketsResponse = MarketWithProduct[];
 
 export interface GetEngineHealthGroupsResponse {
   healthGroups: HealthGroup[];
@@ -109,14 +108,11 @@ export interface EngineOrder extends Subaccount {
   totalAmount: BigDecimal;
   // Amount still unfilled
   unfilledAmount: BigDecimal;
-  expiration: BigDecimal;
-  // Margin being transferred for the order, will be null if not an iso order
-  margin: BigDecimal | null;
+  expiration: number;
   nonce: string;
   digest: string;
-  orderParams: EIP712OrderParams;
   placementTime: number;
-  orderType: OrderExpirationType;
+  appendix: OrderAppendix;
 }
 
 export type GetEngineOrderResponse = EngineOrder;
@@ -128,7 +124,6 @@ export interface ValidateSignedEngineOrderParams {
 
 export interface ValidateEngineOrderParams {
   productId: number;
-  orderbookAddr: string;
   chainId: number;
   order: EIP712OrderParams;
 }
@@ -171,6 +166,7 @@ export interface GetEngineSubaccountFeeRatesResponse {
   liquidationSequencerFee: BigDecimal;
   healthCheckSequencerFee: BigDecimal;
   takerSequencerFee: BigDecimal;
+  feeTier: number;
 }
 
 export interface EnginePriceTickLiquidity {
@@ -220,6 +216,10 @@ export interface GetEngineMaxOrderSizeParams extends Subaccount {
   // If not given, engine defaults to false. If true, the max order size will be capped to the subaccount's current position size;
   // If no position exists, it will return 0.
   reduceOnly?: boolean;
+  isolated?: boolean;
+  // If not given, engine defaults to true (do not borrow margin for isolated orders)
+  // Max order size query for `isolated` includes available transfer from the cross subaccount
+  isoBorrowMargin?: boolean;
 }
 
 export type GetEngineMaxOrderSizeResponse = BigDecimal;
@@ -242,15 +242,6 @@ export interface GetEngineLinkedSignerResponse {
 
 export type GetEngineInsuranceResponse = BigDecimal;
 
-export interface EngineMinDepositRate {
-  productId: number;
-  minDepositRate: BigDecimal;
-}
-
-export interface GetEngineMinDepositRatesResponse {
-  minDepositRates: Record<number, EngineMinDepositRate>;
-}
-
 /**
  * Given an IP, backend will either:
  * - Allow queries only through archive / engine (query_only)
@@ -265,3 +256,37 @@ export interface GetEngineMaxMintNlpAmountParams extends Subaccount {
 }
 
 export type GetEngineMaxMintNlpAmountResponse = BigDecimal;
+
+export type GetEngineMaxBurnNlpAmountParams = Subaccount;
+
+export type GetEngineMaxBurnNlpAmountResponse = BigDecimal;
+
+export type GetEngineNlpLockedBalancesParams = Subaccount;
+
+export interface EngineNlpBalance {
+  productId: number;
+  balance: BigDecimal;
+}
+
+export interface EngineNlpLockedBalance extends EngineNlpBalance {
+  unlockedAt: number;
+}
+
+export interface GetEngineNlpLockedBalancesResponse {
+  lockedBalances: EngineNlpLockedBalance[];
+  balanceLocked: EngineNlpBalance;
+  balanceUnlocked: EngineNlpBalance;
+}
+
+export interface NlpPool {
+  poolId: number;
+  subaccountHex: string;
+  ownerAddress: string;
+  balanceWeight: BigDecimal;
+  subaccountInfo: GetEngineSubaccountSummaryResponse;
+  openOrders: EngineOrder[];
+}
+
+export interface GetEngineNlpPoolInfoResponse {
+  nlpPools: NlpPool[];
+}

package/src/types/index.ts

@@ -1,8 +1,8 @@
-export * from './clientQueryTypes';
 export * from './clientExecuteTypes';
-export * from './serverQueryTypes';
-export * from './serverQueryModelTypes';
+export * from './clientQueryTypes';
+export * from './EngineServerFailureError';
 export * from './serverExecuteTypes';
-export * from './serverSubscriptionTypes';
+export * from './serverQueryModelTypes';
+export * from './serverQueryTypes';
 export * from './serverSubscriptionEventTypes';
-export * from './EngineServerFailureError';
+export * from './serverSubscriptionTypes';

package/src/types/serverExecuteTypes.ts

@@ -1,6 +1,5 @@
 import {
   EIP712BurnNlpValues,
-  EIP712IsolatedOrderParams,
   EIP712LinkSignerValues,
   EIP712LiquidateSubaccountValues,
   EIP712MintNlpValues,
@@ -11,13 +10,16 @@ import {
   EIP712TransferQuoteValues,
   EIP712WithdrawCollateralValues,
   SignedTx,
-} from '@nadohq/contracts';
+} from '@nadohq/shared';
 import { EngineServerOrderResponse } from './serverQueryTypes';
 
 export interface EngineServerPlaceOrderResponse {
   digest: string;
+  error: string | null;
 }
 
+export type EngineServerPlaceOrdersResponse = EngineServerPlaceOrderResponse[];
+
 export interface EngineServerCancelOrdersResponse {
   cancelled_orders: EngineServerOrderResponse[];
 }
@@ -30,8 +32,8 @@ export interface EngineServerExecuteResponseDataByType {
   link_signer: null;
   liquidate_subaccount: null;
   mint_nlp: null;
-  place_isolated_order: EngineServerPlaceOrderResponse;
   place_order: EngineServerPlaceOrderResponse;
+  place_orders: EngineServerPlaceOrdersResponse;
   transfer_quote: null;
   withdraw_collateral: null;
 }
@@ -71,15 +73,7 @@ export interface EngineServerPlaceOrderParams {
   signature: string;
   // Engine defaults this to true
   spot_leverage: boolean | null;
-}
-
-export interface EngineServerPlaceIsolatedOrderParams {
-  id: number | null;
-  product_id: number;
-  isolated_order: EIP712OrderValues;
-  // Bytes
-  signature: string;
-  // Engine defaults this to false
+  // 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;
 }
 
@@ -116,8 +110,15 @@ export interface EngineServerExecuteRequestByType {
   link_signer: SignedTx<EIP712LinkSignerValues>;
   liquidate_subaccount: SignedTx<EIP712LiquidateSubaccountValues>;
   mint_nlp: WithSpotLeverage<SignedTx<EIP712MintNlpValues>>;
-  place_isolated_order: EngineServerPlaceIsolatedOrderParams;
   place_order: 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>
@@ -131,8 +132,3 @@ export interface EngineServerExecutePlaceOrderPayload {
   payload: EngineServerExecuteRequestByType['place_order'];
   orderParams: EIP712OrderParams;
 }
-
-export interface EngineServerExecutePlaceIsolatedOrderPayload {
-  payload: EngineServerExecuteRequestByType['place_isolated_order'];
-  orderParams: EIP712IsolatedOrderParams;
-}

package/src/types/serverQueryModelTypes.ts

@@ -6,7 +6,6 @@ export interface EngineServerHealthBreakdown {
 
 export interface EngineServerSpotBalanceData {
   amount: string;
-  last_cumulative_multiplier_x18: string;
 }
 
 export interface EngineServerPerpBalanceData {
@@ -36,6 +35,7 @@ export interface EngineServerSpotConfig {
   interest_floor_x18: string;
   interest_small_cap_x18: string;
   interest_large_cap_x18: string;
+  min_deposit_rate_x18: string;
 }
 
 export interface EngineServerSpotState {
@@ -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/contracts';
+import { HealthStatus } from '@nadohq/shared';
 import {
   EngineServerHealthBreakdown,
+  EngineServerNlpBalance,
+  EngineServerNlpLockedBalance,
+  EngineServerOrder,
   EngineServerPerpBalance,
   EngineServerPerpProduct,
   EngineServerProductType,
@@ -89,6 +92,10 @@ export interface EngineServerMaxOrderSizeQueryParams {
   // If not given, engine defaults to false. If true, the max order size will be capped to the subaccount's current position size;
   // If no position exists, it will return 0.
   reduce_only: string | null;
+  isolated: string | null;
+  // For isolated, max order size includes available collateral to transfer from parent cross subaccount
+  // If not given, engine defaults to true (borrow enabled)
+  borrow_margin: string | null;
 }
 
 export interface EngineServerLinkedSignerParams {
@@ -101,6 +108,14 @@ export interface EngineServerMaxMintNlpQueryParams {
   spot_leverage: string | null;
 }
 
+export interface EngineServerMaxBurnNlpQueryParams {
+  sender: string;
+}
+
+export interface EngineServerNlpLockedBalancesQueryParams {
+  subaccount: string;
+}
+
 export interface EngineServerQueryRequestByType {
   all_products: Record<string, never>;
   contracts: Record<string, never>;
@@ -113,10 +128,12 @@ export interface EngineServerQueryRequestByType {
   market_liquidity: EngineServerMarketLiquidityQueryParams;
   market_price: EngineServerMarketPriceQueryParams;
   market_prices: EngineServerMarketPricesQueryParams;
+  max_nlp_burnable: EngineServerMaxBurnNlpQueryParams;
   max_nlp_mintable: EngineServerMaxMintNlpQueryParams;
   max_order_size: EngineServerMaxOrderSizeQueryParams;
+  nlp_locked_balances: EngineServerNlpLockedBalancesQueryParams;
+  nlp_pool_info: Record<string, never>;
   max_withdrawable: EngineServerMaxWithdrawableQueryParams;
-  min_deposit_rates: Record<string, never>;
   nonces: EngineServerNoncesParams;
   order: EngineServerGetOrderQueryParams;
   orders: EngineServerOrdersQueryParams;
@@ -141,8 +158,6 @@ export type EngineServerQueryRequest<
 export interface EngineServerContractsResponse {
   chain_id: string;
   endpoint_addr: string;
-  // Index is product ID
-  book_addrs: string[];
 }
 
 // Unless in active state, engine is not fully operational
@@ -256,6 +271,7 @@ export interface EngineServerFeeRatesResponse {
   withdraw_sequencer_fees: string[];
   taker_fee_rates_x18: string[];
   maker_fee_rates_x18: string[];
+  fee_tier: number;
 }
 
 export interface EngineServerMarketPrice {
@@ -270,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;
-  margin: string | null;
-}
-
 export type EngineServerOrderResponse = EngineServerOrder;
 
 export interface EngineServerValidateOrderResponse {
@@ -315,25 +317,38 @@ export interface EngineInsuranceResponse {
   insurance: string;
 }
 
-export interface EngineServerMinDepositRate {
-  product_id: number;
-  min_deposit_rate_x18: string;
-}
-
-export interface EngineServerMinDepositRatesResponse {
-  // product_id -> EngineServerMinDepositRate
-  min_deposit_rates: Record<number, EngineServerMinDepositRate>;
-}
-
 export interface EngineServerEdgeAllProductsResponse {
   // chain_id -> EngineServerAllProductsResponse
   edge_all_products: Record<number, EngineServerAllProductsResponse>;
 }
 
+export interface EngineServerMaxBurnNlpResponse {
+  max_nlp_amount: string;
+}
+
 export interface EngineServerMaxMintNlpResponse {
   max_quote_amount: string;
 }
 
+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;
@@ -346,10 +361,12 @@ export interface EngineServerQueryResponseByType {
   market_liquidity: EngineServerMarketLiquidityResponse;
   market_price: EngineServerMarketPriceResponse;
   market_prices: EngineServerMarketPricesResponse;
+  max_nlp_burnable: EngineServerMaxBurnNlpResponse;
   max_nlp_mintable: EngineServerMaxMintNlpResponse;
   max_order_size: EngineServerMaxOrderSizeResponse;
+  nlp_locked_balances: EngineServerNlpLockedBalancesResponse;
+  nlp_pool_info: EngineServerNlpPoolInfoResponse;
   max_withdrawable: EngineServerMaxWithdrawableResponse;
-  min_deposit_rates: EngineServerMinDepositRatesResponse;
   nonces: EngineServerNoncesResponse;
   order: EngineServerOrderResponse;
   orders: EngineServerProductOrdersResponse;