@hfunlabs/hyperliquid 0.27.1 → 0.30.0-hfunlabs.1

package/esm/src/api/info/_methods/userNonFundingLedgerUpdates.js

@@ -0,0 +1,267 @@
+import * as v from "valibot";
+// ============================================================
+// API Schemas
+// ============================================================
+import { Address, Decimal, Hex, UnsignedDecimal, UnsignedInteger } from "../../_schemas.js";
+/**
+ * Request user non-funding ledger updates.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-a-users-funding-history-or-non-funding-ledger-updates
+ */
+export const UserNonFundingLedgerUpdatesRequest = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** Type of request. */
+        type: v.pipe(v.literal("userNonFundingLedgerUpdates"), v.description("Type of request.")),
+        /** User address. */
+        user: v.pipe(Address, v.description("User address.")),
+        /** Start time (in ms since epoch). */
+        startTime: v.pipe(v.optional(UnsignedInteger), v.description("Start time (in ms since epoch).")),
+        /** End time (in ms since epoch). */
+        endTime: v.pipe(v.nullish(UnsignedInteger), v.description("End time (in ms since epoch).")),
+    }), v.description("Request user non-funding ledger updates."));
+})();
+/**
+ * Array of user's non-funding ledger update.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-a-users-funding-history-or-non-funding-ledger-updates
+ */
+export const UserNonFundingLedgerUpdatesResponse = /* @__PURE__ */ (() => {
+    return v.pipe(v.array(v.object({
+        /** Timestamp of the update (in ms since epoch). */
+        time: v.pipe(UnsignedInteger, v.description("Timestamp of the update (in ms since epoch).")),
+        /** L1 transaction hash. */
+        hash: v.pipe(Hex, v.length(66), v.description("L1 transaction hash.")),
+        /** Update details. */
+        delta: v.pipe(v.variant("type", [
+            /** Transfer between spot and perpetual accounts. */
+            v.object({
+                /** Update type. */
+                type: v.pipe(v.literal("accountClassTransfer"), v.description("Update type.")),
+                /** Amount transferred in USDC. */
+                usdc: v.pipe(UnsignedDecimal, v.description("Amount transferred in USDC.")),
+                /** Indicates if the transfer is to the perpetual account. */
+                toPerp: v.pipe(v.boolean(), v.description("Indicates if the transfer is to the perpetual account.")),
+            }),
+            /** Deposit to an account. */
+            v.object({
+                /** Update type. */
+                type: v.pipe(v.literal("deposit"), v.description("Update type.")),
+                /** Amount deposited in USDC. */
+                usdc: v.pipe(UnsignedDecimal, v.description("Amount deposited in USDC.")),
+            }),
+            /** Internal transfer between accounts. */
+            v.object({
+                /** Update type. */
+                type: v.pipe(v.literal("internalTransfer"), v.description("Update type.")),
+                /** Amount transferred in USDC. */
+                usdc: v.pipe(UnsignedDecimal, v.description("Amount transferred in USDC.")),
+                /** Initiator address. */
+                user: v.pipe(Address, v.description("Initiator address.")),
+                /** Destination address. */
+                destination: v.pipe(Address, v.description("Destination address.")),
+                /** Transfer fee. */
+                fee: v.pipe(UnsignedDecimal, v.description("Transfer fee.")),
+            }),
+            /** Liquidation event. */
+            v.object({
+                /** Update type. */
+                type: v.pipe(v.literal("liquidation"), v.description("Update type.")),
+                /** Total notional value of liquidated positions. */
+                liquidatedNtlPos: v.pipe(UnsignedDecimal, v.description("Total notional value of liquidated positions.")),
+                /** Account value at liquidation time. */
+                accountValue: v.pipe(UnsignedDecimal, v.description("Account value at liquidation time.")),
+                /** Leverage type for liquidated positions. */
+                leverageType: v.pipe(v.picklist(["Cross", "Isolated"]), v.description("Leverage type for liquidated positions.")),
+                /** Details of each liquidated position. */
+                liquidatedPositions: v.pipe(v.array(v.object({
+                    /** Asset symbol of the liquidated position. */
+                    coin: v.pipe(v.string(), v.description("Asset symbol of the liquidated position.")),
+                    /** Signed position size liquidated. */
+                    szi: v.pipe(Decimal, v.description("Signed position size liquidated.")),
+                })), v.description("Details of each liquidated position.")),
+            }),
+            /** Rewards claim event. */
+            v.object({
+                /** Update type. */
+                type: v.pipe(v.literal("rewardsClaim"), v.description("Update type.")),
+                /** Amount of rewards claimed. */
+                amount: v.pipe(UnsignedDecimal, v.description("Amount of rewards claimed.")),
+                /** Token symbol. */
+                token: v.pipe(v.string(), v.description("Token symbol.")),
+            }),
+            /** Spot transfer between accounts. */
+            v.object({
+                /** Update type. */
+                type: v.pipe(v.literal("spotTransfer"), v.description("Update type.")),
+                /** Token symbol. */
+                token: v.pipe(v.string(), v.description("Token symbol.")),
+                /** Amount transferred. */
+                amount: v.pipe(UnsignedDecimal, v.description("Amount transferred.")),
+                /** Equivalent USDC value. */
+                usdcValue: v.pipe(UnsignedDecimal, v.description("Equivalent USDC value.")),
+                /** Initiator address. */
+                user: v.pipe(Address, v.description("Initiator address.")),
+                /** Destination address. */
+                destination: v.pipe(Address, v.description("Destination address.")),
+                /** Transfer fee. */
+                fee: v.pipe(UnsignedDecimal, v.description("Transfer fee.")),
+                /** Fee in native token. */
+                nativeTokenFee: v.pipe(UnsignedDecimal, v.description("Fee in native token.")),
+                /** Nonce of the transfer. */
+                nonce: v.pipe(v.nullable(UnsignedInteger), v.description("Nonce of the transfer.")),
+                /** Token in which the fee is denominated (e.g., "USDC"). */
+                feeToken: v.pipe(v.string(), v.description('Token in which the fee is denominated (e.g., "USDC").')),
+            }),
+            /** Transfer between sub-accounts. */
+            v.object({
+                /** Update type. */
+                type: v.pipe(v.literal("subAccountTransfer"), v.description("Update type.")),
+                /** Amount transferred in USDC. */
+                usdc: v.pipe(UnsignedDecimal, v.description("Amount transferred in USDC.")),
+                /** Initiator address. */
+                user: v.pipe(Address, v.description("Initiator address.")),
+                /** Destination address. */
+                destination: v.pipe(Address, v.description("Destination address.")),
+            }),
+            /** Vault creation event. */
+            v.object({
+                /** Update type. */
+                type: v.pipe(v.literal("vaultCreate"), v.description("Update type.")),
+                /** Address of the created vault. */
+                vault: v.pipe(Address, v.description("Address of the created vault.")),
+                /** Initial allocated amount in USDC. */
+                usdc: v.pipe(UnsignedDecimal, v.description("Initial allocated amount in USDC.")),
+                /** Vault creation fee. */
+                fee: v.pipe(UnsignedDecimal, v.description("Vault creation fee.")),
+            }),
+            /** Vault deposit event. */
+            v.object({
+                /** Update type. */
+                type: v.pipe(v.literal("vaultDeposit"), v.description("Update type.")),
+                /** Address of the target vault. */
+                vault: v.pipe(Address, v.description("Address of the target vault.")),
+                /** Amount deposited in USDC. */
+                usdc: v.pipe(UnsignedDecimal, v.description("Amount deposited in USDC.")),
+            }),
+            /** Vault distribution event. */
+            v.object({
+                /** Update type. */
+                type: v.pipe(v.literal("vaultDistribution"), v.description("Update type.")),
+                /** Address of the vault distributing funds. */
+                vault: v.pipe(Address, v.description("Address of the vault distributing funds.")),
+                /** Amount distributed in USDC. */
+                usdc: v.pipe(UnsignedDecimal, v.description("Amount distributed in USDC.")),
+            }),
+            /** Vault withdrawal event. */
+            v.object({
+                /** Update type. */
+                type: v.pipe(v.literal("vaultWithdraw"), v.description("Update type.")),
+                /** Vault address. */
+                vault: v.pipe(Address, v.description("Vault address.")),
+                /** Address of the user withdrawing funds. */
+                user: v.pipe(Address, v.description("Address of the user withdrawing funds.")),
+                /** Withdrawal request amount in USD. */
+                requestedUsd: v.pipe(UnsignedDecimal, v.description("Withdrawal request amount in USD.")),
+                /** Withdrawal commission fee. */
+                commission: v.pipe(UnsignedDecimal, v.description("Withdrawal commission fee.")),
+                /** Closing cost associated with positions. */
+                closingCost: v.pipe(UnsignedDecimal, v.description("Closing cost associated with positions.")),
+                /** Basis value for withdrawal calculation. */
+                basis: v.pipe(UnsignedDecimal, v.description("Basis value for withdrawal calculation.")),
+                /** Net withdrawn amount in USD after fees and costs. */
+                netWithdrawnUsd: v.pipe(UnsignedDecimal, v.description("Net withdrawn amount in USD after fees and costs.")),
+            }),
+            /** Withdrawal from an account. */
+            v.object({
+                /** Update type. */
+                type: v.pipe(v.literal("withdraw"), v.description("Update type.")),
+                /** Amount withdrawn in USDC. */
+                usdc: v.pipe(UnsignedDecimal, v.description("Amount withdrawn in USDC.")),
+                /** Nonce (timestamp in ms) used to prevent replay attacks. */
+                nonce: v.pipe(UnsignedInteger, v.description("Nonce (timestamp in ms) used to prevent replay attacks.")),
+                /** Withdrawal fee. */
+                fee: v.pipe(UnsignedDecimal, v.description("Withdrawal fee.")),
+            }),
+            /** Transfer tokens between different perp DEXs, spot balance, users, and/or sub-accounts. */
+            v.object({
+                /** Update type. */
+                type: v.pipe(v.literal("send"), v.description("Update type.")),
+                /** Address of the sender. */
+                user: v.pipe(Address, v.description("Address of the sender.")),
+                /** Destination address. */
+                destination: v.pipe(Address, v.description("Destination address.")),
+                /** Source DEX ("" for default USDC perp DEX, "spot" for spot). */
+                sourceDex: v.pipe(v.string(), v.description('Source DEX ("" for default USDC perp DEX, "spot" for spot).')),
+                /** Destination DEX ("" for default USDC perp DEX, "spot" for spot). */
+                destinationDex: v.pipe(v.string(), v.description('Destination DEX ("" for default USDC perp DEX, "spot" for spot).')),
+                /** Token identifier. */
+                token: v.pipe(v.string(), v.description("Token identifier.")),
+                /** Amount to send (not in wei). */
+                amount: v.pipe(UnsignedDecimal, v.description("Amount to send (not in wei).")),
+                /** Equivalent USDC value. */
+                usdcValue: v.pipe(UnsignedDecimal, v.description("Equivalent USDC value.")),
+                /** Transfer fee. */
+                fee: v.pipe(UnsignedDecimal, v.description("Transfer fee.")),
+                /** Fee in native token. */
+                nativeTokenFee: v.pipe(UnsignedDecimal, v.description("Fee in native token.")),
+                /** Nonce of the transfer. */
+                nonce: v.pipe(UnsignedInteger, v.description("Nonce of the transfer.")),
+                /** Token in which the fee is denominated (e.g., "USDC"). */
+                feeToken: v.pipe(v.string(), v.description('Token in which the fee is denominated (e.g., "USDC").')),
+            }),
+            /** Deploy gas auction update. */
+            v.object({
+                /** Update type. */
+                type: v.pipe(v.literal("deployGasAuction"), v.description("Update type.")),
+                /** Token symbol. */
+                token: v.pipe(v.string(), v.description("Token symbol.")),
+                /** Amount in the specified token. */
+                amount: v.pipe(UnsignedDecimal, v.description("Amount in the specified token.")),
+            }),
+            /** C-staking transfer update. */
+            v.object({
+                /** Update type. */
+                type: v.pipe(v.literal("cStakingTransfer"), v.description("Update type.")),
+                /** Token symbol. */
+                token: v.pipe(v.string(), v.description("Token symbol.")),
+                /** Amount in the specified token. */
+                amount: v.pipe(UnsignedDecimal, v.description("Amount in the specified token.")),
+                /** `true` for deposit, `false` for withdrawal. */
+                isDeposit: v.pipe(v.boolean(), v.description("`true` for deposit, `false` for withdrawal.")),
+            }),
+        ]), v.description("Update details.")),
+    })), v.description("Array of user's non-funding ledger update."));
+})();
+/**
+ * Request user non-funding ledger updates.
+ *
+ * @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.
+ *
+ * @returns Array of user's non-funding ledger update.
+ *
+ * @throws {ValiError} 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 { userNonFundingLedgerUpdates } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ *
+ * 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
+ */
+export function userNonFundingLedgerUpdates(config, params, signal) {
+    const request = v.parse(UserNonFundingLedgerUpdatesRequest, {
+        type: "userNonFundingLedgerUpdates",
+        ...params,
+    });
+    return config.transport.request("info", request, signal);
+}
+//# sourceMappingURL=userNonFundingLedgerUpdates.js.map

