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@1bac7ff2[Running, parallelism = 2, size = 2, active = 0, running = 0, steals = 37, tasks = 0, submissions = 0]
+// ec: ExecutionContext = scala.concurrent.impl.ExecutionContextImpl$$anon$3@605a3780[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(03695ffbfaf3f0ccaee3501b83079dbf242bf36ce5f48ed89848c70a79c3351112)
+// pubKey: ECPublicKey = ECPublicKey(0382a4892670d9a49833b18950e1dab196daef2646890fed4c5182ca1fc026bc2c)
// 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(a7d7ebdfab01435415420ed2d12ad2326c6b97a3)
+// creditingSpk: P2PKHScriptPubKey = pkh(69c1842bd3f0ed9444852953aad0b391b5c6bcaf)
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(a7d7ebdfab01435415420ed2d12ad2326c6b97a3))
+// utxo: TransactionOutput = TransactionOutput(10000 sats,pkh(69c1842bd3f0ed9444852953aad0b391b5c6bcaf))
// 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(0846ceb6f263a8db1f9ceb7901d58b3bef92fce4)
+// destinationSPK: P2PKHScriptPubKey = pkh(71fb7a02ae115415576429ca359698521acc8ba6)
// 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(0846ceb6f263a8db1f9ceb7901d58b3bef92fce4)))
+// destinations: Vector[TransactionOutput] = Vector(TransactionOutput(5000 sats,pkh(71fb7a02ae115415576429ca359698521acc8ba6)))
// 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(a7d7ebdfab01435415420ed2d12ad2326c6b97a3))),UInt32Impl(0))
+// creditingTx: BaseTransaction = BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(69c1842bd3f0ed9444852953aad0b391b5c6bcaf))),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(cfd8aa17130951c5aa82ac1d148aeb89e4bce4f06f1b2a34bc9f38fc765e62cf:0)
+// outPoint: TransactionOutPoint = TransactionOutPoint(6010d8a37dcdefe2f070512e9d4a378e531379d515ebdfe68c6b7c198943c2d9:0)
val input = TransactionInput(
outPoint,
EmptyScriptSignature,
sequenceNumber = UInt32.zero)
-// input: TransactionInput = TransactionInputImpl(TransactionOutPoint(cfd8aa17130951c5aa82ac1d148aeb89e4bce4f06f1b2a34bc9f38fc765e62cf:0),EmptyScriptSignature,UInt32Impl(0))
+// input: TransactionInput = TransactionInputImpl(TransactionOutPoint(6010d8a37dcdefe2f070512e9d4a378e531379d515ebdfe68c6b7c198943c2d9: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(cfd8aa17130951c5aa82ac1d148aeb89e4bce4f06f1b2a34bc9f38fc765e62cf:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(0846ceb6f263a8db1f9ceb7901d58b3bef92fce4))),UInt32Impl(0))
+// builderResult: RawTxBuilderResult = RawTxBuilderResult(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(6010d8a37dcdefe2f070512e9d4a378e531379d515ebdfe68c6b7c198943c2d9:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(71fb7a02ae115415576429ca359698521acc8ba6))),UInt32Impl(0))
// this contains the information needed to analyze our input during finalization
val inputInfo = P2PKHInputInfo(outPoint, amount, privKey.publicKey)
-// inputInfo: P2PKHInputInfo = P2PKHInputInfo(TransactionOutPoint(cfd8aa17130951c5aa82ac1d148aeb89e4bce4f06f1b2a34bc9f38fc765e62cf:0),10000 sats,ECPublicKey(03695ffbfaf3f0ccaee3501b83079dbf242bf36ce5f48ed89848c70a79c3351112))
+// inputInfo: P2PKHInputInfo = P2PKHInputInfo(TransactionOutPoint(6010d8a37dcdefe2f070512e9d4a378e531379d515ebdfe68c6b7c198943c2d9:0),10000 sats,ECPublicKey(0382a4892670d9a49833b18950e1dab196daef2646890fed4c5182ca1fc026bc2c))
// 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(5951d4784b4f8cfea2de84c38972d163b8d969e6)
+// changeSPK: P2PKHScriptPubKey = pkh(cbc3f5334b42c8508b250accb54ef0306b8a2ff4)
// 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(cfd8aa17130951c5aa82ac1d148aeb89e4bce4f06f1b2a34bc9f38fc765e62cf:0),10000 sats,ECPublicKey(03695ffbfaf3f0ccaee3501b83079dbf242bf36ce5f48ed89848c70a79c3351112))),1 sats/byte,pkh(5951d4784b4f8cfea2de84c38972d163b8d969e6))
+// finalizer: StandardNonInteractiveFinalizer = StandardNonInteractiveFinalizer(Vector(P2PKHInputInfo(TransactionOutPoint(6010d8a37dcdefe2f070512e9d4a378e531379d515ebdfe68c6b7c198943c2d9:0),10000 sats,ECPublicKey(0382a4892670d9a49833b18950e1dab196daef2646890fed4c5182ca1fc026bc2c))),1 sats/byte,pkh(cbc3f5334b42c8508b250accb54ef0306b8a2ff4))
// 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(cfd8aa17130951c5aa82ac1d148aeb89e4bce4f06f1b2a34bc9f38fc765e62cf:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(0846ceb6f263a8db1f9ceb7901d58b3bef92fce4)), TransactionOutput(4775 sats,pkh(5951d4784b4f8cfea2de84c38972d163b8d969e6))),UInt32Impl(0))))
+// unsignedTxF: Future[Transaction] = Future(Success(BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(6010d8a37dcdefe2f070512e9d4a378e531379d515ebdfe68c6b7c198943c2d9:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(71fb7a02ae115415576429ca359698521acc8ba6)), TransactionOutput(4775 sats,pkh(cbc3f5334b42c8508b250accb54ef0306b8a2ff4))),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(cfd8aa17130951c5aa82ac1d148aeb89e4bce4f06f1b2a34bc9f38fc765e62cf:0),10000 sats,ECPublicKey(03695ffbfaf3f0ccaee3501b83079dbf242bf36ce5f48ed89848c70a79c3351112)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(a7d7ebdfab01435415420ed2d12ad2326c6b97a3))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1)))
+// utxoInfo: ScriptSignatureParams[P2PKHInputInfo] = ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(6010d8a37dcdefe2f070512e9d4a378e531379d515ebdfe68c6b7c198943c2d9:0),10000 sats,ECPublicKey(0382a4892670d9a49833b18950e1dab196daef2646890fed4c5182ca1fc026bc2c)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(69c1842bd3f0ed9444852953aad0b391b5c6bcaf))),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(cfd8aa17130951c5aa82ac1d148aeb89e4bce4f06f1b2a34bc9f38fc765e62cf:0),10000 sats,ECPublicKey(03695ffbfaf3f0ccaee3501b83079dbf242bf36ce5f48ed89848c70a79c3351112)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(a7d7ebdfab01435415420ed2d12ad2326c6b97a3))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1))))
+// utxoInfos: Vector[ScriptSignatureParams[InputInfo]] = Vector(ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(6010d8a37dcdefe2f070512e9d4a378e531379d515ebdfe68c6b7c198943c2d9:0),10000 sats,ECPublicKey(0382a4892670d9a49833b18950e1dab196daef2646890fed4c5182ca1fc026bc2c)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(69c1842bd3f0ed9444852953aad0b391b5c6bcaf))),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(cfd8aa17130951c5aa82ac1d148aeb89e4bce4f06f1b2a34bc9f38fc765e62cf:0),P2PKHScriptSignature(ECPublicKey(03695ffbfaf3f0ccaee3501b83079dbf242bf36ce5f48ed89848c70a79c3351112), ECDigitalSignature(3044022054e75d0e7c3f257e4a6dce4795e4197145f93126506c08e5851460ed37fdc82f02200d6d65298f5ccaeedd970941246001686b6374b9c39ef1bc854117a3325c6d9301)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(0846ceb6f263a8db1f9ceb7901d58b3bef92fce4)), TransactionOutput(4775 sats,pkh(5951d4784b4f8cfea2de84c38972d163b8d969e6))),UInt32Impl(0))
+// signedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(6010d8a37dcdefe2f070512e9d4a378e531379d515ebdfe68c6b7c198943c2d9:0),P2PKHScriptSignature(ECPublicKey(0382a4892670d9a49833b18950e1dab196daef2646890fed4c5182ca1fc026bc2c), ECDigitalSignature(304402206c059850bfcd63908d329246b72faa314b76de4189dac8b260a86e6c5e1a7b37022055371ff05a2fd219ef6d10360847f1a51f019b6c28156951413226adc702135801)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(71fb7a02ae115415576429ca359698521acc8ba6)), TransactionOutput(4775 sats,pkh(cbc3f5334b42c8508b250accb54ef0306b8a2ff4))),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 = 0200000001cf625e76fc389fbc342a1b6ff0e4bce489eb8a141dac82aac551091317aad8cf000000006a473044022054e75d0e7c3f257e4a6dce4795e4197145f93126506c08e5851460ed37fdc82f02200d6d65298f5ccaeedd970941246001686b6374b9c39ef1bc854117a3325c6d93012103695ffbfaf3f0ccaee3501b83079dbf242bf36ce5f48ed89848c70a79c3351112000000000288130000000000001976a9140846ceb6f263a8db1f9ceb7901d58b3bef92fce488aca7120000000000001976a9145951d4784b4f8cfea2de84c38972d163b8d969e688ac00000000
+// res4: String = 0200000001d9c24389197c6b8ce6dfeb15d57913538e374a9d2e5170f0e2efcd7da3d81060000000006a47304402206c059850bfcd63908d329246b72faa314b76de4189dac8b260a86e6c5e1a7b37022055371ff05a2fd219ef6d10360847f1a51f019b6c28156951413226adc702135801210382a4892670d9a49833b18950e1dab196daef2646890fed4c5182ca1fc026bc2c000000000288130000000000001976a91471fb7a02ae115415576429ca359698521acc8ba688aca7120000000000001976a914cbc3f5334b42c8508b250accb54ef0306b8a2ff488ac00000000