@nktkas/hyperliquid 0.32.0 → 0.32.2

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

@@ -0,0 +1,81 @@
+import * as v from "valibot";
+
+// ============================================================
+// API Schemas
+// ============================================================
+
+/**
+ * Request perp annotation.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-perp-annotation
+ */
+export const PerpAnnotationRequest = /* @__PURE__ */ (() => {
+  return v.object({
+    /** Type of request. */
+    type: v.literal("perpAnnotation"),
+    /** Coin symbol for the perpetual asset. */
+    coin: v.string(),
+  });
+})();
+export type PerpAnnotationRequest = v.InferOutput<typeof PerpAnnotationRequest>;
+
+/**
+ * Perp annotation for an asset.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-perp-annotation
+ */
+export type PerpAnnotationResponse = {
+  /** Classification category assigned to the perpetual. */
+  category: string;
+  /** Human-readable description of the category. */
+  description: string;
+  /** Display name for frontends to use instead of the L1 name. */
+  displayName?: string;
+  /** Keywords used as hints to match against searches. */
+  keywords?: string[];
+} | null;
+
+// ============================================================
+// Execution Logic
+// ============================================================
+
+import { parse } from "../../../_base.js";
+import type { InfoConfig } from "./_base/types.js";
+
+/** Request parameters for the {@linkcode perpAnnotation} function. */
+export type PerpAnnotationParameters = Omit<v.InferInput<typeof PerpAnnotationRequest>, "type">;
+
+/**
+ * Request perp annotation.
+ *
+ * @param config General configuration for Info API requests.
+ * @param params Parameters specific to the API request.
+ * @param signal {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+ * @return Perp annotation for an asset.
+ *
+ * @throws {ValidationError} When the request parameters fail validation (before sending).
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { perpAnnotation } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ *
+ * const data = await perpAnnotation({ transport }, {
+ *   coin: "BTC",
+ * });
+ * ```
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-perp-annotation
+ */
+export function perpAnnotation(
+  config: InfoConfig,
+  params: PerpAnnotationParameters,
+  signal?: AbortSignal,
+): Promise<PerpAnnotationResponse> {
+  const request = parse(PerpAnnotationRequest, {
+    type: "perpAnnotation",
+    ...params,
+  });
+  return config.transport.request("info", request, signal);
+}

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

@@ -0,0 +1,74 @@
+import * as v from "valibot";
+
+// ============================================================
+// API Schemas
+// ============================================================
+
+/**
+ * Request concise annotations for all perpetual assets.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-concise-perp-annotations
+ */
+export const PerpConciseAnnotationsRequest = /* @__PURE__ */ (() => {
+  return v.object({
+    /** Type of request. */
+    type: v.literal("perpConciseAnnotations"),
+  });
+})();
+export type PerpConciseAnnotationsRequest = v.InferOutput<typeof PerpConciseAnnotationsRequest>;
+
+/**
+ * Array of tuples mapping coin names to their concise annotations.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-concise-perp-annotations
+ */
+export type PerpConciseAnnotationsResponse = [
+  /** Coin symbol. */
+  coin: string,
+  /** Concise annotation. */
+  annotation: {
+    /** Classification category assigned to the perpetual. */
+    category: string;
+    /** Display name for frontends to use instead of the L1 name. */
+    displayName?: string;
+    /** Keywords used as hints to match against searches. */
+    keywords?: string[];
+  },
+][];
+
+// ============================================================
+// Execution Logic
+// ============================================================
+
+import { parse } from "../../../_base.js";
+import type { InfoConfig } from "./_base/types.js";
+
+/**
+ * Request concise annotations for all perpetual assets.
+ *
+ * @param config General configuration for Info API requests.
+ * @param signal {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+ * @return Array of tuples mapping coin names to their concise annotations.
+ *
+ * @throws {ValidationError} When the request parameters fail validation (before sending).
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { perpConciseAnnotations } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ *
+ * const data = await perpConciseAnnotations({ transport });
+ * ```
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-concise-perp-annotations
+ */
+export function perpConciseAnnotations(
+  config: InfoConfig,
+  signal?: AbortSignal,
+): Promise<PerpConciseAnnotationsResponse> {
+  const request = parse(PerpConciseAnnotationsRequest, {
+    type: "perpConciseAnnotations",
+  });
+  return config.transport.request("info", request, signal);
+}

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

