Struct ProtocolStreamBuilder 

pub struct ProtocolStreamBuilder { /* private fields */ }

Builds and configures the multi protocol stream described in the module-level docs.

See the module documentation for details on protocols, configuration options, and stream behavior.

Implementations

impl ProtocolStreamBuilder

pub fn new(tycho_url: &str, chain: Chain) -> Self

Creates a new builder for a multi-protocol stream.

See the module-level docs for full details on stream behavior and configuration.

pub fn exchange<T>( self, name: &str, filter: ComponentFilter, filter_fn: Option<fn(&ComponentWithState) -> bool>, ) -> Self

where T: ProtocolSim + TryFromWithBlock<ComponentWithState, BlockHeader, Error = InvalidSnapshotError> + Send + 'static,

Adds a specific exchange to the stream.

This configures the builder to include a new protocol synchronizer for name, filtering its components according to filter and optionally filter_fn.

The type parameter T specifies the decoder type for this exchange. All component states for this exchange will be decoded into instances of T.

Parameters

• name: The protocol or exchange name (e.g., "uniswap_v4", "vm:balancer_v2").
• filter: Defines the set of components to include in the stream.
• filter_fn: Optional custom filter function for client-side filtering of components not expressible in filter.

Notes

For certain protocols (e.g., "uniswap_v4", "vm:balancer_v2", "vm:curve"), omitting filter_fn may cause decoding errors or incorrect results. In these cases, a proper filter function is required to ensure correct decoding and quoting logic.

pub fn exchange_with_decoder_context<T>( self, name: &str, filter: ComponentFilter, filter_fn: Option<fn(&ComponentWithState) -> bool>, decoder_context: DecoderContext, ) -> Self

where T: ProtocolSim + TryFromWithBlock<ComponentWithState, BlockHeader, Error = InvalidSnapshotError> + Send + 'static,

Adds a specific exchange to the stream with decoder context.

This configures the builder to include a new protocol synchronizer for name, filtering its components according to filter and optionally filter_fn. It also registers the DecoderContext (this is useful to test protocols that are not live yet)

The type parameter T specifies the decoder type for this exchange. All component states for this exchange will be decoded into instances of T.

Parameters

• name: The protocol or exchange name (e.g., "uniswap_v4", "vm:balancer_v2").
• filter: Defines the set of components to include in the stream.
• filter_fn: Optional custom filter function for client-side filtering of components not expressible in filter.
• decoder_context: The decoder context for this exchange

Notes

For certain protocols (e.g., "uniswap_v4", "vm:balancer_v2", "vm:curve"), omitting filter_fn may cause decoding errors or incorrect results. In these cases, a proper filter function is required to ensure correct decoding and quoting logic.

pub fn block_time(self, block_time: u64) -> Self

Sets the block time interval for the stream.

This controls how often the stream produces updates.

pub fn timeout(self, timeout: u64) -> Self

👎Deprecated: Use latency_buffer instead

Sets the network operation timeout (deprecated).

Use [latency_buffer] instead for controlling latency. This method is retained for backwards compatibility.

pub fn latency_buffer(self, timeout: u64) -> Self

Sets the latency buffer to aggregate same-block messages.

This allows the supervisor to wait a short interval for all synchronizers to emit before aggregating.

pub fn max_missed_blocks(self, n: u64) -> Self

Sets the maximum number of blocks a synchronizer may miss before being marked as Stale.

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

Sets how long a synchronizer may take to process the initial message.

Useful for data-intensive protocols where startup decoding takes longer.

pub fn no_state(self, no_state: bool) -> Self

Configures the stream to exclude state updates.

This reduces bandwidth and decoding workload if protocol state is not of interest (e.g. only process new tokens).

pub fn auth_key(self, auth_key: Option<String>) -> Self

Sets the API key for authenticating with the Tycho server.

pub fn no_tls(self, no_tls: bool) -> Self

Disables TLS/ SSL for the connection, using http and ws protocols.

This is not recommended for production use.

pub fn disable_compression(self) -> Self

Disable compression for the connection.

pub fn stream_end_policy(self, stream_end_policy: StreamEndPolicy) -> Self

Sets the stream end policy.

Controls when the stream should stop based on synchronizer states.

Note

The stream always ends latest if all protocols are stale or ended independent of this configuration. This allows you to end the stream earlier than that.

See self::StreamEndPolicy for possible configuration options.

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

Sets the initial tokens to consider during decoding.

Only components containing these tokens will be decoded initially. New tokens may be added automatically if they meet the quality threshold.

pub fn skip_state_decode_failures(self, skip: bool) -> Self

Skips decoding errors for component state updates.

Allows the stream to continue processing even if some states fail to decode, logging a warning instead of panicking.

pub fn websocket_retry_config(self, config: &RetryConfiguration) -> Self

Configures the retry policy for websocket reconnects.

pub fn state_synchronizer_retry_config( self, config: &RetryConfiguration, ) -> Self

Configures the retry policy for state synchronization.

pub fn get_decoder(&self) -> &TychoStreamDecoder<BlockHeader>

pub async fn build( self, ) -> Result<impl Stream<Item = Result<Update, StreamDecodeError>>, StreamError>

Builds and returns the configured protocol stream.

See the module-level docs for details on stream behavior and emitted messages. This method applies all builder settings and starts the stream.