Module address

Bitcoin addresses.

Support for ordinary base58 Bitcoin addresses and private keys.

Example: creating a new address from a randomly-generated key pair

use bitcoin::{Address, PublicKey, Network};
use bitcoin::secp256k1::{rand, Secp256k1};

// Generate random key pair.
let s = Secp256k1::new();
let public_key = PublicKey::new(s.generate_keypair(&mut rand::thread_rng()).1);

// Generate pay-to-pubkey-hash address.
let address = Address::p2pkh(&public_key, Network::Bitcoin);

Note: creating a new address requires the rand-std feature flag

bitcoin = { version = "...", features = ["rand-std"] }

Modules

error

Error code for the address module.

Structs

Address

A Bitcoin address.

InvalidBase58PayloadLengthError

Decoded base58 data was an invalid length.

InvalidLegacyPrefixError

Invalid legacy address prefix in decoded base58 data.

LegacyAddressTooLongError

Legacy base58 address was too long, max 50 characters.

NetworkValidationError

Address’s network differs from required one.

UnknownAddressTypeError

Address type is either invalid or not supported in rust-bitcoin.

UnknownHrpError

Unknown HRP error.

Enums

AddressData

The data encoded by an Address.

AddressType

The different types of addresses.

FromScriptError

Error while generating address from script.

KnownHrp

Known bech32 human-readable parts.

NetworkChecked

Marker that address’s network has been successfully validated. See section Parsing addresses on Address for details.

NetworkUnchecked

Marker that address’s network has not yet been validated. See section Parsing addresses on Address for details.

P2shError

Error while generating address from a p2sh script.

ParseError

Address parsing error.

Traits

NetworkValidation

Marker of status of address’s network validation. See section Parsing addresses on Address for details.