View Source Hyperliquid.Api.Explorer.BlockDetails (hyperliquid v0.2.2)

Block details from the Hyperliquid L1 explorer.

Returns information about a specific block including transactions and metadata.

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

Usage 

{:ok, block} = BlockDetails.request(12345)
tx_count = BlockDetails.tx_count(block)

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.

block_datetime(arg1)

Get block time as DateTime.

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(height)

Build the request payload.

cache_enabled?()

Returns true if cache storage is enabled.

cache_ttl()

Returns the cache TTL if configured.

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

Creates a changeset for block details data.

empty?(details)

Check if block is empty (no transactions).

fetch(height)

Fetch data and persist to configured storage backends.

fetch!(height)

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(height)

Make the API request and parse the response.

request!(height)

Make the API request, raising on error.

request_raw(height)

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

request_raw!(height)

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

storage_enabled?()

Returns true if any storage backend is enabled.

tx_count(arg1)

Get the number of transactions in the block.

Types

Link to this type

t()

View Source 
@type t() :: %Hyperliquid.Api.Explorer.BlockDetails{
  block_number: non_neg_integer(),
  block_time: non_neg_integer(),
  hash: String.t(),
  prev_hash: String.t(),
  proposer: String.t() | nil,
  txs: [map()]
}

Functions

Link to this function

__endpoint_info__()

View Source

Returns metadata about this endpoint.

Example 

iex> Hyperliquid.Api.Explorer.BlockDetails.__endpoint_info__()
%{
  endpoint: "blockDetails",
  type: :explorer,
  rate_limit_cost: 2,
  params: [:height],
  optional_params: [],
  doc: "Retrieve block details by height",
  returns: "Block with transactions, hash, and metadata"
}
Link to this function

__postgres_tables__()

View Source

Returns postgres table configurations (multi-table support).

Link to this function

__storage_config__()

View Source

Returns storage configuration for this endpoint.

Link to this function

block_datetime(arg1)

View Source 
@spec block_datetime(t()) :: {:ok, DateTime.t()} | {:error, :invalid_time}

Get block time as DateTime.

Parameters

  • details: The block details struct

Returns

  • {:ok, DateTime.t()} if valid
  • {:error, :invalid_time} if invalid
Link to this function

build_cache_key(data)

View Source

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

Link to this function

build_request(height)

View Source 
@spec build_request(term()) :: map()

Build the request payload.

Link to this function

cache_enabled?()

View Source

Returns true if cache storage is enabled.

Link to this function

cache_ttl()

View Source

Returns the cache TTL if configured.

Link to this function

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

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

Creates a changeset for block details data.

Link to this function

empty?(details)

View Source 
@spec empty?(t()) :: boolean()

Check if block is empty (no transactions).

Parameters

  • details: The block details struct

Returns

  • boolean()
Link to this function

fetch(height)

View Source

Fetch data and persist to configured storage backends.

This calls request/N and then stores the result using Storage.Writer. Request params are merged into stored data for cache key generation.

Link to this function

fetch!(height)

View Source

Fetch data and persist. Raises on error.

Link to this function

parse_response(data)

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

Parse and validate the API response.

Link to this function

postgres_enabled?()

View Source

Returns true if postgres storage is enabled.

Link to this function

postgres_table()

View Source

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

Link to this function

postgres_upsert_config()

View Source

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

Link to this function

rate_limit_cost()

View Source 
@spec rate_limit_cost() :: non_neg_integer()

Get the rate limit cost for this endpoint.

Link to this function

request(height)

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

Make the API request and parse the response.

Link to this function

request!(height)

View Source 
@spec request!(term()) :: t()

Make the API request, raising on error.

Link to this function

request_raw(height)

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

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

Link to this function

request_raw!(height)

View Source 
@spec request_raw!(term()) :: map()

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

Link to this function

storage_enabled?()

View Source

Returns true if any storage backend is enabled.

Link to this function

tx_count(arg1)

View Source 
@spec tx_count(t()) :: non_neg_integer()

Get the number of transactions in the block.

Parameters

  • details: The block details struct

Returns

  • non_neg_integer()