From 3c8368bafe2701a0393c0f74bed2d4a8504182d9 Mon Sep 17 00:00:00 2001 From: Docusaurus bot Date: Wed, 20 Jan 2021 18:38:57 +0000 Subject: [PATCH] Deploy website Deploy website version based on 36b5fc142715f8ab3ad053465d53dc29ab319790 --- docs/next/core/addresses.html | 10 +++--- docs/next/core/addresses/index.html | 10 +++--- docs/next/core/hd-keys.html | 12 +++---- docs/next/core/hd-keys/index.html | 12 +++---- docs/next/core/txbuilder.html | 36 +++++++++---------- docs/next/core/txbuilder/index.html | 36 +++++++++---------- docs/next/crypto/sign.html | 4 +-- docs/next/crypto/sign/index.html | 4 +-- docs/next/getting-started.html | 2 +- docs/next/getting-started/index.html | 2 +- docs/next/key-manager/key-manager.html | 22 ++++++------ docs/next/key-manager/key-manager/index.html | 22 ++++++------ docs/next/key-manager/server-key-manager.html | 3 ++ .../key-manager/server-key-manager/index.html | 3 ++ docs/next/secp256k1/secp256k1.html | 4 +-- docs/next/secp256k1/secp256k1/index.html | 4 +-- docs/next/wallet/wallet-rescan.html | 23 +++++++++--- docs/next/wallet/wallet-rescan/index.html | 23 +++++++++--- 18 files changed, 134 insertions(+), 98 deletions(-) diff --git a/docs/next/core/addresses.html b/docs/next/core/addresses.html index 2e54329f2a..24117f06da 100644 --- a/docs/next/core/addresses.html +++ b/docs/next/core/addresses.html @@ -80,7 +80,7 @@ reason to keep using legacy transaction formats.

val privkey = ECPrivateKey() // privkey: ECPrivateKey = Masked(ECPrivateKeyImpl) val pubkey = privkey.publicKey -// pubkey: org.bitcoins.crypto.ECPublicKey = ECPublicKey(0286720b3062759a3dd191fb4af22f40b6af86479061a23bb21ae734560e580246) +// pubkey: org.bitcoins.crypto.ECPublicKey = ECPublicKey(03316f1664fd16bf453113d21786eb1478cec260662f49a1cdb0476837c04b9c0c) val segwitAddress = { // see https://bitcoin.org/en/glossary/pubkey-script @@ -89,10 +89,10 @@ reason to keep using legacy transaction formats.

val scriptPubKey = P2WPKHWitnessSPKV0(pubkey) Bech32Address(scriptPubKey, TestNet3) } -// segwitAddress: Bech32Address = tb1q050ae9drcjha5m5rhxrvgmryastax69eze7se3 +// segwitAddress: Bech32Address = tb1qreu9gc7a8sg0n5y5dd43hpes6fj0nc6nzu2l97 println(segwitAddress.toString) -// tb1q050ae9drcjha5m5rhxrvgmryastax69eze7se3 +// tb1qreu9gc7a8sg0n5y5dd43hpes6fj0nc6nzu2l97

Generating legacy (base58) addresses

If you need to generate legacy addresses for backwards @@ -101,10 +101,10 @@ Take a look:

// we're reusing the same private/public key pair
 // from before. don't do this in an actual application!
 val legacyAddress = P2PKHAddress(pubkey, TestNet3)
-// legacyAddress: P2PKHAddress = mrvYvpVZyUYVrTxbPwGGjVMEenkpkksshh
+// legacyAddress: P2PKHAddress = miJ4iTc2Z3YFWdaKwFAc5UAzFh7D7w54db
 
 println(legacyAddress.toString)
