Edit

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@52f2f4d0[Running, parallelism = 8, size = 2, active = 0, running = 0, steals = 2364, tasks = 0, submissions = 0]

// Initialize a transaction builder
val builder = RawTxBuilder()
// builder: RawTxBuilder = RawTxBuilder()

// generate a fresh private key that we are going to use in the scriptpubkey
val privKey = ECPrivateKey.freshPrivateKey
// privKey: ECPrivateKey = Masked(ECPrivateKey)
val pubKey = privKey.publicKey
// pubKey: ECPublicKey = ECPublicKey(02c3055bf0b9f15961bf8e71f0ce1aa91a3f4696f064fd3c73880ef6e4654c1989)

// 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(7cc70ef16daacd4fc87b9c9ff78adc0acf517041)
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(7cc70ef16daacd4fc87b9c9ff78adc0acf517041))

// the private key that locks the funds for the script we are spending too
val destinationPrivKey = ECPrivateKey.freshPrivateKey
// destinationPrivKey: ECPrivateKey = Masked(ECPrivateKey)

// the amount we are sending -- 5000 satoshis -- to the destinationSPK
val destinationAmount = 5000.satoshis
// destinationAmount: Satoshis = 5000 sats

// the script that corresponds to destination private key, this is what is receiving the money
val destinationSPK =
  P2PKHScriptPubKey(pubKey = destinationPrivKey.publicKey)
// destinationSPK: P2PKHScriptPubKey = pkh(b8a468d1a90743c3ab87511f71ee53c7e2826af3)

// this is where we are sending money too
// we could add more destinations here if we
// wanted to batch transactions
val destinations = {
    val destination0 = TransactionOutput(value = destinationAmount,
                                         scriptPubKey = destinationSPK)

    Vector(destination0)
}
// destinations: Vector[TransactionOutput] = Vector(TransactionOutput(5000 sats,pkh(b8a468d1a90743c3ab87511f71ee53c7e2826af3)))

// Add the destinations to the tx builder
builder ++= destinations
// res0: RawTxBuilder = RawTxBuilder()

// we have to fabricate a transaction that contains the
// UTXO we are trying to spend. If this were a real blockchain
// we would need to reference the UTXO set
val creditingTx = BaseTransaction(version = Int32.one,
                                  inputs = Vector.empty,
                                  outputs = Vector(utxo),
                                  lockTime = UInt32.zero)
// creditingTx: BaseTransaction = BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(7cc70ef16daacd4fc87b9c9ff78adc0acf517041))),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(a3ceb9d2375cbe24fb973fc2dec976938a29f12aded9dd216ff56197f93e7eb0:0)
val input = TransactionInput(
    outPoint,
    EmptyScriptSignature,
    sequenceNumber = UInt32.zero)
// input: TransactionInput = TransactionInputImpl(TransactionOutPoint(a3ceb9d2375cbe24fb973fc2dec976938a29f12aded9dd216ff56197f93e7eb0:0),EmptyScriptSignature,UInt32Impl(0))

// Add a new input to our builder
builder += input
// res1: RawTxBuilder = RawTxBuilder()

// We can now generate a RawTxBuilderResult ready to be finalized
val builderResult = builder.result()
// builderResult: RawTxBuilderResult = RawTxBuilderResult(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(a3ceb9d2375cbe24fb973fc2dec976938a29f12aded9dd216ff56197f93e7eb0:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(b8a468d1a90743c3ab87511f71ee53c7e2826af3))),UInt32Impl(0))

// this contains the information needed to analyze our input during finalization
val inputInfo = P2PKHInputInfo(outPoint, amount, privKey.publicKey)
// inputInfo: P2PKHInputInfo = P2PKHInputInfo(TransactionOutPoint(a3ceb9d2375cbe24fb973fc2dec976938a29f12aded9dd216ff56197f93e7eb0:0),10000 sats,ECPublicKey(02c3055bf0b9f15961bf8e71f0ce1aa91a3f4696f064fd3c73880ef6e4654c1989))

// 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
val feeRate = SatoshisPerByte(1.satoshi)
// feeRate: SatoshisPerByte = 1 sats/byte

val changePrivKey = ECPrivateKey.freshPrivateKey
// changePrivKey: ECPrivateKey = Masked(ECPrivateKey)
val changeSPK = P2PKHScriptPubKey(pubKey = changePrivKey.publicKey)
// changeSPK: P2PKHScriptPubKey = pkh(d0544762d046ebd4b70aadf583a0599c92842d50)

