View Source Hyperliquid.Api.Info.GossipRootIps (hyperliquid v0.2.2)
Gossip network root IP addresses.
Returns the list of root node IP addresses for the Hyperliquid gossip network.
See: https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint
Summary
Functions
Returns metadata about this endpoint.
Returns postgres table configurations (multi-table support).
Returns storage configuration for this endpoint.
Build a cache key from response data using the configured pattern.
Returns nil if cache is not enabled or no pattern configured.
Build the request payload.
Returns true if cache storage is enabled.
Returns the cache TTL if configured.
Creates a changeset for gossip root IPs data.
Check if an IP is in the root list.
Get the count of root IPs.
Fetch is an alias for request when no storage is configured.
Parse and validate the API response.
Returns true if postgres storage is enabled.
Returns the postgres table name if configured (primary table for legacy support).
Returns the upsert config for postgres (primary table for legacy support).
Get a random root IP for connection.
Get the rate limit cost for this endpoint.
Make the API request and parse the response.
Make the API request, raising on error.
Make the API request and return the raw response map (no key transformation).
Make the API request returning raw map, raising on error.
Returns true if any storage backend is enabled.
Convert IPs to a list.
Types
@type t() :: %Hyperliquid.Api.Info.GossipRootIps{ips: [String.t()]}
Functions
Returns metadata about this endpoint.
Example
iex> Hyperliquid.Api.Info.GossipRootIps.__endpoint_info__()
%{
endpoint: "gossipRootIps",
type: :info,
rate_limit_cost: 1,
params: [],
optional_params: [],
doc: "Retrieve gossip network root IP addresses",
returns: "List of root node IP addresses for the Hyperliquid gossip network"
}
Returns postgres table configurations (multi-table support).
Returns storage configuration for this endpoint.
Build a cache key from response data using the configured pattern.
Returns nil if cache is not enabled or no pattern configured.
@spec build_request() :: map()
Build the request payload.
Returns true if cache storage is enabled.
Returns the cache TTL if configured.
@spec changeset(t(), map()) :: Ecto.Changeset.t()
Creates a changeset for gossip root IPs data.
Parameters
gossip: The gossip root IPs structattrs: Map with ips key
Returns
Ecto.Changeset.t()
Check if an IP is in the root list.
Parameters
gossip: The gossip root IPs structip: IP address to check
Returns
boolean()
@spec count(t()) :: non_neg_integer()
Get the count of root IPs.
Parameters
gossip: The gossip root IPs struct
Returns
non_neg_integer()
Fetch is an alias for request when no storage is configured.
Parse and validate the API response.
Returns true if postgres storage is enabled.
Returns the postgres table name if configured (primary table for legacy support).
Returns the upsert config for postgres (primary table for legacy support).
Get a random root IP for connection.
Parameters
gossip: The gossip root IPs struct
Returns
{:ok, String.t()}- Random IP{:error, :empty}- No IPs available
@spec rate_limit_cost() :: non_neg_integer()
Get the rate limit cost for this endpoint.
Make the API request and parse the response.
@spec request!() :: t()
Make the API request, raising on error.
Make the API request and return the raw response map (no key transformation).
@spec request_raw!() :: map()
Make the API request returning raw map, raising on error.
Returns true if any storage backend is enabled.
Convert IPs to a list.
Parameters
gossip: The gossip root IPs struct
Returns
- List of IP strings