Skip to main content

CommitmentOutputs

Struct CommitmentOutputs 

Source
pub struct CommitmentOutputs {
    pub receiver_outputs: DeterministicOutputsForOneContext,
    pub sender_outputs: DeterministicOutputsForOneContext,
}
Expand description

Commitment outputs for a specific balance distribution Contains the deterministic outputs for both sender (Alice) and receiver (Charlie) at a specific balance point in the channel

Fields§

§receiver_outputs: DeterministicOutputsForOneContext

Receiver’s (Charlie’s) deterministic outputs

§sender_outputs: DeterministicOutputsForOneContext

Sender’s (Alice’s) deterministic outputs

Implementations§

Source§

impl CommitmentOutputs

Source

pub fn new( receiver_outputs: DeterministicOutputsForOneContext, sender_outputs: DeterministicOutputsForOneContext, ) -> Self

Create new commitment outputs

Source

pub fn for_balance( receiver_balance: u64, params: &ChannelParameters, ) -> Result<Self>

Create commitment outputs for a given receiver balance

Given the receiver’s (Charlie’s) desired final balance, this creates:

  • One DeterministicOutputsForOneContext for the receiver (Charlie)
  • One DeterministicOutputsForOneContext for the sender (Alice) with the remainder

The process:

  1. Use inverse function to find nominal value for receiver’s deterministic outputs
  2. Calculate sender’s nominal value as: amount_after_stage1 - receiver_nominal
  3. Create both sets of outputs wrapped in CommitmentOutputs

Parameters:

  • receiver_balance: The desired final balance for the receiver (after stage 2 fees)
  • params: Channel parameters

Returns CommitmentOutputs containing both receiver and sender outputs

Source

pub fn create_swap_request( &self, funding_proofs: Vec<Proof>, override_keyset_id: Option<Id>, ) -> Result<SwapRequest, Error>

Create an unsigned swap request from this commitment

Takes the funding proofs and creates a SwapRequest with:

  • Inputs: all funding proofs
  • Outputs: all outputs sorted by amount (stable) for privacy

The swap request is unsigned and needs to be signed by the sender (Alice) before sending

Source

pub fn unblind_all( &self, blind_signatures: Vec<BlindSignature>, active_keys: &Keys, ) -> Result<Vec<ProofWithMetadata>, Error>

Unblind all outputs from a swap response

Takes the blind signatures from the swap response and returns a vector of ProofWithMetadata containing each proof along with its amount, index, and ownership flag.

The caller can filter by is_receiver to separate receiver/sender proofs.

Source

pub async fn restore_all_blind_signatures<M>( &self, mint_connection: &M, ) -> Result<Vec<BlindSignature>, Error>
where M: MintConnection + ?Sized,

Restore blind signatures from the mint using NUT-09

This allows recovering the blind signatures for a commitment transaction without needing to have received them from the original swap. Since outputs are deterministic, we can recreate the blinded messages and ask the mint to restore the corresponding blind signatures.

Returns the blind signatures in the same order as create_swap_request: sorted by amount (stable) for privacy

Trait Implementations§

Source§

impl Clone for CommitmentOutputs

Source§

fn clone(&self) -> CommitmentOutputs

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 CommitmentOutputs

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