cuprate_types/
transaction_verification_data.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
//! Contains [`TransactionVerificationData`] and the related types.

use std::sync::Mutex;

use monero_serai::transaction::{Timelock, Transaction};

use crate::{HardFork, VerifiedTransactionInformation};

/// An enum representing all valid Monero transaction versions.
#[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd)]
pub enum TxVersion {
    /// Legacy ring signatures.
    RingSignatures,
    /// Ring-CT
    RingCT,
}

impl TxVersion {
    /// Converts a `raw` version value to a [`TxVersion`].
    ///
    /// This will return `None` on invalid values.
    ///
    /// ref: <https://monero-book.cuprate.org/consensus_rules/transactions.html#version>
    ///  &&  <https://monero-book.cuprate.org/consensus_rules/blocks/miner_tx.html#version>
    pub const fn from_raw(version: u8) -> Option<Self> {
        Some(match version {
            1 => Self::RingSignatures,
            2 => Self::RingCT,
            _ => return None,
        })
    }
}

/// Represents if a transaction has been fully validated and under what conditions
/// the transaction is valid in the future.
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
pub enum CachedVerificationState {
    /// The transaction has not been validated.
    NotVerified,
    /// The transaction is valid* if the block represented by this hash is in the blockchain and the [`HardFork`]
    /// is the same.
    ///
    /// *V1 transactions require checks on their ring-length even if this hash is in the blockchain.
    ValidAtHashAndHF {
        /// The block hash that was in the chain when this transaction was validated.
        block_hash: [u8; 32],
        /// The hf this transaction was validated against.
        hf: HardFork,
    },
    /// The transaction is valid* if the block represented by this hash is in the blockchain _and_ this
    /// given time lock is unlocked. The time lock here will represent the youngest used time based lock
    /// (If the transaction uses any time based time locks). This is because time locks are not monotonic
    /// so unlocked outputs could become re-locked.
    ///
    /// *V1 transactions require checks on their ring-length even if this hash is in the blockchain.
    ValidAtHashAndHFWithTimeBasedLock {
        /// The block hash that was in the chain when this transaction was validated.
        block_hash: [u8; 32],
        /// The hf this transaction was validated against.
        hf: HardFork,
        /// The youngest used time based lock.
        time_lock: Timelock,
    },
}

impl CachedVerificationState {
    /// Returns the block hash this is valid for if in state [`CachedVerificationState::ValidAtHashAndHF`] or [`CachedVerificationState::ValidAtHashAndHFWithTimeBasedLock`].
    pub const fn verified_at_block_hash(&self) -> Option<[u8; 32]> {
        match self {
            Self::NotVerified => None,
            Self::ValidAtHashAndHF { block_hash, .. }
            | Self::ValidAtHashAndHFWithTimeBasedLock { block_hash, .. } => Some(*block_hash),
        }
    }
}

/// Data needed to verify a transaction.
#[derive(Debug)]
pub struct TransactionVerificationData {
    /// The transaction we are verifying
    pub tx: Transaction,
    /// The [`TxVersion`] of this tx.
    pub version: TxVersion,
    /// The serialised transaction.
    pub tx_blob: Vec<u8>,
    /// The weight of the transaction.
    pub tx_weight: usize,
    /// The fee this transaction has paid.
    pub fee: u64,
    /// The hash of this transaction.
    pub tx_hash: [u8; 32],
    /// The verification state of this transaction.
    pub cached_verification_state: Mutex<CachedVerificationState>,
}

#[derive(Debug, Copy, Clone, thiserror::Error)]
#[error("Error converting a verified tx to a cached verification data tx.")]
pub struct TxConversionError;

impl TryFrom<VerifiedTransactionInformation> for TransactionVerificationData {
    type Error = TxConversionError;

    fn try_from(value: VerifiedTransactionInformation) -> Result<Self, Self::Error> {
        Ok(Self {
            version: TxVersion::from_raw(value.tx.version()).ok_or(TxConversionError)?,
            tx: value.tx,
            tx_blob: value.tx_blob,
            tx_weight: value.tx_weight,
            fee: value.fee,
            tx_hash: value.tx_hash,
            cached_verification_state: Mutex::new(CachedVerificationState::NotVerified),
        })
    }
}