Struct PriceLevelStreamBuilder 

pub struct PriceLevelStreamBuilder { /* private fields */ }

Builds a stream of Updates from the Titan pAMM price level WebSocket.

A new builder serves no pAMMs: register the known venues via with_known_pamms, individual ones via add_pamm, or opt into serving unknown streamed venues via auto_detect; with_tokens provides the token metadata pairs are interpreted with.

One component is emitted per (pAMM, token pair), identified by the concatenation pamm ++ token0 ++ token1 (tokens sorted ascending), under the protocol system pricelevelstream:{pamm} — or propammfallback:{pamm} for venues on the PropAMMRouter whitelist, unless without_fallback_router turns that off. The venue address is exposed through the PAMM_ADDRESS_ATTRIBUTE static attribute for downstream encoding.

Implementations

impl PriceLevelStreamBuilder

pub fn new() -> Self

pub fn auto_detect(self, enabled: bool) -> Self

Enables serving pAMMs that are not registered via with_known_pamms or add_pamm (disabled by default).

When enabled, any unknown streamed venue — except denied ones (see deny_pamm) — is served under its full lowercase hex address as the name, with the default gas cost. A venue’s protocol system therefore changes from the address form (pricelevelstream:{0xaddress}) to a name (pricelevelstream:{name}) once it gets registered — via add_pamm or a release’s default_served_pamms recognizing it; the name-independent identifiers — the component id and the PAMM_ADDRESS_ATTRIBUTE — stay stable across such renames.

pub fn auto_detected_gas_cost(self, gas_cost: BigUint) -> Self

Overrides the per-swap gas cost that auto-detected pAMMs (see auto_detect) are served with. Defaults to the maximum over the known venue profiles, as the conservative choice. Registered venues are unaffected — their gas cost comes from their PriceLevelStreamConfig.

pub fn endpoint(self, url: impl Into<String>) -> Self

Overrides the stream endpoint, e.g. to connect to a closer Titan region than the default (see https://docs.titanbuilder.xyz/propamms/takers).

pub fn connect_timeout(self, timeout: Duration) -> Self

Overrides how long a single connection attempt may take before it is aborted and retried (default: 10s), so a hung TCP/TLS handshake cannot block the stream forever.

pub fn read_idle_timeout(self, timeout: Duration) -> Self

Overrides the longest gap between Titan messages tolerated before the connection is treated as dead and re-established (default: 30s). Titan pushes several updates per second, so a multi-second silence means a stalled or half-open connection.

pub fn max_backoff(self, max_backoff: Duration) -> Self

Overrides the cap on the exponential reconnect backoff of 2^attempt seconds (default: 32s).

pub fn add_pamm(self, config: PriceLevelStreamConfig) -> Self

Registers a pAMM to be served under the given configuration, overriding any default, denied, or auto-detected one for the same address.

Between add_pamm and deny_pamm for the same address, the later call wins; the defaults applied by with_known_pamms never override either, in any call order.

pub fn deny_pamm(self, address: Bytes) -> Self

Excludes a venue from being served: drops its current registration (default or explicit) and blocks auto-detecting it.

Between add_pamm and deny_pamm for the same address, the later call wins; the defaults applied by with_known_pamms never override either, in any call order — so denying a venue from the default set works whether the denial comes before or after with_known_pamms.

pub fn with_known_pamms(self) -> Self

Applies what is known about the streamed venues: registers the known-good ones (default_served_pamms) to be served and denies the known-bad ones (default_denied_pamms) — venues that stream quotes but whose swaps are not executable.

These defaults never override an explicit add_pamm or deny_pamm for the same address, regardless of call order.

pub fn with_tokens(self, tokens: HashMap<Bytes, Token>) -> Self

Provides the token metadata used to build components and interpret amounts. Pairs whose tokens are missing here are skipped.

pub fn without_fallback_router(self) -> Self

Keeps every venue on the direct pricelevelstream:{name} path, so swaps execute on the venues themselves and a stale maker quote reverts the route.

By default build emits venues on Titan’s PropAMMRouter whitelist under propammfallback:{name} instead, so tycho-execution routes their swaps through the router. Opt out when the direct call is what you want to measure or execute, or to skip the whitelist read at startup.

pub fn build(self) -> impl Stream<Item = Update> + Send

Consumes the builder and opens the stream.

Venues on Titan’s PropAMMRouter whitelist are served under propammfallback:{name}, so tycho-execution routes their swaps through the router. The router falls back to a single-hop Uniswap V3 pool when the venue reverts — which a stale maker quote does in any simulation against a mined block. Only whitelisted venues may use the family: the router reverts UnknownVenue for others, so every swap would execute on the Uniswap V3 fallback at a worse price than the venue gives.

Reading that whitelist needs a node at RPC_URL (from the environment, falling back to .env), and degrades instead of failing: without the variable, or when the read fails, a warning is logged and every venue stays on the direct pricelevelstream: path. without_fallback_router skips the read and takes the direct path unconditionally.

The whitelist is read once, on the first poll, and never re-read — it is governance-gated and changes rarely, and renaming a running component’s protocol system would churn every consumer’s component set. Restart the stream to pick up a whitelist change.

The connection is established lazily on first poll and maintained (with reconnects) for as long as the stream is polled; it never terminates on its own, and dropping the stream closes the connection. Frames that contain no served pAMM produce no update.

Each streamed frame is a complete snapshot of everything Titan currently streams, so every update carries the full set of the frame’s pair states, with new_pairs / removed_pairs derived by diffing against the previous frame — a pair (or a whole venue) the stream stops serving is removed. Frames older than an already processed one are skipped, so updates never move backwards in block number. Pairs whose tokens are missing from the provided token metadata are skipped.

Trait Implementations

impl Default for PriceLevelStreamBuilder

fn default() -> Self

Returns the “default value” for a type.