View Source Hyperliquid.Node (hyperliquid v0.4.1)

Client for interacting with a local Hyperliquid node.

Local nodes can serve EVM JSON-RPC (/evm) and Info API (/info) endpoints when started with --serve-eth-rpc and --serve-info flags. This gives lower latency, no rate limits, and reduced trust assumptions.

Info Endpoints

Convenience functions are generated for the info requests verified to work on the local info server. Each function sends the request to the node's /info endpoint and parses the response using the corresponding endpoint module when available.

# Documented endpoints with parsed struct responses
Hyperliquid.Node.meta()
Hyperliquid.Node.clearinghouse_state("0x...")

# Generic fallback for any info request (returns raw snake_cased map)
Hyperliquid.Node.info_request(%{type: "someEndpoint"})

File Snapshots

The local info server supports fileSnapshot requests that write large snapshot data to files on the node's filesystem.

Hyperliquid.Node.file_snapshot(%{type: "referrerStates"}, "/tmp/out.json")
Hyperliquid.Node.referrer_states_snapshot("/tmp/out.json")
Hyperliquid.Node.l4_snapshots("/tmp/out.json")

EVM RPC

When enable_node_rpc: true is configured, a :node named RPC is registered at startup pointing to node_url/evm. You can use it directly:

Hyperliquid.Rpc.Eth.block_number(rpc_name: :node)

Or through the convenience helpers:

Hyperliquid.Node.rpc_call("eth_blockNumber")

Configuration

Info and RPC can be enabled independently:

config :hyperliquid,
  node_url: "http://localhost:3001",
  enable_node_info: true,  # enables Node info convenience functions
  enable_node_rpc: true    # registers :node named RPC at startup

Summary

Functions

active_asset_data(user, coin)

Fetch activeAssetData for the given user and coin from the local node.

aligned_quote_token_info(token)

Fetch alignedQuoteTokenInfo for the given token from the local node.

all_borrow_lend_reserve_states()

Fetch allBorrowLendReserveStates from the local node.

all_perp_metas()

Fetch allPerpMetas from the local node.

approved_builders(user)

Fetch approvedBuilders for the given user from the local node.

borrow_lend_reserve_state(token)

Fetch borrowLendReserveState for the given token from the local node.

borrow_lend_user_state(user)

Fetch borrowLendUserState for the given user from the local node.

clearinghouse_state(user, opts \\ [])

Fetch clearinghouseState for the given user from the local node. Accepts [:dex] as optional keyword args.

delegations(user)

Fetch delegations for the given user from the local node.

delegator_summary(user)

Fetch delegatorSummary for the given user from the local node.

exchange_status()

Fetch exchangeStatus from the local node.

extra_agents(user)

Fetch extraAgents for the given user from the local node.

file_snapshot(request, out_path, opts \\ [])

Send a fileSnapshot request to the local node.

frontend_open_orders(user, opts \\ [])

Fetch frontendOpenOrders for the given user from the local node. Accepts [:dex] as optional keyword args.

gossip_priority_auction_status()

Fetch gossipPriorityAuctionStatus from the local node.

info_request(payload, opts \\ [])

Send any info request to the local node.

l4_snapshots(out_path, opts \\ [])

Write L4 snapshots to a file on the node.

leading_vaults()

Fetch leadingVaults from the local node.

liquidatable()

Fetch liquidatable from the local node.

margin_table(id)

Fetch marginTable for the given id from the local node.

max_builder_fee(user)

Fetch maxBuilderFee for the given user from the local node.

max_market_order_ntls(user)

Fetch maxMarketOrderNtls for the given user from the local node.

meta(opts \\ [])

Fetch meta from the local node. Accepts [:dex] as optional keyword args.

open_orders(user, opts \\ [])

Fetch openOrders for the given user from the local node. Accepts [:dex] as optional keyword args.

outcome_meta()

Fetch outcomeMeta from the local node.

outcome_templates()

Fetch outcomeTemplates from the local node.

perp_annotation(coin)

Fetch perpAnnotation for the given coin from the local node.

