Enum PoolIdentifier 

pub enum PoolIdentifier {
    Address(Ustr),
    PoolId(Ustr),
}

Protocol-aware pool identifier for DeFi liquidity pools.

This enum distinguishes between two types of pool identifiers:

• Address: Used by V2/V3 protocols where pool identifier equals pool contract address (42 chars: “0x” + 40 hex)
• PoolId: Used by V4 protocols where pool identifier is a bytes32 hash (66 chars: “0x” + 64 hex)

The type implements case-insensitive equality and hashing for address comparison, while preserving the original case for display purposes.

DeFi pool data carries both this PoolIdentifier and an InstrumentId, which key different layers. The chain and database layers key on the PoolIdentifier: the raw on-chain identity used for log filters and table lookups. The engine, message bus, and cache key on the InstrumentId (Symbol(pool_identifier) at Venue(chain:dex)), so pool events flow through the same instrument-keyed infrastructure as any other data. The InstrumentId flattens the identifier to a string and loses the Address versus PoolId variant, so it cannot reconstruct this type: both are stored rather than derived.

Variants

Address(Ustr)

V2/V3 pool identifier (checksummed Ethereum address)

PoolId(Ustr)

V4 pool identifier (32-byte pool ID as hex string)

Implementations

impl PoolIdentifier

pub fn new_checked<T: AsRef<str>>(value: T) -> Result<Self>

Creates a new PoolIdentifier instance with correctness checking.

Automatically detects variant based on string length:

• 42 characters (0x + 40 hex): Address variant
• 66 characters (0x + 64 hex): PoolId variant

Errors

Returns an error if:

• String doesn’t start with “0x”
• Length is neither 42 nor 66 characters
• Contains invalid hex characters
• Address checksum validation fails (for Address variant)

pub fn new<T: AsRef<str>>(value: T) -> Self

Creates a new PoolIdentifier instance.

Panics

Panics if validation fails.

pub fn from_address(address: Address) -> Self

Creates an Address variant from an alloy Address.

Returns the checksummed representation.

pub fn from_pool_id_bytes(bytes: &[u8]) -> Result<Self>

Creates a PoolId variant from raw bytes (32 bytes).

Errors

Returns an error if bytes length is not 32.

pub fn from_pool_id_hex<T: AsRef<str>>(hex: T) -> Result<Self>

Creates a PoolId variant from a hex string (with or without 0x prefix).

Errors

Returns an error if the string is not valid 64-character hex.

pub fn inner(&self) -> Ustr

Returns the inner identifier value as a Ustr.

pub fn as_str(&self) -> &str

Returns the inner identifier value as a string slice.

pub fn is_address(&self) -> bool

Returns true if this is an Address variant (V2/V3 pools).

pub fn is_pool_id(&self) -> bool

Returns true if this is a PoolId variant (V4 pools).

pub fn to_address(&self) -> Result<Address>

Converts to native Address type (V2/V3 pools only).

Returns the underlying Address for use with alloy/ethers operations.

Errors

Returns error if this is a PoolId variant or if parsing fails.

pub fn to_pool_id_bytes(&self) -> Result<[u8; 32]>

Converts to native bytes array (V4 pools only).

Returns the 32-byte pool ID for use in V4-specific operations.

Errors

Returns error if this is an Address variant or if hex decoding fails.

Trait Implementations

impl AsRef<str> for PoolIdentifier

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for PoolIdentifier

fn clone(&self) -> PoolIdentifier

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for PoolIdentifier

impl Debug for PoolIdentifier

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PoolIdentifier

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PoolIdentifier

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for PoolIdentifier

impl From<&str> for PoolIdentifier

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<String> for PoolIdentifier

fn from(value: String) -> Self

Converts to this type from the input type.

impl FromStr for PoolIdentifier

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for PoolIdentifier

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for PoolIdentifier

fn cmp(&self, other: &PoolIdentifier) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for PoolIdentifier

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for PoolIdentifier

fn partial_cmp(&self, other: &PoolIdentifier) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for PoolIdentifier

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.