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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
use std::hash::{Hash, Hasher};
use std::ops::Deref;
use multiversx_sc::api::ManagedTypeApi;
use multiversx_sc::types::ManagedAddress;
use multiversx_sc_codec::{DecodeError, TopDecode, TopDecodeInput};
use multiversx_sc_scenario::api::StaticApi;
use multiversx_sc_scenario::scenario_model::AddressValue;
use multiversx_sdk::data::address::Address as SDKAddress;
use serde::{Deserialize, Deserializer, Serialize};
use serde::de::Error;
use crate::error::AddressError;
use crate::error::DataError;
use crate::types::managed::ManagedConvertible;
use crate::types::native::NativeConvertible;

/// A struct representing a blockchain address.
/// This struct provides various utility methods for working with addresses,
/// including conversions from and to Bech32 string representations and byte arrays.
///
/// # Serialization
/// This struct is serializable with the `serde` crate.
///
/// # Cloning
/// Cloning is supported.
///
/// # Debugging
/// Debug printouts are supported.
///
/// # Examples
///
/// Basic usage:
///
/// ```
/// # use novax_data::Address;
/// let address = Address::from_bech32_string("erd1qqqqqqqqqqqqqpgq7ykazrzd905zvnlr88dpfw06677lxe9w0n4suz00uh").unwrap();
/// let bech32 = address.to_bech32_string().unwrap();
/// assert_eq!(bech32, "erd1qqqqqqqqqqqqqpgq7ykazrzd905zvnlr88dpfw06677lxe9w0n4suz00uh");
/// ```
#[derive(Serialize, Clone, Debug)]
pub struct Address(SDKAddress);


impl PartialEq for Address {
    fn eq(&self, other: &Self) -> bool {
        self.to_bytes() == other.to_bytes()
    }
}

/// The `Address` struct provides an abstraction over a blockchain address,
/// with various utility methods for working with addresses.
impl Address {
    /// Creates an `Address` instance from a Bech32 string representation.
    ///
    /// # Parameters
    /// - `bech32`: The Bech32 string representation of the address.
    ///
    /// # Returns
    /// - An `Ok(Address)` instance if the conversion is successful.
    /// - An `Err(DataError)` if the Bech32 string is invalid.
    ///
    /// # Example
    /// ```
    /// # use novax_data::Address;
    /// let address = Address::from_bech32_string("erd1qqqqqqqqqqqqqpgq7ykazrzd905zvnlr88dpfw06677lxe9w0n4suz00uh").unwrap();
    /// ```
    pub fn from_bech32_string(bech32: &str) -> Result<Address, DataError> {
        let Ok(address) = SDKAddress::from_bech32_string(bech32) else { return Err(AddressError::InvalidBech32String { invalid_value: bech32.to_string() }.into()) };

        Ok(Address(address))
    }

    /// Creates an `Address` instance from a byte array.
    ///
    /// # Parameters
    /// - `bytes`: A byte array of length 32.
    ///
    /// # Returns
    /// - An `Address` instance.
    ///
    /// # Example
    /// ```
    /// # use novax_data::Address;
    /// let address = Address::from_bytes([0_u8; 32]);
    /// ```
    pub fn from_bytes(bytes: [u8; 32]) -> Address {
        Address(SDKAddress::from_bytes(bytes))
    }

    /// Converts the `Address` instance to a Bech32 string representation.
    ///
    /// # Returns
    /// - An `Ok(String)` containing the Bech32 string representation if successful.
    /// - An `Err(DataError)` if the conversion fails.
    ///
    /// # Example
    /// ```
    /// # use novax_data::Address;
    /// # let address = Address::from_bytes([0_u8; 32]);
    /// let bech32_string = address.to_bech32_string().unwrap();
    /// ```
    pub fn to_bech32_string(&self) -> Result<String, DataError> {
        let Ok(string) = self.0.to_bech32_string() else {
            return Err(AddressError::CannotConvertToBech32String.into())
        };

        Ok(string)
    }

    /// Converts the `Address` instance to a byte array.
    ///
    /// # Returns
    /// - A byte array of length 32.
    ///
    /// # Example
    /// ```
    /// # use novax_data::Address;
    /// # let address = Address::from_bytes([0_u8; 32]);
    /// let bytes = address.to_bytes();
    /// assert_eq!(bytes, [0_u8; 32]);
    /// ```
    pub fn to_bytes(&self) -> [u8; 32] {
        self.0.to_bytes()
    }
}


impl Deref for Address {
    type Target = multiversx_sdk::data::address::Address;

    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl Hash for Address {
    fn hash<H: Hasher>(&self, state: &mut H) {
        self.0.to_bytes().hash(state)
    }
}

impl<M: ManagedTypeApi> NativeConvertible for ManagedAddress<M> {
    type Native = Address;

