@katanaperps/katana-perps-sdk 0.0.0-placeholder

package/dist/types/rest/endpoints/CancelOrders.d.ts

@@ -0,0 +1,134 @@
+import type { RestRequestWithSignature } from '#types/utils';
+import type * as katanaPerps from '@katanaperps/katana-perps-sdk/types';
+/**
+ * [[include:unexported.md]]
+ *
+ * @category Base Types
+ */
+interface RestRequestCancelOrdersBase extends katanaPerps.RestRequestByWallet, katanaPerps.DelegatedKeyParams, katanaPerps.RestRequestByMarketOptional {
+    /**
+     * - When specified, cancels multiple orders by orderId or clientOrderId.
+     *   - You may provide an orders {@link katanaPerps.KatanaPerpsOrder.orderId orderId}
+     *   - You may provide an orders {@link katanaPerps.KatanaPerpsOrder.clientOrderId clientOrderId}
+     *     by prefixing it with `client:`
+     *
+     * @throws {BAD_REQUEST} If `orderIds` array is empty
+     */
+    readonly orderIds?: string[];
+    /**
+     * - Delegated key used for the order, if any
+     * - This is only allowed when using the `cancelOrders` client method.
+     */
+    readonly orderDelegatedKey?: string;
+}
+/**
+ * Allows cancelling all open orders for a given wallet.
+ *
+ * @category KatanaPerps - Cancel Order
+ *
+ * @see request {@link RestRequestCancelOrders}
+ */
+export interface RestRequestCancelOrdersByWallet extends RestRequestCancelOrdersBase {
+    market?: undefined;
+    orderDelegatedKey?: undefined;
+    orderIds?: undefined;
+}
+/**
+ * Allows cancelling all open orders by one or more orderId's or clientOrderId's.
+ *
+ * @category KatanaPerps - Cancel Order
+ *
+ * @see request {@link RestRequestCancelOrders}
+ */
+export interface RestRequestCancelOrdersByOrderIds extends RestRequestCancelOrdersBase {
+    market?: undefined;
+    orderDelegatedKey?: undefined;
+    /**
+     * @inheritDoc
+     */
+    readonly orderIds: string[];
+}
+/**
+ * Allows cancelling all open orders of a wallet for a given market.
+ *
+ * @category KatanaPerps - Cancel Order
+ *
+ * @see request {@link RestRequestCancelOrders}
+ */
+export interface RestRequestCancelOrdersByMarket extends RestRequestCancelOrdersBase {
+    /**
+     * @inheritDoc
+     */
+    readonly market: string;
+    orderDelegatedKey?: undefined;
+    orderIds?: undefined;
+}
+/**
+ * Allows cancelling all open orders of a wallet using the given delegated key.
+ *
+ * @category KatanaPerps - Cancel Order
+ *
+ * @see request {@link RestRequestCancelOrders}
+ */
+export interface RestRequestCancelOrdersByDelegatedKey extends RestRequestCancelOrdersBase {
+    market?: undefined;
+    orderIds?: undefined;
+    /**
+     * @inheritDoc
+     */
+    readonly orderDelegatedKey: string;
+}
+/**
+ * Cancel Orders can be done with various parameter combinations depending on
+ * the desired behavior.
+ *
+ * - {@link RestRequestCancelOrdersByWallet} - Cancel all open orders for a given wallet.
+ * - {@link RestRequestCancelOrdersByOrderIds} - Cancel all orders for a given wallet by one or more orderId's or clientOrderId's.
+ * - {@link RestRequestCancelOrdersByMarket} - Cancel all open orders for a given wallet on a specific market.
+ * - {@link RestRequestCancelOrdersByDelegatedKey} - Cancel all open orders for a given wallet using a specific delegated key.
+ *
+ * @see related {@link RestRequestCancelOrder} - Cancel a single order by its `orderId`.
+ *
+ * @category KatanaPerps - Cancel Order
+ */
+export type RestRequestCancelOrders = RestRequestCancelOrdersByOrderIds | RestRequestCancelOrdersByMarket | RestRequestCancelOrdersByDelegatedKey | RestRequestCancelOrdersByWallet;
+/**
+ * Response to "cancel order" requests (single or multiple orders). Includes
+ * one object for each successfully canceled order.
+ *
+ * @category KatanaPerps Interfaces
+ * @category KatanaPerps - Cancel Order
+ */
+export interface KatanaPerpsCanceledOrder {
+    /**
+     * Exchange-assigned order identifier. Will not be present for client order IDs
+     * that were not found on the books and were not filled
+     */
+    readonly orderId?: string;
+    /**
+     * If the order was created with a `clientOrderId`, it will be included
+     * within the cancel object when cancelled by any of your requests.
+     */
+    readonly clientOrderId?: string;
+    /**
+     * Current order status, either canceled or notFound if provided ID was not on the books
+     *
+     * @see enum {@link OrderStatus}
+     */
+    status: Extract<katanaPerps.OrderStatus, 'canceled' | 'notFound'>;
+}
+/**
+ * @see type {@link KatanaPerpsCanceledOrder}
+ *
+ * @category KatanaPerps - Cancel Order
+ */
+export type RestResponseCancelOrders = KatanaPerpsCanceledOrder[];
+/**
+ * The raw request body for the `DELETE /v1/orders` endpoint
+ * including `signature` and the body in `parameters`.
+ *
+ * @internal
+ */
+export type RestRequestCancelOrdersSigned = RestRequestWithSignature<RestRequestCancelOrders>;
+export {};
+//# sourceMappingURL=CancelOrders.d.ts.map

