@nktkas/hyperliquid/script/src/api/exchange/_methods/_base/execute.d.ts

Hyperliquid API SDK for all major JS runtimes, written in TypeScript.

import type { HttpTransport } from "../../../../transport/http/mod.js";
import type { WebSocketTransport } from "../../../../transport/websocket/mod.js";
import { type AbstractWallet } from "../../../../signing/mod.js";
type MaybePromise<T> = T | Promise<T>;
type Prettify<T> = {
    [K in keyof T]: T[K];
} & {};
/** Extract request options from a request type (excludes action, nonce, signature). */
export type ExtractRequestOptions<T extends {
    action: Record<string, unknown>;
}> = Prettify<{
    signal?: AbortSignal;
} & Omit<T, "action" | "nonce" | "signature">>;
/** Base configuration shared by single-wallet and multi-sig configs. */
interface BaseConfig<T extends HttpTransport | WebSocketTransport = HttpTransport | WebSocketTransport> {
    /** The transport used to connect to the Hyperliquid Exchange API. */
    transport: T;
    /** Signature chain ID for EIP-712 signing, defaults to wallet's chain ID. */
    signatureChainId?: `0x${string}` | (() => MaybePromise<`0x${string}`>);
    /**
     * Default vault address for vault-based operations, used when not specified in action options.
     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#subaccounts-and-vaults
     */
    defaultVaultAddress?: `0x${string}`;
    /**
     * Default expiration time in milliseconds, used when not specified in action options.
     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#expires-after
     */
    defaultExpiresAfter?: number | (() => MaybePromise<number>);
    /**
     * Custom nonce generator function.
     * Defaults to a global manager using timestamp with auto-increment.
     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/nonces-and-api-wallets#hyperliquid-nonces
     */
    nonceManager?: (address: string) => MaybePromise<number>;
}
/** Configuration for single-wallet Exchange API requests. */
export interface ExchangeSingleWalletConfig<T extends HttpTransport | WebSocketTransport = HttpTransport | WebSocketTransport> extends BaseConfig<T> {
    /** The wallet used to sign requests. */
    wallet: AbstractWallet;
}
/** Configuration for multi-signature Exchange API requests. */
export interface ExchangeMultiSigConfig<T extends HttpTransport | WebSocketTransport = HttpTransport | WebSocketTransport> extends BaseConfig<T> {
    /** Array of wallets for multi-sig. First wallet is the leader. */
    wallet: readonly [AbstractWallet, ...AbstractWallet[]];
    /** The multi-signature account address. */
    multiSigUser: `0x${string}`;
}
/** Union type for all Exchange API configurations. */
export type ExchangeConfig = ExchangeSingleWalletConfig | ExchangeMultiSigConfig;
/**
 * Execute an L1 action on the Hyperliquid Exchange.
 * Handles both single-wallet and multi-sig signing.
 */
export declare function executeL1Action<T>(config: ExchangeConfig, action: Record<string, unknown>, options?: {
    vaultAddress?: string;
    expiresAfter?: string | number;
    signal?: AbortSignal;
}): Promise<T>;
/**
 * Execute a user-signed action (EIP-712) on the Hyperliquid Exchange.
 * Handles both single-wallet and multi-sig signing.
 * Automatically adds signatureChainId, hyperliquidChain, and nonce/time.
 */
export declare function executeUserSignedAction<T>(config: ExchangeConfig, action: Record<string, unknown>, types: Record<string, {
    name: string;
    type: string;
}[]>, options?: {
    signal?: AbortSignal;
}): Promise<T>;
export {};
//# sourceMappingURL=execute.d.ts.map