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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
use crate::{Network, Operation};
use snarkvm_utilities::{FromBytes, FromBytesDeserializer, ToBytes, ToBytesSerializer};
use serde::{de, ser::SerializeStruct, Deserialize, Deserializer, Serialize, Serializer};
use std::{
fmt,
io::{Read, Result as IoResult, Write},
str::FromStr,
};
#[derive(Clone, Debug, Eq, PartialEq)]
pub enum Event<N: Network> {
Custom(Vec<u8>),
RecordViewKey(u8, N::RecordViewKey),
Operation(Operation<N>),
}
impl<N: Network> Event<N> {
#[inline]
fn id(&self) -> u8 {
match self {
Self::Custom(..) => 0,
Self::RecordViewKey(..) => 1,
Self::Operation(..) => 2,
}
}
}
impl<N: Network> FromBytes for Event<N> {
#[inline]
fn read_le<R: Read>(mut reader: R) -> IoResult<Self> {
let id: u8 = FromBytes::read_le(&mut reader)?;
match id {
0 => {
let num_bytes: u16 = FromBytes::read_le(&mut reader)?;
let mut buffer = vec![0u8; num_bytes as usize];
reader.read_exact(&mut buffer)?;
Ok(Self::Custom(buffer))
}
1 => {
let index: u8 = FromBytes::read_le(&mut reader)?;
let record_view_key: N::RecordViewKey = FromBytes::read_le(&mut reader)?;
Ok(Self::RecordViewKey(index, record_view_key))
}
2 => Ok(Self::Operation(FromBytes::read_le(&mut reader)?)),
_ => unreachable!("Invalid event ID during deserialization"),
}
}
}
impl<N: Network> ToBytes for Event<N> {
#[inline]
fn write_le<W: Write>(&self, mut writer: W) -> IoResult<()> {
self.id().write_le(&mut writer)?;
match self {
Self::Custom(buffer) => {
(buffer.len() as u16).write_le(&mut writer)?;
buffer.write_le(&mut writer)
}
Self::RecordViewKey(index, record_view_key) => {
index.write_le(&mut writer)?;
record_view_key.write_le(&mut writer)
}
Self::Operation(operation) => operation.write_le(&mut writer),
}
}
}
impl<N: Network> FromStr for Event<N> {
type Err = anyhow::Error;
fn from_str(event: &str) -> Result<Self, Self::Err> {
Ok(serde_json::from_str(event)?)
}
}
impl<N: Network> fmt::Display for Event<N> {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(
f,
"{}",
serde_json::to_string(self).map_err::<fmt::Error, _>(serde::ser::Error::custom)?
)
}
}
impl<N: Network> Serialize for Event<N> {
fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
match serializer.is_human_readable() {
true => match *self {
Self::Custom(ref bytes) => {
let mut event = serializer.serialize_struct("Event", 2)?;
event.serialize_field("id", &self.id())?;
event.serialize_field("bytes", &hex::encode(bytes))?;
event.end()
}
Self::RecordViewKey(ref index, ref record_view_key) => {
let mut event = serializer.serialize_struct("Event", 3)?;
event.serialize_field("id", &self.id())?;
event.serialize_field("index", &index)?;
event.serialize_field("record_view_key", &record_view_key)?;
event.end()
}
Self::Operation(ref operation) => {
let mut event = serializer.serialize_struct("Event", 2)?;
event.serialize_field("id", &self.id())?;
event.serialize_field("operation", &operation)?;
event.end()
}
},
false => ToBytesSerializer::serialize_with_size_encoding(self, serializer),
}
}
}
impl<'de, N: Network> Deserialize<'de> for Event<N> {
fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
match deserializer.is_human_readable() {
true => {
let event = serde_json::Value::deserialize(deserializer).map_err(de::Error::custom)?;
let event_id: u8 = serde_json::from_value(event["id"].clone()).map_err(de::Error::custom)?;
match event_id {
0 => {
let bytes: String =
serde_json::from_value(event["bytes"].clone()).map_err(de::Error::custom)?;
Ok(Self::Custom(hex::decode(bytes).map_err(de::Error::custom)?))
}
1 => Ok(Self::RecordViewKey(
serde_json::from_value(event["index"].clone()).map_err(de::Error::custom)?,
serde_json::from_value(event["record_view_key"].clone()).map_err(de::Error::custom)?,
)),
2 => Ok(Self::Operation(
serde_json::from_value(event["operation"].clone()).map_err(de::Error::custom)?,
)),
_ => unreachable!(format!("Invalid event id {}", event_id)),
}
}
false => FromBytesDeserializer::<Self>::deserialize_with_size_encoding(deserializer, "event"),
}
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::testnet2::Testnet2;
#[test]
fn test_event_serde_json() {
let expected_event = Event::<Testnet2>::Operation(Operation::Noop);
let expected_string = expected_event.to_string();
let candidate_string = serde_json::to_string(&expected_event).unwrap();
assert_eq!(33, candidate_string.len(), "Update me if serialization has changed");
assert_eq!(expected_string, candidate_string);
assert_eq!(expected_event, Event::from_str(&candidate_string).unwrap());
assert_eq!(expected_event, serde_json::from_str(&candidate_string).unwrap());
}
#[test]
fn test_event_bincode() {
let expected_event = Event::<Testnet2>::Operation(Operation::Noop);
let expected_bytes = expected_event.to_bytes_le().unwrap();
let candidate_bytes = bincode::serialize(&expected_event).unwrap();
assert_eq!(3, expected_bytes.len(), "Update me if serialization has changed");
assert_eq!(&expected_bytes[..], &candidate_bytes[8..]);
assert_eq!(expected_event, Event::read_le(&expected_bytes[..]).unwrap());
assert_eq!(expected_event, bincode::deserialize(&candidate_bytes[..]).unwrap());
}
}
