evm-oracle-state 0.2.0

EVM-backed Chainlink-style oracle state tracking over evm-fork-cache
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

use alloy_primitives::Address;

use crate::FeedId;

/// Feed registration configuration.
#[derive(Clone, Debug)]
pub struct FeedConfig {
    /// User-facing proxy address.
    pub proxy: Address,
    /// Optional stable id. If omitted, one is derived from the label or proxy.
    pub id: Option<FeedId>,
    /// Optional human-readable label.
    pub label: Option<String>,
    /// Optional base symbol.
    pub base: Option<String>,
    /// Optional quote symbol.
    pub quote: Option<String>,
    /// Staleness and answer validity policy.
    pub staleness: StalenessPolicy,
}

impl Default for FeedConfig {
    fn default() -> Self {
        Self {
            proxy: Address::ZERO,
            id: None,
            label: None,
            base: None,
            quote: None,
            staleness: StalenessPolicy::default(),
        }
    }
}

/// Policy used to classify round freshness and answer validity.
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
pub struct StalenessPolicy {
    max_age_secs: Option<u64>,
    allow_zero_or_negative_answer: bool,
}

impl StalenessPolicy {
    /// Create a policy with a max age.
    pub fn max_age(max_age_secs: u64) -> Self {
        Self {
            max_age_secs: Some(max_age_secs),
            allow_zero_or_negative_answer: false,
        }
    }

    /// Allow zero or negative answers for generic signed numeric feeds.
    pub fn allow_zero_or_negative_answer(mut self, allow: bool) -> Self {
        self.allow_zero_or_negative_answer = allow;
        self
    }

    pub(crate) fn max_age_secs(&self) -> Option<u64> {
        self.max_age_secs
    }

    pub(crate) fn allows_zero_or_negative_answer(&self) -> bool {
        self.allow_zero_or_negative_answer
    }
}