@nktkas/hyperliquid 0.30.2 → 0.31.0

package/src/src/api/info/_methods/spotMeta.ts

@@ -11,16 +11,10 @@ import { Address, Hex, Integer, UnsignedDecimal, UnsignedInteger } from "../../_
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-spot-metadata
  */
 export const SpotMetaRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Type of request. */
-      type: v.pipe(
-        v.literal("spotMeta"),
-        v.description("Type of request."),
-      ),
-    }),
-    v.description("Request spot trading metadata."),
-  );
+  return v.object({
+    /** Type of request. */
+    type: v.literal("spotMeta"),
+  });
 })();
 export type SpotMetaRequest = v.InferOutput<typeof SpotMetaRequest>;
 
@@ -29,105 +23,86 @@ export type SpotMetaRequest = v.InferOutput<typeof SpotMetaRequest>;
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-spot-metadata
  */
 export const SpotMetaResponse = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Trading universes available for spot trading. */
-      universe: v.pipe(
-        v.array(
+  return v.object({
+    /** Trading universes available for spot trading. */
+    universe: v.array(
+      v.object({
+        /** Token indices included in this universe. */
+        tokens: v.array(UnsignedInteger),
+        /** Name of the universe. */
+        name: v.string(),
+        /** Unique identifier of the universe. */
+        index: UnsignedInteger,
+        /** Indicates if the token is the primary representation in the system. */
+        isCanonical: v.boolean(),
+      }),
+    ),
+    /** Tokens available for spot trading. */
+    tokens: v.array(
+      v.object({
+        /** Name of the token. */
+        name: v.string(),
+        /** Minimum decimal places for order sizes. */
+        szDecimals: UnsignedInteger,
+        /** Number of decimals for the token's smallest unit. */
+        weiDecimals: UnsignedInteger,
+        /** Unique identifier for the token. */
+        index: UnsignedInteger,
+        /** Token ID. */
+        tokenId: Hex,
+        /** Indicates if the token is the primary representation in the system. */
+        isCanonical: v.boolean(),
+        /** EVM contract details. */
+        evmContract: v.nullable(
           v.object({
-            /** Token indices included in this universe. */
-            tokens: v.pipe(
-              v.array(UnsignedInteger),
-              v.description("Token indices included in this universe."),
-            ),
-            /** Name of the universe. */
-            name: v.pipe(
-              v.string(),
-              v.description("Name of the universe."),
-            ),
-            /** Unique identifier of the universe. */
-            index: v.pipe(
-              UnsignedInteger,
-              v.description("Unique identifier of the universe."),
-            ),
-            /** Indicates if the token is the primary representation in the system. */
-            isCanonical: v.pipe(
-              v.boolean(),
-              v.description("Indicates if the token is the primary representation in the system."),
-            ),
+            /** Contract address. */
+            address: Address,
+            /** Extra decimals in the token's smallest unit. */
+            evm_extra_wei_decimals: Integer,
           }),
         ),
-        v.description("Trading universes available for spot trading."),
-      ),
-      /** Tokens available for spot trading. */
-      tokens: v.pipe(
-        v.array(
+        /** Full display name of the token. */
+        fullName: v.nullable(v.string()),
+        /** Deployer trading fee share for the token. */
+        deployerTradingFeeShare: UnsignedDecimal,
+      }),
+    ),
+    /** Outcome markets available for spot trading. */
+    outcomes: v.array(
+      v.object({
+        /** Unique identifier of the outcome market. */
+        outcome: UnsignedInteger,
+        /** Short name of the outcome market. */
+        name: v.string(),
+        /** Description of the outcome market. */
+        description: v.string(),
+        /** Token specifications for each side of the outcome market. */
+        sideSpecs: v.array(
           v.object({
-            /** Name of the token. */
-            name: v.pipe(
-              v.string(),
-              v.description("Name of the token."),
-            ),
-            /** Minimum decimal places for order sizes. */
-            szDecimals: v.pipe(
-              UnsignedInteger,
-              v.description("Minimum decimal places for order sizes."),
-            ),
-            /** Number of decimals for the token's smallest unit. */
-            weiDecimals: v.pipe(
-              UnsignedInteger,
-              v.description("Number of decimals for the token's smallest unit."),
-            ),
-            /** Unique identifier for the token. */
-            index: v.pipe(
-              UnsignedInteger,
-              v.description("Unique identifier for the token."),
-            ),
-            /** Token ID. */
-            tokenId: v.pipe(
-              Hex,
-              v.description("Token ID."),
-            ),
-            /** Indicates if the token is the primary representation in the system. */
-            isCanonical: v.pipe(
-              v.boolean(),
-              v.description("Indicates if the token is the primary representation in the system."),
-            ),
-            /** EVM contract details. */
-            evmContract: v.pipe(
-              v.nullable(
-                v.object({
-                  /** Contract address. */
-                  address: v.pipe(
-                    Address,
-                    v.description("Contract address."),
-                  ),
-                  /** Extra decimals in the token's smallest unit. */
-                  evm_extra_wei_decimals: v.pipe(
-                    Integer,
-                    v.description("Extra decimals in the token's smallest unit."),
-                  ),
-                }),
-              ),
-              v.description("EVM contract details."),
-            ),
-            /** Full display name of the token. */
-            fullName: v.pipe(
-              v.nullable(v.string()),
-              v.description("Full display name of the token."),
-            ),
-            /** Deployer trading fee share for the token. */
-            deployerTradingFeeShare: v.pipe(
-              UnsignedDecimal,
-              v.description("Deployer trading fee share for the token."),
-            ),
+            /** Side name (e.g., "YES", "NO"). */
+            name: v.string(),
+            /** Spot token index corresponding to this side. */
+            token: UnsignedInteger,
           }),
         ),
-        v.description("Tokens available for spot trading."),
-      ),
-    }),
-    v.description("Metadata for spot assets."),
-  );
+      }),
+    ),
+    /** Questions for prediction markets. */
+    questions: v.array(
+      v.object({
+        /** Unique identifier of the question. */
+        question: UnsignedInteger,
+        /** Short name of the question. */
+        name: v.string(),
+        /** Description of the question. */
+        description: v.string(),
+        /** Default outcome index if the question is not resolved. */
+        fallbackOutcome: UnsignedInteger,
+        /** Outcome indices associated with this question. */
+        namedOutcomes: v.array(UnsignedInteger),
+      }),
+    ),
+  });
 })();
 export type SpotMetaResponse = v.InferOutput<typeof SpotMetaResponse>;
 

