Struct bdk::wallet::AddressInfo
source · pub struct AddressInfo {
pub index: u32,
pub address: Address,
pub keychain: KeychainKind,
}Expand description
A derived address and the index it was found at.
For convenience this automatically derefs to Address
Fields§
§index: u32Child index of this address
address: AddressAddress
keychain: KeychainKindType of keychain
Methods from Deref<Target = Address>§
pub fn payload(&self) -> &Payload
pub fn payload(&self) -> &Payload
Returns a reference to the payload of this address.
pub fn network(&self) -> &Network
pub fn network(&self) -> &Network
Returns a reference to the network of this address.
pub fn as_unchecked(&self) -> &Address<NetworkUnchecked>
pub fn as_unchecked(&self) -> &Address<NetworkUnchecked>
Returns a reference to the unchecked address, which is dangerous to use if the address
is invalid in the context of NetworkUnchecked.
pub fn address_type(&self) -> Option<AddressType>
pub fn address_type(&self) -> Option<AddressType>
Gets the address type of the address.
Returns
None if unknown, non-standard or related to the future witness version.
pub fn is_spend_standard(&self) -> bool
pub fn is_spend_standard(&self) -> bool
Checks whether or not the address is following Bitcoin standardness rules when spending from this address. NOT to be called by senders.
Spending Standardness
For forward compatibility, the senders must send to any [Address]. Receivers
can use this method to check whether or not they can spend from this address.
SegWit addresses with unassigned witness versions or non-standard program sizes are considered non-standard.
pub fn script_pubkey(&self) -> ScriptBuf
pub fn script_pubkey(&self) -> ScriptBuf
Generates a script pubkey spending to this address.
pub fn to_qr_uri(&self) -> String
pub fn to_qr_uri(&self) -> String
Creates a URI string bitcoin:address optimized to be encoded in QR codes.
If the address is bech32, the address becomes uppercase. If the address is base58, the address is left mixed case.
Quoting BIP 173 “inside QR codes uppercase SHOULD be used, as those permit the use of alphanumeric mode, which is 45% more compact than the normal byte mode.”
Note however that despite BIP21 explicitly stating that the bitcoin: prefix should be
parsed as case-insensitive many wallets got this wrong and don’t parse correctly.
See compatibility table.
If you want to avoid allocation you can use alternate display instead:
write!(writer, "{:#}", address)?;
Returns true if the given pubkey is directly related to the address payload.
This is determined by directly comparing the address payload with either the hash of the given public key or the segwit redeem hash generated from the given key. For taproot addresses, the supplied key is assumed to be tweaked
Returns true if the supplied xonly public key can be used to derive the address.
This will only work for Taproot addresses. The Public Key is assumed to have already been tweaked.
pub fn matches_script_pubkey(&self, script_pubkey: &Script) -> bool
pub fn matches_script_pubkey(&self, script_pubkey: &Script) -> bool
Returns true if the address creates a particular script This function doesn’t make any allocations.
pub fn assume_checked_ref(&self) -> &Address<NetworkChecked>
pub fn assume_checked_ref(&self) -> &Address<NetworkChecked>
Returns a reference to the checked address. This function is dangerous in case the address is not a valid checked address.
pub fn is_valid_for_network(&self, network: Network) -> bool
pub fn is_valid_for_network(&self, network: Network) -> bool
Parsed addresses do not always have one network. The problem is that legacy testnet, regtest and signet addresse use the same prefix instead of multiple different ones. When parsing, such addresses are always assumed to be testnet addresses (the same is true for bech32 signet addresses). So if one wants to check if an address belongs to a certain network a simple comparison is not enough anymore. Instead this function can be used.
use bitcoin::{Address, Network};
use bitcoin::address::NetworkUnchecked;
let address: Address<NetworkUnchecked> = "2N83imGV3gPwBzKJQvWJ7cRUY2SpUyU6A5e".parse().unwrap();
assert!(address.is_valid_for_network(Network::Testnet));
assert!(address.is_valid_for_network(Network::Regtest));
assert!(address.is_valid_for_network(Network::Signet));
assert_eq!(address.is_valid_for_network(Network::Bitcoin), false);
let address: Address<NetworkUnchecked> = "32iVBEu4dxkUQk9dJbZUiBiQdmypcEyJRf".parse().unwrap();
assert!(address.is_valid_for_network(Network::Bitcoin));
assert_eq!(address.is_valid_for_network(Network::Testnet), false);