Interface BumpFeeTxBuilderInterface

  • All Implemented Interfaces:

    public interface BumpFeeTxBuilderInterface
    
                        

    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.

    • Constructor Detail

    • Method Detail

      • allowDust

         abstract BumpFeeTxBuilder allowDust(Boolean allowDust)

        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.

      • currentHeight

         abstract BumpFeeTxBuilder currentHeight(UInt height)

        Set the current blockchain height.

        This will be used to:

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

        • 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.

      • finish

         abstract Psbt finish(Wallet wallet)

        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.

      • nlocktime

         abstract BumpFeeTxBuilder nlocktime(LockTime locktime)

        Use a specific nLockTime while creating the transaction.

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

      • setExactSequence

         abstract BumpFeeTxBuilder setExactSequence(UInt nsequence)

        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.

      • version

         abstract BumpFeeTxBuilder version(Integer version)

        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.