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

package/src/src/clients/multiSign.ts

@@ -1,14 +1,16 @@
 import type { IRequestTransport } from "../transports/base.js";
-import type {
-    CancelSuccessResponse,
-    CreateSubAccountResponse,
-    CreateVaultResponse,
-    MultiSigRequest,
-    OrderSuccessResponse,
-    SuccessResponse,
-    TwapCancelSuccessResponse,
-    TwapOrderSuccessResponse,
+import {
+    type CancelSuccessResponse,
+    type CreateSubAccountResponse,
+    type CreateVaultResponse,
+    type MultiSigRequest,
+    type OrderSuccessResponse,
+    parser,
+    type SuccessResponse,
+    type TwapCancelSuccessResponse,
+    type TwapOrderSuccessResponse,
 } from "../schemas/mod.js";
+import { Address } from "../schemas/_base.js";
 import { ExchangeClient, type ExchangeClientParameters } from "./exchange.js";
 import {
     type AbstractWallet,
@@ -24,7 +26,7 @@ export interface MultiSignClientParameters<
     S extends readonly AbstractWallet[] = AbstractWallet[],
 > extends Omit<ExchangeClientParameters<T, S[0]>, "wallet"> {
     /** The multi-signature account address. */
-    multiSignAddress: `0x${string}`;
+    multiSignAddress: string;
     /** Array of wallets used for multi-signature operations. The first wallet acts as the leader. */
     signers: S;
 }
@@ -65,7 +67,7 @@ export class MultiSignClient<
      */
     constructor(args: MultiSignClientParameters<T, S>) {
         super({ ...args, wallet: args.signers[0] });
-        this.multiSignAddress = args.multiSignAddress;
+        this.multiSignAddress = parser(Address)(args.multiSignAddress);
         this.signers = args.signers;
 
         Object.defineProperty(this, "wallet", {
@@ -96,7 +98,7 @@ export class MultiSignClient<
                 { type: keyof typeof userSignedActionEip712Types }
             >;
             vaultAddress?: `0x${string}`;
-            expiresAfter: number | string | undefined;
+            expiresAfter: number | undefined;
         },
         signal?: AbortSignal,
     ): Promise<T> {
@@ -112,7 +114,7 @@ export class MultiSignClient<
                 nonce,
                 isTestnet: this.transport.isTestnet,
                 vaultAddress,
-                expiresAfter: typeof expiresAfter === "string" ? Number(expiresAfter) : expiresAfter,
+                expiresAfter,
             });
         }));
 

package/src/src/clients/subscription.ts

@@ -45,6 +45,7 @@ import {
     type WsWebData2,
     WsWebData2Request,
 } from "../schemas/mod.js";
+import type * as v from "valibot";
 
 /** @see https://github.com/microsoft/TypeScript/issues/13923#issuecomment-2191862501 */
 type DeepImmutable<T> = {
@@ -58,43 +59,46 @@ export interface SubscriptionClientParameters<T extends ISubscriptionTransport =
 }
 
 /** Subscription parameters for the {@linkcode SubscriptionClient.activeAssetCtx} method. */
-export type WsActiveAssetCtxParameters = Omit<WsActiveAssetCtxRequest, "type">;
+export type WsActiveAssetCtxParameters = Omit<v.InferInput<typeof WsActiveAssetCtxRequest>, "type">;
 /** Subscription parameters for the {@linkcode SubscriptionClient.activeAssetData} method. */
-export type WsActiveAssetDataParameters = Omit<WsActiveAssetDataRequest, "type">;
+export type WsActiveAssetDataParameters = Omit<v.InferInput<typeof WsActiveAssetDataRequest>, "type">;
 /** Subscription parameters for the {@linkcode SubscriptionClient.allMids} method. */
-export type WsAllMidsParameters = Omit<WsAllMidsRequest, "type">;
+export type WsAllMidsParameters = Omit<v.InferInput<typeof WsAllMidsRequest>, "type">;
 /** Subscription parameters for the {@linkcode SubscriptionClient.assetCtxs} method. */
