@nktkas/hyperliquid 0.13.0 → 0.13.2

package/esm/src/types/exchange/requests.d.ts

@@ -0,0 +1,502 @@
+import type { Hex } from "../common.js";
+import type { OrderParams } from "./common.js";
+/** Base structure for exchange requests. */
+export interface BaseExchangeRequest {
+    /** Action to perform. */
+    action: {
+        /** Type of action. */
+        type: string;
+        /** Additional action parameters. */
+        [key: string]: unknown;
+    };
+    /** Unique request identifier (recommended current timestamp in ms). */
+    nonce: number;
+    /** Cryptographic signature. */
+    signature: {
+        r: Hex;
+        s: Hex;
+        v: number;
+    };
+}
+/**
+ * Approve an agent to sign on behalf of the master or sub-accounts.
+ * @returns {SuccessResponse}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#approve-an-api-wallet
+ */
+export interface ApproveAgentRequest extends BaseExchangeRequest {
+    /** Action to be performed. */
+    action: {
+        /** Type of action. */
+        type: "approveAgent";
+        /** HyperLiquid network. */
+        hyperliquidChain: "Mainnet" | "Testnet";
+        /** Chain ID used for signing. */
+        signatureChainId: Hex;
+        /** Unique request identifier (recommended current timestamp in ms). */
+        nonce: number;
+        /** Agent address. */
+        agentAddress: Hex;
+        /** Agent name. */
+        agentName: string;
+    };
+}
+/**
+ * Approve a max fee rate for a builder address.
+ * @returns {SuccessResponse}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#approve-a-builder-fee
+ */
+export interface ApproveBuilderFeeRequest extends BaseExchangeRequest {
+    /** Action to be performed. */
+    action: {
+        /** Type of action. */
+        type: "approveBuilderFee";
+        /** HyperLiquid network. */
+        hyperliquidChain: "Mainnet" | "Testnet";
+        /** Chain ID used for signing. */
+        signatureChainId: Hex;
+        /** Unique request identifier (recommended current timestamp in ms). */
+        nonce: number;
+        /** Max fee rate (e.g., "0.01%"). */
+        maxFeeRate: `${string}%`;
+        /** Builder address. */
+        builder: Hex;
+    };
+}
+/**
+ * Modify multiple orders.
+ * @returns {OrderResponse}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#modify-multiple-orders
+ */
+export interface BatchModifyRequest extends BaseExchangeRequest {
+    /** Action to be performed. */
+    action: {
+        /** Type of action. */
+        type: "batchModify";
+        /** Order modifications. */
+        modifies: {
+            /** Order ID to modify. */
+            oid: number;
+            /** New order parameters. */
+            order: OrderParams;
+        }[];
+    };
+    /** Vault address (for vault trading). */
+    vaultAddress?: Hex;
+}
+/**
+ * Cancel order(s).
+ * @returns {CancelResponse}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#cancel-order-s
+ */
+export interface CancelRequest extends BaseExchangeRequest {
+    /** Action to be performed. */
+    action: {
+        /** Type of action. */
+        type: "cancel";
+        /** Orders to cancel. */
+        cancels: {
+            /** Asset ID. */
+            a: number;
+            /** Order ID. */
+            o: number;
+        }[];
+    };
+    /** Vault address (for vault trading). */
+    vaultAddress?: Hex;
+}
+/**
+ * Cancel order(s) by cloid.
+ * @returns {CancelResponse}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#cancel-order-s-by-cloid
+ */
+export interface CancelByCloidRequest extends BaseExchangeRequest {
+    /** Action to be performed. */
+    action: {
+        /** Type of action. */
+        type: "cancelByCloid";
+        /** Orders to cancel. */
+        cancels: {
+            /** Asset ID. */
+            asset: number;
+            /** Client Order ID. */
+            cloid: Hex;
+        }[];
+    };
+    /** Vault address (for vault trading). */
+    vaultAddress?: Hex;
+}
+/**
+ * Deposit into staking balance.
+ * @returns {SuccessResponse}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#deposit-into-staking
+ */
+export interface CDepositRequest extends BaseExchangeRequest {
+    /** Action to be performed. */
+    action: {
+        /** Type of action. */
+        type: "cDeposit";
+        /** HyperLiquid network. */
+        hyperliquidChain: "Mainnet" | "Testnet";
+        /** Chain ID used for signing. */
+        signatureChainId: Hex;
+        /** Unique request identifier (recommended current timestamp in ms). */
+        nonce: number;
+        /** Amount of wei to deposit into staking balance. */
+        wei: number;
+    };
+}
+/**
+ * Create a sub-account.
+ * @returns {CreateSubAccountResponse}
+ * @see null - no documentation
+ */
+export interface CreateSubAccountRequest extends BaseExchangeRequest {
+    /** Action to be performed. */
+    action: {
+        /** Type of action. */
+        type: "createSubAccount";
+        /** Sub-account name. */
+        name: string;
+    };
+}
+/**
+ * Withdraw from staking balance.
+ * @returns {SuccessResponse}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#withdraw-from-staking
+ */
+export interface CWithdrawRequest extends BaseExchangeRequest {
+    /** Action to be performed. */
+    action: {
+        /** Type of action. */
+        type: "cWithdraw";
+        /** HyperLiquid network. */
+        hyperliquidChain: "Mainnet" | "Testnet";
+        /** Chain ID used for signing. */
+        signatureChainId: Hex;
+        /** Unique request identifier (recommended current timestamp in ms). */
+        nonce: number;
+        /** Amount of wei to withdraw from staking balance. */
+        wei: number;
+    };
+}
+/**
+ * Modify an order.
+ * @returns {SuccessResponse}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#modify-an-order
+ */
+export interface ModifyRequest extends BaseExchangeRequest {
+    /** Action to be performed. */
+    action: {
+        /** Type of action. */
+        type: "modify";
+        /** Order ID to modify. */
+        oid: number;
+        /** New order parameters. */
+        order: OrderParams;
+    };
+    /** Vault address (for vault trading). */
+    vaultAddress?: Hex;
+}
+/**
+ * Place an order(s).
+ * @returns {OrderResponse}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#place-an-order
+ */
+export interface OrderRequest extends BaseExchangeRequest {
+    /** Action to be performed. */
+    action: {
+        /** Type of action. */
+        type: "order";
+        /** Order parameters. */
+        orders: OrderParams[];
+        /**
+         * Order grouping strategy:
+         * - `na`: Standard order without grouping.
+         * - `normalTpsl`: TP/SL order with fixed size that doesn't adjust with position changes.
+         * - `positionTpsl`: TP/SL order that adjusts proportionally with the position size.
+         */
+        grouping: "na" | "normalTpsl" | "positionTpsl";
+        /** Builder fee. */
+        builder?: {
+            /** Builder address. */
+            b: Hex;
+            /** Builder fee in 0.1bps (1 = 0.0001%). */
+            f: number;
+        };
+    };
+    /** Vault address (for vault trading). */
+    vaultAddress?: Hex;
+}
+/**
+ * Schedule a time to cancel all open orders.
+ * @returns {SuccessResponse}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#schedule-cancel-dead-mans-switch
+ */
+export interface ScheduleCancelRequest extends BaseExchangeRequest {
+    /** Action to be performed. */
+    action: {
+        /** Type of action. */
+        type: "scheduleCancel";
+        /**
+         * Scheduled time (in ms since epoch).
+         * Must be at least 5 seconds in the future.
+         *
+         * If not specified, will cause all scheduled cancel operations to be deleted.
+         */
+        time?: number;
+    };
+    /** Vault address (for vault trading). */
+    vaultAddress?: Hex;
+}
+/**
+ * Set a referral code.
+ * @returns {SuccessResponse}
+ * @see null - no documentation
+ */
+export interface SetReferrerRequest extends BaseExchangeRequest {
+    /** Action to be performed. */
+    action: {
+        /** Type of action. */
+        type: "setReferrer";
+        /** Referral code. */
+        code: string;
+    };
+}
+/**
+ * Transfer a spot asset on L1 to another address.
+ * @returns {SuccessResponse}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#l1-spot-transfer
+ */
+export interface SpotSendRequest extends BaseExchangeRequest {
+    /** Action to be performed. */
+    action: {
+        /** Type of action. */
+        type: "spotSend";
+        /** HyperLiquid network. */
+        hyperliquidChain: "Mainnet" | "Testnet";
+        /** Chain ID used for signing. */
+        signatureChainId: Hex;
+        /** Unique request identifier (recommended current timestamp in ms). */
+        time: number;
+        /** Recipient address. */
+        destination: Hex;
+        /** Token identifier. */
+        token: `${string}:${Hex}`;
+        /** Amount to send. */
+        amount: string;
+    };
+}
+/**
+ * Transfer between sub-accounts.
+ * @returns {SuccessResponse}
+ * @see null - no documentation
+ */
+export interface SubAccountTransferRequest extends BaseExchangeRequest {
+    /** Action to be performed. */
+    action: {
+        /** Type of action. */
+        type: "subAccountTransfer";
+        /** Sub-account address. */
+        subAccountUser: Hex;
+        /** `true` for deposit, `false` for withdrawal. */
+        isDeposit: boolean;
+        /** Raw amount to transfer (float * 1e6). */
+        usd: number;
+    };
+}
+/**
+ * Delegate or undelegate stake from a validator.
+ * @returns {SuccessResponse}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#delegate-or-undelegate-stake-from-validator
+ */
+export interface TokenDelegateRequest extends BaseExchangeRequest {
+    /** Action to be performed. */
+    action: {
+        /** Type of action. */
+        type: "tokenDelegate";
+        /** HyperLiquid network. */
+        hyperliquidChain: "Mainnet" | "Testnet";
+        /** Chain ID used for signing. */
+        signatureChainId: Hex;
+        /** Unique request identifier (recommended current timestamp in ms). */
+        nonce: number;
+        /** Validator address. */
+        validator: Hex;
+        /** `true` for undelegate, `false` for delegate. */
+        isUndelegate: boolean;
+        /** Amount of wei to delegate. */
+        wei: number;
+    };
+}
+/**
+ * Cancel a TWAP order.
+ * @returns {TwapCancelResponse}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#cancel-a-twap-order
+ */
+export interface TwapCancelRequest extends BaseExchangeRequest {
+    /** Action to be performed. */
+    action: {
+        /** Type of action. */
+        type: "twapCancel";
+        /** Asset ID. */
+        a: number;
+        /** Twap ID. */
+        t: number;
+    };
+    /** Vault address (for vault trading). */
+    vaultAddress?: Hex;
+}
+/**
+ * Place a TWAP order.
+ * @returns {TwapOrderResponse}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#place-a-twap-order
+ */
+export interface TwapOrderRequest extends BaseExchangeRequest {
+    /** Action to be performed. */
+    action: {
+        /** Type of action. */
+        type: "twapOrder";
+        /** Twap parameters. */
+        twap: {
+            /** Asset ID. */
+            a: number;
+            /** Position side (`true` for long, `false` for short). */
+            b: boolean;
+            /** Size (in base currency units). */
+            s: string;
+            /** Is reduce-only? */
+            r: boolean;
+            /** TWAP duration in minutes. */
+            m: number;
+            /** Enable random order timing. */
+            t: boolean;
+        };
+    };
+    /** Vault address (for vault trading). */
+    vaultAddress?: Hex;
+}
+/**
+ * Update isolated margin for a position.
+ * @returns {SuccessResponse}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#update-isolated-margin
+ */
+export interface UpdateIsolatedMarginRequest extends BaseExchangeRequest {
+    /** Action to be performed. */
+    action: {
+        /** Type of action. */
+        type: "updateIsolatedMargin";
+        /** Asset ID. */
+        asset: number;
+        /** Position side (`true` for long, `false` for short). */
+        isBuy: boolean;
+        /** Amount to adjust (in USD). */
+        ntli: number;
+    };
+    /** Vault address (for vault trading). */
+    vaultAddress?: Hex;
+}
+/**
+ * Update leverage for cross or isolated margin.
+ * @returns {SuccessResponse}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#update-leverage
+ */
+export interface UpdateLeverageRequest extends BaseExchangeRequest {
+    /** Action to be performed. */
+    action: {
+        /** Type of action. */
+        type: "updateLeverage";
+        /** Asset ID. */
+        asset: number;
+        /** `true` for cross leverage, `false` for isolated leverage. */
+        isCross: boolean;
+        /** New leverage value. */
+        leverage: number;
+    };
+    /** Vault address (for vault trading). */
+    vaultAddress?: Hex;
+}
+/**
+ * Transfer funds between Spot and Perp accounts.
+ * @returns {SuccessResponse}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#transfer-from-spot-account-to-perp-account-and-vice-versa
+ */
+export interface UsdClassTransferRequest extends BaseExchangeRequest {
+    /** Action to be performed. */
+    action: {
+        /** Type of action. */
+        type: "usdClassTransfer";
+        /** HyperLiquid network. */
+        hyperliquidChain: "Mainnet" | "Testnet";
+        /** Chain ID used for signing. */
+        signatureChainId: Hex;
+        /** Unique request identifier (recommended current timestamp in ms). */
+        nonce: number;
+        /** Amount to transfer. */
+        amount: string;
+        /** `true` for Spot to Perp, `false` for Perp to Spot. */
+        toPerp: boolean;
+    };
+}
+/**
+ * Transfer USDC on L1 to another address.
+ * @returns {SuccessResponse}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#l1-usdc-transfer
+ */
+export interface UsdSendRequest extends BaseExchangeRequest {
+    /** Action to be performed. */
+    action: {
+        /** Type of action. */
+        type: "usdSend";
+        /** HyperLiquid network. */
+        hyperliquidChain: "Mainnet" | "Testnet";
+        /** Chain ID used for signing. */
+        signatureChainId: Hex;
+        /** Unique request identifier (recommended current timestamp in ms). */
+        time: number;
+        /** Recipient address. */
+        destination: Hex;
+        /** Amount to send. */
+        amount: string;
+    };
+}
+/**
+ * Add or remove funds from a vault.
+ * @returns {SuccessResponse}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#deposit-or-withdraw-from-a-vault
+ */
+export interface VaultTransferRequest extends BaseExchangeRequest {
+    /** Action to be performed. */
+    action: {
+        /** Type of action. */
+        type: "vaultTransfer";
+        /** Vault address. */
+        vaultAddress: Hex;
+        /** `true` for deposit, `false` for withdrawal. */
+        isDeposit: boolean;
+        /** Raw amount to transfer (float * 1e6). */
+        usd: number;
+    };
+}
+/**
+ * Initiate a withdrawal request.
+ * @returns {SuccessResponse}
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#initiate-a-withdrawal-request
+ */
+export interface Withdraw3Request extends BaseExchangeRequest {
+    /** Action to be performed. */
+    action: {
+        /** Type of action. */
+        type: "withdraw3";
+        /** HyperLiquid network. */
+        hyperliquidChain: "Mainnet" | "Testnet";
+        /** Chain ID used for signing. */
+        signatureChainId: Hex;
+        /** Unique request identifier (recommended current timestamp in ms). */
+        time: number;
+        /** Amount to withdraw. */
+        amount: string;
+        /** Recipient address. */
+        destination: Hex;
+    };
+}
+//# sourceMappingURL=requests.d.ts.map

