Struct cyclos_core::states::tick_bitmap::TickBitmapState

#[repr(packed)]
pub struct TickBitmapState {
    pub bump: u8,
    pub word_pos: i16,
    pub word: [u64; 4],
}

Stores info for a single bitmap word. Each word represents 256 packed tick initialized boolean values.

Emulates a solidity mapping, where word_position is the key and

PDA of [BITMAP_SEED, token_0, token_1, fee, word_pos]

Fields

bump: u8

Bump to identify PDA

word_pos: i16

The bitmap key. To find word position from a tick, divide the tick by tick spacing to get a 24 bit compressed result, then right shift to obtain the most significant 16 bits.

word: [u64; 4]

Packed initialized state

Implementations

impl TickBitmapState

pub fn flip_bit(&mut self, bit_pos: u8)

Flips the initialized state for a given bit from false to true, or vice versa

Arguments

• self - The bitmap state corresponding to the tick’s word position
• bit_pos - The rightmost 8 bits of the tick

pub fn next_initialized_bit(&self, bit_pos: u8, lte: bool) -> NextBit

Returns the bitmap index (0 - 255) for the next initialized tick.

If no initialized tick is available, returns the first bit (index 0) the word in lte case, and the last bit in gte case.

Unlike Uniswap, this checks for equality in lte = false case. Externally ensure that compressed + 1 is used to derive the word_pos(for bitmap account) and bit_pos.

Obtain the actual tick using

(next + 255 * word_pos) * spacing

Arguments

• self - The mapping in which to compute the next initialized tick
• bit_pos - The starting bit position
• lte - Whether to search for the next initialized tick to the left (less than or equal to the starting tick)

Trait Implementations

impl AccountDeserialize for TickBitmapState

fn try_deserialize(buf: &mut &[u8]) -> Result<Self>

Deserializes previously initialized account data. Should fail for all uninitialized accounts, where the bytes are zeroed. Implementations should be unique to a particular account type so that one can never successfully deserialize the data of one account type into another. For example, if the SPL token program were to implement this trait, it should be impossible to deserialize a Mint account into a token Account.

fn try_deserialize_unchecked(buf: &mut &[u8]) -> Result<Self>

Deserializes account data without checking the account discriminator. This should only be used on account initialization, when the bytes of the account are zeroed.

impl Clone for TickBitmapState

fn clone(&self) -> TickBitmapState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for TickBitmapState

fn default() -> TickBitmapState

Returns the “default value” for a type.

impl Discriminator for TickBitmapState

fn discriminator() -> [u8; 8]

impl Owner for TickBitmapState

fn owner() -> Pubkey

impl Zeroable for TickBitmapState

fn zeroed() -> Self

Calls zeroed.

impl Copy for TickBitmapState

impl Pod for TickBitmapState

impl ZeroCopy for TickBitmapState