@@ -74,10 +74,9 @@ export type PerpDexLimitsParameters = Omit<v.InferInput<typeof PerpDexLimitsRequ
  *
  * const transport = new HttpTransport(); // or `WebSocketTransport`
  *
- * const data = await perpDexLimits(
- *   { transport },
- *   { dex: "test" },
- * );
+ * const data = await perpDexLimits({ transport }, {
+ *   dex: "test",
+ * });
  * ```
  *
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-builder-deployed-perp-market-limits

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

@@ -58,7 +58,9 @@ export type PerpDexStatusParameters = Omit<v.InferInput<typeof PerpDexStatusRequ
  *
  * const transport = new HttpTransport(); // or `WebSocketTransport`
  *
- * const data = await perpDexStatus({ transport }, { dex: "test" });
+ * const data = await perpDexStatus({ transport }, {
+ *   dex: "test",
+ * });
  * ```
  *
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#get-perp-market-status

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

@@ -84,10 +84,9 @@ export type PortfolioParameters = Omit<v.InferInput<typeof PortfolioRequest>, "t
  *
  * const transport = new HttpTransport(); // or `WebSocketTransport`
  *
- * const data = await portfolio(
- *   { transport },
- *   { user: "0x..." },
- * );
+ * const data = await portfolio({ transport }, {
+ *   user: "0x...",
+ * });
  * ```
  *
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-portfolio

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

@@ -68,10 +68,10 @@ export type PreTransferCheckParameters = Omit<v.InferInput<typeof PreTransferChe
  *
  * const transport = new HttpTransport(); // or `WebSocketTransport`
  *
- * const data = await preTransferCheck(
- *   { transport },
- *   { user: "0x...", source: "0x..." },
- * );
+ * const data = await preTransferCheck({ transport }, {
+ *   user: "0x...",
+ *   source: "0x...",
+ * });
  * ```
  *
  * @see null

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

@@ -83,10 +83,9 @@ export type RecentTradesParameters = Omit<v.InferInput<typeof RecentTradesReques
  *
  * const transport = new HttpTransport(); // or `WebSocketTransport`
  *
- * const data = await recentTrades(
- *   { transport },
- *   { coin: "ETH" },
- * );
+ * const data = await recentTrades({ transport }, {
+ *   coin: "ETH",
+ * });
  * ```
  *
  * @see null

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

@@ -203,10 +203,9 @@ export type ReferralParameters = Omit<v.InferInput<typeof ReferralRequest>, "typ
  *
  * const transport = new HttpTransport(); // or `WebSocketTransport`
  *
- * const data = await referral(
- *   { transport },
- *   { user: "0x..." },
- * );
+ * const data = await referral({ transport }, {
+ *   user: "0x...",
+ * });
  * ```
  *
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-referral-information

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

@@ -91,10 +91,9 @@ export type SpotClearinghouseStateParameters = Omit<v.InferInput<typeof SpotClea
  *
  * const transport = new HttpTransport(); // or `WebSocketTransport`
  *
- * const data = await spotClearinghouseState(
- *   { transport },
- *   { user: "0x..." },
- * );
+ * const data = await spotClearinghouseState({ transport }, {
+ *   user: "0x...",
+ * });
  * ```
  *
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-a-users-token-balances

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

@@ -114,10 +114,9 @@ export type SpotDeployStateParameters = Omit<v.InferInput<typeof SpotDeployState
  *
  * const transport = new HttpTransport(); // or `WebSocketTransport`
  *
- * const data = await spotDeployState(
- *   { transport },
- *   { user: "0x..." },
- * );
+ * const data = await spotDeployState({ transport }, {
+ *   user: "0x...",
+ * });
  * ```
  *
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-the-spot-deploy-auction

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

