Struct Witness

Source

pub struct Witness { /* private fields */ }

Expand description

The Witness is the data used to unlock bitcoin since the segwit upgrade.

Can be logically seen as an array of bytestrings, i.e. Vec<Vec<u8>>, and it is serialized on the wire in that format. You can convert between this type and Vec<Vec<u8>> by using Witness::from_slice and Witness::to_vec.

For serialization and deserialization performance it is stored internally as a single Vec, saving some allocations.

Implementations§

Source §

impl Witness

Source

pub const fn new() -> Witness

Creates a new empty Witness.

Source

pub fn p2wpkh(signature: &Signature, pubkey: &PublicKey) -> Witness

Creates a witness required to spend a P2WPKH output.

The witness will be made up of the DER encoded signature + sighash_type followed by the serialized public key. Also useful for spending a P2SH-P2WPKH output.

It is expected that pubkey is related to the secret key used to create signature.

Source

pub fn p2tr_key_spend(signature: &Signature) -> Witness

Creates a witness required to do a key path spend of a P2TR output.

Source

pub fn from_slice<T>(slice: &[T]) -> Witness
where T: AsRef<[u8]>,

Creates a Witness object from a slice of bytes slices where each slice is a witness item.

Source

pub fn to_vec(&self) -> Vec<Vec<u8>>

Convenience method to create an array of byte-arrays from this witness.

Source

pub fn is_empty(&self) -> bool

Returns true if the witness contains no element.

Source

pub fn iter(&self) -> Iter<'_> ⓘ

Returns a struct implementing Iterator.

Source

pub fn len(&self) -> usize

Returns the number of elements this witness holds.

Source

pub fn size(&self) -> usize

Returns the number of bytes this witness contributes to a transactions total size.

Source

pub fn clear(&mut self)

Clear the witness.

Source

pub fn push<T>(&mut self, new_element: T)
where T: AsRef<[u8]>,

Push a new element on the witness, requires an allocation.

Source

pub fn push_ecdsa_signature(&mut self, signature: &Signature)

Pushes, as a new element on the witness, an ECDSA signature.

Pushes the DER encoded signature + sighash_type, requires an allocation.

Source

pub fn last(&self) -> Option<&[u8]>

Returns the last element in the witness, if any.

Source

pub fn second_to_last(&self) -> Option<&[u8]>

Returns the second-to-last element in the witness, if any.

Source

pub fn third_to_last(&self) -> Option<&[u8]>

Returns the third-to-last element in the witness, if any.

Source

pub fn nth(&self, index: usize) -> Option<&[u8]>

Return the nth element in the witness, if any

Source

pub fn tapscript(&self) -> Option<&Script>

👎Deprecated: use taproot_leaf_script and check leaf version, if applicable

Get leaf script following BIP341 rules regarding accounting for an annex.

This method is broken: it’s called tapscript but it’s actually returning a leaf script. We’re not going to fix it because someone might be relying on it thinking leaf script and tapscript are the same thing (they are not). Instead, this is deprecated and will be removed in the next breaking release. You need to use taproot_leaf_script and if you intended to use it as leaf script, just access the script field of the returned type. If you intended tapscript specifically you have to check the version first and bail if it’s not LeafVersion::TapScript.

This does not guarantee that this represents a P2TR Witness. It merely gets the second to last or third to last element depending on the first byte of the last element being equal to 0x50.

See Script::is_p2tr to check whether this is actually a Taproot witness.

Source

pub fn taproot_leaf_script(&self) -> Option<LeafScript<&Script>>

Returns the leaf script with its version but without the merkle proof.

This does not guarantee that this represents a P2TR Witness. It merely gets the second to last or third to last element depending on the first byte of the last element being equal to 0x50 and the associated version.

Source

pub fn taproot_control_block(&self) -> Option<&[u8]>

Get the taproot control block following BIP341 rules.

This does not guarantee that this represents a P2TR Witness. It merely gets the last or second to last element depending on the first byte of the last element being equal to 0x50.

See Script::is_p2tr to check whether this is actually a Taproot witness.

Source