2019-05-15 01:05:14 +02:00
|
|
|
---
|
|
|
|
id: txbuilder
|
2020-03-13 09:54:07 -05:00
|
|
|
title: TxBuilder Example
|
2019-05-15 01:05:14 +02:00
|
|
|
---
|
|
|
|
|
2020-05-21 09:47:08 -05:00
|
|
|
Bitcoin-S features a transaction building API that allows you to construct and sign Bitcoin transactions. Here's an example of how to use it
|
2019-05-15 01:05:14 +02:00
|
|
|
|
2020-03-10 12:49:22 -05:00
|
|
|
```scala mdoc:invisible
|
2019-05-15 01:05:14 +02:00
|
|
|
import scala.concurrent._
|
|
|
|
|
|
|
|
import org.bitcoins.core._
|
|
|
|
import number._
|
|
|
|
import currency._
|
2020-04-30 11:34:53 -06:00
|
|
|
import org.bitcoins.crypto._
|
2019-05-15 01:05:14 +02:00
|
|
|
import protocol.transaction._
|
|
|
|
import protocol.script._
|
|
|
|
|
|
|
|
import wallet.builder._
|
|
|
|
import wallet.fee._
|
|
|
|
import wallet.utxo._
|
|
|
|
|
2020-03-10 12:49:22 -05:00
|
|
|
```
|
|
|
|
|
|
|
|
```scala mdoc:to-string
|
|
|
|
|
2019-05-15 01:05:14 +02:00
|
|
|
implicit val ec: ExecutionContext = ExecutionContext.Implicits.global
|
|
|
|
|
2020-05-21 09:47:08 -05:00
|
|
|
// Initialize a transaction builder
|
|
|
|
val builder = RawTxBuilder()
|
|
|
|
|
2019-05-15 01:05:14 +02:00
|
|
|
// generate a fresh private key that we are going to use in the scriptpubkey
|
|
|
|
val privKey = ECPrivateKey.freshPrivateKey
|
|
|
|
val pubKey = privKey.publicKey
|
|
|
|
|
|
|
|
// this is the script that the TxBuilder is going to create a
|
|
|
|
// script signature that validly spends this scriptPubKey
|
|
|
|
val creditingSpk = P2PKHScriptPubKey(pubKey = privKey.publicKey)
|
|
|
|
val amount = 10000.satoshis
|
|
|
|
|
|
|
|
// this is the UTXO we are going to be spending
|
|
|
|
val utxo =
|
2019-07-09 13:25:24 +02:00
|
|
|
TransactionOutput(value = amount, scriptPubKey = creditingSpk)
|
2019-05-15 01:05:14 +02:00
|
|
|
|
|
|
|
// the private key that locks the funds for the script we are spending too
|
|
|
|
val destinationPrivKey = ECPrivateKey.freshPrivateKey
|
|
|
|
|
|
|
|
// the amount we are sending -- 5000 satoshis -- to the destinationSPK
|
|
|
|
val destinationAmount = 5000.satoshis
|
|
|
|
|
2020-05-21 09:47:08 -05:00
|
|
|
// the script that corresponds to destination private key, this is what is receiving the money
|
2019-05-15 01:05:14 +02:00
|
|
|
val destinationSPK =
|
|
|
|
P2PKHScriptPubKey(pubKey = destinationPrivKey.publicKey)
|
|
|
|
|
|
|
|
// this is where we are sending money too
|
|
|
|
// we could add more destinations here if we
|
|
|
|
// wanted to batch transactions
|
|
|
|
val destinations = {
|
2020-05-21 09:47:08 -05:00
|
|
|
val destination0 = TransactionOutput(value = destinationAmount,
|
2019-05-15 01:05:14 +02:00
|
|
|
scriptPubKey = destinationSPK)
|
|
|
|
|
2020-05-21 09:47:08 -05:00
|
|
|
Vector(destination0)
|
2019-05-15 01:05:14 +02:00
|
|
|
}
|
|
|
|
|
2020-05-21 09:47:08 -05:00
|
|
|
// Add the destinations to the tx builder
|
|
|
|
builder ++= destinations
|
|
|
|
|
2019-05-15 01:05:14 +02:00
|
|
|
// we have to fabricate a transaction that contains the
|
|
|
|
// UTXO we are trying to spend. If this were a real blockchain
|
|
|
|
// we would need to reference the UTXO set
|
|
|
|
val creditingTx = BaseTransaction(version = Int32.one,
|
2020-01-15 10:00:55 -07:00
|
|
|
inputs = Vector.empty,
|
|
|
|
outputs = Vector(utxo),
|
2019-05-15 01:05:14 +02:00
|
|
|
lockTime = UInt32.zero)
|
|
|
|
|
|
|
|
// this is the information we need from the crediting TX
|
|
|
|
// to properly "link" it in the transaction we are creating
|
|
|
|
val outPoint = TransactionOutPoint(creditingTx.txId, UInt32.zero)
|
2020-05-21 09:47:08 -05:00
|
|
|
val input = TransactionInput(
|
|
|
|
outPoint,
|
|
|
|
EmptyScriptSignature,
|
|
|
|
sequenceNumber = UInt32.zero)
|
2019-05-15 01:05:14 +02:00
|
|
|
|
2020-05-21 09:47:08 -05:00
|
|
|
// Add a new input to our builder
|
|
|
|
builder += input
|
2019-05-15 01:05:14 +02:00
|
|
|
|
2020-05-21 09:47:08 -05:00
|
|
|
// We can now generate a RawTxBuilderResult ready to be finalized
|
|
|
|
val builderResult = builder.result()
|
|
|
|
|
|
|
|
// this contains the information needed to analyze our input during finalization
|
|
|
|
val inputInfo = P2PKHInputInfo(outPoint, amount, privKey.publicKey)
|
2019-05-15 01:05:14 +02:00
|
|
|
|
|
|
|
// this is how much we are going to pay as a fee to the network
|
|
|
|
// for this example, we are going to pay 1 satoshi per byte
|
|
|
|
val feeRate = SatoshisPerByte(1.satoshi)
|
|
|
|
|
|
|
|
val changePrivKey = ECPrivateKey.freshPrivateKey
|
|
|
|
val changeSPK = P2PKHScriptPubKey(pubKey = changePrivKey.publicKey)
|
|
|
|
|
2020-05-21 09:47:08 -05:00
|
|
|
// We chose a finalizer that adds a change output to our tx based on a fee rate
|
2020-05-27 18:05:37 -05:00
|
|
|
val finalizer = StandardNonInteractiveFinalizer(
|
2020-05-21 09:47:08 -05:00
|
|
|
Vector(inputInfo),
|
|
|
|
feeRate,
|
|
|
|
changeSPK)
|
|
|
|
|
|
|
|
// We can now finalize the tx builder result from earlier with this finalizer
|
2021-03-23 17:05:58 -05:00
|
|
|
val unsignedTx: Transaction = finalizer.buildTx(builderResult)
|
2020-05-21 09:47:08 -05:00
|
|
|
|
|
|
|
// We now turn to signing the unsigned transaction
|
|
|
|
// this contains all the information we need to
|
|
|
|
// validly sign the UTXO above
|
|
|
|
val utxoInfo = ScriptSignatureParams(inputInfo = inputInfo,
|
2020-06-25 16:10:36 -05:00
|
|
|
prevTransaction = creditingTx,
|
2020-05-21 09:47:08 -05:00
|
|
|
signers = Vector(privKey),
|
|
|
|
hashType =
|
|
|
|
HashType.sigHashAll)
|
|
|
|
|
|
|
|
// all of the UTXO spending information, since we only have
|
|
|
|
// one input, this is just one element
|
|
|
|
val utxoInfos: Vector[ScriptSignatureParams[InputInfo]] = Vector(utxoInfo)
|
2019-05-15 01:05:14 +02:00
|
|
|
|
2020-05-21 09:47:08 -05:00
|
|
|
// Yay! Now we use the RawTxSigner object to sign the tx.
|
2019-05-15 01:05:14 +02:00
|
|
|
// The 'sign' method is going produce a validly signed transaction
|
|
|
|
// This is going to iterate through each of the UTXOs and use
|
2020-05-15 10:14:15 -06:00
|
|
|
// the corresponding ScriptSignatureParams to produce a validly
|
2019-05-15 01:05:14 +02:00
|
|
|
// signed input. This UTXO has:
|
|
|
|
// 1: one input
|
|
|
|
// 2: outputs (destination and change outputs)
|
|
|
|
// 3: a fee rate of 1 satoshi/byte
|
2021-03-23 17:05:58 -05:00
|
|
|
val signedTx: Transaction =
|
|
|
|
RawTxSigner.sign(
|
|
|
|
utx = unsignedTx,
|
|
|
|
utxoInfos = utxoInfos,
|
|
|
|
expectedFeeRate = feeRate
|
|
|
|
)
|
2019-05-15 01:05:14 +02:00
|
|
|
```
|
|
|
|
|
2020-03-10 12:49:22 -05:00
|
|
|
```scala mdoc:to-string
|
2019-05-15 01:05:14 +02:00
|
|
|
signedTx.inputs.length
|
|
|
|
|
|
|
|
signedTx.outputs.length
|
|
|
|
|
|
|
|
//remember, you can call .hex on any bitcoin-s data structure to get the hex representation!
|
|
|
|
signedTx.hex
|
|
|
|
```
|