package/src/src/api/info/_methods/spotMetaAndAssetCtxs.ts

@@ -12,16 +12,10 @@ import { SpotMetaResponse } from "./spotMeta.js";
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-spot-asset-contexts
  */
 export const SpotMetaAndAssetCtxsRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Type of request. */
-      type: v.pipe(
-        v.literal("spotMetaAndAssetCtxs"),
-        v.description("Type of request."),
-      ),
-    }),
-    v.description("Request spot metadata and asset contexts."),
-  );
+  return v.object({
+    /** Type of request. */
+    type: v.literal("spotMetaAndAssetCtxs"),
+  });
 })();
 export type SpotMetaAndAssetCtxsRequest = v.InferOutput<typeof SpotMetaAndAssetCtxsRequest>;
 
@@ -30,13 +24,7 @@ export type SpotMetaAndAssetCtxsRequest = v.InferOutput<typeof SpotMetaAndAssetC
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-spot-asset-contexts
  */
 export const SpotMetaAndAssetCtxsResponse = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.tuple([
-      SpotMetaResponse,
-      v.array(SpotAssetCtxSchema),
-    ]),
-    v.description("Tuple of spot metadata and asset contexts."),
-  );
+  return v.tuple([SpotMetaResponse, v.array(SpotAssetCtxSchema)]);
 })();
 export type SpotMetaAndAssetCtxsResponse = v.InferOutput<typeof SpotMetaAndAssetCtxsResponse>;
 

package/src/src/api/info/_methods/spotPairDeployAuctionStatus.ts

@@ -11,16 +11,10 @@ import { PerpDeployAuctionStatusResponse } from "./perpDeployAuctionStatus.js";
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-the-spot-pair-deploy-auction
  */
 export const SpotPairDeployAuctionStatusRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Type of request. */
-      type: v.pipe(
-        v.literal("spotPairDeployAuctionStatus"),
-        v.description("Type of request."),
-      ),
-    }),
-    v.description("Request for the status of the spot deploy auction."),
-  );
+  return v.object({
+    /** Type of request. */
+    type: v.literal("spotPairDeployAuctionStatus"),
+  });
 })();
 export type SpotPairDeployAuctionStatusRequest = v.InferOutput<typeof SpotPairDeployAuctionStatusRequest>;
 
