cardano_serialization_lib/serialization/witnesses/
transaction_witnesses_set.rs

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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
use std::io::{BufRead, Seek, Write};
use cbor_event::de::Deserializer;
use cbor_event::se::Serializer;
use cbor_event::Serialize;
use crate::{BootstrapWitnesses, CBORReadLen, DeserializeError, DeserializeFailure, Key, Language, NativeScripts, PlutusList, PlutusScripts, Redeemers, TransactionWitnessSet, Vkeywitnesses};
use crate::protocol_types::{CBORSpecial, CBORType, Deserialize, opt64, TransactionWitnessSetRaw};
use crate::serialization::utils::{deserilized_with_orig_bytes, merge_option_plutus_list};
use crate::traits::NoneOrEmpty;
use crate::utils::opt64_non_empty;

impl cbor_event::se::Serialize for TransactionWitnessSet {
    fn serialize<'a, W: Write + Sized>(&self, serializer: &'a mut Serializer<W>) -> cbor_event::Result<&'a mut Serializer<W>> {
        serialize(self, None, serializer)
    }
}

impl Deserialize for TransactionWitnessSet {
    fn deserialize<R: BufRead + Seek>(raw: &mut Deserializer<R>) -> Result<Self, DeserializeError>
    where
        Self: Sized
    {
        let (witness_set, _) = deserialize(raw, false)?;
        Ok(witness_set)
    }
}

