acceptxmr 0.14.0

Accept monero in your application.
Documentation 
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

/// The [`HeightStorage`] trait describes the block height storage
/// layer for `AcceptXMR`. This layer allows the payment gateway to track the
/// most recently scanned block.
pub trait HeightStorage: Send + Sync {
    /// Error type for the storage layer.
    type Error: std::error::Error + Send + 'static;

    /// Updates the payment gateway's block height, or inserts the height if
    /// there is nothing to update. Returns the old height if it existed.
    ///
    /// # Errors
    ///
    /// Returns an error if there was an underlying issue with the database.
    fn upsert(&mut self, height: u64) -> Result<Option<u64>, Self::Error>;

    /// Returns the block height of the payment gateway, if it exists.
    ///
    /// # Errors
    ///
    /// Returns an error if there was an underlying issue with the database.
    fn get(&self) -> Result<Option<u64>, Self::Error>;
}

#[cfg(test)]
#[allow(clippy::unwrap_used, clippy::expect_used)]
mod test {
    use std::fmt::{Debug, Display};

    use test_case::test_case;
    use testing_utils::new_temp_dir;

    use crate::storage::{
        stores::{InMemory, Sled, Sqlite},
        HeightStorage,
    };

    #[test_case(Sled::new(&new_temp_dir(), "invoices", "output keys", "height").unwrap(); "sled")]
    #[test_case(InMemory::new(); "in-memory")]
    #[test_case(Sqlite::new(":memory:", "invoices", "output keys", "height").unwrap(); "sqlite")]
    fn upsert_and_check<S, E>(mut store: S)
    where
        S: HeightStorage<Error = E> + 'static,
        E: Debug + Display + Send,
    {
        store.upsert(123).unwrap();
        assert_eq!(store.get().unwrap(), Some(123));
    }

    #[test_case(Sled::new(&new_temp_dir(), "invoices", "output keys", "height").unwrap(); "sled")]
    #[test_case(InMemory::new(); "in-memory")]
    #[test_case(Sqlite::new(":memory:", "invoices", "output keys", "height").unwrap(); "sqlite")]
    fn upsert_existing<S, E>(mut store: S)
    where
        S: HeightStorage<Error = E> + 'static,
        E: Debug + Display + Send,
    {
        store.upsert(123).unwrap();
        assert_eq!(store.get().unwrap(), Some(123));

        assert_eq!(store.upsert(124).unwrap(), Some(123));
        assert_eq!(store.get().unwrap(), Some(124));
    }

    #[test_case(&Sled::new(&new_temp_dir(), "invoices", "output keys", "height").unwrap(); "sled")]
    #[test_case(&InMemory::new(); "in-memory")]
    #[test_case(&Sqlite::new(":memory:", "invoices", "output keys", "height").unwrap(); "sqlite")]
    fn doesnt_contain_key<S, E>(store: &S)
    where
        S: HeightStorage<Error = E> + 'static,
        E: Debug + Display + Send,
    {
        assert!(store.get().unwrap().is_none());
    }
}