package/esm/src/api/info/_methods/userNonFundingLedgerUpdates.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"userNonFundingLedgerUpdates.js","sourceRoot":"","sources":["../../../../../src/src/api/info/_methods/userNonFundingLedgerUpdates.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAE7B,+DAA+D;AAC/D,cAAc;AACd,+DAA+D;AAE/D,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAE5F;;;GAGG;AACH,MAAM,CAAC,MAAM,kCAAkC,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACtE,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,uBAAuB;QACvB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,6BAA6B,CAAC,EACxC,CAAC,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAClC;QACD,oBAAoB;QACpB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;QACD,sCAAsC;QACtC,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,CAAC,CAAC,QAAQ,CAAC,eAAe,CAAC,EAC3B,CAAC,CAAC,WAAW,CAAC,iCAAiC,CAAC,CACjD;QACD,oCAAoC;QACpC,OAAO,EAAE,CAAC,CAAC,IAAI,CACb,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC,EAC1B,CAAC,CAAC,WAAW,CAAC,+BAA+B,CAAC,CAC/C;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,0CAA0C,CAAC,CAC1D,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL;;;GAGG;AACH,MAAM,CAAC,MAAM,mCAAmC,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACvE,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,KAAK,CACL,CAAC,CAAC,MAAM,CAAC;QACP,mDAAmD;QACnD,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,8CAA8C,CAAC,CAC9D;QACD,2BAA2B;QAC3B,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,GAAG,EACH,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,EACZ,CAAC,CAAC,WAAW,CAAC,sBAAsB,CAAC,CACtC;QACD,sBAAsB;QACtB,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE;YAChB,oDAAoD;YACpD,CAAC,CAAC,MAAM,CAAC;gBACP,mBAAmB;gBACnB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,sBAAsB,CAAC,EACjC,CAAC,CAAC,WAAW,CAAC,cAAc,CAAC,CAC9B;gBACD,kCAAkC;gBAClC,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,6BAA6B,CAAC,CAC7C;gBACD,6DAA6D;gBAC7D,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,CAAC,CAAC,OAAO,EAAE,EACX,CAAC,CAAC,WAAW,CAAC,wDAAwD,CAAC,CACxE;aACF,CAAC;YACF,6BAA6B;YAC7B,CAAC,CAAC,MAAM,CAAC;gBACP,mBAAmB;gBACnB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,EACpB,CAAC,CAAC,WAAW,CAAC,cAAc,CAAC,CAC9B;gBACD,gCAAgC;gBAChC,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,2BAA2B,CAAC,CAC3C;aACF,CAAC;YACF,0CAA0C;YAC1C,CAAC,CAAC,MAAM,CAAC;gBACP,mBAAmB;gBACnB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAC7B,CAAC,CAAC,WAAW,CAAC,cAAc,CAAC,CAC9B;gBACD,kCAAkC;gBAClC,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,6BAA6B,CAAC,CAC7C;gBACD,yBAAyB;gBACzB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,oBAAoB,CAAC,CACpC;gBACD,2BAA2B;gBAC3B,WAAW,EAAE,CAAC,CAAC,IAAI,CACjB,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,sBAAsB,CAAC,CACtC;gBACD,oBAAoB;gBACpB,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;aACF,CAAC;YACF,yBAAyB;YACzB,CAAC,CAAC,MAAM,CAAC;gBACP,mBAAmB;gBACnB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,EACxB,CAAC,CAAC,WAAW,CAAC,cAAc,CAAC,CAC9B;gBACD,oDAAoD;gBACpD,gBAAgB,EAAE,CAAC,CAAC,IAAI,CACtB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,+CAA+C,CAAC,CAC/D;gBACD,yCAAyC;gBACzC,YAAY,EAAE,CAAC,CAAC,IAAI,CAClB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,oCAAoC,CAAC,CACpD;gBACD,8CAA8C;gBAC9C,YAAY,EAAE,CAAC,CAAC,IAAI,CAClB,CAAC,CAAC,QAAQ,CAAC,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,EACjC,CAAC,CAAC,WAAW,CAAC,yCAAyC,CAAC,CACzD;gBACD,2CAA2C;gBAC3C,mBAAmB,EAAE,CAAC,CAAC,IAAI,CACzB,CAAC,CAAC,KAAK,CACL,CAAC,CAAC,MAAM,CAAC;oBACP,+CAA+C;oBAC/C,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,0CAA0C,CAAC,CAC1D;oBACD,uCAAuC;oBACvC,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,kCAAkC,CAAC,CAClD;iBACF,CAAC,CACH,EACD,CAAC,CAAC,WAAW,CAAC,sCAAsC,CAAC,CACtD;aACF,CAAC;YACF,2BAA2B;YAC3B,CAAC,CAAC,MAAM,CAAC;gBACP,mBAAmB;gBACnB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,EACzB,CAAC,CAAC,WAAW,CAAC,cAAc,CAAC,CAC9B;gBACD,iCAAiC;gBACjC,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,4BAA4B,CAAC,CAC5C;gBACD,oBAAoB;gBACpB,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;aACF,CAAC;YACF,sCAAsC;YACtC,CAAC,CAAC,MAAM,CAAC;gBACP,mBAAmB;gBACnB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,EACzB,CAAC,CAAC,WAAW,CAAC,cAAc,CAAC,CAC9B;gBACD,oBAAoB;gBACpB,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;gBACD,0BAA0B;gBAC1B,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,qBAAqB,CAAC,CACrC;gBACD,6BAA6B;gBAC7B,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,wBAAwB,CAAC,CACxC;gBACD,yBAAyB;gBACzB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,oBAAoB,CAAC,CACpC;gBACD,2BAA2B;gBAC3B,WAAW,EAAE,CAAC,CAAC,IAAI,CACjB,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,sBAAsB,CAAC,CACtC;gBACD,oBAAoB;gBACpB,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;gBACD,2BAA2B;gBAC3B,cAAc,EAAE,CAAC,CAAC,IAAI,CACpB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,sBAAsB,CAAC,CACtC;gBACD,6BAA6B;gBAC7B,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,QAAQ,CAAC,eAAe,CAAC,EAC3B,CAAC,CAAC,WAAW,CAAC,wBAAwB,CAAC,CACxC;gBACD,4DAA4D;gBAC5D,QAAQ,EAAE,CAAC,CAAC,IAAI,CACd,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,uDAAuD,CAAC,CACvE;aACF,CAAC;YACF,qCAAqC;YACrC,CAAC,CAAC,MAAM,CAAC;gBACP,mBAAmB;gBACnB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,EAC/B,CAAC,CAAC,WAAW,CAAC,cAAc,CAAC,CAC9B;gBACD,kCAAkC;gBAClC,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,6BAA6B,CAAC,CAC7C;gBACD,yBAAyB;gBACzB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,oBAAoB,CAAC,CACpC;gBACD,2BAA2B;gBAC3B,WAAW,EAAE,CAAC,CAAC,IAAI,CACjB,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,sBAAsB,CAAC,CACtC;aACF,CAAC;YACF,4BAA4B;YAC5B,CAAC,CAAC,MAAM,CAAC;gBACP,mBAAmB;gBACnB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,EACxB,CAAC,CAAC,WAAW,CAAC,cAAc,CAAC,CAC9B;gBACD,oCAAoC;gBACpC,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,+BAA+B,CAAC,CAC/C;gBACD,wCAAwC;gBACxC,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,mCAAmC,CAAC,CACnD;gBACD,0BAA0B;gBAC1B,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,qBAAqB,CAAC,CACrC;aACF,CAAC;YACF,2BAA2B;YAC3B,CAAC,CAAC,MAAM,CAAC;gBACP,mBAAmB;gBACnB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,EACzB,CAAC,CAAC,WAAW,CAAC,cAAc,CAAC,CAC9B;gBACD,mCAAmC;gBACnC,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,8BAA8B,CAAC,CAC9C;gBACD,gCAAgC;gBAChC,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,2BAA2B,CAAC,CAC3C;aACF,CAAC;YACF,gCAAgC;YAChC,CAAC,CAAC,MAAM,CAAC;gBACP,mBAAmB;gBACnB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,mBAAmB,CAAC,EAC9B,CAAC,CAAC,WAAW,CAAC,cAAc,CAAC,CAC9B;gBACD,+CAA+C;gBAC/C,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,0CAA0C,CAAC,CAC1D;gBACD,kCAAkC;gBAClC,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,6BAA6B,CAAC,CAC7C;aACF,CAAC;YACF,8BAA8B;YAC9B,CAAC,CAAC,MAAM,CAAC;gBACP,mBAAmB;gBACnB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC,EAC1B,CAAC,CAAC,WAAW,CAAC,cAAc,CAAC,CAC9B;gBACD,qBAAqB;gBACrB,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAChC;gBACD,6CAA6C;gBAC7C,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,wCAAwC,CAAC,CACxD;gBACD,wCAAwC;gBACxC,YAAY,EAAE,CAAC,CAAC,IAAI,CAClB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,mCAAmC,CAAC,CACnD;gBACD,iCAAiC;gBACjC,UAAU,EAAE,CAAC,CAAC,IAAI,CAChB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,4BAA4B,CAAC,CAC5C;gBACD,8CAA8C;gBAC9C,WAAW,EAAE,CAAC,CAAC,IAAI,CACjB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,yCAAyC,CAAC,CACzD;gBACD,8CAA8C;gBAC9C,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,yCAAyC,CAAC,CACzD;gBACD,wDAAwD;gBACxD,eAAe,EAAE,CAAC,CAAC,IAAI,CACrB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,mDAAmD,CAAC,CACnE;aACF,CAAC;YACF,kCAAkC;YAClC,CAAC,CAAC,MAAM,CAAC;gBACP,mBAAmB;gBACnB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,EACrB,CAAC,CAAC,WAAW,CAAC,cAAc,CAAC,CAC9B;gBACD,gCAAgC;gBAChC,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,2BAA2B,CAAC,CAC3C;gBACD,8DAA8D;gBAC9D,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,yDAAyD,CAAC,CACzE;gBACD,sBAAsB;gBACtB,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,iBAAiB,CAAC,CACjC;aACF,CAAC;YACF,6FAA6F;YAC7F,CAAC,CAAC,MAAM,CAAC;gBACP,mBAAmB;gBACnB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,EACjB,CAAC,CAAC,WAAW,CAAC,cAAc,CAAC,CAC9B;gBACD,6BAA6B;gBAC7B,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,wBAAwB,CAAC,CACxC;gBACD,2BAA2B;gBAC3B,WAAW,EAAE,CAAC,CAAC,IAAI,CACjB,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,sBAAsB,CAAC,CACtC;gBACD,kEAAkE;gBAClE,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,6DAA6D,CAAC,CAC7E;gBACD,uEAAuE;gBACvE,cAAc,EAAE,CAAC,CAAC,IAAI,CACpB,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,kEAAkE,CAAC,CAClF;gBACD,wBAAwB;gBACxB,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,mBAAmB,CAAC,CACnC;gBACD,mCAAmC;gBACnC,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,8BAA8B,CAAC,CAC9C;gBACD,6BAA6B;gBAC7B,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,wBAAwB,CAAC,CACxC;gBACD,oBAAoB;gBACpB,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;gBACD,2BAA2B;gBAC3B,cAAc,EAAE,CAAC,CAAC,IAAI,CACpB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,sBAAsB,CAAC,CACtC;gBACD,6BAA6B;gBAC7B,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,wBAAwB,CAAC,CACxC;gBACD,4DAA4D;gBAC5D,QAAQ,EAAE,CAAC,CAAC,IAAI,CACd,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,uDAAuD,CAAC,CACvE;aACF,CAAC;YACF,iCAAiC;YACjC,CAAC,CAAC,MAAM,CAAC;gBACP,mBAAmB;gBACnB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAC7B,CAAC,CAAC,WAAW,CAAC,cAAc,CAAC,CAC9B;gBACD,oBAAoB;gBACpB,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;gBACD,qCAAqC;gBACrC,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,gCAAgC,CAAC,CAChD;aACF,CAAC;YACF,iCAAiC;YACjC,CAAC,CAAC,MAAM,CAAC;gBACP,mBAAmB;gBACnB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAC7B,CAAC,CAAC,WAAW,CAAC,cAAc,CAAC,CAC9B;gBACD,oBAAoB;gBACpB,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;gBACD,qCAAqC;gBACrC,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,gCAAgC,CAAC,CAChD;gBACD,kDAAkD;gBAClD,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,CAAC,CAAC,OAAO,EAAE,EACX,CAAC,CAAC,WAAW,CAAC,6CAA6C,CAAC,CAC7D;aACF,CAAC;SACH,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,iBAAiB,CAAC,CACjC;KACF,CAAC,CACH,EACD,CAAC,CAAC,WAAW,CAAC,4CAA4C,CAAC,CAC5D,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAeL;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,UAAU,2BAA2B,CACzC,MAAkB,EAClB,MAA6C,EAC7C,MAAoB;IAEpB,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,kCAAkC,EAAE;QAC1D,IAAI,EAAE,6BAA6B;QACnC,GAAG,MAAM;KACV,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;AAC3D,CAAC"}

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