-// mrvYvpVZyUYVrTxbPwGGjVMEenkpkksshh
+// miJ4iTc2Z3YFWdaKwFAc5UAzFh7D7w54db
← Core ModuleHD Key Generation →
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@292aa6d4[Running, parallelism = 2, size = 2, active = 0, running = 0, steals = 33, tasks = 0, submissions = 0]
+// ec: ExecutionContext = scala.concurrent.impl.ExecutionContextImpl$$anon$3@265e2dfb[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(0307500cd6e4b98efc87519d5067d6fcb17c14dc4322b5bb34f8c467ff43d41c2b)
+// pubKey: ECPublicKey = ECPublicKey(029b31fd9c67b7f5bd1d05e4c877951182e9756963f04775236c5e4dc807224c16)
 
 // 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(9faae24eb0bc1f2d4bd7ee462181f114db68d64c)
+// creditingSpk: P2PKHScriptPubKey = pkh(70dfa78fcbe359c70d08914355a51b2d45d5a732)
 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(9faae24eb0bc1f2d4bd7ee462181f114db68d64c))
+// utxo: TransactionOutput = TransactionOutput(10000 sats,pkh(70dfa78fcbe359c70d08914355a51b2d45d5a732))
 
 // 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(1f12450862cb1da220116b44a6f54b8831fcf7c6)
+// destinationSPK: P2PKHScriptPubKey = pkh(bf7a2289ca4478e42dc3876e842f9ec903b7035c)
 
 // 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(1f12450862cb1da220116b44a6f54b8831fcf7c6)))
+// destinations: Vector[TransactionOutput] = Vector(TransactionOutput(5000 sats,pkh(bf7a2289ca4478e42dc3876e842f9ec903b7035c)))
 
 // 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(9faae24eb0bc1f2d4bd7ee462181f114db68d64c))),UInt32Impl(0))
+// creditingTx: BaseTransaction = BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(70dfa78fcbe359c70d08914355a51b2d45d5a732))),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(690f4b882f26014f9b01d7ab3e89da0ae3202c4c7d9e4086efb850cee9e9918c:0)
+// outPoint: TransactionOutPoint = TransactionOutPoint(72c3e06329923b1cf3d6700631818daf1eee7b445e8493a8086e1446094dec7c:0)
 val input = TransactionInput(
     outPoint,
     EmptyScriptSignature,
     sequenceNumber = UInt32.zero)
-// input: TransactionInput = TransactionInputImpl(TransactionOutPoint(690f4b882f26014f9b01d7ab3e89da0ae3202c4c7d9e4086efb850cee9e9918c:0),EmptyScriptSignature,UInt32Impl(0))
+// input: TransactionInput = TransactionInputImpl(TransactionOutPoint(72c3e06329923b1cf3d6700631818daf1eee7b445e8493a8086e1446094dec7c: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(690f4b882f26014f9b01d7ab3e89da0ae3202c4c7d9e4086efb850cee9e9918c:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(1f12450862cb1da220116b44a6f54b8831fcf7c6))),UInt32Impl(0))
+// builderResult: RawTxBuilderResult = RawTxBuilderResult(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(72c3e06329923b1cf3d6700631818daf1eee7b445e8493a8086e1446094dec7c:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(bf7a2289ca4478e42dc3876e842f9ec903b7035c))),UInt32Impl(0))
 
 // this contains the information needed to analyze our input during finalization
 val inputInfo = P2PKHInputInfo(outPoint, amount, privKey.publicKey)
-// inputInfo: P2PKHInputInfo = P2PKHInputInfo(TransactionOutPoint(690f4b882f26014f9b01d7ab3e89da0ae3202c4c7d9e4086efb850cee9e9918c:0),10000 sats,ECPublicKey(0307500cd6e4b98efc87519d5067d6fcb17c14dc4322b5bb34f8c467ff43d41c2b))
+// inputInfo: P2PKHInputInfo = P2PKHInputInfo(TransactionOutPoint(72c3e06329923b1cf3d6700631818daf1eee7b445e8493a8086e1446094dec7c:0),10000 sats,ECPublicKey(029b31fd9c67b7f5bd1d05e4c877951182e9756963f04775236c5e4dc807224c16))
 
 // 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(7cda083da67087edd7de2f1437973ad2f168e994)
