@katanaperps/katana-perps-sdk 0.0.0-placeholder

package/dist/types/enums/signature.d.ts

@@ -0,0 +1,118 @@
+/**
+ * @internal
+ */
+export declare enum EthTransactionStatus {
+    /**
+     * Either not yet submitted or not yet mined
+     */
+    pending = 0,
+    /**
+     * Mined, no need for any block confirmation delay
+     */
+    mined = 1,
+    /**
+     * Transaction reverted
+     */
+    failed = 2
+}
+/**
+ * @internal
+ */
+export declare enum ManagedAccountWithdrawalType {
+    /**
+     * Withdraw by quantity
+     */
+    byQuantity = 0,
+    /**
+     * Withdraw by shares
+     */
+    byShares = 1
+}
+/**
+ * @internal
+ */
+export declare enum MarketType {
+    /**
+     * Orderbook trades accepted
+     */
+    perpetual = 0
+}
+/**
+ * @internal
+ */
+export declare enum OrderSelfTradePreventionSigEnum {
+    /**
+     * Decrement And Cancel (DC) - When two orders from the same user cross, the smaller order will
+     * be canceled and the larger order size will be decremented by the smaller order size. If the two
+     * orders are the same size, both will be canceled.
+     */
+    dc = 0,
+    /**
+     * Cancel Oldest (CO) - Cancel the older (maker) order in full
+     */
+    co = 1,
+    /**
+     * Cancel Newest (CN) - Cancel the newer, taker order and leave the older, resting order on the
+     * order book. This is the only valid option when time-in-force is set to fill or kill
+     */
+    cn = 2,
+    /**
+     * Cancel Both (CB) - Cancel both orders
+     */
+    cb = 3
+}
+/**
+ * @internal
+ */
+export declare enum OrderSideSigEnum {
+    buy = 0,
+    sell = 1
+}
+/**
+ * @internal
+ */
+export declare enum OrderTimeInForceSigEnum {
+    /**
+     * Good until canceled (default)
+     */
+    gtc = 0,
+    /**
+     * Good until crossing
+     */
+    gtx = 1,
+    /**
+     * Immediate or cancel
+     */
+    ioc = 2,
+    /**
+     * Fill or kill
+     */
+    fok = 3
+}
+/**
+ * @internal
+ */
+export declare enum OrderTriggerTypeSigEnum {
+    none = 0,
+    last = 1,
+    index = 2
+}
+/**
+ * @internal
+ */
+export declare enum OrderTypeSigEnum {
+    market = 0,
+    limit = 1,
+    stopLossMarket = 2,
+    stopLossLimit = 3,
+    takeProfitMarket = 4,
+    takeProfitLimit = 5,
+    trailingStopMarket = 6
+}
+/**
+ * @internal
+ */
+export declare enum TradeType {
+    orderBook = 0
+}
+//# sourceMappingURL=signature.d.ts.map

package/dist/types/enums/signature.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"signature.d.ts","sourceRoot":"","sources":["../../../src/types/enums/signature.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,oBAAY,oBAAoB;IAC9B;;OAEG;IACH,OAAO,IAAA;IACP;;OAEG;IACH,KAAK,IAAA;IACL;;OAEG;IACH,MAAM,IAAA;CACP;AAED;;GAEG;AACH,oBAAY,4BAA4B;IACtC;;OAEG;IACH,UAAU,IAAA;IACV;;OAEG;IACH,QAAQ,IAAA;CACT;AAED;;GAEG;AACH,oBAAY,UAAU;IACpB;;OAEG;IACH,SAAS,IAAA;CACV;AAED;;GAEG;AACH,oBAAY,+BAA+B;IACzC;;;;OAIG;IACH,EAAE,IAAA;IACF;;OAEG;IACH,EAAE,IAAA;IACF;;;OAGG;IACH,EAAE,IAAA;IACF;;OAEG;IACH,EAAE,IAAA;CACH;AAED;;GAEG;AACH,oBAAY,gBAAgB;IAC1B,GAAG,IAAA;IACH,IAAI,IAAA;CACL;AAED;;GAEG;AACH,oBAAY,uBAAuB;IACjC;;OAEG;IACH,GAAG,IAAA;IACH;;OAEG;IACH,GAAG,IAAA;IACH;;OAEG;IACH,GAAG,IAAA;IACH;;OAEG;IACH,GAAG,IAAA;CACJ;AAED;;GAEG;AACH,oBAAY,uBAAuB;IACjC,IAAI,IAAA;IACJ,IAAI,IAAA;IACJ,KAAK,IAAA;CACN;AAED;;GAEG;AACH,oBAAY,gBAAgB;IAC1B,MAAM,IAAA;IACN,KAAK,IAAA;IACL,cAAc,IAAA;IACd,aAAa,IAAA;IACb,gBAAgB,IAAA;IAChB,eAAe,IAAA;IACf,kBAAkB,IAAA;CAGnB;AAED;;GAEG;AACH,oBAAY,SAAS;IACnB,SAAS,IAAA;CACV"}

