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@2f1f0fb7[Running, parallelism = 2, size = 2, active = 0, running = 0, steals = 3, tasks = 0, submissions = 0]
+// ec: ExecutionContext = scala.concurrent.impl.ExecutionContextImpl$$anon$3@339de39c[Running, parallelism = 2, size = 2, active = 0, running = 0, steals = 3, 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(030c82dd870b2491beddc9696be355a21e639b55a8e9bfd83c5a68e222528027b5)
+// pubKey: ECPublicKey = ECPublicKey(03e0f4d8e5c88682c405b1bd5f52450203ed1b7ceb6a5cc47a8e7fa526043f9c08)
// 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(03dcdb81657636c4c1214f89bca9d53e167aa095)
+// creditingSpk: P2PKHScriptPubKey = pkh(34e683bd89b2df667a60f02c3e45320511dc476f)
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(03dcdb81657636c4c1214f89bca9d53e167aa095))
+// utxo: TransactionOutput = TransactionOutput(10000 sats,pkh(34e683bd89b2df667a60f02c3e45320511dc476f))
// 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(7b59b89cbab9cc5b53c1e0028c0dc4d4fd0f9763)
+// destinationSPK: P2PKHScriptPubKey = pkh(e606d381a89cdad85828afbda3f4be70fb8eeffc)
// 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(7b59b89cbab9cc5b53c1e0028c0dc4d4fd0f9763)))
+// destinations: Vector[TransactionOutput] = Vector(TransactionOutput(5000 sats,pkh(e606d381a89cdad85828afbda3f4be70fb8eeffc)))
// 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(03dcdb81657636c4c1214f89bca9d53e167aa095))),UInt32Impl(0))
+// creditingTx: BaseTransaction = BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(34e683bd89b2df667a60f02c3e45320511dc476f))),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(75686d19581d0e537269418e7ca9aef22db9f71bfb6d6028dec5d4220d10f546:0)
+// outPoint: TransactionOutPoint = TransactionOutPoint(220face5a1ea71dcb1117a0bf95eda38c7072a132dfdd0a1c0c9d2d121aa8227:0)
val input = TransactionInput(
outPoint,
EmptyScriptSignature,
sequenceNumber = UInt32.zero)
-// input: TransactionInput = TransactionInputImpl(TransactionOutPoint(75686d19581d0e537269418e7ca9aef22db9f71bfb6d6028dec5d4220d10f546:0),EmptyScriptSignature,UInt32Impl(0))
+// input: TransactionInput = TransactionInputImpl(TransactionOutPoint(220face5a1ea71dcb1117a0bf95eda38c7072a132dfdd0a1c0c9d2d121aa8227: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(75686d19581d0e537269418e7ca9aef22db9f71bfb6d6028dec5d4220d10f546:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(7b59b89cbab9cc5b53c1e0028c0dc4d4fd0f9763))),UInt32Impl(0))
+// builderResult: RawTxBuilderResult = RawTxBuilderResult(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(220face5a1ea71dcb1117a0bf95eda38c7072a132dfdd0a1c0c9d2d121aa8227:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(e606d381a89cdad85828afbda3f4be70fb8eeffc))),UInt32Impl(0))
// this contains the information needed to analyze our input during finalization
val inputInfo = P2PKHInputInfo(outPoint, amount, privKey.publicKey)
-// inputInfo: P2PKHInputInfo = P2PKHInputInfo(TransactionOutPoint(75686d19581d0e537269418e7ca9aef22db9f71bfb6d6028dec5d4220d10f546:0),10000 sats,ECPublicKey(030c82dd870b2491beddc9696be355a21e639b55a8e9bfd83c5a68e222528027b5))
+// inputInfo: P2PKHInputInfo = P2PKHInputInfo(TransactionOutPoint(220face5a1ea71dcb1117a0bf95eda38c7072a132dfdd0a1c0c9d2d121aa8227:0),10000 sats,ECPublicKey(03e0f4d8e5c88682c405b1bd5f52450203ed1b7ceb6a5cc47a8e7fa526043f9c08))
// 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(916090fd01e98c36f7a4e7480b7d156bb3a54ff9)
+// changeSPK: P2PKHScriptPubKey = pkh(44e65db5ee5102c7ef01990e0fddf1cea57700f6)
// 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(75686d19581d0e537269418e7ca9aef22db9f71bfb6d6028dec5d4220d10f546:0),10000 sats,ECPublicKey(030c82dd870b2491beddc9696be355a21e639b55a8e9bfd83c5a68e222528027b5))),1 sats/byte,pkh(916090fd01e98c36f7a4e7480b7d156bb3a54ff9))
+// finalizer: StandardNonInteractiveFinalizer = StandardNonInteractiveFinalizer(Vector(P2PKHInputInfo(TransactionOutPoint(220face5a1ea71dcb1117a0bf95eda38c7072a132dfdd0a1c0c9d2d121aa8227:0),10000 sats,ECPublicKey(03e0f4d8e5c88682c405b1bd5f52450203ed1b7ceb6a5cc47a8e7fa526043f9c08))),1 sats/byte,pkh(44e65db5ee5102c7ef01990e0fddf1cea57700f6))
// 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(75686d19581d0e537269418e7ca9aef22db9f71bfb6d6028dec5d4220d10f546:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(7b59b89cbab9cc5b53c1e0028c0dc4d4fd0f9763)), TransactionOutput(4775 sats,pkh(916090fd01e98c36f7a4e7480b7d156bb3a54ff9))),UInt32Impl(0))))
+// unsignedTxF: Future[Transaction] = Future(Success(BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(220face5a1ea71dcb1117a0bf95eda38c7072a132dfdd0a1c0c9d2d121aa8227:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(e606d381a89cdad85828afbda3f4be70fb8eeffc)), TransactionOutput(4775 sats,pkh(44e65db5ee5102c7ef01990e0fddf1cea57700f6))),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(75686d19581d0e537269418e7ca9aef22db9f71bfb6d6028dec5d4220d10f546:0),10000 sats,ECPublicKey(030c82dd870b2491beddc9696be355a21e639b55a8e9bfd83c5a68e222528027b5)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(03dcdb81657636c4c1214f89bca9d53e167aa095))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1)))
+// utxoInfo: ScriptSignatureParams[P2PKHInputInfo] = ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(220face5a1ea71dcb1117a0bf95eda38c7072a132dfdd0a1c0c9d2d121aa8227:0),10000 sats,ECPublicKey(03e0f4d8e5c88682c405b1bd5f52450203ed1b7ceb6a5cc47a8e7fa526043f9c08)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(34e683bd89b2df667a60f02c3e45320511dc476f))),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(75686d19581d0e537269418e7ca9aef22db9f71bfb6d6028dec5d4220d10f546:0),10000 sats,ECPublicKey(030c82dd870b2491beddc9696be355a21e639b55a8e9bfd83c5a68e222528027b5)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(03dcdb81657636c4c1214f89bca9d53e167aa095))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1))))
+// utxoInfos: Vector[ScriptSignatureParams[InputInfo]] = Vector(ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(220face5a1ea71dcb1117a0bf95eda38c7072a132dfdd0a1c0c9d2d121aa8227:0),10000 sats,ECPublicKey(03e0f4d8e5c88682c405b1bd5f52450203ed1b7ceb6a5cc47a8e7fa526043f9c08)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(34e683bd89b2df667a60f02c3e45320511dc476f))),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(75686d19581d0e537269418e7ca9aef22db9f71bfb6d6028dec5d4220d10f546:0),P2PKHScriptSignature(ECPublicKey(030c82dd870b2491beddc9696be355a21e639b55a8e9bfd83c5a68e222528027b5), ECDigitalSignature(30440220761b54cdc1c7ea3a6f14d6f123c0527bccdd17f5683912d2aacea01b62e5fb56022002f8fe128d402eefce60a7155982df9f0274eb9af05be43d1881e9e9e262f2d801)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(7b59b89cbab9cc5b53c1e0028c0dc4d4fd0f9763)), TransactionOutput(4775 sats,pkh(916090fd01e98c36f7a4e7480b7d156bb3a54ff9))),UInt32Impl(0))
+// signedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(220face5a1ea71dcb1117a0bf95eda38c7072a132dfdd0a1c0c9d2d121aa8227:0),P2PKHScriptSignature(ECPublicKey(03e0f4d8e5c88682c405b1bd5f52450203ed1b7ceb6a5cc47a8e7fa526043f9c08), ECDigitalSignature(30440220611ce60fea677377ed6e13b185db77c184ef856d2aec4cf0593eb8a1648e5016022033058e0e7a936f4e083365f4ec6d6393e9fa95f74373239a6148cbd35cd30ecb01)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(e606d381a89cdad85828afbda3f4be70fb8eeffc)), TransactionOutput(4775 sats,pkh(44e65db5ee5102c7ef01990e0fddf1cea57700f6))),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 = 020000000146f5100d22d4c5de28606dfb1bf7b92df2aea97c8e416972530e1d58196d6875000000006a4730440220761b54cdc1c7ea3a6f14d6f123c0527bccdd17f5683912d2aacea01b62e5fb56022002f8fe128d402eefce60a7155982df9f0274eb9af05be43d1881e9e9e262f2d80121030c82dd870b2491beddc9696be355a21e639b55a8e9bfd83c5a68e222528027b5000000000288130000000000001976a9147b59b89cbab9cc5b53c1e0028c0dc4d4fd0f976388aca7120000000000001976a914916090fd01e98c36f7a4e7480b7d156bb3a54ff988ac00000000
+// res4: String = 02000000012782aa21d1d2c9c0a1d0fd2d132a07c738da5ef90b7a11b1dc71eaa1e5ac0f22000000006a4730440220611ce60fea677377ed6e13b185db77c184ef856d2aec4cf0593eb8a1648e5016022033058e0e7a936f4e083365f4ec6d6393e9fa95f74373239a6148cbd35cd30ecb012103e0f4d8e5c88682c405b1bd5f52450203ed1b7ceb6a5cc47a8e7fa526043f9c08000000000288130000000000001976a914e606d381a89cdad85828afbda3f4be70fb8eeffc88aca7120000000000001976a91444e65db5ee5102c7ef01990e0fddf1cea57700f688ac00000000