Struct wallet::descriptor::ScriptTemplate

pub struct ScriptTemplate<Pk>(_)
 where
    Pk: MiniscriptKey + StrictEncode + StrictDecode + FromStr,
    <Pk as FromStr>::Err: Display;

Allows creating templates for native bitcoin scripts with embedded key generator templates. May be useful for creating descriptors in situations where target script can’t be deterministically represented by miniscript, for instance for Lightning network-specific transaction outputs

Implementations

impl<Pk> ScriptTemplate<Pk> where
    Pk: MiniscriptKey + DerivePublicKey + StrictEncode + StrictDecode + FromStr,
    <Pk as FromStr>::Err: Display, 

pub fn translate_pk(
    &self,
    child_index: UnhardenedIndex
) -> ScriptTemplate<PublicKey>

Trait Implementations

impl<Pk> AsMut<<ScriptTemplate<Pk> as Wrapper>::Inner> for ScriptTemplate<Pk> where
    Pk: MiniscriptKey + StrictEncode + StrictDecode + FromStr,
    <Pk as FromStr>::Err: Display, 

fn as_mut(&mut self) -> &mut Self::Inner

Performs the conversion.

impl<Pk> AsRef<<ScriptTemplate<Pk> as Wrapper>::Inner> for ScriptTemplate<Pk> where
    Pk: MiniscriptKey + StrictEncode + StrictDecode + FromStr,
    <Pk as FromStr>::Err: Display, 

fn as_ref(&self) -> &Self::Inner

Performs the conversion.

impl<Pk> Borrow<<ScriptTemplate<Pk> as Wrapper>::Inner> for ScriptTemplate<Pk> where
    Pk: MiniscriptKey + StrictEncode + StrictDecode + FromStr,
    <Pk as FromStr>::Err: Display, 

fn borrow(&self) -> &Self::Inner

Immutably borrows from an owned value.

impl<Pk> BorrowMut<<ScriptTemplate<Pk> as Wrapper>::Inner> for ScriptTemplate<Pk> where
    Pk: MiniscriptKey + StrictEncode + StrictDecode + FromStr,
    <Pk as FromStr>::Err: Display, 

fn borrow_mut(&mut self) -> &mut Self::Inner

Mutably borrows from an owned value.

impl<Pk: Clone> Clone for ScriptTemplate<Pk> where
    Pk: MiniscriptKey + StrictEncode + StrictDecode + FromStr,
    <Pk as FromStr>::Err: Display, 

fn clone(&self) -> ScriptTemplate<Pk>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Pk: Debug> Debug for ScriptTemplate<Pk> where
    Pk: MiniscriptKey + StrictEncode + StrictDecode + FromStr,
    <Pk as FromStr>::Err: Display, 

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

Formats the value using the given formatter.

impl<Pk> Deref for ScriptTemplate<Pk> where
    Pk: MiniscriptKey + StrictEncode + StrictDecode + FromStr,
    <Pk as FromStr>::Err: Display, 

type Target = Self::Inner

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<Pk> DerefMut for ScriptTemplate<Pk> where
    Pk: MiniscriptKey + StrictEncode + StrictDecode + FromStr,
    <Pk as FromStr>::Err: Display, 

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<Pk> Display for ScriptTemplate<Pk> where
    Pk: MiniscriptKey + StrictEncode + StrictDecode + FromStr,
    <Pk as FromStr>::Err: Display, 

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

Formats the value using the given formatter.

impl<Pk: Eq> Eq for ScriptTemplate<Pk> where
    Pk: MiniscriptKey + StrictEncode + StrictDecode + FromStr,
    <Pk as FromStr>::Err: Display, 

impl<Pk> From<Vec<OpcodeTemplate<Pk>, Global>> for ScriptTemplate<Pk> where
    Pk: MiniscriptKey + StrictEncode + StrictDecode + FromStr,
    <Pk as FromStr>::Err: Display, 

fn from(v: Vec<OpcodeTemplate<Pk>>) -> Self

Performs the conversion.

impl<Pk: Hash> Hash for ScriptTemplate<Pk> where
    Pk: MiniscriptKey + StrictEncode + StrictDecode + FromStr,
    <Pk as FromStr>::Err: Display, 

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<Pk: Ord> Ord for ScriptTemplate<Pk> where
    Pk: MiniscriptKey + StrictEncode + StrictDecode + FromStr,
    <Pk as FromStr>::Err: Display, 

fn cmp(&self, other: &ScriptTemplate<Pk>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<Pk: PartialEq> PartialEq<ScriptTemplate<Pk>> for ScriptTemplate<Pk> where
    Pk: MiniscriptKey + StrictEncode + StrictDecode + FromStr,
    <Pk as FromStr>::Err: Display, 

fn eq(&self, other: &ScriptTemplate<Pk>) -> bool

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

fn ne(&self, other: &ScriptTemplate<Pk>) -> bool

This method tests for !=.

impl<Pk: PartialOrd> PartialOrd<ScriptTemplate<Pk>> for ScriptTemplate<Pk> where
    Pk: MiniscriptKey + StrictEncode + StrictDecode + FromStr,
    <Pk as FromStr>::Err: Display, 

fn partial_cmp(&self, other: &ScriptTemplate<Pk>) -> Option<Ordering>

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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<Pk> StrictDecode for ScriptTemplate<Pk> where
    Pk: MiniscriptKey + StrictEncode + StrictDecode + FromStr,
    <Pk as FromStr>::Err: Display, 

fn strict_decode<D: Read>(d: D) -> Result<Self, Error>

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

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

Tries to deserialize byte array into the current type using [strict_decode()]

impl<Pk> StrictEncode for ScriptTemplate<Pk> where
    Pk: MiniscriptKey + StrictEncode + StrictDecode + FromStr,
    <Pk as FromStr>::Err: Display, 

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

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

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

Serializes data as a byte array using [strict_encode()] function

impl<Pk> StructuralEq for ScriptTemplate<Pk> where
    Pk: MiniscriptKey + StrictEncode + StrictDecode + FromStr,
    <Pk as FromStr>::Err: Display, 

impl<Pk> StructuralPartialEq for ScriptTemplate<Pk> where
    Pk: MiniscriptKey + StrictEncode + StrictDecode + FromStr,
    <Pk as FromStr>::Err: Display, 

impl<Pk> Wrapper for ScriptTemplate<Pk> where
    Pk: MiniscriptKey + StrictEncode + StrictDecode + FromStr,
    <Pk as FromStr>::Err: Display, 

type Inner = Vec<OpcodeTemplate<Pk>>

Inner type wrapped by the current newtype

fn from_inner(inner: Self::Inner) -> Self

Instantiates wrapper type with the inner data

fn as_inner(&self) -> &Self::Inner

Returns reference to the inner representation for the wrapper type

fn as_inner_mut(&mut self) -> &mut Self::Inner

Returns a mutable reference to the inner representation for the wrapper type

fn into_inner(self) -> Self::Inner

Unwraps the wrapper returning the inner type

pub fn to_inner(&self) -> Self::Inner

Clones inner data of the wrapped type and return them

pub fn copy(&self) -> Self where
    Self::Inner: Copy, 

Copies the wrapped type