@nktkas/hyperliquid 0.25.0-beta.2 → 0.25.0-beta.4

package/src/src/schemas/exchange/requests.ts

@@ -1,5 +1,6 @@
 import * as v from "valibot";
-import { Hex, TokenId, UnsignedDecimal, UnsignedInteger } from "../_base.js";
+import { Address, Hex, Integer, TokenId, UnsignedDecimal, UnsignedInteger } from "../_base.js";
+import { TIF } from "../info/orders.js";
 
 /** Deeply removes undefined keys from an object.  */
 function removeUndefinedKeys<T>(obj: T): T {
@@ -47,7 +48,10 @@ export const Signature = v.pipe(
         ),
         /** Recovery identifier. */
         v: v.pipe(
-            v.union([v.literal(27), v.literal(28)]),
+            v.pipe(
+                Integer,
+                v.union([v.literal(27), v.literal(28)]),
+            ),
             v.description("Recovery identifier."),
         ),
     }),
@@ -92,13 +96,7 @@ export const OrderParams = v.pipe(
                         v.object({
                             /** Time-in-force. */
                             tif: v.pipe(
-                                v.union([
-                                    v.literal("Gtc"),
-                                    v.literal("Ioc"),
-                                    v.literal("Alo"),
-                                    v.literal("FrontendMarket"),
-                                    v.literal("LiquidationMarket"),
-                                ]),
+                                TIF,
                                 v.description("Time-in-force."),
                             ),
                         }),
@@ -169,12 +167,12 @@ export const ApproveAgentRequest = v.pipe(
                 ),
                 /** Agent address. */
                 agentAddress: v.pipe(
-                    v.pipe(Hex, v.length(42)),
+                    Address,
                     v.description("Agent address."),
                 ),
-                /** Agent name or null for unnamed agent. */
+                /** Agent name or null for unnamed agent (default: null). */
                 agentName: v.pipe(
-                    v.nullable(v.string()),
+                    v.optional(v.nullable(v.string()), null),
                     v.description("Agent name or null for unnamed agent."),
                 ),
                 /** Unique request identifier (current timestamp in ms). */
@@ -233,7 +231,7 @@ export const ApproveBuilderFeeRequest = v.pipe(
                 ),
                 /** Builder address. */
                 builder: v.pipe(
-                    v.pipe(Hex, v.length(42)),
+                    Address,
                     v.description("Builder address."),
                 ),
                 /** Unique request identifier (current timestamp in ms). */
@@ -309,7 +307,7 @@ export const BatchModifyRequest = v.pipe(
         ),
         /** Vault address (for vault trading). */
         vaultAddress: v.pipe(
-            v.optional(v.pipe(Hex, v.length(42))),
+            v.optional(Address),
             v.description("Vault address (for vault trading)."),
         ),
         /** Expiration time of the action. */
@@ -369,7 +367,7 @@ export const CancelRequest = v.pipe(
         ),
         /** Vault address (for vault trading). */
         vaultAddress: v.pipe(
-            v.optional(v.pipe(Hex, v.length(42))),
+            v.optional(Address),
             v.description("Vault address (for vault trading)."),
         ),
         /** Expiration time of the action. */
@@ -429,7 +427,7 @@ export const CancelByCloidRequest = v.pipe(
         ),
         /** Vault address (for vault trading). */
         vaultAddress: v.pipe(
-            v.optional(v.pipe(Hex, v.length(42))),
+            v.optional(Address),
             v.description("Vault address (for vault trading)."),
         ),
         /** Expiration time of the action. */
@@ -542,7 +540,7 @@ export const ConvertToMultiSigUserRequestSigners = v.pipe(
         v.object({
             /** List of authorized user addresses. */
             authorizedUsers: v.pipe(
-                v.array(v.pipe(Hex, v.length(42))),
+                v.array(Address),
                 v.description("List of authorized user addresses."),
             ),
             /** Minimum number of signatures required. */
@@ -711,9 +709,9 @@ export const CreateVaultRequest = v.pipe(
                     v.minValue(100000000), // 100 USDC
                     v.description("Initial balance (float * 1e6)."),
                 ),
-                /** Unique request identifier (current timestamp in ms). */
+                /** Unique request identifier (current timestamp in ms) (default: Date.now()). */
                 nonce: v.pipe(
-                    UnsignedInteger,
+                    v.optional(UnsignedInteger, () => Date.now()), // default value is allowed because this is an L1 action
                     v.description("Unique request identifier (current timestamp in ms)."),
                 ),
             }),
@@ -868,7 +866,7 @@ export const CValidatorActionRequest = v.pipe(
                             ),
                             /** Signer address. */
                             signer: v.pipe(
-                                v.nullable(v.pipe(Hex, v.length(42))),
+                                v.nullable(Address),
                                 v.description("Signer address."),
                             ),
                         }),