@@ -29,10 +23,7 @@ export type SpotPairDeployAuctionStatusRequest = v.InferOutput<typeof SpotPairDe
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-the-spot-pair-deploy-auction
  */
 export const SpotPairDeployAuctionStatusResponse = /* @__PURE__ */ (() => {
-  return v.pipe(
-    PerpDeployAuctionStatusResponse,
-    v.description("Status of the spot deploy auction."),
-  );
+  return PerpDeployAuctionStatusResponse;
 })();
 export type SpotPairDeployAuctionStatusResponse = v.InferOutput<typeof SpotPairDeployAuctionStatusResponse>;
 

package/src/src/api/info/_methods/subAccounts.ts

@@ -13,21 +13,12 @@ import { SpotClearinghouseStateResponse } from "./spotClearinghouseState.js";
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-subaccounts
  */
 export const SubAccountsRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Type of request. */
-      type: v.pipe(
-        v.literal("subAccounts"),
-        v.description("Type of request."),
-      ),
-      /** User address. */
-      user: v.pipe(
-        Address,
-        v.description("User address."),
-      ),
-    }),
-    v.description("Request user sub-accounts."),
-  );
+  return v.object({
+    /** Type of request. */
+    type: v.literal("subAccounts"),
+    /** User address. */
+    user: Address,
+  });
 })();
 export type SubAccountsRequest = v.InferOutput<typeof SubAccountsRequest>;
 
@@ -36,40 +27,21 @@ export type SubAccountsRequest = v.InferOutput<typeof SubAccountsRequest>;
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-subaccounts
  */
 export const SubAccountsResponse = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.nullable(
-      v.array(
-        v.object({
-          /** Sub-account name. */
-          name: v.pipe(
-            v.string(),
-            v.nonEmpty(),
-            v.description("Sub-account name."),
-          ),
-          /** Sub-account address. */
-          subAccountUser: v.pipe(
-            Address,
-            v.description("Sub-account address."),
-          ),
-          /** Master account address. */
-          master: v.pipe(
-            Address,
-            v.description("Master account address."),
-          ),
-          /** Perpetual trading clearinghouse state summary. */
-          clearinghouseState: v.pipe(
-            ClearinghouseStateResponse,
-            v.description("Perpetual trading clearinghouse state summary."),
-          ),
-          /** Spot tokens clearinghouse state. */
-          spotState: v.pipe(
-            SpotClearinghouseStateResponse,
-            v.description("Spot tokens clearinghouse state."),
-          ),
-        }),
-      ),
+  return v.nullable(
+    v.array(
+      v.object({
+        /** Sub-account name. */
+        name: v.pipe(v.string(), v.nonEmpty()),
+        /** Sub-account address. */
+        subAccountUser: Address,
+        /** Master account address. */
+        master: Address,
+        /** Perpetual trading clearinghouse state summary. */
+        clearinghouseState: ClearinghouseStateResponse,
+        /** Spot tokens clearinghouse state. */
+        spotState: SpotClearinghouseStateResponse,
+      }),
     ),
-    v.description("Array of user sub-account or null if the user does not have any sub-accounts."),
   );
 })();
 export type SubAccountsResponse = v.InferOutput<typeof SubAccountsResponse>;

package/src/src/api/info/_methods/subAccounts2.ts

@@ -12,21 +12,12 @@ import { SpotClearinghouseStateResponse } from "./spotClearinghouseState.js";
  * Request user sub-accounts (V2).
  */
 export const SubAccounts2Request = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Type of request. */
-      type: v.pipe(
-        v.literal("subAccounts2"),
-        v.description("Type of request."),
-      ),
-      /** User address. */
-      user: v.pipe(
-        Address,
-        v.description("User address."),
-      ),
-    }),
-    v.description("Request user sub-accounts (V2)."),
-  );
+  return v.object({
+    /** Type of request. */
+    type: v.literal("subAccounts2"),
+    /** User address. */
+    user: Address,
+  });
 })();
 export type SubAccounts2Request = v.InferOutput<typeof SubAccounts2Request>;
 
