Struct simplicity::Cmr

pub struct Cmr(/* private fields */);

Commitment Merkle root

A Merkle root that commits to a node’s combinator and recursively its children.

Importantly, witness data and right disconnect branches are not included in the hash. This makes these elements malleable while preserving program identity (SegWit, delegation).

Uniquely identifies a program’s structure in terms of combinators at commitment time.

Implementations

impl Cmr

pub fn update(self, left: Self, right: Self) -> Self

Extend the given tagged hash by the given left and right hashes.

The hash self is taken as initial value, left and right hash are combined to create a 512-bit block, and the compression function is run once

pub fn update_1(self, right: Self) -> Self

Extend the given tagged hash by 256 bits of zeroes and the right hash.

The hash self is taken as initial value, 256 bits of zeroes and right hash are combined to create a 512-bit block, and the compression function is run once

pub fn update_with_weight(self, left_weight: u64, right: Self) -> Self

Updates the given tagged hash with given left cost and right hash.

The cost is serialized as the last 64 bits in the left block

pub fn update_fail_entropy(self, entropy: FailEntropy) -> Self

pub fn from_byte_array(data: [u8; 32]) -> Self

Converts the given tagged hash into a byte array

pub fn to_byte_array(self) -> [u8; 32]

Converts the given tagged hash into a byte array

impl Cmr

pub const fn iden() -> Self

Produce a CMR for an iden combinator

pub const fn unit() -> Self

Produce a CMR for a unit combinator

pub fn injl(child: Cmr) -> Self

Produce a CMR for an injl combinator

pub fn injr(child: Cmr) -> Self

Produce a CMR for an injr combinator

pub fn take(child: Cmr) -> Self

Produce a CMR for a take combinator

pub fn drop(child: Cmr) -> Self

Produce a CMR for a drop combinator

pub fn comp(left: Cmr, right: Cmr) -> Self

Produce a CMR for a comp combinator

pub fn case(left: Cmr, right: Cmr) -> Self

Produce a CMR for a case combinator

pub fn pair(left: Cmr, right: Cmr) -> Self

Produce a CMR for a pair combinator

pub fn disconnect(left: Cmr) -> Self

Produce a CMR for a disconnect combinator

pub fn witness() -> Self

Produce a CMR for a witness combinator

pub fn fail(entropy: FailEntropy) -> Self

Produce a CMR for a fail combinator

pub fn jet<J: Jet>(jet: J) -> Self

Produce a CMR for a jet

pub fn const_word(v: &Value) -> Self

Compute the CMR of a constant word jet

This is equal to the IMR of the equivalent scribe, converted to a CMR in the usual way for jets.

pub const BITS: [Cmr; 2] = _

CMRs for the bits 0 and 1 – injl(unit) and injr(unit) respectively

Trait Implementations

impl AsRef<[u8]> for Cmr

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Cmr

fn clone(&self) -> Cmr

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CoreConstructible for Cmr

fn iden() -> Self

fn unit() -> Self

fn injl(child: &Self) -> Self

fn injr(child: &Self) -> Self

fn take(child: &Self) -> Self

fn drop_(child: &Self) -> Self

fn comp(left: &Self, right: &Self) -> Result<Self, Error>

fn case(left: &Self, right: &Self) -> Result<Self, Error>

fn assertl(left: &Self, right: Cmr) -> Result<Self, Error>

fn assertr(left: Cmr, right: &Self) -> Result<Self, Error>

fn pair(left: &Self, right: &Self) -> Result<Self, Error>

fn fail(entropy: FailEntropy) -> Self

fn const_word(word: Arc<Value>) -> Self

fn scribe(value: &Value) -> Self

Create a DAG that takes any input and returns value as constant output.

fn bit_false() -> Self

Create a DAG that takes any input and returns bit 0 as constant output.

fn bit_true() -> Self

Create a DAG that takes any input and returns bit 1 as constant output.

fn cond(left: &Self, right: &Self) -> Result<Self, Error>

Create a DAG that takes a bit and an input, such that the left child is evaluated on the input if the bit is 1 (if branch) and the right child is evaluated on the input otherwise (else branch).

fn assert(child: &Self, hash: Cmr) -> Result<Self, Error>

Create a DAG that asserts that its child returns true, and fails otherwise. The hash identifies the assertion and is returned upon failure.

fn not(child: &Self) -> Result<Self, Error>

Create a DAG that computes Boolean NOT of the child.

fn and(left: &Self, right: &Self) -> Result<Self, Error>

Create a DAG that computes Boolean AND of the left and right child.

fn or(left: &Self, right: &Self) -> Result<Self, Error>

Create a DAG that computes Boolean OR of the left and right.

impl Debug for Cmr

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

Formats the value using the given formatter.

impl<X> DisconnectConstructible<X> for Cmr

fn disconnect(left: &Self, _right: &X) -> Result<Self, Error>

impl Display for Cmr

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

Formats the value using the given formatter.

impl From<Cmr> for Amr

fn from(cmr: Cmr) -> Self

Converts to this type from the input type.

impl From<Cmr> for FirstPassImr

fn from(cmr: Cmr) -> Self

Converts to this type from the input type.

impl From<Cmr> for Imr

fn from(cmr: Cmr) -> Self

Converts to this type from the input type.

impl From<Tmr> for Cmr

fn from(tmr: Tmr) -> Self

Converts to this type from the input type.

impl FromStr for Cmr

type Err = HexToArrayError

The associated error which can be returned from parsing.

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

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

impl Hash for Cmr

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<J: Jet> JetConstructible<J> for Cmr

fn jet(jet: J) -> Self

impl Ord for Cmr

fn cmp(&self, other: &Cmr) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Cmr

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

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

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 PartialOrd for Cmr

fn partial_cmp(&self, other: &Cmr) -> 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<W> WitnessConstructible<W> for Cmr

fn witness(_witness: W) -> Self

impl Copy for Cmr

impl Eq for Cmr

impl StructuralPartialEq for Cmr