@@ -921,7 +919,7 @@ export const CValidatorActionRequest = v.pipe(
                                     ),
                                     /** Signer address. */
                                     signer: v.pipe(
-                                        v.pipe(Hex, v.length(42)),
+                                        Address,
                                         v.description("Signer address."),
                                     ),
                                 }),
@@ -1123,7 +1121,7 @@ export const ModifyRequest = v.pipe(
         ),
         /** Vault address (for vault trading). */
         vaultAddress: v.pipe(
-            v.optional(v.pipe(Hex, v.length(42))),
+            v.optional(Address),
             v.description("Vault address (for vault trading)."),
         ),
         /** Expiration time of the action. */
@@ -1198,16 +1196,12 @@ export const OrderRequest = v.pipe(
                 ),
                 /**
                  * Order grouping strategy:
-                 * - `na`: Standard order without grouping.
+                 * - `na`: Standard order without grouping (default).
                  * - `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: v.pipe(
-                    v.union([
-                        v.literal("na"),
-                        v.literal("normalTpsl"),
-                        v.literal("positionTpsl"),
-                    ]),
+                    v.optional(v.union([v.literal("na"), v.literal("normalTpsl"), v.literal("positionTpsl")]), "na"),
                     v.description(
                         "Order grouping strategy:" +
                             "\n- `na`: Standard order without grouping." +
@@ -1220,7 +1214,7 @@ export const OrderRequest = v.pipe(
                     v.optional(v.object({
                         /** Builder address. */
                         b: v.pipe(
-                            v.pipe(Hex, v.length(42)),
+                            Address,
                             v.description("Builder address."),
                         ),
                         /** Builder fee in 0.1bps (1 = 0.0001%). */
@@ -1246,7 +1240,7 @@ export const OrderRequest = v.pipe(
         ),
         /** Vault address (for vault trading). */
         vaultAddress: v.pipe(
-            v.optional(v.pipe(Hex, v.length(42))),
+            v.optional(Address),
             v.description("Vault address (for vault trading)."),
         ),
         /** Expiration time of the action. */
@@ -1340,7 +1334,7 @@ export const PerpDeployRequest = v.pipe(
                                         ),
                                         /** User to update oracles. If not provided, then deployer is assumed to be oracle updater. */
                                         oracleUpdater: v.pipe(
-                                            v.nullable(v.pipe(Hex, v.length(42))),
+                                            v.nullable(Address),
                                             v.description(
                                                 "User to update oracles. If not provided, then deployer is assumed to be oracle updater.",
                                             ),
@@ -1382,6 +1376,13 @@ export const PerpDeployRequest = v.pipe(
                                         "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."),
                         ),
@@ -1549,7 +1550,7 @@ export const ScheduleCancelRequest = v.pipe(
         ),
         /** Vault address (for vault trading). */
         vaultAddress: v.pipe(
-            v.optional(v.pipe(Hex, v.length(42))),
+            v.optional(Address),
             v.description("Vault address (for vault trading)."),
         ),
         /** Expiration time of the action. */
@@ -1590,7 +1591,7 @@ export const SendAssetRequest = v.pipe(
                 ),
                 /** Destination address. */
                 destination: v.pipe(
-                    v.pipe(Hex, v.length(42)),
+                    Address,
                     v.description("Destination address."),
                 ),
                 /** Source DEX ("" for default USDC perp DEX, "spot" for spot). */
@@ -1613,12 +1614,9 @@ export const SendAssetRequest = v.pipe(
                     UnsignedDecimal,
                     v.description("Amount to send (not in wei)."),
                 ),
-                /** Source sub-account address ("" for main account). */
+                /** Source sub-account address ("" for main account) (default: ""). */
                 fromSubAccount: v.pipe(
-                    v.union([
-                        v.literal(""),
-                        v.pipe(Hex, v.length(42)),
-                    ]),
+                    v.optional(v.union([v.literal(""), Address]), ""),
                     v.description('Source sub-account address ("" for main account).'),
                 ),
                 /** Unique request identifier (current timestamp in ms). */
@@ -1943,7 +1941,7 @@ export const SpotDeployRequest = v.pipe(
                                 ),
                                 /** Array of tuples: [user address, genesis amount in wei]. */
                                 userAndWei: v.pipe(
-                                    v.array(v.tuple([v.pipe(Hex, v.length(42)), UnsignedDecimal])),
+                                    v.array(v.tuple([Address, UnsignedDecimal])),
                                     v.description("Array of tuples: [user address, genesis amount in wei]."),
                                 ),
                                 /** Array of tuples: [existing token identifier, genesis amount in wei]. */
