TxBuilder Example
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
implicit val ec: ExecutionContext = ExecutionContext.Implicits.global
-// ec: ExecutionContext = scala.concurrent.impl.ExecutionContextImpl$$anon$3@9d907a9[Running, parallelism = 2, size = 2, active = 0, running = 0, steals = 33, tasks = 0, submissions = 0]
+// ec: ExecutionContext = scala.concurrent.impl.ExecutionContextImpl$$anon$3@5d92fcf4[Running, parallelism = 2, size = 2, active = 0, running = 0, steals = 33, tasks = 0, submissions = 0]
// Initialize a transaction builder
val builder = RawTxBuilder()
@@ -74,19 +74,19 @@
val privKey = ECPrivateKey.freshPrivateKey
// privKey: ECPrivateKey = Masked(ECPrivateKeyImpl)
val pubKey = privKey.publicKey
-// pubKey: ECPublicKey = ECPublicKey(02f029d2db758444d8fbbcb45a2945d087f4d8079fe0eafbb04273abe31fe31794)
+// pubKey: ECPublicKey = ECPublicKey(023d218a92d78e68ee5d4601badeb1a9025023a4af9507ce0ed0f3f27e04aedf88)
// 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)
-// creditingSpk: P2PKHScriptPubKey = pkh(e052f68c2ec549866b4f86b41234bafff9813b99)
+// creditingSpk: P2PKHScriptPubKey = pkh(3cfc1cab8bef38f6e742844a04d60ad576de0da1)
val amount = 10000.satoshis
// amount: Satoshis = 10000 sats
// this is the UTXO we are going to be spending
val utxo =
TransactionOutput(value = amount, scriptPubKey = creditingSpk)
-// utxo: TransactionOutput = TransactionOutput(10000 sats,pkh(e052f68c2ec549866b4f86b41234bafff9813b99))
+// utxo: TransactionOutput = TransactionOutput(10000 sats,pkh(3cfc1cab8bef38f6e742844a04d60ad576de0da1))
// the private key that locks the funds for the script we are spending too
val destinationPrivKey = ECPrivateKey.freshPrivateKey
@@ -99,7 +99,7 @@
// the script that corresponds to destination private key, this is what is receiving the money
val destinationSPK =
P2PKHScriptPubKey(pubKey = destinationPrivKey.publicKey)
-// destinationSPK: P2PKHScriptPubKey = pkh(cfe8c9c404004eaada543690ad430aa397434875)
+// destinationSPK: P2PKHScriptPubKey = pkh(3d37ba749e7bf6cde55e04746c13bd8ad05b3983)
// this is where we are sending money too
// we could add more destinations here if we
@@ -110,7 +110,7 @@
Vector(destination0)
}
-// destinations: Vector[TransactionOutput] = Vector(TransactionOutput(5000 sats,pkh(cfe8c9c404004eaada543690ad430aa397434875)))
+// destinations: Vector[TransactionOutput] = Vector(TransactionOutput(5000 sats,pkh(3d37ba749e7bf6cde55e04746c13bd8ad05b3983)))
// Add the destinations to the tx builder
builder ++= destinations
@@ -123,17 +123,17 @@ builder ++= destinations
inputs = Vector.empty,
outputs = Vector(utxo),
lockTime = UInt32.zero)
-// creditingTx: BaseTransaction = BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(e052f68c2ec549866b4f86b41234bafff9813b99))),UInt32Impl(0))
+// creditingTx: BaseTransaction = BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(3cfc1cab8bef38f6e742844a04d60ad576de0da1))),UInt32Impl(0))
// 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)
-// outPoint: TransactionOutPoint = TransactionOutPoint(5fe50013f99911a4cb07366da41a843706922d5849f98a16f41564bed81b140f:0)
+// outPoint: TransactionOutPoint = TransactionOutPoint(fc322d4f6303976a45d8c51ae61228ff796006cbf42124975d9730d615389af0:0)
val input = TransactionInput(
outPoint,
EmptyScriptSignature,
sequenceNumber = UInt32.zero)
-// input: TransactionInput = TransactionInputImpl(TransactionOutPoint(5fe50013f99911a4cb07366da41a843706922d5849f98a16f41564bed81b140f:0),EmptyScriptSignature,UInt32Impl(0))
+// input: TransactionInput = TransactionInputImpl(TransactionOutPoint(fc322d4f6303976a45d8c51ae61228ff796006cbf42124975d9730d615389af0:0),EmptyScriptSignature,UInt32Impl(0))
// Add a new input to our builder
builder += input
@@ -141,11 +141,11 @@ builder += input
// We can now generate a RawTxBuilderResult ready to be finalized
val builderResult = builder.result()
-// builderResult: RawTxBuilderResult = RawTxBuilderResult(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(5fe50013f99911a4cb07366da41a843706922d5849f98a16f41564bed81b140f:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(cfe8c9c404004eaada543690ad430aa397434875))),UInt32Impl(0))
+// builderResult: RawTxBuilderResult = RawTxBuilderResult(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(fc322d4f6303976a45d8c51ae61228ff796006cbf42124975d9730d615389af0:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(3d37ba749e7bf6cde55e04746c13bd8ad05b3983))),UInt32Impl(0))
// this contains the information needed to analyze our input during finalization
val inputInfo = P2PKHInputInfo(outPoint, amount, privKey.publicKey)
-// inputInfo: P2PKHInputInfo = P2PKHInputInfo(TransactionOutPoint(5fe50013f99911a4cb07366da41a843706922d5849f98a16f41564bed81b140f:0),10000 sats,ECPublicKey(02f029d2db758444d8fbbcb45a2945d087f4d8079fe0eafbb04273abe31fe31794))
+// inputInfo: P2PKHInputInfo = P2PKHInputInfo(TransactionOutPoint(fc322d4f6303976a45d8c51ae61228ff796006cbf42124975d9730d615389af0:0),10000 sats,ECPublicKey(023d218a92d78e68ee5d4601badeb1a9025023a4af9507ce0ed0f3f27e04aedf88))
// 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
@@ -155,18 +155,18 @@ builder += input
val changePrivKey = ECPrivateKey.freshPrivateKey
// changePrivKey: ECPrivateKey = Masked(ECPrivateKeyImpl)
val changeSPK = P2PKHScriptPubKey(pubKey = changePrivKey.publicKey)
-// changeSPK: P2PKHScriptPubKey = pkh(4507643006ac5e0e305d5bc0e72472a3b7542d81)
+// changeSPK: P2PKHScriptPubKey = pkh(4872dbacad6560dbb9ff6faada2ea73557f8c4b2)
// We chose a finalizer that adds a change output to our tx based on a fee rate
val finalizer = StandardNonInteractiveFinalizer(
Vector(inputInfo),
feeRate,
changeSPK)
-// finalizer: StandardNonInteractiveFinalizer = StandardNonInteractiveFinalizer(Vector(P2PKHInputInfo(TransactionOutPoint(5fe50013f99911a4cb07366da41a843706922d5849f98a16f41564bed81b140f:0),10000 sats,ECPublicKey(02f029d2db758444d8fbbcb45a2945d087f4d8079fe0eafbb04273abe31fe31794))),1 sats/byte,pkh(4507643006ac5e0e305d5bc0e72472a3b7542d81))
+// finalizer: StandardNonInteractiveFinalizer = StandardNonInteractiveFinalizer(Vector(P2PKHInputInfo(TransactionOutPoint(fc322d4f6303976a45d8c51ae61228ff796006cbf42124975d9730d615389af0:0),10000 sats,ECPublicKey(023d218a92d78e68ee5d4601badeb1a9025023a4af9507ce0ed0f3f27e04aedf88))),1 sats/byte,pkh(4872dbacad6560dbb9ff6faada2ea73557f8c4b2))
// We can now finalize the tx builder result from earlier with this finalizer
val unsignedTxF: Future[Transaction] = finalizer.buildTx(builderResult)
-// unsignedTxF: Future[Transaction] = Future(Success(BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(5fe50013f99911a4cb07366da41a843706922d5849f98a16f41564bed81b140f:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(cfe8c9c404004eaada543690ad430aa397434875)), TransactionOutput(4775 sats,pkh(4507643006ac5e0e305d5bc0e72472a3b7542d81))),UInt32Impl(0))))
+// unsignedTxF: Future[Transaction] = Future(Success(BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(fc322d4f6303976a45d8c51ae61228ff796006cbf42124975d9730d615389af0:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(3d37ba749e7bf6cde55e04746c13bd8ad05b3983)), TransactionOutput(4775 sats,pkh(4872dbacad6560dbb9ff6faada2ea73557f8c4b2))),UInt32Impl(0))))
// We now turn to signing the unsigned transaction
// this contains all the information we need to
@@ -176,12 +176,12 @@ builder += input
signers = Vector(privKey),
hashType =
HashType.sigHashAll)
-// utxoInfo: ScriptSignatureParams[P2PKHInputInfo] = ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(5fe50013f99911a4cb07366da41a843706922d5849f98a16f41564bed81b140f:0),10000 sats,ECPublicKey(02f029d2db758444d8fbbcb45a2945d087f4d8079fe0eafbb04273abe31fe31794)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(e052f68c2ec549866b4f86b41234bafff9813b99))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1)))
+// utxoInfo: ScriptSignatureParams[P2PKHInputInfo] = ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(fc322d4f6303976a45d8c51ae61228ff796006cbf42124975d9730d615389af0:0),10000 sats,ECPublicKey(023d218a92d78e68ee5d4601badeb1a9025023a4af9507ce0ed0f3f27e04aedf88)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(3cfc1cab8bef38f6e742844a04d60ad576de0da1))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1)))
// all of the UTXO spending information, since we only have
// one input, this is just one element
val utxoInfos: Vector[ScriptSignatureParams[InputInfo]] = Vector(utxoInfo)
-// utxoInfos: Vector[ScriptSignatureParams[InputInfo]] = Vector(ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(5fe50013f99911a4cb07366da41a843706922d5849f98a16f41564bed81b140f:0),10000 sats,ECPublicKey(02f029d2db758444d8fbbcb45a2945d087f4d8079fe0eafbb04273abe31fe31794)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(e052f68c2ec549866b4f86b41234bafff9813b99))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1))))
+// utxoInfos: Vector[ScriptSignatureParams[InputInfo]] = Vector(ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(fc322d4f6303976a45d8c51ae61228ff796006cbf42124975d9730d615389af0:0),10000 sats,ECPublicKey(023d218a92d78e68ee5d4601badeb1a9025023a4af9507ce0ed0f3f27e04aedf88)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(3cfc1cab8bef38f6e742844a04d60ad576de0da1))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1))))
// Yay! Now we use the RawTxSigner object to sign the tx.
// The 'sign' method is going produce a validly signed transaction
@@ -201,7 +201,7 @@ builder += input
}
Await.result(signedTxF, 30.seconds)
}
-// signedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(5fe50013f99911a4cb07366da41a843706922d5849f98a16f41564bed81b140f:0),P2PKHScriptSignature(ECPublicKey(02f029d2db758444d8fbbcb45a2945d087f4d8079fe0eafbb04273abe31fe31794), ECDigitalSignature(3044022006cfcfebd5a99b02fea5d5ea49386b630d84ad3e43794ff7bee28f246dda5273022046edf6a442cb650014612e6549c4082b70cbeb1b17b74f0ab7d40d93caf4d4c901)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(cfe8c9c404004eaada543690ad430aa397434875)), TransactionOutput(4775 sats,pkh(4507643006ac5e0e305d5bc0e72472a3b7542d81))),UInt32Impl(0))
+// signedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(fc322d4f6303976a45d8c51ae61228ff796006cbf42124975d9730d615389af0:0),P2PKHScriptSignature(ECPublicKey(023d218a92d78e68ee5d4601badeb1a9025023a4af9507ce0ed0f3f27e04aedf88), ECDigitalSignature(3044022004fed4e6635598750f72d11a7e34777308eb45cf86e42d359724adc84aa74bd202207aa784b1e2a237bf70e844535415213c85d52780644261eecea8d82864d617ca01)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(3d37ba749e7bf6cde55e04746c13bd8ad05b3983)), TransactionOutput(4775 sats,pkh(4872dbacad6560dbb9ff6faada2ea73557f8c4b2))),UInt32Impl(0))
signedTx.inputs.length
// res2: Int = 1
@@ -211,7 +211,7 @@ signedTx.outputs.length
//remember, you can call .hex on any bitcoin-s data structure to get the hex representation!
signedTx.hex
-// res4: String = 02000000010f141bd8be6415f4168af949582d920637841aa46d3607cba41199f91300e55f000000006a473044022006cfcfebd5a99b02fea5d5ea49386b630d84ad3e43794ff7bee28f246dda5273022046edf6a442cb650014612e6549c4082b70cbeb1b17b74f0ab7d40d93caf4d4c9012102f029d2db758444d8fbbcb45a2945d087f4d8079fe0eafbb04273abe31fe31794000000000288130000000000001976a914cfe8c9c404004eaada543690ad430aa39743487588aca7120000000000001976a9144507643006ac5e0e305d5bc0e72472a3b7542d8188ac00000000
+// res4: String = 0200000001f09a3815d630975d972421f4cb066079ff2812e61ac5d8456a9703634f2d32fc000000006a473044022004fed4e6635598750f72d11a7e34777308eb45cf86e42d359724adc84aa74bd202207aa784b1e2a237bf70e844535415213c85d52780644261eecea8d82864d617ca0121023d218a92d78e68ee5d4601badeb1a9025023a4af9507ce0ed0f3f27e04aedf88000000000288130000000000001976a9143d37ba749e7bf6cde55e04746c13bd8ad05b398388aca7120000000000001976a9144872dbacad6560dbb9ff6faada2ea73557f8c4b288ac00000000