@nktkas/hyperliquid 0.25.0-beta.4 → 0.25.1

package/esm/src/api/info/userFillsByTime.js

@@ -0,0 +1,102 @@
+import * as v from "valibot";
+import { Address, Decimal, Hex, parser, UnsignedDecimal, UnsignedInteger } from "../_common.js";
+// -------------------- Schemas --------------------
+/**
+ * Request array of user fills by time.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-fills-by-time
+ */
+export const UserFillsByTimeRequest = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** Type of request. */
+        type: v.pipe(v.literal("userFillsByTime"), v.description("Type of request.")),
+        /** User address. */
+        user: v.pipe(Address, v.description("User address.")),
+        /** Start time (in ms since epoch). */
+        startTime: v.pipe(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).")),
+        /** If true, partial fills are aggregated when a crossing order fills multiple resting orders. */
+        aggregateByTime: v.pipe(v.optional(v.boolean()), v.description("If true, partial fills are aggregated when a crossing order fills multiple resting orders.")),
+    }), v.description("Request array of user fills by time."));
+})();
+/**
+ * Array of user trade fills by time.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-fills-by-time
+ */
+export const UserFillsByTimeResponse = /* @__PURE__ */ (() => {
+    return v.pipe(v.array(
+    /** Trade fill record. */
+    v.pipe(v.object({
+        /** Asset symbol. */
+        coin: v.pipe(v.string(), v.description("Asset symbol.")),
+        /** Price. */
+        px: v.pipe(UnsignedDecimal, v.description("Price.")),
+        /** Size. */
+        sz: v.pipe(UnsignedDecimal, v.description("Size.")),
+        /** Order side ("B" = Bid/Buy, "A" = Ask/Sell). */
+        side: v.pipe(v.union([v.literal("B"), v.literal("A")]), v.description('Order side ("B" = Bid/Buy, "A" = Ask/Sell).')),
+        /** Timestamp when the trade occurred (in ms since epoch). */
+        time: v.pipe(UnsignedInteger, v.description("Timestamp when the trade occurred (in ms since epoch).")),
+        /** Start position size. */
+        startPosition: v.pipe(Decimal, v.description("Start position size.")),
+        /** Direction indicator for frontend display. */
+        dir: v.pipe(v.string(), v.description("Direction indicator for frontend display.")),
+        /** Realized PnL. */
+        closedPnl: v.pipe(Decimal, v.description("Realized PnL.")),
+        /** L1 transaction hash. */
+        hash: v.pipe(v.pipe(Hex, v.length(66)), v.description("L1 transaction hash.")),
+        /** Order ID. */
+        oid: v.pipe(UnsignedInteger, v.description("Order ID.")),
+        /** Indicates if the fill was a taker order. */
+        crossed: v.pipe(v.boolean(), v.description("Indicates if the fill was a taker order.")),
+        /** Fee charged or rebate received (negative indicates rebate). */
+        fee: v.pipe(Decimal, v.description("Fee charged or rebate received (negative indicates rebate).")),
+        /** Unique transaction identifier for a partial fill of an order. */
+        tid: v.pipe(UnsignedInteger, v.description("Unique transaction identifier for a partial fill of an order.")),
+        /** Client Order ID. */
+        cloid: v.pipe(v.optional(v.pipe(Hex, v.length(34))), v.description("Client Order ID.")),
+        /** Liquidation details. */
+        liquidation: v.pipe(v.optional(v.object({
+            /** Address of the liquidated user. */
+            liquidatedUser: v.pipe(Address, v.description("Address of the liquidated user.")),
+            /** Mark price at the time of liquidation. */
+            markPx: v.pipe(UnsignedDecimal, v.description("Mark price at the time of liquidation.")),
+            /** Liquidation method. */
+            method: v.pipe(v.union([v.literal("market"), v.literal("backstop")]), v.description("Liquidation method.")),
+        })), v.description("Liquidation details.")),
+        /** 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").')),
+        /** ID of the TWAP. */
+        twapId: v.pipe(v.union([UnsignedInteger, v.null()]), v.description("ID of the TWAP.")),
+    }), v.description("Trade fill record."))), v.description("Array of user trade fills by time."));
+})();
+/**
+ * Request array of user fills by time.
+ * @param config - General configuration for Info API requests.
+ * @param params - Parameters specific to the API request.
+ * @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
+ * @returns Array of user trade fills by time.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-fills-by-time
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { userFillsByTime } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await userFillsByTime(
+ *   { transport },
+ *   { user: "0x...", startTime: Date.now() - 1000 * 60 * 60 * 24 },
+ * );
+ * ```
+ */
+export function userFillsByTime(config, params, signal) {
+    const request = parser(UserFillsByTimeRequest)({
+        type: "userFillsByTime",
+        ...params,
+    });
+    return config.transport.request("info", request, signal);
+}
+//# sourceMappingURL=userFillsByTime.js.map

