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@2530d114[Running, parallelism = 2, size = 2, active = 0, running = 0, steals = 35, tasks = 0, submissions = 0]
+// ec: ExecutionContext = scala.concurrent.impl.ExecutionContextImpl$$anon$3@4a1ada77[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(03d306600f064c130df38e67adf0f79fda65840b58e4835e952797cfdb25d34ddf)
+// pubKey: ECPublicKey = ECPublicKey(0223f0e961d9b4dd59520793dff1c53e9f5d5c5a62e1d0c281caa1d2491245a444)
// 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(aa3b8bac6fe2982b671955233d72ac8ee2655fba)
+// creditingSpk: P2PKHScriptPubKey = pkh(f1e5fc71257c8f69d512687fbf2b23d264058087)
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(aa3b8bac6fe2982b671955233d72ac8ee2655fba))
+// utxo: TransactionOutput = TransactionOutput(10000 sats,pkh(f1e5fc71257c8f69d512687fbf2b23d264058087))
// 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(17f184c4e4dbf7699421fb64be020f7ed3a413b6)
+// destinationSPK: P2PKHScriptPubKey = pkh(16e78aaceceec3deb1ec46f1db2c289d5b586a5a)
// 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(17f184c4e4dbf7699421fb64be020f7ed3a413b6)))
+// destinations: Vector[TransactionOutput] = Vector(TransactionOutput(5000 sats,pkh(16e78aaceceec3deb1ec46f1db2c289d5b586a5a)))
// 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(aa3b8bac6fe2982b671955233d72ac8ee2655fba))),UInt32Impl(0))
+// creditingTx: BaseTransaction = BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(f1e5fc71257c8f69d512687fbf2b23d264058087))),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(93464dbd4548223b9bd57ac6cca59f7bc42f77374d86ab7aefd6c5e984602ea4:0)
+// outPoint: TransactionOutPoint = TransactionOutPoint(2f7b1038327c861babc37bfc15507a4da66323b320d3957a7c61f0824aa61e8b:0)
val input = TransactionInput(
outPoint,
EmptyScriptSignature,
sequenceNumber = UInt32.zero)
-// input: TransactionInput = TransactionInputImpl(TransactionOutPoint(93464dbd4548223b9bd57ac6cca59f7bc42f77374d86ab7aefd6c5e984602ea4:0),EmptyScriptSignature,UInt32Impl(0))
+// input: TransactionInput = TransactionInputImpl(TransactionOutPoint(2f7b1038327c861babc37bfc15507a4da66323b320d3957a7c61f0824aa61e8b: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(93464dbd4548223b9bd57ac6cca59f7bc42f77374d86ab7aefd6c5e984602ea4:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(17f184c4e4dbf7699421fb64be020f7ed3a413b6))),UInt32Impl(0))
+// builderResult: RawTxBuilderResult = RawTxBuilderResult(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(2f7b1038327c861babc37bfc15507a4da66323b320d3957a7c61f0824aa61e8b:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(16e78aaceceec3deb1ec46f1db2c289d5b586a5a))),UInt32Impl(0))
// this contains the information needed to analyze our input during finalization
val inputInfo = P2PKHInputInfo(outPoint, amount, privKey.publicKey)
-// inputInfo: P2PKHInputInfo = P2PKHInputInfo(TransactionOutPoint(93464dbd4548223b9bd57ac6cca59f7bc42f77374d86ab7aefd6c5e984602ea4:0),10000 sats,ECPublicKey(03d306600f064c130df38e67adf0f79fda65840b58e4835e952797cfdb25d34ddf))
+// inputInfo: P2PKHInputInfo = P2PKHInputInfo(TransactionOutPoint(2f7b1038327c861babc37bfc15507a4da66323b320d3957a7c61f0824aa61e8b:0),10000 sats,ECPublicKey(0223f0e961d9b4dd59520793dff1c53e9f5d5c5a62e1d0c281caa1d2491245a444))
// 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(dd432cd0097056b2030946f4938f94b20bb4941f)
+// changeSPK: P2PKHScriptPubKey = pkh(03aad37e92550ca73c4c33a6f9986d29135f4d7a)
// 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(93464dbd4548223b9bd57ac6cca59f7bc42f77374d86ab7aefd6c5e984602ea4:0),10000 sats,ECPublicKey(03d306600f064c130df38e67adf0f79fda65840b58e4835e952797cfdb25d34ddf))),1 sats/byte,pkh(dd432cd0097056b2030946f4938f94b20bb4941f))
+// finalizer: StandardNonInteractiveFinalizer = StandardNonInteractiveFinalizer(Vector(P2PKHInputInfo(TransactionOutPoint(2f7b1038327c861babc37bfc15507a4da66323b320d3957a7c61f0824aa61e8b:0),10000 sats,ECPublicKey(0223f0e961d9b4dd59520793dff1c53e9f5d5c5a62e1d0c281caa1d2491245a444))),1 sats/byte,pkh(03aad37e92550ca73c4c33a6f9986d29135f4d7a))
// 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(93464dbd4548223b9bd57ac6cca59f7bc42f77374d86ab7aefd6c5e984602ea4:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(17f184c4e4dbf7699421fb64be020f7ed3a413b6)), TransactionOutput(4775 sats,pkh(dd432cd0097056b2030946f4938f94b20bb4941f))),UInt32Impl(0))))
+// unsignedTxF: Future[Transaction] = Future(Success(BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(2f7b1038327c861babc37bfc15507a4da66323b320d3957a7c61f0824aa61e8b:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(16e78aaceceec3deb1ec46f1db2c289d5b586a5a)), TransactionOutput(4775 sats,pkh(03aad37e92550ca73c4c33a6f9986d29135f4d7a))),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(93464dbd4548223b9bd57ac6cca59f7bc42f77374d86ab7aefd6c5e984602ea4:0),10000 sats,ECPublicKey(03d306600f064c130df38e67adf0f79fda65840b58e4835e952797cfdb25d34ddf)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(aa3b8bac6fe2982b671955233d72ac8ee2655fba))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1)))
+// utxoInfo: ScriptSignatureParams[P2PKHInputInfo] = ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(2f7b1038327c861babc37bfc15507a4da66323b320d3957a7c61f0824aa61e8b:0),10000 sats,ECPublicKey(0223f0e961d9b4dd59520793dff1c53e9f5d5c5a62e1d0c281caa1d2491245a444)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(f1e5fc71257c8f69d512687fbf2b23d264058087))),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(93464dbd4548223b9bd57ac6cca59f7bc42f77374d86ab7aefd6c5e984602ea4:0),10000 sats,ECPublicKey(03d306600f064c130df38e67adf0f79fda65840b58e4835e952797cfdb25d34ddf)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(aa3b8bac6fe2982b671955233d72ac8ee2655fba))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1))))
+// utxoInfos: Vector[ScriptSignatureParams[InputInfo]] = Vector(ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(2f7b1038327c861babc37bfc15507a4da66323b320d3957a7c61f0824aa61e8b:0),10000 sats,ECPublicKey(0223f0e961d9b4dd59520793dff1c53e9f5d5c5a62e1d0c281caa1d2491245a444)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(f1e5fc71257c8f69d512687fbf2b23d264058087))),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(93464dbd4548223b9bd57ac6cca59f7bc42f77374d86ab7aefd6c5e984602ea4:0),P2PKHScriptSignature(ECPublicKey(03d306600f064c130df38e67adf0f79fda65840b58e4835e952797cfdb25d34ddf), ECDigitalSignature(304402201e38506a918dc71a881f019aed6edd6554e5eae6ab37beaeac20d4e947f5506102203bc73c13c5d1828137015c6acc3b76164b9193050fb84867803668b6b729d88d01)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(17f184c4e4dbf7699421fb64be020f7ed3a413b6)), TransactionOutput(4775 sats,pkh(dd432cd0097056b2030946f4938f94b20bb4941f))),UInt32Impl(0))
+// signedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(2f7b1038327c861babc37bfc15507a4da66323b320d3957a7c61f0824aa61e8b:0),P2PKHScriptSignature(ECPublicKey(0223f0e961d9b4dd59520793dff1c53e9f5d5c5a62e1d0c281caa1d2491245a444), ECDigitalSignature(3044022001035d98aadc3ec971126068bb965a82a56ebcb4a62c823771a939cb81bd632d0220017877547c91b0bea5f637796aeccdc4c4b4566812d60d133c042e5b830eed1001)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(16e78aaceceec3deb1ec46f1db2c289d5b586a5a)), TransactionOutput(4775 sats,pkh(03aad37e92550ca73c4c33a6f9986d29135f4d7a))),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 = 0200000001a42e6084e9c5d6ef7aab864d37772fc47b9fa5ccc67ad59b3b224845bd4d4693000000006a47304402201e38506a918dc71a881f019aed6edd6554e5eae6ab37beaeac20d4e947f5506102203bc73c13c5d1828137015c6acc3b76164b9193050fb84867803668b6b729d88d012103d306600f064c130df38e67adf0f79fda65840b58e4835e952797cfdb25d34ddf000000000288130000000000001976a91417f184c4e4dbf7699421fb64be020f7ed3a413b688aca7120000000000001976a914dd432cd0097056b2030946f4938f94b20bb4941f88ac00000000
+// res4: String = 02000000018b1ea64a82f0617c7a95d320b32363a64d7a5015fc7bc3ab1b867c3238107b2f000000006a473044022001035d98aadc3ec971126068bb965a82a56ebcb4a62c823771a939cb81bd632d0220017877547c91b0bea5f637796aeccdc4c4b4566812d60d133c042e5b830eed1001210223f0e961d9b4dd59520793dff1c53e9f5d5c5a62e1d0c281caa1d2491245a444000000000288130000000000001976a91416e78aaceceec3deb1ec46f1db2c289d5b586a5a88aca7120000000000001976a91403aad37e92550ca73c4c33a6f9986d29135f4d7a88ac00000000