@nktkas/hyperliquid 0.13.0 → 0.13.2

package/esm/src/types/info/assets.d.ts

@@ -0,0 +1,275 @@
+import type { Hex } from "../common.js";
+/** Mapping of coin symbols to mid prices. */
+export interface AllMids {
+    /** Mid prices mapped by coin symbol. */
+    [coin: string]: string;
+}
+/** Context for a perpetual asset. */
+export interface PerpsAssetCtx extends SharedAssetCtx {
+    /** Funding rate. */
+    funding: string;
+    /** Total open interest. */
+    openInterest: string;
+    /** Premium price. */
+    premium: string | null;
+    /** Oracle price. */
+    oraclePx: string;
+    /** Array of impact prices. */
+    impactPxs: string[] | null;
+    /** Daily volume in base currency. */
+    dayBaseVlm: string;
+}
+/** Shared context for assets. */
+export interface SharedAssetCtx {
+    /** Previous day's closing price. */
+    prevDayPx: string;
+    /** Daily notional volume. */
+    dayNtlVlm: string;
+    /** Mark price. */
+    markPx: string;
+    /** Mid price. */
+    midPx: string | null;
+}
+/** Context for a spot asset. */
+export interface SpotAssetCtx extends SharedAssetCtx {
+    /** Circulating supply. */
+    circulatingSupply: string;
+    /** Asset symbol. */
+    coin: string;
+    /** Total supply. */
+    totalSupply: string;
+    /** Daily volume in base currency. */
+    dayBaseVlm: string;
+}
+/** Metadata for perpetual assets. */
+export interface PerpsMeta {
+    /** Trading universes available for perpetual trading. */
+    universe: PerpsUniverse[];
+}
+/** Metadata for spot assets. */
+export interface SpotMeta {
+    /** Trading universes available for spot trading. */
+    universe: SpotUniverse[];
+    /** Tokens available for spot trading. */
+    tokens: SpotToken[];
+}
+/** Trading universe parameters for perpetual assets. */
+export interface PerpsUniverse {
+    /** Minimum decimal places for order sizes. */
+    szDecimals: number;
+    /**
+     * Name of the universe.
+     *
+     * Note: Maximum length 6 characters. No uniqueness constraints.
+     */
+    name: string;
+    /** Maximum allowed leverage. */
+    maxLeverage: number;
+    /** Indicates if only isolated margin trading is allowed. */
+    onlyIsolated?: true;
+    /** Indicates if the universe is delisted. */
+    isDelisted?: true;
+}
+/** Trading universe parameters for spot assets. */
+export interface SpotUniverse {
+    /** Token indices included in this universe. */
+    tokens: number[];
+    /**
+     * Name of the universe.
+     *
+     * Note: Maximum length 6 characters. No uniqueness constraints.
+     */
+    name: string;
+    /** Unique identifier of the universe. */
+    index: number;
+    /** Indicates if the token is the primary representation in the system. */
+    isCanonical: boolean;
+}
+/** Details for a trading token in spot markets. */
+export interface SpotToken {
+    /**
+     * Name of the token.
+     *
+     * Note: Maximum length 6 characters. No uniqueness constraints.
+     */
+    name: string;
+    /** Minimum decimal places for order sizes. */
+    szDecimals: number;
+    /** Number of decimals for the token's smallest unit. */
+    weiDecimals: number;
+    /** Unique identifier for the token. */
+    index: number;
+    /** Token ID. */
+    tokenId: Hex;
+    /** Indicates if the token is the primary representation in the system. */
+    isCanonical: boolean;
+    /** EVM contract details. */
+    evmContract: {
+        /** Contract address. */
+        address: Hex;
+        /** Extra decimals in the token's smallest unit. */
+        evm_extra_wei_decimals: number;
+    } | null;
+    /** Full display name of the token. */
+    fullName: string | null;
+    /** Deployer trading fee share for the token. */
+    deployerTradingFeeShare: string;
+}
+/** Details of a token. */
+export interface TokenDetails {
+    /** Name of the token. */
+    name: string;
+    /** Maximum supply of the token. */
+    maxSupply: string;
+    /** Total supply of the token. */
+    totalSupply: string;
+    /** Circulating supply of the token. */
+    circulatingSupply: string;
+    /** Decimal places for the minimum tradable unit. */
+    szDecimals: number;
+    /** Decimal places for the token's smallest unit. */
+    weiDecimals: number;
+    /** Mid price of the token. */
+    midPx: string;
+    /** Mark price of the token. */
+    markPx: string;
+    /** Previous day's price of the token. */
+    prevDayPx: string;
+    /** Genesis data for the token. */
+    genesis: {
+        /** User balances. */
+        userBalances: [Hex, string][];
+        /** Existing token balances. */
+        existingTokenBalances: [number, string][];
+        /** Blacklisted users. */
+        blacklistUsers: Hex[];
+    } | null;
+    /** Deployer address. */
+    deployer: Hex | null;
+    /** Gas used during token deployment. */
+    deployGas: string | null;
+    /** Deployment time. */
+    deployTime: string | null;
+    /** Seeded USDC amount for the token. */
+    seededUsdc: string;
+    /** Non-circulating user balances of the token. */
+    nonCirculatingUserBalances: [Hex, string][];
+    /** Future emissions amount. */
+    futureEmissions: string;
+}
+/** Metadata and context for perpetual assets. */
+export type PerpsMetaAndAssetCtxs = [
+    /** Metadata for assets. */
+    PerpsMeta,
+    /** Context for each perpetual asset. */
+    PerpsAssetCtx[]
+];
+/** Metadata and context for spot assets. */
+export type SpotMetaAndAssetCtxs = [
+    /** Metadata for assets. */
+    SpotMeta,
+    /** Context for each spot asset. */
+    SpotAssetCtx[]
+];
+/** Candlestick data point. */
+export interface Candle {
+    /** Opening timestamp (ms since epoch). */
+    t: number;
+    /** Closing timestamp (ms since epoch). */
+    T: number;
+    /** Asset symbol. */
+    s: string;
+    /** Candle interval (e.g., "1m", "5m", "1h", etc.). */
+    i: string;
+    /** Opening price. */
+    o: string;
+    /** Closing price. */
+    c: string;
+    /** Highest price. */
+    h: string;
+    /** Lowest price. */
+    l: string;
+    /** Total volume traded in base currency. */
+    v: string;
+    /** Number of trades executed. */
+    n: number;
+}
+/** Historical funding rate record for an asset. */
+export interface FundingHistory {
+    /** Asset symbol. */
+    coin: string;
+    /** Funding rate. */
+    fundingRate: string;
+    /** Premium price. */
+    premium: string;
+    /** Funding record timestamp (ms since epoch). */
+    time: number;
+}
+/**
+ * Predicted funding data.
+ *
+ * The first element is the asset symbol and the second element is an array of predicted funding data for each exchange.
+ */
+export type PredictedFunding = [
+    /** Asset symbol. */
+    string,
+    /** Array of predicted funding data for each exchange. */
+    [
+        /** Exchange symbol. */
+        string,
+        /** Predicted funding data. */
+        {
+            /** Predicted funding rate. */
+            fundingRate: string;
+            /** Next funding time (ms since epoch). */
+            nextFundingTime: number;
+        } | null
+    ][]
+];
+/** Deploy state for spot tokens. */
+export interface SpotDeployState {
+    /** Array of deploy states for tokens. */
+    states: {
+        /** Token ID. */
+        token: number;
+        /** Token specification. */
+        spec: {
+            /** Name of the token. */
+            name: string;
+            /** Minimum decimal places for order sizes. */
+            szDecimals: number;
+            /** Number of decimals for the token's smallest unit. */
+            weiDecimals: number;
+        };
+        /** Full name of the token. */
+        fullName: string | null;
+        /** Deployer trading fee share for the token. */
+        deployerTradingFeeShare: string;
+        /** Spot indices for the token. */
+        spots: number[];
+        /** Maximum supply of the token. */
+        maxSupply: string | null;
+        /** Hyperliquidity genesis balance of the token. */
+        hyperliquidityGenesisBalance: string;
+        /** Total genesis balance (in Wei) for the token. */
+        totalGenesisBalanceWei: string;
+        /** User genesis balances for the token. */
+        userGenesisBalances: [Hex, string][];
+        /** Existing token genesis balances for the token. */
+        existingTokenGenesisBalances: [number, string][];
+    }[];
+    /** Gas auction details. */
+    gasAuction: {
+        /** Current gas. */
+        currentGas: string | null;
+        /** Duration in seconds. */
+        durationSeconds: number;
+        /** Ending gas. */
+        endGas: string | null;
+        /** Starting gas. */
+        startGas: string;
+        /** Auction start time (seconds since epoch). */
+        startTimeSeconds: number;
+    };
+}
+//# sourceMappingURL=assets.d.ts.map