@@ -34,41 +25,24 @@ export type SubAccounts2Request = v.InferOutput<typeof SubAccounts2Request>;
  * Array of user sub-account or null if the user does not have any sub-accounts.
  */
 export const SubAccounts2Response = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.nullable(
-      v.array(
-        v.object({
-          /** Sub-account name. */
-          name: v.pipe(
-            v.string(),
-            v.nonEmpty(),
-            v.description("Sub-account name."),
-          ),
-          /** Sub-account address. */
-          subAccountUser: v.pipe(
-            Address,
-            v.description("Sub-account address."),
-          ),
-          /** Master account address. */
-          master: v.pipe(
-            Address,
-            v.description("Master account address."),
-          ),
-          /** DEX to clearinghouse state mapping. Always includes the main DEX (empty dex name). */
-          dexToClearinghouseState: v.pipe(
-            v.array(v.tuple([v.string(), ClearinghouseStateResponse])),
-            v.nonEmpty(),
-            v.description("DEX to clearinghouse state mapping. Always includes the main DEX (empty dex name)."),
-          ),
-          /** Spot tokens clearinghouse state. */
-          spotState: v.pipe(
-            SpotClearinghouseStateResponse,
-            v.description("Spot tokens clearinghouse state."),
-          ),
-        }),
-      ),
+  return v.nullable(
+    v.array(
+      v.object({
+        /** Sub-account name. */
+        name: v.pipe(v.string(), v.nonEmpty()),
+        /** Sub-account address. */
+        subAccountUser: Address,
+        /** Master account address. */
+        master: Address,
+        /** DEX to clearinghouse state mapping. Always includes the main DEX (empty dex name). */
+        dexToClearinghouseState: v.pipe(
+          v.array(v.tuple([v.string(), ClearinghouseStateResponse])),
+          v.nonEmpty(),
+        ),
+        /** Spot tokens clearinghouse state. */
+        spotState: SpotClearinghouseStateResponse,
+      }),
     ),
-    v.description("Array of user sub-account or null if the user does not have any sub-accounts."),
   );
 })();
 export type SubAccounts2Response = v.InferOutput<typeof SubAccounts2Response>;
@@ -94,7 +68,6 @@ export type SubAccounts2Parameters = Omit<v.InferInput<typeof SubAccounts2Respon
  * @throws {ValiError} When the request parameters fail validation (before sending).
  * @throws {TransportError} When the transport layer throws an error.
  *