@@ -73,10 +73,9 @@ export type SubAccountsParameters = Omit<v.InferInput<typeof SubAccountsRequest>
  *
  * const transport = new HttpTransport(); // or `WebSocketTransport`
  *
- * const data = await subAccounts(
- *   { transport },
- *   { user: "0x..." },
- * );
+ * const data = await subAccounts({ transport }, {
+ *   user: "0x...",
+ * });
  * ```
  *
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-subaccounts

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

@@ -73,10 +73,9 @@ export type SubAccounts2Parameters = Omit<v.InferInput<typeof SubAccounts2Reques
  *
  * const transport = new HttpTransport(); // or `WebSocketTransport`
  *
- * const data = await subAccounts2(
- *   { transport },
- *   { user: "0x..." },
- * );
+ * const data = await subAccounts2({ transport }, {
+ *   user: "0x...",
+ * });
  * ```
  *
  * @see null

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

@@ -144,10 +144,9 @@ export type TokenDetailsParameters = Omit<v.InferInput<typeof TokenDetailsReques
  *
  * const transport = new HttpTransport(); // or `WebSocketTransport`
  *
- * const data = await tokenDetails(
- *   { transport },
- *   { tokenId: "0x..." },
- * );
+ * const data = await tokenDetails({ transport }, {
+ *   tokenId: "0x...",
+ * });
  * ```
  *
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-a-token

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

@@ -78,10 +78,9 @@ export type TwapHistoryParameters = Omit<v.InferInput<typeof TwapHistoryRequest>
  *
  * const transport = new HttpTransport(); // or `WebSocketTransport`
  *
- * const data = await twapHistory(
- *   { transport },
- *   { user: "0x..." },
- * );
+ * const data = await twapHistory({ transport }, {
+ *   user: "0x...",
+ * });
  * ```
  *
  * @see null

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

@@ -59,10 +59,10 @@ export type TxDetailsParameters = Omit<v.InferInput<typeof TxDetailsRequest>, "t
  * import { txDetails } from "@nktkas/hyperliquid/api/info";
  *
  * const transport = new HttpTransport(); // only `HttpTransport` supports this API
- * const data = await txDetails(
- *   { transport },
- *   { hash: "0x..." },
- * );
+ *
+ * const data = await txDetails({ transport }, {
+ *   hash: "0x...",
+ * });
  * ```
  *
  * @see null

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

@@ -59,10 +59,9 @@ export type UserAbstractionParameters = Omit<v.InferInput<typeof UserAbstraction
  *
  * const transport = new HttpTransport(); // or `WebSocketTransport`
  *
- * const data = await userAbstraction(
- *   { transport },
- *   { user: "0x..." },
- * );
+ * const data = await userAbstraction({ transport }, {
+ *   user: "0x...",
+ * });
  * ```
  *
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-abstraction-state

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

@@ -73,13 +73,10 @@ export type UserBorrowLendInterestParameters = Omit<v.InferInput<typeof UserBorr
  *
  * const transport = new HttpTransport(); // or `WebSocketTransport`
  *
- * const data = await userBorrowLendInterest(
- *   { transport },
- *   {
- *     user: "0x...",
- *     startTime: Date.now() - 1000 * 60 * 60 * 24,
- *   },
- * );
+ * const data = await userBorrowLendInterest({ transport }, {
+ *   user: "0x...",
+ *   startTime: Date.now() - 1000 * 60 * 60 * 24,
+ * });
  * ```
  *
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-borrow-lend-user-state

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

@@ -59,10 +59,10 @@ export type UserDetailsParameters = Omit<v.InferInput<typeof UserDetailsRequest>
  * import { userDetails } from "@nktkas/hyperliquid/api/info";
  *
  * const transport = new HttpTransport(); // only `HttpTransport` supports this API
- * const data = await userDetails(
- *   { transport },
- *   { user: "0x..." },
- * );
+ *
+ * const data = await userDetails({ transport }, {
+ *   user: "0x...",
+ * });
  * ```
  *
  * @see null

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

