Bourse.WS.Channels (bourse v0.1.0)

Spec-driven WebSocket channel formatting from websocket.subscribe.channels.

Maps unified watch_* methods to exchange-native channel strings (or OKX-style channel objects) using authored template strings.

When a method has no resolvable templates or carries a non-nil _unresolved_reason, pass the pre-formatted channel via channel: in opts (honest pass-through — no guessing).

Summary

Types

build_error()

channel()

params()

subscription_settings()

Functions

build(exchange, method, params, opts \\ [])

Builds the exchange-native channel(s) for a unified watch method.

private?(method)

Returns whether the unified watch method requires a private WS connection.

Types

build_error()

@type build_error() ::
  :unsupported_method
  | :missing_symbol
  | :no_channel_templates
  | {:unresolved, String.t()}

channel()

@type channel() :: String.t() | map()

params()

@type params() :: %{
  optional(:symbol) => String.t(),
  optional(:limit) => non_neg_integer(),
  optional(:timeframe) => String.t()
}

subscription_settings()

@type subscription_settings() :: {atom() | nil, map()}

Functions

build(exchange, method, params, opts \\ [])

@spec build(Bourse.Exchange.t(), atom(), params(), keyword()) ::
  {:ok, channel()} | {:error, build_error()}

Builds the exchange-native channel(s) for a unified watch method.

Reads templates from exchange.spec["websocket"]["subscribe"]["channels"]. Returns a single channel value (string or map) suitable for Bourse.WS.subscribe/3.

Pass channel: in opts to supply a pre-formatted channel when templates are missing or flagged with _unresolved_reason.

private?(method)

@spec private?(atom()) :: boolean()

Returns whether the unified watch method requires a private WS connection.