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@4ab0927[Running, parallelism = 2, size = 2, active = 0, running = 0, steals = 35, tasks = 0, submissions = 0]
+// ec: ExecutionContext = scala.concurrent.impl.ExecutionContextImpl$$anon$3@70ea8e41[Running, parallelism = 2, size = 2, active = 0, running = 0, steals = 35, 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(032c723fc67f1f441c23e6776b25503382711b7441c2ee047c6bf4afa7b2c1aa25)
+// pubKey: ECPublicKey = ECPublicKey(03c9697b247639f45daa2dbea0d47c0fd879ccec086eb9764cc12c60fc9df7182d)
// 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(d5b22e43eee3b5cf5bba48e557559562ff8dd2e5)
+// creditingSpk: P2PKHScriptPubKey = pkh(bc5b4be0e2b78fc9c777cc67833991dc89d343d0)
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(d5b22e43eee3b5cf5bba48e557559562ff8dd2e5))
+// utxo: TransactionOutput = TransactionOutput(10000 sats,pkh(bc5b4be0e2b78fc9c777cc67833991dc89d343d0))
// 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(de173b06cce21e169cb21d44f6a541734d2559a5)
+// destinationSPK: P2PKHScriptPubKey = pkh(a2b562da2c6df3528cb66dd64d3a4d0a34c2b8ff)
// 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(de173b06cce21e169cb21d44f6a541734d2559a5)))
+// destinations: Vector[TransactionOutput] = Vector(TransactionOutput(5000 sats,pkh(a2b562da2c6df3528cb66dd64d3a4d0a34c2b8ff)))
// 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(d5b22e43eee3b5cf5bba48e557559562ff8dd2e5))),UInt32Impl(0))
+// creditingTx: BaseTransaction = BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(bc5b4be0e2b78fc9c777cc67833991dc89d343d0))),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(a20168c2dce7333a9c5f779a859a84df160012e383b2d3274ef464a84c9c8112:0)
+// outPoint: TransactionOutPoint = TransactionOutPoint(e12ca9e9fd870be7d14afa4c9a2cfc3a0933aa636cf3ae3fbb45752c659c12c3:0)
val input = TransactionInput(
outPoint,
EmptyScriptSignature,
sequenceNumber = UInt32.zero)
-// input: TransactionInput = TransactionInputImpl(TransactionOutPoint(a20168c2dce7333a9c5f779a859a84df160012e383b2d3274ef464a84c9c8112:0),EmptyScriptSignature,UInt32Impl(0))
+// input: TransactionInput = TransactionInputImpl(TransactionOutPoint(e12ca9e9fd870be7d14afa4c9a2cfc3a0933aa636cf3ae3fbb45752c659c12c3: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(a20168c2dce7333a9c5f779a859a84df160012e383b2d3274ef464a84c9c8112:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(de173b06cce21e169cb21d44f6a541734d2559a5))),UInt32Impl(0))
+// builderResult: RawTxBuilderResult = RawTxBuilderResult(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(e12ca9e9fd870be7d14afa4c9a2cfc3a0933aa636cf3ae3fbb45752c659c12c3:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(a2b562da2c6df3528cb66dd64d3a4d0a34c2b8ff))),UInt32Impl(0))
// this contains the information needed to analyze our input during finalization
val inputInfo = P2PKHInputInfo(outPoint, amount, privKey.publicKey)
-// inputInfo: P2PKHInputInfo = P2PKHInputInfo(TransactionOutPoint(a20168c2dce7333a9c5f779a859a84df160012e383b2d3274ef464a84c9c8112:0),10000 sats,ECPublicKey(032c723fc67f1f441c23e6776b25503382711b7441c2ee047c6bf4afa7b2c1aa25))
+// inputInfo: P2PKHInputInfo = P2PKHInputInfo(TransactionOutPoint(e12ca9e9fd870be7d14afa4c9a2cfc3a0933aa636cf3ae3fbb45752c659c12c3:0),10000 sats,ECPublicKey(03c9697b247639f45daa2dbea0d47c0fd879ccec086eb9764cc12c60fc9df7182d))
// 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(50460fb74f026b4203dae6b94d06d05db8457101)
+// changeSPK: P2PKHScriptPubKey = pkh(5c5963adf08642f83ae9aa615ff730cab59a8b6c)
// 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(a20168c2dce7333a9c5f779a859a84df160012e383b2d3274ef464a84c9c8112:0),10000 sats,ECPublicKey(032c723fc67f1f441c23e6776b25503382711b7441c2ee047c6bf4afa7b2c1aa25))),1 sats/byte,pkh(50460fb74f026b4203dae6b94d06d05db8457101))
+// finalizer: StandardNonInteractiveFinalizer = StandardNonInteractiveFinalizer(Vector(P2PKHInputInfo(TransactionOutPoint(e12ca9e9fd870be7d14afa4c9a2cfc3a0933aa636cf3ae3fbb45752c659c12c3:0),10000 sats,ECPublicKey(03c9697b247639f45daa2dbea0d47c0fd879ccec086eb9764cc12c60fc9df7182d))),1 sats/byte,pkh(5c5963adf08642f83ae9aa615ff730cab59a8b6c))
// 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(a20168c2dce7333a9c5f779a859a84df160012e383b2d3274ef464a84c9c8112:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(de173b06cce21e169cb21d44f6a541734d2559a5)), TransactionOutput(4775 sats,pkh(50460fb74f026b4203dae6b94d06d05db8457101))),UInt32Impl(0))))
+// unsignedTxF: Future[Transaction] = Future(Success(BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(e12ca9e9fd870be7d14afa4c9a2cfc3a0933aa636cf3ae3fbb45752c659c12c3:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(a2b562da2c6df3528cb66dd64d3a4d0a34c2b8ff)), TransactionOutput(4775 sats,pkh(5c5963adf08642f83ae9aa615ff730cab59a8b6c))),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(a20168c2dce7333a9c5f779a859a84df160012e383b2d3274ef464a84c9c8112:0),10000 sats,ECPublicKey(032c723fc67f1f441c23e6776b25503382711b7441c2ee047c6bf4afa7b2c1aa25)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(d5b22e43eee3b5cf5bba48e557559562ff8dd2e5))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1)))
+// utxoInfo: ScriptSignatureParams[P2PKHInputInfo] = ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(e12ca9e9fd870be7d14afa4c9a2cfc3a0933aa636cf3ae3fbb45752c659c12c3:0),10000 sats,ECPublicKey(03c9697b247639f45daa2dbea0d47c0fd879ccec086eb9764cc12c60fc9df7182d)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(bc5b4be0e2b78fc9c777cc67833991dc89d343d0))),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(a20168c2dce7333a9c5f779a859a84df160012e383b2d3274ef464a84c9c8112:0),10000 sats,ECPublicKey(032c723fc67f1f441c23e6776b25503382711b7441c2ee047c6bf4afa7b2c1aa25)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(d5b22e43eee3b5cf5bba48e557559562ff8dd2e5))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1))))
+// utxoInfos: Vector[ScriptSignatureParams[InputInfo]] = Vector(ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(e12ca9e9fd870be7d14afa4c9a2cfc3a0933aa636cf3ae3fbb45752c659c12c3:0),10000 sats,ECPublicKey(03c9697b247639f45daa2dbea0d47c0fd879ccec086eb9764cc12c60fc9df7182d)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(bc5b4be0e2b78fc9c777cc67833991dc89d343d0))),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(a20168c2dce7333a9c5f779a859a84df160012e383b2d3274ef464a84c9c8112:0),P2PKHScriptSignature(ECPublicKey(032c723fc67f1f441c23e6776b25503382711b7441c2ee047c6bf4afa7b2c1aa25), ECDigitalSignature(30440220472d91a19685aa48fbd4109097fe2d2e10f38e8454867e9df5d5bb7361f0321102207090e9baa5c9e23b757035ff320db2572fba2a78cad1da7d9639df56d53d103b01)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(de173b06cce21e169cb21d44f6a541734d2559a5)), TransactionOutput(4775 sats,pkh(50460fb74f026b4203dae6b94d06d05db8457101))),UInt32Impl(0))
+// signedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(e12ca9e9fd870be7d14afa4c9a2cfc3a0933aa636cf3ae3fbb45752c659c12c3:0),P2PKHScriptSignature(ECPublicKey(03c9697b247639f45daa2dbea0d47c0fd879ccec086eb9764cc12c60fc9df7182d), ECDigitalSignature(30440220104b89194874f8dab1f44d92faa4217f5a1304c0c3bf342032096ebc4428ed9b022070a2d4ab24c68fe8962f9a6d19ea28964ed45a5b2c77870b244f01b8343ae8d301)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(a2b562da2c6df3528cb66dd64d3a4d0a34c2b8ff)), TransactionOutput(4775 sats,pkh(5c5963adf08642f83ae9aa615ff730cab59a8b6c))),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 = 020000000112819c4ca864f44e27d3b283e3120016df849a859a775f9c3a33e7dcc26801a2000000006a4730440220472d91a19685aa48fbd4109097fe2d2e10f38e8454867e9df5d5bb7361f0321102207090e9baa5c9e23b757035ff320db2572fba2a78cad1da7d9639df56d53d103b0121032c723fc67f1f441c23e6776b25503382711b7441c2ee047c6bf4afa7b2c1aa25000000000288130000000000001976a914de173b06cce21e169cb21d44f6a541734d2559a588aca7120000000000001976a91450460fb74f026b4203dae6b94d06d05db845710188ac00000000
+// res4: String = 0200000001c3129c652c7545bb3faef36c63aa33093afc2c9a4cfa4ad1e70b87fde9a92ce1000000006a4730440220104b89194874f8dab1f44d92faa4217f5a1304c0c3bf342032096ebc4428ed9b022070a2d4ab24c68fe8962f9a6d19ea28964ed45a5b2c77870b244f01b8343ae8d3012103c9697b247639f45daa2dbea0d47c0fd879ccec086eb9764cc12c60fc9df7182d000000000288130000000000001976a914a2b562da2c6df3528cb66dd64d3a4d0a34c2b8ff88aca7120000000000001976a9145c5963adf08642f83ae9aa615ff730cab59a8b6c88ac00000000