@nktkas/hyperliquid
Version:
Hyperliquid API SDK for all major JS runtimes, written in TypeScript.
158 lines (157 loc) • 9.15 kB
TypeScript
/// <amd-module name="file:///home/runner/work/hyperliquid/hyperliquid/src/api/exchange/_methods/userPortfolioMargin.ts" />
import * as v from "valibot";
/**
* Enable/disable user portfolio margin.
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/trading/portfolio-margin
*/
export declare const UserPortfolioMarginRequest: v.ObjectSchema<{
/** Action to perform. */
readonly action: v.ObjectSchema<{
/** Type of action. */
readonly type: v.LiteralSchema<"userPortfolioMargin", undefined>;
/** Chain ID in hex format for EIP-712 signing. */
readonly signatureChainId: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>;
/** Hyperliquid network type. */
readonly hyperliquidChain: v.PicklistSchema<["Mainnet", "Testnet"], undefined>;
/** User address. */
readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>;
/** Whether to enable or disable user portfolio margin. */
readonly enabled: v.BooleanSchema<undefined>;
/** Nonce (timestamp in ms) used to prevent replay attacks. */
readonly nonce: v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToNumberAction<string | number, undefined>, v.NumberSchema<undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
}, undefined>;
/** Nonce (timestamp in ms) used to prevent replay attacks. */
readonly nonce: v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToNumberAction<string | number, undefined>, v.NumberSchema<undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
/** ECDSA signature components. */
readonly signature: v.ObjectSchema<{
/** First 32-byte component. */
readonly r: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 66, undefined>]>;
/** Second 32-byte component. */
readonly s: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 66, undefined>]>;
/** Recovery identifier. */
readonly v: v.PicklistSchema<[27, 28], undefined>;
}, undefined>;
}, undefined>;
export type UserPortfolioMarginRequest = v.InferOutput<typeof UserPortfolioMarginRequest>;
/**
* Successful response without specific data or error response.
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/trading/portfolio-margin
*/
export type UserPortfolioMarginResponse = {
/** Successful status. */
status: "ok";
/** Response details. */
response: {
/** Type of response. */
type: "default";
};
} | {
/** Error status. */
status: "err";
/** Error message. */
response: string;
};
import { type ExchangeConfig, type ExcludeErrorResponse, type ExtractRequestOptions } from "./_base/mod.js";
/** Schema for action fields (excludes request-level system fields). */
declare const UserPortfolioMarginActionSchema: Omit<v.ObjectSchema<{
/** Type of action. */
readonly type: v.LiteralSchema<"userPortfolioMargin", undefined>;
/** Chain ID in hex format for EIP-712 signing. */
readonly signatureChainId: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>;
/** Hyperliquid network type. */
readonly hyperliquidChain: v.PicklistSchema<["Mainnet", "Testnet"], undefined>;
/** User address. */
readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>;
/** Whether to enable or disable user portfolio margin. */
readonly enabled: v.BooleanSchema<undefined>;
/** Nonce (timestamp in ms) used to prevent replay attacks. */
readonly nonce: v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToNumberAction<string | number, undefined>, v.NumberSchema<undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
}, undefined>, "entries" | "~types" | "~run" | "~standard"> & {
readonly entries: Omit<{
/** Type of action. */
readonly type: v.LiteralSchema<"userPortfolioMargin", undefined>;
/** Chain ID in hex format for EIP-712 signing. */
readonly signatureChainId: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>;
/** Hyperliquid network type. */
readonly hyperliquidChain: v.PicklistSchema<["Mainnet", "Testnet"], undefined>;
/** User address. */
readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>;
/** Whether to enable or disable user portfolio margin. */
readonly enabled: v.BooleanSchema<undefined>;
/** Nonce (timestamp in ms) used to prevent replay attacks. */
readonly nonce: v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToNumberAction<string | number, undefined>, v.NumberSchema<undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>;
}, "signatureChainId" | "hyperliquidChain" | "nonce">;
readonly "~standard": v.StandardProps<{
type: "userPortfolioMargin";
user: string;
enabled: boolean;
}, {
type: "userPortfolioMargin";
user: `0x${string}`;
enabled: boolean;
}>;
readonly "~run": (dataset: v.UnknownDataset, config: v.Config<v.BaseIssue<unknown>>) => v.OutputDataset<{
type: "userPortfolioMargin";
user: `0x${string}`;
enabled: boolean;
}, v.ObjectIssue | v.BooleanIssue | v.LiteralIssue | v.StringIssue | v.RegexIssue<string> | v.LengthIssue<`0x${string}`, 42>>;
readonly "~types"?: {
readonly input: {
type: "userPortfolioMargin";
user: string;
enabled: boolean;
};
readonly output: {
type: "userPortfolioMargin";
user: `0x${string}`;
enabled: boolean;
};
readonly issue: v.ObjectIssue | v.BooleanIssue | v.LiteralIssue | v.StringIssue | v.RegexIssue<string> | v.LengthIssue<`0x${string}`, 42>;
} | undefined;
};
/** Action parameters for the {@linkcode userPortfolioMargin} function. */
export type UserPortfolioMarginParameters = Omit<v.InferInput<typeof UserPortfolioMarginActionSchema>, "type">;
/** Request options for the {@linkcode userPortfolioMargin} function. */
export type UserPortfolioMarginOptions = ExtractRequestOptions<v.InferInput<typeof UserPortfolioMarginRequest>>;
/** Successful variant of {@linkcode UserPortfolioMarginResponse} without errors. */
export type UserPortfolioMarginSuccessResponse = ExcludeErrorResponse<UserPortfolioMarginResponse>;
/** EIP-712 types for the {@linkcode userPortfolioMargin} function. */
export declare const UserPortfolioMarginTypes: {
"HyperliquidTransaction:UserPortfolioMargin": {
name: string;
type: string;
}[];
};
/**
* Enable/disable user portfolio margin.
*
* Signing: User-Signed EIP-712.
*
* @param config General configuration for Exchange API requests.
* @param params Parameters specific to the API request.
* @param opts Request execution options.
* @return Successful response without specific data.
*
* @throws {ValidationError} When the request parameters fail validation (before sending).
* @throws {TransportError} When the transport layer throws an error.
* @throws {ApiRequestError} When the API returns an unsuccessful response.
*
* @example
* ```ts
* import { HttpTransport } from "@nktkas/hyperliquid";
* import { userPortfolioMargin } from "@nktkas/hyperliquid/api/exchange";
* import { privateKeyToAccount } from "npm:viem/accounts";
*
* const wallet = privateKeyToAccount("0x..."); // viem or ethers
* const transport = new HttpTransport(); // or `WebSocketTransport`
*
* await userPortfolioMargin({ transport, wallet }, {
* user: "0x...",
* enabled: true,
* });
* ```
*
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/trading/portfolio-margin
*/
export declare function userPortfolioMargin(config: ExchangeConfig, params: UserPortfolioMarginParameters, opts?: UserPortfolioMarginOptions): Promise<UserPortfolioMarginSuccessResponse>;
export {};