Struct TxEnv

pub struct TxEnv<'tx, 'ptx> { /* private fields */ }

A satisfier for Covenant descriptors that can do transaction introspection ’tx denotes the lifetime of the transaction being satisfied and ’ptx denotes the lifetime of the previous transaction inputs

Implementations

impl<'tx, 'ptx> TxEnv<'tx, 'ptx>

pub fn new( tx: &'tx Transaction, spent_utxos: &'ptx [TxOut], idx: usize, ) -> Option<Self>

Returns None when spent_utos.len() != tx.input.len()

pub fn tx(&self) -> &Transaction

Obtains the tx

pub fn spent_utxos(&self) -> &[TxOut]

Obtains the spend utxos

pub fn idx(&self) -> usize

Obtains the current input index

Trait Implementations

impl<'tx, 'ptx> Clone for TxEnv<'tx, 'ptx>

fn clone(&self) -> TxEnv<'tx, 'ptx>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'tx, 'ptx> Debug for TxEnv<'tx, 'ptx>

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

Formats the value using the given formatter.

impl<'tx, 'ptx> PartialEq for TxEnv<'tx, 'ptx>

fn eq(&self, other: &TxEnv<'tx, 'ptx>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'tx, 'ptx, Pk: ToPublicKey> Satisfier<Pk> for TxEnv<'tx, 'ptx>

fn lookup_tx(&self) -> Option<&Transaction>

Lookup spending transaction. Required for introspection

fn lookup_spent_utxos(&self) -> Option<&[TxOut]>

Lookup spent txouts. Required for introspection

fn lookup_curr_inp(&self) -> Option<usize>

Lookup spent txouts. Required for introspection

fn lookup_ecdsa_sig(&self, _: &Pk) -> Option<ElementsSig>

Given a public key, look up an ECDSA signature with that key

fn lookup_tap_key_spend_sig(&self) -> Option<SchnorrSig>

Lookup the tap key spend sig

fn lookup_tap_leaf_script_sig( &self, _: &Pk, _: &TapLeafHash, ) -> Option<SchnorrSig>

Given a public key and a associated leaf hash, look up an schnorr signature with that key

fn lookup_tap_control_block_map( &self, ) -> Option<&BTreeMap<ControlBlock, (Script, LeafVersion)>>

Obtain a reference to the control block for a ver and script

fn lookup_raw_pkh_pk(&self, _: &Hash) -> Option<PublicKey>

Given a raw Pkh, lookup corresponding bitcoin::PublicKey

fn lookup_raw_pkh_x_only_pk(&self, _: &Hash) -> Option<XOnlyPublicKey>

Given a raw Pkh, lookup corresponding bitcoin::key::XOnlyPublicKey

fn lookup_raw_pkh_ecdsa_sig(&self, _: &Hash) -> Option<(PublicKey, ElementsSig)>

Given a keyhash, look up the EC signature and the associated key Even if signatures for public key Hashes are not available, the users can use this map to provide pkh -> pk mapping which can be useful for dissatisfying pkh.

fn lookup_raw_pkh_tap_leaf_script_sig( &self, _: &(Hash, TapLeafHash), ) -> Option<(XOnlyPublicKey, SchnorrSig)>

Given a keyhash, look up the schnorr signature and the associated key Even if signatures for public key Hashes are not available, the users can use this map to provide pkh -> pk mapping which can be useful for dissatisfying pkh.

fn lookup_sha256(&self, _: &Pk::Sha256) -> Option<Preimage32>

Given a SHA256 hash, look up its preimage

fn lookup_hash256(&self, _: &Pk::Hash256) -> Option<Preimage32>

Given a HASH256 hash, look up its preimage

fn lookup_ripemd160(&self, _: &Pk::Ripemd160) -> Option<Preimage32>

Given a RIPEMD160 hash, look up its preimage

fn lookup_hash160(&self, _: &Pk::Hash160) -> Option<Preimage32>

Given a HASH160 hash, look up its preimage

fn check_older(&self, _: Sequence) -> bool

Assert whether an relative locktime is satisfied

fn check_after(&self, _: LockTime) -> bool

Assert whether a absolute locktime is satisfied

fn lookup_nversion(&self) -> Option<u32>

Introspection Data for Covenant support #1 Version

fn lookup_hashprevouts(&self) -> Option<Hash>

Item 2: hashprevouts

fn lookup_hashsequence(&self) -> Option<Hash>

Item 3: hashsequence

fn lookup_hashissuances(&self) -> Option<Hash>

ELEMENTS EXTRA: Item 3b: hashsequence

fn lookup_outpoint(&self) -> Option<OutPoint>

Item 4: outpoint

fn lookup_scriptcode(&self) -> Option<&Script>

Item 5: scriptcode

fn lookup_value(&self) -> Option<Value>

Item 6: value

fn lookup_nsequence(&self) -> Option<u32>

Item 7: sequence

fn lookup_outputs(&self) -> Option<&[TxOut]>

Item 8: hashoutputs

fn lookup_nlocktime(&self) -> Option<u32>

Item 9: nlocktime

fn lookup_sighashu32(&self) -> Option<u32>

Item 10: sighash type as u32

fn lookup_csfs_sig( &self, _pk: &XOnlyPublicKey, _msg: &CsfsMsg, ) -> Option<Signature>

Lookup (msg, sig) for CSFS fragment

fn lookup_price_oracle_sig( &self, _pk: &XOnlyPublicKey, _time: u64, ) -> Option<(Signature, i64, u64)>

Lookup price oracle signature

impl<'tx, 'ptx> Eq for TxEnv<'tx, 'ptx>

impl<'tx, 'ptx> StructuralPartialEq for TxEnv<'tx, 'ptx>