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
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
use std::{error::Error, fmt};

use crate::{kind::*, AddressKind, Network, ZcashAddress};

/// An error indicating that an address type is not supported for conversion.
#[derive(Debug)]
pub struct UnsupportedAddress(&'static str);

impl fmt::Display for UnsupportedAddress {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "Zcash {} addresses are not supported", self.0)
    }
}

/// An error encountered while converting a parsed [`ZcashAddress`] into another type.
#[derive(Debug)]
pub enum ConversionError<E> {
    /// The address is for the wrong network.
    IncorrectNetwork { expected: Network, actual: Network },
    /// The address type is not supported by the target type.
    Unsupported(UnsupportedAddress),
    /// A conversion error returned by the target type.
    User(E),
}

impl<E> From<E> for ConversionError<E> {
    fn from(e: E) -> Self {
        ConversionError::User(e)
    }
}

impl<E: fmt::Display> fmt::Display for ConversionError<E> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::IncorrectNetwork { expected, actual } => write!(
                f,
                "Address is for {:?} but we expected {:?}",
                actual, expected,
            ),
            Self::Unsupported(e) => e.fmt(f),
            Self::User(e) => e.fmt(f),
        }
    }
}

impl Error for UnsupportedAddress {}
impl<E: Error + 'static> Error for ConversionError<E> {
    fn source(&self) -> Option<&(dyn Error + 'static)> {
        match self {
            ConversionError::IncorrectNetwork { .. } | ConversionError::Unsupported(_) => None,
            ConversionError::User(e) => Some(e),
        }
    }
}

/// A helper trait for converting a [`ZcashAddress`] into a network-agnostic type.
///
/// A blanket implementation of [`TryFromAddress`] is provided for `(Network, T)` where
/// `T: TryFromRawAddress`.
///
/// [`ZcashAddress`]: crate::ZcashAddress
///
/// # Examples
///
/// ```
/// use zcash_address::{ConversionError, Network, TryFromRawAddress, UnsupportedAddress, ZcashAddress};
///
/// #[derive(Debug, PartialEq)]
/// struct MySapling([u8; 43]);
///
/// // Implement the TryFromRawAddress trait, overriding whichever conversion methods match
/// // your requirements for the resulting type.
/// impl TryFromRawAddress for MySapling {
///     // In this example we aren't checking the validity of the inner Sapling address,
///     // but your code should do so!
///     type Error = &'static str;
///
///     fn try_from_raw_sapling(data: [u8; 43]) -> Result<Self, ConversionError<Self::Error>> {
///         Ok(MySapling(data))
///     }
/// }
///
/// // For a supported address type, the conversion works.
/// let addr_string = "zs1qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqpq6d8g";
///
/// // You can use `ZcashAddress::convert_if_network` to get your type directly.
/// let addr: ZcashAddress = addr_string.parse().unwrap();
/// let converted = addr.convert_if_network::<MySapling>(Network::Main);
/// assert!(converted.is_ok());
/// assert_eq!(converted.unwrap(), MySapling([0; 43]));
///
/// // Using `ZcashAddress::convert` gives us the tuple `(network, converted_addr)`.
/// let addr: ZcashAddress = addr_string.parse().unwrap();
/// let converted = addr.convert::<(_, MySapling)>();
/// assert!(converted.is_ok());
/// assert_eq!(converted.unwrap(), (Network::Main, MySapling([0; 43])));
///
/// // For an unsupported address type, we get an error.
/// let addr: ZcashAddress = "t1Hsc1LR8yKnbbe3twRp88p6vFfC5t7DLbs".parse().unwrap();
/// assert_eq!(
///     addr.convert::<(_, MySapling)>().unwrap_err().to_string(),
///     "Zcash transparent P2PKH addresses are not supported",
/// );
/// ```
pub trait TryFromRawAddress: Sized {
    /// Conversion errors for the user type (e.g. failing to parse the data passed to
    /// [`Self::try_from_raw_sapling`] as a valid Sapling address).
    type Error;

    fn try_from_raw_sprout(data: [u8; 64]) -> Result<Self, ConversionError<Self::Error>> {
        let _ = data;
        Err(ConversionError::Unsupported(UnsupportedAddress("Sprout")))
    }

    fn try_from_raw_sapling(data: [u8; 43]) -> Result<Self, ConversionError<Self::Error>> {
        let _ = data;
        Err(ConversionError::Unsupported(UnsupportedAddress("Sapling")))
    }

