Struct mycitadel::model::WalletTemplate

pub struct WalletTemplate {
    pub default_derivation: DerivationType,
    pub descriptor_class: DescriptorClass,
    pub min_signer_count: u16,
    pub max_signer_count: Option<u16>,
    pub hardware_req: Requirement,
    pub watch_only_req: Requirement,
    pub conditions: BTreeSet<(u8, SpendingCondition)>,
    pub network: PublicNetwork,
}

Wallet template is a way to define constrained version of a wallet descriptor, but unlike super::WalletDescriptor not having restrains on the internal consistency between amount of signatures already present and condition parameters.

Fields

default_derivation: DerivationType

descriptor_class: DescriptorClass

min_signer_count: u16

max_signer_count: Option<u16>

hardware_req: Requirement

watch_only_req: Requirement

conditions: BTreeSet<(u8, SpendingCondition)>

network: PublicNetwork

Implementations

impl WalletTemplate

pub fn singlesig(
    descriptor_class: DescriptorClass,
    network: PublicNetwork,
    require_hardware: bool
) -> WalletTemplate

pub fn hodling(
    descriptor_class: DescriptorClass,
    network: PublicNetwork,
    sigs_required: u16,
    hardware_req: Requirement,
    watch_only_req: Requirement
) -> WalletTemplate

Panics

If sigs_required is less than 3.

pub fn multisig(
    descriptor_class: DescriptorClass,
    network: PublicNetwork,
    sigs_required: Option<u16>,
    hardware_req: Requirement,
    watch_only_req: Requirement
) -> WalletTemplate

Panics

If sigs_required is Some(0) or Some(1).

pub fn bip43(&self) -> Bip43

Trait Implementations

impl Clone for WalletTemplate

fn clone(&self) -> WalletTemplate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WalletTemplate

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

Formats the value using the given formatter.

impl Hash for WalletTemplate

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl PartialEq<WalletTemplate> for WalletTemplate

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

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

const 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 Eq for WalletTemplate

impl StructuralEq for WalletTemplate

impl StructuralPartialEq for WalletTemplate