Struct PoolPosition 

pub struct PoolPosition {
    pub owner: Address,
    pub tick_lower: i32,
    pub tick_upper: i32,
    pub liquidity: u128,
    pub fee_growth_inside_0_last: U256,
    pub fee_growth_inside_1_last: U256,
    pub tokens_owed_0: u128,
    pub tokens_owed_1: u128,
    pub total_amount0_deposited: U256,
    pub total_amount1_deposited: U256,
    pub total_amount0_collected: u128,
    pub total_amount1_collected: u128,
}

Represents a concentrated liquidity position in a DEX pool.

This struct tracks a specific liquidity provider’s position within a price range, including the liquidity amount, fee accumulation, and token deposits/withdrawals.

Fields

owner: Address

The owner of the position

tick_lower: i32

The lower tick boundary of the position

tick_upper: i32

The upper tick boundary of the position

liquidity: u128

The amount of liquidity in the position

fee_growth_inside_0_last: U256

Fee growth per unit of liquidity for token0 as of the last action on the position

fee_growth_inside_1_last: U256

Fee growth per unit of liquidity for token1 as of the last action on the position

tokens_owed_0: u128

The fees owed to the position for token0

tokens_owed_1: u128

The fees owed to the position for token1

total_amount0_deposited: U256

Total amount of token0 deposited into this position

total_amount1_deposited: U256

Total amount of token1 deposited into this position

total_amount0_collected: u128

Total amount of token0 collected from this position

total_amount1_collected: u128

Total amount of token1 collected from this position

Implementations

impl PoolPosition

pub fn new( owner: Address, tick_lower: i32, tick_upper: i32, liquidity: i128, ) -> Self

Creates a PoolPosition with the specified parameters.

pub fn get_position_key( owner: &Address, tick_lower: i32, tick_upper: i32, ) -> String

Generates a unique string key for a position based on owner and tick range.

pub fn update_liquidity(&mut self, liquidity_delta: i128)

Updates the liquidity amount by the given delta.

Positive values increase liquidity, negative values decrease it. Uses saturating arithmetic to prevent underflow.

pub fn update_fees( &mut self, fee_growth_inside_0: U256, fee_growth_inside_1: U256, )

Updates the position’s fee tracking based on current fee growth inside the position’s range.

Calculates the fees earned since the last update and adds them to tokens_owed. Updates the last known fee growth values for future calculations.

pub fn collect_fees(&mut self, amount0: u128, amount1: u128)

Collects fees owed to the position, up to the requested amounts.

Reduces tokens_owed by the collected amounts and tracks total collections. Cannot collect more than what is currently owed.

pub fn update_amounts( &mut self, liquidity_delta: i128, amount0: U256, amount1: U256, )

Updates position token amounts based on liquidity delta.

For positive liquidity delta (mint), tracks deposited amounts. For negative liquidity delta (burn), adds amounts to tokens owed.

pub fn is_empty(&self) -> bool

Checks if the position is completely empty.

Trait Implementations

impl Clone for PoolPosition

fn clone(&self) -> PoolPosition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PoolPosition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PoolPosition

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'py> IntoPyObject<'py> for PoolPosition

type Target = PoolPosition

The Python output type

type Output = Bound<'py, <PoolPosition 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 PoolPosition

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

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for PoolPosition

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 concentrated liquidity position in a DEX pool. /// /// This struct tracks a specific liquidity provider's position within a price range, /// including the liquidity amount, fee accumulation, and token deposits/withdrawals.

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<PoolPosition>

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<'a, 'holder, 'py> PyFunctionArgument<'a, 'holder, 'py, false> for &'holder PoolPosition

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

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 PoolPosition

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

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

impl PyTypeInfo for PoolPosition

const NAME: &'static str = "PoolPosition"

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 PoolPosition

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 PoolPosition

impl StructuralPartialEq for PoolPosition