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
- Alphabetic
- By Inheritance
- TxBuilder
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Abstract Value Members
- 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
anddestinationAmount
is not a market rate miner fee - abstract def destinations: Seq[TransactionOutput]
The outputs which we are spending bitcoins to
- abstract def feeRate: FeeUnit
This represents the rate, in FeeUnit, we should pay for this transaction
- abstract def network: NetworkParameters
The network that this TxBuilder is signing a transaction for.
- abstract def sign(implicit ec: ExecutionContext): Future[Transaction]
- 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.
- 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
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##(): Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- def creditingAmount: CurrencyUnit
The total amount of satoshis that are able to be spent by this transaction
- def destinationAmount: CurrencyUnit
The spent amount of bitcoins we are sending in the transaction, this does NOT include the fee
- def destinationAmounts: Seq[CurrencyUnit]
A sequence of the amounts we are spending in this transaction
- def destinationSPKs: Seq[ScriptPubKey]
The ScriptPubKey's we are spending bitcoins to
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def largestFee: CurrencyUnit
The largest possible fee in this transaction could pay
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def outPoints: Seq[TransactionOutPoint]
The outpoints that we are using in this transaction
- def redeemScriptOpt: Seq[Option[ScriptPubKey]]
The redeem scripts that are needed in this transaction
- def scriptWitOpt: Seq[Option[ScriptWitness]]
The script witnesses that are needed in this transaction
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- def utxos: Seq[UTXOSpendingInfo]
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])