Struct bdk::wallet::tx_builder::TxBuilder

pub struct TxBuilder<Cs: CoinSelectionAlgorithm> { /* fields omitted */ }

A transaction builder

This structure contains the configuration that the wallet must follow to build a transaction.

For an example see this module's documentation;

Implementations

impl TxBuilder<DefaultCoinSelectionAlgorithm>

pub fn new() -> Self

Create an empty builder

pub fn with_recipients(recipients: Vec<(Script, u64)>) -> Self

Create a builder starting from a list of recipients

impl<Cs: CoinSelectionAlgorithm> TxBuilder<Cs>

pub fn set_recipients(self, recipients: Vec<(Script, u64)>) -> Self

Replace the recipients already added with a new list

pub fn add_recipient(self, script_pubkey: Script, amount: u64) -> Self

Add a recipient to the internal list

pub fn send_all(self) -> Self

Send all the selected utxos to a single output

Adding more than one recipients with this option enabled will result in an error.

The value associated with the only recipient is irrelevant and will be replaced by the wallet.

pub fn fee_rate(self, fee_rate: FeeRate) -> Self

Set a custom fee rate

pub fn policy_path(self, policy_path: BTreeMap<String, Vec<usize>>) -> Self

Set the policy path to use while creating the transaction

This method accepts a map where the key is the policy node id (see Policy::id) and the value is the list of the indexes of the items that are intended to be satisfied from the policy node (see SatisfiableItem::Thresh::items).

pub fn utxos(self, utxos: Vec<OutPoint>) -> Self

Replace the internal list of utxos that must be spent with a new list

These have priority over the "unspendable" utxos, meaning that if a utxo is present both in the "utxos" and the "unspendable" list, it will be spent.

pub fn add_utxo(self, utxo: OutPoint) -> Self

Add a utxo to the internal list of utxos that must be spent

These have priority over the "unspendable" utxos, meaning that if a utxo is present both in the "utxos" and the "unspendable" list, it will be spent.

pub fn unspendable(self, unspendable: Vec<OutPoint>) -> Self

Replace the internal list of unspendable utxos with a new list

It's important to note that the "must-be-spent" utxos added with TxBuilder::utxos and TxBuilder::add_utxo have priority over these. See the docs of the two linked methods for more details.

pub fn add_unspendable(self, unspendable: OutPoint) -> Self

Add a utxo to the internal list of unspendable utxos

It's important to note that the "must-be-spent" utxos added with TxBuilder::utxos and TxBuilder::add_utxo have priority over this. See the docs of the two linked methods for more details.

pub fn sighash(self, sighash: SigHashType) -> Self

Sign with a specific sig hash

Use this option very carefully

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

Choose the ordering for inputs and outputs of the transaction

pub fn nlocktime(self, locktime: u32) -> 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 enable_rbf(self) -> Self

Enable signaling RBF

This will use the default nSequence value of 0xFFFFFFFD.

pub fn enable_rbf_with_sequence(self, nsequence: u32) -> Self

Enable signaling RBF with a specific 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.

If the nsequence is higher than 0xFFFFFFFD an error will be thrown, since it would not be a valid nSequence to signal RBF.

pub fn version(self, version: u32) -> 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 do_not_spend_change(self) -> Self

Do not spend change outputs

This effectively adds all the change outputs to the "unspendable" list. See TxBuilder::unspendable.

pub fn only_spend_change(self) -> Self

Only spend change outputs

This effectively adds all the non-change outputs to the "unspendable" list. See TxBuilder::unspendable.

pub fn change_policy(self, change_policy: ChangeSpendPolicy) -> Self

Set a specific ChangeSpendPolicy. See TxBuilder::do_not_spend_change and TxBuilder::only_spend_change for some shortcuts.

pub fn force_non_witness_utxo(self) -> Self

Fill-in the psbt::Input::non_witness_utxo field even if the wallet only has SegWit descriptors.

This is useful for signers which always require it, like Trezor hardware wallets.

pub fn coin_selection<P: CoinSelectionAlgorithm>(
    self,
    coin_selection: P
) -> TxBuilder<P>

Choose the coin selection algorithm

Overrides the DefaultCoinSelectionAlgorithm.

Trait Implementations

impl<Cs: Debug + CoinSelectionAlgorithm> Debug for TxBuilder<Cs>

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

Formats the value using the given formatter.

impl<Cs: Default + CoinSelectionAlgorithm> Default for TxBuilder<Cs>

fn default() -> TxBuilder<Cs>

Returns the "default value" for a type.