    fn try_from_raw_unified(data: unified::Address) -> Result<Self, ConversionError<Self::Error>> {
        let _ = data;
        Err(ConversionError::Unsupported(UnsupportedAddress("Unified")))
    }

    fn try_from_raw_transparent_p2pkh(
        data: [u8; 20],
    ) -> Result<Self, ConversionError<Self::Error>> {
        let _ = data;
        Err(ConversionError::Unsupported(UnsupportedAddress(
            "transparent P2PKH",
        )))
    }

    fn try_from_raw_transparent_p2sh(data: [u8; 20]) -> Result<Self, ConversionError<Self::Error>> {
        let _ = data;
        Err(ConversionError::Unsupported(UnsupportedAddress(
            "transparent P2SH",
        )))
    }

    fn try_from_raw_tex(data: [u8; 20]) -> Result<Self, ConversionError<Self::Error>> {
        let _ = data;
        Err(ConversionError::Unsupported(UnsupportedAddress(
            "transparent-source restricted P2PKH",
        )))
    }
}

/// A helper trait for converting a [`ZcashAddress`] into another type.
///
/// [`ZcashAddress`]: crate::ZcashAddress
///
/// # Examples
///
/// ```
/// use zcash_address::{ConversionError, Network, TryFromAddress, UnsupportedAddress, ZcashAddress};
///
/// #[derive(Debug)]
/// struct MySapling([u8; 43]);
///
/// // Implement the TryFromAddress trait, overriding whichever conversion methods match your
/// // requirements for the resulting type.
/// impl TryFromAddress for MySapling {
///     // In this example we aren't checking the validity of the inner Sapling address,
///     // but your code should do so!
///     type Error = &'static str;
///
///     fn try_from_sapling(
///         net: Network,
///         data: [u8; 43],
///     ) -> Result<Self, ConversionError<Self::Error>> {
///         Ok(MySapling(data))
///     }
/// }
///
/// // For a supported address type, the conversion works.
/// let addr: ZcashAddress =
///     "zs1qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqpq6d8g"
///         .parse()
///         .unwrap();
/// assert!(addr.convert::<MySapling>().is_ok());
///
/// // For an unsupported address type, we get an error.
/// let addr: ZcashAddress = "t1Hsc1LR8yKnbbe3twRp88p6vFfC5t7DLbs".parse().unwrap();
/// assert_eq!(
///     addr.convert::<MySapling>().unwrap_err().to_string(),
///     "Zcash transparent P2PKH addresses are not supported",
/// );
/// ```
pub trait TryFromAddress: Sized {
    /// Conversion errors for the user type (e.g. failing to parse the data passed to
    /// [`Self::try_from_sapling`] as a valid Sapling address).
    type Error;

    fn try_from_sprout(net: Network, data: [u8; 64]) -> Result<Self, ConversionError<Self::Error>> {
        let _ = (net, data);
        Err(ConversionError::Unsupported(UnsupportedAddress("Sprout")))
    }

    fn try_from_sapling(
        net: Network,
        data: [u8; 43],
    ) -> Result<Self, ConversionError<Self::Error>> {
        let _ = (net, data);
        Err(ConversionError::Unsupported(UnsupportedAddress("Sapling")))
    }

    fn try_from_unified(
        net: Network,
        data: unified::Address,
    ) -> Result<Self, ConversionError<Self::Error>> {
        let _ = (net, data);
        Err(ConversionError::Unsupported(UnsupportedAddress("Unified")))
    }

    fn try_from_transparent_p2pkh(
        net: Network,
        data: [u8; 20],
    ) -> Result<Self, ConversionError<Self::Error>> {
        let _ = (net, data);
        Err(ConversionError::Unsupported(UnsupportedAddress(
            "transparent P2PKH",
        )))
    }

    fn try_from_transparent_p2sh(
        net: Network,
        data: [u8; 20],
    ) -> Result<Self, ConversionError<Self::Error>> {
        let _ = (net, data);
        Err(ConversionError::Unsupported(UnsupportedAddress(
            "transparent P2SH",
        )))
    }

    fn try_from_tex(net: Network, data: [u8; 20]) -> Result<Self, ConversionError<Self::Error>> {
        let _ = (net, data);
        Err(ConversionError::Unsupported(UnsupportedAddress(
            "transparent-source restricted P2PKH",
        )))
    }
}

