Struct ProprietaryKey 

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

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

Fields

prefix: Vec<u8>

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

subtype: Subtype

Custom proprietary subtype

key: Vec<u8>

Additional key bytes (like serialized public key data etc)

Implementations

impl<Subtype> ProprietaryKey<Subtype>

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

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 duplicate 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<'de, Subtype> Deserialize<'de> for ProprietaryKey<Subtype>

where Subtype: Copy + From<u8> + Into<u8> + Deserialize<'de>,

fn deserialize<__D>( __deserializer: __D, ) -> Result<ProprietaryKey<Subtype>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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,

Encodes an object with a well-defined format.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<Subtype> PartialEq for ProprietaryKey<Subtype>

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

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<Subtype> PartialOrd for ProprietaryKey<Subtype>

where Subtype: PartialOrd + 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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl RgbOutExt<ProprietaryKey> for Output

fn get_internal_pk(&self) -> Option<XOnlyPublicKey>

fn is_tap_tree_empty(&self) -> bool

fn set_tap_tree(&mut self, script_commitment: &ScriptBuf)

fn bip32_derivation_terminals(&self) -> Vec<Terminal>

fn tap_bip32_derivation_terminals(&self) -> Vec<Terminal>

fn proprietary_mpc_messages<'a>( &'a self, ) -> impl Iterator<Item = (&'a [u8], &'a [u8])> + 'a

fn proprietary_insert(&mut self, key: ProprietaryKey, value: Vec<u8>)

fn proprietary_contains_key(&self, key: &ProprietaryKey) -> bool

fn proprietary_get_value(&self, key: &ProprietaryKey) -> Option<&[u8]>

fn proprietary_remove(&mut self, key: &ProprietaryKey)

fn is_opret_host(&self) -> bool

fn is_tapret_host(&self) -> bool

fn set_opret_host(&mut self) -> bool

fn set_tapret_host(&mut self) -> bool

fn tapret_commitment(&self) -> Result<TapretCommitment, TapretKeyError>

Returns valid tapret commitment from the PSBT_OUT_TAPRET_COMMITMENT key, if present. If the commitment is absent or invalid, returns TapretKeyError::NoCommitment.

fn opret_commit(&mut self, commitment: Commitment) -> Result<(), OpretKeyError>

Assigns value of the opreturn commitment to this PSBT output, by adding PSBT_OUT_OPRET_COMMITMENT proprietary key containing the 32-byte commitment as its value. Also modifies the output script and removes PSBT_OUT_OPRET_HOST key.

fn tapret_commit( &mut self, commitment: Commitment, ) -> Result<TapretProof, TapretKeyError>

Assigns value of the tapreturn commitment to this PSBT output, by adding PSBT_OUT_TAPRET_COMMITMENT and PSBT_OUT_TAPRET_PROOF proprietary keys containing the 32-byte commitment as its proof.

fn terminal_derivation(&self) -> Option<Terminal>

