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

// Copyright (C) 2019-2023 Aleo Systems Inc.
// This file is part of the snarkVM library.

// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at:
// http://www.apache.org/licenses/LICENSE-2.0

// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#![forbid(unsafe_code)]
#![warn(clippy::cast_possible_truncation)]

mod bytes;
mod serialize;
mod string;

use console::prelude::*;
use ledger_block::Transaction;
use ledger_coinbase::ProverSolution;
use ledger_narwhal_data::Data;

#[derive(Clone, PartialEq, Eq)]
pub enum Transmission<N: Network> {
    /// A ratification.
    Ratification,
    /// A prover solution.
    /// Attention: Observe that the solution is encapsulated in `Data`, and thus possibly unchecked.
    Solution(Data<ProverSolution<N>>),
    /// A transaction.
    /// Attention: Observe that the transaction is encapsulated in `Data`, and thus possibly unchecked.
    Transaction(Data<Transaction<N>>),
}

impl<N: Network> From<ProverSolution<N>> for Transmission<N> {
    /// Converts the prover solution into a transmission.
    fn from(solution: ProverSolution<N>) -> Self {
        Self::Solution(Data::Object(solution))
    }
}

impl<N: Network> From<Transaction<N>> for Transmission<N> {
    /// Converts the transaction into a transmission.
    fn from(transaction: Transaction<N>) -> Self {
        Self::Transaction(Data::Object(transaction))
    }
}

impl<N: Network> From<Data<ProverSolution<N>>> for Transmission<N> {
    /// Converts the prover solution into a transmission.
    fn from(solution: Data<ProverSolution<N>>) -> Self {
        Self::Solution(solution)
    }
}

impl<N: Network> From<Data<Transaction<N>>> for Transmission<N> {
    /// Converts the transaction into a transmission.
    fn from(transaction: Data<Transaction<N>>) -> Self {
        Self::Transaction(transaction)
    }
}

#[cfg(any(test, feature = "test-helpers"))]
pub mod test_helpers {
    use super::*;
    use console::{
        network::Testnet3,
        prelude::{Rng, TestRng},
    };

    use ::bytes::Bytes;

    type CurrentNetwork = Testnet3;

    /// Returns a list of sample transmissions, sampled at random.
    pub fn sample_transmissions(rng: &mut TestRng) -> Vec<Transmission<CurrentNetwork>> {
        // Initialize a sample vector.
        let mut sample = Vec::with_capacity(10);
        // Append sample solutions.
        for _ in 0..5 {
            // Sample random fake solution bytes.
            let solution = Data::Buffer(Bytes::from((0..1024).map(|_| rng.gen::<u8>()).collect::<Vec<_>>()));
            // Append the solution.
            sample.push(Transmission::Solution(solution));
        }
        // Append sample transactions.
        for _ in 0..5 {
            // Sample random fake transaction bytes.
            let transaction = Data::Buffer(Bytes::from((0..1024).map(|_| rng.gen::<u8>()).collect::<Vec<_>>()));
            // Append the transaction.
            sample.push(Transmission::Transaction(transaction));
        }
        // Return the sample vector.
        sample
    }
}