@nktkas/hyperliquid 0.13.1 → 0.13.2

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

@@ -1,10 +1,10 @@
 import type { Hex } from "../common.js";
-/** Mid coin prices. */
+/** Mapping of coin symbols to mid prices. */
 export interface AllMids {
-    /** Maps coin symbols to mid prices. */
+    /** Mid prices mapped by coin symbol. */
     [coin: string]: string;
 }
-/** Context information for a perpetual asset. */
+/** Context for a perpetual asset. */
 export interface PerpsAssetCtx extends SharedAssetCtx {
     /** Funding rate. */
     funding: string;
@@ -14,23 +14,23 @@ export interface PerpsAssetCtx extends SharedAssetCtx {
     premium: string | null;
     /** Oracle price. */
     oraclePx: string;
-    /** Impact prices. */
+    /** Array of impact prices. */
     impactPxs: string[] | null;
     /** Daily volume in base currency. */
     dayBaseVlm: string;
 }
-/** Base asset context information. */
+/** Shared context for assets. */
 export interface SharedAssetCtx {
     /** Previous day's closing price. */
     prevDayPx: string;
-    /** Daily volume. */
+    /** Daily notional volume. */
     dayNtlVlm: string;
     /** Mark price. */
     markPx: string;
-    /** Index price. */
+    /** Mid price. */
     midPx: string | null;
 }
-/** Context information for a spot asset. */
+/** Context for a spot asset. */
 export interface SpotAssetCtx extends SharedAssetCtx {
     /** Circulating supply. */
     circulatingSupply: string;
@@ -43,139 +43,139 @@ export interface SpotAssetCtx extends SharedAssetCtx {
 }
 /** Metadata for perpetual assets. */
 export interface PerpsMeta {
-    /** Universes available for trading. */
+    /** Trading universes available for perpetual trading. */
     universe: PerpsUniverse[];
 }
 /** Metadata for spot assets. */
 export interface SpotMeta {
-    /** Universes available for trading. */
+    /** Trading universes available for spot trading. */
     universe: SpotUniverse[];
-    /** Tokens available for trading. */
+    /** Tokens available for spot trading. */
     tokens: SpotToken[];
 }
-/** Trading universe with specific parameters for perpetual. */
+/** Trading universe parameters for perpetual assets. */
 export interface PerpsUniverse {
     /** Minimum decimal places for order sizes. */
     szDecimals: number;
     /**
      * Name of the universe.
      *
-     * Note: Max length: 6 characters. No uniqueness constraints.
+     * Note: Maximum length 6 characters. No uniqueness constraints.
      */
     name: string;
     /** Maximum allowed leverage. */
     maxLeverage: number;
-    /** Whether only isolated margin trading is allowed. */
+    /** Indicates if only isolated margin trading is allowed. */
     onlyIsolated?: true;
-    /** Whether the universe is delisted. */
+    /** Indicates if the universe is delisted. */
     isDelisted?: true;
 }
-/** Trading universe with specific parameters for spot. */
+/** Trading universe parameters for spot assets. */
 export interface SpotUniverse {
     /** Token indices included in this universe. */
     tokens: number[];
     /**
      * Name of the universe.
      *
-     * Note: Max length: 6 characters. No uniqueness constraints.
+     * Note: Maximum length 6 characters. No uniqueness constraints.
      */
     name: string;
-    /** Unique identifier. */
+    /** Unique identifier of the universe. */
     index: number;
-    /** Whether this token is the primary representation in the system. */
+    /** Indicates if the token is the primary representation in the system. */
     isCanonical: boolean;
 }
-/** Trading token for spot. */
+/** Details for a trading token in spot markets. */
 export interface SpotToken {
     /**
      * Name of the token.
      *
-     * Note: Max length: 6 characters. No uniqueness constraints.
+     * Note: Maximum length 6 characters. No uniqueness constraints.
      */
     name: string;
     /** Minimum decimal places for order sizes. */
     szDecimals: number;
-    /** Number of decimals in the token's smallest unit. */
+    /** Number of decimals for the token's smallest unit. */
     weiDecimals: number;
     /** Unique identifier for the token. */
     index: number;
     /** Token ID. */
     tokenId: Hex;
-    /** Whether this token is the primary representation in the system. */
+    /** Indicates if the token is the primary representation in the system. */
     isCanonical: boolean;
-    /**  EVM contract details. */
+    /** EVM contract details. */
     evmContract: {
-        /** Address of the contract. */
+        /** 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;
-    /** Fee share for the deployer of the token. */
+    /** Deployer trading fee share for the token. */
     deployerTradingFeeShare: string;
 }
-/** The details of a token. */
+/** Details of a token. */
 export interface TokenDetails {
-    /** The name of the token. */
+    /** Name of the token. */
     name: string;
-    /** The maximum supply of the token. */
+    /** Maximum supply of the token. */
     maxSupply: string;
-    /** The total supply of the token. */
+    /** Total supply of the token. */
     totalSupply: string;
-    /** The number of tokens in circulation (total supply minus burned tokens). */
+    /** Circulating supply of the token. */
     circulatingSupply: string;
-    /** The number of decimal places for minimum tradable unit (lot size) */
+    /** Decimal places for the minimum tradable unit. */
     szDecimals: number;
-    /** The number of decimal places for minimum token unit (wei size) */
+    /** Decimal places for the token's smallest unit. */
     weiDecimals: number;
-    /** The mid price of the token. */
+    /** Mid price of the token. */
     midPx: string;
-    /** The mark price of the token. */
+    /** Mark price of the token. */
     markPx: string;
-    /** The previous day's price of the token. */
+    /** Previous day's price of the token. */
     prevDayPx: string;
-    /** The genesis data of the token. */
+    /** Genesis data for the token. */
     genesis: {
-        /** The user balances. */
+        /** User balances. */
         userBalances: [Hex, string][];
-        /** The existing token balances. */
+        /** Existing token balances. */
         existingTokenBalances: [number, string][];
-        /** The blacklisted users. */
+        /** Blacklisted users. */
         blacklistUsers: Hex[];
     } | null;
-    /** The deployer of the token. */
+    /** Deployer address. */
     deployer: Hex | null;
-    /** The gas used to deploy the token. */
+    /** Gas used during token deployment. */
     deployGas: string | null;
-    /** The time at which the token was deployed. */
+    /** Deployment time. */
     deployTime: string | null;
-    /** The seeded USDC of the token. */
+    /** Seeded USDC amount for the token. */
     seededUsdc: string;
-    /** The non-circulating user balances of the token. */
+    /** Non-circulating user balances of the token. */
     nonCirculatingUserBalances: [Hex, string][];
-    /** The future emissions of the token. */
+    /** Future emissions amount. */
     futureEmissions: string;
 }
-/** Metadata and context information for each perpetual asset. */
+/** Metadata and context for perpetual assets. */
 export type PerpsMetaAndAssetCtxs = [
     /** Metadata for assets. */
     PerpsMeta,
-    /** Context information for each asset. */
+    /** Context for each perpetual asset. */
     PerpsAssetCtx[]
 ];
-/** Metadata and context information for each spot asset. */
+/** Metadata and context for spot assets. */
 export type SpotMetaAndAssetCtxs = [
     /** Metadata for assets. */
     SpotMeta,
-    /** Context information for each asset. */
+    /** Context for each spot asset. */
     SpotAssetCtx[]
 ];
 /** Candlestick data point. */
 export interface Candle {
-    /** Opening timestamp (in ms since epoch). */
+    /** Opening timestamp (ms since epoch). */
     t: number;
-    /** Closing timestamp (in ms since epoch). */
+    /** Closing timestamp (ms since epoch). */
     T: number;
     /** Asset symbol. */
     s: string;
@@ -189,12 +189,12 @@ export interface Candle {
     h: string;
     /** Lowest price. */
     l: string;
-    /** Total volume traded (in base currency). */
+    /** Total volume traded in base currency. */
     v: string;
     /** Number of trades executed. */
     n: number;
 }
-/** Historical funding rate data for an asset. */
+/** Historical funding rate record for an asset. */
 export interface FundingHistory {
     /** Asset symbol. */
     coin: string;
@@ -202,14 +202,18 @@ export interface FundingHistory {
     fundingRate: string;
     /** Premium price. */
     premium: string;
-    /** Timestamp of the funding record (in ms since epoch). */
+    /** Funding record timestamp (ms since epoch). */
     time: number;
 }
-/** Predicted funding data for an asset. */
+/**
+ * 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,
-    /** Predicted funding data for each exchange. */
+    /** Array of predicted funding data for each exchange. */
     [
         /** Exchange symbol. */
         string,
@@ -217,54 +221,54 @@ export type PredictedFunding = [
         {
             /** Predicted funding rate. */
             fundingRate: string;
-            /** Next funding time (in ms since epoch). */
+            /** Next funding time (ms since epoch). */
             nextFundingTime: number;
         } | null
     ][]
 ];
-/** The deploy state of a user. */
+/** Deploy state for spot tokens. */
 export interface SpotDeployState {
-    /** The deploy state of a user. */
+    /** Array of deploy states for tokens. */
     states: {
-        /** The token ID. */
+        /** Token ID. */
         token: number;
-        /** The spec of the token. */
+        /** Token specification. */
         spec: {
-            /** The name of the token. */
+            /** Name of the token. */
             name: string;
-            /** The number of decimal places for minimum tradable unit (lot size) */
+            /** Minimum decimal places for order sizes. */
             szDecimals: number;
-            /** The number of decimal places for minimum token unit (wei size) */
+            /** Number of decimals for the token's smallest unit. */
             weiDecimals: number;
         };
-        /** The full name of the token. */
+        /** Full name of the token. */
         fullName: string | null;
-        /** The deployer trading fee share of the token. */
+        /** Deployer trading fee share for the token. */
         deployerTradingFeeShare: string;
-        /** The spots of the token. */
+        /** Spot indices for the token. */
         spots: number[];
-        /** The max supply of the token. */
+        /** Maximum supply of the token. */
         maxSupply: string | null;
-        /** The hyperliquidity genesis balance of the token. */
+        /** Hyperliquidity genesis balance of the token. */
         hyperliquidityGenesisBalance: string;
-        /** The total genesis balance of the token. */
+        /** Total genesis balance (in Wei) for the token. */
         totalGenesisBalanceWei: string;
-        /** The user genesis balances of the token. */
+        /** User genesis balances for the token. */
         userGenesisBalances: [Hex, string][];
-        /** The existing token genesis balances of the token. */
+        /** Existing token genesis balances for the token. */
         existingTokenGenesisBalances: [number, string][];
     }[];
-    /** The gas auction details. */
+    /** Gas auction details. */
     gasAuction: {
         /** Current gas. */
         currentGas: string | null;
-        /** Duration (in seconds). */
+        /** Duration in seconds. */
         durationSeconds: number;
-        /** End gas. */
+        /** Ending gas. */
         endGas: string | null;
-        /** Start gas. */
+        /** Starting gas. */
         startGas: string;
-        /** Start time (in seconds since epoch). */
+        /** Auction start time (seconds since epoch). */
         startTimeSeconds: number;
     };
 }

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

@@ -1 +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,uBAAuB;AACvB,MAAM,WAAW,OAAO;IACpB,uCAAuC;IACvC,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;CAC1B;AAED,iDAAiD;AACjD,MAAM,WAAW,aAAc,SAAQ,cAAc;IACjD,oBAAoB;IACpB,OAAO,EAAE,MAAM,CAAC;IAEhB,2BAA2B;IAC3B,YAAY,EAAE,MAAM,CAAC;IAErB,qBAAqB;IACrB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB,oBAAoB;IACpB,QAAQ,EAAE,MAAM,CAAC;IAEjB,qBAAqB;IACrB,SAAS,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAE3B,qCAAqC;IACrC,UAAU,EAAE,MAAM,CAAC;CACtB;AAED,sCAAsC;AACtC,MAAM,WAAW,cAAc;IAC3B,oCAAoC;IACpC,SAAS,EAAE,MAAM,CAAC;IAElB,oBAAoB;IACpB,SAAS,EAAE,MAAM,CAAC;IAElB,kBAAkB;IAClB,MAAM,EAAE,MAAM,CAAC;IAEf,mBAAmB;IACnB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,4CAA4C;AAC5C,MAAM,WAAW,YAAa,SAAQ,cAAc;IAChD,0BAA0B;IAC1B,iBAAiB,EAAE,MAAM,CAAC;IAE1B,oBAAoB;IACpB,IAAI,EAAE,MAAM,CAAC;IAEb,oBAAoB;IACpB,WAAW,EAAE,MAAM,CAAC;IAEpB,qCAAqC;IACrC,UAAU,EAAE,MAAM,CAAC;CACtB;AAED,qCAAqC;AACrC,MAAM,WAAW,SAAS;IACtB,uCAAuC;IACvC,QAAQ,EAAE,aAAa,EAAE,CAAC;CAC7B;AAED,gCAAgC;AAChC,MAAM,WAAW,QAAQ;IACrB,uCAAuC;IACvC,QAAQ,EAAE,YAAY,EAAE,CAAC;IAEzB,oCAAoC;IACpC,MAAM,EAAE,SAAS,EAAE,CAAC;CACvB;AAED,+DAA+D;AAC/D,MAAM,WAAW,aAAa;IAC1B,8CAA8C;IAC9C,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb,gCAAgC;IAChC,WAAW,EAAE,MAAM,CAAC;IAEpB,uDAAuD;IACvD,YAAY,CAAC,EAAE,IAAI,CAAC;IAEpB,wCAAwC;IACxC,UAAU,CAAC,EAAE,IAAI,CAAC;CACrB;AAED,0DAA0D;AAC1D,MAAM,WAAW,YAAY;IACzB,+CAA+C;IAC/C,MAAM,EAAE,MAAM,EAAE,CAAC;IAEjB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb,yBAAyB;IACzB,KAAK,EAAE,MAAM,CAAC;IAEd,sEAAsE;IACtE,WAAW,EAAE,OAAO,CAAC;CACxB;AAED,8BAA8B;AAC9B,MAAM,WAAW,SAAS;IACtB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb,8CAA8C;IAC9C,UAAU,EAAE,MAAM,CAAC;IAEnB,uDAAuD;IACvD,WAAW,EAAE,MAAM,CAAC;IAEpB,uCAAuC;IACvC,KAAK,EAAE,MAAM,CAAC;IAEd,gBAAgB;IAChB,OAAO,EAAE,GAAG,CAAC;IAEb,sEAAsE;IACtE,WAAW,EAAE,OAAO,CAAC;IAErB,6BAA6B;IAC7B,WAAW,EAAE;QACT,+BAA+B;QAC/B,OAAO,EAAE,GAAG,CAAC;QAEb,mDAAmD;QACnD,sBAAsB,EAAE,MAAM,CAAC;KAClC,GAAG,IAAI,CAAC;IAET,sCAAsC;IACtC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB,+CAA+C;IAC/C,uBAAuB,EAAE,MAAM,CAAC;CACnC;AAED,8BAA8B;AAC9B,MAAM,WAAW,YAAY;IACzB,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAC;IAEb,uCAAuC;IACvC,SAAS,EAAE,MAAM,CAAC;IAElB,qCAAqC;IACrC,WAAW,EAAE,MAAM,CAAC;IAEpB,8EAA8E;IAC9E,iBAAiB,EAAE,MAAM,CAAC;IAE1B,wEAAwE;IACxE,UAAU,EAAE,MAAM,CAAC;IAEnB,qEAAqE;IACrE,WAAW,EAAE,MAAM,CAAC;IAEpB,kCAAkC;IAClC,KAAK,EAAE,MAAM,CAAC;IAEd,mCAAmC;IACnC,MAAM,EAAE,MAAM,CAAC;IAEf,6CAA6C;IAC7C,SAAS,EAAE,MAAM,CAAC;IAElB,qCAAqC;IACrC,OAAO,EAAE;QACL,yBAAyB;QACzB,YAAY,EAAE,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,CAAC;QAE9B,mCAAmC;QACnC,qBAAqB,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;QAE1C,6BAA6B;QAC7B,cAAc,EAAE,GAAG,EAAE,CAAC;KACzB,GAAG,IAAI,CAAC;IAET,iCAAiC;IACjC,QAAQ,EAAE,GAAG,GAAG,IAAI,CAAC;IAErB,wCAAwC;IACxC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,gDAAgD;IAChD,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,oCAAoC;IACpC,UAAU,EAAE,MAAM,CAAC;IAEnB,sDAAsD;IACtD,0BAA0B,EAAE,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,CAAC;IAE5C,yCAAyC;IACzC,eAAe,EAAE,MAAM,CAAC;CAC3B;AAED,iEAAiE;AACjE,MAAM,MAAM,qBAAqB,GAAG;IAChC,2BAA2B;IAC3B,SAAS;IAET,0CAA0C;IAC1C,aAAa,EAAE;CAClB,CAAC;AAEF,4DAA4D;AAC5D,MAAM,MAAM,oBAAoB,GAAG;IAC/B,2BAA2B;IAC3B,QAAQ;IAER,0CAA0C;IAC1C,YAAY,EAAE;CACjB,CAAC;AAEF,8BAA8B;AAC9B,MAAM,WAAW,MAAM;IACnB,6CAA6C;IAC7C,CAAC,EAAE,MAAM,CAAC;IAEV,6CAA6C;IAC7C,CAAC,EAAE,MAAM,CAAC;IAEV,oBAAoB;IACpB,CAAC,EAAE,MAAM,CAAC;IAEV,sDAAsD;IACtD,CAAC,EAAE,MAAM,CAAC;IAEV,qBAAqB;IACrB,CAAC,EAAE,MAAM,CAAC;IAEV,qBAAqB;IACrB,CAAC,EAAE,MAAM,CAAC;IAEV,qBAAqB;IACrB,CAAC,EAAE,MAAM,CAAC;IAEV,oBAAoB;IACpB,CAAC,EAAE,MAAM,CAAC;IAEV,8CAA8C;IAC9C,CAAC,EAAE,MAAM,CAAC;IAEV,iCAAiC;IACjC,CAAC,EAAE,MAAM,CAAC;CACb;AAED,iDAAiD;AACjD,MAAM,WAAW,cAAc;IAC3B,oBAAoB;IACpB,IAAI,EAAE,MAAM,CAAC;IAEb,oBAAoB;IACpB,WAAW,EAAE,MAAM,CAAC;IAEpB,qBAAqB;IACrB,OAAO,EAAE,MAAM,CAAC;IAEhB,2DAA2D;IAC3D,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,2CAA2C;AAC3C,MAAM,MAAM,gBAAgB,GAAG;IAC3B,oBAAoB;IACpB,MAAM;IAEN,gDAAgD;IAChD;QACI,uBAAuB;QACvB,MAAM;QAEN,8BAA8B;QAC9B;YACI,8BAA8B;YAC9B,WAAW,EAAE,MAAM,CAAC;YAEpB,6CAA6C;YAC7C,eAAe,EAAE,MAAM,CAAC;SAC3B,GAAG,IAAI;KACX,EAAE;CACN,CAAC;AAEF,kCAAkC;AAClC,MAAM,WAAW,eAAe;IAC5B,kCAAkC;IAClC,MAAM,EAAE;QACJ,oBAAoB;QACpB,KAAK,EAAE,MAAM,CAAC;QAEd,6BAA6B;QAC7B,IAAI,EAAE;YACF,6BAA6B;YAC7B,IAAI,EAAE,MAAM,CAAC;YAEb,wEAAwE;YACxE,UAAU,EAAE,MAAM,CAAC;YAEnB,qEAAqE;YACrE,WAAW,EAAE,MAAM,CAAC;SACvB,CAAC;QAEF,kCAAkC;QAClC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB,mDAAmD;QACnD,uBAAuB,EAAE,MAAM,CAAC;QAEhC,8BAA8B;QAC9B,KAAK,EAAE,MAAM,EAAE,CAAC;QAEhB,mCAAmC;QACnC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,uDAAuD;QACvD,4BAA4B,EAAE,MAAM,CAAC;QAErC,8CAA8C;QAC9C,sBAAsB,EAAE,MAAM,CAAC;QAE/B,8CAA8C;QAC9C,mBAAmB,EAAE,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,CAAC;QAErC,wDAAwD;QACxD,4BAA4B,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;KACpD,EAAE,CAAC;IAEJ,+BAA+B;IAC/B,UAAU,EAAE;QACR,mBAAmB;QACnB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B,6BAA6B;QAC7B,eAAe,EAAE,MAAM,CAAC;QAExB,eAAe;QACf,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB,iBAAiB;QACjB,QAAQ,EAAE,MAAM,CAAC;QAEjB,2CAA2C;QAC3C,gBAAgB,EAAE,MAAM,CAAC;KAC5B,CAAC;CACL"}
+{"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/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 {};