View Source Hyperliquid.Api.Info.UsdcRouting (hyperliquid v0.3.0)

Current USDC deposit and withdrawal routing.

Each route is either "bridge" (the native Arbitrum bridge) or "cctp" (Circle's Cross-Chain Transfer Protocol). The routes can change independently, so check the one for the direction you care about.

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

Usage 

{:ok, routing} = UsdcRouting.request()
UsdcRouting.deposit_via_cctp?(routing)

Summary

Types

route()
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.

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

Build the request payload.

cache_enabled?()

Returns true if cache storage is enabled.

cache_ttl()

Returns the cache TTL if configured.

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

Creates a changeset for USDC routing data.

deposit_via_cctp?(usdc_routing)

Whether deposits currently route over CCTP.

fetch()

Fetch data and persist to configured storage backends.

fetch!()

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

Make the API request and parse the response.

request!()

Make the API request, raising on error.

request_raw()

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

request_raw!()

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

routes()

Known routing values.

storage_enabled?()

Returns true if any storage backend is enabled.

withdrawal_via_cctp?(usdc_routing)

Whether withdrawals currently route over CCTP.

Types

Link to this type

route()

View Source 
@type route() :: String.t()
Link to this type

t()

View Source 
@type t() :: %Hyperliquid.Api.Info.UsdcRouting{
  deposit_route: route() | nil,
  withdrawal_route: route() | nil
}

Functions

Link to this function

__endpoint_info__()

View Source

Returns metadata about this endpoint.

Example 

iex> Hyperliquid.Api.Info.UsdcRouting.__endpoint_info__()
%{
  endpoint: "usdcRouting",
  type: :info,
  rate_limit_cost: 2,
  params: [],
  optional_params: [],
  doc: "Retrieve current USDC deposit and withdrawal routing",
  returns: "Deposit and withdrawal routes, each bridge or cctp"
}
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

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

View Source 
@spec build_request() :: 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(routing \\ %__MODULE__{}, attrs)

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

Creates a changeset for USDC routing data.

Parameters

  • routing: The routing struct
  • attrs: Map of attributes

Returns

  • Ecto.Changeset.t()
Link to this function

deposit_via_cctp?(usdc_routing)

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

Whether deposits currently route over CCTP.

Parameters

  • routing: The routing struct

Returns

  • boolean()
Link to this function

fetch()

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

Fetch data and persist to configured storage backends.

This calls request/0 and then stores the result using Storage.Writer.

Link to this function

fetch!()

View Source 
@spec fetch!() :: t()

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

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

Make the API request and parse the response.

Link to this function

request!()

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

Make the API request, raising on error.

Link to this function

request_raw()

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

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

Link to this function

request_raw!()

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

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

Link to this function

routes()

View Source 
@spec routes() :: [route()]

Known routing values.

Returns

  • List of valid route strings
Link to this function

storage_enabled?()

View Source

Returns true if any storage backend is enabled.

Link to this function

withdrawal_via_cctp?(usdc_routing)

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

Whether withdrawals currently route over CCTP.

Parameters

  • routing: The routing struct

Returns

  • boolean()