Packages

sealed abstract class TxBuilder extends AnyRef

High level class to create a signed transaction that spends a set of unspent transaction outputs.

The most important method in this class is the 'sign' method. This will start the signing procedure for a transaction and then return either a signed Transaction or a TxBuilderError

For usage examples see TxBuilderSpec

Linear Supertypes
AnyRef, Any
Known Subclasses
BitcoinTxBuilder
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TxBuilder
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def changeSPK: ScriptPubKey

    This is where all the money that is NOT sent to destination outputs is spent too.

    This is where all the money that is NOT sent to destination outputs is spent too. If we don't specify a change output, a large miner fee may be paid as more than likely the difference between creditingAmount and destinationAmount is not a market rate miner fee

  2. abstract def destinations: Seq[TransactionOutput]

    The outputs which we are spending bitcoins to

  3. abstract def feeRate: FeeUnit

    This represents the rate, in FeeUnit, we should pay for this transaction

  4. abstract def network: NetworkParameters

    The network that this TxBuilder is signing a transaction for.

    The network that this TxBuilder is signing a transaction for. An example could be MainNet

  5. abstract def sign(implicit ec: ExecutionContext): Future[Transaction]
  6. abstract def unsignedTx(implicit ec: ExecutionContext): Future[Transaction]

    The unsigned version of the tx with dummy signatures instead of real signatures in the ScriptSignatures.

    The unsigned version of the tx with dummy signatures instead of real signatures in the ScriptSignatures. This unsigned transaction has fee estimation done against the SatoshisPerVirtualByte you passed in as a parameter the change output is calculated and ready for signing.

  7. abstract def utxoMap: UTXOMap

    The list of TransactionOutPoints we are attempting to spend and the signers, redeem scripts, and script witnesses that might be needed to spend this outpoint.

    The list of TransactionOutPoints we are attempting to spend and the signers, redeem scripts, and script witnesses that might be needed to spend this outpoint. This information is dependent on what the ScriptPubKey type is we are spending. For isntance, if we are spending a regular P2PKHScriptPubKey, we do not need a redeem script or script witness.

    If we are spending a P2WPKHWitnessSPKV0 we do not need a redeem script, but we need a ScriptWitness

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  6. def creditingAmount: CurrencyUnit

    The total amount of satoshis that are able to be spent by this transaction

  7. def destinationAmount: CurrencyUnit

    The spent amount of bitcoins we are sending in the transaction, this does NOT include the fee

  8. def destinationAmounts: Seq[CurrencyUnit]

    A sequence of the amounts we are spending in this transaction

  9. def destinationSPKs: Seq[ScriptPubKey]

    The ScriptPubKey's we are spending bitcoins to

  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. def largestFee: CurrencyUnit

    The largest possible fee in this transaction could pay

  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. def outPoints: Seq[TransactionOutPoint]

    The outpoints that we are using in this transaction

  20. def redeemScriptOpt: Seq[Option[ScriptPubKey]]

    The redeem scripts that are needed in this transaction

  21. def scriptWitOpt: Seq[Option[ScriptWitness]]

    The script witnesses that are needed in this transaction

  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. def utxos: Seq[UTXOSpendingInfo]
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from AnyRef

Inherited from Any

Ungrouped