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

@type t() :: %Hyperliquid.Api.Info.PreTransferCheck{
  fee: String.t(),
  is_sanctioned: boolean(),
  user_exists: boolean(),
  user_has_sent_tx: boolean()
}

Functions

__endpoint_info__()

Returns metadata about this endpoint.

Example

iex> Hyperliquid.Api.Info.PreTransferCheck.__endpoint_info__()
%{
  endpoint: "preTransferCheck",
  type: :info,
  rate_limit_cost: 1,
  params: [:user, :source],
  optional_params: [],
  doc: "Check user existence before transfer",
  returns: "User existence and sanction status"
}

__postgres_tables__()

Returns postgres table configurations (multi-table support).

__storage_config__()

Returns storage configuration for this endpoint.

activation_fee(pre_transfer_check)

@spec activation_fee(t()) :: String.t()

Get activation fee.

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, source)

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

Build the request payload.

cache_enabled?()

Returns true if cache storage is enabled.

cache_ttl()

Returns the cache TTL if configured.

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

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

Creates a changeset for pre-transfer check data.

Parameters

check: The pre-transfer check struct
attrs: Map of attributes to validate

Returns

Ecto.Changeset.t()

fetch(user, source)

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

fetch!(user, source)

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

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

Make the API request and parse the response.

request!(user, source)

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

Make the API request, raising on error.

request_raw(user, source)

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

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

request_raw!(user, source)

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

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

sanctioned?(pre_transfer_check)

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

Check if user is sanctioned.

storage_enabled?()

Returns true if any storage backend is enabled.

user_exists?(pre_transfer_check)

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

Check if user exists.