+// changeSPK: P2PKHScriptPubKey = pkh(96f51bc363aecf04785f8923eb31082331bce04e)
 
 // 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(690f4b882f26014f9b01d7ab3e89da0ae3202c4c7d9e4086efb850cee9e9918c:0),10000 sats,ECPublicKey(0307500cd6e4b98efc87519d5067d6fcb17c14dc4322b5bb34f8c467ff43d41c2b))),1 sats/byte,pkh(7cda083da67087edd7de2f1437973ad2f168e994))
+// finalizer: StandardNonInteractiveFinalizer = StandardNonInteractiveFinalizer(Vector(P2PKHInputInfo(TransactionOutPoint(72c3e06329923b1cf3d6700631818daf1eee7b445e8493a8086e1446094dec7c:0),10000 sats,ECPublicKey(029b31fd9c67b7f5bd1d05e4c877951182e9756963f04775236c5e4dc807224c16))),1 sats/byte,pkh(96f51bc363aecf04785f8923eb31082331bce04e))
 
 // 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(690f4b882f26014f9b01d7ab3e89da0ae3202c4c7d9e4086efb850cee9e9918c:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(1f12450862cb1da220116b44a6f54b8831fcf7c6)), TransactionOutput(4775 sats,pkh(7cda083da67087edd7de2f1437973ad2f168e994))),UInt32Impl(0))))
