@nktkas/hyperliquid 0.31.0 → 0.32.0

package/esm/api/info/_methods/userNonFundingLedgerUpdates.d.ts

@@ -0,0 +1,396 @@
+import * as v from "valibot";
+/**
+ * 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 declare const UserNonFundingLedgerUpdatesRequest: v.ObjectSchema<{
+    /** Type of request. */
+    readonly type: v.LiteralSchema<"userNonFundingLedgerUpdates", undefined>;
+    /** User address. */
+    readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>;
+    /** Start time (in ms since epoch). */
+    readonly startTime: v.OptionalSchema<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>]>, undefined>;
+    /** End time (in ms since epoch). */
+    readonly endTime: v.NullishSchema<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>]>, undefined>;
+}, undefined>;
+export type UserNonFundingLedgerUpdatesRequest = v.InferOutput<typeof UserNonFundingLedgerUpdatesRequest>;
+/**
+ * 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 type UserNonFundingLedgerUpdatesResponse = {
+    /** Timestamp of the update (in ms since epoch). */
+    time: number;
+    /**
+     * L1 transaction hash.
+     * @pattern ^0x[a-fA-F0-9]{64}$
+     */
+    hash: `0x${string}`;
+    /** Update details. */
+    delta: {
+        /** Update type. */
+        type: "accountClassTransfer";
+        /**
+         * Amount transferred in USDC.
+         * @pattern ^[0-9]+(\.[0-9]+)?$
+         */
+        usdc: string;
+        /** Indicates if the transfer is to the perpetual account. */
+        toPerp: boolean;
+    } | {
+        /** Update type. */
+        type: "deposit";
+        /**
+         * Amount deposited in USDC.
+         * @pattern ^[0-9]+(\.[0-9]+)?$
+         */
+        usdc: string;
+    } | {
+        /** Update type. */
+        type: "internalTransfer";
+        /**
+         * Amount transferred in USDC.
+         * @pattern ^[0-9]+(\.[0-9]+)?$
+         */
+        usdc: string;
+        /**
+         * Initiator address.
+         * @pattern ^0x[a-fA-F0-9]{40}$
+         */
+        user: `0x${string}`;
+        /**
+         * Destination address.
+         * @pattern ^0x[a-fA-F0-9]{40}$
+         */
+        destination: `0x${string}`;
+        /**
+         * Transfer fee.
+         * @pattern ^[0-9]+(\.[0-9]+)?$
+         */
+        fee: string;
+    } | {
+        /** Update type. */
+        type: "liquidation";
+        /**
+         * Total notional value of liquidated positions.
+         * @pattern ^[0-9]+(\.[0-9]+)?$
+         */
+        liquidatedNtlPos: string;
+        /**
+         * Account value at liquidation time.
+         * @pattern ^[0-9]+(\.[0-9]+)?$
+         */
+        accountValue: string;
+        /** Leverage type for liquidated positions. */
+        leverageType: "Cross" | "Isolated";
+        /** Details of each liquidated position. */
+        liquidatedPositions: {
+            /** Asset symbol of the liquidated position. */
+            coin: string;
+            /**
+             * Signed position size liquidated.
+             * @pattern ^-?[0-9]+(\.[0-9]+)?$
+             */
+            szi: string;
+        }[];
+    } | {
+        /** Update type. */
+        type: "rewardsClaim";
+        /**
+         * Amount of rewards claimed.
+         * @pattern ^[0-9]+(\.[0-9]+)?$
+         */
+        amount: string;
+        /** Token symbol. */
+        token: string;
+    } | {
+        /** Update type. */
+        type: "spotTransfer";
+        /** Token symbol. */
+        token: string;
+        /**
+         * Amount transferred.
+         * @pattern ^[0-9]+(\.[0-9]+)?$
+         */
+        amount: string;
+        /**
+         * Equivalent USDC value.
+         * @pattern ^[0-9]+(\.[0-9]+)?$
+         */
+        usdcValue: string;
+        /**
+         * Initiator address.
+         * @pattern ^0x[a-fA-F0-9]{40}$
+         */
+        user: `0x${string}`;
+        /**
+         * Destination address.
+         * @pattern ^0x[a-fA-F0-9]{40}$
+         */
+        destination: `0x${string}`;
+        /**
+         * Transfer fee.
+         * @pattern ^[0-9]+(\.[0-9]+)?$
+         */
+        fee: string;
+        /**
+         * Fee in native token.
+         * @pattern ^[0-9]+(\.[0-9]+)?$
+         */
+        nativeTokenFee: string;
+        /** Nonce of the transfer. */
+        nonce: number | null;
+        /** Token in which the fee is denominated (e.g., "USDC"). */
+        feeToken: string;
+    } | {
+        /** Update type. */
+        type: "subAccountTransfer";
+        /**
+         * Amount transferred in USDC.
+         * @pattern ^[0-9]+(\.[0-9]+)?$
+         */
+        usdc: string;
+        /**
+         * Initiator address.
+         * @pattern ^0x[a-fA-F0-9]{40}$
+         */
+        user: `0x${string}`;
+        /**
+         * Destination address.
+         * @pattern ^0x[a-fA-F0-9]{40}$
+         */
+        destination: `0x${string}`;
+    } | {
+        /** Update type. */
+        type: "vaultCreate";
+        /**
+         * Address of the created vault.
+         * @pattern ^0x[a-fA-F0-9]{40}$
+         */
+        vault: `0x${string}`;
+        /**
+         * Initial allocated amount in USDC.
+         * @pattern ^[0-9]+(\.[0-9]+)?$
+         */
+        usdc: string;
+        /**
+         * Vault creation fee.
+         * @pattern ^[0-9]+(\.[0-9]+)?$
+         */
+        fee: string;
+    } | {
+        /** Update type. */
+        type: "vaultDeposit";
+        /**
+         * Address of the target vault.
+         * @pattern ^0x[a-fA-F0-9]{40}$
+         */
+        vault: `0x${string}`;
+        /**
+         * Amount deposited in USDC.
+         * @pattern ^[0-9]+(\.[0-9]+)?$
+         */
+        usdc: string;
+    } | {
+        /** Update type. */
+        type: "vaultDistribution";
+        /**
+         * Address of the vault distributing funds.
+         * @pattern ^0x[a-fA-F0-9]{40}$
+         */
+        vault: `0x${string}`;
+        /**
+         * Amount distributed in USDC.
+         * @pattern ^[0-9]+(\.[0-9]+)?$
+         */
+        usdc: string;
+    } | {
+        /** Update type. */
+        type: "vaultWithdraw";
+        /**
+         * Vault address.
+         * @pattern ^0x[a-fA-F0-9]{40}$
+         */
+        vault: `0x${string}`;
+        /**
+         * Address of the user withdrawing funds.
+         * @pattern ^0x[a-fA-F0-9]{40}$
+         */
+        user: `0x${string}`;
+        /**
+         * Withdrawal request amount in USD.
+         * @pattern ^[0-9]+(\.[0-9]+)?$
+         */
+        requestedUsd: string;
+        /**
+         * Withdrawal commission fee.
+         * @pattern ^[0-9]+(\.[0-9]+)?$
+         */
+        commission: string;
+        /**
+         * Closing cost associated with positions.
+         * @pattern ^[0-9]+(\.[0-9]+)?$
+         */
+        closingCost: string;
+        /**
+         * Basis value for withdrawal calculation.
+         * @pattern ^[0-9]+(\.[0-9]+)?$
+         */
+        basis: string;
+        /**
+         * Net withdrawn amount in USD after fees and costs.
+         * @pattern ^[0-9]+(\.[0-9]+)?$
+         */
+        netWithdrawnUsd: string;
+    } | {
+        /** Update type. */
+        type: "withdraw";
+        /**
+         * Amount withdrawn in USDC.
+         * @pattern ^[0-9]+(\.[0-9]+)?$
+         */
+        usdc: string;
+        /** Nonce (timestamp in ms) used to prevent replay attacks. */
+        nonce: number;
+        /**
+         * Withdrawal fee.
+         * @pattern ^[0-9]+(\.[0-9]+)?$
+         */
+        fee: string;
+    } | {
+        /** Update type. */
+        type: "send";
+        /**
+         * Address of the sender.
+         * @pattern ^0x[a-fA-F0-9]{40}$
+         */
+        user: `0x${string}`;
+        /**
+         * Destination address.
+         * @pattern ^0x[a-fA-F0-9]{40}$
+         */
+        destination: `0x${string}`;
+        /** Source DEX ("" for default USDC perp DEX, "spot" for spot). */
+        sourceDex: string;
+        /** Destination DEX ("" for default USDC perp DEX, "spot" for spot). */
+        destinationDex: string;
+        /** Token identifier. */
+        token: string;
+        /**
+         * Amount to send (not in wei).
+         * @pattern ^[0-9]+(\.[0-9]+)?$
+         */
+        amount: string;
+        /**
+         * Equivalent USDC value.
+         * @pattern ^[0-9]+(\.[0-9]+)?$
+         */
+        usdcValue: string;
+        /**
+         * Transfer fee.
+         * @pattern ^[0-9]+(\.[0-9]+)?$
+         */
+        fee: string;
+        /**
+         * Fee in native token.
+         * @pattern ^[0-9]+(\.[0-9]+)?$
+         */
+        nativeTokenFee: string;
+        /** Nonce of the transfer. */
+        nonce: number;
+        /** Token in which the fee is denominated (e.g., "USDC"). */
+        feeToken: string;
+    } | {
+        /** Update type. */
+        type: "deployGasAuction";
+        /** Token symbol. */
+        token: string;
+        /**
+         * Amount in the specified token.
+         * @pattern ^[0-9]+(\.[0-9]+)?$
+         */
+        amount: string;
+    } | {
+        /** Update type. */
+        type: "cStakingTransfer";
+        /** Token symbol. */
+        token: string;
+        /**
+         * Amount in the specified token.
+         * @pattern ^[0-9]+(\.[0-9]+)?$
+         */
+        amount: string;
+        /** `true` for deposit, `false` for withdrawal. */
+        isDeposit: boolean;
+    } | {
+        /** Update type. */
+        type: "borrowLend";
+        /** Token symbol. */
+        token: string;
+        /** Operation type. */
+        operation: "supply" | "withdraw" | "repay" | "borrow";
+        /**
+         * Amount in the specified token.
+         * @pattern ^[0-9]+(\.[0-9]+)?$
+         */
+        amount: string;
+        /**
+         * Interest amount in the specified token.
+         * @pattern ^[0-9]+(\.[0-9]+)?$
+         */
+        interestAmount: string;
+    } | {
+        /** Update type. */
+        type: "spotGenesis";
+        /** Token symbol. */
+        token: string;
+        /**
+         * Amount in the specified token.
+         * @pattern ^-?[0-9]+(\.[0-9]+)?$
+         */
+        amount: string;
+    } | {
+        /** Update type. */
+        type: "activateDexAbstraction";
+        /** Name of the dex. */
+        dex: string;
+        /** Token symbol. */
+        token: string;
+        /**
+         * Amount in the specified token.
+         * @pattern ^[0-9]+(\.[0-9]+)?$
+         */
+        amount: string;
+    };
+}[];
+import type { InfoConfig } from "./_base/types.js";
+/** Request parameters for the {@linkcode userNonFundingLedgerUpdates} function. */
+export type UserNonFundingLedgerUpdatesParameters = Omit<v.InferInput<typeof UserNonFundingLedgerUpdatesRequest>, "type">;
+/**
+ * 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.
+ * @return Array of user's non-funding ledger update.
+ *
+ * @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 { 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 declare function userNonFundingLedgerUpdates(config: InfoConfig, params: UserNonFundingLedgerUpdatesParameters, signal?: AbortSignal): Promise<UserNonFundingLedgerUpdatesResponse>;
+//# sourceMappingURL=userNonFundingLedgerUpdates.d.ts.map

package/esm/api/info/_methods/userNonFundingLedgerUpdates.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"userNonFundingLedgerUpdates.d.ts","sourceRoot":"","sources":["../../../../src/api/info/_methods/userNonFundingLedgerUpdates.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAQ7B;;;GAGG;AACH,eAAO,MAAM,kCAAkC;IAE3C,uBAAuB;;IAEvB,oBAAoB;;IAEpB,sCAAsC;;IAEtC,oCAAoC;;aAGpC,CAAC;AACL,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,kCAAkC,CAAC,CAAC;AAE1G;;;GAGG;AACH,MAAM,MAAM,mCAAmC,GAAG;IAChD,mDAAmD;IACnD,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,IAAI,EAAE,KAAK,MAAM,EAAE,CAAC;IACpB,sBAAsB;IACtB,KAAK,EACD;QACA,mBAAmB;QACnB,IAAI,EAAE,sBAAsB,CAAC;QAC7B;;;WAGG;QACH,IAAI,EAAE,MAAM,CAAC;QACb,6DAA6D;QAC7D,MAAM,EAAE,OAAO,CAAC;KACjB,GACC;QACA,mBAAmB;QACnB,IAAI,EAAE,SAAS,CAAC;QAChB;;;WAGG;QACH,IAAI,EAAE,MAAM,CAAC;KACd,GACC;QACA,mBAAmB;QACnB,IAAI,EAAE,kBAAkB,CAAC;QACzB;;;WAGG;QACH,IAAI,EAAE,MAAM,CAAC;QACb;;;WAGG;QACH,IAAI,EAAE,KAAK,MAAM,EAAE,CAAC;QACpB;;;WAGG;QACH,WAAW,EAAE,KAAK,MAAM,EAAE,CAAC;QAC3B;;;WAGG;QACH,GAAG,EAAE,MAAM,CAAC;KACb,GACC;QACA,mBAAmB;QACnB,IAAI,EAAE,aAAa,CAAC;QACpB;;;WAGG;QACH,gBAAgB,EAAE,MAAM,CAAC;QACzB;;;WAGG;QACH,YAAY,EAAE,MAAM,CAAC;QACrB,8CAA8C;QAC9C,YAAY,EAAE,OAAO,GAAG,UAAU,CAAC;QACnC,2CAA2C;QAC3C,mBAAmB,EAAE;YACnB,+CAA+C;YAC/C,IAAI,EAAE,MAAM,CAAC;YACb;;;eAGG;YACH,GAAG,EAAE,MAAM,CAAC;SACb,EAAE,CAAC;KACL,GACC;QACA,mBAAmB;QACnB,IAAI,EAAE,cAAc,CAAC;QACrB;;;WAGG;QACH,MAAM,EAAE,MAAM,CAAC;QACf,oBAAoB;QACpB,KAAK,EAAE,MAAM,CAAC;KACf,GACC;QACA,mBAAmB;QACnB,IAAI,EAAE,cAAc,CAAC;QACrB,oBAAoB;QACpB,KAAK,EAAE,MAAM,CAAC;QACd;;;WAGG;QACH,MAAM,EAAE,MAAM,CAAC;QACf;;;WAGG;QACH,SAAS,EAAE,MAAM,CAAC;QAClB;;;WAGG;QACH,IAAI,EAAE,KAAK,MAAM,EAAE,CAAC;QACpB;;;WAGG;QACH,WAAW,EAAE,KAAK,MAAM,EAAE,CAAC;QAC3B;;;WAGG;QACH,GAAG,EAAE,MAAM,CAAC;QACZ;;;WAGG;QACH,cAAc,EAAE,MAAM,CAAC;QACvB,6BAA6B;QAC7B,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QACrB,4DAA4D;QAC5D,QAAQ,EAAE,MAAM,CAAC;KAClB,GACC;QACA,mBAAmB;QACnB,IAAI,EAAE,oBAAoB,CAAC;QAC3B;;;WAGG;QACH,IAAI,EAAE,MAAM,CAAC;QACb;;;WAGG;QACH,IAAI,EAAE,KAAK,MAAM,EAAE,CAAC;QACpB;;;WAGG;QACH,WAAW,EAAE,KAAK,MAAM,EAAE,CAAC;KAC5B,GACC;QACA,mBAAmB;QACnB,IAAI,EAAE,aAAa,CAAC;QACpB;;;WAGG;QACH,KAAK,EAAE,KAAK,MAAM,EAAE,CAAC;QACrB;;;WAGG;QACH,IAAI,EAAE,MAAM,CAAC;QACb;;;WAGG;QACH,GAAG,EAAE,MAAM,CAAC;KACb,GACC;QACA,mBAAmB;QACnB,IAAI,EAAE,cAAc,CAAC;QACrB;;;WAGG;QACH,KAAK,EAAE,KAAK,MAAM,EAAE,CAAC;QACrB;;;WAGG;QACH,IAAI,EAAE,MAAM,CAAC;KACd,GACC;QACA,mBAAmB;QACnB,IAAI,EAAE,mBAAmB,CAAC;QAC1B;;;WAGG;QACH,KAAK,EAAE,KAAK,MAAM,EAAE,CAAC;QACrB;;;WAGG;QACH,IAAI,EAAE,MAAM,CAAC;KACd,GACC;QACA,mBAAmB;QACnB,IAAI,EAAE,eAAe,CAAC;QACtB;;;WAGG;QACH,KAAK,EAAE,KAAK,MAAM,EAAE,CAAC;QACrB;;;WAGG;QACH,IAAI,EAAE,KAAK,MAAM,EAAE,CAAC;QACpB;;;WAGG;QACH,YAAY,EAAE,MAAM,CAAC;QACrB;;;WAGG;QACH,UAAU,EAAE,MAAM,CAAC;QACnB;;;WAGG;QACH,WAAW,EAAE,MAAM,CAAC;QACpB;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;QACd;;;WAGG;QACH,eAAe,EAAE,MAAM,CAAC;KACzB,GACC;QACA,mBAAmB;QACnB,IAAI,EAAE,UAAU,CAAC;QACjB;;;WAGG;QACH,IAAI,EAAE,MAAM,CAAC;QACb,8DAA8D;QAC9D,KAAK,EAAE,MAAM,CAAC;QACd;;;WAGG;QACH,GAAG,EAAE,MAAM,CAAC;KACb,GACC;QACA,mBAAmB;QACnB,IAAI,EAAE,MAAM,CAAC;QACb;;;WAGG;QACH,IAAI,EAAE,KAAK,MAAM,EAAE,CAAC;QACpB;;;WAGG;QACH,WAAW,EAAE,KAAK,MAAM,EAAE,CAAC;QAC3B,kEAAkE;QAClE,SAAS,EAAE,MAAM,CAAC;QAClB,uEAAuE;QACvE,cAAc,EAAE,MAAM,CAAC;QACvB,wBAAwB;QACxB,KAAK,EAAE,MAAM,CAAC;QACd;;;WAGG;QACH,MAAM,EAAE,MAAM,CAAC;QACf;;;WAGG;QACH,SAAS,EAAE,MAAM,CAAC;QAClB;;;WAGG;QACH,GAAG,EAAE,MAAM,CAAC;QACZ;;;WAGG;QACH,cAAc,EAAE,MAAM,CAAC;QACvB,6BAA6B;QAC7B,KAAK,EAAE,MAAM,CAAC;QACd,4DAA4D;QAC5D,QAAQ,EAAE,MAAM,CAAC;KAClB,GACC;QACA,mBAAmB;QACnB,IAAI,EAAE,kBAAkB,CAAC;QACzB,oBAAoB;QACpB,KAAK,EAAE,MAAM,CAAC;QACd;;;WAGG;QACH,MAAM,EAAE,MAAM,CAAC;KAChB,GACC;QACA,mBAAmB;QACnB,IAAI,EAAE,kBAAkB,CAAC;QACzB,oBAAoB;QACpB,KAAK,EAAE,MAAM,CAAC;QACd;;;WAGG;QACH,MAAM,EAAE,MAAM,CAAC;QACf,kDAAkD;QAClD,SAAS,EAAE,OAAO,CAAC;KACpB,GACC;QACA,mBAAmB;QACnB,IAAI,EAAE,YAAY,CAAC;QACnB,oBAAoB;QACpB,KAAK,EAAE,MAAM,CAAC;QACd,sBAAsB;QACtB,SAAS,EAAE,QAAQ,GAAG,UAAU,GAAG,OAAO,GAAG,QAAQ,CAAC;QACtD;;;WAGG;QACH,MAAM,EAAE,MAAM,CAAC;QACf;;;WAGG;QACH,cAAc,EAAE,MAAM,CAAC;KACxB,GACC;QACA,mBAAmB;QACnB,IAAI,EAAE,aAAa,CAAC;QACpB,oBAAoB;QACpB,KAAK,EAAE,MAAM,CAAC;QACd;;;WAGG;QACH,MAAM,EAAE,MAAM,CAAC;KAChB,GACC;QACA,mBAAmB;QACnB,IAAI,EAAE,wBAAwB,CAAC;QAC/B,uBAAuB;QACvB,GAAG,EAAE,MAAM,CAAC;QACZ,oBAAoB;QACpB,KAAK,EAAE,MAAM,CAAC;QACd;;;WAGG;QACH,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;CACL,EAAE,CAAC;AAOJ,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEnD,mFAAmF;AACnF,MAAM,MAAM,qCAAqC,GAAG,IAAI,CACtD,CAAC,CAAC,UAAU,CAAC,OAAO,kCAAkC,CAAC,EACvD,MAAM,CACP,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,2BAA2B,CACzC,MAAM,EAAE,UAAU,EAClB,MAAM,EAAE,qCAAqC,EAC7C,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,mCAAmC,CAAC,CAM9C"}

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

@@ -0,0 +1,59 @@
+import * as v from "valibot";
+// ============================================================
+// API Schemas
+// ============================================================
+import { Address, 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.object({
+        /** Type of request. */
+        type: v.literal("userNonFundingLedgerUpdates"),
+        /** User address. */
+        user: Address,
+        /** Start time (in ms since epoch). */
+        startTime: v.optional(UnsignedInteger),
+        /** End time (in ms since epoch). */
+        endTime: v.nullish(UnsignedInteger),
+    });
+})();
+// ============================================================
+// Execution Logic
+// ============================================================
+import { parse } from "../../../_base.js";
+/**
+ * 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.
+ * @return Array of user's non-funding ledger update.
+ *
+ * @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 { 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 = parse(UserNonFundingLedgerUpdatesRequest, {
+        type: "userNonFundingLedgerUpdates",
+        ...params,
+    });
+    return config.transport.request("info", request, signal);
+}
+//# sourceMappingURL=userNonFundingLedgerUpdates.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"userNonFundingLedgerUpdates.js","sourceRoot":"","sources":["../../../../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,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAE7D;;;GAGG;AACH,MAAM,CAAC,MAAM,kCAAkC,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACtE,OAAO,CAAC,CAAC,MAAM,CAAC;QACd,uBAAuB;QACvB,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,6BAA6B,CAAC;QAC9C,oBAAoB;QACpB,IAAI,EAAE,OAAO;QACb,sCAAsC;QACtC,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,eAAe,CAAC;QACtC,oCAAoC;QACpC,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC;KACpC,CAAC,CAAC;AACL,CAAC,CAAC,EAAE,CAAC;AAmXL,+DAA+D;AAC/D,kBAAkB;AAClB,+DAA+D;AAE/D,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAS1C;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,UAAU,2BAA2B,CACzC,MAAkB,EAClB,MAA6C,EAC7C,MAAoB;IAEpB,MAAM,OAAO,GAAG,KAAK,CAAC,kCAAkC,EAAE;QACxD,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/api/info/_methods/userRateLimit.d.ts

@@ -0,0 +1,60 @@
+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.ObjectSchema<{
+    /** Type of request. */
+    readonly type: v.LiteralSchema<"userRateLimit", undefined>;
+    /** User address. */
+    readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>;
+}, undefined>;
+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 type UserRateLimitResponse = {
+    /**
+     * Cumulative trading volume.
+     * @pattern ^[0-9]+(\.[0-9]+)?$
+     */
+    cumVlm: string;
+    /** Number of API requests used. */
+    nRequestsUsed: number;
+    /** Maximum allowed API requests. */
+    nRequestsCap: number;
+    /** Number of surplus API requests. */
+    nRequestsSurplus: number;
+};
+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.
+ * @return User rate limits.
+ *
+ * @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 { 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/api/info/_methods/userRateLimit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"userRateLimit.d.ts","sourceRoot":"","sources":["../../../../src/api/info/_methods/userRateLimit.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAQ7B;;;GAGG;AACH,eAAO,MAAM,oBAAoB;IAE7B,uBAAuB;;IAEvB,oBAAoB;;aAGpB,CAAC;AACL,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAE9E;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IACf,mCAAmC;IACnC,aAAa,EAAE,MAAM,CAAC;IACtB,oCAAoC;IACpC,YAAY,EAAE,MAAM,CAAC;IACrB,sCAAsC;IACtC,gBAAgB,EAAE,MAAM,CAAC;CAC1B,CAAC;AAOF,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;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;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/api/info/_methods/userRateLimit.js

@@ -0,0 +1,55 @@
+import * as v from "valibot";
+// ============================================================
+// API Schemas
+// ============================================================
+import { Address } 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.object({
+        /** Type of request. */
+        type: v.literal("userRateLimit"),
+        /** User address. */
+        user: Address,
+    });
+})();
+// ============================================================
+// Execution Logic
+// ============================================================
+import { parse } from "../../../_base.js";
+/**
+ * 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.
+ * @return User rate limits.
+ *
+ * @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 { 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 = parse(UserRateLimitRequest, {
+        type: "userRateLimit",
+        ...params,
+    });
+    return config.transport.request("info", request, signal);
+}
+//# sourceMappingURL=userRateLimit.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"userRateLimit.js","sourceRoot":"","sources":["../../../../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,MAAM,mBAAmB,CAAC;AAE5C;;;GAGG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACxD,OAAO,CAAC,CAAC,MAAM,CAAC;QACd,uBAAuB;QACvB,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC;QAChC,oBAAoB;QACpB,IAAI,EAAE,OAAO;KACd,CAAC,CAAC;AACL,CAAC,CAAC,EAAE,CAAC;AAqBL,+DAA+D;AAC/D,kBAAkB;AAClB,+DAA+D;AAE/D,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAM1C;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,UAAU,aAAa,CAC3B,MAAkB,EAClB,MAA+B,EAC/B,MAAoB;IAEpB,MAAM,OAAO,GAAG,KAAK,CAAC,oBAAoB,EAAE;QAC1C,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/api/info/_methods/userRole.d.ts

@@ -0,0 +1,73 @@
+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.ObjectSchema<{
+    /** Type of request. */
+    readonly type: v.LiteralSchema<"userRole", undefined>;
+    /** User address. */
+    readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>;
+}, undefined>;
+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 type UserRoleResponse = {
+    /** Role identifier. */
+    role: "missing" | "user" | "vault";
+} | {
+    /** Role identifier. */
+    role: "agent";
+    /** Details for agent role. */
+    data: {
+        /**
+         * Master account address associated with the agent.
+         * @pattern ^0x[a-fA-F0-9]{40}$
+         */
+        user: `0x${string}`;
+    };
+} | {
+    /** Role identifier. */
+    role: "subAccount";
+    /** Details for sub-account role. */
+    data: {
+        /**
+         * Master account address associated with the sub-account.
+         * @pattern ^0x[a-fA-F0-9]{40}$
+         */
+        master: `0x${string}`;
+    };
+};
+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.
+ * @return User role.
+ *
+ * @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 { 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/api/info/_methods/userRole.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"userRole.d.ts","sourceRoot":"","sources":["../../../../src/api/info/_methods/userRole.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAQ7B;;;GAGG;AACH,eAAO,MAAM,eAAe;IAExB,uBAAuB;;IAEvB,oBAAoB;;aAGpB,CAAC;AACL,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,eAAe,CAAC,CAAC;AAEpE;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,uBAAuB;IACvB,IAAI,EAAE,SAAS,GAAG,MAAM,GAAG,OAAO,CAAC;CACpC,GAAG;IACF,uBAAuB;IACvB,IAAI,EAAE,OAAO,CAAC;IACd,8BAA8B;IAC9B,IAAI,EAAE;QACJ;;;WAGG;QACH,IAAI,EAAE,KAAK,MAAM,EAAE,CAAC;KACrB,CAAC;CACH,GAAG;IACF,uBAAuB;IACvB,IAAI,EAAE,YAAY,CAAC;IACnB,oCAAoC;IACpC,IAAI,EAAE;QACJ;;;WAGG;QACH,MAAM,EAAE,KAAK,MAAM,EAAE,CAAC;KACvB,CAAC;CACH,CAAC;AAOF,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;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,QAAQ,CACtB,MAAM,EAAE,UAAU,EAClB,MAAM,EAAE,kBAAkB,EAC1B,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,gBAAgB,CAAC,CAM3B"}