Skip to main content

UnsignedBalanceUpdate

Struct UnsignedBalanceUpdate 

Source
pub struct UnsignedBalanceUpdate {
    pub channel_id: String,
    pub balance: u64,
    pub message_hex: String,
    pub tweak_scalar_hex: String,
}
Expand description

An unsigned balance update, ready for signing.

Contains the precomputed message hash and tweak scalar needed for signing. Once signed, use sign() to produce a BalanceUpdateMessage.

§Example

let unsigned = UnsignedBalanceUpdate::new(channel_id, balance, &funding)?;
let signature = host.sign_with_tweaked_key(
    &funding.sender_pubkey_hex,
    &unsigned.message_hex,
    &unsigned.tweak_scalar_hex,
)?;
let balance_update = unsigned.sign(&signature)?;

Fields§

§channel_id: String

Channel ID

§balance: u64

Balance (cumulative amount receiver can claim)

§message_hex: String

SHA-256 hash of the SIG_ALL message (32 bytes, hex-encoded)

§tweak_scalar_hex: String

P2BK blinding scalar for the sender (32 bytes, hex-encoded)

Implementations§

Source§

impl UnsignedBalanceUpdate

Source

pub fn new( channel_id: &str, balance: u64, funding: &ClientChannelFunding, ) -> Result<Self, String>

Create an unsigned balance update from channel funding data.

Computes the message hash and tweak scalar needed for signing.

Source

pub fn sign(self, signature_hex: &str) -> Result<BalanceUpdateMessage, String>

Attach a signature and produce a BalanceUpdateMessage.

The signature should be a BIP-340 Schnorr signature (64 bytes, hex-encoded) produced by signing message_hex with the tweaked key.

Trait Implementations§

Source§

impl Clone for UnsignedBalanceUpdate

Source§

fn clone(&self) -> UnsignedBalanceUpdate

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for UnsignedBalanceUpdate

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more