Struct psbt::ProprietaryKey

pub struct ProprietaryKey<Subtype = u8>where
    Subtype: Copy + From<u8> + Into<u8>,{
    pub prefix: Vec<u8, Global>,
    pub subtype: Subtype,
    pub key: Vec<u8, Global>,
}

Proprietary keys (i.e. keys starting with 0xFC byte) with their internal structure according to BIP 174.

Fields

prefix: Vec<u8, Global>

Proprietary type prefix used for grouping together keys under some application and avoid namespace collision

subtype: Subtype

Custom proprietary subtype

key: Vec<u8, Global>

Additional key bytes (like serialized public key data etc)

Implementations

impl<Subtype> ProprietaryKey<Subtype>where
    Subtype: Copy + From<u8> + Into<u8>,

pub fn from_key(key: Key) -> Result<ProprietaryKey<Subtype>, Error>

👎Deprecated since 0.29.0: use try_from instead

Constructs ProprietaryKey from Key; returns Error::InvalidProprietaryKey if key do not starts with 0xFC byte

pub fn to_key(&self) -> Key

Constructs full Key corresponding to this proprietary key type

Trait Implementations

impl<Subtype> Clone for ProprietaryKey<Subtype>where
    Subtype: Clone + Copy + From<u8> + Into<u8>,

fn clone(&self) -> ProprietaryKey<Subtype>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<Subtype> Debug for ProprietaryKey<Subtype>where
    Subtype: Debug + Copy + From<u8> + Into<u8>,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<Subtype> Decodable for ProprietaryKey<Subtype>where
    Subtype: Copy + From<u8> + Into<u8>,

fn consensus_decode<R>(r: &mut R) -> Result<ProprietaryKey<Subtype>, Error>where
    R: Read + ?Sized,

Decode an object with a well-defined format.

fn consensus_decode_from_finite_reader<R>(reader: &mut R) -> Result<Self, Error>where
    R: Read + ?Sized,

Decode Self from a size-limited reader.

impl<Subtype> Encodable for ProprietaryKey<Subtype>where
    Subtype: Copy + From<u8> + Into<u8>,

fn consensus_encode<W>(&self, w: &mut W) -> Result<usize, Error>where
    W: Write + ?Sized,

Encode an object with a well-defined format. Returns the number of bytes written on success.

impl From<&ProprietaryKeyDescriptor> for ProprietaryKey

fn from(key: &ProprietaryKeyDescriptor) -> Self

Converts to this type from the input type.

impl From<ProprietaryKeyDescriptor> for ProprietaryKey

fn from(key: ProprietaryKeyDescriptor) -> Self

Converts to this type from the input type.

impl<Subtype> Hash for ProprietaryKey<Subtype>where
    Subtype: Hash + Copy + From<u8> + Into<u8>,

fn hash<__H>(&self, state: &mut __H)where
    __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<Subtype> Ord for ProprietaryKey<Subtype>where
    Subtype: Ord + Copy + From<u8> + Into<u8>,

fn cmp(&self, other: &ProprietaryKey<Subtype>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<Subtype> PartialEq<ProprietaryKey<Subtype>> for ProprietaryKey<Subtype>where
    Subtype: PartialEq<Subtype> + Copy + From<u8> + Into<u8>,

fn eq(&self, other: &ProprietaryKey<Subtype>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Subtype> PartialOrd<ProprietaryKey<Subtype>> for ProprietaryKey<Subtype>where
    Subtype: PartialOrd<Subtype> + Copy + From<u8> + Into<u8>,

fn partial_cmp(&self, other: &ProprietaryKey<Subtype>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl ProprietaryKeyLnpbp4 for ProprietaryKey

fn lnpbp4_message(protocol_id: ProtocolId) -> ProprietaryKey

Constructs PSBT_OUT_LNPBP4_MESSAGE proprietary key.

fn lnpbp4_entropy() -> ProprietaryKey

Constructs PSBT_OUT_LNPBP4_ENTROPY proprietary key.

fn lnpbp4_min_tree_depth() -> ProprietaryKey

Constructs PSBT_OUT_LNPBP4_MIN_TREE_DEPTH proprietary key.

fn lnpbp4_protocol_info(protocol_id: ProtocolId) -> ProprietaryKey

Constructs PSBT_GLOBAL_LNPBP4_PROTOCOL_INFO proprietary key.

impl ProprietaryKeyOpret for ProprietaryKey

fn opret_host() -> ProprietaryKey

Constructs PSBT_OUT_OPRET_HOST proprietary key.

fn opret_commitment() -> ProprietaryKey

Constructs PSBT_OUT_OPRET_COMMITMENT proprietary key.

impl ProprietaryKeyTapret for ProprietaryKey

fn tapret_tweak() -> ProprietaryKey

Constructs PSBT_IN_TAPRET_TWEAK proprietary key.

fn tapret_host() -> ProprietaryKey

Constructs PSBT_OUT_TAPRET_HOST proprietary key.

fn tapret_commitment() -> ProprietaryKey

Constructs PSBT_OUT_TAPRET_COMMITMENT proprietary key.

fn tapret_proof() -> ProprietaryKey

Constructs PSBT_OUT_TAPRET_PROOF proprietary key.

impl StrictDecode for ProprietaryKey<u8>

fn strict_decode<D>(d: D) -> Result<ProprietaryKey<u8>, Error>where
    D: Read,

Decode with the given std::io::Read instance; must either construct an instance or return implementation-specific error type.

fn strict_deserialize(data: impl AsRef<[u8]>) -> Result<Self, Error>

Tries to deserialize byte array into the current type using StrictDecode::strict_decode. If there are some data remains in the buffer once deserialization is completed, fails with Error::DataNotEntirelyConsumed. Use io::Cursor over the buffer and StrictDecode::strict_decode to avoid such failures.

fn strict_file_load(path: impl AsRef<Path>) -> Result<Self, Error>

Reads data from file at path and reconstructs object from it. Fails with Error::DataNotEntirelyConsumed if file contains remaining data after the object reconstruction.

impl StrictEncode for ProprietaryKey<u8>

fn strict_encode<E>(&self, e: E) -> Result<usize, Error>where
    E: Write,

Encode with the given std::io::Write instance; must return result with either amount of bytes encoded – or implementation-specific error type.

fn strict_serialize(&self) -> Result<Vec<u8, Global>, Error>

Serializes data as a byte array using StrictEncode::strict_encode function

fn strict_file_save(&self, path: impl AsRef<Path>) -> Result<usize, Error>

Saves data to a file at a given path. If the file does not exists, attempts to create the file. If the file already exists, it gets truncated.

impl<Subtype> TryFrom<Key> for ProprietaryKey<Subtype>where
    Subtype: Copy + From<u8> + Into<u8>,

fn try_from(
    key: Key
) -> Result<ProprietaryKey<Subtype>, <ProprietaryKey<Subtype> as TryFrom<Key>>::Error>

Constructs a ProprietaryKey from a Key.

Errors

Returns Error::InvalidProprietaryKey if key does not start with 0xFC byte.

type Error = Error

The type returned in the event of a conversion error.

impl<Subtype> Eq for ProprietaryKey<Subtype>where
    Subtype: Eq + Copy + From<u8> + Into<u8>,

impl<Subtype> StructuralEq for ProprietaryKey<Subtype>where
    Subtype: Copy + From<u8> + Into<u8>,

impl<Subtype> StructuralPartialEq for ProprietaryKey<Subtype>where
    Subtype: Copy + From<u8> + Into<u8>,