package/dist/types/rest/endpoints/CancelOrders.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CancelOrders.d.ts","sourceRoot":"","sources":["../../../../src/types/rest/endpoints/CancelOrders.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAC;AAC7D,OAAO,KAAK,KAAK,WAAW,MAAM,qCAAqC,CAAC;AAExE;;;;GAIG;AACH,UAAU,2BACR,SAAQ,WAAW,CAAC,mBAAmB,EACrC,WAAW,CAAC,kBAAkB,EAC9B,WAAW,CAAC,2BAA2B;IACzC;;;;;;;OAOG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IAC7B;;;OAGG;IACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;CACrC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,+BACf,SAAQ,2BAA2B;IACnC,MAAM,CAAC,EAAE,SAAS,CAAC;IACnB,iBAAiB,CAAC,EAAE,SAAS,CAAC;IAC9B,QAAQ,CAAC,EAAE,SAAS,CAAC;CACtB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,iCACf,SAAQ,2BAA2B;IACnC,MAAM,CAAC,EAAE,SAAS,CAAC;IACnB,iBAAiB,CAAC,EAAE,SAAS,CAAC;IAC9B;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,CAAC;CAC7B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,+BACf,SAAQ,2BAA2B;IACnC;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,iBAAiB,CAAC,EAAE,SAAS,CAAC;IAC9B,QAAQ,CAAC,EAAE,SAAS,CAAC;CACtB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,qCACf,SAAQ,2BAA2B;IACnC,MAAM,CAAC,EAAE,SAAS,CAAC;IACnB,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB;;OAEG;IACH,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC;CACpC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,uBAAuB,GAC/B,iCAAiC,GACjC,+BAA+B,GAC/B,qCAAqC,GACrC,+BAA+B,CAAC;AAEpC;;;;;;GAMG;AACH,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B;;;OAGG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC;;;;OAIG;IACH,MAAM,EAAE,OAAO,CAAC,WAAW,CAAC,WAAW,EAAE,UAAU,GAAG,UAAU,CAAC,CAAC;CACnE;AAED;;;;GAIG;AACH,MAAM,MAAM,wBAAwB,GAAG,wBAAwB,EAAE,CAAC;AAElE;;;;;GAKG;AACH,MAAM,MAAM,6BAA6B,GACvC,wBAAwB,CAAC,uBAAuB,CAAC,CAAC"}

package/dist/types/rest/endpoints/CancelOrders.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/rest/endpoints/CreateOrder.d.ts

