@nadohq/engine-client 0.1.0-alpha.8 → 0.1.0

package/src/EngineQueryClient.ts

@@ -1,15 +1,15 @@
 import {
   addDecimals,
-  BigDecimal,
   encodeSignedOrder,
   getOrderVerifyingAddress,
   mapValues,
   MarketWithProduct,
   removeDecimals,
   subaccountToHex,
-  toBigDecimal,
+  toBigNumber,
   toIntegerString,
 } from '@nadohq/shared';
+import BigNumber from 'bignumber.js';
 import { EngineBaseClient } from './EngineBaseClient';
 import {
   EngineServerStatusResponse,
@@ -30,12 +30,17 @@ import {
   GetEngineMarketPriceResponse,
   GetEngineMarketPricesParams,
   GetEngineMarketPricesResponse,
+  GetEngineMaxBurnNlpAmountParams,
+  GetEngineMaxBurnNlpAmountResponse,
   GetEngineMaxMintNlpAmountParams,
   GetEngineMaxMintNlpAmountResponse,
   GetEngineMaxOrderSizeParams,
   GetEngineMaxOrderSizeResponse,
   GetEngineMaxWithdrawableParams,
   GetEngineMaxWithdrawableResponse,
+  GetEngineNlpLockedBalancesParams,
+  GetEngineNlpLockedBalancesResponse,
+  GetEngineNlpPoolInfoResponse,
   GetEngineOrderParams,
   GetEngineOrderResponse,
   GetEngineSubaccountFeeRatesParams,
@@ -56,6 +61,8 @@ import { mapProductEngineType } from './utils/productEngineTypeMappers';
 import {
   mapEngineMarketPrice,
   mapEngineServerIsolatedPositions,
+  mapEngineServerNlpLockedBalances,
+  mapEngineServerNlpPoolInfo,
   mapEngineServerOrder,
   mapEngineServerPerpProduct,
   mapEngineServerSpotProduct,
@@ -159,6 +166,9 @@ export class EngineQueryClient extends EngineBaseClient {
     const baseResponse = await this.query('subaccount_info', {
       subaccount: queryParams.subaccount,
       txns: JSON.stringify(queryParams.txns),
+      // Backend expects string variants of booleans
+      pre_state:
+        params.preState !== undefined ? String(params.preState) : undefined,
     });
 
     return mapSubaccountSummary(baseResponse);
@@ -357,13 +367,13 @@ export class EngineQueryClient extends EngineBaseClient {
     });
 
     return {
-      healthCheckSequencerFee: toBigDecimal(
+      healthCheckSequencerFee: toBigNumber(
         baseResponse.health_check_sequencer_fee,
       ),
-      liquidationSequencerFee: toBigDecimal(
+      liquidationSequencerFee: toBigNumber(
         baseResponse.liquidation_sequencer_fee,
       ),
-      takerSequencerFee: toBigDecimal(baseResponse.taker_sequencer_fee),
+      takerSequencerFee: toBigNumber(baseResponse.taker_sequencer_fee),
       orders: baseResponse.taker_fee_rates_x18.reduce(
         (acc, takerRateX18, currIndex) => {
           acc[currIndex] = {
@@ -376,10 +386,10 @@ export class EngineQueryClient extends EngineBaseClient {
       ),
       withdrawal: baseResponse.withdraw_sequencer_fees.reduce(
         (acc, productFee, currIndex) => {
-          acc[currIndex] = toBigDecimal(productFee);
+          acc[currIndex] = toBigNumber(productFee);
           return acc;
         },
-        {} as Record<number, BigDecimal>,
+        {} as Record<number, BigNumber>,
       ),
       feeTier: baseResponse.fee_tier,
     };
@@ -445,12 +455,19 @@ export class EngineQueryClient extends EngineBaseClient {
         subaccountOwner: params.subaccountOwner,
         subaccountName: params.subaccountName,
       }),
+      // Backend expects string variants of booleans
       spot_leverage:
         params.spotLeverage != null ? String(params.spotLeverage) : null,
       reduce_only: params.reduceOnly != null ? String(params.reduceOnly) : null,
+      isolated: params.isolated != null ? String(params.isolated) : null,
+      borrow_margin:
+        // This field is only relevant for isolated orders
+        params.isolated && params.isoBorrowMargin != null
+          ? String(params.isoBorrowMargin)
+          : null,
     });
 
-    return toBigDecimal(baseResponse.max_order_size);
+    return toBigNumber(baseResponse.max_order_size);
   }
 
   /**
@@ -470,7 +487,7 @@ export class EngineQueryClient extends EngineBaseClient {
         params.spotLeverage != null ? String(params.spotLeverage) : null,
     });
 
-    return toBigDecimal(baseResponse.max_withdrawable);
+    return toBigNumber(baseResponse.max_withdrawable);
   }
 
   /**
@@ -490,7 +507,25 @@ export class EngineQueryClient extends EngineBaseClient {
         params.spotLeverage != null ? String(params.spotLeverage) : null,
     });
 
-    return toBigDecimal(baseResponse.max_quote_amount);
+    return toBigNumber(baseResponse.max_quote_amount);
+  }
+
+  /**
+   * Retrieves the max amount of NLP that can be burned.
+   *
+   * @param params
+   */
+  async getMaxBurnNlpAmount(
+    params: GetEngineMaxBurnNlpAmountParams,
+  ): Promise<GetEngineMaxBurnNlpAmountResponse> {
+    const baseResponse = await this.query('max_nlp_burnable', {
+      sender: subaccountToHex({
+        subaccountOwner: params.subaccountOwner,
+        subaccountName: params.subaccountName,
+      }),
+    });
+
+    return toBigNumber(baseResponse.max_nlp_amount);
   }
 
   /**
@@ -514,12 +549,38 @@ export class EngineQueryClient extends EngineBaseClient {
   }
 
   /**
-   * Gets the insurance funds in USDC.
+   * Gets the insurance funds in USDT.
    * @returns
    */
   public async getInsurance(): Promise<GetEngineInsuranceResponse> {
     const baseResponse = await this.query('insurance', {});
 
-    return toBigDecimal(baseResponse.insurance);
+    return toBigNumber(baseResponse.insurance);
+  }
+
+  /**
+   * Retrieves the NLP locked and unlocked balances for a subaccount.
+   *
+   * @param params
+   */
+  async getNlpLockedBalances(
+    params: GetEngineNlpLockedBalancesParams,
+  ): Promise<GetEngineNlpLockedBalancesResponse> {
+    const baseResponse = await this.query('nlp_locked_balances', {
+      subaccount: subaccountToHex({
+        subaccountOwner: params.subaccountOwner,
+        subaccountName: params.subaccountName,
+      }),
+    });
+
+    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/endpoints.ts

@@ -2,19 +2,19 @@ import { ChainEnv } from '@nadohq/shared';
 
 export const ENGINE_CLIENT_ENDPOINTS: Record<ChainEnv, string> = {
   local: 'http://localhost:80',
-  arbitrum: 'https://gateway.prod.vertexprotocol.com/v1',
-  inkTestnet: 'https://gateway.test.nado-backend.xyz/v1',
+  inkTestnet: 'https://gateway.test.nado.xyz/v1',
+  inkMainnet: 'https://gateway.prod.nado.xyz/v1',
 };
 
 export const ENGINE_WS_CLIENT_ENDPOINTS: Record<ChainEnv, string> = {
   local: 'ws://localhost:80',
-  arbitrum: 'wss://gateway.prod.vertexprotocol.com/v1/ws',
-  inkTestnet: 'wss://gateway.test.nado-backend.xyz/v1/ws',
+  inkTestnet: 'wss://gateway.test.nado.xyz/v1/ws',
+  inkMainnet: 'wss://gateway.prod.nado.xyz/v1/ws',
 };
 
 export const ENGINE_WS_SUBSCRIPTION_CLIENT_ENDPOINTS: Record<ChainEnv, string> =
   {
     local: 'ws://localhost:80',
-    arbitrum: 'wss://gateway.prod.vertexprotocol.com/v1/subscribe',
-    inkTestnet: 'wss://gateway.test.nado-backend.xyz/v1/subscribe',
+    inkTestnet: 'wss://gateway.test.nado.xyz/v1/subscribe',
+    inkMainnet: 'wss://gateway.prod.nado.xyz/v1/subscribe',
   };

package/src/index.ts

@@ -1,4 +1,4 @@
-export * from './types';
-export * from './EngineClient';
 export * from './endpoints';
+export * from './EngineClient';
+export * from './types';
 export * from './utils';

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`.
+   */
+  stopOnFailure?: boolean;
+};
 
 export interface EngineExecuteRequestParamsByType {
   burn_nlp: EngineBurnNlpParams;

package/src/types/clientQueryTypes.ts

@@ -2,7 +2,6 @@ import {
   BalanceHealthContributions,
   BalanceSide,
   BalanceWithProduct,
-  BigDecimal,
   EIP712OrderParams,
   HealthGroup,
   HealthStatusByType,
@@ -14,16 +13,21 @@ import {
   SpotBalanceWithProduct,
   Subaccount,
 } from '@nadohq/shared';
+import BigNumber from 'bignumber.js';
 import {
   EngineServerNoncesParams,
   EngineServerTimeResponse,
 } from './serverQueryTypes';
 
-export type GetEngineSubaccountSummaryResponse = {
+export interface GetEngineSubaccountSummaryResponse extends SubaccountSummaryState {
   exists: boolean;
+  preState?: SubaccountSummaryState;
+}
+
+export interface SubaccountSummaryState {
   balances: BalanceWithProduct[];
   health: HealthStatusByType;
-};
+}
 
 export type GetEngineSubaccountSummaryParams = Subaccount;
 
@@ -45,8 +49,8 @@ export type SubaccountTx = {
 
 export interface SubaccountProductDeltaTx {
   productId: number;
-  amountDelta: BigDecimal;
-  vQuoteDelta: BigDecimal;
+  amountDelta: BigNumber;
+  vQuoteDelta: BigNumber;
 }
 
 export interface GetEngineContractsResponse {
@@ -56,6 +60,7 @@ export interface GetEngineContractsResponse {
 
 export type GetEngineEstimatedSubaccountSummaryParams = Subaccount & {
   txs: SubaccountTx[];
+  preState?: boolean;
 };
 
 export type GetEngineNoncesParams = EngineServerNoncesParams;
@@ -79,15 +84,16 @@ export interface EngineSymbol {
   type: ProductEngineType;
   productId: number;
   symbol: string;
-  priceIncrement: BigDecimal;
-  sizeIncrement: BigDecimal;
-  minSize: BigDecimal;
-  minDepth: BigDecimal;
-  maxSpreadRate: BigDecimal;
-  makerFeeRate: BigDecimal;
-  takerFeeRate: BigDecimal;
-  longWeightInitial: BigDecimal;
-  longWeightMaintenance: BigDecimal;
+  priceIncrement: BigNumber;
+  sizeIncrement: BigNumber;
+  minSize: BigNumber;
+  makerFeeRate: BigNumber;
+  takerFeeRate: BigNumber;
+  longWeightInitial: BigNumber;
+  longWeightMaintenance: BigNumber;
+  // undefined when there is no max open interest limit (always undefined for spot products)
+  maxOpenInterest: BigNumber | undefined;
+  isolatedOnly: boolean;
 }
 
 export type GetEngineAllMarketsResponse = MarketWithProduct[];
@@ -103,11 +109,11 @@ export interface GetEngineOrderParams {
 
 export interface EngineOrder extends Subaccount {
   productId: number;
-  price: BigDecimal;
+  price: BigNumber;
   // Amount initially requested
-  totalAmount: BigDecimal;
+  totalAmount: BigNumber;
   // Amount still unfilled
-  unfilledAmount: BigDecimal;
+  unfilledAmount: BigNumber;
   expiration: number;
   nonce: string;
   digest: string;
@@ -155,23 +161,23 @@ export interface GetEngineSubaccountProductOrdersResponse {
 export type GetEngineSubaccountFeeRatesParams = Subaccount;
 
 export interface SubaccountOrderFeeRates {
-  maker: BigDecimal;
-  taker: BigDecimal;
+  maker: BigNumber;
+  taker: BigNumber;
 }
 
 export interface GetEngineSubaccountFeeRatesResponse {
   // By Product ID
   orders: Record<number, SubaccountOrderFeeRates>;
-  withdrawal: Record<number, BigDecimal>;
-  liquidationSequencerFee: BigDecimal;
-  healthCheckSequencerFee: BigDecimal;
-  takerSequencerFee: BigDecimal;
+  withdrawal: Record<number, BigNumber>;
+  liquidationSequencerFee: BigNumber;
+  healthCheckSequencerFee: BigNumber;
+  takerSequencerFee: BigNumber;
   feeTier: number;
 }
 
 export interface EnginePriceTickLiquidity {
-  price: BigDecimal;
-  liquidity: BigDecimal;
+  price: BigNumber;
+  liquidity: BigNumber;
 }
 
 export interface GetEngineMarketLiquidityParams {
@@ -191,8 +197,8 @@ export interface GetEngineMarketPriceParams {
 
 export interface EngineMarketPrice {
   productId: number;
-  bid: BigDecimal;
-  ask: BigDecimal;
+  bid: BigNumber;
+  ask: BigNumber;
 }
 
 export type GetEngineMarketPriceResponse = EngineMarketPrice;
@@ -206,7 +212,7 @@ export interface GetEngineMarketPricesResponse {
 }
 
 export interface GetEngineMaxOrderSizeParams extends Subaccount {
-  price: BigDecimal;
+  price: BigNumber;
   productId: number;
   // Note: When `reduceOnly` is true, `side` must be opposite of the current position, otherwise it returns 0.
   side: BalanceSide;
@@ -216,9 +222,13 @@ 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;
+export type GetEngineMaxOrderSizeResponse = BigNumber;
 
 export interface GetEngineMaxWithdrawableParams extends Subaccount {
   productId: number;
@@ -226,7 +236,7 @@ export interface GetEngineMaxWithdrawableParams extends Subaccount {
   spotLeverage?: boolean;
 }
 
-export type GetEngineMaxWithdrawableResponse = BigDecimal;
+export type GetEngineMaxWithdrawableResponse = BigNumber;
 
 export type GetEngineTimeResponse = EngineServerTimeResponse;
 
@@ -236,7 +246,7 @@ export interface GetEngineLinkedSignerResponse {
   signer: string;
 }
 
-export type GetEngineInsuranceResponse = BigDecimal;
+export type GetEngineInsuranceResponse = BigNumber;
 
 /**
  * Given an IP, backend will either:
@@ -251,4 +261,38 @@ export interface GetEngineMaxMintNlpAmountParams extends Subaccount {
   spotLeverage?: boolean;
 }
 
-export type GetEngineMaxMintNlpAmountResponse = BigDecimal;
+export type GetEngineMaxMintNlpAmountResponse = BigNumber;
+
+export type GetEngineMaxBurnNlpAmountParams = Subaccount;
+
+export type GetEngineMaxBurnNlpAmountResponse = BigNumber;
+
+export type GetEngineNlpLockedBalancesParams = Subaccount;
+
+export interface EngineNlpBalance {
+  productId: number;
+  balance: BigNumber;
+}
+
+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: BigNumber;
+  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

@@ -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`.
+     */
+    stop_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;
+}