Struct Pool 

pub struct Pool {
    pub chain: SharedChain,
    pub dex: SharedDex,
    pub address: Address,
    pub instrument_id: InstrumentId,
    pub creation_block: u64,
    pub token0: Token,
    pub token1: Token,
    pub fee: Option<u32>,
    pub tick_spacing: Option<u32>,
    pub initial_tick: Option<i32>,
    pub initial_sqrt_price_x96: Option<U160>,
    pub ts_init: UnixNanos,
}

Represents a liquidity pool in a decentralized exchange.

The instrument ID encodes with the following components: symbol – The pool address. venue – The chain name plus DEX ID.

The string representation therefore has the form: <POOL_ADDRESS>.<CHAIN_NAME>:<DEX_ID>

Example: 0x11b815efB8f581194ae79006d24E0d814B7697F6.Ethereum:UniswapV3

Fields

chain: SharedChain

The blockchain network where this pool exists.

dex: SharedDex

The decentralized exchange protocol that created and manages this pool.

address: Address

The blockchain address of the pool smart contract.

instrument_id: InstrumentId

The instrument ID for the pool.

creation_block: u64

The block number when this pool was created on the blockchain.

token0: Token

The first token in the trading pair.

token1: Token

The second token in the trading pair.

fee: Option<u32>

The trading fee tier used by the pool expressed in hundred-thousandths (1e-6) of one unit – identical to Uniswap-V3’s fee representation.

Examples: • 500 → 0.05 % (5 bps) • 3_000 → 0.30 % (30 bps) • 10_000→ 1.00 %

tick_spacing: Option<u32>

The minimum tick spacing for positions in concentrated liquidity AMMs.

initial_tick: Option<i32>

The initial tick when the pool was first initialized.

initial_sqrt_price_x96: Option<U160>

The initial square root price when the pool was first initialized.

ts_init: UnixNanos

UNIX timestamp (nanoseconds) when the instance was created.

Implementations

impl Pool

pub fn new( chain: SharedChain, dex: SharedDex, address: Address, creation_block: u64, token0: Token, token1: Token, fee: Option<u32>, tick_spacing: Option<u32>, ts_init: UnixNanos, ) -> Self

Creates a new Pool instance with the specified properties.

pub fn to_full_spec_string(&self) -> String

Returns a formatted string representation of the pool for display purposes.

pub fn initialize(&mut self, sqrt_price_x96: U160)

Initializes the pool with the initial tick and square root price.

This method should be called when an Initialize event is processed to set the initial price and tick values for the pool.

pub fn create_instrument_id( chain: Blockchain, dex: &Dex, address: &Address, ) -> InstrumentId

Trait Implementations

impl Clone for Pool

fn clone(&self) -> Pool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Pool

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Pool

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Pool

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

Formats the value using the given formatter.

impl From<Pool> for CurrencyPair

fn from(p: Pool) -> Self

Converts to this type from the input type.

impl From<Pool> for DefiData

fn from(value: Pool) -> Self

Converts to this type from the input type.

impl From<Pool> for InstrumentAny

fn from(p: Pool) -> Self

Converts to this type from the input type.

impl HasTsInit for Pool

fn ts_init(&self) -> UnixNanos

Returns the UNIX timestamp (nanoseconds) when the instance was created.

impl<'py> IntoPyObject<'py> for Pool

type Target = Pool

The Python output type

type Output = Bound<'py, <Pool as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PartialEq for Pool

fn eq(&self, other: &Pool) -> 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 PyClass for Pool

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for Pool

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// Represents a liquidity pool in a decentralized exchange. /// /// The instrument ID encodes with the following components: /// `symbol` – The pool address. /// `venue` – The chain name plus DEX ID. /// /// The string representation therefore has the form: /// `<POOL_ADDRESS>.<CHAIN_NAME>:<DEX_ID>` /// /// Example: /// `0x11b815efB8f581194ae79006d24E0d814B7697F6.Ethereum:UniswapV3`

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<Pool>

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature for Pool

const TEXT_SIGNATURE: &'static str = "(chain, dex, address, creation_block, token0, token1, fee, tick_spacing, ts_init)"

impl<'a, 'holder, 'py> PyFunctionArgument<'a, 'holder, 'py, false> for &'holder Pool

type Holder = Option<PyClassGuard<'a, Pool>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'holder mut Self::Holder, ) -> PyResult<Self>

impl<'a, 'holder, 'py> PyFunctionArgument<'a, 'holder, 'py, false> for &'holder mut Pool

type Holder = Option<PyClassGuardMut<'a, Pool>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'holder mut Self::Holder, ) -> PyResult<Self>

impl PyMethods<Pool> for PyClassImplCollector<Pool>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for Pool

const NAME: &'static str = "Pool"

Class name.

const MODULE: Option<&'static str>

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl Serialize for Pool

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl DerefToPyAny for Pool

impl StructuralPartialEq for Pool