    fn to_native(&self) -> Self::Native {
        Address(SDKAddress::from_bytes(self.to_byte_array()))
    }
}

impl NativeConvertible for Address {
    type Native = Self;

    fn to_native(&self) -> Self::Native {
        self.clone()
    }
}

impl ManagedConvertible<ManagedAddress<StaticApi>> for Address {
    fn to_managed(&self) -> ManagedAddress<StaticApi> {
        ManagedAddress::from_address(&multiversx_sc::types::Address::from(self.to_bytes()))
    }
}

impl TopDecode for Address {
    fn top_decode<I>(input: I) -> Result<Self, DecodeError> where I: TopDecodeInput {
        let bytes = ManagedAddress::<StaticApi>::top_decode(input)?.to_byte_array();
        Ok(Address(SDKAddress::from_bytes(bytes)))
    }
}

impl From<&Address> for AddressValue {
    fn from(value: &Address) -> Self {
        (&multiversx_sc::types::Address::from(value.0.to_bytes())).into()
    }
}

impl From<SDKAddress> for Address {
    fn from(value: SDKAddress) -> Self {
        Address::from_bytes(value.to_bytes())
    }
}

impl From<&SDKAddress> for Address {
    fn from(value: &SDKAddress) -> Self {
        Address::from_bytes(value.to_bytes())
    }
}

impl From<&multiversx_sc::types::Address> for Address {
    fn from(value: &multiversx_sc::types::Address) -> Self {
        Address::from_bytes(*value.as_array())
    }
}

impl From<multiversx_sc::types::Address> for Address {
    fn from(value: multiversx_sc::types::Address) -> Self {
        Address::from_bytes(*value.as_array())
    }
}

impl From<Address> for multiversx_sc::types::Address {
    fn from(value: Address) -> Self {
        multiversx_sc::types::Address::from(value.to_bytes())
    }
}

impl From<&str> for Address {
    fn from(value: &str) -> Self {
        if value.starts_with("erd1") {
            Address::from_bech32_string(value).unwrap()
        } else {
            (&AddressValue::from(value).value).into()
        }
    }
}

impl From<&String> for Address {
    fn from(value: &String) -> Self {
        From::<&str>::from(value)
    }
}

impl<'a> Deserialize<'a> for Address {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where D: Deserializer<'a> {
        let string = String::deserialize(deserializer)?;

        let Ok(address) = Address::from_bech32_string(&string) else {
            return Err(D::Error::custom(format!("Cannot parse bech32 address : {string}")))
        };

        Ok(address)
    }
}

#[cfg(test)]
mod tests {
    use multiversx_sc::types::ManagedAddress;
    use multiversx_sc_scenario::api::StaticApi;
    use crate::{Address, AddressError, DataError};
    use crate::types::managed::ManagedConvertible;
    use crate::types::native::NativeConvertible;

    #[test]
    fn test_managed_address_to_native() {
        let expected = Address::from_bech32_string("erd1qqqqqqqqqqqqqpgq7ykazrzd905zvnlr88dpfw06677lxe9w0n4suz00uh").unwrap();
        let managed_address: ManagedAddress<StaticApi> = ManagedAddress::from(expected.to_bytes());
        let native = managed_address.to_native();

        assert_eq!(
            native.to_bytes(),
            expected.to_bytes()
        )
    }

    #[test]
    fn test_managed_address_to_managed() {
        let address = Address::from_bech32_string("erd1qqqqqqqqqqqqqpgq7ykazrzd905zvnlr88dpfw06677lxe9w0n4suz00uh").unwrap();
        let managed = address.to_managed();

        assert_eq!(
            address.to_bytes(),
            managed.to_byte_array()
        )
    }

    #[test]
    fn test_from_bech32_string_valid_address() {
        Address::from_bech32_string("erd1an4xpn58j7ymd58m2jznr32t0vmas75egrdfa8mta6fzvqn9tkxq4jvghn").unwrap();
    }

    #[test]
    fn test_from_bech32_string_invalid_address() {
        let str = "erd1an4xpn58j7ymd58m2jznr32t0vmas75egrdfa8mta6fzvqn9tkxq4jvghm";
        let error = Address::from_bech32_string(str).unwrap_err();

        let expected = DataError::Address(AddressError::InvalidBech32String { invalid_value: str.to_string() });

        assert_eq!(error, expected);
    }

    #[test]
    fn test_from_bech32_string_invalid_address_bad_length() {
        let str = "erd1an4xpn58j7ymd58m2jznr32t";
        let error = Address::from_bech32_string(str).unwrap_err();

        let expected = DataError::Address(AddressError::InvalidBech32String { invalid_value: str.to_string() });

        assert_eq!(error, expected);
    }

}