Update Key documentation

This commit is contained in:
Shing Him Ng 2024-07-12 13:29:02 -05:00
parent 6c8f759676
commit 164b72e07b
1 changed files with 3 additions and 2 deletions

View File

@ -17,14 +17,15 @@ use crate::prelude::{DisplayHex, Vec};
use crate::psbt::Error; use crate::psbt::Error;
/// A PSBT key in its raw byte form. /// A PSBT key in its raw byte form.
///
/// `<key> := <keylen> <keytype> <keydata>`
#[derive(Debug, PartialEq, Hash, Eq, Clone, Ord, PartialOrd)] #[derive(Debug, PartialEq, Hash, Eq, Clone, Ord, PartialOrd)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))] #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "serde", serde(crate = "actual_serde"))] #[cfg_attr(feature = "serde", serde(crate = "actual_serde"))]
pub struct Key { pub struct Key {
/// The type of this PSBT key. /// The type of this PSBT key.
pub type_value: u8, pub type_value: u8,
/// The key itself in raw byte form. /// The key data itself in raw byte form.
/// `<key> := <keylen> <keytype> <keydata>`
#[cfg_attr(feature = "serde", serde(with = "crate::serde_utils::hex_bytes"))] #[cfg_attr(feature = "serde", serde(with = "crate::serde_utils::hex_bytes"))]
pub key: Vec<u8>, pub key: Vec<u8>,
} }