@katanaperps/katana-perps-sdk 0.0.0-placeholder

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

@@ -0,0 +1,199 @@
+import type { PayoutProgram, RestRequestByWallet } from '#index';
+/**
+ * Payout distribution fields to be provided to the escrow contract's `distribute` function.
+ *
+ * @see parent {@link KatanaPerpsPayoutProgramAuthorization}
+ *
+ * @category KatanaPerps - Authorize Payout
+ */
+export interface KatanaPerpsPayoutDistribution {
+    nonce: string;
+    parentNonce: string;
+    walletAddress: string;
+    assetAddress: string;
+    quantity: string;
+    exchangeSignature: string;
+}
+/**
+ * Get Payout Program Data
+ *
+ * ---
+ *
+ * @example
+ * ```typescript
+ * import { PayoutProgram } from '@katanaperps/katana-perps-sdk';
+ *
+ * // create client
+ *
+ * authenticatedClient.getPayouts({
+ *  wallet: '0x...',
+ *  nonce: uuidv1(),
+ *  program: PayoutProgram.tradingRewardsV2
+ * })
+ * ```
+ *
+ * <br />
+ *
+ * ---
+ *
+ * @see [API Documentation](https://api-docs-v1-perps.katana.network/#get-payouts)
+ * @see response {@link RestResponseGetPayouts}
+ * @see type {@link KatanaPerpsPayoutProgram}
+ *
+ * @category KatanaPerps - Get Payouts
+ */
+export interface RestRequestGetPayouts extends RestRequestByWallet {
+    /**
+     * - The payout program to query for the given {@link wallet}
+     *
+     * ---
+     *
+     * @example
+     * ```typescript
+     * import { PayoutProgram } from '@katanaperps/katana-perps-sdk';
+     *
+     * // create client
+     *
+     * await authenticatedClient.getPayouts({
+     *  wallet: '0x...',
+     *  nonce: uuidv1(),
+     *  program: PayoutProgram.tradingRewardsV2
+     * })
+     * ```
+     */
+    program: PayoutProgram;
+}
+/**
+ * Get Payout Program Authorization
+ *
+ * ---
+ *
+ * @example
+ * ```typescript
+ * import { PayoutProgram } from '@katanaperps/katana-perps-sdk';
+ *
+ * // create client
+ *
+ * await authenticatedClient.authorizePayout({
+ *  wallet: '0x...',
+ *  nonce: uuidv1(),
+ *  program: PayoutProgram.tradingRewardsV2
+ * })
+ * ```
+ *
+ * <br />
+ *
+ * ---
+ *
+ * @see [API Documentation](https://api-docs-v1-perps.katana.network/#authorize-payout)
+ * @see response {@link RestResponseAuthorizePayout}
+ * @see type {@link KatanaPerpsPayoutProgramAuthorization}
+ *
+ * @category KatanaPerps - Authorize Payout
+ */
+export interface RestRequestAuthorizePayout extends RestRequestByWallet {
+    /**
+     * - The payout program to authorize a payout for the given {@link wallet}
+     *
+     * @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
+     * })
+     * ```
+     */
+    program: PayoutProgram;
+}
+/**
+ * Katana Perps Get Payout Program Response
+ *
+ * @see docs     [API Documentation: Get Payouts](https://api-docs-v1-perps.katana.network/#get-payouts)
+ * @see request  {@link RestRequestGetPayouts}
+ * @see response {@link RestResponseGetPayouts}
+ *
+ * @category KatanaPerps - Get Payouts
+ */
+export interface KatanaPerpsPayoutProgram {
+    /**
+     * Contract address of the rewarded asset for the {@link PayoutProgram payout program}
+     */
+    assetAddress: string;
+    /**
+     * Symbol of the rewarded asset for the {@link PayoutProgram payout program}
+     */
+    assetSymbol: string;
+    /**
+     * Address of the escrow contract for the {@link PayoutProgram payout program}
+     */
+    escrowContractAddress: string;
+    /**
+     * Total quantity earned for the requested wallet for the {@link PayoutProgram payout program}
+     *
+     * - **Format:** Asset Units
+     */
+    quantityEarned: string;
+    /**
+     * Total quantity paid to the requested wallet for the {@link PayoutProgram payout program}
+     *
+     * - **Format:** Asset Units
+     */
+    quantityPaid: string;
+    /**
+     * Total quantity owed to the requested wallet for the {@link PayoutProgram payout program}
+     *
+     * - **Minimums:** There is a minimum quantity of 1 asset unit that must be earned before a payout can be authorized
+     * - **Logical Flow:** When ({@link quantityEarned} - {@link quantityPaid}) `< 1`, then `quantityOwed` will be `0` and an `authorize` call can not be made.
+     * - **Format:** Asset Units
+     */
+    quantityOwed: string;
+    /**
+     * Indicates whether there is likely to be a pending earnings distribution tx that has not been mined yet.
+     *
+     * - This is for internal use and may change without notice.
+     *
+     * @internal
+     */
+    hasPendingEarnings?: boolean;
+}
+/**
+ * Katana Perps Authorize Payout Program Response
+ *
+ * @see [API Documentation](https://api-docs-v1-perps.katana.network/#authorize-payout)
+ * @see request {@link RestRequestAuthorizePayout}
+ * @see response {@link RestResponseAuthorizePayout}
+ *
+ * @category KatanaPerps - Authorize Payout
+ */
+export interface KatanaPerpsPayoutProgramAuthorization extends Omit<KatanaPerpsPayoutProgram, `quantity${string}`> {
+    /**
+     * Payout distribution fields to be provided to the {@link KatanaPerpsPayoutProgram.escrowContractAddress escrow contract's} `distribute` function
+     *
+     * @see {@link KatanaPerpsPayoutDistribution}
+     */
+    distribution: KatanaPerpsPayoutDistribution;
+}
+/**
+ * @see [API Documentation](https://api-docs-v1-perps.katana.network/#get-payouts)
+ * @see type {@link KatanaPerpsPayoutProgram}
+ * @see request {@link RestRequestAuthorizePayout}
+ * @see related {@link RestResponseAuthorizePayout}
+ *
+ * @category KatanaPerps - Get Payouts
+ */
+export type RestResponseGetPayouts = KatanaPerpsPayoutProgram;
+/**
+ * @see [API Documentation](https://api-docs-v1-perps.katana.network/#authorize-payout)
+ * @see type {@link KatanaPerpsPayoutProgramAuthorization}
+ * @see request {@link RestRequestGetPayouts}
+ *
+ * @category KatanaPerps - Authorize Payout
+ */
+export type RestResponseAuthorizePayout = KatanaPerpsPayoutProgramAuthorization;
+//# sourceMappingURL=Payouts.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Payouts.d.ts","sourceRoot":"","sources":["../../../../src/types/rest/endpoints/Payouts.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,QAAQ,CAAC;AAEjE;;;;;;GAMG;AACH,MAAM,WAAW,6BAA6B;IAC5C,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,iBAAiB,EAAE,MAAM,CAAC;CAC3B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,WAAW,qBAAsB,SAAQ,mBAAmB;IAChE;;;;;;;;;;;;;;;;;OAiBG;IACH,OAAO,EAAE,aAAa,CAAC;CACxB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,WAAW,0BAA2B,SAAQ,mBAAmB;IACrE;;;;;;;;;;;;;;;;OAgBG;IACH,OAAO,EAAE,aAAa,CAAC;CACxB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAC9B;;;;OAIG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;;;OAIG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;;;;;OAMG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;;;;;OAMG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,qCACf,SAAQ,IAAI,CAAC,wBAAwB,EAAE,WAAW,MAAM,EAAE,CAAC;IAC3D;;;;OAIG;IACH,YAAY,EAAE,6BAA6B,CAAC;CAC7C;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,sBAAsB,GAAG,wBAAwB,CAAC;AAE9D;;;;;;GAMG;AACH,MAAM,MAAM,2BAA2B,GAAG,qCAAqC,CAAC"}

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

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

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