pub(super) fn deserialize<R: BufRead + Seek>(raw: &mut Deserializer<R>, with_raw_parts: bool) -> Result<(TransactionWitnessSet, TransactionWitnessSetRaw), DeserializeError> {
    (|| -> Result<_, DeserializeError> {
        let len = raw.map()?;
        let mut read_len = CBORReadLen::new(len);
        let mut vkeys = None;
        let mut native_scripts = None;
        let mut bootstraps = None;
        let mut plutus_scripts_v1 = None;
        let mut plutus_scripts_v2 = None;
        let mut plutus_scripts_v3 = None;
        let mut plutus_data = None;
        let mut redeemers = None;
        let mut read = 0;
        let mut raw_part = TransactionWitnessSetRaw::new();

        while match len {
            cbor_event::Len::Len(n) => read < n as usize,
            cbor_event::Len::Indefinite => true,
        } {
            match raw.cbor_type()? {
                CBORType::UnsignedInteger => match raw.unsigned_integer()? {
                    0 => {
                        if vkeys.is_some() {
                            return Err(DeserializeFailure::DuplicateKey(Key::Uint(0)).into());
                        }
                        read_len.read_elems(1)?;
                        let (vkeys_deser, raw) = deserilized_with_orig_bytes(raw, |raw|
                            Vkeywitnesses::deserialize(raw)
                        ).map_err(|e| e.annotate("vkeys"))?;

                        vkeys = Some(vkeys_deser);
                        if with_raw_parts {
                            raw_part.vkeys = Some(raw);
                        }
                    }
                    1 => {
                        if native_scripts.is_some() {
                            return Err(DeserializeFailure::DuplicateKey(Key::Uint(1)).into());
                        }
                        read_len.read_elems(1)?;
                        let (native_scripts_deser, raw) = deserilized_with_orig_bytes(raw, |raw|
                            NativeScripts::deserialize(raw)
                        ).map_err(|e| e.annotate("native_scripts"))?;
                        native_scripts = Some(native_scripts_deser);
                        if with_raw_parts {
                            raw_part.native_scripts = Some(raw);
                        }
                    }
                    2 => {
                        if bootstraps.is_some() {
                            return Err(DeserializeFailure::DuplicateKey(Key::Uint(2)).into());
                        }
                        read_len.read_elems(1)?;
                        let (bootstraps_deser, raw) = deserilized_with_orig_bytes(raw, |raw|
                            BootstrapWitnesses::deserialize(raw)
                        ).map_err(|e| e.annotate("bootstraps"))?;
                        bootstraps = Some(bootstraps_deser);
                        if with_raw_parts {
                            raw_part.bootstraps = Some(raw);
                        }
                    }
                    3 => {
                        if plutus_scripts_v1.is_some() {
                            return Err(DeserializeFailure::DuplicateKey(Key::Uint(3)).into());
                        }
                        read_len.read_elems(1)?;
                        let (plutus_scripts_v1_deser, raw) = deserilized_with_orig_bytes(raw, |raw|
                            PlutusScripts::deserialize_with_version(raw, &Language::new_plutus_v1())
                        ).map_err(|e| e.annotate("plutus_scripts_v1"))?;
                        plutus_scripts_v1 = Some(plutus_scripts_v1_deser);
                        if with_raw_parts {
                            raw_part.plutus_scripts_v1 = Some(raw);
                        }
                    }
                    4 => {
                        if plutus_data.is_some() {
                            return Err(DeserializeFailure::DuplicateKey(Key::Uint(4)).into());
                        }
                        read_len.read_elems(1)?;
                        let (plutus_data_deser, raw) = deserilized_with_orig_bytes(raw, |raw|
                            PlutusList::deserialize(raw)
                        ).map_err(|e| e.annotate("plutus_data"))?;
                        plutus_data = Some(plutus_data_deser);
                        if with_raw_parts {
                            raw_part.plutus_data = Some(raw);
                        }
                    }
                    5 => {
                        if redeemers.is_some() {
                            return Err(DeserializeFailure::DuplicateKey(Key::Uint(5)).into());
                        }
                        read_len.read_elems(1)?;
                        let (redeemers_deser, raw) = deserilized_with_orig_bytes(raw, |raw|
                            Redeemers::deserialize(raw)
                        ).map_err(|e| e.annotate("redeemers"))?;
                        redeemers = Some(redeemers_deser);
                        if with_raw_parts {
                            raw_part.redeemers = Some(raw);
                        }
                    }
                    6 => {
                        if plutus_scripts_v2.is_some() {
                            return Err(DeserializeFailure::DuplicateKey(Key::Uint(6)).into());
                        }
                        read_len.read_elems(1)?;
                        let (plutus_scripts_v2_deser, raw) = deserilized_with_orig_bytes(raw, |raw|
                            PlutusScripts::deserialize_with_version(raw, &Language::new_plutus_v2())
                        ).map_err(|e| e.annotate("plutus_scripts_v2"))?;
                        plutus_scripts_v2 = Some(plutus_scripts_v2_deser);
                        if with_raw_parts {
                            raw_part.plutus_scripts_v2 = Some(raw);
                        }
                    }
                    7 => {
                        if plutus_scripts_v3.is_some() {
                            return Err(DeserializeFailure::DuplicateKey(Key::Uint(7)).into());
                        }
                        read_len.read_elems(1)?;
                        let (plutus_scripts_v3_deser, raw) = deserilized_with_orig_bytes(raw, |raw|
                            PlutusScripts::deserialize_with_version(raw, &Language::new_plutus_v3())
                        ).map_err(|e| e.annotate("plutus_scripts_v3"))?;
                        plutus_scripts_v3 = Some(plutus_scripts_v3_deser);
                        if with_raw_parts {
                            raw_part.plutus_scripts_v3 = Some(raw);
                        }
                    }
                    unknown_key => {
                        return Err(
                            DeserializeFailure::UnknownKey(Key::Uint(unknown_key)).into()
                        )
                    }
                },
                CBORType::Text => match raw.text()?.as_str() {
                    unknown_key => {
                        return Err(DeserializeFailure::UnknownKey(Key::Str(
                            unknown_key.to_owned(),
                        ))
                            .into())
                    }
                },
                CBORType::Special => match len {
                    cbor_event::Len::Len(_) => {
                        return Err(DeserializeFailure::BreakInDefiniteLen.into())
                    }
                    cbor_event::Len::Indefinite => match raw.special()? {
                        CBORSpecial::Break => break,
                        _ => return Err(DeserializeFailure::EndingBreakMissing.into()),
                    },
                },
                other_type => {
                    return Err(DeserializeFailure::UnexpectedKeyType(other_type).into())
                }
            }
            read += 1;
        }
        read_len.finish()?;
        let mut plutus_scripts = None;
        plutus_scripts = merge_option_plutus_list(plutus_scripts, plutus_scripts_v1, &Language::new_plutus_v1());
        plutus_scripts = merge_option_plutus_list(plutus_scripts, plutus_scripts_v2, &Language::new_plutus_v2());
        plutus_scripts = merge_option_plutus_list(plutus_scripts, plutus_scripts_v3, &Language::new_plutus_v3());

        Ok((TransactionWitnessSet {
            vkeys,
            native_scripts,
            bootstraps,
            plutus_scripts,
            plutus_data,
            redeemers,
        }, raw_part))
    })()
        .map_err(|e| e.annotate("TransactionWitnessSet"))
}

