Enum miniscript::Bare

pub enum Bare {}

Bare ScriptContext To be used as raw script pubkeys In general, it is not recommended to use Bare descriptors as they as strongly limited by standardness policies.

Trait Implementations

impl Clone for Bare

pub fn clone(&self) -> Bare

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Bare

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

Formats the value using the given formatter.

impl Eq for Bare

impl Ord for Bare

pub fn cmp(&self, other: &Bare) -> 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 PartialEq<Bare> for Bare

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

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

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

This method tests for !=.

impl PartialOrd<Bare> for Bare

pub fn partial_cmp(&self, other: &Bare) -> 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 ScriptContext for Bare

pub fn check_terminal_non_malleable<Pk: MiniscriptKey, Ctx: ScriptContext>(
    _frag: &Terminal<Pk, Ctx>
) -> Result<(), ScriptContextError>

Depending on ScriptContext, fragments can be malleable. For Example, under Legacy context, PkH is malleable because it is possible to estimate the cost of satisfaction because of compressed keys This is currently only used in compiler code for removing malleable compilations. This does NOT recursively check if the children of the fragment are valid or not. Since the compilation proceeds in a leaf to root fashion, a recursive check is unnecessary.

pub fn check_global_consensus_validity<Pk: MiniscriptKey, Ctx: ScriptContext>(
    ms: &Miniscript<Pk, Ctx>
) -> Result<(), ScriptContextError>

Depending on script Context, some of the Terminals might not be valid under the current consensus rules. Or some of the script resource limits may have been exceeded. These miniscripts would never be accepted by the Bitcoin network and hence it is safe to discard them For example, in Segwit Context with MiniscriptKey as bitcoin::PublicKey uncompressed public keys are non-standard and thus invalid. In LegacyP2SH context, scripts above 520 bytes are invalid. Post Tapscript upgrade, this would have to consider other nodes. This does NOT recursively check the miniscript fragments.

pub fn check_local_consensus_validity<Pk: MiniscriptKey, Ctx: ScriptContext>(
    ms: &Miniscript<Pk, Ctx>
) -> Result<(), ScriptContextError>

Consensus rules at the Miniscript satisfaction time. It is possible that some paths of miniscript may exceed resource limits and our current satisfier and lifting analysis would not work correctly. For example, satisfaction path(Legacy/Segwitv0) may require more than 201 opcodes.

pub fn other_top_level_checks<Pk: MiniscriptKey, Ctx: ScriptContext>(
    ms: &Miniscript<Pk, Ctx>
) -> Result<(), Error>

Other top level checks that are context specific

pub fn max_satisfaction_size<Pk: MiniscriptKey, Ctx: ScriptContext>(
    ms: &Miniscript<Pk, Ctx>
) -> Option<usize>

Depending on script context, the size of a satifaction witness may slightly differ.

pub fn check_witness<Pk: MiniscriptKey, Ctx: ScriptContext>(
    _witness: &[Vec<u8>]
) -> Result<(), ScriptContextError>

Check whether the given satisfaction is valid under the ScriptContext For example, segwit satisfactions may fail if the witness len is more 3600 or number of stack elements are more than 100.

pub fn check_global_policy_validity<Pk: MiniscriptKey, Ctx: ScriptContext>(
    _ms: &Miniscript<Pk, Ctx>
) -> Result<(), ScriptContextError>

Depending on script Context, some of the script resource limits may have been exceeded under the current bitcoin core policy rules These miniscripts would never be accepted by the Bitcoin network and hence it is safe to discard them. (unless explicitly disabled by non-standard flag) For example, in Segwit Context with MiniscriptKey as bitcoin::PublicKey scripts over 3600 bytes are invalid. Post Tapscript upgrade, this would have to consider other nodes. This does NOT recursively check the miniscript fragments.

pub fn check_local_policy_validity<Pk: MiniscriptKey, Ctx: ScriptContext>(
    _ms: &Miniscript<Pk, Ctx>
) -> Result<(), ScriptContextError>

Policy rules at the Miniscript satisfaction time. It is possible that some paths of miniscript may exceed resource limits and our current satisfier and lifting analysis would not work correctly. For example, satisfaction path in Legacy context scriptSig more than 1650 bytes

pub fn check_global_validity<Pk: MiniscriptKey, Ctx: ScriptContext>(
    ms: &Miniscript<Pk, Ctx>
) -> Result<(), ScriptContextError>

Check the consensus + policy(if not disabled) rules that are not based satisfaction

pub fn check_local_validity<Pk: MiniscriptKey, Ctx: ScriptContext>(
    ms: &Miniscript<Pk, Ctx>
) -> Result<(), ScriptContextError>

Check the consensus + policy(if not disabled) rules including the ones for satisfaction

pub fn top_level_type_check<Pk: MiniscriptKey, Ctx: ScriptContext>(
    ms: &Miniscript<Pk, Ctx>
) -> Result<(), Error>

Check whether the top-level is type B

pub fn top_level_checks<Pk: MiniscriptKey, Ctx: ScriptContext>(
    ms: &Miniscript<Pk, Ctx>
) -> Result<(), Error>

Check top level consensus rules.

impl StructuralEq for Bare

impl StructuralPartialEq for Bare