@@ -0,0 +1,83 @@
+import type { RestRequestByMarket, RestRequestByWallet } from '#index';
+import type { RestRequestWithSignature } from '#types/utils';
+import type { DelegatedKeyParams } from '../../delegatedKeys';
+/**
+ * - Rest Request: `POST /v1/initialMarginFractionOverride`
+ *
+ * @packageDocumentation
+ */
+/**
+ *  - Automatically associates wallets that are not yet associated.
+ *
+ * @see response {@link RestResponseSetInitialMarginFractionOverride}
+ * @see type     {@link KatanaPerpsInitialMarginFractionOverride}
+ * @category KatanaPerps - Set or clear Initial Margin Fraction override
+ *
+ * @hidden
+ */
+export interface RestRequestSetInitialMarginFractionOverride extends Required<RestRequestByWallet>, DelegatedKeyParams, RestRequestByMarket {
+    /**
+     * Initial margin fraction override value between `1` and default `initialMarginFraction`
+     * of the market
+     *
+     * - Requests that do not include a `initialMarginFractionOverride` parameter
+     *   **remove any existing Initial Margin Fraction override** for the wallet.
+     */
+    initialMarginFractionOverride?: string;
+}
+/**
+ * Result from calling get or set InitialMarginFractionOverride
+ *
+ * @see request (POST)  {@link RestRequestSetInitialMarginFractionOverride}
+ * @see response (POST) {@link RestResponseSetInitialMarginFractionOverride}
+ * @see request (GET)   {@link RestRequestGetInitialMarginFractionOverride}
+ * @see response (GET)  {@link RestResponseGetInitialMarginFractionOverride}
+ *
+ * @category KatanaPerps - Set Initial Margin Fraction override
+ * @category KatanaPerps - Get Initial Margin Fraction override
+ * @category KatanaPerps Interfaces
+ *
+ * @hidden
+ *
+ */
+export interface KatanaPerpsInitialMarginFractionOverride {
+    /**
+     * Wallet address
+     */
+    wallet: string;
+    /**
+     * Market symbol
+     */
+    market: string;
+    /**
+     * Initial Margin Fraction override value, `null` if no override is set on the market
+     */
+    initialMarginFractionOverride: string | null;
+}
+/**
+ * - Automatically associates wallets that are not yet associated.
+ *
+ * @see type    {@link KatanaPerpsInitialMarginFractionOverride}
+ * @see request {@link RestRequestSetInitialMarginFractionOverride}
+ *
+ * @category KatanaPerps - Set initial margin fraction
+ *
+ * @hidden
+ */
+export type RestResponseSetInitialMarginFractionOverride = KatanaPerpsInitialMarginFractionOverride;
+/**
+ * The raw request body for the `POST /v1/initialMarginFractionOverride` endpoint
+ * including `signature` and the body in `parameters`.
+ *
+ * - Automatically associates wallets that are not yet associated.
+ *
+ * @see parameters {@link RestRequestSetInitialMarginFractionOverride}
+ * @see response   {@link RestResponseSetInitialMarginFractionOverride}
+ * @see type       {@link KatanaPerpsInitialMarginFractionOverride}
+ *
+ * @category KatanaPerps - Set Initial Margin Fraction override
+ *
+ * @hidden
+ */
+export type RestRequestSetInitialMarginFractionOverrideSigned = RestRequestWithSignature<RestRequestSetInitialMarginFractionOverride>;
+//# sourceMappingURL=SetInitialMarginFractionOverride.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SetInitialMarginFractionOverride.d.ts","sourceRoot":"","sources":["../../../../src/types/rest/endpoints/SetInitialMarginFractionOverride.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,QAAQ,CAAC;AACvE,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAC;AAC7D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAE9D;;;;GAIG;AAEH;;;;;;;;GAQG;AACH,MAAM,WAAW,2CACf,SAAQ,QAAQ,CAAC,mBAAmB,CAAC,EACnC,kBAAkB,EAClB,mBAAmB;IACrB;;;;;;OAMG;IACH,6BAA6B,CAAC,EAAE,MAAM,CAAC;CACxC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,wCAAwC;IACvD;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,6BAA6B,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9C;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,4CAA4C,GACtD,wCAAwC,CAAC;AAE3C;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,iDAAiD,GAC3D,wBAAwB,CAAC,2CAA2C,CAAC,CAAC"}

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

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

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