package/dist/types/enums/signature.js

@@ -0,0 +1,131 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TradeType = exports.OrderTypeSigEnum = exports.OrderTriggerTypeSigEnum = exports.OrderTimeInForceSigEnum = exports.OrderSideSigEnum = exports.OrderSelfTradePreventionSigEnum = exports.MarketType = exports.ManagedAccountWithdrawalType = exports.EthTransactionStatus = void 0;
+/**
+ * @internal
+ */
+var EthTransactionStatus;
+(function (EthTransactionStatus) {
+    /**
+     * Either not yet submitted or not yet mined
+     */
+    EthTransactionStatus[EthTransactionStatus["pending"] = 0] = "pending";
+    /**
+     * Mined, no need for any block confirmation delay
+     */
+    EthTransactionStatus[EthTransactionStatus["mined"] = 1] = "mined";
+    /**
+     * Transaction reverted
+     */
+    EthTransactionStatus[EthTransactionStatus["failed"] = 2] = "failed";
+})(EthTransactionStatus || (exports.EthTransactionStatus = EthTransactionStatus = {}));
+/**
+ * @internal
+ */
+var ManagedAccountWithdrawalType;
+(function (ManagedAccountWithdrawalType) {
+    /**
+     * Withdraw by quantity
+     */
+    ManagedAccountWithdrawalType[ManagedAccountWithdrawalType["byQuantity"] = 0] = "byQuantity";
+    /**
+     * Withdraw by shares
+     */
+    ManagedAccountWithdrawalType[ManagedAccountWithdrawalType["byShares"] = 1] = "byShares";
+})(ManagedAccountWithdrawalType || (exports.ManagedAccountWithdrawalType = ManagedAccountWithdrawalType = {}));
+/**
+ * @internal
+ */
+var MarketType;
+(function (MarketType) {
+    /**
+     * Orderbook trades accepted
+     */
+    MarketType[MarketType["perpetual"] = 0] = "perpetual";
+})(MarketType || (exports.MarketType = MarketType = {}));
+/**
+ * @internal
+ */
+var OrderSelfTradePreventionSigEnum;
+(function (OrderSelfTradePreventionSigEnum) {
+    /**
+     * Decrement And Cancel (DC) - When two orders from the same user cross, the smaller order will
+     * be canceled and the larger order size will be decremented by the smaller order size. If the two
+     * orders are the same size, both will be canceled.
+     */
+    OrderSelfTradePreventionSigEnum[OrderSelfTradePreventionSigEnum["dc"] = 0] = "dc";
+    /**
+     * Cancel Oldest (CO) - Cancel the older (maker) order in full
+     */
+    OrderSelfTradePreventionSigEnum[OrderSelfTradePreventionSigEnum["co"] = 1] = "co";
+    /**
+     * Cancel Newest (CN) - Cancel the newer, taker order and leave the older, resting order on the
+     * order book. This is the only valid option when time-in-force is set to fill or kill
+     */
+    OrderSelfTradePreventionSigEnum[OrderSelfTradePreventionSigEnum["cn"] = 2] = "cn";
+    /**
+     * Cancel Both (CB) - Cancel both orders
+     */
+    OrderSelfTradePreventionSigEnum[OrderSelfTradePreventionSigEnum["cb"] = 3] = "cb";
+})(OrderSelfTradePreventionSigEnum || (exports.OrderSelfTradePreventionSigEnum = OrderSelfTradePreventionSigEnum = {}));
+/**
+ * @internal
+ */
+var OrderSideSigEnum;
+(function (OrderSideSigEnum) {
+    OrderSideSigEnum[OrderSideSigEnum["buy"] = 0] = "buy";
+    OrderSideSigEnum[OrderSideSigEnum["sell"] = 1] = "sell";
+})(OrderSideSigEnum || (exports.OrderSideSigEnum = OrderSideSigEnum = {}));
+/**
+ * @internal
+ */
+var OrderTimeInForceSigEnum;
+(function (OrderTimeInForceSigEnum) {
+    /**
+     * Good until canceled (default)
+     */
+    OrderTimeInForceSigEnum[OrderTimeInForceSigEnum["gtc"] = 0] = "gtc";
+    /**
+     * Good until crossing
+     */
+    OrderTimeInForceSigEnum[OrderTimeInForceSigEnum["gtx"] = 1] = "gtx";
+    /**
+     * Immediate or cancel
+     */
+    OrderTimeInForceSigEnum[OrderTimeInForceSigEnum["ioc"] = 2] = "ioc";
+    /**
+     * Fill or kill
+     */
+    OrderTimeInForceSigEnum[OrderTimeInForceSigEnum["fok"] = 3] = "fok";
+})(OrderTimeInForceSigEnum || (exports.OrderTimeInForceSigEnum = OrderTimeInForceSigEnum = {}));
+/**
+ * @internal
+ */
+var OrderTriggerTypeSigEnum;
+(function (OrderTriggerTypeSigEnum) {
+    OrderTriggerTypeSigEnum[OrderTriggerTypeSigEnum["none"] = 0] = "none";
+    OrderTriggerTypeSigEnum[OrderTriggerTypeSigEnum["last"] = 1] = "last";
+    OrderTriggerTypeSigEnum[OrderTriggerTypeSigEnum["index"] = 2] = "index";
+})(OrderTriggerTypeSigEnum || (exports.OrderTriggerTypeSigEnum = OrderTriggerTypeSigEnum = {}));
+/**
+ * @internal
+ */
+var OrderTypeSigEnum;
+(function (OrderTypeSigEnum) {
+    OrderTypeSigEnum[OrderTypeSigEnum["market"] = 0] = "market";
+    OrderTypeSigEnum[OrderTypeSigEnum["limit"] = 1] = "limit";
+    OrderTypeSigEnum[OrderTypeSigEnum["stopLossMarket"] = 2] = "stopLossMarket";
+    OrderTypeSigEnum[OrderTypeSigEnum["stopLossLimit"] = 3] = "stopLossLimit";
+    OrderTypeSigEnum[OrderTypeSigEnum["takeProfitMarket"] = 4] = "takeProfitMarket";
+    OrderTypeSigEnum[OrderTypeSigEnum["takeProfitLimit"] = 5] = "takeProfitLimit";
+    OrderTypeSigEnum[OrderTypeSigEnum["trailingStopMarket"] = 6] = "trailingStopMarket";
+    // NOTE: WebSocket also uses liquidation and deleverage
+    //       these are represented in the value-based enums
+})(OrderTypeSigEnum || (exports.OrderTypeSigEnum = OrderTypeSigEnum = {}));
+/**
+ * @internal
+ */
+var TradeType;
+(function (TradeType) {
+    TradeType[TradeType["orderBook"] = 0] = "orderBook";
+})(TradeType || (exports.TradeType = TradeType = {}));

