@katanaperps/katana-perps-sdk 0.0.0-placeholder

package/dist/client/rest/authenticated.d.ts

@@ -0,0 +1,1199 @@
+import Axios from 'axios';
+import { INTERNAL_SYMBOL } from '#utils';
+import type * as katanaPerps from '#index';
+import type { AnyObj } from '#types/utils';
+import type { AxiosInstance, AxiosRequestConfig, CreateAxiosDefaults } from 'axios';
+/**
+ * Authenticated API client configuration options.
+ *
+ * @example
+ * ```typescript
+ * import { RestAuthenticatedClient } from '@katanaperps/katana-perps-sdk';
+ *
+ * // Edit the values before for your environment
+ * const authenticatedClient = new RestAuthenticatedClient({
+ *   sandbox: false,
+ *   apiKey: '1f7c4f52-4af7-4e1b-aa94-94fac8d931aa',
+ *   apiSecret: 'axuh3ywgg854aq7m73oy6gnnpj5ar9a67szuw5lclbz77zqu0j',
+ *   walletPrivateKey: '0x...'
+ * });
+ * ```
+ *
+ * <br />
+ *
+ * ---
+ *
+ * @see typedoc  [Reference Documentation](https://sdk-js-docs-v1-perps.katana.network/interfaces/RestAuthenticatedClientOptions.html)
+ * @see client   {@link RestAuthenticatedClient}
+ *
+ * @category API Clients
+ */
+export interface RestAuthenticatedClientOptions {
+    /**
+     * - Used to authenticate the requesting user making requests to the API.
+     */
+    apiKey: string;
+    /**
+     * - Used to compute HMAC signature for authenticated requests
+     */
+    apiSecret: string;
+    /**
+     * The private key for the wallet making requests to the API.
+     *
+     * **Note:** This should always be provided except in advanced use case scenarios.
+     *
+     * - When **provided**, used to create ECDSA signatures for authenticated requests automatically.
+     * - When **not provided**, must provider your own {@link katanaperps.SignTypedData signer} to sign requests
+     *   that require an ECDSA signature.
+     */
+    walletPrivateKey?: string;
+    /**
+     * - If `true`, the client will point to [Katana Perps Sandbox API](https;//api-docs-v1-perps.katana.network/#sandbox)
+     * - If not provided or `false`, will point to the Katana Perps Production API.
+     *
+     * @defaultValue false
+     */
+    sandbox?: boolean;
+    /**
+     * - Optionally provide a custom baseURL to use instead of the automatically
+     *   derived value based on the {@link sandbox} option.
+     *
+     * @internal
+     */
+    baseURL?: string;
+    /**
+     * **Optionally** provide the `exchangeContractAddress` as returned by the public clients
+     * {@link RestPublicClient.getExchange getExchange} response's
+     * {@link katanaperps.KatanaPerpsExchange.exchangeContractAddress exchangeContractAddress} property.
+     *
+     * - If not provided, this will be fetched and cached automatically from the public client before
+     *   making the first request which requires it.
+     *
+     * @internal
+     */
+    exchangeContractAddress?: string;
+    /**
+     * Optionally provide the `chainId` as returned by the public clients
+     * {@link RestPublicClient.getExchange getExchange} response's
+     * {@link katanaperps.KatanaPerpsExchange.chainId chainId} property.
+     *
+     * - If not provided, this will be fetched and cached automatically from the public client before
+     *   making the first request which requires it.
+     *
+     * @internal
+     */
+    chainId?: number;
+    /**
+     * Optionally provide the `bridgeAdapterContractAddress` as returned by the public clients
+     * {@link RestPublicClient.getExchange getExchange} response's
+     * {@link katanaperps.KatanaPerpsExchange.bridgeAdapterContractAddress bridgeAdapterContractAddress}
+     * property.
+     *
+     * - If not provided, this will be fetched and cached automatically from the public client before
+     *   making the first request which requires it.
+     *
+     * @internal
+     */
+    bridgeAdapterContractAddress?: string;
+    /**
+     * - Changing this value will likely result in a broken client, internal use only.
+     *
+     * @defaultValue true
+     * @internal
+     */
+    autoCreateHmacHeader?: boolean;
+    /**
+     * - This is for internal use only and may not work as expected if used.
+     *
+     * @internal
+     */
+    axiosConfig?: CreateAxiosDefaults;
+}
+/**
+ * The {@link RestAuthenticatedClient} is used to make authenticated requests to the Katana Perps API.  It includes
+ * methods that make requests on behalf of a specific wallet such as creating and cancelling orders.
+ *
+ * - The client requires the following properties to automatically handle authentication
+ *   of requests:
+ *   - {@link RestAuthenticatedClientOptions.apiKey apiKey}
+ *   - {@link RestAuthenticatedClientOptions.apiSecret apiSecret}
+ *   - {@link RestAuthenticatedClientOptions.walletPrivateKey walletPrivateKey}
+ * - Optionally, a {@link RestAuthenticatedClientOptions.sandbox sandbox} option can
+ *   be set to `true` in order to point to the Katana Perps Sandbox API.
+ *
+ * @example
+ * ```typescript
+ * import { RestAuthenticatedClient } from '@katanaperps/katana-perps-sdk';
+ *
+ * // Edit the values before for your environment
+ * const authenticatedClient = new RestAuthenticatedClient({
+ *   sandbox: false,
+ *   apiKey: '1f7c4f52-4af7-4e1b-aa94-94fac8d931aa',
+ *   apiSecret: 'axuh3ywgg854aq7m73oy6gnnpj5ar9a67szuw5lclbz77zqu0j',
+ *   walletPrivateKey: '0x...'
+ * });
+ * ```
+ *
+ * <br />
+ *
+ * ---
+ *
+ * @see typedoc  [Reference Documentation](https://sdk-js-docs-v1-perps.katana.network/classes/RestAuthenticatedClient.html)
+ * @see options  {@link RestAuthenticatedClientOptions}
+ *
+ * @category API Clients
+ * @category KatanaPerps - Get Market Maker Rewards Epochs
+ * @category KatanaPerps - Get Wallets
+ * @category KatanaPerps - Get Positions
+ * @category KatanaPerps - Associate Wallet
+ * @category KatanaPerps - Create Order
+ * @category KatanaPerps - Cancel Order
+ * @category KatanaPerps - Get Orders
+ * @category KatanaPerps - Get Fills
+ * @category KatanaPerps - Get Payouts
+ * @category KatanaPerps - Authorize Payout
+ * @category KatanaPerps - Get Deposits
+ * @category KatanaPerps - Get Withdrawals
+ * @category KatanaPerps - Withdraw Funds
+ * @category KatanaPerps - Get Funding Payments
+ * @category KatanaPerps - Get Historical PnL
+ * @category KatanaPerps - Get WebSocket Token
+ */
+export declare class RestAuthenticatedClient {
+    #private;
+    /**
+     * When creating an authenticated client, a {@link katanaperps.RestPublicClient RestPublicClient} is automatically
+     * created and can be used based on the config given for this client.
+     *
+     * - Can be utilized to fetch public data instead of creating both clients.
+     * - Used when fetching the {@link katanaperps.KatanaPerpsExchange.exchangeContractAddress exchangeContractAddress}
+     *   and {@link katanaperps.KatanaPerpsExchange.chainId chainId} properties from the public client's
+     *   {@link RestPublicClient.getExchange getExchange} method.
+     *
+     * @example
+     * ```typescript
+     * import { RestAuthenticatedClient } from '@katanaperps/katana-perps-sdk';
+     *
+     * // Edit the values before for your environment
+     * const client = new RestAuthenticatedClient({
+     *   sandbox: true,
+     *   apiKey: '1f7c4f52-4af7-4e1b-aa94-94fac8d931aa',
+     *   apiSecret: 'axuh3ywgg854aq7m73oy6gnnpj5ar9a67szuw5lclbz77zqu0j',
+     *   walletPrivateKey: '0x...'
+     * });
+     *
+     * const wallets = await client.getWallets();
+     * ```
+     *
+     * <br />
+     *
+     * ---
+     *
+     * @see client {@link katanaperps.RestPublicClient RestPublicClient}
+     *
+     * @category Accessors
+     */
+    readonly public: katanaPerps.RestPublicClient;
+    readonly axios: AxiosInstance;
+    /**
+     * Gets the current configured options for the client.
+     *
+     * - The `baseURL` is automatically derived from the {@link sandbox} option during construction
+     *   unless a custom `baseURL` is given.
+     * - The `sandbox` will either default to `false` unless provided in the client constructor.
+     * - Both `exchangeContractAddress` and `chainId` use the provided values during construction
+     *   or are automatically fetched from the {@link public} client.
+     *
+     * @category Accessors
+     *
+     * @internal
+     */
+    get config(): Readonly<{
+        baseURL: string;
+        sandbox: boolean;
+        autoCreateHmacHeader: boolean;
+        exchangeContractAddress?: string | undefined;
+        chainId?: number | undefined;
+        bridgeAdapterContractAddress?: string | undefined;
+    }>;
+    /**
+     * The {@link RestAuthenticatedClient} is used to make authenticated requests to the Katana Perps API.  It includes
+     * methods that make requests on behalf of a specific wallet such as creating and cancelling orders.
+     *
+     * - The client requires the following properties to automatically handle authentication
+     *   of requests:
+     *   - {@link RestAuthenticatedClientOptions.apiKey apiKey}
+     *   - {@link RestAuthenticatedClientOptions.apiSecret apiSecret}
+     *   - {@link RestAuthenticatedClientOptions.walletPrivateKey walletPrivateKey}
+     * - Optionally, a {@link RestAuthenticatedClientOptions.sandbox sandbox} option can
+     *   be set to `true` in order to point to the Katana Perps Sandbox API.
+     *
+     * @example
+     * ```typescript
+     * import { RestAuthenticatedClient } from '@katanaperps/katana-perps-sdk';
+     *
+     * // Edit the values before for your environment
+     * const client = new RestAuthenticatedClient({
+     *   sandbox: true,
+     *   apiKey: '1f7c4f52-4af7-4e1b-aa94-94fac8d931aa',
+     *   apiSecret: 'axuh3ywgg854aq7m73oy6gnnpj5ar9a67szuw5lclbz77zqu0j',
+     *   walletPrivateKey: '0x...'
+     * });
+     *
+     * const wallets = await client.getWallets();
+     * ```
+     *
+     * <br />
+     *
+     * ---
+     *
+     * @see typedoc  [Reference Documentation](https://sdk-js-docs-v1-perps.katana.network/classes/WebSocketClient.html)
+     * @see options {@link RestAuthenticatedClientOptions}
+     *
+     * @category Constructor
+     */
+    constructor(options: RestAuthenticatedClientOptions);
+    /**
+     * <br />
+     *
+     * ---
+     * **Endpoint Parameters**
+     *
+     * > - HTTP Request:      `GET /v1/marketMakerRewardsV1/epoch`
+     * > - Endpoint Security: [User Data](https://api-docs-v1-perps.katana.network/#endpointSecurityUserData)
+     * > - API Key Scope:     [Read](https://api-docs-v1-perps.katana.network/#api-keys)
+     * ---
+     *
+     * <br />
+     *
+     * <details>
+     *  <summary><span style="font-size:1.4em;font-weight:bold;">About Overloads</span></summary>
+     *    <p>
+     *      This method has two overloads to provide type-safe responses:
+     *      <ul>
+     *      <li>
+     *        Calling this method with a {@link katanaperps.RestRequestGetMarketMakerRewardsEpochWithWallet.wallet wallet}
+     *        parameter returns {@link katanaperps.MarketMakerRewardsEpochDetailedWithWallet MarketMakerRewardsEpochDetailedWithWallet}
+     *      </li>
+     *      <li>
+     *        Calling this method without a {@link katanaperps.RestRequestGetMarketMakerRewardsEpochWithWallet.wallet wallet}
+     *        parameter returns {@link katanaperps.MarketMakerRewardsEpochDetailedWithoutWallet MarketMakerRewardsEpochDetailedWithoutWallet}
+     *      </li>
+     *    </ul>
+     * </p>
+     * </details>
+     * <br />
+     *
+     * <br />
+     *
+     * <h3>Overload 1: With Wallet</h3>
+     *
+     * <p>The Get Epoch endpoint provides detailed information about
+     * epoch configuration as well as wallet epoch performance.</p>
+     *
+     * > When **providing** a wallet address, the resulting response will
+     * > be {@link katanaperps.MarketMakerRewardsEpochDetailedWithWallet MarketMakerRewardsEpochDetailedWithWallet}
+     */
+    getMarketMakerRewardsEpoch(params: katanaPerps.RestRequestGetMarketMakerRewardsEpochWithWallet): Promise<katanaPerps.MarketMakerRewardsEpochDetailedWithWallet>;
+    /**
+     * <h3>Overload 2: Without Wallet</h3>
+     *
+     * > When **not** providing a {@link katanaperps.RestRequestGetMarketMakerRewardsEpochWithWallet.wallet wallet},
+     * > the resulting response will be {@link katanaperps.MarketMakerRewardsEpochDetailedWithoutWallet MarketMakerRewardsEpochDetailedWithoutWallet}
+     *
+     * @see typedoc  [Reference Documentation](https://sdk-js-docs-v1-perps.katana.network/classes/RestAuthenticatedClient.html#getMarketMakerRewardsEpoch)
+     * @see request   {@link katanaperps.RestRequestGetMarketMakerRewardsEpoch RestRequestGetMarketMakerRewardsEpoch}
+     * @see response  {@link katanaperps.RestResponseGetMarketMakerRewardsEpoch RestResponseGetMarketMakerRewardsEpoch}
+     * @see type      {@link katanaperps.KatanaPerpsMarketMakerRewardsEpoch KatanaPerpsMarketMakerRewardsEpoch}
+     * @see related   {@link getMarketMakerRewardsEpochs this.getMarketMakerRewardsEpochs}
+     *
+     * @category Rewards & Payouts
+     */
+    getMarketMakerRewardsEpoch(params: katanaPerps.RestRequestGetMarketMakerRewardsEpochWithoutWallet): Promise<katanaPerps.MarketMakerRewardsEpochDetailedWithoutWallet>;
+    /**
+     * The Get Epochs endpoint provides a list of the defined
+     * market maker rewards epochs.
+     *
+     * ---
+     * **Endpoint Parameters**
+     *
+     * > - HTTP Request:      `GET /v1/marketMakerRewardsV1/epochs`
+     * > - Endpoint Security: [User Data](https://api-docs-v1-perps.katana.network/#endpointSecurityUserData)
+     * > - API Key Scope:     [Read](https://api-docs-v1-perps.katana.network/#api-keys)
+     * ---
+     *
+     * @see typedoc   [Reference Documentation](https://sdk-js-docs-v1-perps.katana.network/classes/RestAuthenticatedClient.html#getMarketMakerRewardsEpochs)
+     * @see request   {@link katanaperps.RestRequestGetMarketMakerRewardsEpochs RestRequestGetMarketMakerRewardsEpochs}
+     * @see response  {@link katanaperps.RestResponseGetMarketMakerRewardsEpochs RestResponseGetMarketMakerRewardsEpochs}
+     * @see type      {@link katanaperps.KatanaPerpsMarketMakerRewardsEpochSummary KatanaPerpsMarketMakerRewardsEpochSummary}
+     * @see related   {@link getMarketMakerRewardsEpoch client.getMarketMakerRewardsEpoch}
+     *
+     * @category Rewards & Payouts
+     */
+    getMarketMakerRewardsEpochs(params?: katanaPerps.RestRequestGetMarketMakerRewardsEpochs): Promise<katanaPerps.RestResponseGetMarketMakerRewardsEpochs>;
+    /**
+     * Associates a wallet with an API account, allowing access to private data such as fills.
+     * Associating a wallet with an API account is often the first step in interacting with private
+     * read endpoints.
+     *
+     * ---
+     * **Endpoint Parameters**
+     *
+     * > - **HTTP Request:**         `POST /v1/wallets`
+     * > - **Endpoint Security:**    [Trade](https://api-docs-v1-perps.katana.network/#endpointSecurityUserData)
+     * > - **API Key Scope:**        [Read](https://api-docs-v1-perps.katana.network/#api-keys)
+     * > - **Pagination:**           `None`
+     * ---
+     *
+     * @returns
+     * - Returns the {@link katanaperps.KatanaPerpsWallet KatanaPerpsWallet} which was associated by the request.
+     *
+     * ---
+     *
+     * @example
+     * ```typescript
+     * const wallet = await client.associateWallet({
+     *   nonce: uuidv1(),
+     *   wallet: '0xA71C4aeeAabBBB8D2910F41C2ca3964b81F7310d',
+     * });
+     * ```
+     *
+     * <br />
+     *
+     * ---
+     *
+     * @see typedoc  [Reference Documentation](https://sdk-js-docs-v1-perps.katana.network/classes/RestAuthenticatedClient.html#associateWallet)
+     * @see request  {@link katanaperps.RestRequestAssociateWallet RestRequestAssociateWallet}
+     * @see response {@link katanaperps.RestResponseAssociateWallet RestResponseAssociateWallet}
+     * @see type     {@link katanaperps.KatanaPerpsWallet KatanaPerpsWallet}
+     *
+     * @category Wallets & Positions
+     */
+    associateWallet(params: katanaPerps.RestRequestAssociateWallet, referralCode?: string, signer?: undefined | katanaPerps.SignTypedData): Promise<katanaPerps.KatanaPerpsWallet>;
+    /**
+     * Returns information about the wallets associated with the API account.
+     *
+     * ---
+     * **Endpoint Parameters**
+     *
+     * > - **HTTP Request:**         `GET /v1/wallets`
+     * > - **Endpoint Security:**    [User Data](https://api-docs-v1-perps.katana.network/#endpointSecurityUserData)
+     * > - **API Key Scope:**        [Read](https://api-docs-v1-perps.katana.network/#api-keys)
+     * > - **Pagination:**           `None`
+     * ---
+     *
+     * @returns
+     *  - An array of {@link katanaperps.KatanaPerpsWallet KatanaPerpsWallet} objects representing all associated wallets.
+     *
+     * ---
+     *
+     * @see typedoc  [Reference Documentation](https://sdk-js-docs-v1-perps.katana.network/classes/RestAuthenticatedClient.html#getWallets)
+     * @see request  {@link katanaperps.RestRequestGetWallets RestRequestGetWallets}
+     * @see response {@link katanaperps.RestResponseGetWallets RestResponseGetWallets}
+     * @see type     {@link katanaperps.KatanaPerpsWallet KatanaPerpsWallet}
+     *
+     * @category Wallets & Positions
+     */
+    getWallets(params: katanaPerps.RestRequestGetWallets): Promise<katanaPerps.RestResponseGetWallets>;
+    /**
+     * Get Positions
+     *
+     * ---
+     * **Endpoint Parameters**
+     *
+     * > - **HTTP Request:**         `GET /v1/positions`
+     * > - **Endpoint Security:**    [User Data](https://api-docs-v1-perps.katana.network/#endpointSecurityUserData)
+     * > - **API Key Scope:**        [Read](https://api-docs-v1-perps.katana.network/#api-keys)
+     * > - **Pagination:**           `None`
+     * ---
+     *
+     * @returns
+     *  - An array of {@link katanaperps.KatanaPerpsPosition KatanaPerpsPosition} objects representing all matching positions based
+     *    on your requested params.
+     *
+     * ---
+     *
+     * @see typedoc  [Reference Documentation](https://sdk-js-docs-v1-perps.katana.network/classes/RestAuthenticatedClient.html#getPositions)
+     * @see request  {@link katanaperps.RestRequestGetPositions RestRequestGetPositions}
+     * @see response {@link katanaperps.RestResponseGetPositions RestResponseGetPositions}
+     * @see type     {@link katanaperps.KatanaPerpsPosition KatanaPerpsPosition}
+     *
+     * @category Wallets & Positions
+     */
+    getPositions(params: katanaPerps.RestRequestGetPositions): Promise<katanaPerps.RestResponseGetPositions>;
+    /**
+     * Create and submit an order to the matching engine.
+     *
+     * - It is recommended to use the {@link katanaPerps.OrderType OrderType} enum when creating
+     *   your requests. This provides inline documentation and ensures accuracy of the values.
+     * - Check out the {@link katanaperps.RestRequestOrder RestRequestOrder} type for an overview
+     *   of the various parameters needed for different order types.
+     *
+     * ---
+     * **Endpoint Parameters**
+     *
+     * > - **HTTP Request:**         `POST /v1/orders`
+     * > - **Endpoint Security:**    [Trade](https://api-docs-v1-perps.katana.network/#endpointSecurityTrade)
+     * > - **API Key Scope:**        [Trade](https://api-docs-v1-perps.katana.network/#api-keys)
+     * > - **Pagination:**           `None`
+     * ---
+     *
+     * @returns
+     *  - Returns the {@link katanaPerps.KatanaPerpsOrder KatanaPerpsOrder} which was created by the request.
+     *
+     * ---
+     *
+     * @example
+     * ```typescript
+     * import { OrderType, OrderSide } from '@katanaperps/katana-perps-sdk';
+     *
+     * try {
+     *   const order = await client.createOrder({
+     *     // always use the enum and define it first so that
+     *     // the type of this params object change to the
+     *     // appropriate interface with completion hints in IDE!
+     *     type: OrderType.market,
+     *     // this object is now narrowed to
+     *     // interface: RestRequestOrderTypeMarket
+     *     side: OrderSide.buy,
+     *     nonce: uuidv1(),
+     *     wallet: '0xA71C4aeeAabBBB8D2910F41C2ca3964b81F7310d',
+     *     market: 'ETH-USD',
+     *     quantity: '10.00000000'
+     *   });
+     * } catch(e) {
+     *   // order placement failed with an unexpected error
+     *   // you may use isAxiosError(e) for stronger typing here if desired
+     *   if (e.response?.data?.code === 'INSUFFICIENT_FUNDS') {
+     *      // handle insufficient funds errors
+     *      console.log('Insufficient funds to create order');
+     *   }
+     * }
+     * ```
+     *
+     * <br />
+     *
+     * ---
+     *
+     * @see typedoc  [Reference Documentation](https://sdk-js-docs-v1-perps.katana.network/classes/RestAuthenticatedClient.html#createOrder)
+     * @see request  {@link katanaperps.RestRequestOrder RestRequestOrder}
+     * @see response {@link katanaperps.RestResponseGetOrder RestResponseGetOrder}
+     * @see type     {@link katanaPerps.KatanaPerpsOrder KatanaPerpsOrder}
+     *
+     * @category Orders
+     */
+    createOrder<T extends katanaPerps.OrderType>(params: katanaPerps.RestRequestOrder & {
+        type: T;
+    }, signer?: undefined | katanaPerps.SignTypedData): Promise<katanaPerps.RestResponseGetOrder>;
+    /**
+     * Cancel multiple matching orders using one of the following methods:
+     *
+     * - By {@link katanaperps.RestRequestCancelOrdersByWallet.wallet wallet} (params: {@link katanaperps.RestRequestCancelOrdersByWallet RestRequestCancelOrdersByWallet})
+     * - By {@link katanaperps.RestRequestCancelOrdersByMarket.wallet wallet} & {@link katanaperps.RestRequestCancelOrdersByMarket.market market} (params: {@link katanaperps.RestRequestCancelOrdersByMarket RestRequestCancelOrdersByMarket})
+     * - By {@link katanaperps.RestRequestCancelOrdersByMarket.wallet wallet} & {@link katanaperps.RestRequestCancelOrdersByOrderIds.orderIds orderIds} (params: {@link katanaperps.RestRequestCancelOrdersByOrderIds RestRequestCancelOrdersByOrderIds})
+     *
+     * ---
+     * **Endpoint Parameters**
+     *
+     * > - **HTTP Request:**         `DELETE /v1/orders`
+     * > - **Endpoint Security:**    [Trade](https://api-docs-v1-perps.katana.network/#endpointSecurityUserData)
+     * > - **API Key Scope:**        [Trade](https://api-docs-v1-perps.katana.network/#api-keys)
+     * > - **Pagination:**           `None`
+     * ---
+     *
+     * @returns
+     * - Returns an array of cancelled orders matching {@link katanaperps.KatanaPerpsCanceledOrder KatanaPerpsCanceledOrder}
+     *
+     * ---
+     *
+     * @example
+     * ```typescript
+     * const allOrders = client.cancelOrders({
+     *   nonce: uuidv1(),
+     *   wallet: '0xA71C4aeeAabBBB8D2910F41C2ca3964b81F7310d',
+     * });
+     *
+     * const ordersForMarket = client.cancelOrders({
+     *   nonce: uuidv1(),
+     *   wallet: '0xA71C4aeeAabBBB8D2910F41C2ca3964b81F7310d',
+     *   market: 'ETH-USD'
+     * });
+     * ```
+     *
+     * <br />
+     *
+     * ---
+     *
+     * @see typedoc  [Reference Documentation](https://sdk-js-docs-v1-perps.katana.network/classes/RestAuthenticatedClient.html#cancelOrders)
+     * @see request  {@link katanaperps.RestRequestCancelOrders RestRequestCancelOrders}
+     * @see response {@link katanaperps.RestResponseCancelOrders RestResponseCancelOrders}
+     * @see type     {@link katanaperps.KatanaPerpsCanceledOrder KatanaPerpsCanceledOrder}
+     * @see related  {@link cancelOrder client.cancelOrder}
+     *
+     * @category Orders
+     */
+    cancelOrders(params: katanaPerps.RestRequestCancelOrders, signer?: katanaPerps.SignTypedData | undefined): Promise<katanaPerps.RestResponseCancelOrders>;
+    private makeCancelOrdersRequest;
+    /**
+     * Returns an order matching your {@link katanaperps.RestRequestGetOrder.orderId orderId} request parameter.
+     *
+     * - Can be an order's {@link katanaPerps.KatanaPerpsOrder.orderId orderId}
+     * - To get an order by its {@link katanaPerps.KatanaPerpsOrder.clientOrderId clientOrderId},
+     *   you should prefix the value with `client:`.
+     *
+     * ---
+     * **Endpoint Parameters**
+     *
+     * > - **HTTP Request:**         `GET /v1/orders`
+     * > - **Endpoint Security:**    [User Data](https://api-docs-v1-perps.katana.network/#endpointSecurityUserData)
+     * > - **API Key Scope:**        [Read](https://api-docs-v1-perps.katana.network/#api-keys)
+     * > - **Pagination:**           `None`
+     * ---
+     *
+     * @see typedoc  [Reference Documentation](https://sdk-js-docs-v1-perps.katana.network/classes/RestAuthenticatedClient.html#getOrder)
+     * @see request  {@link katanaperps.RestRequestGetOrder RestRequestGetOrder}
+     * @see response {@link katanaperps.RestResponseGetOrder RestResponseGetOrder}
+     * @see type     {@link katanaPerps.KatanaPerpsOrder KatanaPerpsOrder}
+     * @see related  {@link getOrders client.getOrders}
+     *
+     * @category Orders
+     */
+    getOrder(params: katanaPerps.RestRequestGetOrder): Promise<katanaPerps.RestResponseGetOrder>;
+    /**
+     * Returns information about open and past {@link katanaPerps.KatanaPerpsOrder orders}.
+     *
+     * ---
+     * **Endpoint Parameters**
+     *
+     * > - **HTTP Request:**         `GET /v1/orders`
+     * > - **Endpoint Security:**    [User Data](https://api-docs-v1-perps.katana.network/#endpointSecurityUserData)
+     * > - **API Key Scope:**        [Read](https://api-docs-v1-perps.katana.network/#api-keys)
+     * > - **Pagination:**
+     * > {@link katanaperps.RestRequestPaginationWithFromId.start start},
+     * > {@link katanaperps.RestRequestPaginationWithFromId.end end},
+     * > {@link katanaperps.RestRequestPaginationWithFromId.limit limit},
+     * > {@link katanaperps.RestRequestPaginationWithFromId.fromId fromId}
+     * ---
+     *
+     * @see typedoc  [Reference Documentation](https://sdk-js-docs-v1-perps.katana.network/classes/RestAuthenticatedClient.html#getOrders)
+     * @see request  {@link katanaperps.RestRequestGetOrders RestRequestGetOrders}
+     * @see response {@link katanaperps.RestResponseGetOrders RestResponseGetOrders}
+     * @see type     {@link katanaPerps.KatanaPerpsOrder KatanaPerpsOrder}
+     * @see related  {@link getOrder client.getOrder}
+     *
+     * @category Orders
+     */
+    getOrders(params: katanaPerps.RestRequestGetOrders): Promise<katanaPerps.RestResponseGetOrders>;
+    /**
+     * Get a single fill from the API by your requests {@link katanaperps.RestRequestGetFill.fillId fillId}
+     * parameter.
+     *
+     * ---
+     * **Endpoint Parameters**
+     *
+     * > - **HTTP Request:**         `GET /v1/fills`
+     * > - **Endpoint Security:**    [User Data](https://api-docs-v1-perps.katana.network/#endpointSecurityUserData)
+     * > - **API Key Scope:**        [Read](https://api-docs-v1-perps.katana.network/#api-keys)
+     * > - **Pagination:**           `None`
+     * ---
+     *
+     * @see typedoc  [Reference Documentation](https://sdk-js-docs-v1-perps.katana.network/classes/RestAuthenticatedClient.html#getFill)
+     * @see request  {@link katanaperps.RestRequestGetFill RestRequestGetFill}
+     * @see response {@link katanaperps.RestResponseGetFill RestResponseGetFill}
+     * @see type     {@link katanaperps.KatanaPerpsFill KatanaPerpsFill}
+     * @see related  {@link getFills client.getFills}
+     *
+     * @category Fills & Historical
+     */
+    getFill(params: katanaPerps.RestRequestGetFill): Promise<katanaPerps.KatanaPerpsFill>;
+    /**
+     * Get an array of {@link KatanaPerpsFill} objects matching your request parameters.
+     *
+     * ---
+     * **Endpoint Parameters**
+     *
+     * > - **HTTP Request:**         `GET /v1/fills`
+     * > - **Endpoint Security:**    [User Data](https://api-docs-v1-perps.katana.network/#endpointSecurityUserData)
+     * > - **API Key Scope:**        [Read](https://api-docs-v1-perps.katana.network/#api-keys)
+     * > - **Pagination:**
+     * > {@link katanaperps.RestRequestPaginationWithFromId.start start},
+     * > {@link katanaperps.RestRequestPaginationWithFromId.end end},
+     * > {@link katanaperps.RestRequestPaginationWithFromId.limit limit},
+     * > {@link katanaperps.RestRequestPaginationWithFromId.fromId fromId}
+     * ---
+     *
+     * @see typedoc  [Reference Documentation](https://sdk-js-docs-v1-perps.katana.network/classes/RestAuthenticatedClient.html#getFills)
+     * @see request  {@link katanaperps.RestRequestGetFills RestRequestGetFills}
+     * @see response {@link katanaperps.RestResponseGetFills RestResponseGetFills}
+     * @see type     {@link katanaperps.KatanaPerpsFill KatanaPerpsFill}
+     * @see related  {@link getFill client.getFill}
+     *
+     * @category Fills & Historical
+     */
+    getFills(params: katanaPerps.RestRequestGetFills): Promise<katanaPerps.RestResponseGetFills>;
+    /**
+     * Returns information about a payout program and the requested wallets earned/paid amounts for
+     * the program.
+     *
+     * - Includes the data required to authorize a payout using the `distribute`
+     *   function of the escrow contract.
+     * - Throws an error if the {@link katanaperps.KatanaPerpsPayoutProgram.quantityOwed quantityOwed}
+     *   is `0`
+     *
+     * ---
+     * **Endpoint Parameters**
+     *
+     * > - **HTTP Request:**         `POST /v1/payouts`
+     * > - **Endpoint Security:**    [User Data](https://api-docs-v1-perps.katana.network/#endpointSecurityUserData)
+     * > - **API Key Scope:**        [Read](https://api-docs-v1-perps.katana.network/#api-keys)
+     * > - **Pagination:**           `None`
+     * ---
+     *
+     * @example
+     * ```typescript
+     * import { PayoutProgram } from '@katanaperps/katana-perps-sdk';
+     *
+     * // create client
+     *
+     * await client.authorizePayout({
+     *  wallet: '0x...',
+     *  nonce: uuidv1(),
+     *  // use the PayoutProgram enum for inline auto completion
+     *  program: PayoutProgram.tradingRewardsV2
+     * });
+     * ```
+     *
+     *
+     * @see typedoc  [Reference Documentation](https://sdk-js-docs-v1-perps.katana.network/classes/RestAuthenticatedClient.html#authorizePayout)
+     * @see request  {@link katanaperps.RestRequestAuthorizePayout RestRequestAuthorizePayout}
+     * @see response {@link katanaperps.RestResponseAuthorizePayout RestResponseAuthorizePayout}
+     * @see type     {@link katanaperps.KatanaPerpsPayoutProgramAuthorization KatanaPerpsPayoutProgramAuthorization}
+     *
+     * @category Rewards & Payouts
+     */
+    authorizePayout(params: katanaPerps.RestRequestAuthorizePayout): Promise<katanaPerps.KatanaPerpsPayoutProgramAuthorization>;
+    /**
+     * Returns information about a payout program and the requested wallets
+     * earned/paid amounts for the program.
+     *
+     * ---
+     * **Endpoint Parameters**
+     *
+     * > - **HTTP Request:**       `GET /v1/payouts`
+     * > - **Endpoint Security:**  [User Data](https://api-docs-v1-perps.katana.network/#endpointSecurityUserData)
+     * > - **API Key Scope:**      [Read](https://api-docs-v1-perps.katana.network/#api-keys)
+     * > - **Pagination:**         `None`
+     * ---
+     *
+     * @example
+     * ```typescript
+     * import { PayoutProgram } from '@katanaperps/katana-perps-sdk';
+     *
+     * // create client
+     *
+     * await client.getPayouts({
+     *  wallet: '0x...',
+     *  nonce: uuidv1(),
+     *  // use the PayoutProgram enum for inline auto completion
+     *  program: PayoutProgram.tradingRewardsV2
+     * });
+     * ```
+     *
+     * <br />
+     *
+     * ---
+     *
+     * @see typedoc  [Reference Documentation](https://sdk-js-docs-v1-perps.katana.network/classes/RestAuthenticatedClient.html#getPayouts)
+     * @see request  {@link katanaperps.RestRequestGetPayouts RestRequestGetPayouts}
+     * @see response {@link katanaperps.RestResponseGetPayouts RestResponseGetPayouts}
+     * @see type     {@link katanaperps.KatanaPerpsPayoutProgram KatanaPerpsPayoutProgram}
+     *
+     * @category Rewards & Payouts
+     */
+    getPayouts(params: katanaPerps.RestRequestGetPayouts): Promise<katanaPerps.KatanaPerpsPayoutProgram>;
+    /**
+     * Returns information about deposits made by a wallet.
+     *
+     * ---
+     * **Endpoint Parameters**
+     *
+     * > - **HTTP Request:**         `GET /v1/deposits`
+     * > - **Endpoint Security:**    [User Data](https://api-docs-v1-perps.katana.network/#endpointSecurityUserData)
+     * > - **API Key Scope:**        [Read](https://api-docs-v1-perps.katana.network/#api-keys)
+     * > - **Pagination:**           `None`
+     * ---
+     *
+     * @returns
+     * - Returns a single {@link katanaperps.KatanaPerpsDeposit KatanaPerpsDeposit} object matching your parameters.
+     *
+     * ---
+     *
+     * @see typedoc  [Reference Documentation](https://sdk-js-docs-v1-perps.katana.network/classes/RestAuthenticatedClient.html#getDeposit)
+     * @see request  {@link katanaperps.RestRequestGetDeposit RestRequestGetDeposit}
+     * @see response {@link katanaperps.RestResponseGetDeposit RestResponseGetDeposit}
+     * @see type     {@link katanaperps.KatanaPerpsDeposit KatanaPerpsDeposit}
+     * @see related  {@link getDeposits client.getDeposits}
+     *
+     * @category Deposits & Withdrawals
+     */
+    getDeposit(params: katanaPerps.RestRequestGetDeposit): Promise<katanaPerps.KatanaPerpsDeposit>;
+    /**
+     * Returns information about deposits made by a wallet.
+     *
+     * ---
+     * **Endpoint Parameters**
+     *
+     * > - **HTTP Request:**         `GET /v1/deposits`
+     * > - **Endpoint Security:**    [User Data](https://api-docs-v1-perps.katana.network/#endpointSecurityUserData)
+     * > - **API Key Scope:**        [Read](https://api-docs-v1-perps.katana.network/#api-keys)
+     * > - **Pagination:**
+     * > {@link katanaperps.RestRequestPaginationWithFromId.start start},
+     * > {@link katanaperps.RestRequestPaginationWithFromId.end end},
+     * > {@link katanaperps.RestRequestPaginationWithFromId.limit limit},
+     * > {@link katanaperps.RestRequestPaginationWithFromId.fromId fromId}
+     * ---
+     *
+     * @returns
+     * - Returns an array of {@link katanaperps.KatanaPerpsDeposit KatanaPerpsDeposit} objects matching your parameters.
+     *
+     * ---
+     *
+     * @see typedoc  [Reference Documentation](https://sdk-js-docs-v1-perps.katana.network/classes/RestAuthenticatedClient.html#getDeposits)
+     * @see request  {@link katanaperps.RestRequestGetDeposits RestRequestGetDeposits}
+     * @see response {@link katanaperps.RestResponseGetDeposits RestResponseGetDeposits}
+     * @see type     {@link katanaperps.KatanaPerpsDeposit KatanaPerpsDeposit}
+     * @see related  {@link getDeposit client.getDeposit}
+     *
+     * @category Deposits & Withdrawals
+     */
+    getDeposits(params: katanaPerps.RestRequestGetDeposits): Promise<katanaPerps.RestResponseGetDeposits>;
+    /**
+     * A convenience method that helps capture the appropriate value for the
+     * {@link withdraw} method's {@link katanaperps.RestRequestWithdrawFundsBase.maximumGasFee maximumGasFee}
+     * parameter.
+     *
+     * - Calls `publicClient.getGasFees` and adds the defined `maximumSlippagePercent` to it.
+     * - User should then confirm the value is acceptable before calling {@link withdraw} method.
+     * - If gas were `0.05000000` and `maximumSlippagePercent` is `0.10000000` (10%) then result would be `0.05500000`
+     * - The value is represented in USD.
+     *
+     * ---
+     *
+     * @returns
+     * - A value indicating the max gas fee that should be allowed (in USD) based on the
+     *   core gas fee with your `maximumSlippagePercent` added.  This value should always
+     *   be validated by your application before calling {@link withdraw} method with this
+     *   as your {@link katanaperps.RestRequestWithdrawFundsBase.maximumGasFee maximumGasFee}
+     *   parameter.
+     *
+     * ---
+     *
+     * @example
+     * ```typescript
+     * // returns the max gas fee in USD you will accept for a withdrawal
+     * const maximumGasFee = await client.calculateWithdrawalMaximumGasFee({
+     *  bridgeTarget: BridgeTarget.STARGATE_ETHEREUM,
+     *  // 10% slippage alllowed (default)
+     *  maximumSlippagePercent: '0.10000000'
+     * });
+     *
+     * // never pay more than $1 USD in gas fees to withdrawal
+     * if (Number(maximumGasFee) >= 1) {
+     *  throw new Error('Too Much Gas cost to Withdraw! ${maximumGasFee} USD >= 1 USD!');
+     * }
+     *
+     * const withdrawal = await client.withdraw({
+     *   nonce: uuidv1(),
+     *   wallet: '0xA71C4aeeAabBBB8D2910F41C2ca3964b81F7310d',
+     *   quantity: '100.00000000',
+     *   maximumGasFee,
+     *   bridgeTarget: BridgeTarget.STARGATE_ETHEREUM
+     * });
+     * ```
+     *
+     * <br />
+     *
+     * ---
+     *
+     * @see typedoc   [Reference Documentation](https://sdk-js-docs-v1-perps.katana.network/classes/RestAuthenticatedClient.html#calculateWithdrawalMaximumGasFee)
+     * @see related {@link withdraw client.withdraw}
+     */
+    calculateWithdrawalMaximumGasFee({ bridgeTarget, maximumSlippagePercent, }: {
+        /**
+         * The bridge target for the withdrawal of funds.
+         *
+         * - Utilize the {@link BridgeTarget} enum for convenience and
+         *   auto-completion.
+         * - Automatically calculates the {@link bridgeAdapterAddress} &
+         *   {@link bridgeAdapterPayload} parameters for the targeted network.
+         *
+         * @see enum {@link BridgeTarget}
+         */
+        bridgeTarget: katanaPerps.BridgeTarget;
+        /**
+         *  Maximum slippage percent in pips percent format (ex `0.10000000` for 10%)
+         *
+         * @example
+         * ```typescript
+         * // 10%
+         * '0.10000000'
+         * ```
+         */
+        maximumSlippagePercent: string;
+    }): Promise<string>;
+    /**
+     * Withdraw funds from the exchange.
+     *
+     * - Unlike deposits, withdrawals are initiated via this REST API endpoint.
+     * - Once the withdrawal is validated, Katana Perps automatically dispatches the
+     *   resulting transaction to send funds to the wallet.
+     *
+     * ---
+     * **Endpoint Parameters**
+     *
+     * > - **HTTP Request:**         `POST /v1/withdrawals`
+     * > - **Endpoint Security:**    [Trade](https://api-docs-v1-perps.katana.network/#endpointSecurityUserData)
+     * > - **API Key Scope:**        [Withdraw](https://api-docs-v1-perps.katana.network/#api-keys)
+     * > - **Pagination:**           `None`
+     * ---
+     *
+     * @returns
+     * - Returns an {@link katanaperps.KatanaPerpsWithdrawal KatanaPerpsWithdrawal} object providing the details of the
+     *   withdrawal.
+     *
+     * ---
+     *
+     * @example
+     * ```typescript
+     * // returns the max gas fee in USD you will accept for a withdrawal
+     * const maximumGasFee = await client.calculateWithdrawalMaximumGasFee({
+     *  bridgeTarget: BridgeTarget.STARGATE_ETHEREUM,
+     *  // 10% slippage alllowed (default)
+     *  maximumSlippagePercent: '0.10000000'
+     * });
+     *
+     * // never pay more than $1 USD in gas fees to withdrawal
+     * if (Number(maximumGasFee) >= 1) {
+     *  throw new Error('Too Much Gas cost to Withdraw! ${maximumGasFee} USD >= 1 USD!');
+     * }
+     *
+     * const withdrawal = await client.withdraw({
+     *   nonce: uuidv1(),
+     *   wallet: '0xA71C4aeeAabBBB8D2910F41C2ca3964b81F7310d',
+     *   quantity: '100.00000000',
+     *   maximumGasFee,
+     *   bridgeTarget: BridgeTarget.STARGATE_ETHEREUM
+     * });
+     * ```
+     *
+     * <br />
+     *
+     * ---
+     *
+     * @see typedoc  [Reference Documentation](https://sdk-js-docs-v1-perps.katana.network/classes/RestAuthenticatedClient.html#withdraw)
+     * @see request  {@link katanaperps.RestRequestWithdrawFunds RestRequestWithdrawFunds}
+     * @see response {@link katanaperps.RestResponseWithdrawFunds RestResponseWithdrawFunds}
+     * @see type     {@link katanaperps.KatanaPerpsWithdrawal KatanaPerpsWithdrawal}
+     * @see related  {@link calculateWithdrawalMaximumGasFee}
+     *
+     * @category Deposits & Withdrawals
+     */
+    withdraw($params: katanaPerps.RestRequestWithdrawFundsSDK | katanaPerps.RestRequestWithdrawFunds, signer?: undefined | katanaPerps.SignTypedData): Promise<katanaPerps.KatanaPerpsWithdrawal>;
+    /**
+     * Returns information about a single withdrawal matching the request.
+     *
+     * ---
+     * **Endpoint Parameters**
+     *
+     * > - **HTTP Request:**         `GET /v1/withdrawals`
+     * > - **Endpoint Security:**    [User Data](https://api-docs-v1-perps.katana.network/#endpointSecurityUserData)
+     * > - **API Key Scope:**        [Read](https://api-docs-v1-perps.katana.network/#api-keys)
+     * > - **Pagination:**           `None`
+     * ---
+     *
+     * @returns
+     * - Returns an {@link katanaperps.KatanaPerpsWithdrawal KatanaPerpsWithdrawal} object matching your request.
+     *
+     * ---
+     *
+     * @see typedoc  [Reference Documentation](https://sdk-js-docs-v1-perps.katana.network/classes/RestAuthenticatedClient.html#getWithdrawal)
+     * @see request  {@link katanaperps.RestRequestGetWithdrawal RestRequestGetWithdrawal}
+     * @see response {@link katanaperps.RestResponseGetWithdrawal RestResponseGetWithdrawal}
+     * @see type     {@link katanaperps.KatanaPerpsWithdrawal KatanaPerpsWithdrawal}
+     * @see related  {@link getWithdrawals client.getWithdrawals}
+     *
+     * @category Deposits & Withdrawals
+     */
+    getWithdrawal(params: katanaPerps.RestRequestGetWithdrawal): Promise<katanaPerps.KatanaPerpsWithdrawal>;
+    /**
+     * Returns information about withdrawals to a wallet.
+     *
+     * ---
+     * **Endpoint Parameters**
+     *
+     * > - **HTTP Request:**         `GET /v1/withdrawals`
+     * > - **Endpoint Security:**    [User Data](https://api-docs-v1-perps.katana.network/#endpointSecurityUserData)
+     * > - **API Key Scope:**        [Read](https://api-docs-v1-perps.katana.network/#api-keys)
+     * > - **Pagination:**
+     * > {@link katanaperps.RestRequestPaginationWithFromId.start start},
+     * > {@link katanaperps.RestRequestPaginationWithFromId.end end},
+     * > {@link katanaperps.RestRequestPaginationWithFromId.limit limit},
+     * > {@link katanaperps.RestRequestPaginationWithFromId.fromId fromId}
+     * ---
+     *
+     * @returns
+     * - Returns an array of {@link katanaperps.KatanaPerpsWithdrawal KatanaPerpsWithdrawal} objects matching your request.
+     *
+     * ---
+     *
+     * @see typedoc  [Reference Documentation](https://sdk-js-docs-v1-perps.katana.network/classes/RestAuthenticatedClient.html#getWithdrawals)
+     * @see request  {@link katanaperps.RestRequestGetWithdrawals RestRequestGetWithdrawals}
+     * @see response {@link katanaperps.RestResponseGetWithdrawals RestResponseGetWithdrawals}
+     * @see type     {@link katanaperps.KatanaPerpsWithdrawal KatanaPerpsWithdrawal}
+     * @see related  {@link getWithdrawal client.getWithdrawal}
+     *
+     * @category Deposits & Withdrawals
+     */
+    getWithdrawals(params: katanaPerps.RestRequestGetWithdrawals): Promise<katanaPerps.RestResponseGetWithdrawals>;
+    /**
+     * Get Funding Payments for wallet matching {@link katanaperps.KatanaPerpsFundingPayment KatanaPerpsFundingPayment}
+     *
+     * ---
+     * **Endpoint Parameters**
+     *
+     * > - **HTTP Request:**         `GET /v1/fundingPayments`
+     * > - **Endpoint Security:**    [User Data](https://api-docs-v1-perps.katana.network/#endpointSecurityUserData)
+     * > - **API Key Scope:**        [Read](https://api-docs-v1-perps.katana.network/#api-keys)
+     * > - **Pagination:**
+     * > {@link katanaperps.RestRequestPaginationWithFromId.start start},
+     * > {@link katanaperps.RestRequestPaginationWithFromId.end end},
+     * > {@link katanaperps.RestRequestPaginationWithFromId.limit limit}
+     * ---
+     *
+     * @see typedoc  [Reference Documentation](https://sdk-js-docs-v1-perps.katana.network/classes/RestAuthenticatedClient.html#getFundingPayments)
+     * @see request  {@link katanaperps.RestRequestGetFundingPayments RestRequestGetFundingPayments}
+     * @see response {@link katanaperps.RestResponseGetFundingPayments RestResponseGetFundingPayments}
+     * @see type     {@link katanaperps.KatanaPerpsFundingPayment KatanaPerpsFundingPayment}
+     *
+     * @category Fills & Historical
+     */
+    getFundingPayments<R = katanaPerps.RestResponseGetFundingPayments>(params: katanaPerps.RestRequestGetFundingPayments): Promise<R>;
+    /**
+     * Override minimum Initial Margin Fraction for wallet for a market
+     *
+     * ---
+     * **Endpoint Parameters**
+     *
+     * > - **HTTP Request:**         `POST /v1/initialMarginFractionOverride`
+     * > - **Endpoint Security:**    [Trade](https://api-docs-v1-perps.katana.network/#endpointSecurityTrade)
+     * > - **API Key Scope:**        [Read](https://api-docs-v1-perps.katana.network/#api-keys)
+     * > - **Pagination:**
+     * ---
+     *
+     * @returns
+     * - Returns an {@link katanaperps.KatanaPerpsInitialMarginFractionOverride KatanaPerpsInitialMarginFractionOverride}
+     *   object providing the details of the new  setting.
+  
+     *
+     * @category Wallets & Positions
+     */
+    setInitialMarginFractionOverride<R = katanaPerps.RestResponseSetInitialMarginFractionOverride>(params: katanaPerps.RestRequestSetInitialMarginFractionOverride, signer?: katanaPerps.SignTypedData | undefined): Promise<R>;
+    /**
+     * Get Initial Margin Fraction overrides for wallet for a market or all markets
+     *
+     * ---
+     * **Endpoint Parameters**
+     *
+     * > - **HTTP Request:**         `GET /v1/initialMarginFractionOverride`
+     * > - **Endpoint Security:**    [Trade](https://api-docs-v1-perps.katana.network/#endpointSecurityTrade)
+     * > - **API Key Scope:**        [Read](https://api-docs-v1-perps.katana.network/#api-keys)
+     * > - **Pagination:**
+     * ---
+     *
+     * @returns
+     * - Returns an {@link katanaperps.KatanaPerpsInitialMarginFractionOverride KatanaPerpsInitialMarginFractionOverride}
+     *   object providing the details of the setting.
+  
+     *
+     * @category Wallets & Positions
+     */
+    getInitialMarginFractionOverride<R = katanaPerps.RestResponseGetInitialMarginFractionOverride>(params: katanaPerps.RestRequestGetInitialMarginFractionOverride): Promise<R>;
+    /**
+     * Get Historical PnL for the wallet / market matching {@link katanaperps.KatanaPerpsHistoricalProfitLoss KatanaPerpsHistoricalProfitLoss}
+     *
+     * ---
+     * **Endpoint Parameters**
+     *
+     * > - **HTTP Request:**         `GET /v1/historicalPnL`
+     * > - **Endpoint Security:**    [User Data](https://api-docs-v1-perps.katana.network/#endpointSecurityUserData)
+     * > - **API Key Scope:**        [Read](https://api-docs-v1-perps.katana.network/#api-keys)
+     * > - **Pagination:**
+     * > {@link katanaperps.RestRequestPaginationWithFromId.start start},
+     * > {@link katanaperps.RestRequestPaginationWithFromId.end end},
+     * > {@link katanaperps.RestRequestPaginationWithFromId.limit limit}
+     * ---
+     *
+     * @see typedoc  [Reference Documentation](https://sdk-js-docs-v1-perps.katana.network/classes/RestAuthenticatedClient.html#getHistoricalPnL)
+     * @see request  {@link katanaperps.RestRequestGetHistoricalPnL RestRequestGetHistoricalPnL}
+     * @see response {@link katanaperps.RestResponseGetHistoricalPnL RestResponseGetHistoricalPnL}
+     * @see type     {@link katanaperps.KatanaPerpsHistoricalProfitLoss KatanaPerpsHistoricalProfitLoss}
+     *
+     * @category Fills & Historical
+     */
+    getHistoricalPnL(params: katanaPerps.RestRequestGetHistoricalPnL): Promise<katanaPerps.RestResponseGetHistoricalPnL>;
+    /**
+     * Returns a single-use authentication token as a string for access
+     * to {@link katanaperps.SubscriptionNameAuthenticated authenticated subscriptions}
+     * in the WebSocket API.
+     *
+     * ---
+     * **Endpoint Parameters**
+     *
+     * > - **HTTP Request:**         `GET /v1/wsToken`
+     * > - **Endpoint Security:**    [User Data](https://api-docs-v1-perps.katana.network/#endpointSecurityUserData)
+     * > - **API Key Scope:**        [Read](https://api-docs-v1-perps.katana.network/#api-keys)
+     * > - **Pagination:**           `None`
+     * ---
+     *
+     * @returns
+     * - Returns the {@link katanaperps.KatanaPerpsWebSocketToken.token KatanaPerpsWebSocketToken.token} string
+     *   directly which you can use to authenticate with the WebSocket server.
+     *
+     * ---
+     *
+     * @see typedoc  [Reference Documentation](https://sdk-js-docs-v1-perps.katana.network/classes/RestAuthenticatedClient.html#getWsToken)
+     * @see request  {@link katanaperps.RestRequestGetAuthenticationToken RestRequestGetAuthenticationToken}
+     * @see response {@link katanaperps.RestResponseGetAuthenticationToken RestResponseGetAuthenticationToken}
+     *
+     * @category WebSocket
+     */
+    getWsToken(params: katanaPerps.RestRequestGetAuthenticationToken): Promise<string>;
+    /**
+     * - All requests within the internal symbol are undocumented internal methods which may change or be removed without notice.
+     * - API handling of the parameters used within these methods is likely to change without notice without changes to the SDK to match.
+     * - These methods or parameters may require additional permissions to use and result in errors or blocking of your request if used.
+     * - If you need to use these methods for your use case, please contact support to discuss your requirements before using them.
+     *
+     * @internal
+     */
+    readonly [INTERNAL_SYMBOL]: Readonly<{
+        /**
+         * Requires the public IDs (`orderIds`) of the stop loss orders' parent
+         * orders. Do not provide the public IDs of the stop loss orders themselves.
+         */
+        readonly cancelConditionalStopLossOrders: (params: katanaPerps.RestRequestCancelOrders, signer?: katanaPerps.SignTypedData | undefined) => Promise<katanaPerps.RestResponseCancelOrders>;
+        /**
+         * Requires the public IDs (`orderIds`) of the take profit orders' parent
+         * orders. Do not provide the public IDs of the take profit orders themselves.
+         */
+        readonly cancelConditionalTakeProfitOrders: (params: katanaPerps.RestRequestCancelOrders, signer?: katanaPerps.SignTypedData | undefined) => Promise<katanaPerps.RestResponseCancelOrders>;
+        readonly getFundingPayments: (params: katanaPerps.RestRequestGetFundingPayments) => Promise<katanaPerps.Paginated<katanaPerps.RestResponseGetFundingPayments>>;
+        readonly getXChallenge: (params: katanaPerps.RestRequestGetVaultXConnectionChallenge) => Promise<katanaPerps.RestResponseGetVaultXConnectionChallenge>;
+        readonly placeConditionalTpSlOrder: <T extends "stopLossMarket" | "takeProfitMarket">(takeProfitOrStopLossOrder: katanaPerps.RestRequestOrder & {
+            type: T;
+        }, conditionalParentOrderId: string, signer?: undefined | katanaPerps.SignTypedData) => Promise<katanaPerps.RestResponseGetOrder & {
+            type: T;
+        }>;
+        readonly placeOrderWithConditionalTpSlOrders: <T_1 extends katanaPerps.OrderType>(params: {
+            order: katanaPerps.RestRequestOrder & {
+                type: T_1;
+            };
+            conditionalTakeProfitOrder?: (katanaPerps.RestRequestOrderTypeTakeProfitMarket & {
+                type: typeof katanaPerps.OrderType.takeProfitMarket;
+            }) | undefined;
+            conditionalStopLossOrder?: (katanaPerps.RestRequestOrderTypeStopLossMarket & {
+                type: typeof katanaPerps.OrderType.stopLossMarket;
+            }) | undefined;
+        }, signer?: undefined | katanaPerps.SignTypedData) => Promise<{
+            order: katanaPerps.KatanaPerpsOrder & {
+                conditionalTakeProfitOrder?: (katanaPerps.KatanaPerpsOrder & {
+                    type: "takeProfitMarket";
+                }) | undefined;
+                conditionalStopLossOrder?: (katanaPerps.KatanaPerpsOrder & {
+                    type: "stopLossMarket";
+                }) | undefined;
+            } & {
+                type: T_1;
+            };
+            conditionalTakeProfitOrder?: (katanaPerps.KatanaPerpsOrder & {
+                conditionalTakeProfitOrder?: (katanaPerps.KatanaPerpsOrder & {
+                    type: "takeProfitMarket";
+                }) | undefined;
+                conditionalStopLossOrder?: (katanaPerps.KatanaPerpsOrder & {
+                    type: "stopLossMarket";
+                }) | undefined;
+            } & {
+                type: typeof katanaPerps.OrderType.takeProfitMarket;
+            }) | undefined;
+            conditionalStopLossOrder?: (katanaPerps.KatanaPerpsOrder & {
+                conditionalTakeProfitOrder?: (katanaPerps.KatanaPerpsOrder & {
+                    type: "takeProfitMarket";
+                }) | undefined;
+                conditionalStopLossOrder?: (katanaPerps.KatanaPerpsOrder & {
+                    type: "stopLossMarket";
+                }) | undefined;
+            } & {
+                type: typeof katanaPerps.OrderType.stopLossMarket;
+            }) | undefined;
+        }>;
+        readonly setVaultDetails: (params: katanaPerps.RestRequestSetVaultDetails, signer?: undefined | katanaPerps.SignTypedData) => Promise<katanaPerps.RestResponseSetVaultDetails>;
+        readonly removeVaultXConnection: (params: katanaPerps.RestRequestRemoveVaultXConnection, signer?: undefined | katanaPerps.SignTypedData) => Promise<void>;
+        readonly setVaultXConnection: (params: katanaPerps.RestRequestSetVaultXConnection, signer?: undefined | katanaPerps.SignTypedData) => Promise<void>;
+        readonly withdrawFromManagedAccountByQuantity: ($params: katanaPerps.RestRequestWithdrawFundsFromManagedAccountByQuantitySDK | katanaPerps.RestRequestWithdrawFundsFromManagedAccountByQuantity, signer?: undefined | katanaPerps.SignTypedData) => Promise<katanaPerps.KatanaPerpsWithdrawalFromManagedAccount>;
+        readonly withdrawFromManagedAccountByShares: ($params: katanaPerps.RestRequestWithdrawFundsFromManagedAccountBySharesSDK | katanaPerps.RestRequestWithdrawFundsFromManagedAccountByShares, signer?: undefined | katanaPerps.SignTypedData) => Promise<katanaPerps.KatanaPerpsWithdrawalFromManagedAccount>;
+    }>;
+    protected getContractAndChainId(): Promise<{
+        chainId: number;
+        exchangeContractAddress: string;
+    }>;
+    /**
+     * - Internal Use and may change or break without notice
+     *
+     * @internal
+     * @hidden
+     */
+    protected get<R>(endpoint: string, params?: AnyObj | undefined, axiosConfig?: Omit<Partial<AxiosRequestConfig>, 'method' | 'url' | 'params'>): Promise<R>;
+    /**
+     * - Internal Use and may change or break without notice
+     *
+     * @internal
+     * @hidden
+     */
+    protected post<R>(endpoint: string, data?: AnyObj, axiosConfig?: Omit<Partial<AxiosRequestConfig>, 'method' | 'url' | 'data'>): Promise<R>;
+    /**
+     * - Internal Use and may change or break without notice
+     *
+     * @internal
+     * @hidden
+     */
+    protected delete<R>(endpoint: string, data?: AnyObj, axiosConfig?: Omit<Partial<AxiosRequestConfig>, 'method' | 'url' | 'data'>): Promise<R>;
+    /**
+     * - Internal Use and may change or break without notice
+     *
+     * @internal
+     * @hidden
+     */
+    protected put<R>(endpoint: string, data?: AnyObj, axiosConfig?: Omit<Partial<AxiosRequestConfig>, 'method' | 'url' | 'data'>): Promise<R>;
+    /**
+     * - Internal Use and may change or break without notice
+     *
+     * @internal
+     * @hidden
+     */
+    protected patch<R>(endpoint: string, data?: AnyObj, axiosConfig?: Omit<Partial<AxiosRequestConfig>, 'method' | 'url' | 'data'>): Promise<R>;
+    /**
+     * - Internal Use and may change or break without notice
+     *
+     * @internal
+     * @hidden
+     */
+    protected request<R = any>(endpoint: string, config: Partial<AxiosRequestConfig> & ({
+        method: 'GET';
+    } | {
+        method: Exclude<AxiosRequestConfig['method'], 'GET' | 'get'>;
+        data: {
+            [key: string]: unknown;
+        };
+    }), createHmacSignatureHeader?: boolean): Promise<Axios.AxiosResponse<R, any>>;
+}
+//# sourceMappingURL=authenticated.d.ts.map