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

// 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::{network::TRANSACTION_PREFIX, prelude::*};
use ledger_coinbase::{PuzzleCommitment, PUZZLE_COMMITMENT_PREFIX};

#[derive(Copy, Clone, PartialEq, Eq, Hash)]
pub enum TransmissionID<N: Network> {
    /// A ratification.
    Ratification,
    /// A prover solution.
    Solution(PuzzleCommitment<N>),
    /// A transaction.
    Transaction(N::TransactionID),
}

impl<N: Network> From<PuzzleCommitment<N>> for TransmissionID<N> {
    /// Converts the puzzle commitment into an transmission ID.
    fn from(puzzle_commitment: PuzzleCommitment<N>) -> Self {
        Self::Solution(puzzle_commitment)
    }
}

impl<N: Network> From<&N::TransactionID> for TransmissionID<N> {
    /// Converts the transaction ID into an transmission ID.
    fn from(transaction_id: &N::TransactionID) -> Self {
        Self::Transaction(*transaction_id)
    }
}

impl<N: Network> TransmissionID<N> {
    /// Returns the puzzle commitment if the transmission is a solution.
    pub fn solution(&self) -> Option<PuzzleCommitment<N>> {
        match self {
            Self::Solution(puzzle_commitment) => Some(*puzzle_commitment),
            _ => None,
        }
    }

    /// Returns the transaction ID if the transmission is a transaction.
    pub fn transaction(&self) -> Option<N::TransactionID> {
        match self {
            Self::Transaction(transaction_id) => Some(*transaction_id),
            _ => None,
        }
    }
}

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

    type CurrentNetwork = Testnet3;

    /// Returns a list of sample transmission IDs, sampled at random.
    pub fn sample_transmission_ids(rng: &mut TestRng) -> Vec<TransmissionID<CurrentNetwork>> {
        // Initialize a sample vector.
        let mut sample = Vec::with_capacity(10);
        // Append sample puzzle commitments.
        for _ in 0..5 {
            sample.push(TransmissionID::Solution(PuzzleCommitment::from_g1_affine(rng.gen())));
        }
        // Append sample transaction IDs.
        for _ in 0..5 {
            let id = TransmissionID::Transaction(<CurrentNetwork as Network>::TransactionID::from(Field::rand(rng)));
            sample.push(id);
        }
        // Return the sample vector.
        sample
    }
}