package/esm/src/api/info/userFillsByTime.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"userFillsByTime.js","sourceRoot":"","sources":["../../../../src/src/api/info/userFillsByTime.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAE,OAAO,EAAE,OAAO,EAAsB,GAAG,EAAE,MAAM,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAGpH,oDAAoD;AAEpD;;;GAGG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IAC1D,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,uBAAuB;QACvB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,iBAAiB,CAAC,EAC5B,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,eAAe,EACf,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;QACD,iGAAiG;QACjG,eAAe,EAAE,CAAC,CAAC,IAAI,CACrB,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,EACvB,CAAC,CAAC,WAAW,CAAC,4FAA4F,CAAC,CAC5G;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,sCAAsC,CAAC,CACtD,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL;;;GAGG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IAC3D,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,KAAK;IACL,yBAAyB;IACzB,CAAC,CAAC,IAAI,CACJ,CAAC,CAAC,MAAM,CAAC;QACP,oBAAoB;QACpB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;QACD,aAAa;QACb,EAAE,EAAE,CAAC,CAAC,IAAI,CACR,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,QAAQ,CAAC,CACxB;QACD,YAAY;QACZ,EAAE,EAAE,CAAC,CAAC,IAAI,CACR,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,CACvB;QACD,kDAAkD;QAClD,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EACzC,CAAC,CAAC,WAAW,CAAC,6CAA6C,CAAC,CAC7D;QACD,6DAA6D;QAC7D,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,wDAAwD,CAAC,CACxE;QACD,2BAA2B;QAC3B,aAAa,EAAE,CAAC,CAAC,IAAI,CACnB,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,sBAAsB,CAAC,CACtC;QACD,gDAAgD;QAChD,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,2CAA2C,CAAC,CAC3D;QACD,oBAAoB;QACpB,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;QACD,2BAA2B;QAC3B,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,EACzB,CAAC,CAAC,WAAW,CAAC,sBAAsB,CAAC,CACtC;QACD,gBAAgB;QAChB,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,WAAW,CAAC,CAC3B;QACD,+CAA+C;QAC/C,OAAO,EAAE,CAAC,CAAC,IAAI,CACb,CAAC,CAAC,OAAO,EAAE,EACX,CAAC,CAAC,WAAW,CAAC,0CAA0C,CAAC,CAC1D;QACD,kEAAkE;QAClE,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,6DAA6D,CAAC,CAC7E;QACD,oEAAoE;QACpE,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,+DAA+D,CAAC,CAC/E;QACD,uBAAuB;QACvB,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,EACrC,CAAC,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAClC;QACD,2BAA2B;QAC3B,WAAW,EAAE,CAAC,CAAC,IAAI,CACjB,CAAC,CAAC,QAAQ,CACR,CAAC,CAAC,MAAM,CAAC;YACP,sCAAsC;YACtC,cAAc,EAAE,CAAC,CAAC,IAAI,CACpB,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,iCAAiC,CAAC,CACjD;YACD,6CAA6C;YAC7C,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,wCAAwC,CAAC,CACxD;YACD,0BAA0B;YAC1B,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,EACrD,CAAC,CAAC,WAAW,CAAC,qBAAqB,CAAC,CACrC;SACF,CAAC,CACH,EACD,CAAC,CAAC,WAAW,CAAC,sBAAsB,CAAC,CACtC;QACD,4DAA4D;QAC5D,QAAQ,EAAE,CAAC,CAAC,IAAI,CACd,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,uDAAuD,CAAC,CACvE;QACD,sBAAsB;QACtB,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,CAAC,CAAC,KAAK,CAAC,CAAC,eAAe,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,EACpC,CAAC,CAAC,WAAW,CAAC,iBAAiB,CAAC,CACjC;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,oBAAoB,CAAC,CACpC,CACF,EACD,CAAC,CAAC,WAAW,CAAC,oCAAoC,CAAC,CACpD,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAQL;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,eAAe,CAC7B,MAAyB,EACzB,MAAgD,EAChD,MAAoB;IAEpB,MAAM,OAAO,GAAG,MAAM,CAAC,sBAAsB,CAAC,CAAC;QAC7C,IAAI,EAAE,iBAAiB;QACvB,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/userFunding.d.ts

@@ -0,0 +1,104 @@
+import * as v from "valibot";
+import { type DeepImmutable } from "../_common.js";
+import type { InfoRequestConfig } from "./_common.js";
+/**
+ * Request array of user 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 UserFundingRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of request. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"userFunding", undefined>, v.DescriptionAction<"userFunding", "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.">]>;
+    /** Start time (in ms since epoch). */
+    readonly startTime: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Start time (in ms since epoch).">]>;
+    /** End time (in ms since epoch). */
+    readonly endTime: v.SchemaWithPipe<readonly [v.NullishSchema<v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, undefined>, v.DescriptionAction<number | null | undefined, "End time (in ms since epoch).">]>;
+}, undefined>, v.DescriptionAction<{
+    type: "userFunding";
+    user: `0x${string}`;
+    startTime: number;
+    endTime?: number | null | undefined;
+}, "Request array of user funding ledger updates.">]>;
+export type UserFundingRequest = v.InferOutput<typeof UserFundingRequest>;
+/**
+ * Array of user 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 UserFundingResponse: v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Timestamp of the update (in ms since epoch). */
+    readonly time: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Timestamp of the update (in ms since epoch).">]>;
+    /** L1 transaction hash. */
+    readonly hash: 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}`, 66, undefined>]>, v.DescriptionAction<`0x${string}`, "L1 transaction hash.">]>;
+    /** Update details. */
+    readonly delta: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        /** Update type. */
+        readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"funding", undefined>, v.DescriptionAction<"funding", "Update type.">]>;
+        /** Asset symbol. */
+        readonly coin: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Asset symbol.">]>;
+        /** Amount transferred in USDC. */
+        readonly usdc: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Amount transferred in USDC.">]>;
+        /** Signed position size. */
+        readonly szi: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Signed position size.">]>;
+        /** Applied funding rate. */
+        readonly fundingRate: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Applied funding rate.">]>;
+        /** Number of samples. */
+        readonly nSamples: v.SchemaWithPipe<readonly [v.UnionSchema<[v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.NullSchema<undefined>], undefined>, v.DescriptionAction<number | null, "Number of samples.">]>;
+    }, undefined>, v.DescriptionAction<{
+        type: "funding";
+        coin: string;
+        usdc: string;
+        szi: string;
+        fundingRate: string;
+        nSamples: number | null;
+    }, "Update details.">]>;
+}, undefined>, v.DescriptionAction<{
+    time: number;
+    hash: `0x${string}`;
+    delta: {
+        type: "funding";
+        coin: string;
+        usdc: string;
+        szi: string;
+        fundingRate: string;
+        nSamples: number | null;
+    };
+}, "User funding ledger update.">]>, undefined>, v.DescriptionAction<{
+    time: number;
+    hash: `0x${string}`;
+    delta: {
+        type: "funding";
+        coin: string;
+        usdc: string;
+        szi: string;
+        fundingRate: string;
+        nSamples: number | null;
+    };
+}[], "Array of user funding ledger updates.">]>;
+export type UserFundingResponse = v.InferOutput<typeof UserFundingResponse>;
+/** Request parameters for the {@linkcode userFunding} function. */
+export type UserFundingParameters = Omit<v.InferInput<typeof UserFundingRequest>, "type">;
+/**
+ * Request array of user funding ledger updates.
+ * @param config - General configuration for Info API requests.
+ * @param params - Parameters specific to the API request.
+ * @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
+ * @returns Array of user funding ledger updates.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-a-users-funding-history-or-non-funding-ledger-updates
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { userFunding } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await userFunding(
+ *   { transport },
+ *   { user: "0x...", startTime: Date.now() - 1000 * 60 * 60 * 24 },
+ * );
+ * ```
+ */
+export declare function userFunding(config: InfoRequestConfig, params: DeepImmutable<UserFundingParameters>, signal?: AbortSignal): Promise<UserFundingResponse>;
+//# sourceMappingURL=userFunding.d.ts.map