- * @seenull
  * @example
  * ```ts
  * import { HttpTransport } from "@nktkas/hyperliquid";

package/src/src/api/info/_methods/tokenDetails.ts

@@ -11,22 +11,12 @@ import { Address, Hex, UnsignedDecimal, UnsignedInteger } from "../../_schemas.j
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-a-token
  */
 export const TokenDetailsRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Type of request. */
-      type: v.pipe(
-        v.literal("tokenDetails"),
-        v.description("Type of request."),
-      ),
-      /** Token ID. */
-      tokenId: v.pipe(
-        Hex,
-        v.length(34),
-        v.description("Token ID."),
-      ),
-    }),
-    v.description("Request token details."),
-  );
+  return v.object({
+    /** Type of request. */
+    type: v.literal("tokenDetails"),
+    /** Token ID. */
+    tokenId: v.pipe(Hex, v.length(34)),
+  });
 })();
 export type TokenDetailsRequest = v.InferOutput<typeof TokenDetailsRequest>;
 
@@ -35,109 +25,49 @@ export type TokenDetailsRequest = v.InferOutput<typeof TokenDetailsRequest>;
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-a-token
  */
 export const TokenDetailsResponse = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Name of the token. */
-      name: v.pipe(
-        v.string(),
-        v.description("Name of the token."),
-      ),
-      /** Maximum supply of the token. */
-      maxSupply: v.pipe(
-        UnsignedDecimal,
-        v.description("Maximum supply of the token."),
-      ),
-      /** Total supply of the token. */
-      totalSupply: v.pipe(
-        UnsignedDecimal,
-        v.description("Total supply of the token."),
-      ),
-      /** Circulating supply of the token. */
-      circulatingSupply: v.pipe(
-        UnsignedDecimal,
-        v.description("Circulating supply of the token."),
-      ),
-      /** Decimal places for the minimum tradable unit. */
-      szDecimals: v.pipe(
-        UnsignedInteger,
-        v.description("Decimal places for the minimum tradable unit."),
-      ),
-      /** Decimal places for the token's smallest unit. */
-      weiDecimals: v.pipe(
-        UnsignedInteger,
-        v.description("Decimal places for the token's smallest unit."),
-      ),
-      /** Mid price of the token. */
-      midPx: v.pipe(
-        UnsignedDecimal,
-        v.description("Mid price of the token."),
-      ),
-      /** Mark price of the token. */
-      markPx: v.pipe(
-        UnsignedDecimal,
-        v.description("Mark price of the token."),
-      ),
-      /** Previous day's price of the token. */
-      prevDayPx: v.pipe(
-        UnsignedDecimal,
-        v.description("Previous day's price of the token."),
-      ),
-      /** Genesis data for the token. */
-      genesis: v.pipe(
-        v.nullable(
-          v.object({
-            /** User balances. */
-            userBalances: v.pipe(
-              v.array(v.tuple([Address, v.string()])),
-              v.description("User balances."),
-            ),
-            /** Existing token balances. */
-            existingTokenBalances: v.pipe(
-              v.array(v.tuple([UnsignedInteger, v.string()])),
-              v.description("Existing token balances."),
-            ),
-            /** Blacklisted users. */
-            blacklistUsers: v.pipe(
-              v.array(Address),
-              v.description("Blacklisted users."),
-            ),
-          }),
-        ),
-        v.description("Genesis data for the token."),
-      ),
-      /** Deployer address. */
-      deployer: v.pipe(
-        v.nullable(Address),
-        v.description("Deployer address."),
-      ),
-      /** Gas used during token deployment. */
-      deployGas: v.pipe(
-        v.nullable(UnsignedDecimal),
-        v.description("Gas used during token deployment."),
-      ),
-      /** Deployment time. */
-      deployTime: v.pipe(
-        v.nullable(v.string()),
-        v.description("Deployment time."),
-      ),
-      /** Seeded USDC amount for the token. */
-      seededUsdc: v.pipe(
-        UnsignedDecimal,
-        v.description("Seeded USDC amount for the token."),
-      ),
-      /** Non-circulating user balances of the token. */
-      nonCirculatingUserBalances: v.pipe(
-        v.array(v.tuple([Address, v.string()])),
-        v.description("Non-circulating user balances of the token."),
-      ),
-      /** Future emissions amount. */
-      futureEmissions: v.pipe(
-        UnsignedDecimal,
-        v.description("Future emissions amount."),
-      ),
-    }),
-    v.description("Details of a token."),
-  );
+  return v.object({
+    /** Name of the token. */
+    name: v.string(),
+    /** Maximum supply of the token. */
+    maxSupply: UnsignedDecimal,
+    /** Total supply of the token. */
+    totalSupply: UnsignedDecimal,
+    /** Circulating supply of the token. */
+    circulatingSupply: UnsignedDecimal,
+    /** Decimal places for the minimum tradable unit. */
+    szDecimals: UnsignedInteger,
+    /** Decimal places for the token's smallest unit. */
+    weiDecimals: UnsignedInteger,
+    /** Mid price of the token. */
+    midPx: UnsignedDecimal,
+    /** Mark price of the token. */
+    markPx: UnsignedDecimal,
+    /** Previous day's price of the token. */
+    prevDayPx: UnsignedDecimal,
+    /** Genesis data for the token. */
+    genesis: v.nullable(
+      v.object({
+        /** User balances. */
+        userBalances: v.array(v.tuple([Address, v.string()])),
+        /** Existing token balances. */
+        existingTokenBalances: v.array(v.tuple([UnsignedInteger, v.string()])),
+        /** Blacklisted users. */
+        blacklistUsers: v.array(Address),
+      }),
+    ),
+    /** Deployer address. */
+    deployer: v.nullable(Address),
+    /** Gas used during token deployment. */
+    deployGas: v.nullable(UnsignedDecimal),
+    /** Deployment time. */
+    deployTime: v.nullable(v.string()),
+    /** Seeded USDC amount for the token. */
+    seededUsdc: UnsignedDecimal,
+    /** Non-circulating user balances of the token. */
+    nonCirculatingUserBalances: v.array(v.tuple([Address, v.string()])),
+    /** Future emissions amount. */
+    futureEmissions: UnsignedDecimal,
+  });
 })();
 export type TokenDetailsResponse = v.InferOutput<typeof TokenDetailsResponse>;