-export type WsAssetCtxsParameters = Omit<WsAssetCtxsRequest, "type">;
+export type WsAssetCtxsParameters = Omit<v.InferInput<typeof WsAssetCtxsRequest>, "type">;
 /** Subscription parameters for the {@linkcode SubscriptionClient.bbo} method. */
-export type WsBboParameters = Omit<WsBboRequest, "type">;
+export type WsBboParameters = Omit<v.InferInput<typeof WsBboRequest>, "type">;
 /** Subscription parameters for the {@linkcode SubscriptionClient.candle} method. */
-export type WsCandleParameters = Omit<WsCandleRequest, "type">;
+export type WsCandleParameters = Omit<v.InferInput<typeof WsCandleRequest>, "type">;
 /** Subscription parameters for the {@linkcode SubscriptionClient.clearinghouseState} method. */
-export type WsClearinghouseStateParameters = Omit<WsClearinghouseStateRequest, "type">;
+export type WsClearinghouseStateParameters = Omit<v.InferInput<typeof WsClearinghouseStateRequest>, "type">;
 /** Subscription parameters for the {@linkcode SubscriptionClient.l2Book} method. */
-export type WsL2BookParameters = Omit<WsL2BookRequest, "type">;
+export type WsL2BookParameters = Omit<v.InferInput<typeof WsL2BookRequest>, "type">;
 /** Subscription parameters for the {@linkcode SubscriptionClient.notification} method. */
-export type WsNotificationParameters = Omit<WsNotificationRequest, "type">;
+export type WsNotificationParameters = Omit<v.InferInput<typeof WsNotificationRequest>, "type">;
 /** Subscription parameters for the {@linkcode SubscriptionClient.openOrders} method. */
-export type WsOpenOrdersParameters = Omit<WsOpenOrdersRequest, "type">;
+export type WsOpenOrdersParameters = Omit<v.InferInput<typeof WsOpenOrdersRequest>, "type">;
 /** Subscription parameters for the {@linkcode SubscriptionClient.orderUpdates} method. */
-export type WsOrderUpdatesParameters = Omit<WsOrderUpdatesRequest, "type">;
+export type WsOrderUpdatesParameters = Omit<v.InferInput<typeof WsOrderUpdatesRequest>, "type">;
 /** Subscription parameters for the {@linkcode SubscriptionClient.trades} method. */
-export type WsTradesParameters = Omit<WsTradesRequest, "type">;
+export type WsTradesParameters = Omit<v.InferInput<typeof WsTradesRequest>, "type">;
 /** Subscription parameters for the {@linkcode SubscriptionClient.userEvents} method. */
-export type WsUserEventsParameters = Omit<WsUserEventsRequest, "type">;
+export type WsUserEventsParameters = Omit<v.InferInput<typeof WsUserEventsRequest>, "type">;
 /** Subscription parameters for the {@linkcode SubscriptionClient.userFills} method. */
-export type WsUserFillsParameters = Omit<WsUserFillsRequest, "type">;
+export type WsUserFillsParameters = Omit<v.InferInput<typeof WsUserFillsRequest>, "type">;
 /** Subscription parameters for the {@linkcode SubscriptionClient.userFundings} method. */
-export type WsUserFundingsParameters = Omit<WsUserFundingsRequest, "type">;
+export type WsUserFundingsParameters = Omit<v.InferInput<typeof WsUserFundingsRequest>, "type">;
 /** Subscription parameters for the {@linkcode SubscriptionClient.userNonFundingLedgerUpdates} method. */
-export type WsUserNonFundingLedgerUpdatesParameters = Omit<WsUserNonFundingLedgerUpdatesRequest, "type">;
+export type WsUserNonFundingLedgerUpdatesParameters = Omit<
+    v.InferInput<typeof WsUserNonFundingLedgerUpdatesRequest>,
+    "type"
+>;
 /** Subscription parameters for the {@linkcode SubscriptionClient.userTwapHistory} method. */