@@ -0,0 +1,67 @@
+import * as v from "valibot";
+/**
+ * Request user rate limits.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-user-rate-limits
+ */
+export declare const UserRateLimitRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of request. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"userRateLimit", undefined>, v.DescriptionAction<"userRateLimit", "Type of request.">]>;
+    /** User address. */
+    readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
+}, undefined>, v.DescriptionAction<{
+    type: "userRateLimit";
+    user: `0x${string}`;
+}, "Request user rate limits.">]>;
+export type UserRateLimitRequest = v.InferOutput<typeof UserRateLimitRequest>;
+/**
+ * User rate limits.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-user-rate-limits
+ */
+export declare const UserRateLimitResponse: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Cumulative trading volume. */
+    readonly cumVlm: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToStringAction<string | number, undefined>, v.StringSchema<undefined>, v.TransformAction<string, string>, v.RegexAction<string, undefined>]>, v.DescriptionAction<string, "Cumulative trading volume.">]>;
+    /** Number of API requests used. */
+    readonly nRequestsUsed: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToNumberAction<string | number, undefined>, v.NumberSchema<undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Number of API requests used.">]>;
+    /** Maximum allowed API requests. */
+    readonly nRequestsCap: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToNumberAction<string | number, undefined>, v.NumberSchema<undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Maximum allowed API requests.">]>;
+    /** Number of surplus API requests. */
+    readonly nRequestsSurplus: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.ToNumberAction<string | number, undefined>, v.NumberSchema<undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Number of surplus API requests.">]>;
+}, undefined>, v.DescriptionAction<{
+    cumVlm: string;
+    nRequestsUsed: number;
+    nRequestsCap: number;
+    nRequestsSurplus: number;
+}, "User rate limits.">]>;
+export type UserRateLimitResponse = v.InferOutput<typeof UserRateLimitResponse>;
+import type { InfoConfig } from "./_base/types.js";
+/** Request parameters for the {@linkcode userRateLimit} function. */
+export type UserRateLimitParameters = Omit<v.InferInput<typeof UserRateLimitRequest>, "type">;
+/**
+ * Request user rate limits.
+ *
+ * @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.
+ *
+ * @returns User rate limits.
+ *
+ * @throws {ValiError} 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 { userRateLimit } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ *
+ * const data = await userRateLimit(
+ *   { transport },
+ *   { user: "0x..." },
+ * );
+ * ```
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-user-rate-limits
+ */
+export declare function userRateLimit(config: InfoConfig, params: UserRateLimitParameters, signal?: AbortSignal): Promise<UserRateLimitResponse>;
+//# sourceMappingURL=userRateLimit.d.ts.map