+// unsignedTxF: Future[Transaction] = Future(Success(BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(72c3e06329923b1cf3d6700631818daf1eee7b445e8493a8086e1446094dec7c:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(bf7a2289ca4478e42dc3876e842f9ec903b7035c)), TransactionOutput(4775 sats,pkh(96f51bc363aecf04785f8923eb31082331bce04e))),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(690f4b882f26014f9b01d7ab3e89da0ae3202c4c7d9e4086efb850cee9e9918c:0),10000 sats,ECPublicKey(0307500cd6e4b98efc87519d5067d6fcb17c14dc4322b5bb34f8c467ff43d41c2b)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(9faae24eb0bc1f2d4bd7ee462181f114db68d64c))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1)))
+// utxoInfo: ScriptSignatureParams[P2PKHInputInfo] = ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(72c3e06329923b1cf3d6700631818daf1eee7b445e8493a8086e1446094dec7c:0),10000 sats,ECPublicKey(029b31fd9c67b7f5bd1d05e4c877951182e9756963f04775236c5e4dc807224c16)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(70dfa78fcbe359c70d08914355a51b2d45d5a732))),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(690f4b882f26014f9b01d7ab3e89da0ae3202c4c7d9e4086efb850cee9e9918c:0),10000 sats,ECPublicKey(0307500cd6e4b98efc87519d5067d6fcb17c14dc4322b5bb34f8c467ff43d41c2b)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(9faae24eb0bc1f2d4bd7ee462181f114db68d64c))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1))))
+// utxoInfos: Vector[ScriptSignatureParams[InputInfo]] = Vector(ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(72c3e06329923b1cf3d6700631818daf1eee7b445e8493a8086e1446094dec7c:0),10000 sats,ECPublicKey(029b31fd9c67b7f5bd1d05e4c877951182e9756963f04775236c5e4dc807224c16)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(70dfa78fcbe359c70d08914355a51b2d45d5a732))),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(690f4b882f26014f9b01d7ab3e89da0ae3202c4c7d9e4086efb850cee9e9918c:0),P2PKHScriptSignature(ECPublicKey(0307500cd6e4b98efc87519d5067d6fcb17c14dc4322b5bb34f8c467ff43d41c2b), ECDigitalSignature(30440220231f86db9d3728e6e2ad719f84b9708f45f4b492174f6c141f13fd1458df6b12022078f3c73e205d45e8a4dcdc3d77266427c5901243a7d1149c513b9c4f55a083fb01)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(1f12450862cb1da220116b44a6f54b8831fcf7c6)), TransactionOutput(4775 sats,pkh(7cda083da67087edd7de2f1437973ad2f168e994))),UInt32Impl(0))
+// signedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(72c3e06329923b1cf3d6700631818daf1eee7b445e8493a8086e1446094dec7c:0),P2PKHScriptSignature(ECPublicKey(029b31fd9c67b7f5bd1d05e4c877951182e9756963f04775236c5e4dc807224c16), ECDigitalSignature(304402202019d6e21648a0eae337ac8c4246913a66d86aed97b1c51c7ad1789f26d2ccc20220077b1ff1793b51b40525562df4b801e7626232b27a89bbf811252bb80c5e835901)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(bf7a2289ca4478e42dc3876e842f9ec903b7035c)), TransactionOutput(4775 sats,pkh(96f51bc363aecf04785f8923eb31082331bce04e))),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 = 02000000018c91e9e9ce50b8ef86409e7d4c2c20e30ada893eabd7019b4f01262f884b0f69000000006a4730440220231f86db9d3728e6e2ad719f84b9708f45f4b492174f6c141f13fd1458df6b12022078f3c73e205d45e8a4dcdc3d77266427c5901243a7d1149c513b9c4f55a083fb01210307500cd6e4b98efc87519d5067d6fcb17c14dc4322b5bb34f8c467ff43d41c2b000000000288130000000000001976a9141f12450862cb1da220116b44a6f54b8831fcf7c688aca7120000000000001976a9147cda083da67087edd7de2f1437973ad2f168e99488ac00000000
+// res4: String = 02000000017cec4d0946146e08a893845e447bee1eaf8d81310670d6f31c3b922963e0c372000000006a47304402202019d6e21648a0eae337ac8c4246913a66d86aed97b1c51c7ad1789f26d2ccc20220077b1ff1793b51b40525562df4b801e7626232b27a89bbf811252bb80c5e83590121029b31fd9c67b7f5bd1d05e4c877951182e9756963f04775236c5e4dc807224c16000000000288130000000000001976a914bf7a2289ca4478e42dc3876e842f9ec903b7035c88aca7120000000000001976a91496f51bc363aecf04785f8923eb31082331bce04e88ac00000000
← Partially Signed Bitcoin TransactionsLightning Network Data Types →
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@292aa6d4[Running, parallelism = 2, size = 2, active = 0, running = 0, steals = 33, tasks = 0, submissions = 0]
+// ec: ExecutionContext = scala.concurrent.impl.ExecutionContextImpl$$anon$3@265e2dfb[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(0307500cd6e4b98efc87519d5067d6fcb17c14dc4322b5bb34f8c467ff43d41c2b)
+// pubKey: ECPublicKey = ECPublicKey(029b31fd9c67b7f5bd1d05e4c877951182e9756963f04775236c5e4dc807224c16)
 
 // 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(9faae24eb0bc1f2d4bd7ee462181f114db68d64c)
+// creditingSpk: P2PKHScriptPubKey = pkh(70dfa78fcbe359c70d08914355a51b2d45d5a732)
 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(9faae24eb0bc1f2d4bd7ee462181f114db68d64c))
+// utxo: TransactionOutput = TransactionOutput(10000 sats,pkh(70dfa78fcbe359c70d08914355a51b2d45d5a732))
 
 // 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(1f12450862cb1da220116b44a6f54b8831fcf7c6)
+// destinationSPK: P2PKHScriptPubKey = pkh(bf7a2289ca4478e42dc3876e842f9ec903b7035c)
 
 // 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(1f12450862cb1da220116b44a6f54b8831fcf7c6)))
+// destinations: Vector[TransactionOutput] = Vector(TransactionOutput(5000 sats,pkh(bf7a2289ca4478e42dc3876e842f9ec903b7035c)))
 
 // 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(9faae24eb0bc1f2d4bd7ee462181f114db68d64c))),UInt32Impl(0))