perp_categories()

Fetch perpCategories from the local node.

perp_concise_annotations()

Fetch perpConciseAnnotations from the local node.

perp_deploy_auction_status()

Fetch perpDeployAuctionStatus from the local node.

perp_dex_limits(dex)

Fetch perpDexLimits for the given dex from the local node.

perp_dex_status(dex)

Fetch perpDexStatus for the given dex from the local node.

perp_dexs()

Fetch perpDexs from the local node.

perps_at_open_interest_cap(opts \\ [])

Fetch perpsAtOpenInterestCap from the local node. Accepts [:dex] as optional keyword args.

ping()

Ping the local node by requesting exchange status.

referrer_states_snapshot(out_path, opts \\ [])

Write a referrer states snapshot to a file on the node.

rpc_call(method, params \\ [])

Make a JSON-RPC call to the node's EVM endpoint.

rpc_call!(method, params \\ [])

Like rpc_call/2 but raises on error.

settled_outcome(outcome)

Fetch settledOutcome for the given outcome from the local node.

spot_clearinghouse_state(user)

Fetch spotClearinghouseState for the given user from the local node.

spot_deploy_state()

Fetch spotDeployState from the local node.

spot_meta()

Fetch spotMeta from the local node.

spot_pair_deploy_auction_status()

Fetch spotPairDeployAuctionStatus from the local node.

sub_accounts2(user)

Fetch subAccounts2 for the given user from the local node.

sub_accounts(user)

Fetch subAccounts for the given user from the local node.

user_abstraction(user)

Fetch userAbstraction for the given user from the local node.

user_dex_abstraction(user)

Fetch userDexAbstraction for the given user from the local node.

user_fees(user)

Fetch userFees for the given user from the local node.

user_rate_limit(user)

Fetch userRateLimit for the given user from the local node.

user_role(user)

Fetch userRole for the given user from the local node.

user_to_multi_sig_signers(user)

Fetch userToMultiSigSigners for the given user from the local node.

user_vault_equities(user)

Fetch userVaultEquities for the given user from the local node.

validator_l1_votes()

Fetch validatorL1Votes from the local node.

vault_summaries()

Fetch vaultSummaries from the local node.

web_data2(user)

Fetch webData2 for the given user from the local node.

Functions

active_asset_data(user, coin)

Fetch activeAssetData for the given user and coin from the local node.

aligned_quote_token_info(token)

Fetch alignedQuoteTokenInfo for the given token from the local node.

all_borrow_lend_reserve_states()

Fetch allBorrowLendReserveStates from the local node.

all_perp_metas()

Fetch allPerpMetas from the local node.

approved_builders(user)

Fetch approvedBuilders for the given user from the local node.

borrow_lend_reserve_state(token)

Fetch borrowLendReserveState for the given token from the local node.

borrow_lend_user_state(user)

Fetch borrowLendUserState for the given user from the local node.

clearinghouse_state(user, opts \\ [])

Fetch clearinghouseState for the given user from the local node. Accepts [:dex] as optional keyword args.

delegations(user)

Fetch delegations for the given user from the local node.

delegator_summary(user)

Fetch delegatorSummary for the given user from the local node.

exchange_status()

Fetch exchangeStatus from the local node.

extra_agents(user)

Fetch extraAgents for the given user from the local node.

file_snapshot(request, out_path, opts \\ [])

Send a fileSnapshot request to the local node.

File snapshot requests write large data sets to a file on the node's filesystem rather than returning them in the HTTP response.

Parameters

request: The inner request map (e.g., %{type: "referrerStates"})
out_path: Absolute path on the node where the snapshot file will be written
opts:
- :include_height - Whether to include block height in output (default: false)

Examples

Hyperliquid.Node.file_snapshot(%{type: "referrerStates"}, "/tmp/out.json")

frontend_open_orders(user, opts \\ [])

Fetch frontendOpenOrders for the given user from the local node. Accepts [:dex] as optional keyword args.

gossip_priority_auction_status()

Fetch gossipPriorityAuctionStatus from the local node.

