Struct BumpFeeTxBuilder

pub struct BumpFeeTxBuilder { /* private fields */ }

A BumpFeeTxBuilder is created by calling build_fee_bump on a wallet. After assigning it, you set options on it until finally calling finish to consume the builder and generate the transaction.

Implementations

impl BumpFeeTxBuilder

pub fn new(txid: Arc<Txid>, fee_rate: Arc<FeeRate>) -> Self

pub fn set_exact_sequence(&self, nsequence: u32) -> Arc<Self>

Set an exact nSequence value.

This can cause conflicts if the wallet’s descriptors contain an “older” (OP_CSV) operator and the given nsequence is lower than the CSV value.

pub fn current_height(&self, height: u32) -> Arc<Self>

Set the current blockchain height.

This will be used to:

1. Set the nLockTime for preventing fee sniping. Note: This will be ignored if you manually specify a nlocktime using TxBuilder::nlocktime.

2. Decide whether coinbase outputs are mature or not. If the coinbase outputs are not mature at current_height, we ignore them in the coin selection. If you want to create a transaction that spends immature coinbase inputs, manually add them using TxBuilder::add_utxos. In both cases, if you don’t provide a current height, we use the last sync height.

pub fn nlocktime(&self, locktime: LockTime) -> Arc<Self>

Use a specific nLockTime while creating the transaction.

This can cause conflicts if the wallet’s descriptors contain an “after” (OP_CLTV) operator.

pub fn allow_dust(&self, allow_dust: bool) -> Arc<Self>

Set whether the dust limit is checked.

Note: by avoiding a dust limit check you may end up with a transaction that is non-standard.

pub fn version(&self, version: i32) -> Arc<Self>

Build a transaction with a specific version.

The version should always be greater than 0 and greater than 1 if the wallet’s descriptors contain an “older” (OP_CSV) operator.

pub fn sighash(&self, sighash: String) -> Result<Arc<Self>, SighashParseError>

Sign with a specific sig hash

Use this option very carefully

pub fn ordering(&self, ordering: TxOrdering) -> Arc<Self>

Choose the ordering for inputs and outputs of the transaction

When TxBuilder::ordering is set to TxOrdering::Untouched, the insertion order of recipients and manually selected UTXOs is preserved and reflected exactly in transaction’s output and input vectors respectively. If algorithmically selected UTXOs are included, they will be placed after all the manually selected ones in the transaction’s input vector.

pub fn finish(&self, wallet: &Arc<Wallet>) -> Result<Arc<Psbt>, CreateTxError>

Finish building the transaction.

Uses the thread-local random number generator (rng).

Returns a new Psbt per BIP174.

WARNING: To avoid change address reuse you must persist the changes resulting from one or more calls to this method before closing the wallet. See Wallet::reveal_next_address.

Trait Implementations

impl Clone for BumpFeeTxBuilder

fn clone(&self) -> BumpFeeTxBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<UT> LiftRef<UT> for BumpFeeTxBuilder

type LiftType = Arc<BumpFeeTxBuilder>

impl<UT> LowerError<UT> for BumpFeeTxBuilder

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for BumpFeeTxBuilder

type ReturnType = <Arc<BumpFeeTxBuilder> as LowerReturn<UniFfiTag>>::ReturnType

The type that should be returned by scaffolding functions for this type.

fn lower_return(obj: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts

impl<UT> TypeId<UT> for BumpFeeTxBuilder

const TYPE_ID_META: MetadataBuffer