package/esm/src/types/info/assets.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"assets.d.ts","sourceRoot":"","sources":["../../../../src/src/types/info/assets.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,cAAc,CAAC;AAExC,6CAA6C;AAC7C,MAAM,WAAW,OAAO;IACpB,wCAAwC;IACxC,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;CAC1B;AAED,qCAAqC;AACrC,MAAM,WAAW,aAAc,SAAQ,cAAc;IACjD,oBAAoB;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,2BAA2B;IAC3B,YAAY,EAAE,MAAM,CAAC;IACrB,qBAAqB;IACrB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,oBAAoB;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,8BAA8B;IAC9B,SAAS,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAC3B,qCAAqC;IACrC,UAAU,EAAE,MAAM,CAAC;CACtB;AAED,iCAAiC;AACjC,MAAM,WAAW,cAAc;IAC3B,oCAAoC;IACpC,SAAS,EAAE,MAAM,CAAC;IAClB,6BAA6B;IAC7B,SAAS,EAAE,MAAM,CAAC;IAClB,kBAAkB;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,iBAAiB;IACjB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,gCAAgC;AAChC,MAAM,WAAW,YAAa,SAAQ,cAAc;IAChD,0BAA0B;IAC1B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,oBAAoB;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,oBAAoB;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,qCAAqC;IACrC,UAAU,EAAE,MAAM,CAAC;CACtB;AAED,qCAAqC;AACrC,MAAM,WAAW,SAAS;IACtB,yDAAyD;IACzD,QAAQ,EAAE,aAAa,EAAE,CAAC;CAC7B;AAED,gCAAgC;AAChC,MAAM,WAAW,QAAQ;IACrB,oDAAoD;IACpD,QAAQ,EAAE,YAAY,EAAE,CAAC;IACzB,yCAAyC;IACzC,MAAM,EAAE,SAAS,EAAE,CAAC;CACvB;AAED,wDAAwD;AACxD,MAAM,WAAW,aAAa;IAC1B,8CAA8C;IAC9C,UAAU,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,gCAAgC;IAChC,WAAW,EAAE,MAAM,CAAC;IACpB,4DAA4D;IAC5D,YAAY,CAAC,EAAE,IAAI,CAAC;IACpB,6CAA6C;IAC7C,UAAU,CAAC,EAAE,IAAI,CAAC;CACrB;AAED,mDAAmD;AACnD,MAAM,WAAW,YAAY;IACzB,+CAA+C;IAC/C,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,yCAAyC;IACzC,KAAK,EAAE,MAAM,CAAC;IACd,0EAA0E;IAC1E,WAAW,EAAE,OAAO,CAAC;CACxB;AAED,mDAAmD;AACnD,MAAM,WAAW,SAAS;IACtB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,8CAA8C;IAC9C,UAAU,EAAE,MAAM,CAAC;IACnB,wDAAwD;IACxD,WAAW,EAAE,MAAM,CAAC;IACpB,uCAAuC;IACvC,KAAK,EAAE,MAAM,CAAC;IACd,gBAAgB;IAChB,OAAO,EAAE,GAAG,CAAC;IACb,0EAA0E;IAC1E,WAAW,EAAE,OAAO,CAAC;IACrB,4BAA4B;IAC5B,WAAW,EAAE;QACT,wBAAwB;QACxB,OAAO,EAAE,GAAG,CAAC;QACb,mDAAmD;QACnD,sBAAsB,EAAE,MAAM,CAAC;KAClC,GAAG,IAAI,CAAC;IACT,sCAAsC;IACtC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,gDAAgD;IAChD,uBAAuB,EAAE,MAAM,CAAC;CACnC;AAED,0BAA0B;AAC1B,MAAM,WAAW,YAAY;IACzB,yBAAyB;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,mCAAmC;IACnC,SAAS,EAAE,MAAM,CAAC;IAClB,iCAAiC;IACjC,WAAW,EAAE,MAAM,CAAC;IACpB,uCAAuC;IACvC,iBAAiB,EAAE,MAAM,CAAC;IAC1B,oDAAoD;IACpD,UAAU,EAAE,MAAM,CAAC;IACnB,oDAAoD;IACpD,WAAW,EAAE,MAAM,CAAC;IACpB,8BAA8B;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,+BAA+B;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,yCAAyC;IACzC,SAAS,EAAE,MAAM,CAAC;IAClB,kCAAkC;IAClC,OAAO,EAAE;QACL,qBAAqB;QACrB,YAAY,EAAE,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,CAAC;QAC9B,+BAA+B;QAC/B,qBAAqB,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;QAC1C,yBAAyB;QACzB,cAAc,EAAE,GAAG,EAAE,CAAC;KACzB,GAAG,IAAI,CAAC;IACT,wBAAwB;IACxB,QAAQ,EAAE,GAAG,GAAG,IAAI,CAAC;IACrB,wCAAwC;IACxC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,uBAAuB;IACvB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,wCAAwC;IACxC,UAAU,EAAE,MAAM,CAAC;IACnB,kDAAkD;IAClD,0BAA0B,EAAE,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,CAAC;IAC5C,+BAA+B;IAC/B,eAAe,EAAE,MAAM,CAAC;CAC3B;AAED,iDAAiD;AACjD,MAAM,MAAM,qBAAqB,GAAG;IAChC,2BAA2B;IAC3B,SAAS;IACT,wCAAwC;IACxC,aAAa,EAAE;CAClB,CAAC;AAEF,4CAA4C;AAC5C,MAAM,MAAM,oBAAoB,GAAG;IAC/B,2BAA2B;IAC3B,QAAQ;IACR,mCAAmC;IACnC,YAAY,EAAE;CACjB,CAAC;AAEF,8BAA8B;AAC9B,MAAM,WAAW,MAAM;IACnB,0CAA0C;IAC1C,CAAC,EAAE,MAAM,CAAC;IACV,0CAA0C;IAC1C,CAAC,EAAE,MAAM,CAAC;IACV,oBAAoB;IACpB,CAAC,EAAE,MAAM,CAAC;IACV,sDAAsD;IACtD,CAAC,EAAE,MAAM,CAAC;IACV,qBAAqB;IACrB,CAAC,EAAE,MAAM,CAAC;IACV,qBAAqB;IACrB,CAAC,EAAE,MAAM,CAAC;IACV,qBAAqB;IACrB,CAAC,EAAE,MAAM,CAAC;IACV,oBAAoB;IACpB,CAAC,EAAE,MAAM,CAAC;IACV,4CAA4C;IAC5C,CAAC,EAAE,MAAM,CAAC;IACV,iCAAiC;IACjC,CAAC,EAAE,MAAM,CAAC;CACb;AAED,mDAAmD;AACnD,MAAM,WAAW,cAAc;IAC3B,oBAAoB;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,oBAAoB;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,qBAAqB;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,iDAAiD;IACjD,IAAI,EAAE,MAAM,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC3B,oBAAoB;IACpB,MAAM;IACN,yDAAyD;IACzD;QACI,uBAAuB;QACvB,MAAM;QACN,8BAA8B;QAC9B;YACI,8BAA8B;YAC9B,WAAW,EAAE,MAAM,CAAC;YACpB,0CAA0C;YAC1C,eAAe,EAAE,MAAM,CAAC;SAC3B,GAAG,IAAI;KACX,EAAE;CACN,CAAC;AAEF,oCAAoC;AACpC,MAAM,WAAW,eAAe;IAC5B,yCAAyC;IACzC,MAAM,EAAE;QACJ,gBAAgB;QAChB,KAAK,EAAE,MAAM,CAAC;QACd,2BAA2B;QAC3B,IAAI,EAAE;YACF,yBAAyB;YACzB,IAAI,EAAE,MAAM,CAAC;YACb,8CAA8C;YAC9C,UAAU,EAAE,MAAM,CAAC;YACnB,wDAAwD;YACxD,WAAW,EAAE,MAAM,CAAC;SACvB,CAAC;QACF,8BAA8B;QAC9B,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QACxB,gDAAgD;QAChD,uBAAuB,EAAE,MAAM,CAAC;QAChC,kCAAkC;QAClC,KAAK,EAAE,MAAM,EAAE,CAAC;QAChB,mCAAmC;QACnC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QACzB,mDAAmD;QACnD,4BAA4B,EAAE,MAAM,CAAC;QACrC,oDAAoD;QACpD,sBAAsB,EAAE,MAAM,CAAC;QAC/B,2CAA2C;QAC3C,mBAAmB,EAAE,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,CAAC;QACrC,qDAAqD;QACrD,4BAA4B,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;KACpD,EAAE,CAAC;IACJ,2BAA2B;IAC3B,UAAU,EAAE;QACR,mBAAmB;QACnB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAC1B,2BAA2B;QAC3B,eAAe,EAAE,MAAM,CAAC;QACxB,kBAAkB;QAClB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;QACtB,oBAAoB;QACpB,QAAQ,EAAE,MAAM,CAAC;QACjB,gDAAgD;QAChD,gBAAgB,EAAE,MAAM,CAAC;KAC5B,CAAC;CACL"}

