Struct cyclos_core::states::oracle::ObservationState

#[repr(packed)]
pub struct ObservationState {
    pub bump: u8,
    pub index: u16,
    pub block_timestamp: u32,
    pub tick_cumulative: i64,
    pub seconds_per_liquidity_cumulative_x32: u64,
    pub initialized: bool,
}

Returns data about a specific observation index

PDA of [OBSERVATION_SEED, token_0, token_1, fee, index]

Fields

bump: u8

Bump to identify PDA

index: u16

The element of the observations array stored in this account

block_timestamp: u32

The block timestamp of the observation

tick_cumulative: i64

The tick multiplied by seconds elapsed for the life of the pool as of the observation timestamp

seconds_per_liquidity_cumulative_x32: u64

The seconds per in range liquidity for the life of the pool as of the observation timestamp

initialized: bool

Whether the observation has been initialized and the values are safe to use

Implementations

impl ObservationState

pub fn transform(
    self,
    block_timestamp: u32,
    tick: i32,
    liquidity: u64
) -> ObservationState

Transforms a previous observation into a new observation, given the passage of time and the current tick and liquidity values

Arguments

• last - Must be chronologically equal to or greater than last.blockTimestamp, safe for 0 or 1 overflows.
• block_timestamp - The timestamp of the new observation
• tick - The active tick at the time of the new observation
• liquidity - The total in-range liquidity at the time of the new observation

pub fn update(
    &mut self,
    block_timestamp: u32,
    tick: i32,
    liquidity: u64,
    cardinality: u16,
    cardinality_next: u16
) -> u16

Writes an oracle observation to the account, returning the updated cardinality. Writable at most once per second. Index represents the most recently written element. cardinality and index must be tracked externally. If the index is at the end of the allowable array length (according to cardinality), and the next cardinality is greater than the current one, cardinality may be increased. This restriction is created to preserve ordering.

Arguments

• self - The observation account to write in
• block_timestamp - The timestamp of the new observation
• tick - The active tick at the time of the new observation
• liquidity - The total in-range liquidity at the time of the new observation
• cardinality - The number of populated elements in the oracle array
• cardinality_next - The new length of the oracle array, independent of population

pub fn observe_latest(self, time: u32, tick: i32, liquidity: u64) -> (i64, u64)

Makes a new observation for the current block timestamp

Arguments

• last - The most recently written observation
• time - The current block timestamp
• liquidity - The current in-range pool liquidity

Trait Implementations

impl AccountDeserialize for ObservationState

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 ObservationState

fn clone(&self) -> ObservationState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for ObservationState

fn default() -> ObservationState

Returns the “default value” for a type.

impl Discriminator for ObservationState

fn discriminator() -> [u8; 8]

impl Owner for ObservationState

fn owner() -> Pubkey

impl Zeroable for ObservationState

fn zeroed() -> Self

Calls zeroed.

impl Copy for ObservationState

impl Pod for ObservationState

impl ZeroCopy for ObservationState