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

@type t() :: %Hyperliquid.Api.Info.DelegatorSummary{
  delegated: String.t(),
  n_pending_withdrawals: non_neg_integer(),
  total_pending_withdrawal: String.t(),
  undelegated: String.t()
}

Functions

__endpoint_info__()

Returns metadata about this endpoint.

Example

iex> Hyperliquid.Api.Info.DelegatorSummary.__endpoint_info__()
%{
  endpoint: "delegatorSummary",
  type: :info,
  rate_limit_cost: 2,
  params: [:user],
  optional_params: [],
  doc: "Retrieve summary of user's delegation status",
  returns: "Totals for delegated, undelegated, and pending withdrawal amounts"
}

__postgres_tables__()

Returns postgres table configurations (multi-table support).

__storage_config__()

Returns storage configuration for this endpoint.

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

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

Build the request payload.

cache_enabled?()

Returns true if cache storage is enabled.

cache_ttl()

Returns the cache TTL if configured.

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

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

Creates a changeset for delegator summary data.

Parameters

summary: The delegator summary struct
attrs: Map of attributes to validate

Returns

Ecto.Changeset.t()

delegated_amount(delegator_summary)

@spec delegated_amount(t()) :: {:ok, float()} | {:error, :parse_error}

Get delegated amount as float.

Parameters

summary: The delegator summary struct

Returns

{:ok, float()} - Delegated amount
{:error, :parse_error} - If parsing fails

fetch(user)

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

fetch!(user)

has_pending_withdrawals?(delegator_summary)

@spec has_pending_withdrawals?(t()) :: boolean()

Check if there are pending withdrawals.

Parameters

summary: The delegator summary struct

Returns

boolean()

parse_response(data)

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

Parse and validate the API response.

pending_amount(delegator_summary)

@spec pending_amount(t()) :: {:ok, float()} | {:error, :parse_error}

Get pending withdrawal amount as float.

Parameters

summary: The delegator summary struct

Returns

{:ok, float()} - Pending amount
{:error, :parse_error} - If parsing fails

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

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

Make the API request and parse the response.

request!(user)

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

Make the API request, raising on error.

request_raw(user)

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

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

request_raw!(user)

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

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

storage_enabled?()

Returns true if any storage backend is enabled.

total_balance(delegator_summary)

@spec total_balance(t()) :: {:ok, float()} | {:error, :parse_error}

Get total staking balance (delegated + undelegated).

Parameters

summary: The delegator summary struct

Returns

{:ok, float()} - Total balance
{:error, :parse_error} - If parsing fails