@@ -0,0 +1,401 @@
+import type * as katanaPerps from '#index';
+import type { RestRequestWithSignature } from '#types/utils';
+/**
+ * <div>
+ * [[include:base.md]]
+ * </div>
+ *
+ * @category Base Types
+ *
+ * @see related {@link RestRequestOrderBaseWithoutTriggerPrice}
+ * @see related {@link RestRequestOrderBaseWithTriggerPrice}
+ */
+export interface RestRequestOrderBase extends katanaPerps.RestRequestByWallet, katanaPerps.DelegatedKeyParams, katanaPerps.RestRequestByMarket {
+    /**
+     * - When specifying, using the {@link katanaPerps.OrderType OrderType} enum is recommended for
+     *   inline docs and convenience.
+     *
+     * @example
+     * ```typescript
+     *  import { OrderType } from '@katanaperps/katana-perps-sdk'
+     *
+     *  const response = await client.createOrder({
+     *    // whichever order type you are creating
+     *    type: OrderType.market,
+     *    // ...other params
+     *  })
+     * ```
+     *
+     * @see docs [API Documentation: Order Types](https://api-docs-v1-perps.katana.network/#order-types)
+     * @see enum {@link katanaPerps.OrderType OrderType}
+     */
+    readonly type: katanaPerps.OrderType;
+    /**
+     * - When specifying, using the {@link katanaPerps.OrderSide OrderSide} enum is recommended for
+     *   inline docs and convenience.
+     *
+     * @see enum {@link katanaPerps.OrderSide OrderSide}
+     */
+    readonly side: katanaPerps.OrderSide;
+    /**
+     * Order quantity in base terms
+     */
+    readonly quantity: string;
+    /**
+     * Client-specified order id, maximum of 40 bytes
+     */
+    readonly clientOrderId?: string;
+    /**
+     * Reduce only orders are only accepted opposite open
+     * positions and only reduce an opposite position’s size
+     */
+    readonly reduceOnly?: boolean;
+    /**
+     * - When specifying, using the {@link katanaPerps.TimeInForce TimeInForce} enum is recommended for inline docs and convenience.
+     * - {@link isLiquidationAcquisitionOnly} limit orders must have `timeInForce` set to {@link katanaPerps.TimeInForce.gtx TimeInForce.gtx}
+     * - Defaults to {@link katanaPerps.TimeInForce.gtc TimeInForce.gtc}
+     *
+     * @see enum {@link katanaPerps.TimeInForce TimeInForce}
+     *
+     * @defaultValue
+     * ```typescript
+     * TimeInForce.gtc
+     * ```
+     */
+    readonly timeInForce?: katanaPerps.TimeInForce;
+    /**
+     * Self-trade prevention policy, see enum links
+     *
+     * - When specifying, using the {@link katanaPerps.SelfTradePrevention SelfTradePrevention} enum is
+     *   recommended for inline docs and convenience.
+     * - **MUST** be {@link katanaPerps.SelfTradePrevention.cn SelfTradePrevention.cn} if
+     *   {@link katanaPerps.TimeInForce.fok TimeInForce.fok} is specified for the {@link timeInForce} property.
+     * - For {@link isLiquidationAcquisitionOnly} {@link katanaPerps.OrderType.limit OrderType.limit} orders,
+     *   `selfTradePrevention` must be omitted or its default value of {@link katanaPerps.SelfTradePrevention.dc SelfTradePrevention.dc}.
+     *
+     * @see enum {@link katanaPerps.SelfTradePrevention SelfTradePrevention}
+     *
+     * @defaultValue
+     * ```typescript
+     * SelfTradePrevention.dc
+     * ```
+     */
+    readonly selfTradePrevention?: katanaPerps.SelfTradePrevention;
+    /**
+     * **Internal:** Not yet available in production APIs.
+     *
+     * - Only applicable to stop {@link katanaPerps.OrderType order types}:
+     *   - {@link katanaPerps.OrderType.stopLossMarket stopLossMarket}
+     *   - {@link katanaPerps.OrderType.stopLossLimit stopLossLimit}
+     *   - {@link katanaPerps.OrderType.trailingStopMarket trailingStopMarket}
+     * - Indicates an {@link katanaPerps.KatanaPerpsOrder.orderId orderId} of an open {@link katanaPerps.OrderType.limit limit} order
+     *   by the same wallet in the same market that must be filled before the stop becomes active.
+     * - Canceling the conditional order also cancels the stop order.
+     *
+     * @see enum {@link katanaPerps.OrderType OrderType}
+     *
+     * @alpha
+     * @internal
+     */
+    readonly conditionalOrderId?: string | undefined;
+    /**
+     * **Internal:** Not yet available in production APIs.
+     *
+     * - Only applicable to {@link katanaPerps.OrderType.trailingStopMarket trailingStopMarket} order types.
+     * - bounded from `0.1%` to `5%`
+     *
+     * @see type {@link RestRequestOrderTypeTrailingStopMarket}
+     * @see enum {@link katanaPerps.OrderType OrderType}
+     *
+     * @alpha
+     * @internal
+     */
+    readonly callbackRate?: string | undefined;
+    /**
+     * Only allowed for certain order types mentioned below, omitted otherwise.
+     *
+     * - Stop loss or take profit price for order types:
+     *   - {@link katanaPerps.OrderType.stopLossMarket stopLossMarket}
+     *   - {@link katanaPerps.OrderType.stopLossLimit stopLossLimit}
+     *   - {@link katanaPerps.OrderType.takeProfitMarket takeProfitMarket}
+     *   - {@link katanaPerps.OrderType.takeProfitLimit takeProfitLimit}
+     *
+     * - Activation price for order types:
+     *   - {@link katanaPerps.OrderType.trailingStopMarket trailingStopMarket}
+     *
+     * @see enum {@link katanaPerps.OrderType OrderType}
+     */
+    readonly triggerPrice?: string;
+    /**
+     * Price type for the {@link triggerPrice}
+     *
+     * - When specifying, using the {@link katanaPerps.TriggerType TriggerType} enum is recommended
+     *   for inline docs and convenience.
+     * - Required when {@link triggerPrice} is defined.
+     *
+     * @see enum {@link katanaPerps.TriggerType TriggerType}
+     */
+    readonly triggerType?: katanaPerps.TriggerType;
+    /**
+     * Order price in quote terms
+     *
+     * - Required for all {@link katanaPerps.OrderType.limit limit} order types.
+     * - Omitted for all {@link katanaPerps.OrderType.market market}  order types.
+     *
+     * @see enum {@link katanaPerps.OrderType OrderType}
+     */
+    readonly price?: string | undefined;
+    /**
+     * When this parameter is `true` it indicates that the order is an LP side
+     * channel order not to be executed against the order book.
+     *
+     * - Wallet placing the order **MUST BE WHITELISTED.** Contact the Katana Perps team for more details.
+     * - This parameter is only allowed to be `true` on {@link katanaPerps.OrderType.market market} and
+     *   {@link katanaPerps.OrderType.limit limit} order types.
+     * - In the case of `limit` orders, {@link timeInForce} must be {@link katanaPerps.TimeInForce.gtc TimeInForce.gtc}
+     *   indicating that side channel orders never take liquidity.
+     * - {@link reduceOnly} and {@link selfTradePrevention} parameters may be omitted or set to their
+     *   default values only.
+     *
+     * @see enum {@link katanaPerps.OrderType OrderType}
+     * @see enum {@link katanaPerps.TimeInForce TimeInForce}
+     */
+    readonly isLiquidationAcquisitionOnly?: boolean | undefined;
+}
+/**
+ * [[include:unexported.md]]
+ *
+ * @category Base Types
+ */
+interface RestRequestOrderBaseWithTriggerPrice extends RestRequestOrderBase {
+    /**
+     * @inheritDoc
+     */
+    readonly triggerPrice: string;
+    /**
+     * @inheritDoc
+     */
+    readonly triggerType: katanaPerps.TriggerType;
+}
+/**
+ * [[include:unexported.md]]
+ *
+ * @category Base Types
+ */
+interface RestRequestOrderBaseWithoutTriggerPrice extends RestRequestOrderBase {
+    readonly triggerPrice?: undefined;
+    readonly triggerType?: undefined;
+}
+/**
+ * @category KatanaPerps - Create Order
+ */
+export interface RestRequestOrderTypeLimit extends RestRequestOrderBaseWithoutTriggerPrice {
+    /**
+     * @inheritDoc
+     */
+    readonly type: typeof katanaPerps.OrderType.limit;
+    /**
+     * @inheritDoc
+     */
+    readonly price: string;
+    callbackRate?: undefined;
+    conditionalOrderId?: undefined;
+    readonly isLiquidationAcquisitionOnly?: false;
+}
+/**
+ * > Orders with {@link RestRequestOrderBase.isLiquidationAcquisitionOnly isLiquidationAcquisitionOnly} set to `true` are
+ * > only allowed for whitelisted wallets at this time.  Please contact
+ * > the Katana Perps team if you would like more details.
+ *
+ * @category KatanaPerps - Create Order
+ */
+export interface RestRequestOrderTypeLimitLPP extends RestRequestOrderBaseWithoutTriggerPrice {
+    /**
+     * @inheritDoc
+     */
+    readonly type: typeof katanaPerps.OrderType.limit;
+    /**
+     * @inheritDoc
+     */
+    readonly isLiquidationAcquisitionOnly: true;
+    /**
+     * @inheritDoc
+     */
+    readonly timeInForce: typeof katanaPerps.TimeInForce.gtx;
+    /**
+     * @inheritDoc
+     */
+    readonly price: string;
+    reduceOnly?: false;
+    selfTradePrevention?: typeof katanaPerps.SelfTradePrevention.dc;
+    callbackRate?: undefined;
+    conditionalOrderId?: undefined;
+}
+/**
+ * @category KatanaPerps - Create Order
+ */
+export interface RestRequestOrderTypeMarket extends RestRequestOrderBaseWithoutTriggerPrice {
+    /**
+     * @inheritDoc
+     */
+    readonly type: typeof katanaPerps.OrderType.market;
+    price?: undefined;
+    timeInForce?: undefined;
+    callbackRate?: undefined;
+    conditionalOrderId?: undefined;
+    isLiquidationAcquisitionOnly?: false;
+}
+/**
+ * > Orders with {@link RestRequestOrderBase.isLiquidationAcquisitionOnly isLiquidationAcquisitionOnly} set to `true` are
+ * > only allowed for whitelisted wallets at this time.  Please contact
+ * > the Katana Perps team if you would like more details.
+ *
+ * @category KatanaPerps - Create Order
+ */
+export interface RestRequestOrderTypeMarketLPP extends RestRequestOrderBaseWithoutTriggerPrice {
+    /**
+     * @inheritDoc
+     */
+    readonly type: typeof katanaPerps.OrderType.market;
+    /**
+     * @inheritDoc
+     */
+    readonly isLiquidationAcquisitionOnly: true;
+    price?: undefined;
+    timeInForce?: undefined;
+    reduceOnly?: false;
+    selfTradePrevention?: typeof katanaPerps.SelfTradePrevention.dc;
+    callbackRate?: undefined;
+    conditionalOrderId?: undefined;
+}
+/**
+ * @category KatanaPerps - Create Order
+ */
+export interface RestRequestOrderTypeStopLossMarket extends RestRequestOrderBaseWithTriggerPrice {
+    readonly type: typeof katanaPerps.OrderType.stopLossMarket;
+    price?: undefined;
+    timeInForce?: undefined;
+    callbackRate?: undefined;
+    isLiquidationAcquisitionOnly?: false;
+}
+/**
+ * Order request parameters for when the {@link katanaPerps.OrderType type} is a {@link katanaPerps.OrderType.stopLossLimit stopLossLimit} order.
+ *
+ * @category KatanaPerps - Create Order
+ *
+ * @see related {@link katanaPerps.OrderType.stopLossLimit OrderType.stopLossLimit}
+ * @see enum {@link katanaPerps.OrderType OrderType}
+ */
+export interface RestRequestOrderTypeStopLossLimit extends RestRequestOrderBaseWithTriggerPrice {
+    /**
+     * @inheritDoc
+     */
+    readonly type: typeof katanaPerps.OrderType.stopLossLimit;
+    /**
+     * @inheritDoc
+     */
+    readonly price: string;
+    callbackRate?: undefined;
+    isLiquidationAcquisitionOnly?: false;
+}
+/**
+ * @category KatanaPerps - Create Order
+ */
+export interface RestRequestOrderTypeTakeProfitMarket extends RestRequestOrderBaseWithTriggerPrice {
+    /**
+     * @inheritDoc
+     */
+    readonly type: typeof katanaPerps.OrderType.takeProfitMarket;
+    price?: undefined;
+    timeInForce?: undefined;
+    callbackRate?: undefined;
+    conditionalOrderId?: undefined;
+    isLiquidationAcquisitionOnly?: false;
+}
+/**
+ * @category KatanaPerps - Create Order
+ */
+export interface RestRequestOrderTypeTakeProfitLimit extends RestRequestOrderBaseWithTriggerPrice {
+    /**
+     * @inheritDoc
+     */
+    readonly type: typeof katanaPerps.OrderType.takeProfitLimit;
+    /**
+     * @inheritDoc
+     */
+    readonly price: string;
+    callbackRate?: undefined;
+    conditionalOrderId?: undefined;
+    isLiquidationAcquisitionOnly?: false;
+}
+/**
+ * @category KatanaPerps - Create Order
+ */
+export interface RestRequestOrderTypeTrailingStopMarket extends RestRequestOrderBaseWithTriggerPrice {
+    /**
+     * @inheritDoc
+     */
+    readonly type: typeof katanaPerps.OrderType.trailingStopMarket;
+    /**
+     * @inheritDoc
+     */
+    readonly callbackRate?: string;
+    price?: undefined;
+    timeInForce?: undefined;
+    isLiquidationAcquisitionOnly?: false;
+}
+/**
+ * Available Request Order Types.  The request is narrowed based on the parameters given to the
+ * request. Below is a summary of the various interfaces to match to achieve different orders.
+ *
+ * - {@link RestRequestOrderTypeLimit}
+ *   - parameter {@link RestRequestOrderBase.type type} is {@link katanaPerps.OrderType.limit OrderType.limit}
+ * - {@link RestRequestOrderTypeMarket}
+ *   - parameter {@link RestRequestOrderBase.type type} is {@link katanaPerps.OrderType.market OrderType.market}
+ * - {@link RestRequestOrderTypeStopLossMarket}
+ *   - parameter {@link RestRequestOrderBase.type type} is {@link katanaPerps.OrderType.stopLossMarket OrderType.stopLossMarket}
+ * - {@link RestRequestOrderTypeStopLossLimit}
+ *   - parameter {@link RestRequestOrderBase.type type} is {@link katanaPerps.OrderType.stopLossLimit OrderType.stopLossLimit}
+ * - {@link RestRequestOrderTypeTakeProfitMarket}
+ *   - parameter {@link RestRequestOrderBase.type type} is {@link katanaPerps.OrderType.takeProfitMarket OrderType.takeProfitMarket}
+ * - {@link RestRequestOrderTypeTakeProfitLimit}
+ *   - parameter {@link RestRequestOrderBase.type type} is {@link katanaPerps.OrderType.takeProfitLimit OrderType.takeProfitLimit}
+ * - {@link RestRequestOrderTypeTrailingStopMarket}
+ *   - parameter {@link RestRequestOrderBase.type type} is {@link katanaPerps.OrderType.trailingStopMarket OrderType.trailingStopMarket}
+ *
+ * Protected Request Order Types:
+ *
+ * - {@link RestRequestOrderTypeLimitLPP}
+ *   - parameter {@link RestRequestOrderBase.isLiquidationAcquisitionOnly isLiquidationAcquisitionOnly} set to `true`
+ *   - parameter {@link RestRequestOrderBase.type type} is {@link katanaPerps.OrderType.limit OrderType.limit}
+ * - {@link RestRequestOrderTypeMarketLPP}
+ *   - parameter {@link RestRequestOrderBase.isLiquidationAcquisitionOnly isLiquidationAcquisitionOnly} set to `true`
+ *   - parameter {@link RestRequestOrderBase.type type} is {@link katanaPerps.OrderType.market OrderType.market} order
+ *
+ * @category KatanaPerps - Create Order
+ */
+export type RestRequestOrder = RestRequestOrderTypeLimit | RestRequestOrderTypeMarket | RestRequestOrderTypeStopLossMarket | RestRequestOrderTypeStopLossLimit | RestRequestOrderTypeTakeProfitMarket | RestRequestOrderTypeTakeProfitLimit | RestRequestOrderTypeTrailingStopMarket | RestRequestOrderTypeLimitLPP | RestRequestOrderTypeMarketLPP;
+/**
+ * Extract an order by its {@link RestRequestOrderBase.type type} parameter.
+ */
+export type RestRequestOrderOfType<T extends katanaPerps.OrderType> = Extract<RestRequestOrder, {
+    type: T;
+}>;
+export type RestRequestOrderTypeAllLimit = Extract<RestRequestOrder, {
+    type: 'limit' | `${string}Limit`;
+}>;
+export type RestRequestOrderTypeAllMarket = Extract<RestRequestOrder, {
+    type: 'market' | `${string}Market`;
+}>;
+export type RestRequestOrderTypeLPP = Extract<RestRequestOrder, {
+    isLiquidationAcquisitionOnly: true;
+}>;
+/**
+ * The raw request body for the `DELETE /v1/orders` endpoint
+ * including `signature` and the body in `parameters`.
+ *
+ * @internal
+ */
+export type RestRequestCreateOrderSigned = RestRequestWithSignature<RestRequestOrder>;
+export {};
+//# sourceMappingURL=CreateOrder.d.ts.map

