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@3fcd0a8c[Running, parallelism = 2, size = 2, active = 0, running = 0, steals = 33, tasks = 0, submissions = 0]
+// ec: ExecutionContext = scala.concurrent.impl.ExecutionContextImpl$$anon$3@13a6357c[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(032c9f596867fba33a0a4bc0b74e701dea5c678740ed3b0a9b3e33bf025743ffdf)
+// pubKey: ECPublicKey = ECPublicKey(02af3e17f2fd73718b63bcbcc740e4f3dffb5731e64d4fccf10043c37ce0ee0073)
// 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(519528d184c6466cd6c4d62d1d7eceff9dfc4163)
+// creditingSpk: P2PKHScriptPubKey = pkh(ac1aade05633d5bf25b7f2a68db4518a4c44d0c7)
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(519528d184c6466cd6c4d62d1d7eceff9dfc4163))
+// utxo: TransactionOutput = TransactionOutput(10000 sats,pkh(ac1aade05633d5bf25b7f2a68db4518a4c44d0c7))
// 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(a7c9351e1dbd6f90ed9f035216d6e48f85b5fa26)
+// destinationSPK: P2PKHScriptPubKey = pkh(3004a2ba707c15ec9188f18d973bed8a7ef27bc0)
// 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(a7c9351e1dbd6f90ed9f035216d6e48f85b5fa26)))
+// destinations: Vector[TransactionOutput] = Vector(TransactionOutput(5000 sats,pkh(3004a2ba707c15ec9188f18d973bed8a7ef27bc0)))
// 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(519528d184c6466cd6c4d62d1d7eceff9dfc4163))),UInt32Impl(0))
+// creditingTx: BaseTransaction = BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(ac1aade05633d5bf25b7f2a68db4518a4c44d0c7))),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(61b34cfce2645aa18dc83bb54fa53da5a11754b0197afa1bbc21b9ff7b807174:0)
+// outPoint: TransactionOutPoint = TransactionOutPoint(aec8528b5808ef3b87974cda7c3f20f1df9edd7b3fe6681ee637b97698202af6:0)
val input = TransactionInput(
outPoint,
EmptyScriptSignature,
sequenceNumber = UInt32.zero)
-// input: TransactionInput = TransactionInputImpl(TransactionOutPoint(61b34cfce2645aa18dc83bb54fa53da5a11754b0197afa1bbc21b9ff7b807174:0),EmptyScriptSignature,UInt32Impl(0))
+// input: TransactionInput = TransactionInputImpl(TransactionOutPoint(aec8528b5808ef3b87974cda7c3f20f1df9edd7b3fe6681ee637b97698202af6: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(61b34cfce2645aa18dc83bb54fa53da5a11754b0197afa1bbc21b9ff7b807174:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(a7c9351e1dbd6f90ed9f035216d6e48f85b5fa26))),UInt32Impl(0))
+// builderResult: RawTxBuilderResult = RawTxBuilderResult(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(aec8528b5808ef3b87974cda7c3f20f1df9edd7b3fe6681ee637b97698202af6:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(3004a2ba707c15ec9188f18d973bed8a7ef27bc0))),UInt32Impl(0))
// this contains the information needed to analyze our input during finalization
val inputInfo = P2PKHInputInfo(outPoint, amount, privKey.publicKey)
-// inputInfo: P2PKHInputInfo = P2PKHInputInfo(TransactionOutPoint(61b34cfce2645aa18dc83bb54fa53da5a11754b0197afa1bbc21b9ff7b807174:0),10000 sats,ECPublicKey(032c9f596867fba33a0a4bc0b74e701dea5c678740ed3b0a9b3e33bf025743ffdf))
+// inputInfo: P2PKHInputInfo = P2PKHInputInfo(TransactionOutPoint(aec8528b5808ef3b87974cda7c3f20f1df9edd7b3fe6681ee637b97698202af6:0),10000 sats,ECPublicKey(02af3e17f2fd73718b63bcbcc740e4f3dffb5731e64d4fccf10043c37ce0ee0073))
// 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(65cbac3f9e8bebff88860097cda85603ac90506e)
+// changeSPK: P2PKHScriptPubKey = pkh(cbb9f7f4438f80ee9560287200db6be1bd041a0e)
// 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(61b34cfce2645aa18dc83bb54fa53da5a11754b0197afa1bbc21b9ff7b807174:0),10000 sats,ECPublicKey(032c9f596867fba33a0a4bc0b74e701dea5c678740ed3b0a9b3e33bf025743ffdf))),1 sats/byte,pkh(65cbac3f9e8bebff88860097cda85603ac90506e))
+// finalizer: StandardNonInteractiveFinalizer = StandardNonInteractiveFinalizer(Vector(P2PKHInputInfo(TransactionOutPoint(aec8528b5808ef3b87974cda7c3f20f1df9edd7b3fe6681ee637b97698202af6:0),10000 sats,ECPublicKey(02af3e17f2fd73718b63bcbcc740e4f3dffb5731e64d4fccf10043c37ce0ee0073))),1 sats/byte,pkh(cbb9f7f4438f80ee9560287200db6be1bd041a0e))
// 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(61b34cfce2645aa18dc83bb54fa53da5a11754b0197afa1bbc21b9ff7b807174:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(a7c9351e1dbd6f90ed9f035216d6e48f85b5fa26)), TransactionOutput(4775 sats,pkh(65cbac3f9e8bebff88860097cda85603ac90506e))),UInt32Impl(0))))
+// unsignedTxF: Future[Transaction] = Future(Success(BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(aec8528b5808ef3b87974cda7c3f20f1df9edd7b3fe6681ee637b97698202af6:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(3004a2ba707c15ec9188f18d973bed8a7ef27bc0)), TransactionOutput(4775 sats,pkh(cbb9f7f4438f80ee9560287200db6be1bd041a0e))),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(61b34cfce2645aa18dc83bb54fa53da5a11754b0197afa1bbc21b9ff7b807174:0),10000 sats,ECPublicKey(032c9f596867fba33a0a4bc0b74e701dea5c678740ed3b0a9b3e33bf025743ffdf)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(519528d184c6466cd6c4d62d1d7eceff9dfc4163))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1)))
+// utxoInfo: ScriptSignatureParams[P2PKHInputInfo] = ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(aec8528b5808ef3b87974cda7c3f20f1df9edd7b3fe6681ee637b97698202af6:0),10000 sats,ECPublicKey(02af3e17f2fd73718b63bcbcc740e4f3dffb5731e64d4fccf10043c37ce0ee0073)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(ac1aade05633d5bf25b7f2a68db4518a4c44d0c7))),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(61b34cfce2645aa18dc83bb54fa53da5a11754b0197afa1bbc21b9ff7b807174:0),10000 sats,ECPublicKey(032c9f596867fba33a0a4bc0b74e701dea5c678740ed3b0a9b3e33bf025743ffdf)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(519528d184c6466cd6c4d62d1d7eceff9dfc4163))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1))))
+// utxoInfos: Vector[ScriptSignatureParams[InputInfo]] = Vector(ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(aec8528b5808ef3b87974cda7c3f20f1df9edd7b3fe6681ee637b97698202af6:0),10000 sats,ECPublicKey(02af3e17f2fd73718b63bcbcc740e4f3dffb5731e64d4fccf10043c37ce0ee0073)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(ac1aade05633d5bf25b7f2a68db4518a4c44d0c7))),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(61b34cfce2645aa18dc83bb54fa53da5a11754b0197afa1bbc21b9ff7b807174:0),P2PKHScriptSignature(ECPublicKey(032c9f596867fba33a0a4bc0b74e701dea5c678740ed3b0a9b3e33bf025743ffdf), ECDigitalSignature(304402204d4108a23b7136c1cf4a325b02ee55ff20280670a8238e9d6973f511be1f7484022030acdb56c05f71502572bb893a09cf7b7fee03c141fecf197c91caac66af8e2901)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(a7c9351e1dbd6f90ed9f035216d6e48f85b5fa26)), TransactionOutput(4775 sats,pkh(65cbac3f9e8bebff88860097cda85603ac90506e))),UInt32Impl(0))
+// signedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(aec8528b5808ef3b87974cda7c3f20f1df9edd7b3fe6681ee637b97698202af6:0),P2PKHScriptSignature(ECPublicKey(02af3e17f2fd73718b63bcbcc740e4f3dffb5731e64d4fccf10043c37ce0ee0073), ECDigitalSignature(304402205ae60f0e468500067787d8332ed6610aa1e95861bd404104adc1e3e25e9df581022038d5ff08a01c4cfc23dd320e91b32507258697f7a803506fd4dc6b67da730e2501)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(3004a2ba707c15ec9188f18d973bed8a7ef27bc0)), TransactionOutput(4775 sats,pkh(cbb9f7f4438f80ee9560287200db6be1bd041a0e))),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 = 02000000017471807bffb921bc1bfa7a19b05417a1a53da54fb53bc88da15a64e2fc4cb361000000006a47304402204d4108a23b7136c1cf4a325b02ee55ff20280670a8238e9d6973f511be1f7484022030acdb56c05f71502572bb893a09cf7b7fee03c141fecf197c91caac66af8e290121032c9f596867fba33a0a4bc0b74e701dea5c678740ed3b0a9b3e33bf025743ffdf000000000288130000000000001976a914a7c9351e1dbd6f90ed9f035216d6e48f85b5fa2688aca7120000000000001976a91465cbac3f9e8bebff88860097cda85603ac90506e88ac00000000
+// res4: String = 0200000001f62a209876b937e61e68e63f7bdd9edff1203f7cda4c97873bef08588b52c8ae000000006a47304402205ae60f0e468500067787d8332ed6610aa1e95861bd404104adc1e3e25e9df581022038d5ff08a01c4cfc23dd320e91b32507258697f7a803506fd4dc6b67da730e25012102af3e17f2fd73718b63bcbcc740e4f3dffb5731e64d4fccf10043c37ce0ee0073000000000288130000000000001976a9143004a2ba707c15ec9188f18d973bed8a7ef27bc088aca7120000000000001976a914cbb9f7f4438f80ee9560287200db6be1bd041a0e88ac00000000