hal 0.11.0

hal - the Bitcoin companion
Documentation 
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


use bitcoin::{
	address, Address, Network, Script, PubkeyHash, ScriptHash, WPubkeyHash, WScriptHash,
};
use secp256k1::XOnlyPublicKey;
use serde::{Deserialize, Serialize};

use crate::SECP;
use crate::tx;

#[derive(Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
pub struct AddressInfo {
	#[serde(rename = "type")]
	pub type_: Option<String>,
	pub script_pub_key: tx::OutputScriptInfo,
	#[serde(skip_serializing_if = "Option::is_none")]
	pub witness_program_version: Option<usize>,
	#[serde(skip_serializing_if = "Option::is_none")]
	pub pubkey_hash: Option<PubkeyHash>,
	#[serde(skip_serializing_if = "Option::is_none")]
	pub script_hash: Option<ScriptHash>,
	#[serde(skip_serializing_if = "Option::is_none")]
	pub witness_pubkey_hash: Option<WPubkeyHash>,
	#[serde(skip_serializing_if = "Option::is_none")]
	pub witness_script_hash: Option<WScriptHash>,
}

#[derive(Clone, PartialEq, Eq, Debug, Default, Deserialize, Serialize)]
pub struct Addresses {
	#[serde(skip_serializing_if = "Option::is_none")]
	pub p2pkh: Option<Address<address::NetworkUnchecked>>,
	#[serde(skip_serializing_if = "Option::is_none")]
	pub p2wpkh: Option<Address<address::NetworkUnchecked>>,
	#[serde(skip_serializing_if = "Option::is_none")]
	pub p2shwpkh: Option<Address<address::NetworkUnchecked>>,
	#[serde(skip_serializing_if = "Option::is_none")]
	pub p2sh: Option<Address<address::NetworkUnchecked>>,
	#[serde(skip_serializing_if = "Option::is_none")]
	pub p2wsh: Option<Address<address::NetworkUnchecked>>,
	#[serde(skip_serializing_if = "Option::is_none")]
	pub p2shwsh: Option<Address<address::NetworkUnchecked>>,
	#[serde(skip_serializing_if = "Option::is_none")]
	pub p2tr: Option<Address<address::NetworkUnchecked>>,
}

impl Addresses {
	pub fn from_pubkey(pubkey: &bitcoin::PublicKey, network: Network) -> Addresses {
		Addresses {
			p2pkh: Some(Address::p2pkh(pubkey, network).as_unchecked().clone()),
			p2wpkh: if pubkey.compressed {
				let pk = bitcoin::CompressedPublicKey(pubkey.inner);
				Some(Address::p2wpkh(&pk, network).as_unchecked().clone())
			} else {
				None
			},
			p2shwpkh: if pubkey.compressed {
				let pk = bitcoin::CompressedPublicKey(pubkey.inner);
				Some(Address::p2shwpkh(&pk, network).as_unchecked().clone())
			} else {
				None
			},
			p2tr: if pubkey.compressed {
				let pk = pubkey.inner.into();
				Some(Address::p2tr(&SECP, pk, None, network).as_unchecked().clone())
			} else {
				None
			},
			..Default::default()
		}
	}

	pub fn from_xonly_pubkey(pubkey: XOnlyPublicKey, network: Network) -> Addresses {
		Addresses {
			p2tr: Some(Address::p2tr(&SECP, pubkey, None, network).as_unchecked().clone()),
			..Default::default()
		}
	}

	pub fn from_script(script: &Script, network: Network) -> Addresses {
		Addresses {
			p2sh: Address::p2sh(&script, network).ok().map(|a| a.as_unchecked().clone()),
			p2wsh: Some(Address::p2wsh(&script, network).as_unchecked().clone()),
			p2shwsh: Some(Address::p2shwsh(&script, network).as_unchecked().clone()),
			// NB to make a p2tr here we need a NUMS internal key and it's
			// probably not safe to pick one ourselves. AFAIK there is no
			// standard NUMS point for this purpose.
			// (Though BIP341 suggests one..)
			..Default::default()
		}
	}
}