Struct TickMap 

pub struct TickMap {
    pub liquidity: u128,
    pub max_liquidity_per_tick: u128,
    /* private fields */
}

A tick map implementation for managing liquidity distribution in an AMM (Automated Market Maker).

This structure maintains a mapping of price ticks to liquidity data, allowing efficient navigation and manipulation of concentrated liquidity positions. It tracks active liquidity, global fee growth, and uses a bitmap for efficient tick traversal during swaps.

Fields

liquidity: u128

Current active liquidity

max_liquidity_per_tick: u128

Maximum liquidity that can be concentrated in a single tick based on tick spacing.

Implementations

impl TickMap

pub fn new(tick_spacing: u32) -> Self

Creates a new TickMap with the specified tick spacing.

Panics

Panics if tick_spacing is zero.

pub fn get_tick(&self, tick: i32) -> Option<&PoolTick>

Retrieves a reference to the tick data at the specified tick index.

pub fn get_tick_or_init(&mut self, tick: i32) -> &mut PoolTick

Gets a mutable reference to the tick data, initializing it if it doesn’t exist.

pub fn get_fee_growth_inside( &mut self, lower_tick: i32, upper_tick: i32, current_tick: i32, fee_growth_global_0: U256, fee_growth_global_1: U256, ) -> (U256, U256)

Calculates the fee growth inside a price range defined by lower and upper ticks.

pub fn update( &mut self, tick: i32, tick_current: i32, liquidity_delta: i128, upper: bool, fee_growth_global_0: U256, fee_growth_global_1: U256, ) -> bool

Updates liquidity at a specific tick and manages the tick bitmap.

pub fn cross_tick( &mut self, tick: i32, fee_growth_global_0: U256, fee_growth_global_1: U256, ) -> i128

Crosses a tick during a swap, updating fee growth tracking.

pub fn active_tick_count(&self) -> usize

Returns the number of currently active (initialized) ticks.

pub fn total_tick_count(&self) -> usize

Returns the total number of ticks stored in the map.

pub fn get_all_ticks(&self) -> &AHashMap<i32, PoolTick>

Returns a reference to all ticks in the map for debugging/analysis purposes.

pub fn set_tick(&mut self, tick_data: PoolTick)

Sets the tick data for a specific tick index.

pub fn restore_tick(&mut self, tick_data: PoolTick)

Restores a tick from a snapshot, updating both tick data and bitmap.

This method is used when restoring pool state from a saved snapshot. It sets the tick data and updates the bitmap if the tick is initialized.

pub fn clear(&mut self, tick: i32)

Clears all data in a tick by removing it from the tick map.

pub fn next_initialized_tick(&self, tick: i32, lte: bool) -> (i32, bool)

Finds the next initialized tick after the given tick.

pub fn is_tick_initialized(&self, tick: i32) -> bool

Checks if a tick is initialized in the bitmap.

Trait Implementations

impl Clone for TickMap

fn clone(&self) -> TickMap

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TickMap

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

Formats the value using the given formatter.

impl Default for TickMap

fn default() -> Self

Returns the “default value” for a type.