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@3206ed47[Running, parallelism = 2, size = 2, active = 0, running = 0, steals = 33, tasks = 0, submissions = 0]
+// ec: ExecutionContext = scala.concurrent.impl.ExecutionContextImpl$$anon$3@43460d81[Running, parallelism = 2, size = 2, active = 0, running = 0, steals = 37, 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(0323dd42327cb73b1349b4197a821b06f126c3200da8f0e4c7bb51baf4bdb563d7)
+// pubKey: ECPublicKey = ECPublicKey(032f94e27c68ef3c516a88a61ccdf6841228614e2c7a6848b90b1a32e6e22d00b1)
// 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(b0ebedbd72000579889de6edd54f68440c4a0216)
+// creditingSpk: P2PKHScriptPubKey = pkh(c29324ff7d3a47fd31964475ecaf2fb31adc3567)
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(b0ebedbd72000579889de6edd54f68440c4a0216))
+// utxo: TransactionOutput = TransactionOutput(10000 sats,pkh(c29324ff7d3a47fd31964475ecaf2fb31adc3567))
// 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(0f247758a6cf34f324795f256040083fd1121548)
+// destinationSPK: P2PKHScriptPubKey = pkh(da053d3cbc1f650bccf647e1654e18000d3d7285)
// 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(0f247758a6cf34f324795f256040083fd1121548)))
+// destinations: Vector[TransactionOutput] = Vector(TransactionOutput(5000 sats,pkh(da053d3cbc1f650bccf647e1654e18000d3d7285)))
// 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(b0ebedbd72000579889de6edd54f68440c4a0216))),UInt32Impl(0))
+// creditingTx: BaseTransaction = BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(c29324ff7d3a47fd31964475ecaf2fb31adc3567))),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(a0320318bb6683065f6ac45b9f73388ad50120de8445e55addb217d5fb04f4fa:0)
+// outPoint: TransactionOutPoint = TransactionOutPoint(5e8ed6483b797875d681dd6fe50517d8b6b7f7df8911d0d2f106efd6e184f785:0)
val input = TransactionInput(
outPoint,
EmptyScriptSignature,
sequenceNumber = UInt32.zero)
-// input: TransactionInput = TransactionInputImpl(TransactionOutPoint(a0320318bb6683065f6ac45b9f73388ad50120de8445e55addb217d5fb04f4fa:0),EmptyScriptSignature,UInt32Impl(0))
+// input: TransactionInput = TransactionInputImpl(TransactionOutPoint(5e8ed6483b797875d681dd6fe50517d8b6b7f7df8911d0d2f106efd6e184f785: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(a0320318bb6683065f6ac45b9f73388ad50120de8445e55addb217d5fb04f4fa:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(0f247758a6cf34f324795f256040083fd1121548))),UInt32Impl(0))
+// builderResult: RawTxBuilderResult = RawTxBuilderResult(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(5e8ed6483b797875d681dd6fe50517d8b6b7f7df8911d0d2f106efd6e184f785:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(da053d3cbc1f650bccf647e1654e18000d3d7285))),UInt32Impl(0))
// this contains the information needed to analyze our input during finalization
val inputInfo = P2PKHInputInfo(outPoint, amount, privKey.publicKey)
-// inputInfo: P2PKHInputInfo = P2PKHInputInfo(TransactionOutPoint(a0320318bb6683065f6ac45b9f73388ad50120de8445e55addb217d5fb04f4fa:0),10000 sats,ECPublicKey(0323dd42327cb73b1349b4197a821b06f126c3200da8f0e4c7bb51baf4bdb563d7))
+// inputInfo: P2PKHInputInfo = P2PKHInputInfo(TransactionOutPoint(5e8ed6483b797875d681dd6fe50517d8b6b7f7df8911d0d2f106efd6e184f785:0),10000 sats,ECPublicKey(032f94e27c68ef3c516a88a61ccdf6841228614e2c7a6848b90b1a32e6e22d00b1))
// 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(3db31c023064b193bb0d9eee13d659e1af4c58fd)
+// changeSPK: P2PKHScriptPubKey = pkh(85f51b0746ef0927d5bccaf4e146f6662f54d1de)
// 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(a0320318bb6683065f6ac45b9f73388ad50120de8445e55addb217d5fb04f4fa:0),10000 sats,ECPublicKey(0323dd42327cb73b1349b4197a821b06f126c3200da8f0e4c7bb51baf4bdb563d7))),1 sats/byte,pkh(3db31c023064b193bb0d9eee13d659e1af4c58fd))
+// finalizer: StandardNonInteractiveFinalizer = StandardNonInteractiveFinalizer(Vector(P2PKHInputInfo(TransactionOutPoint(5e8ed6483b797875d681dd6fe50517d8b6b7f7df8911d0d2f106efd6e184f785:0),10000 sats,ECPublicKey(032f94e27c68ef3c516a88a61ccdf6841228614e2c7a6848b90b1a32e6e22d00b1))),1 sats/byte,pkh(85f51b0746ef0927d5bccaf4e146f6662f54d1de))
// 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(a0320318bb6683065f6ac45b9f73388ad50120de8445e55addb217d5fb04f4fa:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(0f247758a6cf34f324795f256040083fd1121548)), TransactionOutput(4775 sats,pkh(3db31c023064b193bb0d9eee13d659e1af4c58fd))),UInt32Impl(0))))
+// unsignedTxF: Future[Transaction] = Future(Success(BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(5e8ed6483b797875d681dd6fe50517d8b6b7f7df8911d0d2f106efd6e184f785:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(da053d3cbc1f650bccf647e1654e18000d3d7285)), TransactionOutput(4775 sats,pkh(85f51b0746ef0927d5bccaf4e146f6662f54d1de))),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(a0320318bb6683065f6ac45b9f73388ad50120de8445e55addb217d5fb04f4fa:0),10000 sats,ECPublicKey(0323dd42327cb73b1349b4197a821b06f126c3200da8f0e4c7bb51baf4bdb563d7)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(b0ebedbd72000579889de6edd54f68440c4a0216))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1)))
+// utxoInfo: ScriptSignatureParams[P2PKHInputInfo] = ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(5e8ed6483b797875d681dd6fe50517d8b6b7f7df8911d0d2f106efd6e184f785:0),10000 sats,ECPublicKey(032f94e27c68ef3c516a88a61ccdf6841228614e2c7a6848b90b1a32e6e22d00b1)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(c29324ff7d3a47fd31964475ecaf2fb31adc3567))),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(a0320318bb6683065f6ac45b9f73388ad50120de8445e55addb217d5fb04f4fa:0),10000 sats,ECPublicKey(0323dd42327cb73b1349b4197a821b06f126c3200da8f0e4c7bb51baf4bdb563d7)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(b0ebedbd72000579889de6edd54f68440c4a0216))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1))))
+// utxoInfos: Vector[ScriptSignatureParams[InputInfo]] = Vector(ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(5e8ed6483b797875d681dd6fe50517d8b6b7f7df8911d0d2f106efd6e184f785:0),10000 sats,ECPublicKey(032f94e27c68ef3c516a88a61ccdf6841228614e2c7a6848b90b1a32e6e22d00b1)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(c29324ff7d3a47fd31964475ecaf2fb31adc3567))),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(a0320318bb6683065f6ac45b9f73388ad50120de8445e55addb217d5fb04f4fa:0),P2PKHScriptSignature(ECPublicKey(0323dd42327cb73b1349b4197a821b06f126c3200da8f0e4c7bb51baf4bdb563d7), ECDigitalSignature(30440220521d069818d2ac3d26eca2eb85b5ee19d08337cc2194cffcc76b48ba8ed2cc530220642a24736d7f3b79417e7353edacaca71798b30732dfc4ce523163dbf1cc8e0501)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(0f247758a6cf34f324795f256040083fd1121548)), TransactionOutput(4775 sats,pkh(3db31c023064b193bb0d9eee13d659e1af4c58fd))),UInt32Impl(0))
+// signedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(5e8ed6483b797875d681dd6fe50517d8b6b7f7df8911d0d2f106efd6e184f785:0),P2PKHScriptSignature(ECPublicKey(032f94e27c68ef3c516a88a61ccdf6841228614e2c7a6848b90b1a32e6e22d00b1), ECDigitalSignature(3044022002251722a7e199db2df4f888fd0fc114b9d1e96d1758b28584aab3f793d777c60220177e04b3eca0742693de33a559a6972d6f739caecdc6c1b76836ec2fe9b745c701)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(da053d3cbc1f650bccf647e1654e18000d3d7285)), TransactionOutput(4775 sats,pkh(85f51b0746ef0927d5bccaf4e146f6662f54d1de))),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 = 0200000001faf404fbd517b2dd5ae54584de2001d58a38739f5bc46a5f068366bb180332a0000000006a4730440220521d069818d2ac3d26eca2eb85b5ee19d08337cc2194cffcc76b48ba8ed2cc530220642a24736d7f3b79417e7353edacaca71798b30732dfc4ce523163dbf1cc8e0501210323dd42327cb73b1349b4197a821b06f126c3200da8f0e4c7bb51baf4bdb563d7000000000288130000000000001976a9140f247758a6cf34f324795f256040083fd112154888aca7120000000000001976a9143db31c023064b193bb0d9eee13d659e1af4c58fd88ac00000000
+// res4: String = 020000000185f784e1d6ef06f1d2d01189dff7b7b6d81705e56fdd81d67578793b48d68e5e000000006a473044022002251722a7e199db2df4f888fd0fc114b9d1e96d1758b28584aab3f793d777c60220177e04b3eca0742693de33a559a6972d6f739caecdc6c1b76836ec2fe9b745c70121032f94e27c68ef3c516a88a61ccdf6841228614e2c7a6848b90b1a32e6e22d00b1000000000288130000000000001976a914da053d3cbc1f650bccf647e1654e18000d3d728588aca7120000000000001976a91485f51b0746ef0927d5bccaf4e146f6662f54d1de88ac00000000