@hfunlabs/hyperliquid 0.27.1-hfunlabs.1

package/script/src/api/exchange/perpDeploy.d.ts

@@ -0,0 +1,400 @@
+import * as v from "valibot";
+/**
+ * Deploying HIP-3 assets.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/deploying-hip-3-assets
+ */
+export declare const PerpDeployRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Action to perform. */
+    readonly action: v.SchemaWithPipe<readonly [v.UnionSchema<[v.ObjectSchema<{
+        /** Type of action. */
+        readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"perpDeploy", undefined>, v.DescriptionAction<"perpDeploy", "Type of action.">]>;
+        /** Parameters for registering a new perpetual asset. */
+        readonly registerAsset: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+            /** Max gas in native token wei. If not provided, then uses current deploy auction price. */
+            readonly maxGas: v.SchemaWithPipe<readonly [v.NullableSchema<v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, undefined>, v.DescriptionAction<number | null, "Max gas in native token wei. If not provided, then uses current deploy auction price.">]>;
+            /** Contains new asset listing parameters. */
+            readonly assetRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+                /** Coin symbol for the new asset. */
+                readonly coin: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Coin symbol for the new asset.">]>;
+                /** Number of decimal places for size. */
+                readonly szDecimals: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Number of decimal places for size.">]>;
+                /** Initial oracle price for the asset. */
+                readonly oraclePx: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Initial oracle price for the asset.">]>;
+                /** Margin table identifier for risk management. */
+                readonly marginTableId: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Margin table identifier for risk management.">]>;
+                /** Whether the asset can only be traded with isolated margin. */
+                readonly onlyIsolated: v.SchemaWithPipe<readonly [v.BooleanSchema<undefined>, v.DescriptionAction<boolean, "Whether the asset can only be traded with isolated margin.">]>;
+            }, undefined>, v.DescriptionAction<{
+                coin: string;
+                szDecimals: number;
+                oraclePx: string;
+                marginTableId: number;
+                onlyIsolated: boolean;
+            }, "Contains new asset listing parameters.">]>;
+            /** Name of the dex. */
+            readonly dex: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Name of the dex.">]>;
+            /** Contains new dex parameters. */
+            readonly schema: v.SchemaWithPipe<readonly [v.NullableSchema<v.ObjectSchema<{
+                /** Full name of the dex. */
+                readonly fullName: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Full name of the dex.">]>;
+                /** Collateral token index. */
+                readonly collateralToken: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Collateral token index.">]>;
+                /** User to update oracles. If not provided, then deployer is assumed to be oracle updater. */
+                readonly oracleUpdater: v.SchemaWithPipe<readonly [v.NullableSchema<v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, undefined>, v.DescriptionAction<`0x${string}` | null, "User to update oracles. If not provided, then deployer is assumed to be oracle updater.">]>;
+            }, undefined>, undefined>, v.DescriptionAction<{
+                fullName: string;
+                collateralToken: number;
+                oracleUpdater: `0x${string}` | null;
+            } | null, "Contains new dex parameters.">]>;
+        }, undefined>, v.DescriptionAction<{
+            maxGas: number | null;
+            assetRequest: {
+                coin: string;
+                szDecimals: number;
+                oraclePx: string;
+                marginTableId: number;
+                onlyIsolated: boolean;
+            };
+            dex: string;
+            schema: {
+                fullName: string;
+                collateralToken: number;
+                oracleUpdater: `0x${string}` | null;
+            } | null;
+        }, "Parameters for registering a new perpetual asset.">]>;
+    }, undefined>, v.ObjectSchema<{
+        /** Type of action. */
+        readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"perpDeploy", undefined>, v.DescriptionAction<"perpDeploy", "Type of action.">]>;
+        /** Parameters for setting oracle and mark prices for assets. */
+        readonly setOracle: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+            /** Name of the dex. */
+            readonly dex: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>, v.DescriptionAction<string, "Name of the dex.">]>;
+            /** A list (sorted by key) of asset and oracle prices. */
+            readonly oraclePxs: v.SchemaWithPipe<readonly [v.ArraySchema<v.TupleSchema<[v.StringSchema<undefined>, v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>], undefined>, undefined>, v.DescriptionAction<[string, string][], "A list (sorted by key) of asset and oracle prices.">]>;
+            /** An outer list of inner lists (inner list sorted by key) of asset and mark prices. */
+            readonly markPxs: v.SchemaWithPipe<readonly [v.ArraySchema<v.ArraySchema<v.TupleSchema<[v.StringSchema<undefined>, v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>], undefined>, undefined>, undefined>, v.DescriptionAction<[string, string][][], "An outer list of inner lists (inner list sorted by key) of asset and mark prices.">]>;
+            /** A list (sorted by key) of asset and external prices which prevent sudden mark price deviations. */
+            readonly externalPerpPxs: v.SchemaWithPipe<readonly [v.ArraySchema<v.TupleSchema<[v.StringSchema<undefined>, v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>], undefined>, undefined>, v.DescriptionAction<[string, string][], "A list (sorted by key) of asset and external prices which prevent sudden mark price deviations.">]>;
+        }, undefined>, v.DescriptionAction<{
+            dex: string;
+            oraclePxs: [string, string][];
+            markPxs: [string, string][][];
+            externalPerpPxs: [string, string][];
+        }, "Parameters for setting oracle and mark prices for assets.">]>;
+    }, undefined>, v.ObjectSchema<{
+        /** Type of action. */
+        readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"perpDeploy", undefined>, v.DescriptionAction<"perpDeploy", "Type of action.">]>;
+        /** A list (sorted by key) of asset and funding multiplier. */
+        readonly setFundingMultipliers: v.SchemaWithPipe<readonly [v.ArraySchema<v.TupleSchema<[v.StringSchema<undefined>, v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>], undefined>, undefined>, v.DescriptionAction<[string, string][], "A list (sorted by key) of asset and funding multiplier.">]>;
+    }, undefined>, v.ObjectSchema<{
+        /** Type of action. */
+        readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"perpDeploy", undefined>, v.DescriptionAction<"perpDeploy", "Type of action.">]>;
+        /** Parameters for halting or resuming trading for an asset. */
+        readonly haltTrading: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+            readonly coin: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Coin symbol for the asset to halt or resume.">]>;
+            readonly isHalted: v.SchemaWithPipe<readonly [v.BooleanSchema<undefined>, v.DescriptionAction<boolean, "Whether trading should be halted (true) or resumed (false).">]>;
+        }, undefined>, v.DescriptionAction<{
+            coin: string;
+            isHalted: boolean;
+        }, "Parameters for halting or resuming trading for an asset.">]>;
+    }, undefined>, v.ObjectSchema<{
+        /** Type of action. */
+        readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"perpDeploy", undefined>, v.DescriptionAction<"perpDeploy", "Type of action.">]>;
+        /** A list (sorted by key) of asset and margin table ids. */
+        readonly setMarginTableIds: v.SchemaWithPipe<readonly [v.ArraySchema<v.TupleSchema<[v.StringSchema<undefined>, v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>], undefined>, undefined>, v.DescriptionAction<[string, number][], "A list (sorted by key) of asset and margin table ids.">]>;
+    }, undefined>, v.ObjectSchema<{
+        /** Type of action. */
+        readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"perpDeploy", undefined>, v.DescriptionAction<"perpDeploy", "Type of action.">]>;
+        /** Parameters for setting the fee recipient. */
+        readonly setFeeRecipient: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+            /** Name of the DEX. */
+            readonly dex: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Name of the DEX.">]>;
+            /** Address of the fee recipient. */
+            readonly feeRecipient: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "Address of the fee recipient.">]>;
+        }, undefined>, v.DescriptionAction<{
+            dex: string;
+            feeRecipient: `0x${string}`;
+        }, "Parameters for setting the fee recipient.">]>;
+    }, undefined>, v.ObjectSchema<{
+        /** Type of action. */
+        readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"perpDeploy", undefined>, v.DescriptionAction<"perpDeploy", "Type of action.">]>;
+        /** A list (sorted by key) of asset and open interest cap notionals. */
+        readonly setOpenInterestCaps: v.SchemaWithPipe<readonly [v.ArraySchema<v.TupleSchema<[v.StringSchema<undefined>, v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>], undefined>, undefined>, v.DescriptionAction<[string, number][], "A list (sorted by key) of asset and open interest cap notionals.">]>;
+    }, undefined>, v.ObjectSchema<{
+        /** Type of action. */
+        readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"perpDeploy", undefined>, v.DescriptionAction<"perpDeploy", "Type of action.">]>;
+        /** A modification to sub-deployer permissions. */
+        readonly setSubDeployers: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+            /** Name of the DEX. */
+            readonly dex: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Name of the DEX.">]>;
+            /** A modification to sub-deployer permissions. */
+            readonly subDeployers: v.SchemaWithPipe<readonly [v.ArraySchema<v.ObjectSchema<{
+                /** Corresponds to a variant of PerpDeployAction. */
+                readonly variant: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Corresponds to a variant of PerpDeployAction.">]>;
+                /** Sub-deployer address. */
+                readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "Sub-deployer address.">]>;
+                /** Add or remove the subDeployer from the authorized set for the action variant. */
+                readonly allowed: v.SchemaWithPipe<readonly [v.BooleanSchema<undefined>, v.DescriptionAction<boolean, "Add or remove the subDeployer from the authorized set for the action variant.">]>;
+            }, undefined>, undefined>, v.DescriptionAction<{
+                variant: string;
+                user: `0x${string}`;
+                allowed: boolean;
+            }[], "A modification to sub-deployer permissions.">]>;
+        }, undefined>, v.DescriptionAction<{
+            dex: string;
+            subDeployers: {
+                variant: string;
+                user: `0x${string}`;
+                allowed: boolean;
+            }[];
+        }, "A modification to sub-deployer permissions.">]>;
+    }, undefined>, v.ObjectSchema<{
+        /** Type of action. */
+        readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"perpDeploy", undefined>, v.DescriptionAction<"perpDeploy", "Type of action.">]>;
+        /** Set fee scale. */
+        readonly setFeeScale: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+            /** Name of the dex. */
+            readonly dex: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Name of the dex.">]>;
+            /** Fee scale (between 0.0 and 3.0). */
+            readonly scale: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.StringSchema<undefined>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Fee scale (between 0.0 and 3.0).">]>;
+        }, undefined>, v.DescriptionAction<{
+            dex: string;
+            scale: string;
+        }, "Set fee scale.">]>;
+    }, undefined>], undefined>, v.DescriptionAction<{
+        type: "perpDeploy";
+        registerAsset: {
+            maxGas: number | null;
+            assetRequest: {
+                coin: string;
+                szDecimals: number;
+                oraclePx: string;
+                marginTableId: number;
+                onlyIsolated: boolean;
+            };
+            dex: string;
+            schema: {
+                fullName: string;
+                collateralToken: number;
+                oracleUpdater: `0x${string}` | null;
+            } | null;
+        };
+    } | {
+        type: "perpDeploy";
+        setOracle: {
+            dex: string;
+            oraclePxs: [string, string][];
+            markPxs: [string, string][][];
+            externalPerpPxs: [string, string][];
+        };
+    } | {
+        type: "perpDeploy";
+        setFundingMultipliers: [string, string][];
+    } | {
+        type: "perpDeploy";
+        haltTrading: {
+            coin: string;
+            isHalted: boolean;
+        };
+    } | {
+        type: "perpDeploy";
+        setMarginTableIds: [string, number][];
+    } | {
+        type: "perpDeploy";
+        setFeeRecipient: {
+            dex: string;
+            feeRecipient: `0x${string}`;
+        };
+    } | {
+        type: "perpDeploy";
+        setOpenInterestCaps: [string, number][];
+    } | {
+        type: "perpDeploy";
+        setSubDeployers: {
+            dex: string;
+            subDeployers: {
+                variant: string;
+                user: `0x${string}`;
+                allowed: boolean;
+            }[];
+        };
+    } | {
+        type: "perpDeploy";
+        setFeeScale: {
+            dex: string;
+            scale: string;
+        };
+    }, "Action to perform.">]>;
+    /** Unique request identifier (current timestamp in ms). */
+    readonly nonce: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Unique request identifier (current timestamp in ms).">]>;
+    /** Cryptographic signature. */
+    readonly signature: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        readonly r: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 66, undefined>]>, v.DescriptionAction<`0x${string}`, "First 32-byte component of ECDSA signature.">]>;
+        readonly s: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 66, undefined>]>, v.DescriptionAction<`0x${string}`, "Second 32-byte component of ECDSA signature.">]>;
+        readonly v: v.SchemaWithPipe<readonly [v.UnionSchema<[v.LiteralSchema<27, undefined>, v.LiteralSchema<28, undefined>], undefined>, v.DescriptionAction<27 | 28, "Recovery identifier.">]>;
+    }, undefined>, v.DescriptionAction<{
+        r: `0x${string}`;
+        s: `0x${string}`;
+        v: 27 | 28;
+    }, "ECDSA signature components for Ethereum typed data.">]>, v.DescriptionAction<{
+        r: `0x${string}`;
+        s: `0x${string}`;
+        v: 27 | 28;
+    }, "Cryptographic signature.">]>;
+    /** Expiration time of the action. */
+    readonly expiresAfter: v.SchemaWithPipe<readonly [v.OptionalSchema<v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, undefined>, v.DescriptionAction<number | undefined, "Expiration time of the action.">]>;
+}, undefined>, v.DescriptionAction<{
+    action: {
+        type: "perpDeploy";
+        registerAsset: {
+            maxGas: number | null;
+            assetRequest: {
+                coin: string;
+                szDecimals: number;
+                oraclePx: string;
+                marginTableId: number;
+                onlyIsolated: boolean;
+            };
+            dex: string;
+            schema: {
+                fullName: string;
+                collateralToken: number;
+                oracleUpdater: `0x${string}` | null;
+            } | null;
+        };
+    } | {
+        type: "perpDeploy";
+        setOracle: {
+            dex: string;
+            oraclePxs: [string, string][];
+            markPxs: [string, string][][];
+            externalPerpPxs: [string, string][];
+        };
+    } | {
+        type: "perpDeploy";
+        setFundingMultipliers: [string, string][];
+    } | {
+        type: "perpDeploy";
+        haltTrading: {
+            coin: string;
+            isHalted: boolean;
+        };
+    } | {
+        type: "perpDeploy";
+        setMarginTableIds: [string, number][];
+    } | {
+        type: "perpDeploy";
+        setFeeRecipient: {
+            dex: string;
+            feeRecipient: `0x${string}`;
+        };
+    } | {
+        type: "perpDeploy";
+        setOpenInterestCaps: [string, number][];
+    } | {
+        type: "perpDeploy";
+        setSubDeployers: {
+            dex: string;
+            subDeployers: {
+                variant: string;
+                user: `0x${string}`;
+                allowed: boolean;
+            }[];
+        };
+    } | {
+        type: "perpDeploy";
+        setFeeScale: {
+            dex: string;
+            scale: string;
+        };
+    };
+    nonce: number;
+    signature: {
+        r: `0x${string}`;
+        s: `0x${string}`;
+        v: 27 | 28;
+    };
+    expiresAfter?: number | undefined;
+}, "Deploying HIP-3 assets.">]>;
+export type PerpDeployRequest = v.InferOutput<typeof PerpDeployRequest>;
+/**
+ * Successful response without specific data or error response.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/deploying-hip-3-assets
+ */
+export declare const PerpDeployResponse: v.SchemaWithPipe<readonly [v.UnionSchema<[v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    readonly status: v.SchemaWithPipe<readonly [v.LiteralSchema<"ok", undefined>, v.DescriptionAction<"ok", "Successful status.">]>;
+    readonly response: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"default", undefined>, v.DescriptionAction<"default", "Type of response.">]>;
+    }, undefined>, v.DescriptionAction<{
+        type: "default";
+    }, "Response details.">]>;
+}, undefined>, v.DescriptionAction<{
+    status: "ok";
+    response: {
+        type: "default";
+    };
+}, "Successful response without specific data.">]>, v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    readonly status: v.SchemaWithPipe<readonly [v.LiteralSchema<"err", undefined>, v.DescriptionAction<"err", "Error status.">]>;
+    readonly response: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Error message.">]>;
+}, undefined>, v.DescriptionAction<{
+    status: "err";
+    response: string;
+}, "Error response for failed operations.">]>], undefined>, v.DescriptionAction<{
+    status: "err";
+    response: string;
+} | {
+    status: "ok";
+    response: {
+        type: "default";
+    };
+}, "Successful response without specific data or error response.">]>;
+export type PerpDeployResponse = v.InferOutput<typeof PerpDeployResponse>;
+import { type DeepImmutable } from "../_base.js";
+import { type ExchangeRequestConfig, type ExcludeErrorResponse, type ExtractRequestAction, type ExtractRequestOptions, type MultiSignRequestConfig } from "./_base/mod.js";
+/** Action parameters for the {@linkcode perpDeploy} function. */
+export type PerpDeployParameters = ExtractRequestAction<v.InferInput<typeof PerpDeployRequest>>;
+/** Request options for the {@linkcode perpDeploy} function. */
+export type PerpDeployOptions = ExtractRequestOptions<v.InferInput<typeof PerpDeployRequest>>;
+/** Successful variant of {@linkcode PerpDeployResponse} without errors. */
+export type PerpDeploySuccessResponse = ExcludeErrorResponse<PerpDeployResponse>;
+/**
+ * Deploying HIP-3 assets.
+ * @param config - General configuration for Exchange API requests.
+ * @param params - Parameters specific to the API request.
+ * @param opts - Request execution options.
+ * @returns Successful response without specific data.
+ *
+ * @throws {ApiRequestError} When the API returns an unsuccessful response.
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/deploying-hip-3-assets
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { perpDeploy } 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 perpDeploy(
+ *   { transport, wallet },
+ *   {
+ *     registerAsset: {
+ *       maxGas: 1000000,
+ *       assetRequest: {
+ *         coin: "USDC",
+ *         szDecimals: 8,
+ *         oraclePx: "1",
+ *         marginTableId: 1,
+ *         onlyIsolated: false,
+ *       },
+ *       dex: "test",
+ *       schema: null,
+ *     },
+ *   },
+ * );
+ * ```
+ */
+export declare function perpDeploy(config: ExchangeRequestConfig | MultiSignRequestConfig, params: DeepImmutable<PerpDeployParameters>, opts?: PerpDeployOptions): Promise<PerpDeploySuccessResponse>;
+//# sourceMappingURL=perpDeploy.d.ts.map

