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

// Copyright 2024 MaidSafe.net limited.
//
// This SAFE Network Software is licensed to you under The General Public License (GPL), version 3.
// Unless required by applicable law or agreed to in writing, the SAFE Network Software distributed
// under the GPL Licence is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. Please review the Licences for the specific language governing
// permissions and limitations relating to use of the SAFE Network Software.

use crate::{Result, TransferError};

use super::UniquePubkey;

use serde::{Deserialize, Serialize};
use std::{fmt, hash::Hash};
use xor_name::XorName;

/// The address of a SignedSpend in the network.
/// This is used to check if a CashNote is spent, note that the actual CashNote is not stored on the Network.
#[derive(Clone, Copy, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub struct SpendAddress(XorName);

impl SpendAddress {
    /// Construct a `SpendAddress` given an `XorName`.
    pub fn new(name: XorName) -> Self {
        Self(name)
    }

    /// Construct a `SpendAddress` from a `UniquePubkey`.
    pub fn from_unique_pubkey(unique_pubkey: &UniquePubkey) -> Self {
        Self::new(XorName::from_content(&unique_pubkey.to_bytes()))
    }

    /// Return the name, which is the hash of `UniquePubkey`.
    pub fn xorname(&self) -> &XorName {
        &self.0
    }

    pub fn to_hex(&self) -> String {
        hex::encode(self.0)
    }

    pub fn from_hex(hex: &str) -> Result<Self> {
        let bytes =
            hex::decode(hex).map_err(|e| TransferError::HexDeserializationFailed(e.to_string()))?;
        let xorname = XorName(bytes.try_into().map_err(|_| {
            TransferError::HexDeserializationFailed("wrong string size".to_string())
        })?);
        Ok(Self::new(xorname))
    }
}

impl std::fmt::Debug for SpendAddress {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "SpendAddress({})", &self.to_hex()[0..6])
    }
}

impl std::str::FromStr for SpendAddress {
    type Err = TransferError;

    fn from_str(s: &str) -> Result<Self> {
        let pk_res = UniquePubkey::from_hex(s);
        let addr_res = SpendAddress::from_hex(s);

        match (pk_res, addr_res) {
            (Ok(pk), _) => Ok(SpendAddress::from_unique_pubkey(&pk)),
            (_, Ok(addr)) => Ok(addr),
            _ => Err(TransferError::HexDeserializationFailed(
                "Invalid SpendAddress".to_string(),
            )),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use bls::SecretKey;
    use std::str::FromStr;

    #[test]
    fn test_spend_address_hex_conversions() -> eyre::Result<()> {
        let mut rng = rand::thread_rng();
        let spend_address = SpendAddress::new(XorName::random(&mut rng));
        let hex = spend_address.to_hex();
        let spend_address2 = SpendAddress::from_hex(&hex)?;
        assert_eq!(spend_address, spend_address2);
        Ok(())
    }

    #[test]
    fn test_from_str() -> eyre::Result<()> {
        let public_key = SecretKey::random().public_key();
        let unique_pk = UniquePubkey::new(public_key);
        let spend_address = SpendAddress::from_unique_pubkey(&unique_pk);
        let addr_hex = spend_address.to_hex();
        let unique_pk_hex = unique_pk.to_hex();

        let addr = SpendAddress::from_str(&addr_hex)?;
        assert_eq!(addr, spend_address);

        let addr2 = SpendAddress::from_str(&unique_pk_hex)?;
        assert_eq!(addr2, spend_address);
        Ok(())
    }
}