package/esm/src/api/info/_methods/userRateLimit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"userRateLimit.d.ts","sourceRoot":"","sources":["../../../../../src/src/api/info/_methods/userRateLimit.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAQ7B;;;GAGG;AACH,eAAO,MAAM,oBAAoB;IAG3B,uBAAuB;;IAKvB,oBAAoB;;;;;iCAQtB,CAAC;AACL,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAE9E;;;GAGG;AACH,eAAO,MAAM,qBAAqB;IAG5B,iCAAiC;;IAKjC,mCAAmC;;IAKnC,oCAAoC;;IAKpC,sCAAsC;;;;;;;yBAQxC,CAAC;AACL,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAMhF,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEnD,qEAAqE;AACrE,MAAM,MAAM,uBAAuB,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,oBAAoB,CAAC,EAAE,MAAM,CAAC,CAAC;AAE9F;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,aAAa,CAC3B,MAAM,EAAE,UAAU,EAClB,MAAM,EAAE,uBAAuB,EAC/B,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,qBAAqB,CAAC,CAMhC"}

package/esm/src/api/info/_methods/userRateLimit.js

@@ -0,0 +1,68 @@
+import * as v from "valibot";
+// ============================================================
+// API Schemas
+// ============================================================
+import { Address, UnsignedDecimal, UnsignedInteger } from "../../_schemas.js";
+/**
+ * Request user rate limits.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-user-rate-limits
+ */
+export const UserRateLimitRequest = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** Type of request. */
+        type: v.pipe(v.literal("userRateLimit"), v.description("Type of request.")),
+        /** User address. */
+        user: v.pipe(Address, v.description("User address.")),
+    }), v.description("Request user rate limits."));
+})();
+/**
+ * User rate limits.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-user-rate-limits
+ */
+export const UserRateLimitResponse = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** Cumulative trading volume. */
+        cumVlm: v.pipe(UnsignedDecimal, v.description("Cumulative trading volume.")),
+        /** Number of API requests used. */
+        nRequestsUsed: v.pipe(UnsignedInteger, v.description("Number of API requests used.")),
+        /** Maximum allowed API requests. */
+        nRequestsCap: v.pipe(UnsignedInteger, v.description("Maximum allowed API requests.")),
+        /** Number of surplus API requests. */
+        nRequestsSurplus: v.pipe(UnsignedInteger, v.description("Number of surplus API requests.")),
+    }), v.description("User rate limits."));
+})();
+/**
+ * Request user rate limits.
+ *
+ * @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.
+ *
+ * @returns User rate limits.
+ *
+ * @throws {ValiError} 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 { userRateLimit } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ *
+ * const data = await userRateLimit(
+ *   { transport },
+ *   { user: "0x..." },
+ * );
+ * ```
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-user-rate-limits
+ */
+export function userRateLimit(config, params, signal) {
+    const request = v.parse(UserRateLimitRequest, {
+        type: "userRateLimit",
+        ...params,
+    });
+    return config.transport.request("info", request, signal);
+}
+//# sourceMappingURL=userRateLimit.js.map

