neptune-mempool 0.14.0

Neptune transaction mempool: the Mempool store, its transaction-id and upgrade-priority abstractions, and the proof-quality policy used for gossip and replacement
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

use std::ops::Add;

use get_size2::GetSize;
use neptune_consensus::type_scripts::native_currency_amount::NativeCurrencyAmount;

use crate::upgrade_incentive::UpgradeIncentive;

/// Used by memory pool subscribers to indicate how interested they are in
/// a specific transaction.
#[derive(Debug, Default, Copy, Clone, Eq, PartialEq, GetSize)]
#[cfg_attr(any(test, feature = "test-helpers"), derive(serde::Serialize))]
#[cfg_attr(any(test, feature = "arbitrary-impls"), derive(arbitrary::Arbitrary))]
pub enum UpgradePriority {
    /// This transaction was received from a 3rd party and does not have a
    /// financial interest for this node operator.
    #[default]
    Irrelevant,

    /// There's a certain amount of interest.
    ///
    /// For example, wallets can use the sum of the outputs the transaction
    /// sends to them. Should also be used when this node has upgraded the
    /// transaction.
    Interested(NativeCurrencyAmount),

    /// The transaction in question is of the highest possible priority. Wallets
    /// should use this for transactions they have initiated.
    Critical,
}

impl From<UpgradeIncentive> for UpgradePriority {
    fn from(incentive: UpgradeIncentive) -> Self {
        match incentive {
            UpgradeIncentive::Gobble(amount) => UpgradePriority::Interested(amount),
            UpgradeIncentive::BalanceAffecting(amount) => UpgradePriority::Interested(amount),
            UpgradeIncentive::Critical => UpgradePriority::Critical,
        }
    }
}

impl PartialOrd for UpgradePriority {
    fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
        Some(self.cmp(other))
    }
}

impl Ord for UpgradePriority {
    fn cmp(&self, other: &Self) -> std::cmp::Ordering {
        use std::cmp::Ordering::Equal;
        use std::cmp::Ordering::Greater;
        use std::cmp::Ordering::Less;

        use UpgradePriority::Critical;
        use UpgradePriority::Interested;
        use UpgradePriority::Irrelevant;
        match (self, other) {
            (Irrelevant, Irrelevant) => Equal,
            (Irrelevant, _) => Less,
            (Interested(_), Irrelevant) => Greater,
            (Interested(self_amt), Interested(other_amt)) => self_amt.cmp(other_amt),
            (Interested(_), Critical) => Less,
            (Critical, Critical) => Equal,
            (Critical, _) => Greater,
        }
    }
}

impl UpgradePriority {
    /// Returns true if the priority is irrelevant.
    pub fn is_irrelevant(&self) -> bool {
        *self == UpgradePriority::Irrelevant
    }

    /// Given the gobbling potential of the transaction, return the incentive to
    /// perform an upgrade.
    pub fn incentive_given_gobble_potential(
        &self,
        gobbling_potential: NativeCurrencyAmount,
    ) -> UpgradeIncentive {
        use UpgradePriority::Critical;
        use UpgradePriority::Interested;
        use UpgradePriority::Irrelevant;
        match self {
            Irrelevant => UpgradeIncentive::Gobble(gobbling_potential),
            Interested(native_currency_amount) => {
                UpgradeIncentive::BalanceAffecting(*native_currency_amount)
            }
            Critical => UpgradeIncentive::Critical,
        }
    }
}

impl Add for UpgradePriority {
    type Output = Self;

    fn add(self, other: Self) -> Self::Output {
        use UpgradePriority::Critical;
        use UpgradePriority::Interested;
        use UpgradePriority::Irrelevant;
        match (self, other) {
            (Irrelevant, _) => other,
            (_, Irrelevant) => self,
            (Interested(self_amt), Interested(other_amt)) => Interested(self_amt + other_amt),
            (_, Critical) | (Critical, _) => Critical,
        }
    }
}