info_request(payload, opts \\ [])

Send any info request to the local node.

This is a generic fallback that accepts any payload. Use this for undocumented endpoints or when you need full control over the request.

Examples

Hyperliquid.Node.info_request(%{type: "someEndpoint"})
Hyperliquid.Node.info_request(%{type: "clearinghouseState", user: "0x..."})

l4_snapshots(out_path, opts \\ [])

Write L4 snapshots to a file on the node.

Parameters

out_path: File path on the node
opts:
- :include_users - Include user data (default: true)
- :include_trigger_orders - Include trigger orders (default: true)
- :include_height - Include block height in output (default: false)

leading_vaults()

Fetch leadingVaults from the local node.

liquidatable()

Fetch liquidatable from the local node.

margin_table(id)

Fetch marginTable for the given id from the local node.

max_builder_fee(user)

Fetch maxBuilderFee for the given user from the local node.

max_market_order_ntls(user)

Fetch maxMarketOrderNtls for the given user from the local node.

meta(opts \\ [])

Fetch meta from the local node. Accepts [:dex] as optional keyword args.

open_orders(user, opts \\ [])

Fetch openOrders for the given user from the local node. Accepts [:dex] as optional keyword args.

outcome_meta()

Fetch outcomeMeta from the local node.

outcome_templates()

Fetch outcomeTemplates from the local node.

perp_annotation(coin)

Fetch perpAnnotation for the given coin from the local node.

perp_categories()

Fetch perpCategories from the local node.

perp_concise_annotations()

Fetch perpConciseAnnotations from the local node.

perp_deploy_auction_status()

Fetch perpDeployAuctionStatus from the local node.

perp_dex_limits(dex)

Fetch perpDexLimits for the given dex from the local node.

perp_dex_status(dex)

Fetch perpDexStatus for the given dex from the local node.

perp_dexs()

Fetch perpDexs from the local node.

perps_at_open_interest_cap(opts \\ [])

Fetch perpsAtOpenInterestCap from the local node. Accepts [:dex] as optional keyword args.

ping()

Ping the local node by requesting exchange status.

Returns {:ok, data} if the node is reachable, {:error, reason} otherwise.

referrer_states_snapshot(out_path, opts \\ [])

Write a referrer states snapshot to a file on the node.

Parameters

out_path: File path on the node
opts: See file_snapshot/3

rpc_call(method, params \\ [])

Make a JSON-RPC call to the node's EVM endpoint.

Requires enable_node_rpc: true in config so the :node named RPC is registered.

Examples

Hyperliquid.Node.rpc_call("eth_blockNumber")
Hyperliquid.Node.rpc_call("eth_getBalance", ["0x...", "latest"])

rpc_call!(method, params \\ [])

Like rpc_call/2 but raises on error.

settled_outcome(outcome)

Fetch settledOutcome for the given outcome from the local node.

spot_clearinghouse_state(user)

Fetch spotClearinghouseState for the given user from the local node.

spot_deploy_state()

Fetch spotDeployState from the local node.

spot_meta()

Fetch spotMeta from the local node.

spot_pair_deploy_auction_status()

Fetch spotPairDeployAuctionStatus from the local node.

sub_accounts2(user)

Fetch subAccounts2 for the given user from the local node.

sub_accounts(user)

Fetch subAccounts for the given user from the local node.

user_abstraction(user)

Fetch userAbstraction for the given user from the local node.

user_dex_abstraction(user)

Fetch userDexAbstraction for the given user from the local node.

user_fees(user)

Fetch userFees for the given user from the local node.

user_rate_limit(user)

Fetch userRateLimit for the given user from the local node.

user_role(user)

Fetch userRole for the given user from the local node.

user_to_multi_sig_signers(user)

Fetch userToMultiSigSigners for the given user from the local node.

user_vault_equities(user)

Fetch userVaultEquities for the given user from the local node.

validator_l1_votes()

Fetch validatorL1Votes from the local node.

vault_summaries()

Fetch vaultSummaries from the local node.

web_data2(user)

Fetch webData2 for the given user from the local node.