Package 

Class BumpFeeTxBuilder

  • All Implemented Interfaces:
    
public final class BumpFeeTxBuilder

    The BumpFeeTxBuilder is used to bump the fee on a transaction that has been broadcast and has its RBF flag set to true.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      final BumpFeeTxBuilder allowShrinking(String address) Explicitly tells the wallet that it is allowed to reduce the amount of the output matching this scriptPubKey in order to bump the transaction fee.
      final BumpFeeTxBuilder enableRbf() Enable signaling RBF.
      final BumpFeeTxBuilder enableRbfWithSequence(UInt nsequence) Enable signaling RBF with a specific nSequence value.
      final TxBuilderResult finish(Wallet wallet) Finish building the transaction.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • BumpFeeTxBuilder

        BumpFeeTxBuilder()

    • Method Detail

      • allowShrinking

         final BumpFeeTxBuilder allowShrinking(String address)

        Explicitly tells the wallet that it is allowed to reduce the amount of the output matching this scriptPubKey in order to bump the transaction fee. Without specifying this the wallet will attempt to find a change output to shrink instead. Note that the output may shrink to below the dust limit and therefore be removed. If it is preserved then it is currently not guaranteed to be in the same position as it was originally. Returns an error if scriptPubkey can’t be found among the recipients of the transaction we are bumping.

      • enableRbf

         final BumpFeeTxBuilder enableRbf()

        Enable signaling RBF. This will use the default nsequence value of 0xFFFFFFFD.

      • enableRbfWithSequence

         final BumpFeeTxBuilder enableRbfWithSequence(UInt nsequence)

        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.