package/esm/src/api/info/_methods/userRateLimit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"userRateLimit.js","sourceRoot":"","sources":["../../../../../src/src/api/info/_methods/userRateLimit.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAE7B,+DAA+D;AAC/D,cAAc;AACd,+DAA+D;AAE/D,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAE9E;;;GAGG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACxD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,uBAAuB;QACvB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC,EAC1B,CAAC,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAClC;QACD,oBAAoB;QACpB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,2BAA2B,CAAC,CAC3C,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL;;;GAGG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACzD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,iCAAiC;QACjC,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,4BAA4B,CAAC,CAC5C;QACD,mCAAmC;QACnC,aAAa,EAAE,CAAC,CAAC,IAAI,CACnB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,8BAA8B,CAAC,CAC9C;QACD,oCAAoC;QACpC,YAAY,EAAE,CAAC,CAAC,IAAI,CAClB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,+BAA+B,CAAC,CAC/C;QACD,sCAAsC;QACtC,gBAAgB,EAAE,CAAC,CAAC,IAAI,CACtB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,iCAAiC,CAAC,CACjD;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,mBAAmB,CAAC,CACnC,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAYL;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,UAAU,aAAa,CAC3B,MAAkB,EAClB,MAA+B,EAC/B,MAAoB;IAEpB,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,oBAAoB,EAAE;QAC5C,IAAI,EAAE,eAAe;QACrB,GAAG,MAAM;KACV,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;AAC3D,CAAC"}

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

