Struct themelio_stf::melvm::Covenant

pub struct Covenant(pub Vec<u8>);

A MelVM covenant. Essentially, given a transaction that attempts to spend it, it either allows the transaction through or doesn’t.

Implementations

impl Covenant

pub fn check(&self, tx: &Transaction, env: CovenantEnv<'_>) -> bool

Checks a transaction, returning whether or not the transaction is valid.

The caller must also pass in the CoinID and CoinDataHeight corresponding to the coin that’s being spent, as well as the Header of the previous block (if this transaction is trying to go into block N, then the header of block N-1). This allows the covenant to access (a committment to) its execution environment, allowing constructs like timelock contracts and colored-coin-like systems.

pub fn check_raw(&self, args: &[Value]) -> bool

Checks with respect to a manually instantiated initial heap.

pub fn hash(&self) -> CovHash

The hash of the covenant.

pub fn std_ed25519_pk_legacy(pk: Ed25519PK) -> Self

Returns a legacy ed25519 signature checking covenant, which checks the first signature.

pub fn std_ed25519_pk_new(pk: Ed25519PK) -> Self

Returns a new ed25519 signature checking covenant, which checks the nth signature when spent as the nth input.

pub fn from_ops(ops: &[OpCode]) -> Option<Self>

pub fn always_true() -> Self

pub fn to_ops(&self) -> Option<Vec<OpCode>>

pub fn weight(&self) -> Option<u128>

Trait Implementations

impl<'arbitrary> Arbitrary<'arbitrary> for Covenant

fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl Clone for Covenant

fn clone(&self) -> Covenant

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Covenant

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Covenant

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl From<Covenant> for Value

fn from(c: Covenant) -> Self

Performs the conversion.

impl Hash for Covenant

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<Covenant> for Covenant

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

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

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

This method tests for !=.

impl Serialize for Covenant

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl Eq for Covenant

impl StructuralEq for Covenant

impl StructuralPartialEq for Covenant