Struct ShutdownScript

pub struct ShutdownScript(/* private fields */);

A script pubkey for shutting down a channel as defined by BOLT #2.

Implementations

impl ShutdownScript

pub fn new_p2wpkh(pubkey_hash: &WPubkeyHash) -> Self

Generates a P2WPKH script pubkey from the given WPubkeyHash.

pub fn new_p2wsh(script_hash: &WScriptHash) -> Self

Generates a P2WSH script pubkey from the given WScriptHash.

pub fn new_op_return<T: AsRef<PushBytes>>( data: T, ) -> Result<Self, InvalidShutdownScript>

Generates an OP_RETURN script pubkey from the given data bytes.

This is only needed and valid for channels supporting option_simple_close. Please refer to BOLT-2 for more information.

Errors

This function may return an error if data is not BOLT-2 compliant.

pub fn new_witness_program( witness_program: &WitnessProgram, ) -> Result<Self, InvalidShutdownScript>

Generates a witness script pubkey from the given segwit version and program.

Note for version-zero witness scripts you must use ShutdownScript::new_p2wpkh or ShutdownScript::new_p2wsh instead.

Errors

This function may return an error if program is invalid for the segwit version.

pub fn into_inner(self) -> ScriptBuf

Converts the shutdown script into the underlying ScriptBuf.

pub fn as_legacy_pubkey(&self) -> Option<&PublicKey>

Returns the PublicKey used for a P2WPKH shutdown script if constructed directly from it.

pub fn is_compatible(&self, features: &InitFeatures) -> bool

Returns whether the shutdown script is compatible with the features as defined by BOLT #2.

Specifically, checks for compliance with feature option_shutdown_anysegwit and/or option_simple_close.

Trait Implementations

impl Clone for ShutdownScript

fn clone(&self) -> ShutdownScript

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Display for ShutdownScript

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

Formats the value using the given formatter.

impl From<ShutdownScript> for ScriptBuf

fn from(value: ShutdownScript) -> Self

Converts to this type from the input type.

impl PartialEq for ShutdownScript

fn eq(&self, other: &ShutdownScript) -> 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 Readable for ShutdownScript

fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError>

Reads a Self in from the given Read.

impl TryFrom<(ScriptBuf, &Features<InitContext>)> for ShutdownScript

type Error = InvalidShutdownScript

The type returned in the event of a conversion error.

fn try_from( (script, features): (ScriptBuf, &InitFeatures), ) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<ScriptBuf> for ShutdownScript

type Error = InvalidShutdownScript

The type returned in the event of a conversion error.

fn try_from(script: ScriptBuf) -> Result<Self, Self::Error>

Performs the conversion.

impl Writeable for ShutdownScript

fn write<W: Writer>(&self, w: &mut W) -> Result<(), Error>

Writes self out to the given Writer.

fn encode(&self) -> Vec<u8>

Writes self out to a Vec<u8>.

fn serialized_length(&self) -> usize

Gets the length of this object after it has been serialized. This can be overridden to optimize cases where we prepend an object with its length.

impl Eq for ShutdownScript

impl StructuralPartialEq for ShutdownScript