package/esm/src/types/info/assets.js

@@ -0,0 +1 @@
+export {};

package/esm/src/types/info/delegations.d.ts

@@ -0,0 +1,117 @@
+import type { Hex } from "../common.js";
+/** User delegation to a validator. */
+export interface Delegation {
+    /** Validator address. */
+    validator: Hex;
+    /** Amount of tokens delegated to the validator. */
+    amount: string;
+    /** Locked until timestamp (in ms since epoch). */
+    lockedUntilTimestamp: number;
+}
+/** Reward received from staking activities. */
+export interface DelegatorReward {
+    /** Timestamp when the reward was received (in ms since epoch). */
+    time: number;
+    /** Source of the reward. */
+    source: "delegation" | "commission";
+    /** Total reward amount. */
+    totalAmount: string;
+}
+/** Record of a staking event by a delegator. */
+export interface DelegatorUpdate {
+    /** Timestamp of the delegation event (in ms since epoch). */
+    time: number;
+    /** Transaction hash of the delegation event. */
+    hash: Hex;
+    /** Details of the update. */
+    delta: DelegatorUpdateDelegate | DelegatorUpdateDeposit | DelegatorUpdateWithdrawal;
+}
+/** Delegation operation in a delegator update. */
+export interface DelegatorUpdateDelegate {
+    /** Delegation operation details. */
+    delegate: {
+        /** Address of the validator receiving or losing delegation. */
+        validator: Hex;
+        /** Amount of tokens being delegated or undelegated. */
+        amount: string;
+        /** Whether this is an undelegation operation. */
+        isUndelegate: boolean;
+    };
+}
+/** Deposit operation in a delegator update. */
+export interface DelegatorUpdateDeposit {
+    /** Deposit details. */
+    cDeposit: {
+        /** Amount of tokens being deposited. */
+        amount: string;
+    };
+}
+/** Withdrawal operation in a delegator update. */
+export interface DelegatorUpdateWithdrawal {
+    /** Withdrawal details. */
+    withdrawal: {
+        /** Amount of tokens being withdrawn. */
+        amount: string;
+        /** Phase of the withdrawal process. */
+        phase: "initiated" | "finalized";
+    };
+}
+/** Summary of a user's staking. */
+export interface DelegatorSummary {
+    /** Total amount of delegated tokens. */
+    delegated: string;
+    /** Total amount of undelegated tokens. */
+    undelegated: string;
+    /** Total amount of tokens pending withdrawal. */
+    totalPendingWithdrawal: string;
+    /** Number of pending withdrawals. */
+    nPendingWithdrawals: number;
+}
+/** Summary of a validator's status and performance. */
+export interface ValidatorSummary {
+    /** Address of the validator. */
+    validator: Hex;
+    /** Address of the validator's signer. */
+    signer: Hex;
+    /** Name of the validator. */
+    name: string;
+    /** Description of the validator. */
+    description: string;
+    /** Number of blocks produced recently. */
+    nRecentBlocks: number;
+    /** Total amount of tokens staked. */
+    stake: number;
+    /** Whether the validator is currently jailed. */
+    isJailed: boolean;
+    /** Timestamp when the validator can be unjailed (in ms since epoch). */
+    unjailableAfter: number | null;
+    /** Whether the validator is currently active. */
+    isActive: boolean;
+    /** Commission rate charged by the validator. */
+    commission: string;
+    /** Performance statistics over different time periods. */
+    stats: [
+        [
+            "day",
+            ValidatorStats
+        ],
+        [
+            "week",
+            ValidatorStats
+        ],
+        [
+            "month",
+            ValidatorStats
+        ]
+    ];
+}
+/** Statistics for validator performance over a time period. */
+export interface ValidatorStats {
+    /** Fraction of time the validator was online. */
+    uptimeFraction: string;
+    /** Predicted annual percentage rate of returns. */
+    predictedApr: string;
+    /** Number of samples used for statistics calculation. */
+    nSamples: number;
+}
+//# sourceMappingURL=delegations.d.ts.map

