Struct TychoStreamDecoder 

pub struct TychoStreamDecoder<H>
where
    H: HeaderLike,
{ /* private fields */ }

A decoder to process raw messages.

This struct decodes incoming messages of type FeedMessage and converts it into the BlockUpdate struct.

Important:

• Supports registering exchanges and their associated filters for specific protocol components.
• Allows the addition of client-side filters for custom conditions.

Note: The tokens provided during configuration will be used for decoding, ensuring efficient handling of protocol components. Protocol components containing tokens which are not included in this initial list, or added when applying deltas, will not be decoded.

Implementations

impl<H> TychoStreamDecoder<H>

where H: HeaderLike + Clone + Sync + Send + 'static + Debug,

pub fn new() -> Self

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

Sets the currently known tokens which will be considered during decoding.

Protocol components containing tokens which are not included in this initial list, or added when applying deltas, will not be decoded.

pub fn skip_state_decode_failures(&mut self, skip: bool)

pub fn register_decoder_with_context<T>( &mut self, exchange: &str, context: DecoderContext, )

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

Registers a decoder for a given exchange with a decoder context.

This method maps an exchange identifier to a specific protocol simulation type. The associated type must implement the TryFromWithBlock trait to enable decoding of state updates from ComponentWithState objects. This allows the decoder to transform the component data into the appropriate protocol simulation type based on the current blockchain state and the provided block header. For example, to register a decoder for the uniswap_v2 exchange with an additional decoder context, you must call this function with register_decoder_with_context::<UniswapV2State>("uniswap_v2", context). This ensures that the exchange ID uniswap_v2 is properly associated with the UniswapV2State decoder for use in the protocol stream.

pub fn register_decoder<T>(&mut self, exchange: &str)

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

Registers a decoder for a given exchange.

This method maps an exchange identifier to a specific protocol simulation type. The associated type must implement the TryFromWithBlock trait to enable decoding of state updates from ComponentWithState objects. This allows the decoder to transform the component data into the appropriate protocol simulation type based on the current blockchain state and the provided block header. For example, to register a decoder for the uniswap_v2 exchange, you must call this function with register_decoder::<UniswapV2State>("uniswap_v2", vm_attributes). This ensures that the exchange ID uniswap_v2 is properly associated with the UniswapV2State decoder for use in the protocol stream.

pub fn register_filter( &mut self, exchange: &str, predicate: fn(&ComponentWithState) -> bool, )

Registers a client-side filter function for a given exchange.

Associates a filter function with an exchange ID, enabling custom filtering of protocol components. The filter function is applied client-side to refine the data received from the stream. It can be used to exclude certain components based on attributes or conditions that are not supported by the server-side filtering logic. This is particularly useful for implementing custom behaviors, such as:

• Filtering out pools with specific attributes (e.g., unsupported features).
• Blacklisting pools based on custom criteria.
• Excluding pools that do not meet certain requirements (e.g., token pairs or liquidity constraints).

For example, you might use a filter to exclude pools that are not fully supported in the protocol, or to ignore pools with certain attributes that are irrelevant to your application.

pub async fn decode( &self, msg: &FeedMessage<H>, ) -> Result<Update, StreamDecodeError>

Decodes a FeedMessage into a BlockUpdate containing the updated states of protocol components

Trait Implementations

impl<H> Default for TychoStreamDecoder<H>

where H: HeaderLike + Clone + Sync + Send + 'static + Debug,

fn default() -> Self

Returns the “default value” for a type.