package/esm/src/types/exchange/requests.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"requests.d.ts","sourceRoot":"","sources":["../../../../src/src/types/exchange/requests.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,cAAc,CAAC;AACxC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE/C,4CAA4C;AAC5C,MAAM,WAAW,mBAAmB;IAChC,yBAAyB;IACzB,MAAM,EAAE;QACJ,sBAAsB;QACtB,IAAI,EAAE,MAAM,CAAC;QACb,oCAAoC;QACpC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KAC1B,CAAC;IACF,uEAAuE;IACvE,KAAK,EAAE,MAAM,CAAC;IACd,+BAA+B;IAC/B,SAAS,EAAE;QAAE,CAAC,EAAE,GAAG,CAAC;QAAC,CAAC,EAAE,GAAG,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CAC5C;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAoB,SAAQ,mBAAmB;IAC5D,8BAA8B;IAC9B,MAAM,EAAE;QACJ,sBAAsB;QACtB,IAAI,EAAE,cAAc,CAAC;QACrB,2BAA2B;QAC3B,gBAAgB,EAAE,SAAS,GAAG,SAAS,CAAC;QACxC,iCAAiC;QACjC,gBAAgB,EAAE,GAAG,CAAC;QACtB,uEAAuE;QACvE,KAAK,EAAE,MAAM,CAAC;QACd,qBAAqB;QACrB,YAAY,EAAE,GAAG,CAAC;QAClB,kBAAkB;QAClB,SAAS,EAAE,MAAM,CAAC;KACrB,CAAC;CACL;AAED;;;;GAIG;AACH,MAAM,WAAW,wBAAyB,SAAQ,mBAAmB;IACjE,8BAA8B;IAC9B,MAAM,EAAE;QACJ,sBAAsB;QACtB,IAAI,EAAE,mBAAmB,CAAC;QAC1B,2BAA2B;QAC3B,gBAAgB,EAAE,SAAS,GAAG,SAAS,CAAC;QACxC,iCAAiC;QACjC,gBAAgB,EAAE,GAAG,CAAC;QACtB,uEAAuE;QACvE,KAAK,EAAE,MAAM,CAAC;QACd,oCAAoC;QACpC,UAAU,EAAE,GAAG,MAAM,GAAG,CAAC;QACzB,uBAAuB;QACvB,OAAO,EAAE,GAAG,CAAC;KAChB,CAAC;CACL;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAmB,SAAQ,mBAAmB;IAC3D,8BAA8B;IAC9B,MAAM,EAAE;QACJ,sBAAsB;QACtB,IAAI,EAAE,aAAa,CAAC;QACpB,2BAA2B;QAC3B,QAAQ,EAAE;YACN,0BAA0B;YAC1B,GAAG,EAAE,MAAM,CAAC;YACZ,4BAA4B;YAC5B,KAAK,EAAE,WAAW,CAAC;SACtB,EAAE,CAAC;KACP,CAAC;IACF,yCAAyC;IACzC,YAAY,CAAC,EAAE,GAAG,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAc,SAAQ,mBAAmB;IACtD,8BAA8B;IAC9B,MAAM,EAAE;QACJ,sBAAsB;QACtB,IAAI,EAAE,QAAQ,CAAC;QACf,wBAAwB;QACxB,OAAO,EAAE;YACL,gBAAgB;YAChB,CAAC,EAAE,MAAM,CAAC;YACV,gBAAgB;YAChB,CAAC,EAAE,MAAM,CAAC;SACb,EAAE,CAAC;KACP,CAAC;IACF,yCAAyC;IACzC,YAAY,CAAC,EAAE,GAAG,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAqB,SAAQ,mBAAmB;IAC7D,8BAA8B;IAC9B,MAAM,EAAE;QACJ,sBAAsB;QACtB,IAAI,EAAE,eAAe,CAAC;QACtB,wBAAwB;QACxB,OAAO,EAAE;YACL,gBAAgB;YAChB,KAAK,EAAE,MAAM,CAAC;YACd,uBAAuB;YACvB,KAAK,EAAE,GAAG,CAAC;SACd,EAAE,CAAC;KACP,CAAC;IACF,yCAAyC;IACzC,YAAY,CAAC,EAAE,GAAG,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAgB,SAAQ,mBAAmB;IACxD,8BAA8B;IAC9B,MAAM,EAAE;QACJ,sBAAsB;QACtB,IAAI,EAAE,UAAU,CAAC;QACjB,2BAA2B;QAC3B,gBAAgB,EAAE,SAAS,GAAG,SAAS,CAAC;QACxC,iCAAiC;QACjC,gBAAgB,EAAE,GAAG,CAAC;QACtB,uEAAuE;QACvE,KAAK,EAAE,MAAM,CAAC;QACd,qDAAqD;QACrD,GAAG,EAAE,MAAM,CAAC;KACf,CAAC;CACL;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAwB,SAAQ,mBAAmB;IAChE,8BAA8B;IAC9B,MAAM,EAAE;QACJ,sBAAsB;QACtB,IAAI,EAAE,kBAAkB,CAAC;QACzB,wBAAwB;QACxB,IAAI,EAAE,MAAM,CAAC;KAChB,CAAC;CACL;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAiB,SAAQ,mBAAmB;IACzD,8BAA8B;IAC9B,MAAM,EAAE;QACJ,sBAAsB;QACtB,IAAI,EAAE,WAAW,CAAC;QAClB,2BAA2B;QAC3B,gBAAgB,EAAE,SAAS,GAAG,SAAS,CAAC;QACxC,iCAAiC;QACjC,gBAAgB,EAAE,GAAG,CAAC;QACtB,uEAAuE;QACvE,KAAK,EAAE,MAAM,CAAC;QACd,sDAAsD;QACtD,GAAG,EAAE,MAAM,CAAC;KACf,CAAC;CACL;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAc,SAAQ,mBAAmB;IACtD,8BAA8B;IAC9B,MAAM,EAAE;QACJ,sBAAsB;QACtB,IAAI,EAAE,QAAQ,CAAC;QACf,0BAA0B;QAC1B,GAAG,EAAE,MAAM,CAAC;QACZ,4BAA4B;QAC5B,KAAK,EAAE,WAAW,CAAC;KACtB,CAAC;IACF,yCAAyC;IACzC,YAAY,CAAC,EAAE,GAAG,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAa,SAAQ,mBAAmB;IACrD,8BAA8B;IAC9B,MAAM,EAAE;QACJ,sBAAsB;QACtB,IAAI,EAAE,OAAO,CAAC;QACd,wBAAwB;QACxB,MAAM,EAAE,WAAW,EAAE,CAAC;QACtB;;;;;WAKG;QACH,QAAQ,EAAE,IAAI,GAAG,YAAY,GAAG,cAAc,CAAC;QAC/C,mBAAmB;QACnB,OAAO,CAAC,EAAE;YACN,uBAAuB;YACvB,CAAC,EAAE,GAAG,CAAC;YACP,2CAA2C;YAC3C,CAAC,EAAE,MAAM,CAAC;SACb,CAAC;KACL,CAAC;IACF,yCAAyC;IACzC,YAAY,CAAC,EAAE,GAAG,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAsB,SAAQ,mBAAmB;IAC9D,8BAA8B;IAC9B,MAAM,EAAE;QACJ,sBAAsB;QACtB,IAAI,EAAE,gBAAgB,CAAC;QACvB;;;;;WAKG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,yCAAyC;IACzC,YAAY,CAAC,EAAE,GAAG,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAmB,SAAQ,mBAAmB;IAC3D,8BAA8B;IAC9B,MAAM,EAAE;QACJ,sBAAsB;QACtB,IAAI,EAAE,aAAa,CAAC;QACpB,qBAAqB;QACrB,IAAI,EAAE,MAAM,CAAC;KAChB,CAAC;CACL;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAgB,SAAQ,mBAAmB;IACxD,8BAA8B;IAC9B,MAAM,EAAE;QACJ,sBAAsB;QACtB,IAAI,EAAE,UAAU,CAAC;QACjB,2BAA2B;QAC3B,gBAAgB,EAAE,SAAS,GAAG,SAAS,CAAC;QACxC,iCAAiC;QACjC,gBAAgB,EAAE,GAAG,CAAC;QACtB,uEAAuE;QACvE,IAAI,EAAE,MAAM,CAAC;QACb,yBAAyB;QACzB,WAAW,EAAE,GAAG,CAAC;QACjB,wBAAwB;QACxB,KAAK,EAAE,GAAG,MAAM,IAAI,GAAG,EAAE,CAAC;QAC1B,sBAAsB;QACtB,MAAM,EAAE,MAAM,CAAC;KAClB,CAAC;CACL;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAA0B,SAAQ,mBAAmB;IAClE,8BAA8B;IAC9B,MAAM,EAAE;QACJ,sBAAsB;QACtB,IAAI,EAAE,oBAAoB,CAAC;QAC3B,2BAA2B;QAC3B,cAAc,EAAE,GAAG,CAAC;QACpB,kDAAkD;QAClD,SAAS,EAAE,OAAO,CAAC;QACnB,4CAA4C;QAC5C,GAAG,EAAE,MAAM,CAAC;KACf,CAAC;CACL;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAqB,SAAQ,mBAAmB;IAC7D,8BAA8B;IAC9B,MAAM,EAAE;QACJ,sBAAsB;QACtB,IAAI,EAAE,eAAe,CAAC;QACtB,2BAA2B;QAC3B,gBAAgB,EAAE,SAAS,GAAG,SAAS,CAAC;QACxC,iCAAiC;QACjC,gBAAgB,EAAE,GAAG,CAAC;QACtB,uEAAuE;QACvE,KAAK,EAAE,MAAM,CAAC;QACd,yBAAyB;QACzB,SAAS,EAAE,GAAG,CAAC;QACf,mDAAmD;QACnD,YAAY,EAAE,OAAO,CAAC;QACtB,iCAAiC;QACjC,GAAG,EAAE,MAAM,CAAC;KACf,CAAC;CACL;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAkB,SAAQ,mBAAmB;IAC1D,8BAA8B;IAC9B,MAAM,EAAE;QACJ,sBAAsB;QACtB,IAAI,EAAE,YAAY,CAAC;QACnB,gBAAgB;QAChB,CAAC,EAAE,MAAM,CAAC;QACV,eAAe;QACf,CAAC,EAAE,MAAM,CAAC;KACb,CAAC;IACF,yCAAyC;IACzC,YAAY,CAAC,EAAE,GAAG,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAiB,SAAQ,mBAAmB;IACzD,8BAA8B;IAC9B,MAAM,EAAE;QACJ,sBAAsB;QACtB,IAAI,EAAE,WAAW,CAAC;QAClB,uBAAuB;QACvB,IAAI,EAAE;YACF,gBAAgB;YAChB,CAAC,EAAE,MAAM,CAAC;YACV,0DAA0D;YAC1D,CAAC,EAAE,OAAO,CAAC;YACX,qCAAqC;YACrC,CAAC,EAAE,MAAM,CAAC;YACV,sBAAsB;YACtB,CAAC,EAAE,OAAO,CAAC;YACX,gCAAgC;YAChC,CAAC,EAAE,MAAM,CAAC;YACV,kCAAkC;YAClC,CAAC,EAAE,OAAO,CAAC;SACd,CAAC;KACL,CAAC;IACF,yCAAyC;IACzC,YAAY,CAAC,EAAE,GAAG,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,2BAA4B,SAAQ,mBAAmB;IACpE,8BAA8B;IAC9B,MAAM,EAAE;QACJ,sBAAsB;QACtB,IAAI,EAAE,sBAAsB,CAAC;QAC7B,gBAAgB;QAChB,KAAK,EAAE,MAAM,CAAC;QACd,0DAA0D;QAC1D,KAAK,EAAE,OAAO,CAAC;QACf,iCAAiC;QACjC,IAAI,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,yCAAyC;IACzC,YAAY,CAAC,EAAE,GAAG,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAsB,SAAQ,mBAAmB;IAC9D,8BAA8B;IAC9B,MAAM,EAAE;QACJ,sBAAsB;QACtB,IAAI,EAAE,gBAAgB,CAAC;QACvB,gBAAgB;QAChB,KAAK,EAAE,MAAM,CAAC;QACd,gEAAgE;QAChE,OAAO,EAAE,OAAO,CAAC;QACjB,0BAA0B;QAC1B,QAAQ,EAAE,MAAM,CAAC;KACpB,CAAC;IACF,yCAAyC;IACzC,YAAY,CAAC,EAAE,GAAG,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAwB,SAAQ,mBAAmB;IAChE,8BAA8B;IAC9B,MAAM,EAAE;QACJ,sBAAsB;QACtB,IAAI,EAAE,kBAAkB,CAAC;QACzB,2BAA2B;QAC3B,gBAAgB,EAAE,SAAS,GAAG,SAAS,CAAC;QACxC,iCAAiC;QACjC,gBAAgB,EAAE,GAAG,CAAC;QACtB,uEAAuE;QACvE,KAAK,EAAE,MAAM,CAAC;QACd,0BAA0B;QAC1B,MAAM,EAAE,MAAM,CAAC;QACf,yDAAyD;QACzD,MAAM,EAAE,OAAO,CAAC;KACnB,CAAC;CACL;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAe,SAAQ,mBAAmB;IACvD,8BAA8B;IAC9B,MAAM,EAAE;QACJ,sBAAsB;QACtB,IAAI,EAAE,SAAS,CAAC;QAChB,2BAA2B;QAC3B,gBAAgB,EAAE,SAAS,GAAG,SAAS,CAAC;QACxC,iCAAiC;QACjC,gBAAgB,EAAE,GAAG,CAAC;QACtB,uEAAuE;QACvE,IAAI,EAAE,MAAM,CAAC;QACb,yBAAyB;QACzB,WAAW,EAAE,GAAG,CAAC;QACjB,sBAAsB;QACtB,MAAM,EAAE,MAAM,CAAC;KAClB,CAAC;CACL;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAqB,SAAQ,mBAAmB;IAC7D,8BAA8B;IAC9B,MAAM,EAAE;QACJ,sBAAsB;QACtB,IAAI,EAAE,eAAe,CAAC;QACtB,qBAAqB;QACrB,YAAY,EAAE,GAAG,CAAC;QAClB,kDAAkD;QAClD,SAAS,EAAE,OAAO,CAAC;QACnB,4CAA4C;QAC5C,GAAG,EAAE,MAAM,CAAC;KACf,CAAC;CACL;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAiB,SAAQ,mBAAmB;IACzD,8BAA8B;IAC9B,MAAM,EAAE;QACJ,sBAAsB;QACtB,IAAI,EAAE,WAAW,CAAC;QAClB,2BAA2B;QAC3B,gBAAgB,EAAE,SAAS,GAAG,SAAS,CAAC;QACxC,iCAAiC;QACjC,gBAAgB,EAAE,GAAG,CAAC;QACtB,uEAAuE;QACvE,IAAI,EAAE,MAAM,CAAC;QACb,0BAA0B;QAC1B,MAAM,EAAE,MAAM,CAAC;QACf,yBAAyB;QACzB,WAAW,EAAE,GAAG,CAAC;KACpB,CAAC;CACL"}