package/esm/src/types/info/delegations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"delegations.d.ts","sourceRoot":"","sources":["../../../../src/src/types/info/delegations.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,cAAc,CAAC;AAExC,sCAAsC;AACtC,MAAM,WAAW,UAAU;IACvB,yBAAyB;IACzB,SAAS,EAAE,GAAG,CAAC;IACf,mDAAmD;IACnD,MAAM,EAAE,MAAM,CAAC;IACf,kDAAkD;IAClD,oBAAoB,EAAE,MAAM,CAAC;CAChC;AAED,+CAA+C;AAC/C,MAAM,WAAW,eAAe;IAC5B,kEAAkE;IAClE,IAAI,EAAE,MAAM,CAAC;IACb,4BAA4B;IAC5B,MAAM,EAAE,YAAY,GAAG,YAAY,CAAC;IACpC,2BAA2B;IAC3B,WAAW,EAAE,MAAM,CAAC;CACvB;AAED,gDAAgD;AAChD,MAAM,WAAW,eAAe;IAC5B,6DAA6D;IAC7D,IAAI,EAAE,MAAM,CAAC;IACb,gDAAgD;IAChD,IAAI,EAAE,GAAG,CAAC;IACV,6BAA6B;IAC7B,KAAK,EAAE,uBAAuB,GAAG,sBAAsB,GAAG,yBAAyB,CAAC;CACvF;AAED,kDAAkD;AAClD,MAAM,WAAW,uBAAuB;IACpC,oCAAoC;IACpC,QAAQ,EAAE;QACN,+DAA+D;QAC/D,SAAS,EAAE,GAAG,CAAC;QACf,uDAAuD;QACvD,MAAM,EAAE,MAAM,CAAC;QACf,iDAAiD;QACjD,YAAY,EAAE,OAAO,CAAC;KACzB,CAAC;CACL;AAED,+CAA+C;AAC/C,MAAM,WAAW,sBAAsB;IACnC,uBAAuB;IACvB,QAAQ,EAAE;QACN,wCAAwC;QACxC,MAAM,EAAE,MAAM,CAAC;KAClB,CAAC;CACL;AAED,kDAAkD;AAClD,MAAM,WAAW,yBAAyB;IACtC,0BAA0B;IAC1B,UAAU,EAAE;QACR,wCAAwC;QACxC,MAAM,EAAE,MAAM,CAAC;QACf,uCAAuC;QACvC,KAAK,EAAE,WAAW,GAAG,WAAW,CAAC;KACpC,CAAC;CACL;AAED,mCAAmC;AACnC,MAAM,WAAW,gBAAgB;IAC7B,wCAAwC;IACxC,SAAS,EAAE,MAAM,CAAC;IAClB,0CAA0C;IAC1C,WAAW,EAAE,MAAM,CAAC;IACpB,iDAAiD;IACjD,sBAAsB,EAAE,MAAM,CAAC;IAC/B,qCAAqC;IACrC,mBAAmB,EAAE,MAAM,CAAC;CAC/B;AAED,uDAAuD;AACvD,MAAM,WAAW,gBAAgB;IAC7B,gCAAgC;IAChC,SAAS,EAAE,GAAG,CAAC;IACf,yCAAyC;IACzC,MAAM,EAAE,GAAG,CAAC;IACZ,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,oCAAoC;IACpC,WAAW,EAAE,MAAM,CAAC;IACpB,0CAA0C;IAC1C,aAAa,EAAE,MAAM,CAAC;IACtB,qCAAqC;IACrC,KAAK,EAAE,MAAM,CAAC;IACd,iDAAiD;IACjD,QAAQ,EAAE,OAAO,CAAC;IAClB,wEAAwE;IACxE,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,iDAAiD;IACjD,QAAQ,EAAE,OAAO,CAAC;IAClB,gDAAgD;IAChD,UAAU,EAAE,MAAM,CAAC;IACnB,0DAA0D;IAC1D,KAAK,EAAE;QACH;YAAC,KAAK;YAAE,cAAc;SAAC;QACvB;YAAC,MAAM;YAAE,cAAc;SAAC;QACxB;YAAC,OAAO;YAAE,cAAc;SAAC;KAC5B,CAAC;CACL;AAED,+DAA+D;AAC/D,MAAM,WAAW,cAAc;IAC3B,iDAAiD;IACjD,cAAc,EAAE,MAAM,CAAC;IACvB,mDAAmD;IACnD,YAAY,EAAE,MAAM,CAAC;IACrB,yDAAyD;IACzD,QAAQ,EAAE,MAAM,CAAC;CACpB"}