@@ -54,10 +54,9 @@ export type UserDexAbstractionParameters = Omit<v.InferInput<typeof UserDexAbstr
  *
  * const transport = new HttpTransport(); // or `WebSocketTransport`
  *
- * const data = await userDexAbstraction(
- *   { transport },
- *   { user: "0x..." },
- * );
+ * const data = await userDexAbstraction({ transport }, {
+ *   user: "0x...",
+ * });
  * ```
  *
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-hip-3-dex-abstraction-state

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

@@ -231,10 +231,9 @@ export type UserFeesParameters = Omit<v.InferInput<typeof UserFeesRequest>, "typ
  *
  * const transport = new HttpTransport(); // or `WebSocketTransport`
  *
- * const data = await userFees(
- *   { transport },
- *   { user: "0x..." },
- * );
+ * const data = await userFees({ transport }, {
+ *   user: "0x...",
+ * });
  * ```
  *
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-fees

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

@@ -78,10 +78,9 @@ export type UserFillsParameters = Omit<v.InferInput<typeof UserFillsRequest>, "t
  *
  * const transport = new HttpTransport(); // or `WebSocketTransport`
  *
- * const data = await userFills(
- *   { transport },
- *   { user: "0x..." },
- * );
+ * const data = await userFills({ transport }, {
+ *   user: "0x...",
+ * });
  * ```
  *
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-fills

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

@@ -63,13 +63,10 @@ export type UserFillsByTimeParameters = Omit<v.InferInput<typeof UserFillsByTime
  *
  * const transport = new HttpTransport(); // or `WebSocketTransport`
  *
- * const data = await userFillsByTime(
- *   { transport },
- *   {
- *     user: "0x...",
- *     startTime: Date.now() - 1000 * 60 * 60 * 24,
- *   },
- * );
+ * const data = await userFillsByTime({ transport }, {
+ *   user: "0x...",
+ *   startTime: Date.now() - 1000 * 60 * 60 * 24,
+ * });
  * ```
  *
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-fills-by-time

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

@@ -90,10 +90,9 @@ export type UserFundingParameters = Omit<v.InferInput<typeof UserFundingRequest>
  *
  * const transport = new HttpTransport(); // or `WebSocketTransport`
  *
- * const data = await userFunding(
- *   { transport },
- *   { user: "0x..." },
- * );
+ * const data = await userFunding({ transport }, {
+ *   user: "0x...",
+ * });
  * ```
  *
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-a-users-funding-history-or-non-funding-ledger-updates

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

@@ -92,7 +92,7 @@ export type UserNonFundingLedgerUpdatesResponse = {
       liquidatedNtlPos: string;
       /**
        * Account value at liquidation time.
-       * @pattern ^[0-9]+(\.[0-9]+)?$
+       * @pattern ^-?[0-9]+(\.[0-9]+)?$
        */
       accountValue: string;
       /** Leverage type for liquidated positions. */
@@ -389,6 +389,20 @@ export type UserNonFundingLedgerUpdatesResponse = {
        * @pattern ^[0-9]+(\.[0-9]+)?$
        */
       amount: string;
+    }
+    | {
+      /** Update type. */
+      type: "vaultLeaderCommission";
+      /**
+       * Address of the leader.
+       * @pattern ^0x[a-fA-F0-9]{40}$
+       */
+      user: `0x${string}`;
+      /**
+       * Amount earned in USDC.
+       * @pattern ^[0-9]+(\.[0-9]+)?$
+       */
+      usdc: string;
     };
 }[];
 
@@ -423,10 +437,9 @@ export type UserNonFundingLedgerUpdatesParameters = Omit<
  *
  * const transport = new HttpTransport(); // or `WebSocketTransport`
  *
- * const data = await userNonFundingLedgerUpdates(
- *   { transport },
- *   { user: "0x..." },
- * );
+ * const data = await userNonFundingLedgerUpdates({ transport }, {
+ *   user: "0x...",
+ * });
  * ```
  *
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-a-users-funding-history-or-non-funding-ledger-updates

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