@@ -0,0 +1,88 @@
+import * as v from "valibot";
+/**
+ * Request user role.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-role
+ */
+export declare const UserRoleRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of request. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"userRole", undefined>, v.DescriptionAction<"userRole", "Type of request.">]>;
+    /** User address. */
+    readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
+}, undefined>, v.DescriptionAction<{
+    type: "userRole";
+    user: `0x${string}`;
+}, "Request user role.">]>;
+export type UserRoleRequest = v.InferOutput<typeof UserRoleRequest>;
+/**
+ * User role.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-role
+ */
+export declare const UserRoleResponse: v.SchemaWithPipe<readonly [v.VariantSchema<"role", [v.ObjectSchema<{
+    /** Role identifier. */
+    readonly role: v.SchemaWithPipe<readonly [v.PicklistSchema<["missing", "user", "vault"], undefined>, v.DescriptionAction<"user" | "vault" | "missing", "Role identifier.">]>;
+}, undefined>, v.ObjectSchema<{
+    /** Role identifier. */
+    readonly role: v.SchemaWithPipe<readonly [v.LiteralSchema<"agent", undefined>, v.DescriptionAction<"agent", "Role identifier.">]>;
+    /** Details for agent role. */
+    readonly data: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        /** Master account address associated with the agent. */
+        readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "Master account address associated with the agent.">]>;
+    }, undefined>, v.DescriptionAction<{
+        user: `0x${string}`;
+    }, "Details for agent role.">]>;
+}, undefined>, v.ObjectSchema<{
+    /** Role identifier. */
+    readonly role: v.SchemaWithPipe<readonly [v.LiteralSchema<"subAccount", undefined>, v.DescriptionAction<"subAccount", "Role identifier.">]>;
+    /** Details for sub-account role. */
+    readonly data: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        /** Master account address associated with the sub-account. */
+        readonly master: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "Master account address associated with the sub-account.">]>;
+    }, undefined>, v.DescriptionAction<{
+        master: `0x${string}`;
+    }, "Details for sub-account role.">]>;
+}, undefined>], undefined>, v.DescriptionAction<{
+    role: "user" | "vault" | "missing";
+} | {
+    role: "agent";
+    data: {
+        user: `0x${string}`;
+    };
+} | {
+    role: "subAccount";
+    data: {
+        master: `0x${string}`;
+    };
+}, "User role.">]>;
+export type UserRoleResponse = v.InferOutput<typeof UserRoleResponse>;
+import type { InfoConfig } from "./_base/types.js";
+/** Request parameters for the {@linkcode userRole} function. */
+export type UserRoleParameters = Omit<v.InferInput<typeof UserRoleRequest>, "type">;
+/**
+ * Request user role.
+ *
+ * @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.
+ *
+ * @returns User role.
+ *
+ * @throws {ValiError} 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 { userRole } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ *
+ * const data = await userRole(
+ *   { transport },
+ *   { user: "0x..." },
+ * );
+ * ```
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-role
+ */
+export declare function userRole(config: InfoConfig, params: UserRoleParameters, signal?: AbortSignal): Promise<UserRoleResponse>;
+//# sourceMappingURL=userRole.d.ts.map

