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
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

#[cfg(feature = "bincode")]
use bincode::{Decode, Encode};
#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};

/// The [`OutputKeyStorage`] trait describes the output public key storage layer
/// for `AcceptXMR`. This layer is necessary for protection against the [burning
/// bug](https://www.getmonero.org/2018/09/25/a-post-mortum-of-the-burning-bug.html).
pub trait OutputKeyStorage: Send + Sync {
    /// Error type for the storage layer.
    type Error: std::error::Error + Send + 'static;

    /// Insert an output's public key into storage.
    ///
    /// # Errors
    ///
    /// Returns an error if the key could not be inserted, or if it already
    /// exists.
    fn insert(&mut self, key: OutputPubKey, output_id: OutputId) -> Result<(), Self::Error>;

    /// Returns the output ID associated with the given key, if it exists.
    ///
    /// # Errors
    ///
    /// Returns an error if there was an underlying issue with the database.
    fn get(&self, key: OutputPubKey) -> Result<Option<OutputId>, Self::Error>;
}

/// An output's public key.
#[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "bincode", derive(Encode, Decode))]
pub struct OutputPubKey(pub [u8; 32]);

impl AsRef<[u8]> for OutputPubKey {
    fn as_ref(&self) -> &[u8] {
        self.0.as_ref()
    }
}

/// A means of referring to a given output. Consists of a transaction hash and
/// the output's index in the transaction.
#[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "bincode", derive(Encode, Decode))]
pub struct OutputId {
    /// Hash of the transaction the output is part of.
    pub tx_hash: [u8; 32],
    /// Index of the output in the transaction.
    pub index: u8,
}

#[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},
        OutputId, OutputKeyStorage, OutputPubKey,
    };

    fn dummy_key() -> OutputPubKey {
        OutputPubKey([0; 32])
    }

    fn dummy_id() -> OutputId {
        OutputId {
            tx_hash: [0; 32],
            index: 13,
        }
    }

    #[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 insert_and_check<S, E>(mut store: S)
    where
        S: OutputKeyStorage<Error = E> + 'static,
        E: Debug + Display + Send,
    {
        let key = dummy_key();
        let output_id = dummy_id();
        store.insert(key, output_id).unwrap();
        assert_eq!(store.get(key).unwrap(), Some(output_id));
    }

    #[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 insert_existing<S, E>(mut store: S)
    where
        S: OutputKeyStorage<Error = E> + 'static,
        E: Debug + Display + Send,
    {
        let key = dummy_key();
        let output_id = dummy_id();

        store.insert(key, output_id).unwrap();
        assert_eq!(store.get(key).unwrap(), Some(output_id));

        store
            .insert(key, output_id)
            .expect_err("inserting existing key should fail");
        // Check that the key is still present.
        assert_eq!(store.get(key).unwrap(), Some(output_id));
    }

    #[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>(mut store: S)
    where
        S: OutputKeyStorage<Error = E> + 'static,
        E: Debug + Display + Send,
    {
        let key = OutputPubKey([1; 32]);
        let output_id = dummy_id();

        store.insert(key, output_id).unwrap();

        assert!(store.get(dummy_key()).unwrap().is_none());
    }
}