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@4f7104fd[Running, parallelism = 2, size = 2, active = 0, running = 0, steals = 3, tasks = 0, submissions = 0]
+// ec: ExecutionContext = scala.concurrent.impl.ExecutionContextImpl$$anon$3@686ffec4[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(03d7715680672d324441f5ee6bc6f757869a0881d5acc67dc3a8467d461f473cf2)
+// pubKey: ECPublicKey = ECPublicKey(03b846b1ded9755cdec752edb7746940945f11e92a59358b2e7a0abf844ec4cc4a)
// 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(ef9c2f53098571dad2d9722974ca3c55e4b569ef)
+// creditingSpk: P2PKHScriptPubKey = pkh(978d844e541451a3583ecb73f7572873cce8ce41)
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(ef9c2f53098571dad2d9722974ca3c55e4b569ef))
+// utxo: TransactionOutput = TransactionOutput(10000 sats,pkh(978d844e541451a3583ecb73f7572873cce8ce41))
// 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(49e1cf01cbd2bf709099ee9628caa6f66b654106)
+// destinationSPK: P2PKHScriptPubKey = pkh(816dcf402974c905e65eec5df492ea5a3aeacf51)
// 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(49e1cf01cbd2bf709099ee9628caa6f66b654106)))
+// destinations: Vector[TransactionOutput] = Vector(TransactionOutput(5000 sats,pkh(816dcf402974c905e65eec5df492ea5a3aeacf51)))
// 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(ef9c2f53098571dad2d9722974ca3c55e4b569ef))),UInt32Impl(0))
+// creditingTx: BaseTransaction = BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(978d844e541451a3583ecb73f7572873cce8ce41))),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(b6346af7e01501346b02c65a8d4b5c93509f26827b409182e464b6cf9c512e90:0)
+// outPoint: TransactionOutPoint = TransactionOutPoint(ce790c688a49b6630f9dc5a75282d237597d920c132b2577452f0d0b6c044226:0)
val input = TransactionInput(
outPoint,
EmptyScriptSignature,
sequenceNumber = UInt32.zero)
-// input: TransactionInput = TransactionInputImpl(TransactionOutPoint(b6346af7e01501346b02c65a8d4b5c93509f26827b409182e464b6cf9c512e90:0),EmptyScriptSignature,UInt32Impl(0))
+// input: TransactionInput = TransactionInputImpl(TransactionOutPoint(ce790c688a49b6630f9dc5a75282d237597d920c132b2577452f0d0b6c044226: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(b6346af7e01501346b02c65a8d4b5c93509f26827b409182e464b6cf9c512e90:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(49e1cf01cbd2bf709099ee9628caa6f66b654106))),UInt32Impl(0))
+// builderResult: RawTxBuilderResult = RawTxBuilderResult(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(ce790c688a49b6630f9dc5a75282d237597d920c132b2577452f0d0b6c044226:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(816dcf402974c905e65eec5df492ea5a3aeacf51))),UInt32Impl(0))
// this contains the information needed to analyze our input during finalization
val inputInfo = P2PKHInputInfo(outPoint, amount, privKey.publicKey)
-// inputInfo: P2PKHInputInfo = P2PKHInputInfo(TransactionOutPoint(b6346af7e01501346b02c65a8d4b5c93509f26827b409182e464b6cf9c512e90:0),10000 sats,ECPublicKey(03d7715680672d324441f5ee6bc6f757869a0881d5acc67dc3a8467d461f473cf2))
+// inputInfo: P2PKHInputInfo = P2PKHInputInfo(TransactionOutPoint(ce790c688a49b6630f9dc5a75282d237597d920c132b2577452f0d0b6c044226:0),10000 sats,ECPublicKey(03b846b1ded9755cdec752edb7746940945f11e92a59358b2e7a0abf844ec4cc4a))
// 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(247399d5eddfc4dfaee663e0bc44041553860802)
+// changeSPK: P2PKHScriptPubKey = pkh(c5a2f707903ffa2c379b2b945bc6c2ec3b404c86)
// 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(b6346af7e01501346b02c65a8d4b5c93509f26827b409182e464b6cf9c512e90:0),10000 sats,ECPublicKey(03d7715680672d324441f5ee6bc6f757869a0881d5acc67dc3a8467d461f473cf2))),SatoshisPerByte(1 sat),pkh(247399d5eddfc4dfaee663e0bc44041553860802))
+// finalizer: StandardNonInteractiveFinalizer = StandardNonInteractiveFinalizer(Vector(P2PKHInputInfo(TransactionOutPoint(ce790c688a49b6630f9dc5a75282d237597d920c132b2577452f0d0b6c044226:0),10000 sats,ECPublicKey(03b846b1ded9755cdec752edb7746940945f11e92a59358b2e7a0abf844ec4cc4a))),SatoshisPerByte(1 sat),pkh(c5a2f707903ffa2c379b2b945bc6c2ec3b404c86))
// 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(b6346af7e01501346b02c65a8d4b5c93509f26827b409182e464b6cf9c512e90:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(49e1cf01cbd2bf709099ee9628caa6f66b654106)), TransactionOutput(4775 sats,pkh(247399d5eddfc4dfaee663e0bc44041553860802))),UInt32Impl(0))))
+// unsignedTxF: Future[Transaction] = Future(Success(BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(ce790c688a49b6630f9dc5a75282d237597d920c132b2577452f0d0b6c044226:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(816dcf402974c905e65eec5df492ea5a3aeacf51)), TransactionOutput(4775 sats,pkh(c5a2f707903ffa2c379b2b945bc6c2ec3b404c86))),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(b6346af7e01501346b02c65a8d4b5c93509f26827b409182e464b6cf9c512e90:0),10000 sats,ECPublicKey(03d7715680672d324441f5ee6bc6f757869a0881d5acc67dc3a8467d461f473cf2)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(ef9c2f53098571dad2d9722974ca3c55e4b569ef))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1)))
+// utxoInfo: ScriptSignatureParams[P2PKHInputInfo] = ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(ce790c688a49b6630f9dc5a75282d237597d920c132b2577452f0d0b6c044226:0),10000 sats,ECPublicKey(03b846b1ded9755cdec752edb7746940945f11e92a59358b2e7a0abf844ec4cc4a)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(978d844e541451a3583ecb73f7572873cce8ce41))),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(b6346af7e01501346b02c65a8d4b5c93509f26827b409182e464b6cf9c512e90:0),10000 sats,ECPublicKey(03d7715680672d324441f5ee6bc6f757869a0881d5acc67dc3a8467d461f473cf2)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(ef9c2f53098571dad2d9722974ca3c55e4b569ef))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1))))
+// utxoInfos: Vector[ScriptSignatureParams[InputInfo]] = Vector(ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(ce790c688a49b6630f9dc5a75282d237597d920c132b2577452f0d0b6c044226:0),10000 sats,ECPublicKey(03b846b1ded9755cdec752edb7746940945f11e92a59358b2e7a0abf844ec4cc4a)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(978d844e541451a3583ecb73f7572873cce8ce41))),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(b6346af7e01501346b02c65a8d4b5c93509f26827b409182e464b6cf9c512e90:0),P2PKHScriptSignature(ECPublicKey(03d7715680672d324441f5ee6bc6f757869a0881d5acc67dc3a8467d461f473cf2), ECDigitalSignature(304402201a766a56ebd5ca3e88a4a6ce384ee8e4f57675bd986f04eeb7bb099a3545e74e02204c5190c8f188c83a8676a729fa623a69a90ff50b2e7ee01e5478f4f3373b0d5701)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(49e1cf01cbd2bf709099ee9628caa6f66b654106)), TransactionOutput(4775 sats,pkh(247399d5eddfc4dfaee663e0bc44041553860802))),UInt32Impl(0))
+// signedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(ce790c688a49b6630f9dc5a75282d237597d920c132b2577452f0d0b6c044226:0),P2PKHScriptSignature(ECPublicKey(03b846b1ded9755cdec752edb7746940945f11e92a59358b2e7a0abf844ec4cc4a), ECDigitalSignature(3044022027a3ebf75435b53bf18ad9c3323278f92439853dbf7f359a0c9b6532a475645e02200199f717c5455a7f79b27f52aa7043d13e08ad5b8ae0960f1a8b889859cd289001)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(816dcf402974c905e65eec5df492ea5a3aeacf51)), TransactionOutput(4775 sats,pkh(c5a2f707903ffa2c379b2b945bc6c2ec3b404c86))),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 = 0200000001902e519ccfb664e48291407b82269f50935c4b8d5ac6026b340115e0f76a34b6000000006a47304402201a766a56ebd5ca3e88a4a6ce384ee8e4f57675bd986f04eeb7bb099a3545e74e02204c5190c8f188c83a8676a729fa623a69a90ff50b2e7ee01e5478f4f3373b0d57012103d7715680672d324441f5ee6bc6f757869a0881d5acc67dc3a8467d461f473cf2000000000288130000000000001976a91449e1cf01cbd2bf709099ee9628caa6f66b65410688aca7120000000000001976a914247399d5eddfc4dfaee663e0bc4404155386080288ac00000000
+// res4: String = 02000000012642046c0b0d2f4577252b130c927d5937d28252a7c59d0f63b6498a680c79ce000000006a473044022027a3ebf75435b53bf18ad9c3323278f92439853dbf7f359a0c9b6532a475645e02200199f717c5455a7f79b27f52aa7043d13e08ad5b8ae0960f1a8b889859cd2890012103b846b1ded9755cdec752edb7746940945f11e92a59358b2e7a0abf844ec4cc4a000000000288130000000000001976a914816dcf402974c905e65eec5df492ea5a3aeacf5188aca7120000000000001976a914c5a2f707903ffa2c379b2b945bc6c2ec3b404c8688ac00000000