package/esm/src/api/info/userFunding.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"userFunding.d.ts","sourceRoot":"","sources":["../../../../src/src/api/info/userFunding.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAoB,KAAK,aAAa,EAAgC,MAAM,eAAe,CAAC;AACnG,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAItD;;;GAGG;AACH,eAAO,MAAM,kBAAkB;IAGzB,uBAAuB;;IAKvB,oBAAoB;;IAKpB,sCAAsC;;IAKtC,oCAAoC;;;;;;;qDAQtC,CAAC;AACL,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE1E;;;GAGG;AACH,eAAO,MAAM,mBAAmB;IAMtB,mDAAmD;;IAKnD,2BAA2B;;IAK3B,sBAAsB;;QAGlB,mBAAmB;;QAKnB,oBAAoB;;QAKpB,kCAAkC;;QAKlC,4BAA4B;;QAK5B,4BAA4B;;QAK5B,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;+CAcnC,CAAC;AACL,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAI5E,mEAAmE;AACnE,MAAM,MAAM,qBAAqB,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,kBAAkB,CAAC,EAAE,MAAM,CAAC,CAAC;AAE1F;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,WAAW,CACzB,MAAM,EAAE,iBAAiB,EACzB,MAAM,EAAE,aAAa,CAAC,qBAAqB,CAAC,EAC5C,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,mBAAmB,CAAC,CAM9B"}