@@ -66,10 +66,9 @@ export type UserRateLimitParameters = Omit<v.InferInput<typeof UserRateLimitRequ
  *
  * const transport = new HttpTransport(); // or `WebSocketTransport`
  *
- * const data = await userRateLimit(
- *   { transport },
- *   { user: "0x..." },
- * );
+ * const data = await userRateLimit({ transport }, {
+ *   user: "0x...",
+ * });
  * ```
  *
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-user-rate-limits

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

@@ -79,10 +79,9 @@ export type UserRoleParameters = Omit<v.InferInput<typeof UserRoleRequest>, "typ
  *
  * const transport = new HttpTransport(); // or `WebSocketTransport`
  *
- * const data = await userRole(
- *   { transport },
- *   { user: "0x..." },
- * );
+ * const data = await userRole({ transport }, {
+ *   user: "0x...",
+ * });
  * ```
  *
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-role

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

@@ -62,10 +62,9 @@ export type UserToMultiSigSignersParameters = Omit<v.InferInput<typeof UserToMul
  *
  * const transport = new HttpTransport(); // or `WebSocketTransport`
  *
- * const data = await userToMultiSigSigners(
- *   { transport },
- *   { user: "0x..." },
- * );
+ * const data = await userToMultiSigSigners({ transport }, {
+ *   user: "0x...",
+ * });
  * ```
  *
  * @see null

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

@@ -60,10 +60,9 @@ export type UserTwapSliceFillsParameters = Omit<v.InferInput<typeof UserTwapSlic
  *
  * const transport = new HttpTransport(); // or `WebSocketTransport`
  *
- * const data = await userTwapSliceFills(
- *   { transport },
- *   { user: "0x..." },
- * );
+ * const data = await userTwapSliceFills({ transport }, {
+ *   user: "0x...",
+ * });
  * ```
  *
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-twap-slice-fills

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

@@ -61,13 +61,10 @@ export type UserTwapSliceFillsByTimeParameters = Omit<v.InferInput<typeof UserTw
  *
  * const transport = new HttpTransport(); // or `WebSocketTransport`
  *
- * const data = await userTwapSliceFillsByTime(
- *   { transport },
- *   {
- *     user: "0x...",
- *     startTime: Date.now() - 1000 * 60 * 60 * 24,
- *   },
- * );
+ * const data = await userTwapSliceFillsByTime({ transport }, {
+ *   user: "0x...",
+ *   startTime: Date.now() - 1000 * 60 * 60 * 24,
+ * });
  * ```
  *
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-twap-slice-fills

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

@@ -67,10 +67,9 @@ export type UserVaultEquitiesParameters = Omit<v.InferInput<typeof UserVaultEqui
  *
  * const transport = new HttpTransport(); // or `WebSocketTransport`
  *
- * const data = await userVaultEquities(
- *   { transport },
- *   { user: "0x..." },
- * );
+ * const data = await userVaultEquities({ transport }, {
+ *   user: "0x...",
+ * });
  * ```
  *
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-vault-deposits

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

@@ -151,10 +151,9 @@ export type VaultDetailsParameters = Omit<v.InferInput<typeof VaultDetailsReques
  *
  * const transport = new HttpTransport(); // or `WebSocketTransport`
  *
- * const data = await vaultDetails(
- *   { transport },
- *   { vaultAddress: "0x..." },
- * );
+ * const data = await vaultDetails({ transport }, {
+ *   vaultAddress: "0x...",
+ * });
  * ```
  *
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-details-for-a-vault

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

@@ -108,10 +108,9 @@ export type WebData2Parameters = Omit<v.InferInput<typeof WebData2Request>, "typ
  *
  * const transport = new HttpTransport(); // or `WebSocketTransport`
  *
- * const data = await webData2(
- *   { transport },
- *   { user: "0x..." },
- * );
+ * const data = await webData2({ transport }, {
+ *   user: "0x...",
+ * });
  * ```
  *
  * @see null