package/dist/types/errors.d.ts

@@ -0,0 +1,5 @@
+/**
+ * The possible error short codes when interacting with the Katana Perps API's.
+ */
+export type ErrorShortCodes = 'TOKEN_NOT_FOUND' | 'ORDER_NOT_FOUND' | 'MARKET_NOT_FOUND' | 'DEPOSIT_NOT_FOUND' | 'WITHDRAWAL_NOT_FOUND' | 'FILL_NOT_FOUND' | 'USER_NOT_FOUND' | 'ENDPOINT_NOT_FOUND' | 'EXCEEDED_RATE_LIMIT' | 'INSUFFICIENT_FUNDS' | 'USER_MIGRATION_REQUIRED' | 'WALLET_NOT_ASSOCIATED' | 'EMAIL_VERIFICATION_REQUIRED' | 'INVALID_WALLET_SIGNATURE' | 'INVALID_API_KEY' | 'REQUIRED_API_KEY' | 'INVALID_HMAC_SIGNATURE' | 'REQUIRED_HMAC_SIGNATURE' | 'REQUIRED_API_KEY_READ_SCOPE' | 'REQUIRED_API_KEY_TRADE_SCOPE' | 'REQUIRED_API_KEY_WITHDRAW_SCOPE' | 'TRADING_RESTRICTED_FOR_LOCATION' | 'EXCEEDED_WITHDRAWAL_LIMIT' | 'CANCELS_DISABLED' | 'TRADING_DISABLED' | 'WITHDRAWALS_DISABLED' | 'INTERNAL_SERVER_ERROR' | 'BAD_REQUEST' | 'SERVICE_UNAVAILABLE' | 'INVALID_API_VERSION' | 'REQUIRED_PARAMETER' | 'INVALID_PARAMETER' | 'INVALID_WITHDRAWAL_QUANTITY' | 'INVALID_ORDER_QUANTITY' | 'UNAUTHORIZED_LPP_WALLET';
+//# sourceMappingURL=errors.d.ts.map