impl<T: TryFromRawAddress> TryFromAddress for (Network, T) {
    type Error = T::Error;

    fn try_from_sprout(net: Network, data: [u8; 64]) -> Result<Self, ConversionError<Self::Error>> {
        T::try_from_raw_sprout(data).map(|addr| (net, addr))
    }

    fn try_from_sapling(
        net: Network,
        data: [u8; 43],
    ) -> Result<Self, ConversionError<Self::Error>> {
        T::try_from_raw_sapling(data).map(|addr| (net, addr))
    }

    fn try_from_unified(
        net: Network,
        data: unified::Address,
    ) -> Result<Self, ConversionError<Self::Error>> {
        T::try_from_raw_unified(data).map(|addr| (net, addr))
    }

    fn try_from_transparent_p2pkh(
        net: Network,
        data: [u8; 20],
    ) -> Result<Self, ConversionError<Self::Error>> {
        T::try_from_raw_transparent_p2pkh(data).map(|addr| (net, addr))
    }

    fn try_from_transparent_p2sh(
        net: Network,
        data: [u8; 20],
    ) -> Result<Self, ConversionError<Self::Error>> {
        T::try_from_raw_transparent_p2sh(data).map(|addr| (net, addr))
    }

    fn try_from_tex(net: Network, data: [u8; 20]) -> Result<Self, ConversionError<Self::Error>> {
        T::try_from_raw_tex(data).map(|addr| (net, addr))
    }
}

/// A helper trait for converting another type into a [`ZcashAddress`].
///
/// This trait is sealed and cannot be implemented for types outside this crate. Its
/// purpose is to move these conversion functions out of the main `ZcashAddress` API
/// documentation, as they are only required when creating addresses (rather than when
/// parsing addresses, which is a more common occurrence).
///
/// [`ZcashAddress`]: crate::ZcashAddress
///
/// # Examples
///
/// ```
/// use zcash_address::{ToAddress, Network, ZcashAddress};
///
/// #[derive(Debug)]
/// struct MySapling([u8; 43]);
///
/// impl MySapling {
///     /// Encodes this Sapling address for the given network.
///     fn encode(&self, net: Network) -> ZcashAddress {
///         ZcashAddress::from_sapling(net, self.0)
///     }
/// }
///
/// let addr = MySapling([0; 43]);
/// let encoded = addr.encode(Network::Main);
/// assert_eq!(
///     encoded.to_string(),
///     "zs1qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqpq6d8g",
/// );
/// ```
pub trait ToAddress: private::Sealed {
    fn from_sprout(net: Network, data: [u8; 64]) -> Self;

    fn from_sapling(net: Network, data: [u8; 43]) -> Self;

    fn from_unified(net: Network, data: unified::Address) -> Self;

    fn from_transparent_p2pkh(net: Network, data: [u8; 20]) -> Self;

    fn from_transparent_p2sh(net: Network, data: [u8; 20]) -> Self;

    fn from_tex(net: Network, data: [u8; 20]) -> Self;
}

impl ToAddress for ZcashAddress {
    fn from_sprout(net: Network, data: [u8; 64]) -> Self {
        ZcashAddress {
            net: if let Network::Regtest = net {
                Network::Test
            } else {
                net
            },
            kind: AddressKind::Sprout(data),
        }
    }

    fn from_sapling(net: Network, data: [u8; 43]) -> Self {
        ZcashAddress {
            net,
            kind: AddressKind::Sapling(data),
        }
    }

    fn from_unified(net: Network, data: unified::Address) -> Self {
        ZcashAddress {
            net,
            kind: AddressKind::Unified(data),
        }
    }

    fn from_transparent_p2pkh(net: Network, data: [u8; 20]) -> Self {
        ZcashAddress {
            net: if let Network::Regtest = net {
                Network::Test
            } else {
                net
            },
            kind: AddressKind::P2pkh(data),
        }
    }

    fn from_transparent_p2sh(net: Network, data: [u8; 20]) -> Self {
        ZcashAddress {
            net: if let Network::Regtest = net {
                Network::Test
            } else {
                net
            },
            kind: AddressKind::P2sh(data),
        }
    }

    fn from_tex(net: Network, data: [u8; 20]) -> Self {
        ZcashAddress {
            net,
            kind: AddressKind::Tex(data),
        }
    }
}

mod private {
    use crate::ZcashAddress;

    pub trait Sealed {}
    impl Sealed for ZcashAddress {}
}