View Source Hyperliquid.Api.Info.GossipPriorityAuctionStatus (hyperliquid v0.3.1)

Status of the gossip priority slot auctions.

The response is a two-element array: the IPs currently holding each priority slot (nil for an unclaimed slot), and the auction status for each slot in the same shape as perpDeployAuctionStatus.

See: https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/priority-fees

Usage

{:ok, status} = GossipPriorityAuctionStatus.request()
GossipPriorityAuctionStatus.slot_holders(status)

Summary

Types

t()

Functions

__endpoint_info__()

Returns metadata about this endpoint.

__postgres_tables__()

Returns postgres table configurations (multi-table support).

__storage_config__()

Returns storage configuration for this endpoint.

auction_for(gossip_priority_auction_status, slot_id)

Auction status for a given slot.

build_cache_key(data)

Build a cache key from response data using the configured pattern. Returns nil if cache is not enabled or no pattern configured.

build_request()

Build the request payload.

cache_enabled?()

Returns true if cache storage is enabled.

cache_ttl()

Returns the cache TTL if configured.

changeset(status \\ %__MODULE__{}, attrs)

Creates a changeset for auction status data.

fetch()

Fetch data and persist to configured storage backends.

fetch!()

Fetch data and persist. Raises on error.

parse_response(data)

Parse and validate the API response.

postgres_enabled?()

Returns true if postgres storage is enabled.

postgres_table()

Returns the postgres table name if configured (primary table for legacy support).

postgres_upsert_config()

Returns the upsert config for postgres (primary table for legacy support).

rate_limit_cost()

Get the rate limit cost for this endpoint.

request()

Make the API request and parse the response.

request!()

Make the API request, raising on error.

request_raw()

Make the API request and return the raw response map (no key transformation).

request_raw!()

Make the API request returning raw map, raising on error.

slot_available?(status, slot_id)

Whether a given slot is currently unclaimed.

slot_holders(gossip_priority_auction_status)

IPs currently holding a priority slot, indexed by slot id.

storage_enabled?()

Returns true if any storage backend is enabled.

Types

t()

@type t() :: %Hyperliquid.Api.Info.GossipPriorityAuctionStatus{
  auctions: [map()],
  slot_holders: [String.t() | nil]
}

Functions

__endpoint_info__()

Returns metadata about this endpoint.

Example

iex> Hyperliquid.Api.Info.GossipPriorityAuctionStatus.__endpoint_info__()
%{
  endpoint: "gossipPriorityAuctionStatus",
  type: :info,
  rate_limit_cost: 2,
  params: [],
  optional_params: [],
  doc: "Retrieve gossip priority slot auction status",
  returns: "Current slot holders and per-slot auction status"
}

__postgres_tables__()

Returns postgres table configurations (multi-table support).

__storage_config__()

Returns storage configuration for this endpoint.

auction_for(gossip_priority_auction_status, slot_id)

@spec auction_for(t(), non_neg_integer()) :: {:ok, map()} | {:error, :not_found}

Auction status for a given slot.

Parameters

status: The auction status struct
slot_id: Slot identifier

Returns

{:ok, auction} if present
{:error, :not_found} otherwise

build_cache_key(data)

Build a cache key from response data using the configured pattern. Returns nil if cache is not enabled or no pattern configured.

build_request()

@spec build_request() :: map()

Build the request payload.

cache_enabled?()

Returns true if cache storage is enabled.

cache_ttl()

Returns the cache TTL if configured.

changeset(status \\ %MODULE{}, attrs)

@spec changeset(t(), map()) :: Ecto.Changeset.t()

Creates a changeset for auction status data.

Parameters

status: The auction status struct
attrs: Map with slot_holders and auctions keys

Returns

Ecto.Changeset.t()

fetch()

@spec fetch() :: {:ok, t()} | {:error, term()}

Fetch data and persist to configured storage backends.

This calls request/0 and then stores the result using Storage.Writer.

fetch!()

@spec fetch!() :: t()

Fetch data and persist. Raises on error.

parse_response(data)

@spec parse_response(map()) :: {:ok, t()} | {:error, term()}

Parse and validate the API response.

postgres_enabled?()

Returns true if postgres storage is enabled.

postgres_table()

Returns the postgres table name if configured (primary table for legacy support).

postgres_upsert_config()

Returns the upsert config for postgres (primary table for legacy support).

rate_limit_cost()

@spec rate_limit_cost() :: non_neg_integer()

Get the rate limit cost for this endpoint.

request()

@spec request() :: {:ok, t()} | {:error, term()}

Make the API request and parse the response.

request!()

@spec request!() :: t()

Make the API request, raising on error.

request_raw()

@spec request_raw() :: {:ok, map()} | {:error, term()}

Make the API request and return the raw response map (no key transformation).

request_raw!()

@spec request_raw!() :: map()

Make the API request returning raw map, raising on error.

slot_available?(status, slot_id)

@spec slot_available?(t(), non_neg_integer()) :: boolean()

Whether a given slot is currently unclaimed.

Parameters

status: The auction status struct
slot_id: Slot identifier

Returns

boolean()

slot_holders(gossip_priority_auction_status)

@spec slot_holders(t()) :: [String.t() | nil]

IPs currently holding a priority slot, indexed by slot id.

Parameters

status: The auction status struct

Returns

List where each element is an IP string or nil

storage_enabled?()

Returns true if any storage backend is enabled.