package/esm/src/types/exchange/requests.js

@@ -0,0 +1 @@
+export {};

package/esm/src/types/exchange/responses.d.ts

@@ -0,0 +1,141 @@
+import type { Hex } from "../common.js";
+/** Base structure for exchange responses. */
+export interface BaseExchangeResponse {
+    /** Response status */
+    status: "ok" | "err";
+    /** Error message or success data */
+    response: string | {
+        /** Type of response. */
+        type: string;
+        /** Specific data for the operation. */
+        data?: unknown;
+    };
+}
+/** Successful response without specific data. */
+export interface SuccessResponse extends BaseExchangeResponse {
+    /** Successful status. */
+    status: "ok";
+    /** Response details. */
+    response: {
+        /** Type of response. */
+        type: "default";
+    };
+}
+/** Error response for failed operations. */
+export interface ErrorResponse extends BaseExchangeResponse {
+    /** Error status. */
+    status: "err";
+    /** Error message. */
+    response: string;
+}
+/** Response for order cancellation. */
+export interface CancelResponse extends BaseExchangeResponse {
+    /** Successful status. */
+    status: "ok";
+    /** Response details. */
+    response: {
+        /** Type of response. */
+        type: "cancel";
+        /** Specific data. */
+        data: {
+            /** Array of statuses or error messages. */
+            statuses: ("success" | {
+                /** Error message. */
+                error: string;
+            })[];
+        };
+    };
+}
+/** Response for creating a sub-account. */
+export interface CreateSubAccountResponse extends BaseExchangeResponse {
+    /** Successful status. */
+    status: "ok";
+    /** Response details. */
+    response: {
+        /** Type of response. */
+        type: "createSubAccount";
+        /** Sub-account address. */
+        data: Hex;
+    };
+}
+/** Response for order placement and batch modifications. */
+export interface OrderResponse extends BaseExchangeResponse {
+    /** Successful status. */
+    status: "ok";
+    /** Response details. */
+    response: {
+        /** Type of response. */
+        type: "order";
+        /** Specific data. */
+        data: {
+            /** Array of statuses or error messages. */
+            statuses: ({
+                /** Resting order status. */
+                resting: {
+                    /** Order ID. */
+                    oid: number;
+                    /** Client Order ID. */
+                    cloid?: Hex;
+                };
+            } | {
+                /** Filled order status. */
+                filled: {
+                    /** Total size filled. */
+                    totalSz: string;
+                    /** Average price of fill. */
+                    avgPx: string;
+                    /** Order ID. */
+                    oid: number;
+                    /** Client Order ID. */
+                    cloid?: Hex;
+                };
+            } | {
+                /** Error message. */
+                error: string;
+            })[];
+        };
+    };
+}
+/** Response for creating a TWAP order. */
+export interface TwapOrderResponse extends BaseExchangeResponse {
+    /** Successful status. */
+    status: "ok";
+    /** Response details. */
+    response: {
+        /** Type of response. */
+        type: "twapOrder";
+        /** Specific data. */
+        data: {
+            /** Status of the operation. */
+            status: {
+                /** Running order status. */
+                running: {
+                    /** TWAP ID. */
+                    twapId: number;
+                };
+            } | {
+                /** Error message. */
+                error: string;
+            };
+        };
+    };
+}
+/** Response for canceling a TWAP order. */
+export interface TwapCancelResponse extends BaseExchangeResponse {
+    /** Successful status. */
+    status: "ok";
+    /** Response details. */
+    response: {
+        /** Type of response. */
+        type: "twapCancel";
+        /** Specific data. */
+        data: {
+            /** Status of the operation. */
+            status: string | {
+                /** Error message. */
+                error: string;
+            };
+        };
+    };
+}
+//# sourceMappingURL=responses.d.ts.map