+// creditingTx: BaseTransaction = BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(70dfa78fcbe359c70d08914355a51b2d45d5a732))),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(690f4b882f26014f9b01d7ab3e89da0ae3202c4c7d9e4086efb850cee9e9918c:0)
+// outPoint: TransactionOutPoint = TransactionOutPoint(72c3e06329923b1cf3d6700631818daf1eee7b445e8493a8086e1446094dec7c:0)
 val input = TransactionInput(
     outPoint,
     EmptyScriptSignature,
     sequenceNumber = UInt32.zero)
-// input: TransactionInput = TransactionInputImpl(TransactionOutPoint(690f4b882f26014f9b01d7ab3e89da0ae3202c4c7d9e4086efb850cee9e9918c:0),EmptyScriptSignature,UInt32Impl(0))
+// input: TransactionInput = TransactionInputImpl(TransactionOutPoint(72c3e06329923b1cf3d6700631818daf1eee7b445e8493a8086e1446094dec7c: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(690f4b882f26014f9b01d7ab3e89da0ae3202c4c7d9e4086efb850cee9e9918c:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(1f12450862cb1da220116b44a6f54b8831fcf7c6))),UInt32Impl(0))
+// builderResult: RawTxBuilderResult = RawTxBuilderResult(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(72c3e06329923b1cf3d6700631818daf1eee7b445e8493a8086e1446094dec7c:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(bf7a2289ca4478e42dc3876e842f9ec903b7035c))),UInt32Impl(0))
 
 // this contains the information needed to analyze our input during finalization
 val inputInfo = P2PKHInputInfo(outPoint, amount, privKey.publicKey)
-// inputInfo: P2PKHInputInfo = P2PKHInputInfo(TransactionOutPoint(690f4b882f26014f9b01d7ab3e89da0ae3202c4c7d9e4086efb850cee9e9918c:0),10000 sats,ECPublicKey(0307500cd6e4b98efc87519d5067d6fcb17c14dc4322b5bb34f8c467ff43d41c2b))
+// inputInfo: P2PKHInputInfo = P2PKHInputInfo(TransactionOutPoint(72c3e06329923b1cf3d6700631818daf1eee7b445e8493a8086e1446094dec7c:0),10000 sats,ECPublicKey(029b31fd9c67b7f5bd1d05e4c877951182e9756963f04775236c5e4dc807224c16))
 
 // 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(7cda083da67087edd7de2f1437973ad2f168e994)
+// changeSPK: P2PKHScriptPubKey = pkh(96f51bc363aecf04785f8923eb31082331bce04e)
 
 // 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(690f4b882f26014f9b01d7ab3e89da0ae3202c4c7d9e4086efb850cee9e9918c:0),10000 sats,ECPublicKey(0307500cd6e4b98efc87519d5067d6fcb17c14dc4322b5bb34f8c467ff43d41c2b))),1 sats/byte,pkh(7cda083da67087edd7de2f1437973ad2f168e994))
+// finalizer: StandardNonInteractiveFinalizer = StandardNonInteractiveFinalizer(Vector(P2PKHInputInfo(TransactionOutPoint(72c3e06329923b1cf3d6700631818daf1eee7b445e8493a8086e1446094dec7c:0),10000 sats,ECPublicKey(029b31fd9c67b7f5bd1d05e4c877951182e9756963f04775236c5e4dc807224c16))),1 sats/byte,pkh(96f51bc363aecf04785f8923eb31082331bce04e))
 
 // 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(690f4b882f26014f9b01d7ab3e89da0ae3202c4c7d9e4086efb850cee9e9918c:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(1f12450862cb1da220116b44a6f54b8831fcf7c6)), TransactionOutput(4775 sats,pkh(7cda083da67087edd7de2f1437973ad2f168e994))),UInt32Impl(0))))