pub(super) fn serialize<'se, W: Write>(
    wit_set: &TransactionWitnessSet,
    raw_parts: Option<&TransactionWitnessSetRaw>,
    serializer: &'se mut Serializer<W>,
) -> cbor_event::Result<&'se mut Serializer<W>> {
    let mut has_plutus_v1 = false;
    let mut has_plutus_v2 = false;
    let mut has_plutus_v3 = false;
    let plutus_added_length = match &wit_set.plutus_scripts {
        Some(scripts) => {
            has_plutus_v1 = scripts.has_version(&Language::new_plutus_v1());
            has_plutus_v2 = scripts.has_version(&Language::new_plutus_v2());
            has_plutus_v3 = scripts.has_version(&Language::new_plutus_v3());
            (has_plutus_v1 as u64) + (has_plutus_v2 as u64) + (has_plutus_v3 as u64)
        },
        _ => 0,
    };
    serializer.write_map(cbor_event::Len::Len(
        opt64(&wit_set.vkeys)
            + opt64_non_empty(&wit_set.native_scripts)
            + opt64_non_empty(&wit_set.bootstraps)
            + opt64_non_empty(&wit_set.plutus_data)
            + opt64_non_empty(&wit_set.redeemers)
            + plutus_added_length,
    ))?;
    if let Some(field) = &wit_set.vkeys {
        if let Some(raw_vkeys) = raw_parts.map(|x| x.vkeys.as_ref()).flatten() {
            serializer.write_unsigned_integer(0)?;
            serializer.write_raw_bytes(raw_vkeys)?;
        } else if !field.is_none_or_empty() {
            serializer.write_unsigned_integer(0)?;
            field.serialize(serializer)?;
        }
    }
    if let Some(field) = &wit_set.native_scripts {
        if let Some(raw) = raw_parts.as_ref().map(|x| x.native_scripts.as_ref()).flatten() {
            serializer.write_unsigned_integer(1)?;
            serializer.write_raw_bytes(raw)?;
        } else if !field.is_none_or_empty() {
            serializer.write_unsigned_integer(1)?;
            //transaction witness set already has deduplicated native scripts
            field.serialize_as_set(false, serializer)?;
        }
    }
    if let Some(field) = &wit_set.bootstraps {
        if let Some(raw) = raw_parts.as_ref().map(|x| x.bootstraps.as_ref()).flatten() {
            serializer.write_unsigned_integer(2)?;
            serializer.write_raw_bytes(raw)?;
        } else if !field.is_none_or_empty() {
            serializer.write_unsigned_integer(2)?;
            field.serialize(serializer)?;
        }
    }

    //no need deduplication here because transaction witness set already has deduplicated plutus scripts
    if let Some(plutus_scripts) = &wit_set.plutus_scripts {
        if has_plutus_v1 {
            if let Some(raw) = raw_parts.as_ref().map(|x| x.plutus_scripts_v1.as_ref()).flatten() {
                serializer.write_unsigned_integer(3)?;
                serializer.write_raw_bytes(raw)?;
            } else {
                serializer.write_unsigned_integer(3)?;
                plutus_scripts.serialize_as_set_by_version(false, &Language::new_plutus_v1(), serializer)?;
            }
        }
        if has_plutus_v2 {
            if let Some(raw) = raw_parts.as_ref().map(|x| x.plutus_scripts_v2.as_ref()).flatten() {
                serializer.write_unsigned_integer(6)?;
                serializer.write_raw_bytes(raw)?;
            } else {
                serializer.write_unsigned_integer(6)?;
                plutus_scripts.serialize_as_set_by_version(false, &Language::new_plutus_v2(), serializer)?;
            }
        }
        if has_plutus_v3 {
            if let Some(raw) = raw_parts.as_ref().map(|x| x.plutus_scripts_v3.as_ref()).flatten() {
                serializer.write_unsigned_integer(7)?;
                serializer.write_raw_bytes(raw)?;
            } else {
                serializer.write_unsigned_integer(7)?;
                plutus_scripts.serialize_as_set_by_version(false, &Language::new_plutus_v3(), serializer)?;
            }
        }
    }
    if let Some(field) = &wit_set.plutus_data {
        if let Some(raw) = raw_parts.as_ref().map(|x| x.plutus_data.as_ref()).flatten() {
            serializer.write_unsigned_integer(4)?;
            serializer.write_raw_bytes(&raw)?;
        } else if !field.is_none_or_empty() {
            serializer.write_unsigned_integer(4)?;
            //transaction witness set already has deduplicated plutus data
            field.serialize_as_set(false, serializer)?;
        }
    }
    if let Some(field) = &wit_set.redeemers {
        if let Some(raw) = raw_parts.as_ref().map(|x| x.redeemers.as_ref()).flatten() {
            serializer.write_unsigned_integer(5)?;
            serializer.write_raw_bytes(raw)?;
        } else if !field.is_none_or_empty() {
            serializer.write_unsigned_integer(5)?;
            field.serialize(serializer)?;
        }
    }
    Ok(serializer)
}