package/esm/src/api/info/_methods/userRole.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"userRole.d.ts","sourceRoot":"","sources":["../../../../../src/src/api/info/_methods/userRole.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAQ7B;;;GAGG;AACH,eAAO,MAAM,eAAe;IAGtB,uBAAuB;;IAKvB,oBAAoB;;;;;0BAQtB,CAAC;AACL,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,eAAe,CAAC,CAAC;AAEpE;;;GAGG;AACH,eAAO,MAAM,gBAAgB;IAIrB,uBAAuB;;;IAOvB,uBAAuB;;IAKvB,8BAA8B;;QAG1B,wDAAwD;;;;;;IAU5D,uBAAuB;;IAKvB,oCAAoC;;QAGhC,8DAA8D;;;;;;;;;;;;;;;;;kBAYtE,CAAC;AACL,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAMtE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEnD,gEAAgE;AAChE,MAAM,MAAM,kBAAkB,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,eAAe,CAAC,EAAE,MAAM,CAAC,CAAC;AAEpF;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,QAAQ,CACtB,MAAM,EAAE,UAAU,EAClB,MAAM,EAAE,kBAAkB,EAC1B,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,gBAAgB,CAAC,CAM3B"}

package/esm/src/api/info/_methods/userRole.js

@@ -0,0 +1,82 @@
+import * as v from "valibot";
+// ============================================================
+// API Schemas
+// ============================================================
+import { Address } from "../../_schemas.js";
+/**
+ * Request user role.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-role
+ */
+export const UserRoleRequest = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** Type of request. */
+        type: v.pipe(v.literal("userRole"), v.description("Type of request.")),
+        /** User address. */
+        user: v.pipe(Address, v.description("User address.")),
+    }), v.description("Request user role."));
+})();
+/**
+ * User role.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-role
+ */
+export const UserRoleResponse = /* @__PURE__ */ (() => {
+    return v.pipe(v.variant("role", [
+        v.object({
+            /** Role identifier. */
+            role: v.pipe(v.picklist(["missing", "user", "vault"]), v.description("Role identifier.")),
+        }),
+        v.object({
+            /** Role identifier. */
+            role: v.pipe(v.literal("agent"), v.description("Role identifier.")),
+            /** Details for agent role. */
+            data: v.pipe(v.object({
+                /** Master account address associated with the agent. */
+                user: v.pipe(Address, v.description("Master account address associated with the agent.")),
+            }), v.description("Details for agent role.")),
+        }),
+        v.object({
+            /** Role identifier. */
+            role: v.pipe(v.literal("subAccount"), v.description("Role identifier.")),
+            /** Details for sub-account role. */
+            data: v.pipe(v.object({
+                /** Master account address associated with the sub-account. */
+                master: v.pipe(Address, v.description("Master account address associated with the sub-account.")),
+            }), v.description("Details for sub-account role.")),
+        }),
+    ]), v.description("User role."));
+})();
+/**
+ * Request user role.
+ *
+ * @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.
+ *
+ * @returns User role.
+ *
+ * @throws {ValiError} 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 { userRole } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ *
+ * const data = await userRole(
+ *   { transport },
+ *   { user: "0x..." },
+ * );
+ * ```
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-role
+ */
+export function userRole(config, params, signal) {
+    const request = v.parse(UserRoleRequest, {
+        type: "userRole",
+        ...params,
+    });
+    return config.transport.request("info", request, signal);
+}
+//# sourceMappingURL=userRole.js.map