package/esm/src/types/info/delegations.js

@@ -0,0 +1 @@
+export {};

package/esm/src/types/info/orders.d.ts

@@ -0,0 +1,209 @@
+import type { Hex } from "../common.js";
+/**
+ * Order types for market execution.
+ * - Market: Executes immediately at the market price.
+ * - Limit: Executes at the specified limit price or better.
+ * - Stop Market: Activates as a market order when a stop price is reached.
+ * - Stop Limit: Activates as a limit order when a stop price is reached.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/trading/order-types
+ */
+export type OrderType = "Market" | "Limit" | "Stop Market" | "Stop Limit";
+/**
+ * Time-in-force options.
+ * - Gtc: Remains active until filled or canceled.
+ * - Ioc: Fills immediately or cancels any unfilled portion.
+ * - Alo: Adds liquidity only.
+ * - FrontendMarket: Similar to Ioc, used in Hyperliquid UI.
+ * - LiquidationMarket: Similar to Ioc, used in Hyperliquid UI.
+ */
+export type TIF = "Gtc" | "Ioc" | "Alo" | "FrontendMarket" | "LiquidationMarket";
+/**
+ * TWAP order status.
+ * - finished: Fully executed.
+ * - activated: Active and executing.
+ * - terminated: Terminated.
+ * - error: An error occurred.
+ */
+export type TwapStatus = {
+    /** Status of the TWAP order. */
+    status: "finished" | "activated" | "terminated";
+} | {
+    /** Status of the TWAP order. */
+    status: "error";
+    /** Error message. */
+    description: string;
+};
+/**
+ * Order processing status.
+ * - filled: Order fully executed.
+ * - open: Order active and waiting to be filled.
+ * - canceled: Order canceled by the user.
+ * - triggered: Order triggered and awaiting execution.
+ * - rejected: Order rejected by the system.
+ * - marginCanceled: Order canceled due to insufficient margin.
+ */
+export type OrderProcessingStatus = "filled" | "open" | "canceled" | "triggered" | "rejected" | "marginCanceled";
+/** L2 order book snapshot. */
+export interface Book {
+    /** Asset symbol. */
+    coin: string;
+    /** Timestamp of the snapshot (in ms since epoch). */
+    time: number;
+    /** Bid and ask levels (index 0 = bids, index 1 = asks). */
+    levels: [BookLevel[], BookLevel[]];
+}
+/** Order book level. */
+export interface BookLevel {
+    /** Price. */
+    px: string;
+    /** Total size. */
+    sz: string;
+    /** Number of individual orders. */
+    n: number;
+}
+/** Trade fill record. */
+export interface Fill {
+    /** Asset symbol. */
+    coin: string;
+    /** Price. */
+    px: string;
+    /** Size. */
+    sz: string;
+    /** Order side ("B" = Bid/Buy, "A" = Ask/Sell). */
+    side: "B" | "A";
+    /** Timestamp when the trade occurred (in ms since epoch). */
+    time: number;
+    /** Start position size. */
+    startPosition: string;
+    /** Direction indicator for frontend display. */
+    dir: string;
+    /** Realized PnL. */
+    closedPnl: string;
+    /** L1 transaction hash. */
+    hash: Hex;
+    /** Order ID. */
+    oid: number;
+    /** Indicates if the fill was a taker order. */
+    crossed: boolean;
+    /** Fee charged or rebate received (negative indicates rebate). */
+    fee: string;
+    /** Unique transaction identifier for a partial fill of an order. */
+    tid: number;
+    /** Client Order ID. */
+    cloid?: Hex;
+    /** Liquidation details. */
+    liquidation?: FillLiquidation;
+    /** Token in which the fee is denominated (e.g., "USDC"). */
+    feeToken: string;
+}
+/** Liquidation details for a trade fill. */
+export interface FillLiquidation {
+    /** Address of the liquidated user. */
+    liquidatedUser: Hex;
+    /** Mark price at the time of liquidation. */
+    markPx: string;
+    /** Liquidation method. */
+    method: "market" | "backstop";
+}
+/** Frontend order with additional display information. */
+export interface FrontendOrder extends Omit<Order, "reduceOnly" | "cloid"> {
+    /** Condition for triggering the order. */
+    triggerCondition: string;
+    /** Indicates if the order is a trigger order. */
+    isTrigger: boolean;
+    /** Trigger price. */
+    triggerPx: string;
+    /** Child orders associated with this order. */
+    children: FrontendOrder[];
+    /** Indicates if the order is a position TP/SL order. */
+    isPositionTpsl: boolean;
+    /** Indicates whether the order is reduce-only. */
+    reduceOnly: boolean;
+    /** Order type. */
+    orderType: OrderType;
+    /** Time-in-force option. */
+    tif: TIF | null;
+    /** Client Order ID. */
+    cloid: Hex | null;
+}
+/** Open order details. */
+export interface Order {
+    /** Asset symbol. */
+    coin: string;
+    /** Order side ("B" = Bid/Buy, "A" = Ask/Sell). */
+    side: "B" | "A";
+    /** Limit price. */
+    limitPx: string;
+    /** Size. */
+    sz: string;
+    /** Order ID. */
+    oid: number;
+    /** Timestamp when the order was placed (in ms since epoch). */
+    timestamp: number;
+    /** Original size at order placement. */
+    origSz: string;
+    /** Client Order ID. */
+    cloid?: Hex;
+    /** Indicates if the order is reduce-only. */
+    reduceOnly?: true;
+}
+/** Order status with additional frontend information and current state. */
+export interface OrderStatus<O extends Order | FrontendOrder> {
+    /** Order details. */
+    order: O;
+    /** Order processing status. */
+    status: OrderProcessingStatus;
+    /** Timestamp when the status was last updated (in ms since epoch). */
+    statusTimestamp: number;
+}
+/** Result of an order status lookup. */
+export type OrderLookup = {
+    /** Indicates that the order was found. */
+    status: "order";
+    /** Order details. */
+    order: OrderStatus<FrontendOrder>;
+} | {
+    /** Indicates that the order was not found. */
+    status: "unknownOid";
+};
+/** TWAP history record for a user. */
+export interface TwapHistory {
+    /** Creation time of the history record (in seconds since epoch). */
+    time: number;
+    /** State of the TWAP order. */
+    state: TwapState;
+    /** Current status of the TWAP order. */
+    status: TwapStatus;
+}
+/** TWAP slice fill details. */
+export interface TwapSliceFill {
+    /** Fill details for the TWAP slice. */
+    fill: Omit<Fill, "cloid" | "liquidation">;
+    /** ID of the TWAP. */
+    twapId: number;
+}
+/** Current state of a TWAP order. */
+export interface TwapState {
+    /** Asset symbol. */
+    coin: string;
+    /** Executed notional value. */
+    executedNtl: string;
+    /** Executed size. */
+    executedSz: string;
+    /** Duration in minutes. */
+    minutes: number;
+    /** Indicates if the TWAP randomizes execution. */
+    randomize: boolean;
+    /** Indicates if the order is reduce-only. */
+    reduceOnly: boolean;
+    /** Order side ("B" = Bid/Buy, "A" = Ask/Sell). */
+    side: "B" | "A";
+    /** Order size. */
+    sz: string;
+    /** Start time of the TWAP order (in ms since epoch). */
+    timestamp: number;
+    /** User address. */
+    user: Hex;
+}
+//# sourceMappingURL=orders.d.ts.map

