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@47b08fe5[Running, parallelism = 2, size = 2, active = 0, running = 0, steals = 37, tasks = 0, submissions = 0]
+// ec: ExecutionContext = scala.concurrent.impl.ExecutionContextImpl$$anon$3@656c86be[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(033575b51716813a8fa0756dbba7733239f6bd205ba94294fcaa7adfc67c35d6dd)
+// pubKey: ECPublicKey = ECPublicKey(02faf66a2bad0a166c979de6f1c3b50eab4fcbc26543dcea69c8e7952652e8c6d8)
// 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(50810b0433d1865663cd5d0b370ffd69509a258e)
+// creditingSpk: P2PKHScriptPubKey = pkh(f8975382b6e69784d15dad8c343f87183a7be89c)
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(50810b0433d1865663cd5d0b370ffd69509a258e))
+// utxo: TransactionOutput = TransactionOutput(10000 sats,pkh(f8975382b6e69784d15dad8c343f87183a7be89c))
// 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(809e2aa10bbc3f5c63907241a698a1c011381f2c)
+// destinationSPK: P2PKHScriptPubKey = pkh(d66d1b4fd7d05fb5bb77add69683535f3bece20d)
// 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(809e2aa10bbc3f5c63907241a698a1c011381f2c)))
+// destinations: Vector[TransactionOutput] = Vector(TransactionOutput(5000 sats,pkh(d66d1b4fd7d05fb5bb77add69683535f3bece20d)))
// 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(50810b0433d1865663cd5d0b370ffd69509a258e))),UInt32Impl(0))
+// creditingTx: BaseTransaction = BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(f8975382b6e69784d15dad8c343f87183a7be89c))),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(3beb5c10a2ba90e4477666cea488e0abc02cd89a4eac5d23f1db5ce8a998be31:0)
+// outPoint: TransactionOutPoint = TransactionOutPoint(b88e0022c3967c034ae2e3e0b9abd3a6256f16574f9139d5f24e1913c7ddf60c:0)
val input = TransactionInput(
outPoint,
EmptyScriptSignature,
sequenceNumber = UInt32.zero)
-// input: TransactionInput = TransactionInputImpl(TransactionOutPoint(3beb5c10a2ba90e4477666cea488e0abc02cd89a4eac5d23f1db5ce8a998be31:0),EmptyScriptSignature,UInt32Impl(0))
+// input: TransactionInput = TransactionInputImpl(TransactionOutPoint(b88e0022c3967c034ae2e3e0b9abd3a6256f16574f9139d5f24e1913c7ddf60c: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(3beb5c10a2ba90e4477666cea488e0abc02cd89a4eac5d23f1db5ce8a998be31:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(809e2aa10bbc3f5c63907241a698a1c011381f2c))),UInt32Impl(0))
+// builderResult: RawTxBuilderResult = RawTxBuilderResult(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(b88e0022c3967c034ae2e3e0b9abd3a6256f16574f9139d5f24e1913c7ddf60c:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(d66d1b4fd7d05fb5bb77add69683535f3bece20d))),UInt32Impl(0))
// this contains the information needed to analyze our input during finalization
val inputInfo = P2PKHInputInfo(outPoint, amount, privKey.publicKey)
-// inputInfo: P2PKHInputInfo = P2PKHInputInfo(TransactionOutPoint(3beb5c10a2ba90e4477666cea488e0abc02cd89a4eac5d23f1db5ce8a998be31:0),10000 sats,ECPublicKey(033575b51716813a8fa0756dbba7733239f6bd205ba94294fcaa7adfc67c35d6dd))
+// inputInfo: P2PKHInputInfo = P2PKHInputInfo(TransactionOutPoint(b88e0022c3967c034ae2e3e0b9abd3a6256f16574f9139d5f24e1913c7ddf60c:0),10000 sats,ECPublicKey(02faf66a2bad0a166c979de6f1c3b50eab4fcbc26543dcea69c8e7952652e8c6d8))
// 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(29c1c638551f8dea872facccb8e9bd6575227ec4)
+// changeSPK: P2PKHScriptPubKey = pkh(6a311ae18a8509bdec30a2bb394cdc24851724cc)
// 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(3beb5c10a2ba90e4477666cea488e0abc02cd89a4eac5d23f1db5ce8a998be31:0),10000 sats,ECPublicKey(033575b51716813a8fa0756dbba7733239f6bd205ba94294fcaa7adfc67c35d6dd))),1 sats/byte,pkh(29c1c638551f8dea872facccb8e9bd6575227ec4))
+// finalizer: StandardNonInteractiveFinalizer = StandardNonInteractiveFinalizer(Vector(P2PKHInputInfo(TransactionOutPoint(b88e0022c3967c034ae2e3e0b9abd3a6256f16574f9139d5f24e1913c7ddf60c:0),10000 sats,ECPublicKey(02faf66a2bad0a166c979de6f1c3b50eab4fcbc26543dcea69c8e7952652e8c6d8))),1 sats/byte,pkh(6a311ae18a8509bdec30a2bb394cdc24851724cc))
// 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(3beb5c10a2ba90e4477666cea488e0abc02cd89a4eac5d23f1db5ce8a998be31:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(809e2aa10bbc3f5c63907241a698a1c011381f2c)), TransactionOutput(4775 sats,pkh(29c1c638551f8dea872facccb8e9bd6575227ec4))),UInt32Impl(0))))
+// unsignedTxF: Future[Transaction] = Future(Success(BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(b88e0022c3967c034ae2e3e0b9abd3a6256f16574f9139d5f24e1913c7ddf60c:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(d66d1b4fd7d05fb5bb77add69683535f3bece20d)), TransactionOutput(4775 sats,pkh(6a311ae18a8509bdec30a2bb394cdc24851724cc))),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(3beb5c10a2ba90e4477666cea488e0abc02cd89a4eac5d23f1db5ce8a998be31:0),10000 sats,ECPublicKey(033575b51716813a8fa0756dbba7733239f6bd205ba94294fcaa7adfc67c35d6dd)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(50810b0433d1865663cd5d0b370ffd69509a258e))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1)))
+// utxoInfo: ScriptSignatureParams[P2PKHInputInfo] = ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(b88e0022c3967c034ae2e3e0b9abd3a6256f16574f9139d5f24e1913c7ddf60c:0),10000 sats,ECPublicKey(02faf66a2bad0a166c979de6f1c3b50eab4fcbc26543dcea69c8e7952652e8c6d8)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(f8975382b6e69784d15dad8c343f87183a7be89c))),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(3beb5c10a2ba90e4477666cea488e0abc02cd89a4eac5d23f1db5ce8a998be31:0),10000 sats,ECPublicKey(033575b51716813a8fa0756dbba7733239f6bd205ba94294fcaa7adfc67c35d6dd)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(50810b0433d1865663cd5d0b370ffd69509a258e))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1))))
+// utxoInfos: Vector[ScriptSignatureParams[InputInfo]] = Vector(ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(b88e0022c3967c034ae2e3e0b9abd3a6256f16574f9139d5f24e1913c7ddf60c:0),10000 sats,ECPublicKey(02faf66a2bad0a166c979de6f1c3b50eab4fcbc26543dcea69c8e7952652e8c6d8)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(f8975382b6e69784d15dad8c343f87183a7be89c))),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(3beb5c10a2ba90e4477666cea488e0abc02cd89a4eac5d23f1db5ce8a998be31:0),P2PKHScriptSignature(ECPublicKey(033575b51716813a8fa0756dbba7733239f6bd205ba94294fcaa7adfc67c35d6dd), ECDigitalSignature(3044022057f66c771984cecf26cecd2cacba62b7c9d4ec35d6466135d8dbb4d06f71b03a02204e871e3a11e37c1ec12bd6f30ed7e7102a3824402d3ea58ebe404d4669541ded01)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(809e2aa10bbc3f5c63907241a698a1c011381f2c)), TransactionOutput(4775 sats,pkh(29c1c638551f8dea872facccb8e9bd6575227ec4))),UInt32Impl(0))
+// signedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(b88e0022c3967c034ae2e3e0b9abd3a6256f16574f9139d5f24e1913c7ddf60c:0),P2PKHScriptSignature(ECPublicKey(02faf66a2bad0a166c979de6f1c3b50eab4fcbc26543dcea69c8e7952652e8c6d8), ECDigitalSignature(3044022010c4daa7e3d35d313e42213a7e6f6125fa82dab6495b9acaa0984410fac58f2a022073a1f98205719f84da9e44f01f3dcbebb74bb90ae8a18e97a109571cb938ab4a01)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(d66d1b4fd7d05fb5bb77add69683535f3bece20d)), TransactionOutput(4775 sats,pkh(6a311ae18a8509bdec30a2bb394cdc24851724cc))),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 = 020000000131be98a9e85cdbf1235dac4e9ad82cc0abe088a4ce667647e490baa2105ceb3b000000006a473044022057f66c771984cecf26cecd2cacba62b7c9d4ec35d6466135d8dbb4d06f71b03a02204e871e3a11e37c1ec12bd6f30ed7e7102a3824402d3ea58ebe404d4669541ded0121033575b51716813a8fa0756dbba7733239f6bd205ba94294fcaa7adfc67c35d6dd000000000288130000000000001976a914809e2aa10bbc3f5c63907241a698a1c011381f2c88aca7120000000000001976a91429c1c638551f8dea872facccb8e9bd6575227ec488ac00000000
+// res4: String = 02000000010cf6ddc713194ef2d539914f57166f25a6d3abb9e0e3e24a037c96c322008eb8000000006a473044022010c4daa7e3d35d313e42213a7e6f6125fa82dab6495b9acaa0984410fac58f2a022073a1f98205719f84da9e44f01f3dcbebb74bb90ae8a18e97a109571cb938ab4a012102faf66a2bad0a166c979de6f1c3b50eab4fcbc26543dcea69c8e7952652e8c6d8000000000288130000000000001976a914d66d1b4fd7d05fb5bb77add69683535f3bece20d88aca7120000000000001976a9146a311ae18a8509bdec30a2bb394cdc24851724cc88ac00000000