@nktkas/hyperliquid 0.30.2 → 0.31.0

package/src/src/api/exchange/_methods/perpDeploy.ts

@@ -12,443 +12,185 @@ import { ErrorResponse, SignatureSchema, SuccessResponse } from "./_base/commonS
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/hip-3-deployer-actions
  */
 export const PerpDeployRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Action to perform. */
-      action: v.pipe(
-        v.union([
-          v.object({
-            /** Type of action. */
-            type: v.pipe(
-              v.literal("perpDeploy"),
-              v.description("Type of action."),
-            ),
-            /** Parameters for registering a new perpetual asset (v2). */
-            registerAsset2: v.pipe(
-              v.object({
-                /** Max gas in native token wei. If not provided, then uses current deploy auction price. */
-                maxGas: v.pipe(
-                  v.nullable(UnsignedInteger),
-                  v.description(
-                    "Max gas in native token wei. If not provided, then uses current deploy auction price.",
-                  ),
-                ),
-                /** Contains new asset listing parameters. */
-                assetRequest: v.pipe(
-                  v.object({
-                    /** Coin symbol for the new asset. */
-                    coin: v.pipe(
-                      v.string(),
-                      v.description("Coin symbol for the new asset."),
-                    ),
-                    /** Number of decimal places for size. */
-                    szDecimals: v.pipe(
-                      UnsignedInteger,
-                      v.description("Number of decimal places for size."),
-                    ),
-                    /** Initial oracle price for the asset. */
-                    oraclePx: v.pipe(
-                      UnsignedDecimal,
-                      v.description("Initial oracle price for the asset."),
-                    ),
-                    /** Margin table identifier for risk management. */
-                    marginTableId: v.pipe(
-                      UnsignedInteger,
-                      v.description("Margin table identifier for risk management."),
-                    ),
-                    /** 'strictIsolated' does not allow withdrawing of isolated margin from open position. */
-                    marginMode: v.pipe(
-                      v.picklist(["strictIsolated", "noCross"]),
-                      v.description(
-                        "'strictIsolated' does not allow withdrawing of isolated margin from open position.",
-                      ),
-                    ),
-                  }),
-                  v.description("Contains new asset listing parameters."),
-                ),
-                /** Name of the dex. */
-                dex: v.pipe(
-                  v.string(),
-                  v.description("Name of the dex."),
-                ),
-                /** Contains new dex parameters. */
-                schema: v.pipe(
-                  v.nullable(v.object({
-                    /** Full name of the dex. */
-                    fullName: v.pipe(
-                      v.string(),
-                      v.description("Full name of the dex."),
-                    ),
-                    /** Collateral token index. */
-                    collateralToken: v.pipe(
-                      UnsignedInteger,
-                      v.description("Collateral token index."),
-                    ),
-                    /** User to update oracles. If not provided, then deployer is assumed to be oracle updater. */
-                    oracleUpdater: v.pipe(
-                      v.nullable(Address),
-                      v.description(
-                        "User to update oracles. If not provided, then deployer is assumed to be oracle updater.",
-                      ),
-                    ),
-                  })),
-                  v.description("Contains new dex parameters."),
-                ),
-              }),
-              v.description("Parameters for registering a new perpetual asset (v2)."),
-            ),
+  return v.object({
+    /** Action to perform. */
+    action: v.variant("type", [
+      v.object({
+        /** Type of action. */
+        type: v.literal("perpDeploy"),
+        /** Parameters for registering a new perpetual asset (v2). */
+        registerAsset2: v.object({
+          /** Max gas in native token wei. If not provided, then uses current deploy auction price. */
+          maxGas: v.nullable(UnsignedInteger),
+          /** Contains new asset listing parameters. */
+          assetRequest: v.object({
+            /** Coin symbol for the new asset. */
+            coin: v.string(),
+            /** Number of decimal places for size. */
+            szDecimals: UnsignedInteger,
+            /** Initial oracle price for the asset. */
+            oraclePx: UnsignedDecimal,
+            /** Margin table identifier for risk management. */
+            marginTableId: UnsignedInteger,
+            /** 'strictIsolated' does not allow withdrawing of isolated margin from open position. */
+            marginMode: v.picklist(["strictIsolated", "noCross"]),
           }),
-          v.object({
-            /** Type of action. */
-            type: v.pipe(
-              v.literal("perpDeploy"),
-              v.description("Type of action."),
-            ),
-            /** Parameters for registering a new perpetual asset. */
-            registerAsset: v.pipe(
-              v.object({
-                /** Max gas in native token wei. If not provided, then uses current deploy auction price. */
-                maxGas: v.pipe(
-                  v.nullable(UnsignedInteger),
-                  v.description(
-                    "Max gas in native token wei. If not provided, then uses current deploy auction price.",
-                  ),
-                ),
-                /** Contains new asset listing parameters. */
-                assetRequest: v.pipe(
-                  v.object({
-                    /** Coin symbol for the new asset. */
-                    coin: v.pipe(
-                      v.string(),
-                      v.description("Coin symbol for the new asset."),
-                    ),
-                    /** Number of decimal places for size. */
-                    szDecimals: v.pipe(
-                      UnsignedInteger,
-                      v.description("Number of decimal places for size."),
-                    ),
-                    /** Initial oracle price for the asset. */
-                    oraclePx: v.pipe(
-                      UnsignedDecimal,
-                      v.description("Initial oracle price for the asset."),
-                    ),
-                    /** Margin table identifier for risk management. */
-                    marginTableId: v.pipe(
-                      UnsignedInteger,
-                      v.description("Margin table identifier for risk management."),
-                    ),
-                    /** Whether the asset can only be traded with isolated margin. */
-                    onlyIsolated: v.pipe(
-                      v.boolean(),
-                      v.description("Whether the asset can only be traded with isolated margin."),
-                    ),
-                  }),
-                  v.description("Contains new asset listing parameters."),
-                ),
-                /** Name of the dex. */
-                dex: v.pipe(
-                  v.string(),
-                  v.description("Name of the dex."),
-                ),
-                /** Contains new dex parameters. */
-                schema: v.pipe(
-                  v.nullable(v.object({
-                    /** Full name of the dex. */
-                    fullName: v.pipe(
-                      v.string(),
-                      v.description("Full name of the dex."),
-                    ),
-                    /** Collateral token index. */
-                    collateralToken: v.pipe(
-                      UnsignedInteger,
-                      v.description("Collateral token index."),
-                    ),
-                    /** User to update oracles. If not provided, then deployer is assumed to be oracle updater. */
-                    oracleUpdater: v.pipe(
-                      v.nullable(Address),
-                      v.description(
-                        "User to update oracles. If not provided, then deployer is assumed to be oracle updater.",
-                      ),
-                    ),
-                  })),
-                  v.description("Contains new dex parameters."),
-                ),
-              }),
-              v.description("Parameters for registering a new perpetual asset."),
-            ),
+          /** Name of the dex. */
+          dex: v.string(),
+          /** Contains new dex parameters. */
+          schema: v.nullable(
+            v.object({
+              /** Full name of the dex. */
+              fullName: v.string(),
+              /** Collateral token index. */
+              collateralToken: UnsignedInteger,
+              /** User to update oracles. If not provided, then deployer is assumed to be oracle updater. */
+              oracleUpdater: v.nullable(Address),
+            }),
+          ),
+        }),
+      }),
+      v.object({
+        /** Type of action. */
+        type: v.literal("perpDeploy"),
+        /** Parameters for registering a new perpetual asset. */
+        registerAsset: v.object({
+          /** Max gas in native token wei. If not provided, then uses current deploy auction price. */
+          maxGas: v.nullable(UnsignedInteger),
+          /** Contains new asset listing parameters. */
+          assetRequest: v.object({
+            /** Coin symbol for the new asset. */
+            coin: v.string(),
+            /** Number of decimal places for size. */
+            szDecimals: UnsignedInteger,
+            /** Initial oracle price for the asset. */
+            oraclePx: UnsignedDecimal,
+            /** Margin table identifier for risk management. */
+            marginTableId: UnsignedInteger,
+            /** Whether the asset can only be traded with isolated margin. */
+            onlyIsolated: v.boolean(),
           }),
-          v.object({
-            /** Type of action. */
-            type: v.pipe(
-              v.literal("perpDeploy"),
-              v.description("Type of action."),
-            ),
-            /** Parameters for setting oracle and mark prices for assets. */
-            setOracle: v.pipe(
-              v.object({
-                /** Name of the dex. */
-                dex: v.pipe(
-                  v.string(),
-                  v.description("Name of the dex."),
-                ),
-                /** A list (sorted by key) of asset and oracle prices. */
-                oraclePxs: v.pipe(
-                  v.array(
-                    v.tuple([
-                      v.string(),
-                      UnsignedDecimal,
-                    ]),
-                  ),
-                  v.description("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. */
-                markPxs: v.pipe(
-                  v.array(
-                    v.array(
-                      v.tuple([
-                        v.string(),
-                        UnsignedDecimal,
-                      ]),
-                    ),
-                  ),
-                  v.description(
-                    "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. */
-                externalPerpPxs: v.pipe(
-                  v.array(
-                    v.tuple([
-                      v.string(),
-                      UnsignedDecimal,
-                    ]),
-                  ),
-                  v.description(
-                    "A list (sorted by key) of asset and external prices which prevent sudden mark price deviations.",
-                  ),
-                ),
-              }),
-              v.description("Parameters for setting oracle and mark prices for assets."),
-            ),
-          }),
-          v.object({
-            /** Type of action. */
-            type: v.pipe(
-              v.literal("perpDeploy"),
-              v.description("Type of action."),
-            ),
-            /** A list (sorted by key) of asset and funding multiplier. */
-            setFundingMultipliers: v.pipe(
-              v.array(
-                v.tuple([
-                  v.string(),
-                  UnsignedDecimal,
-                ]),
-              ),
-              v.description("A list (sorted by key) of asset and funding multiplier."),
-            ),
-          }),
-          v.object({
-            /** Type of action. */
-            type: v.pipe(
-              v.literal("perpDeploy"),
-              v.description("Type of action."),
-            ),
-            /** Parameters for halting or resuming trading for an asset. */
-            haltTrading: v.pipe(
-              v.object({
-                /** Coin symbol for the asset to halt or resume. */
-                coin: v.pipe(
-                  v.string(),
-                  v.description("Coin symbol for the asset to halt or resume."),
-                ),
-                /** Whether trading should be halted (true) or resumed (false). */
-                isHalted: v.pipe(
-                  v.boolean(),
-                  v.description("Whether trading should be halted (true) or resumed (false)."),
-                ),
-              }),
-              v.description("Parameters for halting or resuming trading for an asset."),
-            ),
-          }),
-          v.object({
-            /** Type of action. */
-            type: v.pipe(
-              v.literal("perpDeploy"),
-              v.description("Type of action."),
-            ),
-            /** A list (sorted by key) of asset and margin table ids. */
-            setMarginTableIds: v.pipe(
-              v.array(
-                v.tuple([
-                  v.string(),
-                  UnsignedInteger,
-                ]),
-              ),
-              v.description("A list (sorted by key) of asset and margin table ids."),
-            ),
-          }),
-          v.object({
-            /** Type of action. */
-            type: v.pipe(
-              v.literal("perpDeploy"),
-              v.description("Type of action."),
-            ),
-            /** Parameters for setting the fee recipient. */
-            setFeeRecipient: v.pipe(
-              v.object({
-                /** Name of the DEX. */
-                dex: v.pipe(
-                  v.string(),
-                  v.description("Name of the DEX."),
-                ),
-                /** Address of the fee recipient. */
-                feeRecipient: v.pipe(
-                  Address,
-                  v.description("Address of the fee recipient."),
-                ),
-              }),
-              v.description("Parameters for setting the fee recipient."),
-            ),
-          }),
-          v.object({
-            /** Type of action. */
-            type: v.pipe(
-              v.literal("perpDeploy"),
-              v.description("Type of action."),
-            ),
-            /** A list (sorted by key) of asset and open interest cap notionals. */
-            setOpenInterestCaps: v.pipe(
-              v.array(
-                v.tuple([
-                  v.string(),
-                  UnsignedInteger,
-                ]),
-              ),
-              v.description("A list (sorted by key) of asset and open interest cap notionals."),
-            ),
-          }),
-          v.object({
-            /** Type of action. */
-            type: v.pipe(
-              v.literal("perpDeploy"),
-              v.description("Type of action."),
-            ),
-            /** A modification to sub-deployer permissions. */
-            setSubDeployers: v.pipe(
-              v.object({
-                /** Name of the DEX. */
-                dex: v.pipe(
-                  v.string(),
-                  v.description("Name of the DEX."),
-                ),
-                /** A modification to sub-deployer permissions. */
-                subDeployers: v.pipe(
-                  v.array(
-                    v.object({
-                      /** Corresponds to a variant of PerpDeployAction. */
-                      variant: v.pipe(
-                        v.string(),
-                        v.description("Corresponds to a variant of PerpDeployAction."),
-                      ),
-                      /** Sub-deployer address. */
-                      user: v.pipe(
-                        Address,
-                        v.description("Sub-deployer address."),
-                      ),
-                      /** Add or remove the subDeployer from the authorized set for the action variant. */
-                      allowed: v.pipe(
-                        v.boolean(),
-                        v.description(
-                          "Add or remove the subDeployer from the authorized set for the action variant.",
-                        ),
-                      ),
-                    }),
-                  ),
-                  v.description("A modification to sub-deployer permissions."),
-                ),
-              }),
-              v.description("A modification to sub-deployer permissions."),
-            ),
-          }),
-          v.object({
-            /** Type of action. */
-            type: v.pipe(
-              v.literal("perpDeploy"),
-              v.description("Type of action."),
-            ),
-            /** A list (sorted by key) of asset and margin modes. */
-            setMarginModes: v.pipe(
-              v.array(
-                v.tuple([
-                  v.string(),
-                  v.picklist(["strictIsolated", "noCross"]),
-                ]),
-              ),
-              v.description("A list (sorted by key) of asset and margin modes."),
-            ),
-          }),
-          v.object({
-            /** Type of action. */
-            type: v.pipe(
-              v.literal("perpDeploy"),
-              v.description("Type of action."),
-            ),
-            /** Set fee scale. */
-            setFeeScale: v.pipe(
-              v.object({
-                /** Name of the dex. */
-                dex: v.pipe(
-                  v.string(),
-                  v.description("Name of the dex."),
-                ),
-                /** Fee scale (between 0.0 and 3.0). */
-                scale: v.pipe(
-                  UnsignedDecimal,
-                  v.description("Fee scale (between 0.0 and 3.0)."),
-                ),
-              }),
-              v.description("Set fee scale."),
-            ),
-          }),
-          v.object({
-            /** Type of action. */
-            type: v.pipe(
-              v.literal("perpDeploy"),
-              v.description("Type of action."),
-            ),
-            /** A list (sorted by key) of asset and growth modes. */
-            setGrowthModes: v.pipe(
-              v.array(
-                v.tuple([
-                  v.string(),
-                  v.boolean(),
-                ]),
-              ),
-              v.description("A list (sorted by key) of asset and growth modes."),
-            ),
-          }),
-        ]),
-        v.description("Action to perform."),
-      ),
-      /** Nonce (timestamp in ms) used to prevent replay attacks. */
-      nonce: v.pipe(
-        UnsignedInteger,
-        v.description("Nonce (timestamp in ms) used to prevent replay attacks."),
-      ),
-      /** ECDSA signature components. */
-      signature: v.pipe(
-        SignatureSchema,
-        v.description("ECDSA signature components."),
-      ),
-      /** Expiration time of the action. */
-      expiresAfter: v.pipe(
-        v.optional(UnsignedInteger),
-        v.description("Expiration time of the action."),
-      ),
-    }),
-    v.description("Deploying HIP-3 assets."),
-  );
+          /** Name of the dex. */
+          dex: v.string(),
+          /** Contains new dex parameters. */
+          schema: v.nullable(
+            v.object({
+              /** Full name of the dex. */
+              fullName: v.string(),
+              /** Collateral token index. */
+              collateralToken: UnsignedInteger,
+              /** User to update oracles. If not provided, then deployer is assumed to be oracle updater. */
+              oracleUpdater: v.nullable(Address),
+            }),
+          ),
+        }),
+      }),
+      v.object({
+        /** Type of action. */
+        type: v.literal("perpDeploy"),
+        /** Parameters for setting oracle and mark prices for assets. */
+        setOracle: v.object({
+          /** Name of the dex. */
+          dex: v.string(),
+          /** A list (sorted by key) of asset and oracle prices. */
+          oraclePxs: v.array(v.tuple([v.string(), UnsignedDecimal])),
+          /** An outer list of inner lists (inner list sorted by key) of asset and mark prices. */
+          markPxs: v.array(v.array(v.tuple([v.string(), UnsignedDecimal]))),
+          /** A list (sorted by key) of asset and external prices which prevent sudden mark price deviations. */
+          externalPerpPxs: v.array(v.tuple([v.string(), UnsignedDecimal])),
+        }),
+      }),
+      v.object({
+        /** Type of action. */
+        type: v.literal("perpDeploy"),
+        /** A list (sorted by key) of asset and funding multiplier. */
+        setFundingMultipliers: v.array(v.tuple([v.string(), UnsignedDecimal])),
+      }),
+      v.object({
+        /** Type of action. */
+        type: v.literal("perpDeploy"),
+        /** Parameters for halting or resuming trading for an asset. */
+        haltTrading: v.object({
+          /** Coin symbol for the asset to halt or resume. */
+          coin: v.string(),
+          /** Whether trading should be halted (true) or resumed (false). */
+          isHalted: v.boolean(),
+        }),
+      }),
+      v.object({
+        /** Type of action. */
+        type: v.literal("perpDeploy"),
+        /** A list (sorted by key) of asset and margin table ids. */
+        setMarginTableIds: v.array(v.tuple([v.string(), UnsignedInteger])),
+      }),
+      v.object({
+        /** Type of action. */
+        type: v.literal("perpDeploy"),
+        /** Parameters for setting the fee recipient. */
+        setFeeRecipient: v.object({
+          /** Name of the DEX. */
+          dex: v.string(),
+          /** Address of the fee recipient. */
+          feeRecipient: Address,
+        }),
+      }),
+      v.object({
+        /** Type of action. */
+        type: v.literal("perpDeploy"),
+        /** A list (sorted by key) of asset and open interest cap notionals. */
+        setOpenInterestCaps: v.array(v.tuple([v.string(), UnsignedInteger])),
+      }),
+      v.object({
+        /** Type of action. */
+        type: v.literal("perpDeploy"),
+        /** A modification to sub-deployer permissions. */
+        setSubDeployers: v.object({
+          /** Name of the DEX. */
+          dex: v.string(),
+          /** A modification to sub-deployer permissions. */
+          subDeployers: v.array(
+            v.object({
+              /** Corresponds to a variant of PerpDeployAction. */
+              variant: v.string(),
+              /** Sub-deployer address. */
+              user: Address,
+              /** Add or remove the subDeployer from the authorized set for the action variant. */
+              allowed: v.boolean(),
+            }),
+          ),
+        }),
+      }),
+      v.object({
+        /** Type of action. */
+        type: v.literal("perpDeploy"),
+        /** A list (sorted by key) of asset and margin modes. */
+        setMarginModes: v.array(v.tuple([v.string(), v.picklist(["strictIsolated", "noCross"])])),
+      }),
+      v.object({
+        /** Type of action. */
+        type: v.literal("perpDeploy"),
+        /** Set fee scale. */
+        setFeeScale: v.object({
+          /** Name of the dex. */
+          dex: v.string(),
+          /** Fee scale (between 0.0 and 3.0). */
+          scale: UnsignedDecimal,
+        }),
+      }),
+      v.object({
+        /** Type of action. */
+        type: v.literal("perpDeploy"),
+        /** A list (sorted by key) of asset and growth modes. */
+        setGrowthModes: v.array(v.tuple([v.string(), v.boolean()])),
+      }),
+    ]),
+    /** Nonce (timestamp in ms) used to prevent replay attacks. */
+    nonce: UnsignedInteger,
+    /** ECDSA signature components. */
+    signature: SignatureSchema,
+    /** Expiration time of the action. */
+    expiresAfter: v.optional(UnsignedInteger),
+  });
 })();
 export type PerpDeployRequest = v.InferOutput<typeof PerpDeployRequest>;
 
@@ -457,10 +199,7 @@ export type PerpDeployRequest = v.InferOutput<typeof PerpDeployRequest>;
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/hip-3-deployer-actions
  */
 export const PerpDeployResponse = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.union([SuccessResponse, ErrorResponse]),
-    v.description("Successful response without specific data or error response."),
-  );
+  return v.union([SuccessResponse, ErrorResponse]);
 })();
 export type PerpDeployResponse = v.InferOutput<typeof PerpDeployResponse>;