package/esm/src/types/exchange/responses.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/src/types/exchange/responses.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,cAAc,CAAC;AAExC,6CAA6C;AAC7C,MAAM,WAAW,oBAAoB;IACjC,sBAAsB;IACtB,MAAM,EAAE,IAAI,GAAG,KAAK,CAAC;IACrB,oCAAoC;IACpC,QAAQ,EACF,MAAM,GACN;QACE,wBAAwB;QACxB,IAAI,EAAE,MAAM,CAAC;QACb,uCAAuC;QACvC,IAAI,CAAC,EAAE,OAAO,CAAC;KAClB,CAAC;CACT;AAED,iDAAiD;AACjD,MAAM,WAAW,eAAgB,SAAQ,oBAAoB;IACzD,yBAAyB;IACzB,MAAM,EAAE,IAAI,CAAC;IACb,wBAAwB;IACxB,QAAQ,EAAE;QACN,wBAAwB;QACxB,IAAI,EAAE,SAAS,CAAC;KACnB,CAAC;CACL;AAED,4CAA4C;AAC5C,MAAM,WAAW,aAAc,SAAQ,oBAAoB;IACvD,oBAAoB;IACpB,MAAM,EAAE,KAAK,CAAC;IACd,qBAAqB;IACrB,QAAQ,EAAE,MAAM,CAAC;CACpB;AAED,uCAAuC;AACvC,MAAM,WAAW,cAAe,SAAQ,oBAAoB;IACxD,yBAAyB;IACzB,MAAM,EAAE,IAAI,CAAC;IACb,wBAAwB;IACxB,QAAQ,EAAE;QACN,wBAAwB;QACxB,IAAI,EAAE,QAAQ,CAAC;QACf,qBAAqB;QACrB,IAAI,EAAE;YACF,2CAA2C;YAC3C,QAAQ,EAAE,CACJ,SAAS,GACT;gBACE,qBAAqB;gBACrB,KAAK,EAAE,MAAM,CAAC;aACjB,CACJ,EAAE,CAAC;SACP,CAAC;KACL,CAAC;CACL;AAED,2CAA2C;AAC3C,MAAM,WAAW,wBAAyB,SAAQ,oBAAoB;IAClE,yBAAyB;IACzB,MAAM,EAAE,IAAI,CAAC;IACb,wBAAwB;IACxB,QAAQ,EAAE;QACN,wBAAwB;QACxB,IAAI,EAAE,kBAAkB,CAAC;QACzB,2BAA2B;QAC3B,IAAI,EAAE,GAAG,CAAC;KACb,CAAC;CACL;AAED,4DAA4D;AAC5D,MAAM,WAAW,aAAc,SAAQ,oBAAoB;IACvD,yBAAyB;IACzB,MAAM,EAAE,IAAI,CAAC;IACb,wBAAwB;IACxB,QAAQ,EAAE;QACN,wBAAwB;QACxB,IAAI,EAAE,OAAO,CAAC;QACd,qBAAqB;QACrB,IAAI,EAAE;YACF,2CAA2C;YAC3C,QAAQ,EAAE,CACJ;gBACE,4BAA4B;gBAC5B,OAAO,EAAE;oBACL,gBAAgB;oBAChB,GAAG,EAAE,MAAM,CAAC;oBACZ,uBAAuB;oBACvB,KAAK,CAAC,EAAE,GAAG,CAAC;iBACf,CAAC;aACL,GACC;gBACE,2BAA2B;gBAC3B,MAAM,EAAE;oBACJ,yBAAyB;oBACzB,OAAO,EAAE,MAAM,CAAC;oBAChB,6BAA6B;oBAC7B,KAAK,EAAE,MAAM,CAAC;oBACd,gBAAgB;oBAChB,GAAG,EAAE,MAAM,CAAC;oBACZ,uBAAuB;oBACvB,KAAK,CAAC,EAAE,GAAG,CAAC;iBACf,CAAC;aACL,GACC;gBACE,qBAAqB;gBACrB,KAAK,EAAE,MAAM,CAAC;aACjB,CACJ,EAAE,CAAC;SACP,CAAC;KACL,CAAC;CACL;AAED,0CAA0C;AAC1C,MAAM,WAAW,iBAAkB,SAAQ,oBAAoB;IAC3D,yBAAyB;IACzB,MAAM,EAAE,IAAI,CAAC;IACb,wBAAwB;IACxB,QAAQ,EAAE;QACN,wBAAwB;QACxB,IAAI,EAAE,WAAW,CAAC;QAClB,qBAAqB;QACrB,IAAI,EAAE;YACF,+BAA+B;YAC/B,MAAM,EACA;gBACE,4BAA4B;gBAC5B,OAAO,EAAE;oBACL,eAAe;oBACf,MAAM,EAAE,MAAM,CAAC;iBAClB,CAAC;aACL,GACC;gBACE,qBAAqB;gBACrB,KAAK,EAAE,MAAM,CAAC;aACjB,CAAC;SACT,CAAC;KACL,CAAC;CACL;AAED,2CAA2C;AAC3C,MAAM,WAAW,kBAAmB,SAAQ,oBAAoB;IAC5D,yBAAyB;IACzB,MAAM,EAAE,IAAI,CAAC;IACb,wBAAwB;IACxB,QAAQ,EAAE;QACN,wBAAwB;QACxB,IAAI,EAAE,YAAY,CAAC;QACnB,qBAAqB;QACrB,IAAI,EAAE;YACF,+BAA+B;YAC/B,MAAM,EACA,MAAM,GACN;gBACE,qBAAqB;gBACrB,KAAK,EAAE,MAAM,CAAC;aACjB,CAAC;SACT,CAAC;KACL,CAAC;CACL"}

package/esm/src/types/exchange/responses.js

@@ -0,0 +1 @@
+export {};