// 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(a3ceb9d2375cbe24fb973fc2dec976938a29f12aded9dd216ff56197f93e7eb0:0),10000 sats,ECPublicKey(02c3055bf0b9f15961bf8e71f0ce1aa91a3f4696f064fd3c73880ef6e4654c1989))),1 sats/byte,pkh(d0544762d046ebd4b70aadf583a0599c92842d50))

// We can now finalize the tx builder result from earlier with this finalizer
val unsignedTx: Transaction = finalizer.buildTx(builderResult)
// unsignedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(a3ceb9d2375cbe24fb973fc2dec976938a29f12aded9dd216ff56197f93e7eb0:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(b8a468d1a90743c3ab87511f71ee53c7e2826af3)), TransactionOutput(4775 sats,pkh(d0544762d046ebd4b70aadf583a0599c92842d50))),UInt32Impl(0))

// We now turn to signing the unsigned transaction
// this contains all the information we need to
// validly sign the UTXO above
val utxoInfo = ScriptSignatureParams(inputInfo = inputInfo,
                                     prevTransaction = creditingTx,
                                     signers = Vector(privKey),
                                     hashType =
                                         HashType.sigHashAll)
// utxoInfo: ScriptSignatureParams[P2PKHInputInfo] = ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(a3ceb9d2375cbe24fb973fc2dec976938a29f12aded9dd216ff56197f93e7eb0:0),10000 sats,ECPublicKey(02c3055bf0b9f15961bf8e71f0ce1aa91a3f4696f064fd3c73880ef6e4654c1989)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(7cc70ef16daacd4fc87b9c9ff78adc0acf517041))),UInt32Impl(0)),Vector(Masked(ECPrivateKey)),SIGHASH_ALL(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(a3ceb9d2375cbe24fb973fc2dec976938a29f12aded9dd216ff56197f93e7eb0:0),10000 sats,ECPublicKey(02c3055bf0b9f15961bf8e71f0ce1aa91a3f4696f064fd3c73880ef6e4654c1989)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(7cc70ef16daacd4fc87b9c9ff78adc0acf517041))),UInt32Impl(0)),Vector(Masked(ECPrivateKey)),SIGHASH_ALL(1)))

// Yay! Now we use the RawTxSigner object to sign the tx.
// The 'sign' method is going produce a validly signed transaction
// This is going to iterate through each of the UTXOs and use
// the corresponding ScriptSignatureParams to produce a validly
// signed input. This UTXO has:
//   1: one input
//   2: outputs (destination and change outputs)
//   3: a fee rate of 1 satoshi/byte
val signedTx: Transaction =
  RawTxSigner.sign(
      utx = unsignedTx,
      utxoInfos = utxoInfos,
      expectedFeeRate = feeRate
  )
// signedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(a3ceb9d2375cbe24fb973fc2dec976938a29f12aded9dd216ff56197f93e7eb0:0),P2PKHScriptSignature(ECPublicKeyBytes(ByteVector(33 bytes, 0x02c3055bf0b9f15961bf8e71f0ce1aa91a3f4696f064fd3c73880ef6e4654c1989)), ECDigitalSignature(304402206f5050a5648a4738c8c4b3c7bb15131f241cf00690f23bef1b1358db4894130f02205e12386a020fa1b3fcc21abd98ccd187196811ccd344df7feaf1641d4c58ae1001)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(b8a468d1a90743c3ab87511f71ee53c7e2826af3)), TransactionOutput(4775 sats,pkh(d0544762d046ebd4b70aadf583a0599c92842d50))),UInt32Impl(0))

signedTx.inputs.length
// res2: Int = 1

signedTx.outputs.length
// res3: Int = 2

//remember, you can call .hex on any bitcoin-s data structure to get the hex representation!
signedTx.hex
// res4: String = 0200000001b07e3ef99761f56f21ddd9de2af1298a9376c9dec23f97fb24be5c37d2b9cea3000000006a47304402206f5050a5648a4738c8c4b3c7bb15131f241cf00690f23bef1b1358db4894130f02205e12386a020fa1b3fcc21abd98ccd187196811ccd344df7feaf1641d4c58ae10012102c3055bf0b9f15961bf8e71f0ce1aa91a3f4696f064fd3c73880ef6e4654c1989000000000288130000000000001976a914b8a468d1a90743c3ab87511f71ee53c7e2826af388aca7120000000000001976a914d0544762d046ebd4b70aadf583a0599c92842d5088ac00000000