package/esm/src/api/info/_methods/userRole.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"userRole.js","sourceRoot":"","sources":["../../../../../src/src/api/info/_methods/userRole.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAE7B,+DAA+D;AAC/D,cAAc;AACd,+DAA+D;AAE/D,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAE5C;;;GAGG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACnD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,uBAAuB;QACvB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,EACrB,CAAC,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAClC;QACD,oBAAoB;QACpB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,oBAAoB,CAAC,CACpC,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL;;;GAGG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACpD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE;QAChB,CAAC,CAAC,MAAM,CAAC;YACP,uBAAuB;YACvB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,QAAQ,CAAC,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,EACxC,CAAC,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAClC;SACF,CAAC;QACF,CAAC,CAAC,MAAM,CAAC;YACP,uBAAuB;YACvB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAClB,CAAC,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAClC;YACD,8BAA8B;YAC9B,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,CAAC;gBACP,wDAAwD;gBACxD,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,mDAAmD,CAAC,CACnE;aACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,yBAAyB,CAAC,CACzC;SACF,CAAC;QACF,CAAC,CAAC,MAAM,CAAC;YACP,uBAAuB;YACvB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,EACvB,CAAC,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAClC;YACD,oCAAoC;YACpC,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,CAAC;gBACP,8DAA8D;gBAC9D,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,yDAAyD,CAAC,CACzE;aACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,+BAA+B,CAAC,CAC/C;SACF,CAAC;KACH,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,YAAY,CAAC,CAC5B,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAYL;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,UAAU,QAAQ,CACtB,MAAkB,EAClB,MAA0B,EAC1B,MAAoB;IAEpB,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,eAAe,EAAE;QACvC,IAAI,EAAE,UAAU;QAChB,GAAG,MAAM;KACV,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;AAC3D,CAAC"}