package/dist/types/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/types/errors.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,eAAe,GACvB,iBAAiB,GACjB,iBAAiB,GACjB,kBAAkB,GAClB,mBAAmB,GACnB,sBAAsB,GACtB,gBAAgB,GAChB,gBAAgB,GAChB,oBAAoB,GACpB,qBAAqB,GACrB,oBAAoB,GACpB,yBAAyB,GACzB,uBAAuB,GACvB,6BAA6B,GAC7B,0BAA0B,GAC1B,iBAAiB,GACjB,kBAAkB,GAClB,wBAAwB,GACxB,yBAAyB,GACzB,6BAA6B,GAC7B,8BAA8B,GAC9B,iCAAiC,GACjC,iCAAiC,GACjC,2BAA2B,GAC3B,kBAAkB,GAClB,kBAAkB,GAClB,sBAAsB,GACtB,uBAAuB,GACvB,aAAa,GACb,qBAAqB,GACrB,qBAAqB,GACrB,oBAAoB,GACpB,mBAAmB,GACnB,6BAA6B,GAC7B,wBAAwB,GACxB,yBAAyB,CAAC"}

package/dist/types/errors.js

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

package/dist/types/index.d.ts

@@ -0,0 +1,9 @@
+export * from '#types/delegatedKeys';
+export * from '#types/enums/index';
+export * from '#types/errors';
+export * from '#types/orderBook';
+export * from '#types/rest/index';
+export * from '#types/swaps';
+export * from '#types/webSocket/index';
+export type { Paginated, Expand, ExpandDeep } from '#types/utils';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,cAAc,CAAC;AAC7B,cAAc,wBAAwB,CAAC;AACvC,YAAY,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC"}

package/dist/types/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("#types/delegatedKeys"), exports);
+tslib_1.__exportStar(require("#types/enums/index"), exports);
+tslib_1.__exportStar(require("#types/errors"), exports);
+tslib_1.__exportStar(require("#types/orderBook"), exports);
+tslib_1.__exportStar(require("#types/rest/index"), exports);
+tslib_1.__exportStar(require("#types/swaps"), exports);
+tslib_1.__exportStar(require("#types/webSocket/index"), exports);

package/dist/types/orderBook.d.ts

@@ -0,0 +1,72 @@
+import type { OrderBookLevelType } from '#types/enums/response';
+interface OrderBookBase {
+    /**
+     * Most recent order book update sequence number reflected in the returned snapshot
+     */
+    sequence: number;
+    /**
+     * Price of the last trade in quote terms
+     */
+    lastPrice: string | null;
+    /**
+     * Mark price
+     */
+    markPrice: string | null;
+    /**
+     * Index price
+     */
+    indexPrice: string | null;
+    bids: OrderBookLevelL1 | OrderBookLevelL2[];
+    asks: OrderBookLevelL1 | OrderBookLevelL2[];
+}
+/**
+ *
+ *
+ */
+export type BestAvailablePriceLevels = {
+    buyPrice: bigint;
+    sellPrice: bigint;
+};
+/**
+ * Level-1 order book data is limited to the best bid and ask for a market, including hybrid liquidity synthetic price levels.
+ *
+ * @see {@link https://api-docs-v1-perps.katana.network/#get-order-books API Documentation}
+ */
+export interface L1OrderBook extends OrderBookBase {
+    asks: OrderBookLevelL1;
+    bids: OrderBookLevelL1;
+}
+/**
+ * Level-2 order book data includes price and quantity information for all price levels in the order book.
+ *
+ * @see {@link https://api-docs-v1-perps.katana.network/#get-order-books API Documentation}
+ */
+export interface L2OrderBook extends OrderBookBase {
+    asks: OrderBookLevelL2[];
+    bids: OrderBookLevelL2[];
+}
+/**
+ *
+ */
+export type OrderBookFeesAndMinimums = {
+    /**
+     * Minimum order size that is accepted by the matching engine for execution in MATIC, applies to both MATIC and tokens
+     */
+    takerTradeMinimum: string;
+};
+/**
+ *
+ */
+export interface OrderBookLevelL1 {
+    price: bigint;
+    size: bigint;
+    numOrders: number;
+}
+/**
+ *
+ */
+export interface OrderBookLevelL2 extends OrderBookLevelL1 {
+    type: OrderBookLevelType;
+}
+export {};
+//# sourceMappingURL=orderBook.d.ts.map