package/esm/src/types/info/orders.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"orders.d.ts","sourceRoot":"","sources":["../../../../src/src/types/info/orders.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,cAAc,CAAC;AAExC;;;;;;;;GAQG;AACH,MAAM,MAAM,SAAS,GAAG,QAAQ,GAAG,OAAO,GAAG,aAAa,GAAG,YAAY,CAAC;AAE1E;;;;;;;GAOG;AACH,MAAM,MAAM,GAAG,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,gBAAgB,GAAG,mBAAmB,CAAC;AAEjF;;;;;;GAMG;AACH,MAAM,MAAM,UAAU,GAChB;IACE,gCAAgC;IAChC,MAAM,EAAE,UAAU,GAAG,WAAW,GAAG,YAAY,CAAC;CACnD,GACC;IACE,gCAAgC;IAChC,MAAM,EAAE,OAAO,CAAC;IAChB,qBAAqB;IACrB,WAAW,EAAE,MAAM,CAAC;CACvB,CAAC;AAEN;;;;;;;;GAQG;AACH,MAAM,MAAM,qBAAqB,GAC3B,QAAQ,GACR,MAAM,GACN,UAAU,GACV,WAAW,GACX,UAAU,GACV,gBAAgB,CAAC;AAEvB,8BAA8B;AAC9B,MAAM,WAAW,IAAI;IACjB,oBAAoB;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,qDAAqD;IACrD,IAAI,EAAE,MAAM,CAAC;IACb,2DAA2D;IAC3D,MAAM,EAAE,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;CACtC;AAED,wBAAwB;AACxB,MAAM,WAAW,SAAS;IACtB,aAAa;IACb,EAAE,EAAE,MAAM,CAAC;IACX,kBAAkB;IAClB,EAAE,EAAE,MAAM,CAAC;IACX,mCAAmC;IACnC,CAAC,EAAE,MAAM,CAAC;CACb;AAED,yBAAyB;AACzB,MAAM,WAAW,IAAI;IACjB,oBAAoB;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,aAAa;IACb,EAAE,EAAE,MAAM,CAAC;IACX,YAAY;IACZ,EAAE,EAAE,MAAM,CAAC;IACX,kDAAkD;IAClD,IAAI,EAAE,GAAG,GAAG,GAAG,CAAC;IAChB,6DAA6D;IAC7D,IAAI,EAAE,MAAM,CAAC;IACb,2BAA2B;IAC3B,aAAa,EAAE,MAAM,CAAC;IACtB,gDAAgD;IAChD,GAAG,EAAE,MAAM,CAAC;IACZ,oBAAoB;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,2BAA2B;IAC3B,IAAI,EAAE,GAAG,CAAC;IACV,gBAAgB;IAChB,GAAG,EAAE,MAAM,CAAC;IACZ,+CAA+C;IAC/C,OAAO,EAAE,OAAO,CAAC;IACjB,kEAAkE;IAClE,GAAG,EAAE,MAAM,CAAC;IACZ,oEAAoE;IACpE,GAAG,EAAE,MAAM,CAAC;IACZ,uBAAuB;IACvB,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ,2BAA2B;IAC3B,WAAW,CAAC,EAAE,eAAe,CAAC;IAC9B,4DAA4D;IAC5D,QAAQ,EAAE,MAAM,CAAC;CACpB;AAED,4CAA4C;AAC5C,MAAM,WAAW,eAAe;IAC5B,sCAAsC;IACtC,cAAc,EAAE,GAAG,CAAC;IACpB,6CAA6C;IAC7C,MAAM,EAAE,MAAM,CAAC;IACf,0BAA0B;IAC1B,MAAM,EAAE,QAAQ,GAAG,UAAU,CAAC;CACjC;AAED,0DAA0D;AAC1D,MAAM,WAAW,aAAc,SAAQ,IAAI,CAAC,KAAK,EAAE,YAAY,GAAG,OAAO,CAAC;IACtE,0CAA0C;IAC1C,gBAAgB,EAAE,MAAM,CAAC;IACzB,iDAAiD;IACjD,SAAS,EAAE,OAAO,CAAC;IACnB,qBAAqB;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,+CAA+C;IAC/C,QAAQ,EAAE,aAAa,EAAE,CAAC;IAC1B,wDAAwD;IACxD,cAAc,EAAE,OAAO,CAAC;IACxB,kDAAkD;IAClD,UAAU,EAAE,OAAO,CAAC;IACpB,kBAAkB;IAClB,SAAS,EAAE,SAAS,CAAC;IACrB,4BAA4B;IAC5B,GAAG,EAAE,GAAG,GAAG,IAAI,CAAC;IAChB,uBAAuB;IACvB,KAAK,EAAE,GAAG,GAAG,IAAI,CAAC;CACrB;AAED,0BAA0B;AAC1B,MAAM,WAAW,KAAK;IAClB,oBAAoB;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,kDAAkD;IAClD,IAAI,EAAE,GAAG,GAAG,GAAG,CAAC;IAChB,mBAAmB;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY;IACZ,EAAE,EAAE,MAAM,CAAC;IACX,gBAAgB;IAChB,GAAG,EAAE,MAAM,CAAC;IACZ,+DAA+D;IAC/D,SAAS,EAAE,MAAM,CAAC;IAClB,wCAAwC;IACxC,MAAM,EAAE,MAAM,CAAC;IACf,uBAAuB;IACvB,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ,6CAA6C;IAC7C,UAAU,CAAC,EAAE,IAAI,CAAC;CACrB;AAED,2EAA2E;AAC3E,MAAM,WAAW,WAAW,CAAC,CAAC,SAAS,KAAK,GAAG,aAAa;IACxD,qBAAqB;IACrB,KAAK,EAAE,CAAC,CAAC;IACT,+BAA+B;IAC/B,MAAM,EAAE,qBAAqB,CAAC;IAC9B,sEAAsE;IACtE,eAAe,EAAE,MAAM,CAAC;CAC3B;AAED,wCAAwC;AACxC,MAAM,MAAM,WAAW,GACjB;IACE,0CAA0C;IAC1C,MAAM,EAAE,OAAO,CAAC;IAChB,qBAAqB;IACrB,KAAK,EAAE,WAAW,CAAC,aAAa,CAAC,CAAC;CACrC,GACC;IACE,8CAA8C;IAC9C,MAAM,EAAE,YAAY,CAAC;CACxB,CAAC;AAEN,sCAAsC;AACtC,MAAM,WAAW,WAAW;IACxB,oEAAoE;IACpE,IAAI,EAAE,MAAM,CAAC;IACb,+BAA+B;IAC/B,KAAK,EAAE,SAAS,CAAC;IACjB,wCAAwC;IACxC,MAAM,EAAE,UAAU,CAAC;CACtB;AAED,+BAA+B;AAC/B,MAAM,WAAW,aAAa;IAC1B,uCAAuC;IACvC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,OAAO,GAAG,aAAa,CAAC,CAAC;IAC1C,sBAAsB;IACtB,MAAM,EAAE,MAAM,CAAC;CAClB;AAED,qCAAqC;AACrC,MAAM,WAAW,SAAS;IACtB,oBAAoB;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,+BAA+B;IAC/B,WAAW,EAAE,MAAM,CAAC;IACpB,qBAAqB;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,2BAA2B;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,kDAAkD;IAClD,SAAS,EAAE,OAAO,CAAC;IACnB,6CAA6C;IAC7C,UAAU,EAAE,OAAO,CAAC;IACpB,kDAAkD;IAClD,IAAI,EAAE,GAAG,GAAG,GAAG,CAAC;IAChB,kBAAkB;IAClB,EAAE,EAAE,MAAM,CAAC;IACX,wDAAwD;IACxD,SAAS,EAAE,MAAM,CAAC;IAClB,oBAAoB;IACpB,IAAI,EAAE,GAAG,CAAC;CACb"}

package/esm/src/types/info/orders.js

@@ -0,0 +1 @@
+export {};