Struct ClosingTransaction

pub struct ClosingTransaction { /* private fields */ }

This class tracks the per-transaction information needed to build a closing transaction and will actually build it and sign.

This class can be used inside a signer implementation to generate a signature given the relevant secret key.

Implementations

impl ClosingTransaction

pub fn new( to_holder_value_sat: u64, to_counterparty_value_sat: u64, to_holder_script: ScriptBuf, to_counterparty_script: ScriptBuf, funding_outpoint: OutPoint, ) -> Self

Construct an object of the class

pub fn trust(&self) -> TrustedClosingTransaction<'_>

Trust our pre-built transaction.

Applies a wrapper which allows access to the transaction.

This should only be used if you fully trust the builder of this object. It should not be used by an external signer - instead use the verify function.

pub fn verify( &self, funding_outpoint: OutPoint, ) -> Result<TrustedClosingTransaction<'_>, ()>

Verify our pre-built transaction.

Applies a wrapper which allows access to the transaction.

An external validating signer must call this method before signing or using the built transaction.

pub fn to_holder_value_sat(&self) -> u64

The value to be sent to the holder, or zero if the output will be omitted

pub fn to_counterparty_value_sat(&self) -> u64

The value to be sent to the counterparty, or zero if the output will be omitted

pub fn to_holder_script(&self) -> &Script

The destination of the holder’s output

pub fn to_counterparty_script(&self) -> &Script

The destination of the counterparty’s output

Trait Implementations

impl Clone for ClosingTransaction

fn clone(&self) -> ClosingTransaction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Hash for ClosingTransaction

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ClosingTransaction

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

impl StructuralPartialEq for ClosingTransaction