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
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


use ark::address::{ArkId, Address, VtxoDelivery};
use ark::lightning::PaymentHash;
use ark::mailbox::BlindedMailboxIdentifier;
use ark::VtxoPolicy;
use bitcoin::Network;
use bitcoin::secp256k1::{PublicKey, XOnlyPublicKey};
use serde::{Deserialize, Serialize};

use crate::{GetInfo, HexBytes};

#[derive(Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
#[serde(tag = "type")]
pub enum BarkVtxoPolicyInfo {
	#[serde(rename = "pubkey")]
	Pubkey {
		user_pubkey: PublicKey,
	},
	#[serde(rename = "server-htlc-send")]
	ServerHtlcSend {
		user_pubkey: PublicKey,
		payment_hash: PaymentHash,
		htlc_expiry: u32,
	},
	#[serde(rename = "server-htlc-receive")]
	ServerHtlcRecv {
		user_pubkey: PublicKey,
		payment_hash: PaymentHash,
		htlc_expiry: u32,
	},
}

impl GetInfo<BarkVtxoPolicyInfo> for VtxoPolicy {
	fn get_info(&self, _: Network) -> BarkVtxoPolicyInfo {
		match self {
			VtxoPolicy::Pubkey(p) => BarkVtxoPolicyInfo::Pubkey {
				user_pubkey: p.user_pubkey,
			},
			VtxoPolicy::ServerHtlcSend(p) => BarkVtxoPolicyInfo::ServerHtlcSend {
				user_pubkey: p.user_pubkey,
				payment_hash: p.payment_hash,
				htlc_expiry: p.htlc_expiry as u32,
			},
			VtxoPolicy::ServerHtlcRecv(p) => BarkVtxoPolicyInfo::ServerHtlcRecv {
				user_pubkey: p.user_pubkey,
				payment_hash: p.payment_hash,
				htlc_expiry: p.htlc_expiry as u32,
			},
		}
	}
}

#[derive(Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
#[serde(tag = "type")]
pub enum BarkVtxoDeliveryInfo {
	#[serde(rename = "server-builtin")]
	ServerBuiltin,
	#[serde(rename = "server-mailbox")]
	ServerMailbox {
		blinded_mailbox_id: BlindedMailboxIdentifier,
	},
	#[serde(rename = "unknown")]
	Unknown {
		delivery_type_byte: u8,
		data: HexBytes,
	},
}

impl GetInfo<BarkVtxoDeliveryInfo> for VtxoDelivery {
	fn get_info(&self, _network: Network) -> BarkVtxoDeliveryInfo {
		match self {
			VtxoDelivery::ServerBuiltin => BarkVtxoDeliveryInfo::ServerBuiltin,
			VtxoDelivery::ServerMailbox { blinded_id } => BarkVtxoDeliveryInfo::ServerMailbox {
				blinded_mailbox_id: *blinded_id,
			},
			VtxoDelivery::Unknown { delivery_type, data } => BarkVtxoDeliveryInfo::Unknown {
				delivery_type_byte: *delivery_type,
				data: data.clone().into(),
			},
			_ => BarkVtxoDeliveryInfo::Unknown {
				delivery_type_byte: u8::MAX,
				data: HexBytes(vec![]),
			},
		}
	}
}

#[derive(Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
pub struct BarkAddressInfo {
	pub testnet: bool,
	pub ark_id: ArkId,
	pub policy: BarkVtxoPolicyInfo,
	pub delivery: Vec<BarkVtxoDeliveryInfo>,
}

impl GetInfo<BarkAddressInfo> for Address {
	fn get_info(&self, network: Network) -> BarkAddressInfo {
		BarkAddressInfo {
			testnet: self.is_testnet(),
			ark_id: self.ark_id(),
			policy: self.policy().get_info(network),
			delivery: self.delivery().iter().map(|d| d.clone().get_info(network)).collect(),
		}
	}
}

#[derive(Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
pub struct ArkadeAddressInfo {
	pub testnet: bool,
	pub user_pubkey: XOnlyPublicKey,
	pub server_pubkey: XOnlyPublicKey,
}

#[derive(Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
#[serde(tag = "type")]
pub enum ArkAddressInfo {
	#[serde(rename = "bark")]
	Bark(BarkAddressInfo),
	#[serde(rename = "arkade")]
	Arkade(ArkadeAddressInfo),
}