@katanaperps/katana-perps-sdk 0.0.0-placeholder

package/dist/client/rest/authenticated.js

@@ -0,0 +1,1311 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RestAuthenticatedClient = void 0;
+const tslib_1 = require("tslib");
+/* eslint-disable lines-between-class-members */
+const http = tslib_1.__importStar(require("http"));
+const https = tslib_1.__importStar(require("https"));
+const axios_1 = tslib_1.__importDefault(require("axios"));
+const bignumber_js_1 = tslib_1.__importDefault(require("bignumber.js"));
+const ethers_1 = require("ethers");
+const _constants_1 = require("#constants");
+const _signatures_1 = require("#signatures");
+const _utils_1 = require("#utils");
+const public_1 = require("#client/rest/public");
+/**
+ * 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
+ */
+class RestAuthenticatedClient {
+    /**
+     * 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
+     */
+    public;
+    #exchange = null;
+    #signer = undefined;
+    #apiSecret;
+    #axiosConfig;
+    axios;
+    #config;
+    /**
+     * 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() {
+        return Object.freeze({
+            ...this.#config,
+        });
+    }
+    /**
+     * 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) {
+        const { sandbox = false, exchangeContractAddress, chainId, bridgeAdapterContractAddress, autoCreateHmacHeader = true, } = options;
+        const baseURL = (0, _utils_1.deriveBaseURL)({
+            sandbox,
+            api: 'rest',
+            overrideBaseURL: options.baseURL ?? options.axiosConfig?.baseURL,
+        });
+        if (!baseURL) {
+            throw new Error(`Invalid configuration, baseURL could not be derived (sandbox? ${String(sandbox)})`);
+        }
+        this.#config = {
+            baseURL,
+            sandbox,
+            bridgeAdapterContractAddress,
+            exchangeContractAddress,
+            chainId,
+            autoCreateHmacHeader,
+        };
+        this.public = new public_1.RestPublicClient({
+            apiKey: options.apiKey,
+            baseURL,
+            sandbox,
+        });
+        this.#axiosConfig = Object.freeze({
+            paramsSerializer(params) {
+                return (0, _utils_1.sanitizeSearchParams)(params ?? {}).toString();
+            },
+            ...(_utils_1.isNode ?
+                {
+                    httpAgent: options.axiosConfig?.httpAgent ??
+                        new http.Agent({ keepAlive: true }),
+                    httpsAgent: options.axiosConfig?.httpsAgent ??
+                        new https.Agent({ keepAlive: true }),
+                }
+                : {}),
+            ...(options.axiosConfig ?? {}),
+            baseURL,
+            headers: {
+                ...(options.axiosConfig?.headers ?? {
+                    [_constants_1.REST_API_KEY_HEADER]: options.apiKey,
+                }),
+            },
+        });
+        this.#apiSecret = options.apiSecret;
+        if (options.walletPrivateKey) {
+            this.#signer = (0, _signatures_1.createPrivateKeyTypedDataSigner)(options.walletPrivateKey);
+        }
+        this.axios = axios_1.default.create(this.#axiosConfig);
+        if (options.axiosConfig?.headers) {
+            Object.assign(this.axios.defaults.headers.common, options.axiosConfig.headers);
+        }
+    }
+    async getMarketMakerRewardsEpoch(params) {
+        return this.get('/marketMakerRewardsV1/epoch', params);
+    }
+    /**
+     * 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
+     */
+    async getMarketMakerRewardsEpochs(params = {}) {
+        return this.get('/marketMakerRewardsV1/epochs', params);
+    }
+    /**
+     * 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
+     */
+    async associateWallet(params, referralCode, signer = this.#signer) {
+        ensureSigner(signer);
+        const { chainId, exchangeContractAddress } = await this.getContractAndChainId();
+        return this.post('/wallets', {
+            referralCode,
+            parameters: params,
+            signature: await signer(...(0, _signatures_1.getWalletAssociationSignatureTypedData)(params, exchangeContractAddress, chainId, this.#config.sandbox)),
+        });
+    }
+    /**
+     * 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
+     */
+    async getWallets(params) {
+        return this.get('/wallets', params);
+    }
+    /**
+     * 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
+     */
+    async getPositions(params) {
+        return this.get('/positions', params);
+    }
+    /**
+     * 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
+     */
+    async createOrder(params, signer = this.#signer) {
+        ensureSigner(signer);
+        const { chainId, exchangeContractAddress } = await this.getContractAndChainId();
+        return this.post('/orders', {
+            parameters: params,
+            signature: await signer(...(0, _signatures_1.getOrderSignatureTypedData)(params, exchangeContractAddress, chainId, this.#config.sandbox)),
+        });
+    }
+    /**
+     * 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
+     */
+    async cancelOrders(params, signer = this.#signer) {
+        return this.makeCancelOrdersRequest('/orders', params, signer);
+    }
+    async makeCancelOrdersRequest(endpoint, params, signer = this.#signer) {
+        ensureSigner(signer);
+        const { chainId, exchangeContractAddress } = await this.getContractAndChainId();
+        return this.delete(endpoint, {
+            parameters: params,
+            signature: await signer(...(0, _signatures_1.getOrderCancellationSignatureTypedData)(params, exchangeContractAddress, chainId, this.#config.sandbox)),
+        });
+    }
+    /**
+     * 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
+     */
+    async getOrder(params) {
+        return this.get('/orders', params);
+    }
+    /**
+     * 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
+     */
+    async getOrders(params) {
+        return this.get('/orders', params);
+    }
+    /**
+     * 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
+     */
+    async getFill(params) {
+        return this.get('/fills', params);
+    }
+    /**
+     * 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
+     */
+    async getFills(params) {
+        return this.get('/fills', params);
+    }
+    /**
+     * 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
+     */
+    async authorizePayout(params) {
+        return this.post('/payouts', params);
+    }
+    /**
+     * 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
+     */
+    async getPayouts(params) {
+        return this.get('/payouts', params);
+    }
+    /**
+     * 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
+     */
+    async getDeposit(params) {
+        return this.get('/deposits', params);
+    }
+    /**
+     * 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
+     */
+    async getDeposits(params) {
+        return this.get('/deposits', params);
+    }
+    /**
+     * 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}
+     */
+    async calculateWithdrawalMaximumGasFee({ bridgeTarget, maximumSlippagePercent, }) {
+        const maximumSlippagePercentBN = (0, bignumber_js_1.default)(maximumSlippagePercent);
+        if (maximumSlippagePercentBN.gt(1) || maximumSlippagePercentBN.lt(0)) {
+            throw new Error(`maximumSlippagePercent must be a value between 0 and 1. Value of ${maximumSlippagePercent} was provided`);
+        }
+        const gasFees = await this.public.getGasFees();
+        const fees = gasFees.withdrawal[bridgeTarget];
+        if (!fees) {
+            // in testnet we only define katana so need this - mainnet should have all of them.
+            throw new Error(`Could not estimate withdrawal maximumGasFee for ${bridgeTarget} as the "gasFees" endpoint does not provide the gas fee for the target.`);
+        }
+        const slippage = (0, bignumber_js_1.default)(fees).multipliedBy(maximumSlippagePercent);
+        return (0, bignumber_js_1.default)(fees).plus(slippage).toFixed(8, bignumber_js_1.default.ROUND_DOWN);
+    }
+    /**
+     * 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
+     */
+    async withdraw($params, signer = this.#signer) {
+        ensureSigner(signer);
+        const { chainId, exchangeContractAddress } = await this.getContractAndChainId();
+        let params;
+        if ($params.bridgeTarget) {
+            const { bridgeTarget, ...rest } = $params;
+            params = {
+                ...rest,
+                ...getWithdrawalRequestBridgeAdapterParametersForTarget(),
+            };
+        }
+        else {
+            params = $params;
+        }
+        return this.post('/withdrawals', {
+            parameters: params,
+            signature: await signer(...(0, _signatures_1.getWithdrawalSignatureTypedData)(params, exchangeContractAddress, chainId, this.#config.sandbox)),
+        });
+    }
+    /**
+     * 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
+     */
+    async getWithdrawal(params) {
+        return this.get('/withdrawals', params);
+    }
+    /**
+     * 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
+     */
+    async getWithdrawals(params) {
+        return this.get('/withdrawals', params);
+    }
+    /**
+     * 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
+     */
+    async getFundingPayments(params) {
+        return this.get('/fundingPayments', params);
+    }
+    /**
+     * 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
+     */
+    async setInitialMarginFractionOverride(params, signer = this.#signer) {
+        ensureSigner(signer);
+        const { chainId, exchangeContractAddress } = await this.getContractAndChainId();
+        return this.post('/initialMarginFractionOverride', {
+            parameters: params,
+            signature: await signer(...(0, _signatures_1.getInitialMarginFractionOverrideSettingsSignatureTypedData)(params, exchangeContractAddress, chainId, this.#config.sandbox)),
+        });
+    }
+    /**
+     * 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
+     */
+    async getInitialMarginFractionOverride(params) {
+        return this.get('/initialMarginFractionOverride', params);
+    }
+    /**
+     * 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
+     */
+    async getHistoricalPnL(params) {
+        return this.get('/historicalPnL', params);
+    }
+    /**
+     * 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
+     */
+    async getWsToken(params) {
+        if (!params.nonce || !params.wallet) {
+            throw new Error('Invalid request, nonce and wallet are required');
+        }
+        return (await this.get('/wsToken', params)).token;
+    }
+    /**
+     * - 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
+     */
+    [_utils_1.INTERNAL_SYMBOL] = Object.freeze({
+        /**
+         * Requires the public IDs (`orderIds`) of the stop loss orders' parent
+         * orders. Do not provide the public IDs of the stop loss orders themselves.
+         */
+        cancelConditionalStopLossOrders: async (params, signer = this.#signer) => {
+            return this.makeCancelOrdersRequest('/internal/orders/conditionalStopLossOrders', params, signer);
+        },
+        /**
+         * Requires the public IDs (`orderIds`) of the take profit orders' parent
+         * orders. Do not provide the public IDs of the take profit orders themselves.
+         */
+        cancelConditionalTakeProfitOrders: async (params, signer = this.#signer) => {
+            return this.makeCancelOrdersRequest('/internal/orders/conditionalTakeProfitOrders', params, signer);
+        },
+        getFundingPayments: async (...[params, ...args]) => {
+            const result = await this.getFundingPayments({
+                ...params,
+                page: Math.max(typeof params.page === 'number' ? params.page : 1, 1),
+            }, ...args);
+            return result;
+        },
+        getXChallenge: async (params) => {
+            const result = await this.get('/internal/vaults/xchallenge', params);
+            return result;
+        },
+        placeConditionalTpSlOrder: async (takeProfitOrStopLossOrder, conditionalParentOrderId, signer = this.#signer) => {
+            ensureSigner(signer);
+            const { chainId, exchangeContractAddress } = await this.getContractAndChainId();
+            return this.post('/internal/orders/conditionalTpSlOrders', {
+                order: {
+                    parameters: takeProfitOrStopLossOrder,
+                    signature: await signer(...(0, _signatures_1.getOrderSignatureTypedData)(takeProfitOrStopLossOrder, exchangeContractAddress, chainId, this.#config.sandbox)),
+                },
+                conditionalParentOrderPublicId: conditionalParentOrderId,
+            });
+        },
+        placeOrderWithConditionalTpSlOrders: async (params, signer = this.#signer) => {
+            ensureSigner(signer);
+            const { chainId, exchangeContractAddress } = await this.getContractAndChainId();
+            const signOrder = (order) => signer(...(0, _signatures_1.getOrderSignatureTypedData)(order, exchangeContractAddress, chainId, this.#config.sandbox));
+            return this.post('/internal/orders/orderWithConditionalTpSlOrders', {
+                order: {
+                    parameters: params.order,
+                    signature: await signOrder(params.order),
+                },
+                conditionalTakeProfitOrder: params.conditionalTakeProfitOrder ?
+                    {
+                        parameters: params.conditionalTakeProfitOrder,
+                        signature: await signOrder(params.conditionalTakeProfitOrder),
+                    }
+                    : undefined,
+                conditionalStopLossOrder: params.conditionalStopLossOrder ?
+                    {
+                        parameters: params.conditionalStopLossOrder,
+                        signature: await signOrder(params.conditionalStopLossOrder),
+                    }
+                    : undefined,
+            });
+        },
+        setVaultDetails: async (params, signer = this.#signer) => {
+            ensureSigner(signer);
+            const { chainId, exchangeContractAddress } = await this.getContractAndChainId();
+            return this.post('/internal/vaults/details', {
+                parameters: params,
+                signature: await signer(...(0, _signatures_1.getSetVaultDetailsSignatureTypedData)(params, exchangeContractAddress, chainId, this.#config.sandbox)),
+            });
+        },
+        removeVaultXConnection: async (params, signer = this.#signer) => {
+            ensureSigner(signer);
+            const { chainId, exchangeContractAddress } = await this.getContractAndChainId();
+            await this.delete('/internal/vaults/xconnection', {
+                parameters: params,
+                signature: await signer(...(0, _signatures_1.getRemoveVaultXConnectionSignatureTypedData)(params, exchangeContractAddress, chainId, this.#config.sandbox)),
+            });
+        },
+        setVaultXConnection: async (params, signer = this.#signer) => {
+            ensureSigner(signer);
+            const { chainId, exchangeContractAddress } = await this.getContractAndChainId();
+            await this.post('/internal/vaults/xconnection', {
+                parameters: params,
+                signature: await signer(...(0, _signatures_1.getSetVaultXConnectionSignatureTypedData)(params, exchangeContractAddress, chainId, this.#config.sandbox)),
+            });
+        },
+        withdrawFromManagedAccountByQuantity: async ($params, signer = this.#signer) => {
+            ensureSigner(signer);
+            const { chainId, exchangeContractAddress } = await this.getContractAndChainId();
+            let params;
+            if ($params.bridgeTarget) {
+                const { bridgeTarget, ...rest } = $params;
+                params = {
+                    ...rest,
+                    ...getWithdrawalRequestBridgeAdapterParametersForTarget(),
+                };
+            }
+            else {
+                params = $params;
+            }
+            return this.post('/internal/vaults/withdrawByQuantity', {
+                parameters: params,
+                signature: await signer(...(0, _signatures_1.getWithdrawalFromManagedAccountByQuantitySignatureTypedData)(params, exchangeContractAddress, chainId, this.#config.sandbox)),
+            });
+        },
+        withdrawFromManagedAccountByShares: async ($params, signer = this.#signer) => {
+            ensureSigner(signer);
+            const { chainId, exchangeContractAddress } = await this.getContractAndChainId();
+            let params;
+            if ($params.bridgeTarget) {
+                const { bridgeTarget, ...rest } = $params;
+                params = {
+                    ...rest,
+                    ...getWithdrawalRequestBridgeAdapterParametersForTarget(),
+                };
+            }
+            else {
+                params = $params;
+            }
+            return this.post('/internal/vaults/withdrawByShares', {
+                parameters: params,
+                signature: await signer(...(0, _signatures_1.getWithdrawalFromManagedAccountBySharesSignatureTypedData)(params, exchangeContractAddress, chainId, this.#config.sandbox)),
+            });
+        },
+    });
+    // Internal methods exposed for advanced usage
+    async getContractAndChainId() {
+        let { chainId, exchangeContractAddress } = this.#config;
+        if (!chainId || !exchangeContractAddress) {
+            if (!this.#exchange) {
+                this.#exchange = await this.public.getExchange();
+            }
+            if (this.#exchange.chainId && this.#exchange.exchangeContractAddress) {
+                this.#config.chainId ??= this.#exchange.chainId;
+                chainId ??= this.#config.chainId;
+                this.#config.exchangeContractAddress ??=
+                    this.#exchange.exchangeContractAddress;
+                exchangeContractAddress ??= this.#config.exchangeContractAddress;
+            }
+        }
+        if (!chainId || !exchangeContractAddress) {
+            throw new Error(`Could not determine chainId (${typeof chainId}) or exchangeContractAddress (${typeof exchangeContractAddress})`);
+        }
+        return {
+            chainId,
+            exchangeContractAddress,
+        };
+    }
+    /**
+     * - Internal Use and may change or break without notice
+     *
+     * @internal
+     * @hidden
+     */
+    async get(endpoint, params = undefined, axiosConfig = {}) {
+        return (await this.request(endpoint, {
+            ...axiosConfig,
+            method: 'GET',
+            params: (0, _utils_1.sanitizeSearchParams)(params),
+        })).data;
+    }
+    /**
+     * - Internal Use and may change or break without notice
+     *
+     * @internal
+     * @hidden
+     */
+    async post(endpoint, data = {}, axiosConfig = {}) {
+        return (await this.request(endpoint, {
+            ...axiosConfig,
+            method: 'POST',
+            data,
+        })).data;
+    }
+    /**
+     * - Internal Use and may change or break without notice
+     *
+     * @internal
+     * @hidden
+     */
+    async delete(endpoint, data = {}, axiosConfig = {}) {
+        return (await this.request(endpoint, {
+            ...axiosConfig,
+            method: 'DELETE',
+            data,
+        })).data;
+    }
+    /**
+     * - Internal Use and may change or break without notice
+     *
+     * @internal
+     * @hidden
+     */
+    async put(endpoint, data = {}, axiosConfig = {}) {
+        return (await this.request(endpoint, {
+            ...axiosConfig,
+            method: 'PUT',
+            data,
+        })).data;
+    }
+    /**
+     * - Internal Use and may change or break without notice
+     *
+     * @internal
+     * @hidden
+     */
+    async patch(endpoint, data = {}, axiosConfig = {}) {
+        return (await this.request(endpoint, {
+            ...axiosConfig,
+            method: 'PATCH',
+            data,
+        })).data;
+    }
+    /**
+     * - Internal Use and may change or break without notice
+     *
+     * @internal
+     * @hidden
+     */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    request(endpoint, config, createHmacSignatureHeader = this.#config.autoCreateHmacHeader) {
+        const request = {
+            ...config,
+            headers: config.headers ?? {},
+            url: endpoint,
+        };
+        if (createHmacSignatureHeader) {
+            const paramsSerialized = config.method === 'GET' ?
+                new URLSearchParams(config.params ?? {}).toString()
+                : JSON.stringify(config.data);
+            Object.assign(request.headers, (0, _utils_1.createHmacRestRequestSignatureHeader)(paramsSerialized, this.#apiSecret));
+        }
+        return this.axios(request);
+    }
+}
+exports.RestAuthenticatedClient = RestAuthenticatedClient;
+/**
+ * @internal
+ *
+ * Ensures that {@link signer} is provided either by constructor definition
+ * or manually dependent on the use-case.
+ *
+ * - SDK use case by end-user should always be provided via constructor
+ *   definition so the manual define case is for internal purposes only.
+ */
+function ensureSigner(signer) {
+    if (!signer) {
+        throw new Error('A "signer" function is required but was not provided during RestAuthenticatedClient constructor or when calling the method');
+    }
+}
+/**
+ * @internal
+ */
+function getWithdrawalRequestBridgeAdapterParametersForTarget() {
+    return {
+        bridgeAdapterAddress: ethers_1.ethers.ZeroAddress,
+        bridgeAdapterPayload: '0x',
+    };
+}