fn mpc_message_map( &self, ) -> Result<Confined<BTreeMap<ProtocolId, Message>, amplify::::collection::confinement::MediumOrdMap::{constant#0}, amplify::::collection::confinement::MediumOrdMap::{constant#1}>, MpcPsbtError>

Returns mpc::MessageMap constructed from the proprietary key data.

fn mpc_entropy(&self) -> Option<u64>

Returns a valid LNPBP-4 entropy value, if present.

fn mpc_min_tree_depth(&self) -> Option<u8>

fn set_mpc_entropy(&mut self, entropy: u64) -> Result<bool, MpcPsbtError>

Sets MPC entropy value.

fn set_mpc_message( &mut self, protocol_id: ProtocolId, message: Message, ) -> Result<bool, MpcPsbtError>

Sets MPC Message for the given ProtocolId.

fn mpc_commit(&mut self) -> Result<(Commitment, MerkleBlock), MpcPsbtError>

fn proprietary_push( &mut self, key: P, value: Vec<u8>, ) -> Result<(), MpcPsbtError>

fn proprietary_contains(&self, key: &P) -> bool

fn proprietary_get(&self, key: &P) -> Option<&[u8]>

impl RgbPropKeyExt for ProprietaryKey

fn mpc_message(protocol_id: ProtocolId) -> ProprietaryKey

Constructs PSBT_OUT_MPC_MESSAGE proprietary key.

fn mpc_entropy() -> ProprietaryKey

Constructs PSBT_OUT_MPC_ENTROPY proprietary key.

fn mpc_min_tree_depth() -> ProprietaryKey

Constructs PSBT_OUT_MPC_MIN_TREE_DEPTH proprietary key.

fn mpc_commitment() -> ProprietaryKey

Constructs PSBT_OUT_MPC_COMMITMENT proprietary key.

fn mpc_proof() -> ProprietaryKey

Constructs PSBT_OUT_MPC_PROOF proprietary key.

fn opret_host() -> ProprietaryKey

Constructs PSBT_OUT_OPRET_HOST proprietary key.

fn tapret_host() -> ProprietaryKey

Constructs PSBT_OUT_TAPRET_HOST proprietary key.

fn opret_commitment() -> ProprietaryKey

Constructs PSBT_OUT_OPRET_COMMITMENT proprietary key.

fn tapret_commitment() -> ProprietaryKey

Constructs PSBT_OUT_TAPRET_COMMITMENT proprietary key.

fn tapret_proof() -> ProprietaryKey

Constructs PSBT_OUT_TAPRET_PROOF proprietary key.

fn rgb_transition(opid: OpId) -> ProprietaryKey

Constructs PSBT_GLOBAL_RGB_TRANSITION proprietary key.

fn rgb_close_method() -> ProprietaryKey

Constructs PSBT_GLOBAL_RGB_CLOSE_METHOD proprietary key.

fn rgb_consumed_by(contract_id: ContractId) -> ProprietaryKey

Constructs PSBT_GLOBAL_RGB_CONSUMED_BY proprietary key.

fn rgb_tapret_host_on_change() -> ProprietaryKey

Constructs PSBT_GLOBAL_RGB_TAP_HOST_CHANGE proprietary key.

impl RgbPsbtExt<ProprietaryKey, Output> for Psbt

fn get_txid(&self) -> Txid

fn modifiable_outputs(&self) -> bool

fn set_as_unmodifiable(&mut self)

fn unsigned_tx(&self) -> Transaction

fn set_opret_host(&mut self) -> bool

fn dbc_output<D>(&self) -> Option<&Output>

where D: DbcPsbtProof,

fn dbc_output_mut<D>(&mut self) -> Option<(usize, &mut Output)>

where D: DbcPsbtProof,

fn set_opret_commitment(&mut self, idx: usize)

fn set_tapret_commitment(&mut self, idx: usize)

fn proprietary_rgb_contract_consumer_keys<'a>( &'a self, ) -> impl Iterator<Item = &'a [u8]> + 'a

fn outputs_iter_mut<'a>(&'a mut self) -> impl Iterator<Item = &'a mut Output>

where Output: 'a,

fn proprietary_insert(&mut self, key: ProprietaryKey, value: Vec<u8>)

fn proprietary_contains_key(&self, key: &ProprietaryKey) -> bool

fn proprietary_get_value(&self, key: &ProprietaryKey) -> Option<&[u8]>

fn dbc_commit<D>(&mut self) -> Result<(MerkleBlock, D), DbcPsbtError>

where D: DbcPsbtProof, Self: Sized,

fn rgb_embed(&mut self, batch: Batch) -> Result<(), EmbedError>

fn rgb_commit(&mut self) -> Result<Fascia, CommitError>

where Self: Sized,

fn rgb_contract_ids(&self) -> Result<BTreeSet<ContractId>, FromSliceError>

fn rgb_contract_consumers( &self, contract_id: ContractId, ) -> Result<BTreeMap<Opout, OpId>, RgbPsbtError>

fn rgb_transition(&self, opid: OpId) -> Result<Option<Transition>, RgbPsbtError>

fn rgb_close_method(&self) -> Result<Option<Method>, RgbPsbtError>

fn rgb_tapret_host_on_change(&self) -> bool

fn set_rgb_close_method(&mut self, close_method: Method)

fn set_rgb_tapret_host_on_change(&mut self)

fn set_rgb_contract_consumer( &mut self, contract_id: ContractId, opout: Opout, opid: OpId, ) -> Result<bool, RgbPsbtError>

Adds information about an RGB input allocation and the ID of the state transition spending it.

fn push_rgb_transition( &mut self, transition: Transition, ) -> Result<bool, RgbPsbtError>

fn rgb_bundles( &self, ) -> Result<BTreeMap<ContractId, TransitionBundle>, RgbPsbtError>

fn rgb_bundles_to_mpc( &mut self, ) -> Result<Confined<BTreeMap<ContractId, TransitionBundle>, 1, psrgbt::::RgbPsbtExt::rgb_bundles_to_mpc::{constant#0}>, RgbPsbtError>

fn proprietary_push( &mut self, key: P, value: Vec<u8>, ) -> Result<(), MpcPsbtError>

fn proprietary_contains(&self, key: &P) -> bool

fn proprietary_get(&self, key: &P) -> Option<&[u8]>

impl<Subtype> Serialize for ProprietaryKey<Subtype>

where Subtype: Copy + From<u8> + Into<u8> + Serialize,

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

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> StructuralPartialEq for ProprietaryKey<Subtype>

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