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
// Copyright 2015-2020 Parity Technologies (UK) Ltd.
// This file is part of OpenEthereum.

// OpenEthereum is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.

// OpenEthereum is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.

//! Helper type with all filter state data.

use cfx_types::H256;

use parking_lot::Mutex;
use primitives::filter::LogFilter;
use std::{
    collections::{BTreeSet, VecDeque},
    sync::Arc,
};

pub type EpochNumber = u64;

/// Thread-safe filter state.
#[derive(Clone)]
pub struct SyncPollFilter<T>(Arc<Mutex<PollFilter<T>>>);

impl<T> SyncPollFilter<T> {
    /// New `SyncPollFilter`
    pub fn new(f: PollFilter<T>) -> Self {
        SyncPollFilter(Arc::new(Mutex::new(f)))
    }

    /// Modify underlying filter
    pub fn modify<F, R>(&self, f: F) -> R
    where F: FnOnce(&mut PollFilter<T>) -> R {
        f(&mut self.0.lock())
    }
}

/// Filter state.
#[derive(Clone)]
pub enum PollFilter<T> {
    /// Number of last block which client was notified about.
    Block {
        last_epoch_number: EpochNumber,
        #[doc(hidden)]
        recent_reported_epochs: VecDeque<(EpochNumber, Vec<H256>)>,
    },
    /// Hashes of all pending transactions the client knows about.
    PendingTransaction(BTreeSet<H256>),
    /// Number of From block number, last seen block hash, pending logs and log
    /// filter itself.
    Logs {
        last_epoch_number: EpochNumber,
        recent_reported_epochs: VecDeque<(EpochNumber, Vec<H256>)>,
        previous_logs: VecDeque<Vec<T>>,
        filter: LogFilter,
        include_pending: bool,
    },
}

pub const MAX_BLOCK_HISTORY_SIZE: usize = 200;

/// Returns only last `n` logs
pub fn limit_logs<T>(mut logs: Vec<T>, limit: Option<usize>) -> Vec<T> {
    let len = logs.len();
    match limit {
        Some(limit) if len >= limit => logs.split_off(len - limit),
        _ => logs,
    }
}