Struct breez_sdk_core::lightning::ln::script::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) -> ShutdownScript

Generates a P2WPKH script pubkey from the given WPubkeyHash.

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

Generates a P2WSH script pubkey from the given WScriptHash.

pub fn new_witness_program( version: WitnessVersion, program: &[u8], ) -> Result<ShutdownScript, 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) -> Script

Converts the shutdown script into the underlying Script.

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: &Features<InitContext>) -> 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.

Trait Implementations

impl Clone for ShutdownScript

fn clone(&self) -> ShutdownScript

Returns a copy 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<(), Error>

Formats the value using the given formatter.

impl Into<Script> for ShutdownScript

fn into(self) -> Script

Converts this type into the (usually inferred) 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>(r: &mut R) -> Result<ShutdownScript, DecodeError>

where R: Read,

Reads a Self in from the given Read.

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

type Error = InvalidShutdownScript

The type returned in the event of a conversion error.

fn try_from( _: (Script, &Features<InitContext>), ) -> Result<ShutdownScript, <ShutdownScript as TryFrom<(Script, &Features<InitContext>)>>::Error>

Performs the conversion.

impl TryFrom<Script> for ShutdownScript

type Error = InvalidShutdownScript

The type returned in the event of a conversion error.

fn try_from( script: Script, ) -> Result<ShutdownScript, <ShutdownScript as TryFrom<Script>>::Error>

Performs the conversion.

impl Writeable for ShutdownScript

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

where W: Writer,

Writes self out to the given Writer.

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.

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

Writes self out to a Vec<u8>.

impl Eq for ShutdownScript

impl StructuralPartialEq for ShutdownScript