View Source Hyperliquid.Api.Info.PerpDeployAuctionStatus (hyperliquid v0.2.2)

@type t() :: %Hyperliquid.Api.Info.PerpDeployAuctionStatus{
  current_gas: String.t(),
  duration_seconds: non_neg_integer(),
  end_gas: String.t() | nil,
  start_gas: String.t(),
  start_time_seconds: non_neg_integer()
}

Functions

__endpoint_info__()

Returns metadata about this endpoint.

Example

iex> Hyperliquid.Api.Info.PerpDeployAuctionStatus.__endpoint_info__()
%{
  endpoint: "perpDeployAuctionStatus",
  type: :info,
  rate_limit_cost: 1,
  params: [],
  optional_params: [],
  doc: "Retrieve perpetual deployment auction status",
  returns: "Current gas auction information for deploying new perpetuals"
}

__postgres_tables__()

Returns postgres table configurations (multi-table support).

__storage_config__()

Returns storage configuration for this endpoint.

active?(perp_deploy_auction_status, current_time)

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

Check if the auction is currently active.

Parameters

status: The auction status struct
current_time: Current time in seconds (Unix timestamp)

Returns

boolean()

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 perp deploy auction status data.

Parameters

status: The auction status struct
attrs: Map of attributes to validate

Returns

Ecto.Changeset.t()

end_time_seconds(perp_deploy_auction_status)

@spec end_time_seconds(t()) :: non_neg_integer()

Get the end time of the auction in seconds.

Parameters

status: The auction status struct

Returns

non_neg_integer()

fetch()

Fetch is an alias for request when no storage is configured.

fetch!()

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.

remaining_seconds(status, current_time)

@spec remaining_seconds(t(), non_neg_integer()) :: integer()

Get remaining time in the auction in seconds.

Parameters

status: The auction status struct
current_time: Current time in seconds (Unix timestamp)

Returns

integer() - Can be negative if auction has ended

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.

storage_enabled?()

Returns true if any storage backend is enabled.