      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

    //! `AddressHash` with network identifier and format type
    //!
    //! A Bitcoin address, or simply address, is an identifier of 26-35 alphanumeric characters, beginning with the number 1
    //! or 3, that represents a possible destination for a bitcoin payment.
    //!
    //! https://en.bitcoin.it/wiki/Address

    use std::fmt;
    use std::str::FromStr;
    use std::ops::Deref;
    use base58::{ToBase58, FromBase58};
    use crypto::checksum;
    use network::Network;
    use {DisplayLayout, Error, AddressHash};

    /// There are two address formats currently in use.
    /// https://bitcoin.org/en/developer-reference#address-conversion
    #[derive(Debug, PartialEq, Clone, Copy)]
    pub enum Type {
    	/// Pay to PubKey Hash
    	/// Common P2PKH which begin with the number 1, eg: 1BvBMSEYstWetqTFn5Au4m4GFg7xJaNVN2.
    	/// https://bitcoin.org/en/glossary/p2pkh-address
    	P2PKH,
    	/// Pay to Script Hash
    	/// Newer P2SH type starting with the number 3, eg: 3J98t1WpEZ73CNmQviecrnyiWrnqRhWNLy.
    	/// https://bitcoin.org/en/glossary/p2sh-address
    	P2SH,
    }

    /// `AddressHash` with network identifier and format type
    #[derive(Debug, PartialEq, Clone)]
    pub struct Address {
    	/// The type of the address.
    	pub kind: Type,
    	/// The network of the address.
    	pub network: Network,
    	/// Public key hash.
    	pub hash: AddressHash,
    }

    pub struct AddressDisplayLayout([u8; 25]);

    impl Deref for AddressDisplayLayout {
    	type Target = [u8];

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

    impl DisplayLayout for Address {
    	type Target = AddressDisplayLayout;

    	fn layout(&self) -> Self::Target {
    		let mut result = [0u8; 25];

    		result[0] = match (self.network, self.kind) {
    			(Network::Mainnet, Type::P2PKH) => 0,
    			(Network::Mainnet, Type::P2SH) => 5,
    			(Network::Testnet, Type::P2PKH) => 111,
    			(Network::Testnet, Type::P2SH) => 196,
    		};

    		result[1..21].copy_from_slice(&*self.hash);
    		let cs = checksum(&result[0..21]);
    		result[21..25].copy_from_slice(&*cs);
    		AddressDisplayLayout(result)
    	}

    	fn from_layout(data: &[u8]) -> Result<Self, Error> where Self: Sized {
    		if data.len() != 25 {
    			return Err(Error::InvalidAddress);
    		}

    		let cs = checksum(&data[0..21]);
    		if &data[21..] != &*cs {
    			return Err(Error::InvalidChecksum);
    		}

    		let (network, kind) = match data[0] {
    			0 => (Network::Mainnet, Type::P2PKH),
    			5 => (Network::Mainnet, Type::P2SH),
    			111 => (Network::Testnet, Type::P2PKH),
    			196 => (Network::Testnet, Type::P2SH),
    			_ => return Err(Error::InvalidAddress),
    		};

    		let mut hash = AddressHash::default();
    		hash.copy_from_slice(&data[1..21]);

    		let address = Address {
    			kind: kind,
    			network: network,
    			hash: hash,
    		};

    		Ok(address)
    	}
    }

    impl fmt::Display for Address {
    	fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
    		self.layout().to_base58().fmt(f)
    	}
    }

    impl FromStr for Address {
    	type Err = Error;

    	fn from_str(s: &str) -> Result<Self, Error> where Self: Sized {
    		let hex = try!(s.from_base58().map_err(|_| Error::InvalidAddress));
    		Address::from_layout(&hex)
    	}
    }

    impl From<&'static str> for Address {
    	fn from(s: &'static str) -> Self {
    		s.parse().unwrap()
    	}
    }

    #[cfg(test)]
    mod tests {
    	use network::Network;
    	use super::{Address, Type};

    	#[test]
    	fn test_address_to_string() {
    		let address = Address {
    			kind: Type::P2PKH,
    			network: Network::Mainnet,
    			hash: "3f4aa1fedf1f54eeb03b759deadb36676b184911".into(),
    		};

    		assert_eq!("16meyfSoQV6twkAAxPe51RtMVz7PGRmWna".to_owned(), address.to_string());
    	}

    	#[test]
    	fn test_address_from_str() {
    		let address = Address {
    			kind: Type::P2PKH,
    			network: Network::Mainnet,
    			hash: "3f4aa1fedf1f54eeb03b759deadb36676b184911".into(),
    		};

    		assert_eq!(address, "16meyfSoQV6twkAAxPe51RtMVz7PGRmWna".into());
    	}
    }

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)