package/esm/src/api/info/userFunding.js

@@ -0,0 +1,78 @@
+import * as v from "valibot";
+import { Address, Decimal, Hex, parser, UnsignedInteger } from "../_common.js";
+// -------------------- Schemas --------------------
+/**
+ * Request array of user 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 UserFundingRequest = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** Type of request. */
+        type: v.pipe(v.literal("userFunding"), v.description("Type of request.")),
+        /** User address. */
+        user: v.pipe(Address, v.description("User address.")),
+        /** Start time (in ms since epoch). */
+        startTime: v.pipe(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 array of user funding ledger updates."));
+})();
+/**
+ * Array of user 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 UserFundingResponse = /* @__PURE__ */ (() => {
+    return v.pipe(v.array(
+    /** User funding ledger update. */
+    v.pipe(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(v.pipe(Hex, v.length(66)), v.description("L1 transaction hash.")),
+        /** Update details. */
+        delta: v.pipe(v.object({
+            /** Update type. */
+            type: v.pipe(v.literal("funding"), v.description("Update type.")),
+            /** Asset symbol. */
+            coin: v.pipe(v.string(), v.description("Asset symbol.")),
+            /** Amount transferred in USDC. */
+            usdc: v.pipe(Decimal, v.description("Amount transferred in USDC.")),
+            /** Signed position size. */
+            szi: v.pipe(Decimal, v.description("Signed position size.")),
+            /** Applied funding rate. */
+            fundingRate: v.pipe(Decimal, v.description("Applied funding rate.")),
+            /** Number of samples. */
+            nSamples: v.pipe(v.union([UnsignedInteger, v.null()]), v.description("Number of samples.")),
+        }), v.description("Update details.")),
+    }), v.description("User funding ledger update."))), v.description("Array of user funding ledger updates."));
+})();
+/**
+ * Request array of user funding ledger updates.
+ * @param config - General configuration for Info API requests.
+ * @param params - Parameters specific to the API request.
+ * @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
+ * @returns Array of user funding ledger updates.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-a-users-funding-history-or-non-funding-ledger-updates
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { userFunding } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await userFunding(
+ *   { transport },
+ *   { user: "0x...", startTime: Date.now() - 1000 * 60 * 60 * 24 },
+ * );
+ * ```
+ */
+export function userFunding(config, params, signal) {
+    const request = parser(UserFundingRequest)({
+        type: "userFunding",
+        ...params,
+    });
+    return config.transport.request("info", request, signal);
+}
+//# sourceMappingURL=userFunding.js.map

package/esm/src/api/info/userFunding.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"userFunding.js","sourceRoot":"","sources":["../../../../src/src/api/info/userFunding.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAE,OAAO,EAAE,OAAO,EAAsB,GAAG,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAGnG,oDAAoD;AAEpD;;;GAGG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACtD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,uBAAuB;QACvB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,EACxB,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,eAAe,EACf,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,+CAA+C,CAAC,CAC/D,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL;;;GAGG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACvD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,KAAK;IACL,kCAAkC;IAClC,CAAC,CAAC,IAAI,CACJ,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,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,EACzB,CAAC,CAAC,WAAW,CAAC,sBAAsB,CAAC,CACtC;QACD,sBAAsB;QACtB,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;YACP,mBAAmB;YACnB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,EACpB,CAAC,CAAC,WAAW,CAAC,cAAc,CAAC,CAC9B;YACD,oBAAoB;YACpB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;YACD,kCAAkC;YAClC,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,6BAA6B,CAAC,CAC7C;YACD,4BAA4B;YAC5B,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,uBAAuB,CAAC,CACvC;YACD,4BAA4B;YAC5B,WAAW,EAAE,CAAC,CAAC,IAAI,CACjB,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,uBAAuB,CAAC,CACvC;YACD,yBAAyB;YACzB,QAAQ,EAAE,CAAC,CAAC,IAAI,CACd,CAAC,CAAC,KAAK,CAAC,CAAC,eAAe,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,EACpC,CAAC,CAAC,WAAW,CAAC,oBAAoB,CAAC,CACpC;SACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,iBAAiB,CAAC,CACjC;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,6BAA6B,CAAC,CAC7C,CACF,EACD,CAAC,CAAC,WAAW,CAAC,uCAAuC,CAAC,CACvD,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAQL;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,WAAW,CACzB,MAAyB,EACzB,MAA4C,EAC5C,MAAoB;IAEpB,MAAM,OAAO,GAAG,MAAM,CAAC,kBAAkB,CAAC,CAAC;QACzC,IAAI,EAAE,aAAa;QACnB,GAAG,MAAM;KACV,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;AAC3D,CAAC"}