@@ -1960,7 +1958,7 @@ export const SpotDeployRequest = v.pipe(
                                 ),
                                 /** Array of tuples: [user address, blacklist status] (`true` for blacklist, `false` to remove existing blacklisted user). */
                                 blacklistUsers: v.pipe(
-                                    v.optional(v.array(v.tuple([v.pipe(Hex, v.length(42)), v.boolean()]))),
+                                    v.optional(v.array(v.tuple([Address, v.boolean()]))),
                                     v.description(
                                         "Array of tuples: [user address, blacklist status] (`true` for blacklist, `false` to remove existing blacklisted user).",
                                     ),
@@ -2030,7 +2028,7 @@ export const SpotSendRequest = v.pipe(
                 ),
                 /** Destination address. */
                 destination: v.pipe(
-                    v.pipe(Hex, v.length(42)),
+                    Address,
                     v.description("Destination address."),
                 ),
                 /** Token identifier. */
@@ -2134,7 +2132,7 @@ export const SubAccountModifyRequest = v.pipe(
                 ),
                 /** Sub-account address to modify. */
                 subAccountUser: v.pipe(
-                    v.pipe(Hex, v.length(42)),
+                    Address,
                     v.description("Sub-account address to modify."),
                 ),
                 /** New sub-account name. */
@@ -2184,7 +2182,7 @@ export const SubAccountSpotTransferRequest = v.pipe(
                 ),
                 /** Sub-account address. */
                 subAccountUser: v.pipe(
-                    v.pipe(Hex, v.length(42)),
+                    Address,
                     v.description("Sub-account address."),
                 ),
                 /** `true` for deposit, `false` for withdrawal. */
@@ -2243,7 +2241,7 @@ export const SubAccountTransferRequest = v.pipe(
                 ),
                 /** Sub-account address. */
                 subAccountUser: v.pipe(
-                    v.pipe(Hex, v.length(42)),
+                    Address,
                     v.description("Sub-account address."),
                 ),
                 /** `true` for deposit, `false` for withdrawal. */
@@ -2307,7 +2305,7 @@ export const TokenDelegateRequest = v.pipe(
                 ),
                 /** Validator address. */
                 validator: v.pipe(
-                    v.pipe(Hex, v.length(42)),
+                    Address,
                     v.description("Validator address."),
                 ),
                 /** Amount for delegate/undelegate (float * 1e8). */
@@ -2384,7 +2382,7 @@ export const TwapCancelRequest = v.pipe(
         ),
         /** Vault address (for vault trading). */
         vaultAddress: v.pipe(
-            v.optional(v.pipe(Hex, v.length(42))),
+            v.optional(Address),
             v.description("Vault address (for vault trading)."),
         ),
         /** Expiration time of the action. */
@@ -2464,7 +2462,7 @@ export const TwapOrderRequest = v.pipe(
         ),
         /** Vault address (for vault trading). */
         vaultAddress: v.pipe(
-            v.optional(v.pipe(Hex, v.length(42))),
+            v.optional(Address),
             v.description("Vault address (for vault trading)."),
         ),
         /** Expiration time of the action. */
@@ -2523,7 +2521,7 @@ export const UpdateIsolatedMarginRequest = v.pipe(
         ),
         /** Vault address (for vault trading). */
         vaultAddress: v.pipe(
-            v.optional(v.pipe(Hex, v.length(42))),
+            v.optional(Address),
             v.description("Vault address (for vault trading)."),
         ),
         /** Expiration time of the action. */
@@ -2582,7 +2580,7 @@ export const UpdateLeverageRequest = v.pipe(
         ),
         /** Vault address (for vault trading). */
         vaultAddress: v.pipe(
-            v.optional(v.pipe(Hex, v.length(42))),
+            v.optional(Address),
             v.description("Vault address (for vault trading)."),
         ),
         /** Expiration time of the action. */
@@ -2682,7 +2680,7 @@ export const UsdSendRequest = v.pipe(
                 ),
                 /** Destination address. */
                 destination: v.pipe(
-                    v.pipe(Hex, v.length(42)),
+                    Address,
                     v.description("Destination address."),
                 ),
                 /** Amount to send (1 = 1$). */
@@ -2731,7 +2729,7 @@ export const VaultDistributeRequest = v.pipe(
                 ),
                 /** Vault address. */
                 vaultAddress: v.pipe(
-                    v.pipe(Hex, v.length(42)),
+                    Address,
                     v.description("Vault address."),
                 ),
                 /**
@@ -2787,17 +2785,17 @@ export const VaultModifyRequest = v.pipe(
                 ),
                 /** Vault address. */
                 vaultAddress: v.pipe(
-                    v.pipe(Hex, v.length(42)),
+                    Address,
                     v.description("Vault address."),
                 ),
-                /** Allow deposits from followers. */
+                /** Allow deposits from followers (default: null). */
                 allowDeposits: v.pipe(
-                    v.nullable(v.boolean()),
+                    v.optional(v.nullable(v.boolean()), null),
                     v.description("Allow deposits from followers."),
                 ),
-                /** Always close positions on withdrawal. */
+                /** Always close positions on withdrawal (default: null). */
                 alwaysCloseOnWithdraw: v.pipe(
-                    v.nullable(v.boolean()),
+                    v.optional(v.nullable(v.boolean()), null),
                     v.description("Always close positions on withdrawal."),
                 ),
             }),