+// unsignedTxF: Future[Transaction] = Future(Success(BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(72c3e06329923b1cf3d6700631818daf1eee7b445e8493a8086e1446094dec7c:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(bf7a2289ca4478e42dc3876e842f9ec903b7035c)), TransactionOutput(4775 sats,pkh(96f51bc363aecf04785f8923eb31082331bce04e))),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(690f4b882f26014f9b01d7ab3e89da0ae3202c4c7d9e4086efb850cee9e9918c:0),10000 sats,ECPublicKey(0307500cd6e4b98efc87519d5067d6fcb17c14dc4322b5bb34f8c467ff43d41c2b)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(9faae24eb0bc1f2d4bd7ee462181f114db68d64c))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1)))
+// utxoInfo: ScriptSignatureParams[P2PKHInputInfo] = ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(72c3e06329923b1cf3d6700631818daf1eee7b445e8493a8086e1446094dec7c:0),10000 sats,ECPublicKey(029b31fd9c67b7f5bd1d05e4c877951182e9756963f04775236c5e4dc807224c16)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(70dfa78fcbe359c70d08914355a51b2d45d5a732))),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(690f4b882f26014f9b01d7ab3e89da0ae3202c4c7d9e4086efb850cee9e9918c:0),10000 sats,ECPublicKey(0307500cd6e4b98efc87519d5067d6fcb17c14dc4322b5bb34f8c467ff43d41c2b)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(9faae24eb0bc1f2d4bd7ee462181f114db68d64c))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1))))
+// utxoInfos: Vector[ScriptSignatureParams[InputInfo]] = Vector(ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(72c3e06329923b1cf3d6700631818daf1eee7b445e8493a8086e1446094dec7c:0),10000 sats,ECPublicKey(029b31fd9c67b7f5bd1d05e4c877951182e9756963f04775236c5e4dc807224c16)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(70dfa78fcbe359c70d08914355a51b2d45d5a732))),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(690f4b882f26014f9b01d7ab3e89da0ae3202c4c7d9e4086efb850cee9e9918c:0),P2PKHScriptSignature(ECPublicKey(0307500cd6e4b98efc87519d5067d6fcb17c14dc4322b5bb34f8c467ff43d41c2b), ECDigitalSignature(30440220231f86db9d3728e6e2ad719f84b9708f45f4b492174f6c141f13fd1458df6b12022078f3c73e205d45e8a4dcdc3d77266427c5901243a7d1149c513b9c4f55a083fb01)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(1f12450862cb1da220116b44a6f54b8831fcf7c6)), TransactionOutput(4775 sats,pkh(7cda083da67087edd7de2f1437973ad2f168e994))),UInt32Impl(0))
+// signedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(72c3e06329923b1cf3d6700631818daf1eee7b445e8493a8086e1446094dec7c:0),P2PKHScriptSignature(ECPublicKey(029b31fd9c67b7f5bd1d05e4c877951182e9756963f04775236c5e4dc807224c16), ECDigitalSignature(304402202019d6e21648a0eae337ac8c4246913a66d86aed97b1c51c7ad1789f26d2ccc20220077b1ff1793b51b40525562df4b801e7626232b27a89bbf811252bb80c5e835901)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(bf7a2289ca4478e42dc3876e842f9ec903b7035c)), TransactionOutput(4775 sats,pkh(96f51bc363aecf04785f8923eb31082331bce04e))),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 = 02000000018c91e9e9ce50b8ef86409e7d4c2c20e30ada893eabd7019b4f01262f884b0f69000000006a4730440220231f86db9d3728e6e2ad719f84b9708f45f4b492174f6c141f13fd1458df6b12022078f3c73e205d45e8a4dcdc3d77266427c5901243a7d1149c513b9c4f55a083fb01210307500cd6e4b98efc87519d5067d6fcb17c14dc4322b5bb34f8c467ff43d41c2b000000000288130000000000001976a9141f12450862cb1da220116b44a6f54b8831fcf7c688aca7120000000000001976a9147cda083da67087edd7de2f1437973ad2f168e99488ac00000000
+// res4: String = 02000000017cec4d0946146e08a893845e447bee1eaf8d81310670d6f31c3b922963e0c372000000006a47304402202019d6e21648a0eae337ac8c4246913a66d86aed97b1c51c7ad1789f26d2ccc20220077b1ff1793b51b40525562df4b801e7626232b27a89bbf811252bb80c5e83590121029b31fd9c67b7f5bd1d05e4c877951182e9756963f04775236c5e4dc807224c16000000000288130000000000001976a914bf7a2289ca4478e42dc3876e842f9ec903b7035c88aca7120000000000001976a91496f51bc363aecf04785f8923eb31082331bce04e88ac00000000
← Partially Signed Bitcoin TransactionsLightning Network Data Types →
Edit

