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

use neptune_consensus::type_scripts::native_currency_amount::NativeCurrencyAmount;

/// The magnitude of the incentive to perform a transaction upgrade.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum UpgradeIncentive {
    /// The transaction is upgraded because fees can be gobbled.
    Gobble(NativeCurrencyAmount),

    /// The transaction is upgraded because we'd like to see it go through for
    /// other reasons than fee-collection. Usually because it affects our
    /// balance in a positive way. This may be because we've already gobbled up
    /// fees from the transaction and we now have an incentive in it being
    /// mined.
    BalanceAffecting(NativeCurrencyAmount),

    /// The transaction is upgraded because it is critical, e.g. a transaction
    /// that we initiated.
    Critical,
}

impl UpgradeIncentive {
    pub fn upgrade_is_worth_it(&self, min_gobbling_fee: NativeCurrencyAmount) -> bool {
        match self {
            UpgradeIncentive::Gobble(gobble_amt) => *gobble_amt >= min_gobbling_fee,
            _ => true,
        }
    }

    /// On successful proof-upgrading, the new transaction will affect our
    /// balance in the case fees were gobbled. Return the upgrade incentive as
    /// it looks after a successful proof-upgrading.
    pub fn after_upgrade(self) -> Self {
        match self {
            UpgradeIncentive::Critical => UpgradeIncentive::Critical,
            UpgradeIncentive::Gobble(native_currency_amount) => {
                UpgradeIncentive::BalanceAffecting(native_currency_amount)
            }
            UpgradeIncentive::BalanceAffecting(native_currency_amount) => {
                UpgradeIncentive::BalanceAffecting(native_currency_amount)
            }
        }
    }
}

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

impl Ord for UpgradeIncentive {
    fn cmp(&self, other: &Self) -> std::cmp::Ordering {
        // Implemented such that balance affecting transactions are always
        // prioritized over the chance to gobble fees.
        use std::cmp::Ordering::Equal;
        use std::cmp::Ordering::Greater;
        use std::cmp::Ordering::Less;

        use UpgradeIncentive::BalanceAffecting;
        use UpgradeIncentive::Critical;
        use UpgradeIncentive::Gobble;
        match (self, other) {
            (Gobble(self_amt), Gobble(other_amt)) => self_amt.cmp(other_amt),
            (Gobble(_), _) => Less,
            (BalanceAffecting(_), Gobble(_)) => Greater,
            (BalanceAffecting(self_amt), BalanceAffecting(other_amt)) => self_amt.cmp(other_amt),
            (BalanceAffecting(_), Critical) => Less,
            (Critical, Critical) => Equal,
            (Critical, _) => Greater,
        }
    }
}