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

@type t() :: %Hyperliquid.Api.Info.Referral{
  builder_rewards: String.t(),
  claimed_rewards: String.t(),
  cum_vlm: String.t(),
  referred_by: ReferredBy.t() | nil,
  referrer_state: ReferrerState.t() | nil,
  reward_history: [map()],
  token_to_state: [map()],
  unclaimed_rewards: String.t()
}

Functions

__endpoint_info__()

Returns metadata about this endpoint.

Example

iex> Hyperliquid.Api.Info.Referral.__endpoint_info__()
%{
  endpoint: "referral",
  type: :info,
  rate_limit_cost: 1,
  params: [:user],
  optional_params: [],
  doc: "Retrieve referral information for a user",
  returns: "Referral stats, rewards, and referrer state"
}

__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(referral \\ %MODULE{}, attrs)

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

Creates a changeset for referral data.

Parameters

referral: The referral struct
attrs: Map of attributes to validate

Returns

Ecto.Changeset.t()

fetch(user)

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

fetch!(user)

has_unclaimed_rewards?(referral)

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

Check if user has unclaimed rewards.

Parameters

referral: The referral struct

Returns

boolean()

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.

referral_code(arg1)

@spec referral_code(t()) :: {:ok, String.t()} | {:error, :no_code}

Get the referral code if user is a referrer.

Parameters

referral: The referral struct

Returns

{:ok, String.t()} if has code
{:error, :no_code} if not a referrer

referrer(referral)

@spec referrer(t()) :: {:ok, String.t()} | {:error, :not_referred}

Get the referrer address.

Parameters

referral: The referral struct

Returns

{:ok, String.t()} if referred
{:error, :not_referred} if not referred

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_rewards(referral)

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

Get total rewards (claimed + unclaimed).

Parameters

referral: The referral struct

Returns

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

was_referred?(referral)

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

Check if user was referred.

Parameters

referral: The referral struct

Returns

boolean()