Struct pyth_sdk::PriceFeed

#[repr(C)]
pub struct PriceFeed {
    pub id: PriceIdentifier,
    pub status: PriceStatus,
    pub publish_time: UnixTimestamp,
    pub expo: i32,
    pub max_num_publishers: u32,
    pub num_publishers: u32,
    pub product_id: ProductIdentifier,
    /* private fields */
}

Represents a current aggregation price from pyth publisher feeds.

Fields

id: PriceIdentifier

Unique identifier for this price.

status: PriceStatus

Status of price (Trading is valid).

publish_time: UnixTimestamp

Current price aggregation publish time

expo: i32

Price exponent.

max_num_publishers: u32

Maximum number of allowed publishers that can contribute to a price.

num_publishers: u32

Number of publishers that made up current aggregate.

product_id: ProductIdentifier

Product account key.

Implementations

impl PriceFeed

pub fn new(
    id: PriceIdentifier,
    status: PriceStatus,
    publish_time: UnixTimestamp,
    expo: i32,
    max_num_publishers: u32,
    num_publishers: u32,
    product_id: ProductIdentifier,
    price: i64,
    conf: u64,
    ema_price: i64,
    ema_conf: u64,
    prev_price: i64,
    prev_conf: u64,
    prev_publish_time: UnixTimestamp
) -> PriceFeed

Constructs a new Price Feed

pub fn get_current_price(&self) -> Option<Price>

Get the current price and confidence interval as fixed-point numbers of the form a * 10^e.

Returns a struct containing the current price, confidence interval, and the exponent for both numbers. Returns None if price information is currently unavailable for any reason.

pub fn get_current_price_unchecked(&self) -> Price

Get the “unchecked” current price and confidence interval as fixed-point numbers of the form a * 10^e.

Returns a struct containing the current price, confidence interval, and the exponent for both numbers. This method returns the price value without checking availability of the price. This value might not be valid or updated when the price is not available. Please use get_current_price where possible.

pub fn get_ema_price(&self) -> Option<Price>

Get the exponential moving average price (ema_price) and a confidence interval on the result.

Returns None if the ema price is currently unavailable. At the moment, the confidence interval returned by this method is computed in a somewhat questionable way, so we do not recommend using it for high-value applications.

pub fn get_ema_price_unchecked(&self) -> Price

Get the “unchecked” exponential moving average price (ema_price) and a confidence interval on the result.

Returns the price value without checking availability of the price. This value might not be valid or updated when the price is not available. Please use get_ema_price where possible.

At the moment, the confidence interval returned by this method is computed in a somewhat questionable way, so we do not recommend using it for high-value applications.

pub fn get_latest_available_price_unchecked(&self) -> (Price, UnixTimestamp)

Get the latest available price, along with the timestamp when it was generated.

This function returns the same price as get_current_price in the case where a price was available at the time this PriceFeed was published (publish_time). However, if a price was not available at that time, this function returns the price from the latest time at which the price was available. The returned price can be from arbitrarily far in the past; this function makes no guarantees that the returned price is recent or useful for any particular application.

Users of this function should check the returned timestamp to ensure that the returned price is sufficiently recent for their application. If you are considering using this function, it may be safer / easier to use either get_current_price or get_latest_available_price_within_duration.

Returns a struct containing the latest available price, confidence interval, and the exponent for both numbers along with the timestamp when that price was generated.

pub fn get_latest_available_price_within_duration(
    &self,
    current_time: UnixTimestamp,
    duration: DurationInSeconds
) -> Option<Price>

Get the latest price as long as it was updated within duration seconds of the current_time.

This function is a sanity-checked version of get_latest_available_price_unchecked which is useful in applications that require a sufficiently-recent price. Returns None if the price wasn’t updated sufficiently recently.

Returns a struct containing the latest available price, confidence interval and the exponent for both numbers, or None if no price update occurred within duration seconds of the current_time.

Trait Implementations

impl BorshDeserialize for PriceFeed where
    PriceIdentifier: BorshDeserialize,
    PriceStatus: BorshDeserialize,
    UnixTimestamp: BorshDeserialize,
    i32: BorshDeserialize,
    u32: BorshDeserialize,
    u32: BorshDeserialize,
    ProductIdentifier: BorshDeserialize,
    i64: BorshDeserialize,
    u64: BorshDeserialize,
    i64: BorshDeserialize,
    u64: BorshDeserialize,
    i64: BorshDeserialize,
    u64: BorshDeserialize,
    UnixTimestamp: BorshDeserialize, 

fn deserialize(buf: &mut &[u8]) -> Result<Self, Error>

Deserializes this instance from a given slice of bytes. Updates the buffer to point at the remaining bytes.

fn try_from_slice(v: &[u8]) -> Result<Self, Error>

Deserialize this instance from a slice of bytes.

impl BorshSerialize for PriceFeed where
    PriceIdentifier: BorshSerialize,
    PriceStatus: BorshSerialize,
    UnixTimestamp: BorshSerialize,
    i32: BorshSerialize,
    u32: BorshSerialize,
    u32: BorshSerialize,
    ProductIdentifier: BorshSerialize,
    i64: BorshSerialize,
    u64: BorshSerialize,
    i64: BorshSerialize,
    u64: BorshSerialize,
    i64: BorshSerialize,
    u64: BorshSerialize,
    UnixTimestamp: BorshSerialize, 

fn serialize<W: Write>(&self, writer: &mut W) -> Result<(), Error>

fn try_to_vec(&self) -> Result<Vec<u8, Global>, Error>

Serialize this instance into a vector of bytes.

impl Clone for PriceFeed

fn clone(&self) -> PriceFeed

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PriceFeed

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

Formats the value using the given formatter.

impl Default for PriceFeed

fn default() -> PriceFeed

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PriceFeed

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl JsonSchema for PriceFeed

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq<PriceFeed> for PriceFeed

fn eq(&self, other: &PriceFeed) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &PriceFeed) -> bool

This method tests for !=.

impl Serialize for PriceFeed

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

Serialize this value into the given Serde serializer.

impl Copy for PriceFeed

impl Eq for PriceFeed

impl StructuralEq for PriceFeed

impl StructuralPartialEq for PriceFeed