Struct revault_tx::scripts::DerivedCpfpDescriptor

pub struct DerivedCpfpDescriptor(_);

A concrete (with raw public keys) CPFP miniscript descriptor.

Implementations

impl DerivedCpfpDescriptor

pub fn inner(&self) -> &Descriptor<DerivedPublicKey>

pub fn into_inner(self) -> Descriptor<DerivedPublicKey>

pub fn keys(&self) -> Vec<DerivedPublicKey>

Get all the keys and key source used in this derived descriptor

impl DerivedCpfpDescriptor

pub fn new(
    managers: Vec<DerivedPublicKey>
) -> Result<DerivedCpfpDescriptor, ScriptCreationError>

Get the miniscript descriptor for the Unvault transaction CPFP output.

It’s a basic 1-of-N between the fund managers.

Examples

use revault_tx::{scripts, miniscript::{bitcoin::{self, secp256k1, util::bip32}, DescriptorTrait}};
use std::str::FromStr;

let first_manager = scripts::DerivedPublicKey::from_str("[0f0f0f0f/21]02a17786aca5ea2118e9209702454ab432d5b2c656f8ae19447d4ff3e7317d3b41").unwrap();
let second_manager = scripts::DerivedPublicKey::from_str("[0f0f0f0f/21]036edaec85bb1eee1a19ca9f9fd5620134ec98bc21cc14c4e8e3d0f8f121e1b6d1").unwrap();

let cpfp_descriptor =
    scripts::DerivedCpfpDescriptor::new(vec![first_manager, second_manager]).expect("Compiling descriptor");
println!("Concrete CPFP descriptor: {}", cpfp_descriptor);

let desc_str = cpfp_descriptor.to_string();
assert_eq!(cpfp_descriptor, scripts::DerivedCpfpDescriptor::from_str(&desc_str).unwrap());

Errors

• If you attempt to create a DerivedCpfpDescriptor with more than 20 managers.
• If the policy compilation to miniscript failed, which should not happen (tm) and would be a bug.

Trait Implementations

impl Clone for DerivedCpfpDescriptor

fn clone(&self) -> DerivedCpfpDescriptor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DerivedCpfpDescriptor

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

Formats the value using the given formatter.

impl Display for DerivedCpfpDescriptor

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

Formats the value using the given formatter.

impl FromStr for DerivedCpfpDescriptor

type Err = ScriptCreationError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<DerivedCpfpDescriptor, Self::Err>

Parses a string s to return a value of this type.

impl Ord for DerivedCpfpDescriptor

fn cmp(&self, other: &DerivedCpfpDescriptor) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<DerivedCpfpDescriptor> for DerivedCpfpDescriptor

fn eq(&self, other: &DerivedCpfpDescriptor) -> bool

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

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

This method tests for !=.

impl PartialOrd<DerivedCpfpDescriptor> for DerivedCpfpDescriptor

fn partial_cmp(&self, other: &DerivedCpfpDescriptor) -> 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 Eq for DerivedCpfpDescriptor

impl StructuralEq for DerivedCpfpDescriptor

impl StructuralPartialEq for DerivedCpfpDescriptor