@@ -0,0 +1,144 @@
+import type { RestRequestByWallet, KatanaPerpsWithdrawal, BridgeTarget } from '#index';
+import type { RestRequestWithSignature } from '#types/utils';
+/**
+ * <div>
+ * [[include:base.md]]
+ * </div>
+ *
+ * @category Base Types
+ *
+ * @see related {@link RestRequestWithdrawFundsSDK}
+ * @see related {@link RestRequestWithdrawFunds}
+ */
+export interface RestRequestWithdrawFundsBase extends RestRequestByWallet {
+    /**
+     * Withdrawal amount in asset terms, fees are taken from this
+     * value
+     */
+    quantity: string;
+    /**
+     * Maximum acceptable fee that can be deducted from withdrawn
+     * quantity in asset terms
+     */
+    maximumGasFee: string;
+    /**
+     * 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?: BridgeTarget;
+    /**
+     * Address of cross-chain bridge adapter contract to withdraw
+     * funds to. If zero, withdraws directly to wallet
+     *
+     * - This is automatically calculated when using the SDK by instead
+     *   providing {@link bridgeTarget} and leaving {@link bridgeAdapterPayload}
+     *   and {@link bridgeAdapterAddress} undefined.
+     */
+    bridgeAdapterAddress?: string;
+    /**
+     * If {@link bridgeAdapterAddress} is non-zero this should be the
+     * ABI-encoded arguments for the specific adapter
+     *
+     * - This is automatically calculated when using the SDK by instead
+     *   providing {@link bridgeTarget} and leaving {@link bridgeAdapterPayload}
+     *   and {@link bridgeAdapterAddress} undefined.
+     */
+    bridgeAdapterPayload?: string;
+}
+/**
+ * Request a withdrawal for a given wallet.
+ *
+ * - Note that the API utilizes a
+ *   {@link RestRequestWithdrawFunds slightly different interface},
+ *   the SDK simply aids providing these parameters based on the
+ *   {@link RestRequestWithdrawFundsSDK.bridgeTarget bridgeTarget}
+ *   parameter.
+ *
+ * @see docs    [API Documentation](https://api-docs-v1-perps.katana.network/#withdraw-funds)
+ * @see enum    {@link BridgeTarget}
+ * @see related {@link RestRequestWithdrawFunds}
+ *
+ * @category KatanaPerps - Withdraw Funds
+ */
+export interface RestRequestWithdrawFundsSDK extends RestRequestWithdrawFundsBase {
+    /**
+     * @inheritDoc
+     */
+    bridgeTarget: BridgeTarget;
+    /**
+     * @inheritDoc
+     *
+     * @remarks
+     *
+     * - Do not provide if {@link bridgeTarget} parameter is given as it will
+     *   be automatically calculated.
+     *
+     * @hidden
+     */
+    bridgeAdapterAddress?: undefined;
+    /**
+     * @inheritDoc
+     *
+     * @remarks
+     *
+     * - Do not provide if {@link bridgeTarget} parameter is given as it will
+     *   be automatically calculated.
+     *
+     * @hidden
+     */
+    bridgeAdapterPayload?: undefined;
+}
+/**
+ * API parameters for conducting a withdrawal.
+ *
+ * - The SDK utilizes a simplified interface {@link RestRequestWithdrawFundsSDK}
+ *
+ * @see docs    [API Documentation](https://api-docs-v1-perps.katana.network/#withdraw-funds)
+ * @see related {@link RestRequestWithdrawFundsSDK}
+ *
+ * @category KatanaPerps - Withdraw Funds
+ */
+export interface RestRequestWithdrawFunds extends RestRequestWithdrawFundsBase {
+    /**
+     * @remarks
+     *
+     * - Do not provide if {@link bridgeAdapterAddress} and {@link bridgeAdapterPayload} are
+     *   defined as auto-calculation will not be necessary
+     *
+     * @internal
+     */
+    bridgeTarget?: undefined;
+    /**
+     * @inheritDoc
+     */
+    bridgeAdapterAddress: string;
+    /**
+     * @inheritDoc
+     */
+    bridgeAdapterPayload: string;
+}
+/**
+ * The raw request body for the `POST /v1/withdrawals` endpoint
+ * including `signature` and the body in `parameters`.
+ *
+ * @see parameters {@link RestRequestWithdrawFunds}
+ * @see response   {@link RestResponseWithdrawFunds}
+ * @see type       {@link KatanaPerpsWithdrawal}
+ *
+ * @category KatanaPerps - Withdraw Funds
+ */
+export type RestRequestWithdrawFundsSigned = RestRequestWithSignature<RestRequestWithdrawFunds>;
+/**
+ * @see type    {@link KatanaPerpsWithdrawal}
+ * @see request {@link RestRequestWithdrawFunds}
+ *
+ * @category KatanaPerps - Withdraw Funds
+ */
+export type RestResponseWithdrawFunds = KatanaPerpsWithdrawal;
+//# sourceMappingURL=WithdrawFunds.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"WithdrawFunds.d.ts","sourceRoot":"","sources":["../../../../src/types/rest/endpoints/WithdrawFunds.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,mBAAmB,EACnB,qBAAqB,EACrB,YAAY,EACb,MAAM,QAAQ,CAAC;AAChB,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAC;AAE7D;;;;;;;;;GASG;AACH,MAAM,WAAW,4BAA6B,SAAQ,mBAAmB;IACvE;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;;;;;;;;OASG;IACH,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B;;;;;;;OAOG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B;;;;;;;OAOG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,2BACf,SAAQ,4BAA4B;IACpC;;OAEG;IACH,YAAY,EAAE,YAAY,CAAC;IAC3B;;;;;;;;;OASG;IACH,oBAAoB,CAAC,EAAE,SAAS,CAAC;IACjC;;;;;;;;;OASG;IACH,oBAAoB,CAAC,EAAE,SAAS,CAAC;CAClC;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,wBAAyB,SAAQ,4BAA4B;IAC5E;;;;;;;OAOG;IACH,YAAY,CAAC,EAAE,SAAS,CAAC;IACzB;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAC7B;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;CAC9B;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,8BAA8B,GACxC,wBAAwB,CAAC,wBAAwB,CAAC,CAAC;AAErD;;;;;GAKG;AACH,MAAM,MAAM,yBAAyB,GAAG,qBAAqB,CAAC"}

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

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

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

