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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
/// The transaction selector is responsible for filtering transactions
/// in the plugin framework.
use {log::*, solana_sdk::pubkey::Pubkey, std::collections::HashSet};

pub(crate) struct TransactionSelector {
    pub mentioned_addresses: HashSet<Vec<u8>>,
    pub select_all_transactions: bool,
    pub select_all_vote_transactions: bool,
}

#[allow(dead_code)]
impl TransactionSelector {
    pub fn default() -> Self {
        Self {
            mentioned_addresses: HashSet::default(),
            select_all_transactions: false,
            select_all_vote_transactions: false,
        }
    }

    /// Create a selector based on the mentioned addresses
    /// To select all transactions use ["*"] or ["all"]
    /// To select all vote transactions, use ["all_votes"]
    /// To select transactions mentioning specific addresses use ["<pubkey1>", "<pubkey2>", ...]
    pub fn new(mentioned_addresses: &[String]) -> Self {
        info!(
            "Creating TransactionSelector from addresses: {:?}",
            mentioned_addresses
        );

        let select_all_transactions = mentioned_addresses
            .iter()
            .any(|key| key == "*" || key == "all");
        if select_all_transactions {
            return Self {
                mentioned_addresses: HashSet::default(),
                select_all_transactions,
                select_all_vote_transactions: true,
            };
        }
        let select_all_vote_transactions = mentioned_addresses.iter().any(|key| key == "all_votes");
        if select_all_vote_transactions {
            return Self {
                mentioned_addresses: HashSet::default(),
                select_all_transactions,
                select_all_vote_transactions: true,
            };
        }

        let mentioned_addresses = mentioned_addresses
            .iter()
            .map(|key| bs58::decode(key).into_vec().unwrap())
            .collect();

        Self {
            mentioned_addresses,
            select_all_transactions: false,
            select_all_vote_transactions: false,
        }
    }

    /// Check if a transaction is of interest.
    pub fn is_transaction_selected(
        &self,
        is_vote: bool,
        mentioned_addresses: Box<dyn Iterator<Item = &Pubkey> + '_>,
    ) -> bool {
        if !self.is_enabled() {
            return false;
        }

        if self.select_all_transactions || (self.select_all_vote_transactions && is_vote) {
            return true;
        }
        for address in mentioned_addresses {
            if self.mentioned_addresses.contains(address.as_ref()) {
                return true;
            }
        }
        false
    }

    /// Check if any transaction is of interest at all
    pub fn is_enabled(&self) -> bool {
        self.select_all_transactions
            || self.select_all_vote_transactions
            || !self.mentioned_addresses.is_empty()
    }
}

#[cfg(test)]
pub(crate) mod tests {
    use super::*;

    #[test]
    fn test_select_transaction() {
        let pubkey1 = Pubkey::new_unique();
        let pubkey2 = Pubkey::new_unique();

        let selector = TransactionSelector::new(&[pubkey1.to_string()]);

        assert!(selector.is_enabled());

        let addresses = [pubkey1];

        assert!(selector.is_transaction_selected(false, Box::new(addresses.iter())));

        let addresses = [pubkey2];
        assert!(!selector.is_transaction_selected(false, Box::new(addresses.iter())));

        let addresses = [pubkey1, pubkey2];
        assert!(selector.is_transaction_selected(false, Box::new(addresses.iter())));
    }

    #[test]
    fn test_select_all_transaction_using_wildcard() {
        let pubkey1 = Pubkey::new_unique();
        let pubkey2 = Pubkey::new_unique();

        let selector = TransactionSelector::new(&["*".to_string()]);

        assert!(selector.is_enabled());

        let addresses = [pubkey1];

        assert!(selector.is_transaction_selected(false, Box::new(addresses.iter())));

        let addresses = [pubkey2];
        assert!(selector.is_transaction_selected(false, Box::new(addresses.iter())));

        let addresses = [pubkey1, pubkey2];
        assert!(selector.is_transaction_selected(false, Box::new(addresses.iter())));
    }

    #[test]
    fn test_select_all_transaction_all() {
        let pubkey1 = Pubkey::new_unique();
        let pubkey2 = Pubkey::new_unique();

        let selector = TransactionSelector::new(&["all".to_string()]);

        assert!(selector.is_enabled());

        let addresses = [pubkey1];

        assert!(selector.is_transaction_selected(false, Box::new(addresses.iter())));

        let addresses = [pubkey2];
        assert!(selector.is_transaction_selected(false, Box::new(addresses.iter())));

        let addresses = [pubkey1, pubkey2];
        assert!(selector.is_transaction_selected(false, Box::new(addresses.iter())));
    }

    #[test]
    fn test_select_all_vote_transaction() {
        let pubkey1 = Pubkey::new_unique();
        let pubkey2 = Pubkey::new_unique();

        let selector = TransactionSelector::new(&["all_votes".to_string()]);

        assert!(selector.is_enabled());

        let addresses = [pubkey1];

        assert!(!selector.is_transaction_selected(false, Box::new(addresses.iter())));

        let addresses = [pubkey2];
        assert!(selector.is_transaction_selected(true, Box::new(addresses.iter())));

        let addresses = [pubkey1, pubkey2];
        assert!(selector.is_transaction_selected(true, Box::new(addresses.iter())));
    }

    #[test]
    fn test_select_no_transaction() {
        let pubkey1 = Pubkey::new_unique();
        let pubkey2 = Pubkey::new_unique();

        let selector = TransactionSelector::new(&[]);

        assert!(!selector.is_enabled());

        let addresses = [pubkey1];

        assert!(!selector.is_transaction_selected(false, Box::new(addresses.iter())));

        let addresses = [pubkey2];
        assert!(!selector.is_transaction_selected(true, Box::new(addresses.iter())));

        let addresses = [pubkey1, pubkey2];
        assert!(!selector.is_transaction_selected(true, Box::new(addresses.iter())));
    }
}