chainlink-data-streams-sdk 1.2.1

Chainlink Data Streams client SDK
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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153

use chainlink_data_streams_report::feed_id::ID;

use byteorder::{BigEndian, ByteOrder};
use serde::{Deserialize, Serialize};

/// Represents the feed report schema version.
///
/// The `FeedVersion` struct wraps a `u16` integer representing the version of the feed report schema.
///
/// # Examples
///
/// ```rust
/// use chainlink_data_streams_sdk::feed::FeedVersion;
///
/// let version = FeedVersion(1);
/// println!("Feed version: {}", version.0);
/// ```
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct FeedVersion(pub u16);

/// Represents a feed that identifies the report stream ID.
///
/// The `Feed` struct contains a `feed_id` field, which is an `ID` representing
/// the unique identifier of the feed.
///
/// # Examples
///
/// ```rust
/// use chainlink_data_streams_sdk::feed::Feed;
/// use chainlink_data_streams_report::feed_id::ID;
///
/// let id = ID::from_hex_str("0x00016b4aa7e57ca7b68ae1bf45653f56b656fd3aa335ef7fae696b663f1b8472").unwrap();
/// let feed = Feed { feed_id: id };
/// ```
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct Feed {
    /// The unique identifier of the feed.
    #[serde(rename = "feedID")]
    pub feed_id: ID,
}

impl Feed {
    /// Returns the feed version extracted from the first two bytes of the `ID`.
    ///
    /// # Returns
    ///
    /// A `FeedVersion` representing the version number.
    ///
    /// # Examples
    ///
    /// ```rust
    /// use chainlink_data_streams_report::feed_id::ID;
    /// use chainlink_data_streams_sdk::feed::{Feed, FeedVersion};
    ///
    /// let feed_id = ID::from_hex_str("0x00016b4aa7e57ca7b68ae1bf45653f56b656fd3aa335ef7fae696b663f1b8472").unwrap();
    /// let feed = Feed { feed_id };
    /// let version = feed.version();
    /// assert_eq!(version, FeedVersion(1));
    /// ```
    pub fn version(&self) -> FeedVersion {
        let version = BigEndian::read_u16(&self.feed_id.0[0..2]);
        FeedVersion(version)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    const V1_FEED_ID: ID = ID([
        0, 1, 107, 74, 167, 229, 124, 167, 182, 138, 225, 191, 69, 101, 63, 86, 182, 86, 253, 58,
        163, 53, 239, 127, 174, 105, 107, 102, 63, 27, 132, 114,
    ]);
    const V2_FEED_ID: ID = ID([
        00, 02, 107, 74, 167, 229, 124, 167, 182, 138, 225, 191, 69, 101, 63, 86, 182, 86, 253, 58,
        163, 53, 239, 127, 174, 105, 107, 102, 63, 27, 132, 114,
    ]);
    const V3_FEED_ID: ID = ID([
        00, 03, 107, 74, 167, 229, 124, 167, 182, 138, 225, 191, 69, 101, 63, 86, 182, 86, 253, 58,
        163, 53, 239, 127, 174, 105, 107, 102, 63, 27, 132, 114,
    ]);
    const V4_FEED_ID: ID = ID([
        00, 04, 107, 74, 167, 229, 124, 167, 182, 138, 225, 191, 69, 101, 63, 86, 182, 86, 253, 58,
        163, 53, 239, 127, 174, 105, 107, 102, 63, 27, 132, 114,
    ]);

    const V1_FEED_ID_STR: &str =
        "0x00016b4aa7e57ca7b68ae1bf45653f56b656fd3aa335ef7fae696b663f1b8472";
    const V2_FEED_ID_STR: &str =
        "0x00026b4aa7e57ca7b68ae1bf45653f56b656fd3aa335ef7fae696b663f1b8472";
    const V3_FEED_ID_STR: &str =
        "0x00036b4aa7e57ca7b68ae1bf45653f56b656fd3aa335ef7fae696b663f1b8472";
    const V4_FEED_ID_STR: &str =
        "0x00046b4aa7e57ca7b68ae1bf45653f56b656fd3aa335ef7fae696b663f1b8472";

    #[test]
    fn test_feed_version() {
        let feed_v1 = Feed {
            feed_id: V1_FEED_ID,
        };
        let feed_v2 = Feed {
            feed_id: V2_FEED_ID,
        };
        let feed_v3 = Feed {
            feed_id: V3_FEED_ID,
        };
        let feed_v4 = Feed {
            feed_id: V4_FEED_ID,
        };

        assert_eq!(feed_v1.version(), FeedVersion(1));
        assert_eq!(feed_v2.version(), FeedVersion(2));
        assert_eq!(feed_v3.version(), FeedVersion(3));
        assert_eq!(feed_v4.version(), FeedVersion(4));
    }

    #[test]
    fn test_serialize() {
        let feeds = vec![
            (V1_FEED_ID, V1_FEED_ID_STR),
            (V2_FEED_ID, V2_FEED_ID_STR),
            (V3_FEED_ID, V3_FEED_ID_STR),
            (V4_FEED_ID, V4_FEED_ID_STR),
        ];

        for (feed_id, expected_str) in feeds {
            let feed = Feed { feed_id };
            let got = serde_json::to_string(&feed).unwrap();
            let want = format!("{{\"feedID\":\"{}\"}}", expected_str);

            assert_eq!(got, want);
        }
    }

    #[test]
    fn test_deserialize() {
        let feeds = vec![
            (V1_FEED_ID, V1_FEED_ID_STR),
            (V2_FEED_ID, V2_FEED_ID_STR),
            (V3_FEED_ID, V3_FEED_ID_STR),
            (V4_FEED_ID, V4_FEED_ID_STR),
        ];

        for (feed_id, expected_str) in feeds {
            let json = format!("{{\"feedID\":\"{}\"}}", expected_str);

            let got: Feed = serde_json::from_str(&json).unwrap();
            let want = Feed { feed_id };

            assert_eq!(got, want);
        }
    }
}