View Source Hyperliquid.Api.Subscription.OutcomeMetaUpdates (hyperliquid v0.3.0)

WebSocket subscription for HIP-4 prediction market metadata changes.

Each event carries a list of updates, where every update is a single-key map naming what changed:

outcomeCreated - a new outcome, with its side specs and quote token
outcomeSettled - an outcome identifier that has settled
questionUpdated - a question's named outcomes or text changed
questionSettled - a question identifier that has settled

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

Usage

{:ok, request} = OutcomeMetaUpdates.build_request()
# => {:ok, %{type: "outcomeMetaUpdates"}}

Summary

Types

request_params()

t()

Functions

__postgres_tables__()

Returns postgres table configurations (multi-table support).

__storage_config__()

Returns storage configuration for this subscription.

__subscription_info__()

Returns metadata about this subscription endpoint.

build_cache_key(event_data)

Build a cache key from event data using the configured pattern.

build_request(params \\ %{})

Build a subscription request.

cache_enabled?()

Returns true if cache storage is enabled.

cache_fields()

Returns the configured cache fields for partial storage, or nil for all fields.

cache_ttl()

Returns the cache TTL if configured.

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

generate_subscription_key(params)

Generate a unique subscription key for this parameter set.

group_updates(arg1)

Split an event's updates by kind.

postgres_enabled?()

Returns true if postgres storage is enabled.

postgres_fields()

Returns the configured postgres fields for partial storage, or nil for all fields.

postgres_table()

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

settled_outcomes(event)

Outcome identifiers that settled in this event.

settled_questions(event)

Question identifiers that settled in this event.

storage_enabled?()

Returns true if any storage backend is enabled.

Types

request_params()

@type request_params() :: %{}

t()

@type t() :: %Hyperliquid.Api.Subscription.OutcomeMetaUpdates{updates: [map()]}

Functions

__postgres_tables__()

Returns postgres table configurations (multi-table support).

__storage_config__()

Returns storage configuration for this subscription.

__subscription_info__()

Returns metadata about this subscription endpoint.

build_cache_key(event_data)

Build a cache key from event data using the configured pattern.

Returns nil if cache is not enabled or no pattern is configured.

build_request(params \\ %{})

@spec build_request(map()) :: {:ok, map()}

Build a subscription request.

Returns

{:ok, request_map} - Subscription request

cache_enabled?()

Returns true if cache storage is enabled.

cache_fields()

Returns the configured cache fields for partial storage, or nil for all fields.

cache_ttl()

Returns the cache TTL if configured.

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

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

generate_subscription_key(params)

@spec generate_subscription_key(map()) :: String.t()

Generate a unique subscription key for this parameter set.

Parameters

params - Map of subscription parameters

Returns

String key that uniquely identifies this subscription variant.

group_updates(arg1)

@spec group_updates(t() | map()) :: %{optional(String.t()) => [map()]}

Split an event's updates by kind.

Parameters

event: The subscription event

Returns

Map keyed by update kind, each holding the payloads of that kind

Examples

OutcomeMetaUpdates.group_updates(event)
# => %{"outcomeCreated" => [...], "questionSettled" => [...]}

postgres_enabled?()

Returns true if postgres storage is enabled.

postgres_fields()

Returns the configured postgres fields for partial storage, or nil for all fields.

postgres_table()

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

settled_outcomes(event)

@spec settled_outcomes(t() | map()) :: [non_neg_integer()]

Outcome identifiers that settled in this event.

Parameters

event: The subscription event

Returns

List of settled outcome identifiers

settled_questions(event)

@spec settled_questions(t() | map()) :: [non_neg_integer()]

Question identifiers that settled in this event.

Parameters

event: The subscription event

Returns

List of settled question identifiers

storage_enabled?()

Returns true if any storage backend is enabled.