package/dist/types/rest/endpoints/CreateOrder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CreateOrder.d.ts","sourceRoot":"","sources":["../../../../src/types/rest/endpoints/CreateOrder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,WAAW,MAAM,QAAQ,CAAC;AAC3C,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAC;AAE7D;;;;;;;;;GASG;AACH,MAAM,WAAW,oBACf,SAAQ,WAAW,CAAC,mBAAmB,EACrC,WAAW,CAAC,kBAAkB,EAC9B,WAAW,CAAC,mBAAmB;IACjC;;;;;;;;;;;;;;;;;OAiBG;IACH,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC,SAAS,CAAC;IACrC;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC,SAAS,CAAC;IACrC;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC;;;OAGG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC;IAC9B;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,WAAW,CAAC,WAAW,CAAC;IAC/C;;;;;;;;;;;;;;;;OAgBG;IACH,QAAQ,CAAC,mBAAmB,CAAC,EAAE,WAAW,CAAC,mBAAmB,CAAC;IAC/D;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CAAC,kBAAkB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjD;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3C;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAC/B;;;;;;;;OAQG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,WAAW,CAAC,WAAW,CAAC;IAC/C;;;;;;;OAOG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,4BAA4B,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CAC7D;AAED;;;;GAIG;AACH,UAAU,oCAAqC,SAAQ,oBAAoB;IACzE;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC,WAAW,CAAC;CAC/C;AAED;;;;GAIG;AACH,UAAU,uCAAwC,SAAQ,oBAAoB;IAC5E,QAAQ,CAAC,YAAY,CAAC,EAAE,SAAS,CAAC;IAClC,QAAQ,CAAC,WAAW,CAAC,EAAE,SAAS,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,yBACf,SAAQ,uCAAuC;IAC/C;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,OAAO,WAAW,CAAC,SAAS,CAAC,KAAK,CAAC;IAClD;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,SAAS,CAAC;IACzB,kBAAkB,CAAC,EAAE,SAAS,CAAC;IAC/B,QAAQ,CAAC,4BAA4B,CAAC,EAAE,KAAK,CAAC;CAC/C;AAED;;;;;;GAMG;AACH,MAAM,WAAW,4BACf,SAAQ,uCAAuC;IAC/C;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,OAAO,WAAW,CAAC,SAAS,CAAC,KAAK,CAAC;IAClD;;OAEG;IACH,QAAQ,CAAC,4BAA4B,EAAE,IAAI,CAAC;IAC5C;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,OAAO,WAAW,CAAC,WAAW,CAAC,GAAG,CAAC;IACzD;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,UAAU,CAAC,EAAE,KAAK,CAAC;IACnB,mBAAmB,CAAC,EAAE,OAAO,WAAW,CAAC,mBAAmB,CAAC,EAAE,CAAC;IAChE,YAAY,CAAC,EAAE,SAAS,CAAC;IACzB,kBAAkB,CAAC,EAAE,SAAS,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,0BACf,SAAQ,uCAAuC;IAC/C;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,OAAO,WAAW,CAAC,SAAS,CAAC,MAAM,CAAC;IACnD,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,WAAW,CAAC,EAAE,SAAS,CAAC;IACxB,YAAY,CAAC,EAAE,SAAS,CAAC;IACzB,kBAAkB,CAAC,EAAE,SAAS,CAAC;IAC/B,4BAA4B,CAAC,EAAE,KAAK,CAAC;CACtC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,6BACf,SAAQ,uCAAuC;IAC/C;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,OAAO,WAAW,CAAC,SAAS,CAAC,MAAM,CAAC;IACnD;;OAEG;IACH,QAAQ,CAAC,4BAA4B,EAAE,IAAI,CAAC;IAC5C,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,WAAW,CAAC,EAAE,SAAS,CAAC;IACxB,UAAU,CAAC,EAAE,KAAK,CAAC;IACnB,mBAAmB,CAAC,EAAE,OAAO,WAAW,CAAC,mBAAmB,CAAC,EAAE,CAAC;IAChE,YAAY,CAAC,EAAE,SAAS,CAAC;IACzB,kBAAkB,CAAC,EAAE,SAAS,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,kCACf,SAAQ,oCAAoC;IAC5C,QAAQ,CAAC,IAAI,EAAE,OAAO,WAAW,CAAC,SAAS,CAAC,cAAc,CAAC;IAC3D,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,WAAW,CAAC,EAAE,SAAS,CAAC;IAExB,YAAY,CAAC,EAAE,SAAS,CAAC;IACzB,4BAA4B,CAAC,EAAE,KAAK,CAAC;CACtC;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,iCACf,SAAQ,oCAAoC;IAC5C;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,OAAO,WAAW,CAAC,SAAS,CAAC,aAAa,CAAC;IAC1D;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,SAAS,CAAC;IACzB,4BAA4B,CAAC,EAAE,KAAK,CAAC;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,oCACf,SAAQ,oCAAoC;IAC5C;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,OAAO,WAAW,CAAC,SAAS,CAAC,gBAAgB,CAAC;IAC7D,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,WAAW,CAAC,EAAE,SAAS,CAAC;IACxB,YAAY,CAAC,EAAE,SAAS,CAAC;IACzB,kBAAkB,CAAC,EAAE,SAAS,CAAC;IAC/B,4BAA4B,CAAC,EAAE,KAAK,CAAC;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,mCACf,SAAQ,oCAAoC;IAC5C;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,OAAO,WAAW,CAAC,SAAS,CAAC,eAAe,CAAC;IAC5D;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,SAAS,CAAC;IACzB,kBAAkB,CAAC,EAAE,SAAS,CAAC;IAC/B,4BAA4B,CAAC,EAAE,KAAK,CAAC;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,sCACf,SAAQ,oCAAoC;IAC5C;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,OAAO,WAAW,CAAC,SAAS,CAAC,kBAAkB,CAAC;IAC/D;;OAEG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAC/B,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,WAAW,CAAC,EAAE,SAAS,CAAC;IACxB,4BAA4B,CAAC,EAAE,KAAK,CAAC;CACtC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,MAAM,gBAAgB,GACxB,yBAAyB,GACzB,0BAA0B,GAC1B,kCAAkC,GAClC,iCAAiC,GACjC,oCAAoC,GACpC,mCAAmC,GACnC,sCAAsC,GACtC,4BAA4B,GAC5B,6BAA6B,CAAC;AAElC;;GAEG;AACH,MAAM,MAAM,sBAAsB,CAAC,CAAC,SAAS,WAAW,CAAC,SAAS,IAAI,OAAO,CAC3E,gBAAgB,EAChB;IAAE,IAAI,EAAE,CAAC,CAAA;CAAE,CACZ,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG,OAAO,CAChD,gBAAgB,EAChB;IAAE,IAAI,EAAE,OAAO,GAAG,GAAG,MAAM,OAAO,CAAA;CAAE,CACrC,CAAC;AAEF,MAAM,MAAM,6BAA6B,GAAG,OAAO,CACjD,gBAAgB,EAChB;IAAE,IAAI,EAAE,QAAQ,GAAG,GAAG,MAAM,QAAQ,CAAA;CAAE,CACvC,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG,OAAO,CAC3C,gBAAgB,EAChB;IAAE,4BAA4B,EAAE,IAAI,CAAA;CAAE,CACvC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,4BAA4B,GACtC,wBAAwB,CAAC,gBAAgB,CAAC,CAAC"}