package/script/src/api/exchange/perpDeploy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"perpDeploy.d.ts","sourceRoot":"","sources":["../../../../src/src/api/exchange/perpDeploy.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAS7B;;;GAGG;AACH,eAAO,MAAM,iBAAiB;IAGxB,yBAAyB;;QAInB,sBAAsB;;QAKtB,wDAAwD;;YAGpD,4FAA4F;;YAO5F,6CAA6C;;gBAGzC,qCAAqC;;gBAKrC,yCAAyC;;gBAKzC,0CAA0C;;gBAK1C,mDAAmD;;gBAKnD,iEAAiE;;;;;;;;;YAQrE,uBAAuB;;YAKvB,mCAAmC;;gBAG/B,4BAA4B;;gBAK5B,8BAA8B;;gBAK9B,8FAA8F;;;;;;;;;;;;;;;;;;;;;;;;QAetG,sBAAsB;;QAKtB,gEAAgE;;YAG5D,uBAAuB;;YAMvB,yDAAyD;;YAKzD,wFAAwF;;YAOxF,sGAAsG;;;;;;;;;QAY1G,sBAAsB;;QAKtB,8DAA8D;;;QAO9D,sBAAsB;;QAKtB,+DAA+D;;;;;;;;;QAgB/D,sBAAsB;;QAKtB,4DAA4D;;;QAO5D,sBAAsB;;QAKtB,gDAAgD;;YAG5C,uBAAuB;;YAKvB,oCAAoC;;;;;;;QAUxC,sBAAsB;;QAKtB,uEAAuE;;;QAOvE,sBAAsB;;QAKtB,kDAAkD;;YAG9C,uBAAuB;;YAKvB,kDAAkD;;gBAI5C,oDAAoD;;gBAKpD,4BAA4B;;gBAK5B,oFAAoF;;;;;;;;;;;;;;;;QAgB9F,sBAAsB;;QAKtB,qBAAqB;;YAGjB,uBAAuB;;YAKvB,uCAAuC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAYjD,2DAA2D;;IAK3D,+BAA+B;;;;;;;;;;;;;;IAK/B,qCAAqC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;+BAQvC,CAAC;AACL,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAExE;;;GAGG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;oEAK3B,CAAC;AACL,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAM1E,OAAO,EAAE,KAAK,aAAa,EAAU,MAAM,aAAa,CAAC;AACzD,OAAO,EACL,KAAK,qBAAqB,EAC1B,KAAK,oBAAoB,EAEzB,KAAK,oBAAoB,EACzB,KAAK,qBAAqB,EAC1B,KAAK,sBAAsB,EAC5B,MAAM,gBAAgB,CAAC;AAExB,iEAAiE;AACjE,MAAM,MAAM,oBAAoB,GAAG,oBAAoB,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,iBAAiB,CAAC,CAAC,CAAC;AAEhG,+DAA+D;AAC/D,MAAM,MAAM,iBAAiB,GAAG,qBAAqB,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,iBAAiB,CAAC,CAAC,CAAC;AAE9F,2EAA2E;AAC3E,MAAM,MAAM,yBAAyB,GAAG,oBAAoB,CAAC,kBAAkB,CAAC,CAAC;AAEjF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,wBAAsB,UAAU,CAC9B,MAAM,EAAE,qBAAqB,GAAG,sBAAsB,EACtD,MAAM,EAAE,aAAa,CAAC,oBAAoB,CAAC,EAC3C,IAAI,CAAC,EAAE,iBAAiB,GACvB,OAAO,CAAC,yBAAyB,CAAC,CAiBpC"}