af-oracle 0.27.0

Move types for Aftermath's `AfOracle` package
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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130

//! Move types for Aftermath's `AfOracle` package

use af_sui_types::Address;
use af_utilities::types::IFixed;
use sui_framework_sdk::object::{ID, UID};
use sui_framework_sdk::{Field, FieldTypeTag};

pub mod errors;
pub mod event_ext;
pub mod event_instance;
#[cfg(feature = "graphql")]
pub mod graphql;

// Main package types
pub use self::oracle::{PriceFeed, PriceFeedStorage, PriceFeedStorageTypeTag, PriceFeedTypeTag};

/// Dynamic field storing a [`PriceFeed`].
pub type PriceFeedDf = Field<keys::PriceFeedForSource, PriceFeed>;

af_sui_pkg_sdk::sui_pkg_sdk!(af_oracle {
    module oracle {
        // =========================================================================
        //  Objects
        // =========================================================================

        /// Capability object required to create/remove price feeds.
        ///
        /// Created as a single-writer object, unique.
        struct AuthorityCap has key, store {
            id: UID,
        }

        /// Object that stores all the price feeds for this aggregation.
        struct PriceFeedStorage has key, store {
            id: UID,
            /// Symbol for this price feed storage
            symbol: String,
            /// Amount of decimals for this price feed storage.
            decimals: u64,
            /// List of source wrapper ids having a feed in this storage.
            /// Each ID is used as key for the dynamic field containing the price feed
            source_wrapper_ids: vector<ID>,
        }

        /// Object that identifies a price feed for a single source.
        struct PriceFeed has key, store {
            id: UID,
            /// Price value.
            price: IFixed,
            /// Price timestamp.
            timestamp: u64,
            /// Allowed gap between current
            /// and provided timestamp.
            time_tolerance: u64,
        }

        /// Signals a package's capability to act as a price feed source.
        struct SourceCap has store {}
    }

    module keys {
        /// Key type for accessing price feed for particular source.
        struct PriceFeedForSource has copy, drop, store {
            source_wrapper_id: ID,
        }

        /// For attaching a capability to an app.
        ///
        /// This ensures only this package has access to this dynamic field since the key can only be
        /// constructed here.
        struct Authorization has copy, drop, store {}
    }

    module events {
        struct CreatedPriceFeedStorage has copy, drop {
            price_feed_storage_id: ID,
            symbol: String,
            decimals: u64
        }

        struct AddedAuthorization has copy, drop {
            source_wrapper_id: ID,
        }

        struct RemovedAuthorization has copy, drop {
            source_wrapper_id: ID,
        }

        struct CreatedPriceFeed has copy, drop {
            price_feed_storage_id: ID,
            source_wrapper_id: ID,
            price: IFixed,
            timestamp: u64,
            time_tolerance: u64,
        }

        struct RemovedPriceFeed has copy, drop {
            price_feed_storage_id: ID,
            source_wrapper_id: ID,
        }

        struct UpdatedPriceFeed has copy, drop {
            price_feed_storage_id: ID,
            source_wrapper_id: ID,
            old_price: IFixed,
            old_timestamp: u64,
            new_price: IFixed,
            new_timestamp: u64,
        }

        struct UpdatedPriceFeedTimeTolerance has copy, drop {
            price_feed_storage_id: ID,
            source_wrapper_id: ID,
            old_time_tolerance: u64,
            new_time_tolerance: u64,
        }
    }
});

impl PriceFeedStorage {
    /// Convenience function to build the type of a [`PriceFeedDf`].
    pub fn price_feed_df_type(
        package: Address,
    ) -> FieldTypeTag<self::keys::PriceFeedForSource, PriceFeed> {
        Field::type_(
            self::keys::PriceFeedForSource::type_(package),
            PriceFeed::type_(package),
        )
    }
}