@@ -0,0 +1,161 @@
+import type { RestRequestByWallet, KatanaPerpsWithdrawalFromManagedAccount, BridgeTarget } from '#index';
+import type { RestRequestWithSignature } from '#types/utils';
+/**
+ * <div>
+ * [[include:base.md]]
+ * </div>
+ *
+ * @category Base Types
+ *
+ * @see related {@link RestRequestWithdrawFundsFromManagedAccountByQuantitySDK}
+ * @see related {@link RestRequestWithdrawFundsFromManagedAccountByQuantity}
+ */
+export interface RestRequestWithdrawFundsFromManagedAccountByQuantityBase extends RestRequestByWallet {
+    /**
+     * Address of wallet associated with Managed Account from which
+     * funds will be withdrawn
+     */
+    managerWallet: string;
+    /**
+     * Withdrawal amount in asset terms, fees are taken from this
+     * value
+     */
+    quantity: string;
+    /**
+     * Maximum number of shares to burn to create withdrawal amount
+     */
+    maxShares: string;
+    /**
+     * Maximum acceptable fee that can be deducted from withdrawn
+     * quantity in asset terms
+     */
+    maximumGasFee: string;
+    /**
+     * Address of Managed Account Provider contract
+     */
+    managedAccountProvider: string;
+    /**
+     * ABI-encoded parameters to supply specific Managed Account Provider contract
+     */
+    managedAccountProviderPayload: string;
+    /**
+     * 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?: BridgeTarget;
+    /**
+     * Address of cross-chain bridge adapter contract to withdraw
+     * funds to. If zero, withdraws directly to wallet
+     *
+     * - This is automatically calculated when using the SDK by instead
+     *   providing {@link bridgeTarget} and leaving {@link bridgeAdapterPayload}
+     *   and {@link bridgeAdapterAddress} undefined.
+     */
+    bridgeAdapterAddress?: string;
+    /**
+     * If {@link bridgeAdapterAddress} is non-zero this should be the
+     * ABI-encoded arguments for the specific adapter
+     *
+     * - This is automatically calculated when using the SDK by instead
+     *   providing {@link bridgeTarget} and leaving {@link bridgeAdapterPayload}
+     *   and {@link bridgeAdapterAddress} undefined.
+     */
+    bridgeAdapterPayload?: string;
+}
+/**
+ * Request a withdrawal for a given wallet.
+ *
+ * - Note that the API utilizes a
+ *   {@link RestRequestWithdrawFundsFromManagedAccountByQuantity slightly different interface},
+ *   the SDK simply aids providing these parameters based on the
+ *   {@link RestRequestWithdrawFundsFromManagedAccountByQuantitySDK.bridgeTarget bridgeTarget}
+ *   parameter.
+ *
+ * @see docs    [API Documentation](https://api-docs-v1-perps.katana.network/#withdraw-funds)
+ * @see enum    {@link BridgeTarget}
+ * @see related {@link RestRequestWithdrawFundsFromManagedAccountByQuantity}
+ *
+ * @category KatanaPerps - Withdraw Funds
+ */
+export interface RestRequestWithdrawFundsFromManagedAccountByQuantitySDK extends RestRequestWithdrawFundsFromManagedAccountByQuantityBase {
+    /**
+     * @inheritDoc
+     */
+    bridgeTarget: BridgeTarget;
+    /**
+     * @inheritDoc
+     *
+     * @remarks
+     *
+     * - Do not provide if {@link bridgeTarget} parameter is given as it will
+     *   be automatically calculated.
+     *
+     * @hidden
+     */
+    bridgeAdapterAddress?: undefined;
+    /**
+     * @inheritDoc
+     *
+     * @remarks
+     *
+     * - Do not provide if {@link bridgeTarget} parameter is given as it will
+     *   be automatically calculated.
+     *
+     * @hidden
+     */
+    bridgeAdapterPayload?: undefined;
+}
+/**
+ * API parameters for conducting a withdrawal.
+ *
+ * - The SDK utilizes a simplified interface {@link RestRequestWithdrawFundsFromManagedAccountByQuantitySDK}
+ *
+ * @see docs    [API Documentation](https://api-docs-v1-perps.katana.network/#withdraw-funds-from-managed-account)
+ * @see related {@link RestRequestWithdrawFundsFromManagedAccountByQuantitySDK}
+ *
+ * @category KatanaPerps - Withdraw Funds
+ */
+export interface RestRequestWithdrawFundsFromManagedAccountByQuantity extends RestRequestWithdrawFundsFromManagedAccountByQuantityBase {
+    /**
+     * @remarks
+     *
+     * - Do not provide if {@link bridgeAdapterAddress} and {@link bridgeAdapterPayload} are
+     *   defined as auto-calculation will not be necessary
+     *
+     * @internal
+     */
+    bridgeTarget?: undefined;
+    /**
+     * @inheritDoc
+     */
+    bridgeAdapterAddress: string;
+    /**
+     * @inheritDoc
+     */
+    bridgeAdapterPayload: string;
+}
+/**
+ * The raw request body for the `POST /v1/withdrawals` endpoint
+ * including `signature` and the body in `parameters`.
+ *
+ * @see parameters {@link RestRequestWithdrawFundsFromManagedAccountByQuantity}
+ * @see response   {@link RestResponseWithdrawFundsFromManagedAccountByQuantity}
+ * @see type       {@link KatanaPerpsWithdrawal}
+ *
+ * @category KatanaPerps - Withdraw Funds
+ */
+export type RestRequestWithdrawFundsFromManagedAccountByQuantitySigned = RestRequestWithSignature<RestRequestWithdrawFundsFromManagedAccountByQuantity>;
+/**
+ * @see type    {@link KatanaPerpsWithdrawalFromManagedAccount}
+ * @see request {@link RestRequestWithdrawFundsFromManagedAccountByQuantity}
+ *
+ * @category KatanaPerps - Withdraw Funds
+ */
+export type RestResponseWithdrawFundsFromManagedAccountByQuantity = KatanaPerpsWithdrawalFromManagedAccount;
+//# sourceMappingURL=WithdrawFundsFromManagedAccountByQuantity.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"WithdrawFundsFromManagedAccountByQuantity.d.ts","sourceRoot":"","sources":["../../../../src/types/rest/endpoints/WithdrawFundsFromManagedAccountByQuantity.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,mBAAmB,EACnB,uCAAuC,EACvC,YAAY,EACb,MAAM,QAAQ,CAAC;AAChB,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAC;AAE7D;;;;;;;;;GASG;AACH,MAAM,WAAW,wDACf,SAAQ,mBAAmB;IAC3B;;;OAGG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAC/B;;OAEG;IACH,6BAA6B,EAAE,MAAM,CAAC;IACtC;;;;;;;;;OASG;IACH,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B;;;;;;;OAOG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B;;;;;;;OAOG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,uDACf,SAAQ,wDAAwD;IAChE;;OAEG;IACH,YAAY,EAAE,YAAY,CAAC;IAC3B;;;;;;;;;OASG;IACH,oBAAoB,CAAC,EAAE,SAAS,CAAC;IACjC;;;;;;;;;OASG;IACH,oBAAoB,CAAC,EAAE,SAAS,CAAC;CAClC;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,oDACf,SAAQ,wDAAwD;IAChE;;;;;;;OAOG;IACH,YAAY,CAAC,EAAE,SAAS,CAAC;IACzB;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAC7B;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;CAC9B;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,0DAA0D,GACpE,wBAAwB,CAAC,oDAAoD,CAAC,CAAC;AAEjF;;;;;GAKG;AACH,MAAM,MAAM,qDAAqD,GAC/D,uCAAuC,CAAC"}

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

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