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@366c9159[Running, parallelism = 2, size = 2, active = 0, running = 0, steals = 33, tasks = 0, submissions = 0]
+// ec: ExecutionContext = scala.concurrent.impl.ExecutionContextImpl$$anon$3@335b95ab[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(02437b029e98f12062eaf7f90082f325844d0dcbbb495d2a8813020c43bb02157a)
+// pubKey: ECPublicKey = ECPublicKey(03059b3577fc40c02c48694b5e7976048628bda5bab2c21ed64d5f48eacaf5a0f6)
// 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(2fe0a10c12058692a69e2f97b94c62d59fbc4daa)
+// creditingSpk: P2PKHScriptPubKey = pkh(5e01a54407106cb484bf944c2ef4d13ebfde51f0)
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(2fe0a10c12058692a69e2f97b94c62d59fbc4daa))
+// utxo: TransactionOutput = TransactionOutput(10000 sats,pkh(5e01a54407106cb484bf944c2ef4d13ebfde51f0))
// 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(24e21b2d0a55515d16090b696549effe594a64d6)
+// destinationSPK: P2PKHScriptPubKey = pkh(4fef6941e7943e7ea18a582ef02d37a77402dc3a)
// 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(24e21b2d0a55515d16090b696549effe594a64d6)))
+// destinations: Vector[TransactionOutput] = Vector(TransactionOutput(5000 sats,pkh(4fef6941e7943e7ea18a582ef02d37a77402dc3a)))
// 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(2fe0a10c12058692a69e2f97b94c62d59fbc4daa))),UInt32Impl(0))
+// creditingTx: BaseTransaction = BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(5e01a54407106cb484bf944c2ef4d13ebfde51f0))),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(a6293dc519ecdbba26b0c26de754c9cb3677718e536459bc02b643f18560d993:0)
+// outPoint: TransactionOutPoint = TransactionOutPoint(eeec0a0d2e0701ecbc3c8cfa0ae3348031686d514f5aca2602b037191e340fd8:0)
val input = TransactionInput(
outPoint,
EmptyScriptSignature,
sequenceNumber = UInt32.zero)
-// input: TransactionInput = TransactionInputImpl(TransactionOutPoint(a6293dc519ecdbba26b0c26de754c9cb3677718e536459bc02b643f18560d993:0),EmptyScriptSignature,UInt32Impl(0))
+// input: TransactionInput = TransactionInputImpl(TransactionOutPoint(eeec0a0d2e0701ecbc3c8cfa0ae3348031686d514f5aca2602b037191e340fd8: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(a6293dc519ecdbba26b0c26de754c9cb3677718e536459bc02b643f18560d993:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(24e21b2d0a55515d16090b696549effe594a64d6))),UInt32Impl(0))
+// builderResult: RawTxBuilderResult = RawTxBuilderResult(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(eeec0a0d2e0701ecbc3c8cfa0ae3348031686d514f5aca2602b037191e340fd8:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(4fef6941e7943e7ea18a582ef02d37a77402dc3a))),UInt32Impl(0))
// this contains the information needed to analyze our input during finalization
val inputInfo = P2PKHInputInfo(outPoint, amount, privKey.publicKey)
-// inputInfo: P2PKHInputInfo = P2PKHInputInfo(TransactionOutPoint(a6293dc519ecdbba26b0c26de754c9cb3677718e536459bc02b643f18560d993:0),10000 sats,ECPublicKey(02437b029e98f12062eaf7f90082f325844d0dcbbb495d2a8813020c43bb02157a))
+// inputInfo: P2PKHInputInfo = P2PKHInputInfo(TransactionOutPoint(eeec0a0d2e0701ecbc3c8cfa0ae3348031686d514f5aca2602b037191e340fd8:0),10000 sats,ECPublicKey(03059b3577fc40c02c48694b5e7976048628bda5bab2c21ed64d5f48eacaf5a0f6))
// 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(16532349859a99882bcb698ba80d019a2ac5c9f2)
+// changeSPK: P2PKHScriptPubKey = pkh(11e6e637bdb8c68e658d4917ed110d76874a5727)
// 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(a6293dc519ecdbba26b0c26de754c9cb3677718e536459bc02b643f18560d993:0),10000 sats,ECPublicKey(02437b029e98f12062eaf7f90082f325844d0dcbbb495d2a8813020c43bb02157a))),1 sats/byte,pkh(16532349859a99882bcb698ba80d019a2ac5c9f2))
+// finalizer: StandardNonInteractiveFinalizer = StandardNonInteractiveFinalizer(Vector(P2PKHInputInfo(TransactionOutPoint(eeec0a0d2e0701ecbc3c8cfa0ae3348031686d514f5aca2602b037191e340fd8:0),10000 sats,ECPublicKey(03059b3577fc40c02c48694b5e7976048628bda5bab2c21ed64d5f48eacaf5a0f6))),1 sats/byte,pkh(11e6e637bdb8c68e658d4917ed110d76874a5727))
// 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(a6293dc519ecdbba26b0c26de754c9cb3677718e536459bc02b643f18560d993:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(24e21b2d0a55515d16090b696549effe594a64d6)), TransactionOutput(4775 sats,pkh(16532349859a99882bcb698ba80d019a2ac5c9f2))),UInt32Impl(0))))
+// unsignedTxF: Future[Transaction] = Future(Success(BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(eeec0a0d2e0701ecbc3c8cfa0ae3348031686d514f5aca2602b037191e340fd8:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(4fef6941e7943e7ea18a582ef02d37a77402dc3a)), TransactionOutput(4775 sats,pkh(11e6e637bdb8c68e658d4917ed110d76874a5727))),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(a6293dc519ecdbba26b0c26de754c9cb3677718e536459bc02b643f18560d993:0),10000 sats,ECPublicKey(02437b029e98f12062eaf7f90082f325844d0dcbbb495d2a8813020c43bb02157a)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(2fe0a10c12058692a69e2f97b94c62d59fbc4daa))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1)))
+// utxoInfo: ScriptSignatureParams[P2PKHInputInfo] = ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(eeec0a0d2e0701ecbc3c8cfa0ae3348031686d514f5aca2602b037191e340fd8:0),10000 sats,ECPublicKey(03059b3577fc40c02c48694b5e7976048628bda5bab2c21ed64d5f48eacaf5a0f6)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(5e01a54407106cb484bf944c2ef4d13ebfde51f0))),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(a6293dc519ecdbba26b0c26de754c9cb3677718e536459bc02b643f18560d993:0),10000 sats,ECPublicKey(02437b029e98f12062eaf7f90082f325844d0dcbbb495d2a8813020c43bb02157a)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(2fe0a10c12058692a69e2f97b94c62d59fbc4daa))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1))))
+// utxoInfos: Vector[ScriptSignatureParams[InputInfo]] = Vector(ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(eeec0a0d2e0701ecbc3c8cfa0ae3348031686d514f5aca2602b037191e340fd8:0),10000 sats,ECPublicKey(03059b3577fc40c02c48694b5e7976048628bda5bab2c21ed64d5f48eacaf5a0f6)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(5e01a54407106cb484bf944c2ef4d13ebfde51f0))),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(a6293dc519ecdbba26b0c26de754c9cb3677718e536459bc02b643f18560d993:0),P2PKHScriptSignature(ECPublicKey(02437b029e98f12062eaf7f90082f325844d0dcbbb495d2a8813020c43bb02157a), ECDigitalSignature(304402203fe05423ed671a1b21d8aeaaf791a1687845bfffbe621bd76fc5635925583b26022005a14392b627fe66b5ff3cdde4d59c13d5384a049111473c1079c3146197425401)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(24e21b2d0a55515d16090b696549effe594a64d6)), TransactionOutput(4775 sats,pkh(16532349859a99882bcb698ba80d019a2ac5c9f2))),UInt32Impl(0))
+// signedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(eeec0a0d2e0701ecbc3c8cfa0ae3348031686d514f5aca2602b037191e340fd8:0),P2PKHScriptSignature(ECPublicKey(03059b3577fc40c02c48694b5e7976048628bda5bab2c21ed64d5f48eacaf5a0f6), ECDigitalSignature(3044022063775621e05ff4c6df375e95995404f6f64dd0e1ddb6c7fc750834bd2612e8f802201b7e862046e015a4240155ca13915c8d148df2f62468d81cdd97c425b614d66501)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(4fef6941e7943e7ea18a582ef02d37a77402dc3a)), TransactionOutput(4775 sats,pkh(11e6e637bdb8c68e658d4917ed110d76874a5727))),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 = 020000000193d96085f143b602bc5964538e717736cbc954e76dc2b026badbec19c53d29a6000000006a47304402203fe05423ed671a1b21d8aeaaf791a1687845bfffbe621bd76fc5635925583b26022005a14392b627fe66b5ff3cdde4d59c13d5384a049111473c1079c31461974254012102437b029e98f12062eaf7f90082f325844d0dcbbb495d2a8813020c43bb02157a000000000288130000000000001976a91424e21b2d0a55515d16090b696549effe594a64d688aca7120000000000001976a91416532349859a99882bcb698ba80d019a2ac5c9f288ac00000000
+// res4: String = 0200000001d80f341e1937b00226ca5a4f516d68318034e30afa8c3cbcec01072e0d0aecee000000006a473044022063775621e05ff4c6df375e95995404f6f64dd0e1ddb6c7fc750834bd2612e8f802201b7e862046e015a4240155ca13915c8d148df2f62468d81cdd97c425b614d665012103059b3577fc40c02c48694b5e7976048628bda5bab2c21ed64d5f48eacaf5a0f6000000000288130000000000001976a9144fef6941e7943e7ea18a582ef02d37a77402dc3a88aca7120000000000001976a91411e6e637bdb8c68e658d4917ed110d76874a572788ac00000000