package/dist/types/orderBook.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"orderBook.d.ts","sourceRoot":"","sources":["../../src/types/orderBook.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAEhE,UAAU,aAAa;IACrB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,IAAI,EAAE,gBAAgB,GAAG,gBAAgB,EAAE,CAAC;IAC5C,IAAI,EAAE,gBAAgB,GAAG,gBAAgB,EAAE,CAAC;CAC7C;AAED;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,WAAY,SAAQ,aAAa;IAChD,IAAI,EAAE,gBAAgB,CAAC;IACvB,IAAI,EAAE,gBAAgB,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAY,SAAQ,aAAa;IAChD,IAAI,EAAE,gBAAgB,EAAE,CAAC;IACzB,IAAI,EAAE,gBAAgB,EAAE,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,gBAAgB;IACxD,IAAI,EAAE,kBAAkB,CAAC;CAC1B"}

package/dist/types/orderBook.js

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

package/dist/types/rest/common/common.d.ts

@@ -0,0 +1,118 @@
+/**
+ * [[include:base.md]]
+ *
+ * @see related {@link RestRequestByWallet}
+ * @category Base Types
+ */
+export interface RestRequestByWalletOptional {
+    /**
+     * User data and trade endpoints requests must include a nonce.
+     *
+     * - **MUST** be a [version 1 UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address))
+     * - Nonces may be supplied `with` or `without` hyphens.
+     *
+     * @remarks Version 1 UUIDs encode a timestamp in addition to other unique information, and thus serve both
+     *          to prevent replay attacks as well as to enforce request timing. As a result, nonces **MUST** be generated
+     *          at the time of a request.
+     *
+     */
+    nonce: string;
+    /**
+     * The wallet address to use for the request.
+     */
+    wallet?: string;
+}
+/**
+ * [[include:base.md]]
+ *
+ * @see related {@link RestRequestByWalletOptional}
+ * @category Base Types
+ * @interface
+ */
+export type RestRequestByWallet = Required<RestRequestByWalletOptional>;
+/**
+ * [[include:base.md]]
+ *
+ * @see related {@link RestRequestByMarket}
+ * @category Base Types
+ */
+export interface RestRequestByMarketOptional {
+    /**
+     * Base-quote pair e.g. 'ETH-USD'
+     */
+    market?: string;
+}
+/**
+ * [[include:base.md]]
+ *
+ * @see related {@link RestRequestByMarketOptional}
+ * @category Base Types
+ * @interface
+ */
+export type RestRequestByMarket = Required<RestRequestByMarketOptional>;
+/**
+ * [[include:base.md]]
+ *
+ * Any combination of `start`, `end`, `limit` are valid, but **certain values
+ * take precedence over others.** For example,
+ *
+ * - if {@link start} and {@link end} **ARE** specified and **NOT** {@link limit}:
+ *   - the response will include objects starting at {@link start} and ending either at
+ *     {@link end} or the maximum {@link limit} of 1,000 objects.
+ * - If {@link end} is specified alone:
+ *   - returns `50` objects closest to, but **EARLIER** (older) than {@link end}.
+ * - Specifying **NONE** of the pagination parameters returns
+ *   the _50 most recent objects_.
+ *
+ * Response data is returned in ascending time order, with oldest objects first and newest objects last.
+ *
+ * @see related {@link RestRequestPaginationWithFromId}
+ *
+ * @category Base Types
+ */
+export interface RestRequestPagination {
+    /**
+     * If provided, indicates the earliest (oldest) timestamp of an object
+     * to include in the response.
+     *
+     * - This value is **inclusive**, meaning objects with timestamps that exactly
+     *   match `start` are included in the response.
+     * - `start` **MUST** be earlier than {@link end} if provided.
+     */
+    start?: number;
+    /**
+     * If provided, indicates the latest (newest) timestamp of an object to include
+     * the response.
+     *
+     * - This value is **inclusive**, meaning objects with timestamps that exactly
+     *   match `end` are included in the response.
+     * - `end` **MUST** be a later timestamp than {@link start}.
+     */
+    end?: number;
+    /**
+     * Maximum number to return of the requested type.
+     */
+    limit?: number;
+    /**
+     * - This is an internal undocumented parameter and is not available using the public API.
+     * - Using this parameter will likely result in your request returning an error.
+     *
+     * @internal
+     */
+    page?: number;
+}
+/**
+ * @inheritDoc
+ *
+ * @see related {@link RestRequestPagination}
+ * @category Base Types
+ */
+export interface RestRequestPaginationWithFromId extends RestRequestPagination {
+    /**
+     * Identifier of the earliest (oldest) of the requested type.
+     *
+     * - {@link fromId}, takes precedence over {@link start}.
+     */
+    fromId?: string;
+}
+//# sourceMappingURL=common.d.ts.map

