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

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 type 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;
 }
@@ -242,15 +237,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)

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 USDC balance)
   borrow_margin: boolean | null;
 }
 
@@ -116,8 +110,8 @@ 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: EngineServerPlaceOrderParams[];
   transfer_quote: SignedTx<EIP712TransferQuoteValues>;
   withdraw_collateral: WithSpotLeverage<
     SignedTx<EIP712WithdrawCollateralValues>
@@ -131,8 +125,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 {

package/src/types/serverQueryTypes.ts

@@ -1,4 +1,4 @@
-import { HealthStatus } from '@nadohq/contracts';
+import { HealthStatus } from '@nadohq/shared';
 import {
   EngineServerHealthBreakdown,
   EngineServerPerpBalance,
@@ -116,7 +116,6 @@ export interface EngineServerQueryRequestByType {
   max_nlp_mintable: EngineServerMaxMintNlpQueryParams;
   max_order_size: EngineServerMaxOrderSizeQueryParams;
   max_withdrawable: EngineServerMaxWithdrawableQueryParams;
-  min_deposit_rates: Record<string, never>;
   nonces: EngineServerNoncesParams;
   order: EngineServerGetOrderQueryParams;
   orders: EngineServerOrdersQueryParams;
@@ -141,8 +140,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
@@ -281,7 +278,7 @@ export interface EngineServerOrder {
   digest: string;
   placed_at: number;
   order_type: string;
-  margin: string | null;
+  appendix: string;
 }
 
 export type EngineServerOrderResponse = EngineServerOrder;
@@ -315,16 +312,6 @@ 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>;
@@ -349,7 +336,6 @@ export interface EngineServerQueryResponseByType {
   max_nlp_mintable: EngineServerMaxMintNlpResponse;
   max_order_size: EngineServerMaxOrderSizeResponse;
   max_withdrawable: EngineServerMaxWithdrawableResponse;
-  min_deposit_rates: EngineServerMinDepositRatesResponse;
   nonces: EngineServerNoncesResponse;
   order: EngineServerOrderResponse;
   orders: EngineServerProductOrdersResponse;

package/src/utils/productEngineTypeMappers.ts

@@ -1,4 +1,4 @@
-import { ProductEngineType } from '@nadohq/contracts';
+import { ProductEngineType } from '@nadohq/shared';
 import { EngineServerProductType } from '../types';
 
 export function mapProductEngineType(

package/src/utils/queryDataMappers.ts

@@ -2,18 +2,15 @@ import {
   BalanceHealthContributions,
   calcTotalBorrowed,
   calcTotalDeposited,
-  OrderExpirationType,
+  mapValues,
   PerpMarket,
   ProductEngineType,
+  removeDecimals,
   SpotMarket,
   subaccountFromHex,
-} from '@nadohq/contracts';
-import {
-  mapValues,
-  removeDecimals,
   toBigDecimal,
-  toIntegerString,
-} from '@nadohq/utils';
+  unpackOrderAppendix,
+} from '@nadohq/shared';
 import {
   EngineMarketPrice,
   EngineOrder,
@@ -49,7 +46,7 @@ export function mapEngineServerOrder(
   const subaccount = subaccountFromHex(order.sender);
   return {
     digest: order.digest,
-    expiration: toBigDecimal(order.expiration),
+    expiration: Number(order.expiration),
     nonce: order.nonce,
     price: removeDecimals(order.price_x18),
     productId: order.product_id,
@@ -57,19 +54,8 @@ export function mapEngineServerOrder(
     subaccountName: subaccount.subaccountName,
     totalAmount: toBigDecimal(order.amount),
     unfilledAmount: toBigDecimal(order.unfilled_amount),
-    margin: order.margin ? toBigDecimal(order.margin) : null,
-    // Standardizes from hex
-    // toFixed is required as toString gives values with `e`
-    orderParams: {
-      amount: toIntegerString(order.amount),
-      expiration: toIntegerString(order.expiration),
-      nonce: order.nonce,
-      price: toIntegerString(removeDecimals(order.price_x18)),
-      subaccountOwner: subaccount.subaccountOwner,
-      subaccountName: subaccount.subaccountName,
-    },
     placementTime: order.placed_at,
-    orderType: order.order_type as OrderExpirationType,
+    appendix: unpackOrderAppendix(order.appendix),
   };
 }
 
@@ -100,6 +86,7 @@ export function mapEngineServerSpotProduct(
       ),
       interestLargeCap: removeDecimals(product.config.interest_large_cap_x18),
       interestSmallCap: removeDecimals(product.config.interest_small_cap_x18),
+      minDepositRate: removeDecimals(product.config.min_deposit_rate_x18),
       longWeightInitial: removeDecimals(product.risk.long_weight_initial_x18),
       longWeightMaintenance: removeDecimals(
         product.risk.long_weight_maintenance_x18,