Skip to main content

CommitmentTxBuilder

Struct CommitmentTxBuilder 

Source
pub struct CommitmentTxBuilder {
    pub fee_rate_sat_per_vb: u64,
    pub protocol_id: [u8; 32],
    pub max_fee_rate_sat_per_vb: u64,
    pub dust_threshold_sat: u64,
}
Expand description

Configuration for building commitment transactions

Fields§

§fee_rate_sat_per_vb: u64

Fee rate in sat/vB

§protocol_id: [u8; 32]

Protocol ID for this commitment

§max_fee_rate_sat_per_vb: u64

Maximum fee rate to prevent overpaying

§dust_threshold_sat: u64

Dust threshold (satoshi)

Implementations§

Source§

impl CommitmentTxBuilder

Source

pub fn new(protocol_id: [u8; 32], fee_rate_sat_per_vb: u64) -> Self

Create a new transaction builder

Source

pub fn with_fee_rate(self, fee_rate: u64) -> Self

Set the fee rate

Source

pub fn with_max_fee_rate(self, max_fee: u64) -> Self

Set maximum fee rate (prevents overpaying during fee spikes)

Source

pub fn estimate_vbytes(input_count: usize, output_count: usize) -> usize

Estimate virtual bytes for a commitment transaction

Source

pub fn calculate_fee(&self, input_count: usize, output_count: usize) -> u64

Calculate required fee

Source

pub fn is_above_dust(&self, value_sat: u64) -> bool

Check if an output amount is above the dust threshold

Source

pub fn build_commitment_tx( &self, wallet: &SealWallet, seal_utxo: &WalletUtxo, commitment_hash: [u8; 32], _change_path: Option<&Bip86Path>, ) -> Result<CommitmentTxResult, TxBuilderError>

Build a complete commitment transaction

This handles two cases:

  1. Plain P2TR input (funded externally to a simple P2TR address): The input is spent via key-path using the tweaked keypair. The output uses a Tapret commitment with the same internal key.

  2. Tapret input (previously committed): The input is spent via script-path using the tapret leaf.

For freshly funded UTXOs (case 1), this is the standard flow.

Source

pub fn build_commitment_data(&self, commitment: Hash) -> CommitmentData

Build legacy commitment data (for backward compatibility)

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> 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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