View Source Hyperliquid.Rpc.Registry (hyperliquid v0.2.2)

Dynamic registry for named RPC endpoints.

Allows registering, retrieving, and managing multiple RPC endpoints by name at runtime. The registry is initialized from application configuration and can be updated dynamically.

Usage

# Register a new RPC endpoint at runtime
Hyperliquid.Rpc.Registry.register(:alchemy, "https://arb-mainnet.g.alchemy.com/v2/KEY")

# Get an RPC URL by name
{:ok, url} = Hyperliquid.Rpc.Registry.get(:alchemy)

# Use in RPC calls
Hyperliquid.Transport.Rpc.call("eth_blockNumber", [], rpc_name: :alchemy)

# List all registered RPCs
Hyperliquid.Rpc.Registry.list()

# Remove an RPC endpoint
Hyperliquid.Rpc.Registry.unregister(:alchemy)

Configuration

Named RPCs can be configured in your config file:

config :hyperliquid,
  named_rpcs: %{
    alchemy: "https://arb-mainnet.g.alchemy.com/v2/YOUR_KEY",
    quicknode: "https://your-endpoint.quiknode.pro/YOUR_KEY",
    local: "http://localhost:8545"
  }

Summary

Types

rpc_name()

rpc_url()

Functions

child_spec(arg)

Returns a specification to start this module under a supervisor.

clear()

Clears all registered RPC endpoints.

exists?(name)

Checks if a named RPC endpoint exists in the registry.

get(name)

Gets the URL for a named RPC endpoint.

get!(name)

Gets the URL for a named RPC endpoint, raises if not found.

list()

Lists all registered RPC endpoints.

Registers a named RPC endpoint.

start_link(opts \\ [])

Starts the RPC registry.

unregister(name)

Removes a named RPC endpoint from the registry.

Types

rpc_name()

@type rpc_name() :: atom() | String.t()

rpc_url()

@type rpc_url() :: String.t()

Functions

child_spec(arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

clear()

@spec clear() :: :ok

Clears all registered RPC endpoints.

Examples

iex> Hyperliquid.Rpc.Registry.clear()
:ok

exists?(name)

@spec exists?(rpc_name()) :: boolean()

Checks if a named RPC endpoint exists in the registry.

Parameters

name - Name of the RPC endpoint to check

Returns

true if the RPC exists
false otherwise

Examples

iex> Hyperliquid.Rpc.Registry.exists?(:alchemy)
true

iex> Hyperliquid.Rpc.Registry.exists?(:nonexistent)
false

get(name)

@spec get(rpc_name()) :: {:ok, rpc_url()} | :error

Gets the URL for a named RPC endpoint.

Parameters

name - Name of the RPC endpoint

Returns

{:ok, url} - If the RPC exists
:error - If the RPC does not exist

Examples

iex> Hyperliquid.Rpc.Registry.get(:alchemy)
{:ok, "https://arb-mainnet.g.alchemy.com"}

iex> Hyperliquid.Rpc.Registry.get(:nonexistent)
:error

get!(name)

@spec get!(rpc_name()) :: rpc_url()

Gets the URL for a named RPC endpoint, raises if not found.

Parameters

name - Name of the RPC endpoint

Returns

url - The RPC URL

Raises

RuntimeError if the RPC endpoint is not found

Examples

iex> Hyperliquid.Rpc.Registry.get!(:alchemy)
"https://arb-mainnet.g.alchemy.com"

list()

@spec list() :: %{required(atom()) => rpc_url()}

Lists all registered RPC endpoints.

Returns

Map of all registered RPC endpoints (name => url)

Examples

iex> Hyperliquid.Rpc.Registry.list()
%{
  alchemy: "https://arb-mainnet.g.alchemy.com",
  quicknode: "https://quicknode.com",
  local: "http://localhost:8545"
}

register(name, url)

@spec register(rpc_name(), rpc_url()) :: :ok

Registers a named RPC endpoint.

Parameters

name - Name to register the RPC under (atom or string)
url - RPC endpoint URL

Examples

iex> Hyperliquid.Rpc.Registry.register(:alchemy, "https://arb-mainnet.g.alchemy.com")
:ok

iex> Hyperliquid.Rpc.Registry.register("quicknode", "https://quicknode.com")
:ok

start_link(opts \\ [])

@spec start_link(keyword()) :: Agent.on_start()

Starts the RPC registry.

Options

:rpcs - Initial map of named RPC endpoints (default: %{})

This is typically called by the application supervisor.

unregister(name)

@spec unregister(rpc_name()) :: :ok

Removes a named RPC endpoint from the registry.

Parameters

name - Name of the RPC endpoint to remove

Examples

iex> Hyperliquid.Rpc.Registry.unregister(:alchemy)
:ok