Struct handshakes::types::lockingscript::LockingScript

pub struct LockingScript {
    pub version: u8,
    pub witness_program: WitnessProgram,
}

A LockingScript

Fields

version: u8

The version field determines how the Witness Program is interpreted by the virtual machine.

witness_program: WitnessProgram

The witness_program is generally a committment to some data that is required for virtual machine execution. For version 0, a witness_program that is 20 bytes is interpreted as a pay-to-witness-pubkeyhash and data that is 32 bytes is interpreted as a pay-to-witness-scripthash.

Implementations

impl LockingScript

pub fn null() -> Self

Returns a null LockingScript

pub fn new(v: Vec<u8>) -> Result<Self, LockingScriptError>

Create a new LockingScript

impl LockingScript

pub fn p2wpkh<T>(key: &T) -> Self where
    T: AsRef<VerifyingKey>, 

Instantiate a standard p2wpkh script pubkey from a pubkey.

pub fn p2wsh(script: &Script) -> Self

Instantiate a standard p2wsh script pubkey from a script.

pub fn extract_op_return_data(&self) -> Option<Vec<u8>>

Extract data from an op_return output. In Handshake, the version must be 31 for the output to be an op_return output.

pub fn standard_type(&self) -> Result<LockingScriptType, LockingScriptError>

Get the type of the LockingScript based on its version and the size of the WitnessProgram.

Trait Implementations

impl ByteFormat for LockingScript

type Error = SerError

An associated error type

fn serialized_length(&self) -> usize

Returns the byte-length of the serialized data structure.

fn read_from<R>(reader: &mut R) -> Result<Self, Self::Error> where
    R: Read, 

Deserializes an instance of Self from a std::io::Read. The limit argument is used only when deserializing collections, and specifies a maximum number of instances of the underlying type to read.

fn write_to<W>(
    &self,
    writer: &mut W
) -> Result<usize, <Self as ByteFormat>::Error> where
    W: Write, 

Serializes self to a std::io::Write. Following Write trait conventions, its Ok type must be a usize denoting the number of bytes written.

fn read_seq_from<R>(
    reader: &mut R,
    mode: ReadSeqMode
) -> Result<Vec<Self, Global>, Self::Error> where
    R: Read, 

Read a sequence of exactly limit objects from the reader.

fn write_seq_to<'a, W, E, Iter, Item>(
    writer: &mut W,
    iter: Iter
) -> Result<usize, Self::Error> where
    Item: 'a + ByteFormat<Error = E>,
    W: Write,
    Iter: IntoIterator<Item = &'a Item>,
    E: Into<Self::Error> + From<SerError> + From<Error> + Error, 

Write a sequence of ByteFormat objects to a writer. The iter argument may be any object that implements IntoIterator<Item = &Item>. This means we can seamlessly use vectors, slices, etc.

fn deserialize_hex(s: &str) -> Result<Self, Self::Error>

Decodes a hex string to a Vec<u8>, deserializes an instance of Self from that vector.

fn deserialize_base64(s: &str) -> Result<Self, Self::Error>

Serialize self to a base64 string, using standard RFC4648 non-url safe characters

fn serialize_hex(&self) -> String

Serializes self to a vector, returns the hex-encoded vector

fn serialize_base64(&self) -> String

Serialize self to a base64 string, using standard RFC4648 non-url safe characters

impl Clone for LockingScript

fn clone(&self) -> LockingScript

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LockingScript

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LockingScript

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

Deserialize this value from the given Serde deserializer.

impl From<Vec<u8, Global>> for LockingScript

fn from(raw: Vec<u8>) -> Self

Performs the conversion.

impl PartialEq<LockingScript> for LockingScript

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

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

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

This method tests for !=.

impl Serialize for LockingScript

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 LockingScript

impl RecipientIdentifier for LockingScript

impl StructuralEq for LockingScript

impl StructuralPartialEq for LockingScript