package/dist/types/rest/endpoints/CreateOrder.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/rest/endpoints/GetAuthenticationToken.d.ts

@@ -0,0 +1,39 @@
+import type { RestRequestByWallet } from '#index';
+/**
+ * Returns a single-use authentication token for access to private subscriptions in the WebSocket API.
+ *
+ * @see typedoc [Reference Documentation](https://sdk-js-docs-v1-perps.katana.network/interfaces/RestRequestGetAuthenticationToken.html)
+ * @see response {@link RestResponseGetAuthenticationToken}
+ * @see type {@link KatanaPerpsWebSocketToken}
+ *
+ * @category KatanaPerps - Get WebSocket Token
+ */
+export interface RestRequestGetAuthenticationToken extends RestRequestByWallet {
+}
+/**
+ * Returns a single-use authentication token for access to private subscriptions in the WebSocket API.
+ *
+ * @see [API Documentation](https://api-docs-v1-perps.katana.network/#get-authentication-token)
+ * @see request {@link RestRequestGetAuthenticationToken}
+ * @see response {@link RestResponseGetAuthenticationToken}
+ *
+ * @category KatanaPerps Interfaces
+ * @category KatanaPerps - Get WebSocket Token
+ */
+export interface KatanaPerpsWebSocketToken {
+    /**
+     * WebSocket subscription authentication token
+     */
+    token: string;
+}
+/**
+ * Returns a single-use authentication token for access to private subscriptions in the WebSocket API.
+ *
+ * @see [API Documentation](https://api-docs-v1-perps.katana.network/#get-authentication-token)
+ * @see type {@link KatanaPerpsWebSocketToken}
+ * @see request {@link RestRequestGetAuthenticationToken}
+ *
+ * @category KatanaPerps - Get WebSocket Token
+ */
+export type RestResponseGetAuthenticationToken = KatanaPerpsWebSocketToken;
+//# sourceMappingURL=GetAuthenticationToken.d.ts.map

package/dist/types/rest/endpoints/GetAuthenticationToken.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GetAuthenticationToken.d.ts","sourceRoot":"","sources":["../../../../src/types/rest/endpoints/GetAuthenticationToken.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,QAAQ,CAAC;AAElD;;;;;;;;GAQG;AACH,MAAM,WAAW,iCACf,SAAQ,mBAAmB;CAAG;AAIhC;;;;;;;;;GASG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,kCAAkC,GAAG,yBAAyB,CAAC"}

package/dist/types/rest/endpoints/GetAuthenticationToken.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });