Struct switchboard_utils::protos::oracle_job::TwapTask

pub struct TwapTask {
    pub aggregator_pubkey: Option<String>,
    pub period: Option<i32>,
    pub weight_by_propagation_time: Option<bool>,
    pub min_samples: Option<u32>,
    pub ending_unix_timestamp: Option<i32>,
    pub ending_unix_timestamp_task: Option<CronParseTask>,
}

Takes a twap over a set period for a certain aggregator. Aggregators have an optional history buffer account storing the last N accepted results. The TwapTask will iterate over an aggregators history buffer and calculate the time weighted average of the samples within a given time period.

Input: None

Returns: The time weighted average of an aggregator over a given time period.

Example: The 1hr Twap of the SOL/USD Aggregator, requiring at least 60 samples.

{ "twapTask": { "aggregatorPubkey": "GvDMxPzN1sCj7L26YDK2HnMRXEQmQ2aemov8YBtPS7vR", "period": 3600, "minSamples": 60, "weightByPropagationTime": true  } }

Fields

aggregator_pubkey: Option<String>

/ The target aggregator for the TWAP.

period: Option<i32>

/ Period, in seconds, the twap should account for

weight_by_propagation_time: Option<bool>

/ Weight samples by their propagation time

min_samples: Option<u32>

/ Minimum number of samples in the history to calculate a valid result

ending_unix_timestamp: Option<i32>

/ Ending unix timestamp to collect values up to

ending_unix_timestamp_task: Option<CronParseTask>

/ Execute the task to get the ending unix timestamp

Implementations

impl TwapTask

pub fn aggregator_pubkey(&self) -> &str

Returns the value of aggregator_pubkey, or the default value if aggregator_pubkey is unset.

pub fn period(&self) -> i32

Returns the value of period, or the default value if period is unset.

pub fn weight_by_propagation_time(&self) -> bool

Returns the value of weight_by_propagation_time, or the default value if weight_by_propagation_time is unset.

pub fn min_samples(&self) -> u32

Returns the value of min_samples, or the default value if min_samples is unset.

pub fn ending_unix_timestamp(&self) -> i32

Returns the value of ending_unix_timestamp, or the default value if ending_unix_timestamp is unset.

Trait Implementations

impl Clone for TwapTask

fn clone(&self) -> TwapTask

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TwapTask

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

Formats the value using the given formatter.

impl Default for TwapTask

fn default() -> Self

Returns the “default value” for a type.

impl Message for TwapTask

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8> where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8> where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for TwapTask

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for TwapTask