-export type WsUserTwapHistoryParameters = Omit<WsUserTwapHistoryRequest, "type">;
+export type WsUserTwapHistoryParameters = Omit<v.InferInput<typeof WsUserTwapHistoryRequest>, "type">;
 /** Subscription parameters for the {@linkcode SubscriptionClient.userTwapSliceFills} method. */
-export type WsUserTwapSliceFillsParameters = Omit<WsUserTwapSliceFillsRequest, "type">;
+export type WsUserTwapSliceFillsParameters = Omit<v.InferInput<typeof WsUserTwapSliceFillsRequest>, "type">;
 /** Subscription parameters for the {@linkcode SubscriptionClient.webData2} method. */
-export type WsWebData2Parameters = Omit<WsWebData2Request, "type">;
+export type WsWebData2Parameters = Omit<v.InferInput<typeof WsWebData2Request>, "type">;
 
 /**
  * Subscription client for subscribing to various Hyperliquid events.
@@ -102,7 +106,7 @@ export type WsWebData2Parameters = Omit<WsWebData2Request, "type">;
  */
 export class SubscriptionClient<
     T extends ISubscriptionTransport = ISubscriptionTransport,
-> implements SubscriptionClientParameters<T>, AsyncDisposable {
+> implements SubscriptionClientParameters<T> {
     transport: T;
 
     /**
@@ -212,11 +216,11 @@ export class SubscriptionClient<
     allMids(listener: (data: WsAllMids) => void): Promise<Subscription>;
     allMids(params: DeepImmutable<WsAllMidsParameters>, listener: (data: WsAllMids) => void): Promise<Subscription>;
     allMids(
-        params_or_listener: DeepImmutable<WsAllMidsParameters> | ((data: WsAllMids) => void),
+        paramsOrListener: DeepImmutable<WsAllMidsParameters> | ((data: WsAllMids) => void),
         maybeListener?: (data: WsAllMids) => void,
     ): Promise<Subscription> {
-        const params = typeof params_or_listener === "function" ? {} : params_or_listener;
-        const listener = typeof params_or_listener === "function" ? params_or_listener : maybeListener!;
+        const params = typeof paramsOrListener === "function" ? {} : paramsOrListener;
+        const listener = typeof paramsOrListener === "function" ? paramsOrListener : maybeListener!;
 
         const payload = parser(WsAllMidsRequest)({ type: "allMids", ...params });
         return this.transport.subscribe<WsAllMids>(payload.type, payload, (e) => {
@@ -251,11 +255,11 @@ export class SubscriptionClient<
         listener: (data: WsAssetCtxs) => void,
     ): Promise<Subscription>;
     assetCtxs(
-        params_or_listener: DeepImmutable<WsAssetCtxsParameters> | ((data: WsAssetCtxs) => void),
+        paramsOrListener: DeepImmutable<WsAssetCtxsParameters> | ((data: WsAssetCtxs) => void),
         maybeListener?: (data: WsAssetCtxs) => void,
     ): Promise<Subscription> {
-        const params = typeof params_or_listener === "function" ? {} : params_or_listener;
-        const listener = typeof params_or_listener === "function" ? params_or_listener : maybeListener!;
+        const params = typeof paramsOrListener === "function" ? {} : paramsOrListener;
+        const listener = typeof paramsOrListener === "function" ? paramsOrListener : maybeListener!;
 
         const payload = parser(WsAssetCtxsRequest)({
             type: "assetCtxs",
@@ -385,7 +389,7 @@ export class SubscriptionClient<
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.WebSocketTransport();
+     * const transport = new hl.WebSocketTransport({ url: "wss://rpc.hyperliquid.xyz/ws" }); // RPC endpoint
      * const subsClient = new hl.SubscriptionClient({ transport });
      *
      * const sub = await subsClient.explorerBlock((data) => {
@@ -413,7 +417,7 @@ export class SubscriptionClient<
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
      *
-     * const transport = new hl.WebSocketTransport();
+     * const transport = new hl.WebSocketTransport({ url: "wss://rpc.hyperliquid.xyz/ws" }); // RPC endpoint
      * const subsClient = new hl.SubscriptionClient({ transport });
      *
      * const sub = await subsClient.explorerTxs((data) => {
@@ -834,8 +838,4 @@ export class SubscriptionClient<
             }
         });
     }
-
-    async [Symbol.asyncDispose](): Promise<void> {
-        await this.transport[Symbol.asyncDispose]?.();
-    }
 }

package/src/src/schemas/_base.ts

@@ -1,62 +1,37 @@
 import * as v from "valibot";
 
 export const UnsignedDecimal = v.pipe(
-    v.string(),
+    v.union([v.string(), v.number()]),
+    v.transform(String),
     v.trim(),
     v.regex(/^[0-9]+(\.[0-9]+)?$/),
     v.transform((value) => formatDecimal(value)),
 );
 export type UnsignedDecimal = v.InferOutput<typeof UnsignedDecimal>;
-export const UnsignedDecimalMayInputNumber = v.pipe(
-    v.unknown(),
-    v.transform((x) => {
-        const data = v.safeParse(v.number(), x);
-        if (data.success) return String(data.output);
-        return x;
-    }),
-    UnsignedDecimal as unknown as v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>,
-);
 
 export const Decimal = v.pipe(
-    v.string(),
+    v.union([v.string(), v.number()]),
+    v.transform(String),
     v.trim(),
     v.regex(/^-?[0-9]+(\.[0-9]+)?$/),
     v.transform((value) => formatDecimal(value)),
 );
 export type Decimal = v.InferOutput<typeof Decimal>;
-export const DecimalMayInputNumber = v.pipe(
-    v.unknown(),
-    v.transform((x) => {
-        const data = v.safeParse(v.number(), x);
-        if (data.success) return String(data.output);
-        return x;
-    }),
-    Decimal as unknown as v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>,
-);
 
-export const Integer = v.pipe(v.number(), v.safeInteger());
-export type Integer = v.InferOutput<typeof Integer>;
-export const IntegerMayInputString = v.pipe(
-    v.unknown(),
-    v.transform((x) => {
-        const data = v.safeParse(Decimal, x);
-        if (data.success) return Number(data.output);
-        return x;
-    }),
-    Integer as unknown as v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, // allow `string | number` in ts, but use a specific type in the JSON schema
+export const Integer = v.pipe(
+    v.union([v.string(), v.number()]),
+    v.transform(Number),
+    v.safeInteger(),
 );
+export type Integer = v.InferOutput<typeof Integer>;
 
-export const UnsignedInteger = v.pipe(v.number(), v.safeInteger(), v.minValue(0));
-export type UnsignedInteger = v.InferOutput<typeof UnsignedInteger>;
-export const UnsignedIntegerMayInputString = v.pipe(
-    v.unknown(),
-    v.transform((x) => {
-        const data = v.safeParse(Decimal, x);
-        if (data.success) return Number(data.output);
-        return x;
-    }),
-    UnsignedInteger as unknown as v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>,
+export const UnsignedInteger = v.pipe(
+    v.union([v.string(), v.number()]),
+    v.transform(Number),
+    v.safeInteger(),
+    v.minValue(0),
 );
+export type UnsignedInteger = v.InferOutput<typeof UnsignedInteger>;
 
 export const Hex = v.pipe(
     v.string(),
@@ -65,6 +40,9 @@ export const Hex = v.pipe(
 );
 export type Hex = v.InferOutput<typeof Hex>;
 
+export const Address = v.pipe(Hex, v.length(42));
+export type Address = v.InferOutput<typeof Address>;
+
 export const TokenId = v.pipe(
     v.string(),
     v.regex(/^[^:]+:0x[0-9a-fA-F]+$/),