@@ -2841,7 +2839,7 @@ export const VaultTransferRequest = v.pipe(
                 ),
                 /** Vault address. */
                 vaultAddress: v.pipe(
-                    v.pipe(Hex, v.length(42)),
+                    Address,
                     v.description("Vault address."),
                 ),
                 /** `true` for deposit, `false` for withdrawal. */
@@ -2905,7 +2903,7 @@ export const Withdraw3Request = v.pipe(
                 ),
                 /** Destination address. */
                 destination: v.pipe(
-                    v.pipe(Hex, v.length(42)),
+                    Address,
                     v.description("Destination address."),
                 ),
                 /** Amount to withdraw (1 = 1$). */
@@ -2967,12 +2965,12 @@ export const MultiSigRequest = v.pipe(
                     v.object({
                         /** Address of the multi-signature user account. */
                         multiSigUser: v.pipe(
-                            v.pipe(Hex, v.length(42)),
+                            Address,
                             v.description("Address of the multi-signature user account."),
                         ),
                         /** Address of the authorized user initiating the request (any authorized user). */
                         outerSigner: v.pipe(
-                            v.pipe(Hex, v.length(42)),
+                            Address,
                             v.description(
                                 "Address of the authorized user initiating the request (any authorized user).",
                             ),
@@ -3042,7 +3040,7 @@ export const MultiSigRequest = v.pipe(
         ),
         /** Vault address (for vault trading). */
         vaultAddress: v.pipe(
-            v.optional(v.pipe(Hex, v.length(42))),
+            v.optional(Address),
             v.description("Vault address (for vault trading)."),
         ),
         /** Expiration time of the action. */

package/src/src/schemas/exchange/responses.ts

@@ -1,5 +1,5 @@
 import * as v from "valibot";
-import { Hex, UnsignedDecimal, UnsignedInteger } from "../_base.js";
+import { Address, Hex, UnsignedDecimal, UnsignedInteger } from "../_base.js";
 
 /** Response for order cancellation. */
 export const CancelResponse = v.pipe(
@@ -100,7 +100,7 @@ export const CreateSubAccountResponse = v.pipe(
                 ),
                 /** Sub-account address. */
                 data: v.pipe(
-                    v.pipe(Hex, v.length(42)),
+                    Address,
                     v.description("Sub-account address."),
                 ),
             }),
@@ -129,7 +129,7 @@ export const CreateVaultResponse = v.pipe(
                 ),
                 /** Vault address. */
                 data: v.pipe(
-                    v.pipe(Hex, v.length(42)),
+                    Address,
                     v.description("Vault address."),
                 ),
             }),

package/src/src/schemas/explorer/requests.ts

@@ -1,5 +1,5 @@
 import * as v from "valibot";
-import { Hex, UnsignedInteger } from "../_base.js";
+import { Address, Hex, UnsignedInteger } from "../_base.js";
 
 /**
  * Request block details by block height.
@@ -56,7 +56,7 @@ export const UserDetailsRequest = v.pipe(
         ),
         /** User address. */
         user: v.pipe(
-            v.pipe(Hex, v.length(42)),
+            Address,
             v.description("User address."),
         ),
     }),

package/src/src/schemas/explorer/responses.ts

@@ -1,5 +1,5 @@
 import * as v from "valibot";
-import { Hex, UnsignedInteger } from "../_base.js";
+import { Address, Hex, UnsignedInteger } from "../_base.js";
 
 /** Transaction details. */
 export const TxDetails = v.pipe(
@@ -37,7 +37,7 @@ export const TxDetails = v.pipe(
         ),
         /** Creator's address. */
         user: v.pipe(
-            v.pipe(Hex, v.length(42)),
+            Address,
             v.description("Creator's address."),
         ),
     }),
@@ -88,7 +88,7 @@ export const BlockDetails = v.pipe(
         ),
         /** Block proposer address. */
         proposer: v.pipe(
-            v.pipe(Hex, v.length(42)),
+            Address,
             v.description("Block proposer address."),
         ),
         /** List of transactions. */