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() -> Self

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: AsRef<[u8]>>(slice: &[T]) -> Self

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: AsRef<[u8]>>(&mut self, new_element: T)

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 nth(&self, index: usize) -> Option<&[u8]>

Return the nth element in the witness, if any

Source

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

Get Tapscript following BIP341 rules regarding accounting for an annex.

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_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