Finish migration of TransparentAddress out of addresses.rs
This commit is contained in:
Deirdre Connolly
Deirdre Connolly
parent
7ea39fbdce
commit
3fbfd10f2c
|
|
@ -1,252 +1,3 @@
|
|||
//! Address types.
|
||||
|
||||
use std::{fmt, io};
|
||||
|
||||
use bs58;
|
||||
use ripemd160::{Digest, Ripemd160};
|
||||
use secp256k1::PublicKey;
|
||||
use sha2::Sha256;
|
||||
|
||||
#[cfg(test)]
|
||||
use proptest::{arbitrary::Arbitrary, collection::vec, prelude::*};
|
||||
|
||||
use crate::{
|
||||
serialization::{SerializationError, ZcashDeserialize, ZcashSerialize},
|
||||
types::Script,
|
||||
Network,
|
||||
};
|
||||
|
||||
/// Transparent Zcash Addresses
|
||||
///
|
||||
/// In Bitcoin a single byte is used for the version field identifying
|
||||
/// the address type. In Zcash two bytes are used. For addresses on
|
||||
/// the production network, this and the encoded length cause the first
|
||||
/// two characters of the Base58Check encoding to be xed as “t3” for
|
||||
/// P2SH addresses, and as “t1” for P2PKH addresses. (This does not
|
||||
/// imply that a transparent Zcash address can be parsed identically
|
||||
/// to a Bitcoin address just by removing the “t”.)
|
||||
///
|
||||
/// https://zips.z.cash/protocol/protocol.pdf#transparentaddrencoding
|
||||
#[derive(Copy, Clone, Eq, PartialEq)]
|
||||
pub enum TransparentAddress {
|
||||
/// P2SH (Pay to Script Hash) addresses
|
||||
PayToScriptHash {
|
||||
/// Production, test, or other network
|
||||
network: Network,
|
||||
/// 20 bytes specifying a script hash.
|
||||
script_hash: [u8; 20],
|
||||
},
|
||||
/// P2PKH (Pay to Public Key Hash) addresses
|
||||
PayToPublicKeyHash {
|
||||
/// Production, test, or other network
|
||||
network: Network,
|
||||
/// 20 bytes specifying a public key hash, which is a RIPEMD-160
|
||||
/// hash of a SHA-256 hash of a compressed ECDSA key encoding.
|
||||
pub_key_hash: [u8; 20],
|
||||
},
|
||||
}
|
||||
|
||||
impl TransparentAddress {
|
||||
/// A hash of a transparent address payload, as used in
|
||||
/// transparent pay-to-script-hash and pay-to-publickey-hash
|
||||
/// addresses.
|
||||
///
|
||||
/// The resulting hash in both of these cases is always exactly 20
|
||||
/// bytes. These are big-endian.
|
||||
/// https://en.bitcoin.it/Base58Check_encoding#Encoding_a_Bitcoin_address
|
||||
fn hash_payload(bytes: &[u8]) -> [u8; 20] {
|
||||
let sha_hash = Sha256::digest(bytes);
|
||||
let ripe_hash = Ripemd160::digest(&sha_hash);
|
||||
let mut payload = [0u8; 20];
|
||||
payload[..].copy_from_slice(&ripe_hash[..]);
|
||||
payload
|
||||
}
|
||||
}
|
||||
|
||||
impl From<Script> for TransparentAddress {
|
||||
fn from(script: Script) -> Self {
|
||||
TransparentAddress::PayToScriptHash {
|
||||
network: Network::Mainnet,
|
||||
script_hash: Self::hash_payload(&script.0[..]),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl From<PublicKey> for TransparentAddress {
|
||||
fn from(pub_key: PublicKey) -> Self {
|
||||
TransparentAddress::PayToPublicKeyHash {
|
||||
network: Network::Mainnet,
|
||||
pub_key_hash: Self::hash_payload(&pub_key.serialize()[..]),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl fmt::Debug for TransparentAddress {
|
||||
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
||||
let mut bytes = io::Cursor::new(Vec::new());
|
||||
let _ = self.zcash_serialize(&mut bytes);
|
||||
|
||||
f.debug_tuple("TransparentAddress")
|
||||
.field(&bs58::encode(bytes.get_ref()).with_check().into_string())
|
||||
.finish()
|
||||
}
|
||||
}
|
||||
|
||||
impl ZcashSerialize for TransparentAddress {
|
||||
fn zcash_serialize<W: io::Write>(&self, mut writer: W) -> Result<(), io::Error> {
|
||||
match self {
|
||||
TransparentAddress::PayToScriptHash {
|
||||
network,
|
||||
script_hash,
|
||||
} => {
|
||||
// Dev network doesn't have a recommendation so we
|
||||
// default to testnet bytes if it's not mainnet.
|
||||
if *network == Network::Mainnet {
|
||||
writer.write_all(&[0x1C, 0xBD][..])?
|
||||
} else {
|
||||
writer.write_all(&[0x1C, 0xBA][..])?
|
||||
}
|
||||
writer.write_all(script_hash)?
|
||||
}
|
||||
TransparentAddress::PayToPublicKeyHash {
|
||||
network,
|
||||
pub_key_hash,
|
||||
} => {
|
||||
// Dev network doesn't have a recommendation so we
|
||||
// default to testnet bytes if it's not mainnet.
|
||||
if *network == Network::Mainnet {
|
||||
writer.write_all(&[0x1C, 0xB8][..])?
|
||||
} else {
|
||||
writer.write_all(&[0x1D, 0x25][..])?
|
||||
}
|
||||
writer.write_all(pub_key_hash)?
|
||||
}
|
||||
}
|
||||
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
||||
impl ZcashDeserialize for TransparentAddress {
|
||||
fn zcash_deserialize<R: io::Read>(mut reader: R) -> Result<Self, SerializationError> {
|
||||
let mut version_bytes = [0; 2];
|
||||
reader.read_exact(&mut version_bytes)?;
|
||||
|
||||
let mut hash_bytes = [0; 20];
|
||||
reader.read_exact(&mut hash_bytes)?;
|
||||
|
||||
match version_bytes {
|
||||
[0x1c, 0xbd] => Ok(TransparentAddress::PayToScriptHash {
|
||||
network: Network::Mainnet,
|
||||
script_hash: hash_bytes,
|
||||
}),
|
||||
[0x1c, 0xba] => Ok(TransparentAddress::PayToScriptHash {
|
||||
network: Network::Testnet,
|
||||
script_hash: hash_bytes,
|
||||
}),
|
||||
[0x1c, 0xb8] => Ok(TransparentAddress::PayToPublicKeyHash {
|
||||
network: Network::Mainnet,
|
||||
pub_key_hash: hash_bytes,
|
||||
}),
|
||||
[0x1d, 0x25] => Ok(TransparentAddress::PayToPublicKeyHash {
|
||||
network: Network::Testnet,
|
||||
pub_key_hash: hash_bytes,
|
||||
}),
|
||||
_ => Err(SerializationError::Parse("bad t-addr version/type")),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
impl TransparentAddress {
|
||||
fn p2pkh_strategy() -> impl Strategy<Value = Self> {
|
||||
(any::<Network>(), vec(any::<u8>(), 20))
|
||||
.prop_map(|(network, payload_bytes)| {
|
||||
let mut bytes = [0; 20];
|
||||
bytes.copy_from_slice(payload_bytes.as_slice());
|
||||
return Self::PayToPublicKeyHash {
|
||||
network,
|
||||
pub_key_hash: bytes,
|
||||
};
|
||||
})
|
||||
.boxed()
|
||||
}
|
||||
|
||||
fn p2sh_strategy() -> impl Strategy<Value = Self> {
|
||||
(any::<Network>(), vec(any::<u8>(), 20))
|
||||
.prop_map(|(network, payload_bytes)| {
|
||||
let mut bytes = [0; 20];
|
||||
bytes.copy_from_slice(payload_bytes.as_slice());
|
||||
return Self::PayToScriptHash {
|
||||
network,
|
||||
script_hash: bytes,
|
||||
};
|
||||
})
|
||||
.boxed()
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
impl Arbitrary for TransparentAddress {
|
||||
type Parameters = ();
|
||||
|
||||
fn arbitrary_with(_args: Self::Parameters) -> Self::Strategy {
|
||||
prop_oneof![Self::p2pkh_strategy(), Self::p2sh_strategy(),].boxed()
|
||||
}
|
||||
|
||||
type Strategy = BoxedStrategy<Self>;
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
|
||||
use secp256k1::PublicKey;
|
||||
|
||||
use crate::types::Script;
|
||||
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn pubkey() {
|
||||
let pub_key = PublicKey::from_slice(&[
|
||||
3, 23, 183, 225, 206, 31, 159, 148, 195, 42, 67, 115, 146, 41, 248, 140, 11, 3, 51, 41,
|
||||
111, 180, 110, 143, 114, 134, 88, 73, 198, 174, 52, 184, 78,
|
||||
])
|
||||
.expect("A PublicKey from slice");
|
||||
|
||||
let t_addr = TransparentAddress::from(pub_key);
|
||||
|
||||
assert_eq!(
|
||||
format!("{:?}", t_addr),
|
||||
"TransparentAddress(\"t1bmMa1wJDFdbc2TiURQP5BbBz6jHjUBuHq\")"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn empty_script() {
|
||||
let script = Script(vec![0; 20]);
|
||||
|
||||
let t_addr = TransparentAddress::from(script);
|
||||
|
||||
assert_eq!(
|
||||
format!("{:?}", t_addr),
|
||||
"TransparentAddress(\"t3Y5pHwfgHbS6pDjj1HLuMFxhFFip1fcJ6g\")"
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
proptest! {
|
||||
|
||||
#[test]
|
||||
fn transparent_address_roundtrip(taddr in any::<TransparentAddress>()) {
|
||||
|
||||
let mut data = Vec::new();
|
||||
|
||||
taddr.zcash_serialize(&mut data).expect("t-addr should serialize");
|
||||
|
||||
let taddr2 = TransparentAddress::zcash_deserialize(&data[..]).expect("randomized t-addr should deserialize");
|
||||
|
||||
prop_assert_eq![taddr, taddr2];
|
||||
}
|
||||
}
|
||||
pub mod transparent;
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
//! Key types.
|
||||
|
||||
mod sapling;
|
||||
mod sprout;
|
||||
mod transparent;
|
||||
pub mod sapling;
|
||||
pub mod sprout;
|
||||
pub mod transparent;
|
||||
|
|
|
|||
Loading…
Reference in New Issue