@avalabs/hypercore-module 0.0.0-feat-add-hyperliquid-modules-20260714192934

package/dist/index.d.ts

@@ -0,0 +1,640 @@
+import * as _metamask_rpc_errors from '@metamask/rpc-errors';
+import * as _avalabs_vm_module_types from '@avalabs/vm-module-types';
+import { Module, ConstructorParams, Network, Manifest, GetBalancesParams, GetTransactionHistory, NetworkFeeParam, NetworkFees, GetAddressParams, GetAddressResponse, BuildDerivationPathParams, DeriveAddressParams, DeriveAddressesParams, RpcRequest, HypercoreSpotToken, Transaction } from '@avalabs/vm-module-types';
+export { HypercoreSpotToken } from '@avalabs/vm-module-types';
+import { z } from 'zod';
+import Big from 'big.js';
+
+declare class HypercoreModule implements Module {
+    #private;
+    constructor({ environment, approvalController, runtime }: ConstructorParams);
+    getProvider(_network: Network): Promise<never>;
+    getManifest(): Manifest | undefined;
+    getBalances(params: GetBalancesParams): Promise<_avalabs_vm_module_types.GetBalancesResponse>;
+    getTransactionHistory(params: GetTransactionHistory): Promise<_avalabs_vm_module_types.TransactionHistoryResponse>;
+    getNetworkFee(_network: NetworkFeeParam): Promise<NetworkFees>;
+    getAddress(params: GetAddressParams): Promise<GetAddressResponse>;
+    buildDerivationPath(params: BuildDerivationPathParams): Pick<Partial<Record<_avalabs_vm_module_types.NetworkVMType, string>>, _avalabs_vm_module_types.NetworkVMType.HYPERCORE>;
+    deriveAddress(params: DeriveAddressParams): Promise<Partial<Record<_avalabs_vm_module_types.NetworkVMType, string>>>;
+    deriveAddresses(params: DeriveAddressesParams): Promise<_avalabs_vm_module_types.DeriveAddressesResponse>;
+    getTokens(network: Network): Promise<_avalabs_vm_module_types.HypercoreSpotToken[]>;
+    onRpcRequest(request: RpcRequest, _network: Network): Promise<{
+        error: _metamask_rpc_errors.JsonRpcError<_metamask_rpc_errors.OptionalDataWithOptionalCause>;
+    }>;
+}
+
+/** CAIP-2 id for HyperCore mainnet. Namespace must be 3–8 chars (CAIP-2). */
+declare const HYPERCORE_CAIP_ID = "hlcore:mainnet";
+/**
+ * Synthetic numeric id used by Core network lists / storage keys.
+ * Not an EVM chain id — module routing uses {@link HYPERCORE_CAIP_ID}.
+ */
+declare const HYPERCORE_CHAIN_ID = 9999;
+declare const HYPERCORE_USDC_SYMBOL = "USDC";
+declare const HYPERCORE_USDC_NAME = "USD Coin";
+declare const HYPERCORE_USDC_DECIMALS = 8;
+
+/** `type: "spotMeta"` — registry mapping spot token index → display metadata. */
+declare const spotMetaResponseSchema: z.ZodObject<{
+    tokens: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        index: z.ZodNumber;
+        weiDecimals: z.ZodNumber;
+        fullName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        evmContract: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            address: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            address: string;
+        }, {
+            address: string;
+        }>>>;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        index: number;
+        weiDecimals: number;
+        fullName?: string | null | undefined;
+        evmContract?: {
+            address: string;
+        } | null | undefined;
+    }, {
+        name: string;
+        index: number;
+        weiDecimals: number;
+        fullName?: string | null | undefined;
+        evmContract?: {
+            address: string;
+        } | null | undefined;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    tokens: {
+        name: string;
+        index: number;
+        weiDecimals: number;
+        fullName?: string | null | undefined;
+        evmContract?: {
+            address: string;
+        } | null | undefined;
+    }[];
+}, {
+    tokens: {
+        name: string;
+        index: number;
+        weiDecimals: number;
+        fullName?: string | null | undefined;
+        evmContract?: {
+            address: string;
+        } | null | undefined;
+    }[];
+}>;
+/** `type: "spotClearinghouseState"` */
+declare const spotClearinghouseStateSchema: z.ZodObject<{
+    balances: z.ZodArray<z.ZodObject<{
+        coin: z.ZodString;
+        token: z.ZodNumber;
+        total: z.ZodString;
+        hold: z.ZodString;
+        entryNtl: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        coin: string;
+        token: number;
+        total: string;
+        hold: string;
+        entryNtl?: string | undefined;
+    }, {
+        coin: string;
+        token: number;
+        total: string;
+        hold: string;
+        entryNtl?: string | undefined;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    balances: {
+        coin: string;
+        token: number;
+        total: string;
+        hold: string;
+        entryNtl?: string | undefined;
+    }[];
+}, {
+    balances: {
+        coin: string;
+        token: number;
+        total: string;
+        hold: string;
+        entryNtl?: string | undefined;
+    }[];
+}>;
+/**
+ * `type: "clearinghouseState"` — only fields needed for PnL-excluded
+ * perp collateral fold-in.
+ */
+declare const clearinghouseStateSchema: z.ZodObject<{
+    assetPositions: z.ZodArray<z.ZodObject<{
+        position: z.ZodObject<{
+            unrealizedPnl: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            unrealizedPnl: string;
+        }, {
+            unrealizedPnl: string;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        position: {
+            unrealizedPnl: string;
+        };
+    }, {
+        position: {
+            unrealizedPnl: string;
+        };
+    }>, "many">;
+    crossMarginSummary: z.ZodObject<{
+        accountValue: z.ZodString;
+        totalMarginUsed: z.ZodOptional<z.ZodString>;
+        totalNtlPos: z.ZodOptional<z.ZodString>;
+        totalRawUsd: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        accountValue: string;
+        totalMarginUsed?: string | undefined;
+        totalNtlPos?: string | undefined;
+        totalRawUsd?: string | undefined;
+    }, {
+        accountValue: string;
+        totalMarginUsed?: string | undefined;
+        totalNtlPos?: string | undefined;
+        totalRawUsd?: string | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    assetPositions: {
+        position: {
+            unrealizedPnl: string;
+        };
+    }[];
+    crossMarginSummary: {
+        accountValue: string;
+        totalMarginUsed?: string | undefined;
+        totalNtlPos?: string | undefined;
+        totalRawUsd?: string | undefined;
+    };
+}, {
+    assetPositions: {
+        position: {
+            unrealizedPnl: string;
+        };
+    }[];
+    crossMarginSummary: {
+        accountValue: string;
+        totalMarginUsed?: string | undefined;
+        totalNtlPos?: string | undefined;
+        totalRawUsd?: string | undefined;
+    };
+}>;
+type UserAbstractionMode = 'unifiedAccount' | 'portfolioMargin' | 'dexAbstraction' | 'disabled' | 'default';
+/**
+ * `type: "userAbstraction"` — bare JSON string. Unknown future values coerce
+ * to `"default"` so balance math stays conservative.
+ */
+declare const userAbstractionSchema: z.ZodEffects<z.ZodString, "unifiedAccount" | "portfolioMargin" | "dexAbstraction" | "disabled" | "default", string>;
+/** `type: "userFills"` */
+declare const userFillSchema: z.ZodObject<{
+    closedPnl: z.ZodString;
+    coin: z.ZodString;
+    crossed: z.ZodBoolean;
+    dir: z.ZodString;
+    hash: z.ZodString;
+    oid: z.ZodNumber;
+    px: z.ZodString;
+    side: z.ZodString;
+    startPosition: z.ZodString;
+    sz: z.ZodString;
+    time: z.ZodNumber;
+    fee: z.ZodOptional<z.ZodString>;
+    tid: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    coin: string;
+    closedPnl: string;
+    crossed: boolean;
+    dir: string;
+    hash: string;
+    oid: number;
+    px: string;
+    side: string;
+    startPosition: string;
+    sz: string;
+    time: number;
+    fee?: string | undefined;
+    tid?: number | undefined;
+}, {
+    coin: string;
+    closedPnl: string;
+    crossed: boolean;
+    dir: string;
+    hash: string;
+    oid: number;
+    px: string;
+    side: string;
+    startPosition: string;
+    sz: string;
+    time: number;
+    fee?: string | undefined;
+    tid?: number | undefined;
+}>;
+declare const userFillsSchema: z.ZodArray<z.ZodObject<{
+    closedPnl: z.ZodString;
+    coin: z.ZodString;
+    crossed: z.ZodBoolean;
+    dir: z.ZodString;
+    hash: z.ZodString;
+    oid: z.ZodNumber;
+    px: z.ZodString;
+    side: z.ZodString;
+    startPosition: z.ZodString;
+    sz: z.ZodString;
+    time: z.ZodNumber;
+    fee: z.ZodOptional<z.ZodString>;
+    tid: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    coin: string;
+    closedPnl: string;
+    crossed: boolean;
+    dir: string;
+    hash: string;
+    oid: number;
+    px: string;
+    side: string;
+    startPosition: string;
+    sz: string;
+    time: number;
+    fee?: string | undefined;
+    tid?: number | undefined;
+}, {
+    coin: string;
+    closedPnl: string;
+    crossed: boolean;
+    dir: string;
+    hash: string;
+    oid: number;
+    px: string;
+    side: string;
+    startPosition: string;
+    sz: string;
+    time: number;
+    fee?: string | undefined;
+    tid?: number | undefined;
+}>, "many">;
+/**
+ * `userNonFundingLedgerUpdates` deltas — permissive so unknown delta types
+ * still parse and can render generically later.
+ */
+declare const hypercoreLedgerDeltaSchema: z.ZodObject<{
+    type: z.ZodString;
+    usdc: z.ZodOptional<z.ZodString>;
+    amount: z.ZodOptional<z.ZodString>;
+    usdcValue: z.ZodOptional<z.ZodString>;
+    token: z.ZodOptional<z.ZodString>;
+    user: z.ZodOptional<z.ZodString>;
+    destination: z.ZodOptional<z.ZodString>;
+    fee: z.ZodOptional<z.ZodString>;
+    toPerp: z.ZodOptional<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    type: string;
+    token?: string | undefined;
+    fee?: string | undefined;
+    usdc?: string | undefined;
+    amount?: string | undefined;
+    usdcValue?: string | undefined;
+    user?: string | undefined;
+    destination?: string | undefined;
+    toPerp?: boolean | undefined;
+}, {
+    type: string;
+    token?: string | undefined;
+    fee?: string | undefined;
+    usdc?: string | undefined;
+    amount?: string | undefined;
+    usdcValue?: string | undefined;
+    user?: string | undefined;
+    destination?: string | undefined;
+    toPerp?: boolean | undefined;
+}>;
+declare const hypercoreLedgerUpdateSchema: z.ZodObject<{
+    time: z.ZodNumber;
+    hash: z.ZodString;
+    delta: z.ZodObject<{
+        type: z.ZodString;
+        usdc: z.ZodOptional<z.ZodString>;
+        amount: z.ZodOptional<z.ZodString>;
+        usdcValue: z.ZodOptional<z.ZodString>;
+        token: z.ZodOptional<z.ZodString>;
+        user: z.ZodOptional<z.ZodString>;
+        destination: z.ZodOptional<z.ZodString>;
+        fee: z.ZodOptional<z.ZodString>;
+        toPerp: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        type: string;
+        token?: string | undefined;
+        fee?: string | undefined;
+        usdc?: string | undefined;
+        amount?: string | undefined;
+        usdcValue?: string | undefined;
+        user?: string | undefined;
+        destination?: string | undefined;
+        toPerp?: boolean | undefined;
+    }, {
+        type: string;
+        token?: string | undefined;
+        fee?: string | undefined;
+        usdc?: string | undefined;
+        amount?: string | undefined;
+        usdcValue?: string | undefined;
+        user?: string | undefined;
+        destination?: string | undefined;
+        toPerp?: boolean | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    hash: string;
+    time: number;
+    delta: {
+        type: string;
+        token?: string | undefined;
+        fee?: string | undefined;
+        usdc?: string | undefined;
+        amount?: string | undefined;
+        usdcValue?: string | undefined;
+        user?: string | undefined;
+        destination?: string | undefined;
+        toPerp?: boolean | undefined;
+    };
+}, {
+    hash: string;
+    time: number;
+    delta: {
+        type: string;
+        token?: string | undefined;
+        fee?: string | undefined;
+        usdc?: string | undefined;
+        amount?: string | undefined;
+        usdcValue?: string | undefined;
+        user?: string | undefined;
+        destination?: string | undefined;
+        toPerp?: boolean | undefined;
+    };
+}>;
+declare const hypercoreLedgerUpdatesSchema: z.ZodArray<z.ZodObject<{
+    time: z.ZodNumber;
+    hash: z.ZodString;
+    delta: z.ZodObject<{
+        type: z.ZodString;
+        usdc: z.ZodOptional<z.ZodString>;
+        amount: z.ZodOptional<z.ZodString>;
+        usdcValue: z.ZodOptional<z.ZodString>;
+        token: z.ZodOptional<z.ZodString>;
+        user: z.ZodOptional<z.ZodString>;
+        destination: z.ZodOptional<z.ZodString>;
+        fee: z.ZodOptional<z.ZodString>;
+        toPerp: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        type: string;
+        token?: string | undefined;
+        fee?: string | undefined;
+        usdc?: string | undefined;
+        amount?: string | undefined;
+        usdcValue?: string | undefined;
+        user?: string | undefined;
+        destination?: string | undefined;
+        toPerp?: boolean | undefined;
+    }, {
+        type: string;
+        token?: string | undefined;
+        fee?: string | undefined;
+        usdc?: string | undefined;
+        amount?: string | undefined;
+        usdcValue?: string | undefined;
+        user?: string | undefined;
+        destination?: string | undefined;
+        toPerp?: boolean | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    hash: string;
+    time: number;
+    delta: {
+        type: string;
+        token?: string | undefined;
+        fee?: string | undefined;
+        usdc?: string | undefined;
+        amount?: string | undefined;
+        usdcValue?: string | undefined;
+        user?: string | undefined;
+        destination?: string | undefined;
+        toPerp?: boolean | undefined;
+    };
+}, {
+    hash: string;
+    time: number;
+    delta: {
+        type: string;
+        token?: string | undefined;
+        fee?: string | undefined;
+        usdc?: string | undefined;
+        amount?: string | undefined;
+        usdcValue?: string | undefined;
+        user?: string | undefined;
+        destination?: string | undefined;
+        toPerp?: boolean | undefined;
+    };
+}>, "many">;
+type SpotMetaResponse = z.infer<typeof spotMetaResponseSchema>;
+type SpotBalance = {
+    coin: string;
+    token: number;
+    total: string;
+    hold: string;
+    entryNtl?: string;
+};
+type SpotClearinghouseState = {
+    balances: SpotBalance[];
+};
+type ClearinghouseState = z.infer<typeof clearinghouseStateSchema>;
+type UserFill = z.infer<typeof userFillSchema>;
+type HypercoreLedgerUpdate = z.infer<typeof hypercoreLedgerUpdateSchema>;
+
+type HypercoreInfoRequest = {
+    type: 'spotMeta';
+} | {
+    type: 'spotClearinghouseState';
+    user: string;
+    dex?: string;
+} | {
+    type: 'clearinghouseState';
+    user: string;
+    dex?: string;
+} | {
+    type: 'userAbstraction';
+    user: string;
+} | {
+    type: 'userFills';
+    user: string;
+} | {
+    type: 'userNonFundingLedgerUpdates';
+    user: string;
+    startTime: number;
+};
+type HypercoreInfoClientConfig = {
+    /** Proxy-first `/info` URL used for balances and spot meta. */
+    infoUrl: string;
+    /**
+     * Activity URL. Defaults to `infoUrl`; may be the public HL endpoint when
+     * the proxy does not yet support fills/ledger types.
+     */
+    activityInfoUrl?: string;
+    fetch?: typeof globalThis.fetch;
+};
+type PostInfoOptions = {
+    signal?: AbortSignal;
+    /** Overrides the client default URL for this call. */
+    url?: string;
+};
+declare class HypercoreInfoClient {
+    #private;
+    constructor(config: HypercoreInfoClientConfig);
+    postInfo<T>(body: HypercoreInfoRequest, schema: z.ZodType<T>, options?: PostInfoOptions): Promise<T>;
+    getSpotMeta(options?: PostInfoOptions): Promise<SpotMetaResponse>;
+    getSpotClearinghouseState(user: string, options?: PostInfoOptions): Promise<SpotClearinghouseState>;
+    getClearinghouseState(user: string, options?: PostInfoOptions): Promise<ClearinghouseState>;
+    getUserAbstraction(user: string, options?: PostInfoOptions): Promise<UserAbstractionMode>;
+    getUserFills(user: string, options?: PostInfoOptions): Promise<UserFill[]>;
+    getUserNonFundingLedgerUpdates(user: string, startTime: number, options?: PostInfoOptions): Promise<HypercoreLedgerUpdate[]>;
+}
+
+/**
+ * Maps `spotMeta` tokens to the registry used when resolving spot balances.
+ * Keeps every spot token (including HyperCore-only ones without an EVM contract).
+ */
+declare const toHypercoreSpotTokens: (tokens: SpotMetaResponse["tokens"]) => HypercoreSpotToken[];
+
+type HypercoreNativeTokenBalance = {
+    kind: 'native';
+    name: string;
+    symbol: typeof HYPERCORE_USDC_SYMBOL;
+    decimals: number;
+    /** Human-readable amount (decimal string). */
+    balance: string;
+    /** Integer raw amount as a decimal string (no fractional part). */
+    balanceRaw: string;
+    priceUsd: 1;
+    balanceUsd: string;
+};
+type HypercoreSpotTokenBalance = {
+    kind: 'spot';
+    name: string;
+    symbol: string;
+    decimals: number;
+    balance: string;
+    balanceRaw: string;
+    index: number;
+    evmContract?: string;
+};
+type HypercoreTokenBalance = HypercoreNativeTokenBalance | HypercoreSpotTokenBalance;
+/**
+ * `true` when spot balances already back perps for this account mode
+ * (`unifiedAccount`). Other modes keep perp collateral on a separate ledger.
+ */
+declare const spotCountsAsPerpCollateral: (mode: UserAbstractionMode | undefined) => mode is "unifiedAccount";
+/**
+ * Perp collateral in USDC, excluding unrealized PnL.
+ * `crossMarginSummary.accountValue` is collateral ± PnL; we back PnL out.
+ */
+declare const getPerpCollateralUsd: (perp: ClearinghouseState | undefined) => Big.Big;
+/**
+ * USDC merges spot + (non-unified) PnL-excluded perp collateral at $1.
+ * Other spot inventory is `HYPERCORE_SPOT` (no synthetic ERC20 addresses).
+ */
+declare const buildHypercoreTokens: ({ spotBalances, perpState, abstractionMode, spotTokens, }: {
+    spotBalances: readonly SpotBalance[];
+    perpState: ClearinghouseState | undefined;
+    abstractionMode: UserAbstractionMode | undefined;
+    spotTokens: HypercoreSpotToken[];
+}) => HypercoreTokenBalance[];
+
+declare const HYPERLIQUID_COIN_SVG_BASE = "https://app.hyperliquid.xyz/coins";
+declare const hyperliquidCoinSvgKey: (coin: string) => string;
+declare const hyperliquidCoinSvgUrl: (coin: string) => string;
+
+type HypercoreActivityItem = {
+    readonly kind: 'fill';
+    readonly timeMs: number;
+    readonly hash: string;
+    readonly fill: UserFill;
+} | {
+    readonly kind: 'ledger';
+    readonly timeMs: number;
+    readonly hash: string;
+    readonly update: HypercoreLedgerUpdate;
+};
+/** Normalize a Unix timestamp to milliseconds. */
+declare const toTimeMs: (time: number) => number;
+
+declare const FILL_ARROW_UP = "\u25B2";
+declare const FILL_ARROW_DOWN = "\u25BC";
+type HypercoreFillMeta = {
+    readonly dir: string;
+    readonly px: string;
+    readonly closedPnl: string;
+    readonly coin: string;
+};
+type FillLabel = {
+    readonly text: string;
+    readonly arrow?: typeof FILL_ARROW_UP | typeof FILL_ARROW_DOWN;
+    readonly tone?: 'profit' | 'loss';
+};
+/** Display ticker with any `dex:` prefix stripped (`xyz:GOLD` → `GOLD`). */
+declare const tickerOfCoin: (coin: string) => string;
+/** PnL tone from `closedPnl` — `dir` alone does not indicate profit vs loss. */
+declare const closedPnlTone: (closedPnl: string | undefined) => "profit" | "loss" | undefined;
+/**
+ * Map a fill's `dir` into a display label. Arrow direction follows side
+ * (long ▲ / short ▼); success/error tone comes from `closedPnl` when provided.
+ */
+declare const fillLabel: (dir: string, closedPnl?: string) => FillLabel;
+/** Compact USD price for fill rows (`$1,684.7`). */
+declare const formatHypercoreFillPx: (px: string) => string;
+declare const encodeHypercoreFillMethod: (meta: HypercoreFillMeta) => string;
+declare const parseHypercoreFillMethod: (method: string | undefined) => HypercoreFillMeta | undefined;
+
+/**
+ * Semantic label key for a ledger row.
+ */
+type HypercoreLedgerLabel = 'deposit' | 'withdraw' | 'sent' | 'received' | 'transferToPerp' | 'transferToSpot' | 'transfer' | 'liquidation' | 'other';
+type HypercoreLedgerDisplay = {
+    readonly label: HypercoreLedgerLabel;
+    /** Unsigned token amount, e.g. `0.1`. */
+    readonly amount: string;
+    readonly symbol: string;
+    /** Signed USD value for the fiat line; undefined when there's nothing to show. */
+    readonly usdValue?: number;
+    readonly direction: 'positive' | 'negative' | 'neutral';
+    readonly from?: string;
+    readonly to?: string;
+    readonly rawType: string;
+};
+/**
+ * Derives label, amount, signed USD value, and counterparties for a HyperCore
+ * ledger update from the owner's perspective.
+ */
+declare const getHypercoreLedgerDisplay: (update: HypercoreLedgerUpdate, evmAddress: string) => HypercoreLedgerDisplay;
+
+/** Bound ledger pagination so busy accounts cannot trigger unbounded requests. */
+declare const MAX_LEDGER_PAGES = 20;
+/** Prefer recent ledger history; paging from `0` would return the oldest pages first. */
+declare const LEDGER_LOOKBACK_MS: number;
+type FetchHypercoreActivityOptions = {
+    signal?: AbortSignal;
+};
+/**
+ * Fetches HyperCore fills + non-funding ledger updates and sorts newest-first.
+ * Soft-fails individual endpoints so a flaky fills or ledger call still yields
+ * partial history (abort errors are rethrown).
+ */
+declare const fetchHypercoreActivity: (client: HypercoreInfoClient, evmAddress: string, options?: FetchHypercoreActivityOptions) => Promise<HypercoreActivityItem[]>;
+
+declare const mapHypercoreActivityToTransactions: (items: readonly HypercoreActivityItem[], evmAddress: string, network: Pick<Network, "explorerUrl" | "caipId" | "chainId">) => Transaction[];
+
+export { ClearinghouseState, FILL_ARROW_DOWN, FILL_ARROW_UP, FillLabel, HYPERCORE_CAIP_ID, HYPERCORE_CHAIN_ID, HYPERCORE_USDC_DECIMALS, HYPERCORE_USDC_NAME, HYPERCORE_USDC_SYMBOL, HYPERLIQUID_COIN_SVG_BASE, HypercoreActivityItem, HypercoreFillMeta, HypercoreInfoClient, HypercoreInfoClientConfig, HypercoreInfoRequest, HypercoreLedgerDisplay, HypercoreLedgerLabel, HypercoreLedgerUpdate, HypercoreModule, HypercoreNativeTokenBalance, HypercoreSpotTokenBalance, HypercoreTokenBalance, LEDGER_LOOKBACK_MS, MAX_LEDGER_PAGES, PostInfoOptions, SpotBalance, SpotClearinghouseState, SpotMetaResponse, UserAbstractionMode, UserFill, buildHypercoreTokens, clearinghouseStateSchema, closedPnlTone, encodeHypercoreFillMethod, fetchHypercoreActivity, fillLabel, formatHypercoreFillPx, getHypercoreLedgerDisplay, getPerpCollateralUsd, hypercoreLedgerDeltaSchema, hypercoreLedgerUpdateSchema, hypercoreLedgerUpdatesSchema, hyperliquidCoinSvgKey, hyperliquidCoinSvgUrl, mapHypercoreActivityToTransactions, parseHypercoreFillMethod, spotClearinghouseStateSchema, spotCountsAsPerpCollateral, spotMetaResponseSchema, tickerOfCoin, toHypercoreSpotTokens, toTimeMs, userAbstractionSchema, userFillSchema, userFillsSchema };

package/dist/index.js

@@ -0,0 +1,13 @@
+import { Environment, TokenType, TransactionType, WalletType, NetworkVMType, parseManifest } from '@avalabs/vm-module-types';
+import { rpcErrors } from '@metamask/rpc-errors';
+import { z as z$1 } from 'zod';
+import C from 'big.js';
+import { getEvmAddressFromPubKey, getAddressFromXPub } from '@avalabs/core-wallets-sdk';
+import { computeAddress } from 'ethers';
+import { init, deriveAddressesForEvm } from '@avalabs/crypto-sdk';
+
+var we=Object.defineProperty;var n=(e,t)=>we(e,"name",{value:t,configurable:!0});var _=(e,t,r)=>{if(!t.has(e))throw TypeError("Cannot "+r)};var m=(e,t,r)=>(_(e,t,"read from private field"),r?r.call(e):t.get(e)),f=(e,t,r)=>{if(t.has(e))throw TypeError("Cannot add the same private member more than once");t instanceof WeakSet?t.add(e):t.set(e,r);},g=(e,t,r,o)=>(_(e,t,"write to private field"),o?o.call(e,r):t.set(e,r),r);var V={name:"HyperCore",description:"Read-only Hyperliquid HyperCore module (balances, tokens, activity).",version:"0.0.1",sources:{module:{checksum:"",location:{npm:{filePath:"dist/index.js",packageName:"@avalabs/hypercore-module",registry:"https://registry.npmjs.org"}}}},network:{chainIds:["hlcore:mainnet"],namespaces:["hlcore"]},cointype:"60",permissions:{rpc:{dapps:!1,methods:[],nonRestrictedMethods:[]}},manifestVersion:"0.1"};var Y="/proxy/nownodes/hype/info",$="https://api.hyperliquid.xyz/info",ke={proxyApiUrl:"https://proxy-api.avax.network",infoUrl:`https://proxy-api.avax.network${Y}`,activityInfoUrl:$},Ae={proxyApiUrl:"https://proxy-api-dev.avax.network",infoUrl:`https://proxy-api-dev.avax.network${Y}`,activityInfoUrl:$},j=n(e=>{switch(e){case Environment.PRODUCTION:return ke;case Environment.DEV:return Ae}},"getEnv");var Re=z$1.coerce.number(),q=z$1.object({tokens:z$1.array(z$1.object({name:z$1.string(),index:z$1.number(),weiDecimals:z$1.number(),fullName:z$1.string().nullish(),evmContract:z$1.object({address:z$1.string()}).nullish()}))}),Ie=z$1.object({coin:z$1.string(),token:Re,total:z$1.string(),hold:z$1.string(),entryNtl:z$1.string().optional()}),W=z$1.object({balances:z$1.array(Ie)}),Ee=z$1.object({accountValue:z$1.string(),totalMarginUsed:z$1.string().optional(),totalNtlPos:z$1.string().optional(),totalRawUsd:z$1.string().optional()}),z=z$1.object({assetPositions:z$1.array(z$1.object({position:z$1.object({unrealizedPnl:z$1.string()})})),crossMarginSummary:Ee}),K=z$1.string().transform(e=>{switch(e){case"unifiedAccount":case"portfolioMargin":case"dexAbstraction":case"disabled":case"default":return e;default:return "default"}}),De=z$1.object({closedPnl:z$1.string(),coin:z$1.string(),crossed:z$1.boolean(),dir:z$1.string(),hash:z$1.string(),oid:z$1.number(),px:z$1.string(),side:z$1.string(),startPosition:z$1.string(),sz:z$1.string(),time:z$1.number(),fee:z$1.string().optional(),tid:z$1.number().optional()}),J=z$1.array(De),Me=z$1.object({type:z$1.string(),usdc:z$1.string().optional(),amount:z$1.string().optional(),usdcValue:z$1.string().optional(),token:z$1.string().optional(),user:z$1.string().optional(),destination:z$1.string().optional(),fee:z$1.string().optional(),toPerp:z$1.boolean().optional()}),Oe=z$1.object({time:z$1.number(),hash:z$1.string(),delta:Me}),X=z$1.array(Oe);var H=n(e=>e.toLowerCase(),"lowercaseUser"),k,P,A,O=class O{constructor(t){f(this,k,void 0);f(this,P,void 0);f(this,A,void 0);g(this,k,t.infoUrl),g(this,P,t.activityInfoUrl??t.infoUrl),g(this,A,t.fetch??globalThis.fetch.bind(globalThis));}async postInfo(t,r,o){let i=await m(this,A).call(this,o?.url??m(this,k),{method:"POST",headers:{"Content-Type":"application/json"},body:JSON.stringify(t),signal:o?.signal});if(!i.ok)throw new Error(`Hyperliquid /info failed: ${i.status} ${i.statusText}`);let p=await i.json();return r.parse(p)}getSpotMeta(t){return this.postInfo({type:"spotMeta"},q,t)}getSpotClearinghouseState(t,r){return this.postInfo({type:"spotClearinghouseState",user:H(t),dex:""},W,r)}getClearinghouseState(t,r){return this.postInfo({type:"clearinghouseState",user:H(t),dex:""},z,r)}getUserAbstraction(t,r){return this.postInfo({type:"userAbstraction",user:H(t)},K,r)}getUserFills(t,r){return this.postInfo({type:"userFills",user:H(t)},J,{...r,url:r?.url??m(this,P)})}getUserNonFundingLedgerUpdates(t,r,o){return this.postInfo({type:"userNonFundingLedgerUpdates",user:H(t),startTime:r},X,{...o,url:o?.url??m(this,P)})}};k=new WeakMap,P=new WeakMap,A=new WeakMap,n(O,"HypercoreInfoClient");var E=O;var N=n(e=>`HyperCore does not support ${e}: read-only module (balances, tokens, activity).`,"unsupportedHypercoreCapabilityMessage");var Z="hlcore:mainnet",vt=9999,D="USDC",Q="USD Coin",F=8;var h=new C(0),Ne=n(e=>e==="unifiedAccount","spotCountsAsPerpCollateral"),ee=n((e,t)=>e.times(new C(10).pow(t)).round(0,C.roundDown).toFixed(0),"toRawBalance"),Fe=n(e=>{if(!e)return h;let t=new C(e.crossMarginSummary.accountValue??"0"),r=e.assetPositions.reduce((i,{position:p})=>i.plus(p.unrealizedPnl),h),o=t.minus(r);return o.gt(h)?o:h},"getPerpCollateralUsd"),te=n(({spotBalances:e,perpState:t,abstractionMode:r,spotTokens:o})=>{let i=new Map(o.map(d=>[d.index,d])),p=Ne(r)?h:Fe(t),a=e.find(d=>d.coin.toUpperCase()===D),c=new C(a?.total??"0").plus(p),l=[];c.gt(h)&&l.push({kind:"native",name:Q,symbol:D,decimals:8,balance:c.toString(),balanceRaw:ee(c,8),priceUsd:1,balanceUsd:c.toString()});for(let d of e){if(d.coin.toUpperCase()===D)continue;let u=i.get(d.token),w=new C(d.total);!u||!w.gt(h)||l.push({kind:"spot",name:u.name,symbol:u.symbol,decimals:u.decimals,balance:w.toString(),balanceRaw:ee(w,u.decimals),index:u.index,evmContract:u.evmContract});}return l},"buildHypercoreTokens");var Le="https://app.hyperliquid.xyz/coins",Be=n(e=>{let t=e.trim(),r=t.indexOf(":");return r===-1?t.toUpperCase():`${t.slice(0,r)}:${t.slice(r+1).toUpperCase()}`},"hyperliquidCoinSvgKey"),y=n(e=>`${Le}/${encodeURIComponent(Be(e))}.svg`,"hyperliquidCoinSvgUrl");var Ve=n(e=>/^0x[a-fA-F0-9]{40}$/.test(e),"isValidEvmAddress"),M=n(e=>e.map(t=>{let r=t.evmContract?.address.toLowerCase();return {type:TokenType.HYPERCORE_SPOT,index:t.index,name:t.fullName??t.name,symbol:t.name,decimals:t.weiDecimals,evmContract:r&&Ve(r)?r:void 0}}),"toHypercoreSpotTokens");var Ge=n((e,t)=>{if(e.kind==="native"){let i=BigInt(e.balanceRaw),p=Number(e.balanceUsd),a={...t,name:e.name,symbol:e.symbol,decimals:e.decimals,logoUri:t.logoUri??y(e.symbol),coingeckoId:"usd-coin",type:TokenType.NATIVE,balance:i,balanceDisplayValue:e.balance,balanceInCurrency:Number.isFinite(p)?p:0,balanceCurrencyDisplayValue:e.balanceUsd,priceInCurrency:e.priceUsd};return {key:e.symbol,value:a}}let r=BigInt(e.balanceRaw),o={type:TokenType.HYPERCORE_SPOT,name:e.name,symbol:e.symbol,decimals:e.decimals,index:e.index,evmContract:e.evmContract,logoUri:y(e.symbol),reputation:null,balance:r,balanceDisplayValue:e.balance};return {key:`spot:${e.index}`,value:o}},"toTokenWithBalance"),oe=n(async({addresses:e,network:t,infoClient:r})=>{let o=await r.getSpotMeta(),i=M(o.tokens);return (await Promise.allSettled(e.map(async a=>{try{let[c,l,d]=await Promise.all([r.getSpotClearinghouseState(a),r.getClearinghouseState(a).catch(()=>{}),r.getUserAbstraction(a).catch(()=>{})]),u=te({spotBalances:c.balances,perpState:l,abstractionMode:d,spotTokens:i}),w=Object.fromEntries(u.map(Se=>{let{key:Te,value:Ue}=Ge(Se,t.networkToken);return [Te,Ue]}));return {[a]:w}}catch(c){return {[a]:{error:c.toString()}}}}))).reduce((a,c)=>c.status==="fulfilled"?{...a,...c.value}:a,{})},"getBalances");var ne=n(async({infoClient:e})=>{let t=await e.getSpotMeta();return M(t.tokens).map(r=>({...r,logoUri:r.logoUri??y(r.symbol)}))},"getTokens");var R=n(e=>e<1e10?e*1e3:e,"toTimeMs");var Ye=20,$e=365*24*60*60*1e3,je=n(e=>e instanceof DOMException&&e.name==="AbortError"||e instanceof Error&&e.name==="AbortError","isAbortError"),se=n(async(e,t)=>{try{return await e}catch(r){if(je(r))throw r;return t}},"softFail"),qe=n(async(e,t,r)=>{let o=[],i=Date.now()-$e,p=0;for(;p<Ye;){if(r?.signal?.aborted)throw new DOMException("The operation was aborted.","AbortError");let a=await e.getUserNonFundingLedgerUpdates(t,i,r);if(p+=1,a.length===0)break;o.push(...a);let c=a[a.length-1];if(!c)break;let l=c.time+1;if(l<=i)break;i=l;}return o},"fetchLedgerUpdates"),ie=n(async(e,t,r)=>{let[o,i]=await Promise.all([se(e.getUserFills(t,r),[]),se(qe(e,t,r),[])]);return [...o.map(a=>({kind:"fill",timeMs:R(a.time),hash:a.hash,fill:a})),...i.map(a=>({kind:"ledger",timeMs:R(a.time),hash:a.hash,update:a}))].sort((a,c)=>c.timeMs-a.timeMs)},"fetchHypercoreActivity");var b=n(e=>{if(e===void 0||e==="")return "";let t=Number.parseFloat(e);return Number.isFinite(t)?new Intl.NumberFormat("en-US",{maximumFractionDigits:6}).format(t):e},"formatAmount"),x=n((e,t)=>{if(e===void 0||e==="")return;let r=Number.parseFloat(e);return Number.isFinite(r)?r*(t===0?1:t):void 0},"toUsd"),ae=n((e,t)=>{let{delta:r}=e,o=t.toLowerCase(),i=r.user?.toLowerCase()===o;switch(r.type){case"deposit":return {label:"deposit",amount:b(r.usdc),symbol:"USDC",usdValue:x(r.usdc,1),direction:"positive",to:t,rawType:r.type};case"withdraw":return {label:"withdraw",amount:b(r.usdc),symbol:"USDC",usdValue:x(r.usdc,-1),direction:"negative",from:t,rawType:r.type};case"send":case"spotTransfer":return {label:i?"sent":"received",amount:b(r.amount),symbol:r.token??"USDC",usdValue:x(r.usdcValue,i?-1:1),direction:i?"negative":"positive",from:r.user,to:r.destination,rawType:r.type};case"internalTransfer":return {label:"transfer",amount:b(r.usdc),symbol:"USDC",usdValue:x(r.usdc,i?-1:1),direction:i?"negative":"positive",from:r.user,to:r.destination,rawType:r.type};case"accountClassTransfer":return {label:r.toPerp?"transferToPerp":"transferToSpot",amount:b(r.usdc),symbol:"USDC",usdValue:x(r.usdc,0),direction:"neutral",rawType:r.type};case"liquidation":return {label:"liquidation",amount:b(r.usdcValue??r.usdc),symbol:"USDC",usdValue:x(r.usdcValue??r.usdc,-1),direction:"negative",rawType:r.type};default:return {label:"other",amount:b(r.usdcValue??r.usdc),symbol:"USDC",usdValue:x(r.usdcValue??r.usdc,0),direction:"neutral",rawType:r.type}}},"getHypercoreLedgerDisplay");var L="hypercoreFill:v1:",We="\u25B2",ze="\u25BC",pe=n(e=>{let t=e.indexOf(":");return t===-1?e:e.slice(t+1)},"tickerOfCoin"),Ke=n(e=>{if(e===void 0)return;let t=Number.parseFloat(e);if(!(!Number.isFinite(t)||t===0))return t>0?"profit":"loss"},"closedPnlTone"),zt=n((e,t)=>{let r=Ke(t),o=e.toLowerCase();return o.includes("close")&&o.includes("long")?{text:"Long closed",arrow:We,tone:r}:o.includes("close")&&o.includes("short")?{text:"Short closed",arrow:ze,tone:r}:o.includes("open")&&(o.includes("long")||o.includes("short"))?{text:"Order opened"}:o.includes("cancel")?{text:"Order cancelled"}:{text:e}},"fillLabel"),Kt=n(e=>{let t=Number.parseFloat(e);return Number.isFinite(t)?`$${t.toLocaleString(void 0,{maximumFractionDigits:8})}`:e},"formatHypercoreFillPx"),ce=n(e=>`${L}${encodeURIComponent(JSON.stringify(e))}`,"encodeHypercoreFillMethod"),Jt=n(e=>{if(e?.startsWith(L))try{let t=JSON.parse(decodeURIComponent(e.slice(L.length)));if(typeof t!="object"||t===null||!("dir"in t)||!("px"in t)||!("closedPnl"in t)||!("coin"in t))return;let{dir:r,px:o,closedPnl:i,coin:p}=t;return typeof r!="string"||typeof o!="string"||typeof i!="string"||typeof p!="string"?void 0:{dir:r,px:o,closedPnl:i,coin:p}}catch{return}},"parseHypercoreFillMethod");var de=n((e,t)=>{let r=(e.explorerUrl??"").replace(/\/$/,"");return r?`${r}/tx/${t}`:t},"explorerTxLink"),me=n(e=>e.caipId??Z,"chainIdForNetwork"),Je=n((e,t,r)=>{let o=e.side==="B",i=pe(e.coin),p={type:TokenType.NATIVE,name:e.coin,symbol:i,amount:e.sz,imageUri:y(e.coin)};return {isContractCall:!1,isIncoming:o,isOutgoing:!o,isSender:!o,timestamp:t,hash:e.hash,from:"",to:"",tokens:[p],gasUsed:"0",txType:TransactionType.FILL_ORDER,method:ce({dir:e.dir??"",px:e.px,closedPnl:e.closedPnl,coin:e.coin}),chainId:me(r),explorerLink:de(r,e.hash)}},"mapFillToTransaction"),Xe=n((e,t,r)=>{let o=ae(e,t),i=o.direction==="positive",p=o.direction==="negative",a=TransactionType.TRANSFER;switch(o.label){case"deposit":case"received":a=TransactionType.RECEIVE;break;case"withdraw":case"sent":a=TransactionType.SEND;break;case"liquidation":a=TransactionType.UNKNOWN;break;default:a=TransactionType.TRANSFER;}let c=o.amount||"0",l={type:TokenType.NATIVE,name:o.symbol,symbol:o.symbol,amount:c,imageUri:y(o.symbol)};return {isContractCall:!1,isIncoming:i,isOutgoing:p,isSender:p,timestamp:R(e.time),hash:e.hash,from:o.from??(p?t:""),to:o.to??(i?t:""),tokens:[l],gasUsed:"0",txType:a,chainId:me(r),explorerLink:de(r,e.hash)}},"mapLedgerToTransaction"),ue=n((e,t,r)=>e.map(o=>o.kind==="fill"?Je(o.fill,o.timeMs,r):Xe(o.update,t,r)),"mapHypercoreActivityToTransactions");var ye=n(async({address:e,network:t,infoClient:r})=>{let o=await ie(r,e);return {transactions:ue(o,e,t)}},"getTransactionHistory");var ge=n(async({accountIndex:e,xpub:t,walletType:r})=>{switch(r){case WalletType.Mnemonic:case WalletType.Ledger:case WalletType.Keystone:return {[NetworkVMType.HYPERCORE]:getAddressFromXPub(t,e)};case WalletType.LedgerLive:case WalletType.Seedless:{let o=Buffer.from(t,"hex");return {[NetworkVMType.HYPERCORE]:getEvmAddressFromPubKey(o)}}default:throw rpcErrors.invalidParams(`Unsupported wallet type: ${r}`)}},"getAddress");var he=n(e=>"derivationPathType"in e&&"accountIndex"in e&&typeof e.accountIndex=="number"&&typeof e.derivationPathType=="string","hasDerivationDetails");var T=n(({accountIndex:e,derivationPathType:t})=>{if(e<0)throw rpcErrors.invalidParams("Account index must be a non-negative integer");switch(t){case"bip44":return {[NetworkVMType.HYPERCORE]:`m/44'/60'/0'/0/${e}`};case"ledger_live":return {[NetworkVMType.HYPERCORE]:`m/44'/60'/${e}'/0/0`};default:throw rpcErrors.invalidParams(`Unsupported derivation path type: ${t}`)}},"buildDerivationPath");var ve=n(async e=>{let{secretId:t,approvalController:r}=e,o=he(e)?T({accountIndex:e.accountIndex,derivationPathType:e.derivationPathType,addressIndex:e.addressIndex}).HYPERCORE:void 0,i=await r.requestPublicKey({curve:"secp256k1",secretId:t,derivationPath:o});return {[NetworkVMType.HYPERCORE]:computeAddress(`0x${i}`)}},"deriveAddress");var Pe=n(async e=>{let{approvalController:t,secretId:r,accountIndices:o,derivationPathType:i}=e;if(o.length===0)return [];await init();let p=await Promise.all(o.map(async c=>{let l=T({accountIndex:c,derivationPathType:i}).HYPERCORE,d=await t.requestPublicKey({curve:"secp256k1",secretId:r,derivationPath:l});return Uint8Array.from(Buffer.from(d,"hex"))}));return (await deriveAddressesForEvm(p)).map(c=>({[NetworkVMType.HYPERCORE]:c}))},"deriveAddresses");var U,v,B=class B{constructor({environment:t,approvalController:r,runtime:o}){f(this,U,void 0);f(this,v,void 0);let{infoUrl:i,activityInfoUrl:p}=j(t);g(this,U,r),g(this,v,new E({infoUrl:i,activityInfoUrl:p,fetch:o?.fetch}));}getProvider(t){return Promise.reject(new Error(N("getProvider")))}getManifest(){let t=parseManifest(V);return t.success?t.data:void 0}getBalances(t){return oe({...t,infoClient:m(this,v)})}getTransactionHistory(t){return ye({...t,infoClient:m(this,v)})}getNetworkFee(t){return Promise.reject(new Error(N("getNetworkFee")))}getAddress(t){return ge(t)}buildDerivationPath(t){return T(t)}deriveAddress(t){return ve({...t,approvalController:m(this,U)})}deriveAddresses(t){return Pe({...t,approvalController:m(this,U)})}getTokens(t){return ne({network:t,infoClient:m(this,v)})}async onRpcRequest(t,r){return {error:rpcErrors.methodNotSupported(`HyperCore is read-only; method ${t.method} is not supported`)}}};U=new WeakMap,v=new WeakMap,n(B,"HypercoreModule");var Ce=B;
+
+export { ze as FILL_ARROW_DOWN, We as FILL_ARROW_UP, Z as HYPERCORE_CAIP_ID, vt as HYPERCORE_CHAIN_ID, F as HYPERCORE_USDC_DECIMALS, Q as HYPERCORE_USDC_NAME, D as HYPERCORE_USDC_SYMBOL, Le as HYPERLIQUID_COIN_SVG_BASE, E as HypercoreInfoClient, Ce as HypercoreModule, $e as LEDGER_LOOKBACK_MS, Ye as MAX_LEDGER_PAGES, te as buildHypercoreTokens, z as clearinghouseStateSchema, Ke as closedPnlTone, ce as encodeHypercoreFillMethod, ie as fetchHypercoreActivity, zt as fillLabel, Kt as formatHypercoreFillPx, ae as getHypercoreLedgerDisplay, Fe as getPerpCollateralUsd, Me as hypercoreLedgerDeltaSchema, Oe as hypercoreLedgerUpdateSchema, X as hypercoreLedgerUpdatesSchema, Be as hyperliquidCoinSvgKey, y as hyperliquidCoinSvgUrl, ue as mapHypercoreActivityToTransactions, Jt as parseHypercoreFillMethod, W as spotClearinghouseStateSchema, Ne as spotCountsAsPerpCollateral, q as spotMetaResponseSchema, pe as tickerOfCoin, M as toHypercoreSpotTokens, R as toTimeMs, K as userAbstractionSchema, De as userFillSchema, J as userFillsSchema };
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=index.js.map