package/dist/types/rest/common/common.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../../../src/types/rest/common/common.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;;;;;;;;;OAUG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;GAMG;AACH,MAAM,MAAM,mBAAmB,GAAG,QAAQ,CAAC,2BAA2B,CAAC,CAAC;AAExE;;;;;GAKG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;GAMG;AACH,MAAM,MAAM,mBAAmB,GAAG,QAAQ,CAAC,2BAA2B,CAAC,CAAC;AAExE;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;;;;;OAOG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;;;;OAOG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;;;;GAKG;AACH,MAAM,WAAW,+BAAgC,SAAQ,qBAAqB;IAC5E;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}

package/dist/types/rest/common/common.js

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

package/dist/types/rest/common/guards.d.ts

@@ -0,0 +1,8 @@
+import { CandleInterval } from '#types/enums/request';
+/**
+ * @see {@link RestRequestCancelOrdersByMarket}
+ *
+ * @internal
+ */
+export declare function isCandleInterval(value: unknown): value is CandleInterval;
+//# sourceMappingURL=guards.d.ts.map

package/dist/types/rest/common/guards.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"guards.d.ts","sourceRoot":"","sources":["../../../../src/types/rest/common/guards.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAItD;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,cAAc,CAExE"}

package/dist/types/rest/common/guards.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isCandleInterval = void 0;
+const request_1 = require("#types/enums/request");
+const intervals = Object.values(request_1.CandleInterval);
+/**
+ * @see {@link RestRequestCancelOrdersByMarket}
+ *
+ * @internal
+ */
+function isCandleInterval(value) {
+    return intervals.includes(value);
+}
+exports.isCandleInterval = isCandleInterval;

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

@@ -0,0 +1,40 @@
+import type { RestRequestWithSignature } from '#types/utils';
+import type { KatanaPerpsWallet, RestRequestByWallet } from '@katanaperps/katana-perps-sdk/types';
+/**
+ * Associate a wallet with the authenticated account.
+ *
+ * @category KatanaPerps - Associate Wallet
+ *
+ * @see response {@link RestResponseAssociateWallet}
+ * @see type     {@link KatanaPerpsWallet}
+ */
+export interface RestRequestAssociateWallet extends RestRequestByWallet {
+    /**
+     * - The wallet to associate with the authenticated account.
+     *
+     * @inheritDoc
+     */
+    wallet: string;
+}
+/**
+ * The raw request body for the `POST /v1/wallets` endpoint
+ * including `signature` and the body in `parameters`.
+ *
+ * @internal
+ */
+export type RestRequestAssociateWalletSigned = {
+    /**
+     * - Referral code. Required when associating a wallet for the first time
+     */
+    referralCode?: string;
+} | RestRequestWithSignature<RestRequestAssociateWallet>;
+/**
+ * The response to a request to associate a wallet.
+ *
+ * @category KatanaPerps - Associate Wallet
+ *
+ * @see request {@link RestRequestAssociateWallet}
+ * @see type    {@link KatanaPerpsWallet}
+ */
+export type RestResponseAssociateWallet = KatanaPerpsWallet;
+//# sourceMappingURL=AssociateWallet.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"AssociateWallet.d.ts","sourceRoot":"","sources":["../../../../src/types/rest/endpoints/AssociateWallet.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAC;AAC7D,OAAO,KAAK,EACV,iBAAiB,EACjB,mBAAmB,EACpB,MAAM,qCAAqC,CAAC;AAE7C;;;;;;;GAOG;AACH,MAAM,WAAW,0BAA2B,SAAQ,mBAAmB;IACrE;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;;GAKG;AACH,MAAM,MAAM,gCAAgC,GACxC;IACE;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,GACD,wBAAwB,CAAC,0BAA0B,CAAC,CAAC;AAEzD;;;;;;;GAOG;AACH,MAAM,MAAM,2BAA2B,GAAG,iBAAiB,CAAC"}

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

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