Wallet Rescans

With BIP157 you can cache block filters locally to use -later for rescans in the case you need to restore your wallets. Our chain project gives us +later for rescans in the case you need to restore your wallets. Our chain project gives us an API with the ability to query for filters.

+

Rescan from CLI

+

To execute a rescan from the cli because you are restoring a wallet or it has gotten out of sync is fairly simple.

+

If you have an empty wallet it can be done by simply calling rescan

+
./bitcoin-s-cli rescan
+
+

If your wallet is not empty then you will need to call it with the force command

+
./bitcoin-s-cli rescan --force
+
+

You can also specify start and stop heights

+
./bitcoin-s-cli rescan --start <start height> --stop <stop height>
+
+

By default, if you do not set the start height, the rescan will begin at your wallet's creation time. +If you wish to ignore this and start from genesis use the ignorecreationtime flag

+
./bitcoin-s-cli rescan --ignorecreationtime
+
+

Code Example

You can rescan your wallet with filters with WalletApi.rescanNeutrinoWallet()

-

Example

-

To run this example you need to make sure you have access to a bitcoind binary. You can download this with bitcoin-s by doing -sbt downloadBitcoind

+

To run this example you need to make sure you have access to a bitcoind binary. +You can download this with bitcoin-s by doing sbt downloadBitcoind

//we need an actor system and app config to power this
 implicit val system: ActorSystem = ActorSystem(s"wallet-rescan-example")
 implicit val ec: ExecutionContext = system.dispatcher
diff --git a/docs/next/wallet/wallet-rescan/index.html b/docs/next/wallet/wallet-rescan/index.html
index fa0f192678..d2a0363e96 100644
--- a/docs/next/wallet/wallet-rescan/index.html
+++ b/docs/next/wallet/wallet-rescan/index.html
@@ -63,12 +63,27 @@
               }
             });
Edit

Wallet Rescans

With BIP157 you can cache block filters locally to use -later for rescans in the case you need to restore your wallets. Our chain project gives us +later for rescans in the case you need to restore your wallets. Our chain project gives us an API with the ability to query for filters.

+

Rescan from CLI

+

To execute a rescan from the cli because you are restoring a wallet or it has gotten out of sync is fairly simple.

+

If you have an empty wallet it can be done by simply calling rescan

+
./bitcoin-s-cli rescan
+
+

If your wallet is not empty then you will need to call it with the force command

+
./bitcoin-s-cli rescan --force
+
+

You can also specify start and stop heights

+
./bitcoin-s-cli rescan --start <start height> --stop <stop height>
+
+

By default, if you do not set the start height, the rescan will begin at your wallet's creation time. +If you wish to ignore this and start from genesis use the ignorecreationtime flag

+
./bitcoin-s-cli rescan --ignorecreationtime
+
+

Code Example

You can rescan your wallet with filters with WalletApi.rescanNeutrinoWallet()

-

Example

-

To run this example you need to make sure you have access to a bitcoind binary. You can download this with bitcoin-s by doing -sbt downloadBitcoind

+

To run this example you need to make sure you have access to a bitcoind binary. +You can download this with bitcoin-s by doing sbt downloadBitcoind

//we need an actor system and app config to power this
 implicit val system: ActorSystem = ActorSystem(s"wallet-rescan-example")
 implicit val ec: ExecutionContext = system.dispatcher