mirrors/bitcoin-s
1
0
Fork 0
mirror of https://github.com/bitcoin-s/bitcoin-s.git synced 2025-03-19 13:35:17 +01:00
Code Issues Projects Releases Packages Wiki Activity

Deploy website

Browse source 
Deploy website version based on 36b5fc1427
This commit is contained in:
Docusaurus bot 2021-01-20 18:38:57 +00:00
parent edb609664c
commit 3c8368bafe
18 changed files with 134 additions and 98 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/next/core/addresses.html
View file

@ -80,7 +80,7 @@ reason to keep using legacy transaction formats.</p>
<span class="hljs-keyword">val</span> privkey = <span class="hljs-type">ECPrivateKey</span>()
<span class="hljs-comment">// privkey: ECPrivateKey = Masked(ECPrivateKeyImpl)</span>
<span class="hljs-keyword">val</span> pubkey = privkey.publicKey
<span class="hljs-comment">// pubkey: org.bitcoins.crypto.ECPublicKey = ECPublicKey(0286720b3062759a3dd191fb4af22f40b6af86479061a23bb21ae734560e580246)</span>
<span class="hljs-comment">// pubkey: org.bitcoins.crypto.ECPublicKey = ECPublicKey(03316f1664fd16bf453113d21786eb1478cec260662f49a1cdb0476837c04b9c0c)</span>
<span class="hljs-keyword">val</span> segwitAddress = {
<span class="hljs-comment">// see https://bitcoin.org/en/glossary/pubkey-script</span>
@ -89,10 +89,10 @@ reason to keep using legacy transaction formats.</p>
<span class="hljs-keyword">val</span> scriptPubKey = <span class="hljs-type">P2WPKHWitnessSPKV0</span>(pubkey)
<span class="hljs-type">Bech32Address</span>(scriptPubKey, <span class="hljs-type">TestNet3</span>)
}
<span class="hljs-comment">// segwitAddress: Bech32Address = tb1q050ae9drcjha5m5rhxrvgmryastax69eze7se3</span>
<span class="hljs-comment">// segwitAddress: Bech32Address = tb1qreu9gc7a8sg0n5y5dd43hpes6fj0nc6nzu2l97</span>
println(segwitAddress.toString)
<span class="hljs-comment">// tb1q050ae9drcjha5m5rhxrvgmryastax69eze7se3</span>
<span class="hljs-comment">// tb1qreu9gc7a8sg0n5y5dd43hpes6fj0nc6nzu2l97</span>
</code></pre>
<h2><a class="anchor" aria-hidden="true" id="generating-legacy-base58-addresses"></a><a href="#generating-legacy-base58-addresses" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Generating legacy (base58) addresses</h2>
<p>If you need to generate legacy addresses for backwards
@ -101,10 +101,10 @@ Take a look:</p>
<pre><code class="hljs css language-scala"><span class="hljs-comment">// we&#x27;re reusing the same private/public key pair</span>
<span class="hljs-comment">// from before. don&#x27;t do this in an actual application!</span>
<span class="hljs-keyword">val</span> legacyAddress = <span class="hljs-type">P2PKHAddress</span>(pubkey, <span class="hljs-type">TestNet3</span>)
<span class="hljs-comment">// legacyAddress: P2PKHAddress = mrvYvpVZyUYVrTxbPwGGjVMEenkpkksshh</span>
<span class="hljs-comment">// legacyAddress: P2PKHAddress = miJ4iTc2Z3YFWdaKwFAc5UAzFh7D7w54db</span>
println(legacyAddress.toString)
<span class="hljs-comment">// mrvYvpVZyUYVrTxbPwGGjVMEenkpkksshh</span>
<span class="hljs-comment">// miJ4iTc2Z3YFWdaKwFAc5UAzFh7D7w54db</span>
</code></pre>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/next/core/core-intro"><span class="arrow-prev">← </span><span>Core Module</span></a><a class="docs-next button" href="/docs/next/core/hd-keys"><span>HD Key Generation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#generating-segwit-bech32-addresses">Generating SegWit (bech32) addresses</a></li><li><a href="#generating-legacy-base58-addresses">Generating legacy (base58) addresses</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/favicon.ico" alt="bitcoin-s" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/getting-started">Getting Started</a><a href="/docs/en/core/core-intro">Guides</a><a href="/api/org/bitcoins">API Reference</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="https://join.slack.com/t/suredbits/shared_invite/zt-eavycu0x-WQL7XOakzQo8tAy7jHHZUw" target="_blank" rel="noreferrer noopener">Slack</a><a href="https://gitter.im/bitcoin-s-core/">Gitter chat</a></div><div><h5>More</h5><a href="https://github.com/bitcoin-s/bitcoin-s">GitHub</a><a class="github-button" href="https://github.com/bitcoin-s/bitcoin-s" data-icon="octicon-star" data-count-href="/bitcoin-s/bitcoin-s-core/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2021 Suredbits &amp; the bitcoin-s developers</section></footer></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script><script>
document.addEventListener('keyup', function(e) {

10
docs/next/core/addresses/index.html
View file

@ -80,7 +80,7 @@ reason to keep using legacy transaction formats.</p>
<span class="hljs-keyword">val</span> privkey = <span class="hljs-type">ECPrivateKey</span>()
<span class="hljs-comment">// privkey: ECPrivateKey = Masked(ECPrivateKeyImpl)</span>
<span class="hljs-keyword">val</span> pubkey = privkey.publicKey
<span class="hljs-comment">// pubkey: org.bitcoins.crypto.ECPublicKey = ECPublicKey(0286720b3062759a3dd191fb4af22f40b6af86479061a23bb21ae734560e580246)</span>
<span class="hljs-comment">// pubkey: org.bitcoins.crypto.ECPublicKey = ECPublicKey(03316f1664fd16bf453113d21786eb1478cec260662f49a1cdb0476837c04b9c0c)</span>
<span class="hljs-keyword">val</span> segwitAddress = {
<span class="hljs-comment">// see https://bitcoin.org/en/glossary/pubkey-script</span>
@ -89,10 +89,10 @@ reason to keep using legacy transaction formats.</p>
<span class="hljs-keyword">val</span> scriptPubKey = <span class="hljs-type">P2WPKHWitnessSPKV0</span>(pubkey)
<span class="hljs-type">Bech32Address</span>(scriptPubKey, <span class="hljs-type">TestNet3</span>)
}
<span class="hljs-comment">// segwitAddress: Bech32Address = tb1q050ae9drcjha5m5rhxrvgmryastax69eze7se3</span>
<span class="hljs-comment">// segwitAddress: Bech32Address = tb1qreu9gc7a8sg0n5y5dd43hpes6fj0nc6nzu2l97</span>
println(segwitAddress.toString)
<span class="hljs-comment">// tb1q050ae9drcjha5m5rhxrvgmryastax69eze7se3</span>
<span class="hljs-comment">// tb1qreu9gc7a8sg0n5y5dd43hpes6fj0nc6nzu2l97</span>
</code></pre>
<h2><a class="anchor" aria-hidden="true" id="generating-legacy-base58-addresses"></a><a href="#generating-legacy-base58-addresses" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Generating legacy (base58) addresses</h2>
<p>If you need to generate legacy addresses for backwards
@ -101,10 +101,10 @@ Take a look:</p>
<pre><code class="hljs css language-scala"><span class="hljs-comment">// we&#x27;re reusing the same private/public key pair</span>
<span class="hljs-comment">// from before. don&#x27;t do this in an actual application!</span>
<span class="hljs-keyword">val</span> legacyAddress = <span class="hljs-type">P2PKHAddress</span>(pubkey, <span class="hljs-type">TestNet3</span>)
<span class="hljs-comment">// legacyAddress: P2PKHAddress = mrvYvpVZyUYVrTxbPwGGjVMEenkpkksshh</span>
<span class="hljs-comment">// legacyAddress: P2PKHAddress = miJ4iTc2Z3YFWdaKwFAc5UAzFh7D7w54db</span>
println(legacyAddress.toString)
<span class="hljs-comment">// mrvYvpVZyUYVrTxbPwGGjVMEenkpkksshh</span>
<span class="hljs-comment">// miJ4iTc2Z3YFWdaKwFAc5UAzFh7D7w54db</span>
</code></pre>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/next/core/core-intro"><span class="arrow-prev">← </span><span>Core Module</span></a><a class="docs-next button" href="/docs/next/core/hd-keys"><span>HD Key Generation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#generating-segwit-bech32-addresses">Generating SegWit (bech32) addresses</a></li><li><a href="#generating-legacy-base58-addresses">Generating legacy (base58) addresses</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/favicon.ico" alt="bitcoin-s" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/getting-started">Getting Started</a><a href="/docs/en/core/core-intro">Guides</a><a href="/api/org/bitcoins">API Reference</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="https://join.slack.com/t/suredbits/shared_invite/zt-eavycu0x-WQL7XOakzQo8tAy7jHHZUw" target="_blank" rel="noreferrer noopener">Slack</a><a href="https://gitter.im/bitcoin-s-core/">Gitter chat</a></div><div><h5>More</h5><a href="https://github.com/bitcoin-s/bitcoin-s">GitHub</a><a class="github-button" href="https://github.com/bitcoin-s/bitcoin-s" data-icon="octicon-star" data-count-href="/bitcoin-s/bitcoin-s-core/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2021 Suredbits &amp; the bitcoin-s developers</section></footer></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script><script>
document.addEventListener('keyup', function(e) {

12
docs/next/core/hd-keys.html
View file

@ -86,13 +86,13 @@ use that to generate further private and public keys:</p>
<span class="hljs-comment">// how long our phrase ends up being</span>
<span class="hljs-comment">// 256 bits of entropy results in 24 words</span>
<span class="hljs-keyword">val</span> entropy: <span class="hljs-type">BitVector</span> = <span class="hljs-type">MnemonicCode</span>.getEntropy256Bits
<span class="hljs-comment">// entropy: BitVector = BitVector(256 bits, 0x425e21d0036f9d3ba4c0d8a31714f439c4f05da8f7b11f82a9780e424e29dd74)</span>
<span class="hljs-comment">// entropy: BitVector = BitVector(256 bits, 0x38ff3f62716f0f1921466dfb9a36796af9ceb140eadfd956be8d1d6a6a927fcb)</span>
<span class="hljs-keyword">val</span> mnemonicCode = <span class="hljs-type">MnemonicCode</span>.fromEntropy(entropy)
<span class="hljs-comment">// mnemonicCode: MnemonicCode = Masked(MnemonicCodeImpl)</span>
mnemonicCode.words <span class="hljs-comment">// the phrase the user should write down</span>
<span class="hljs-comment">// res0: Vector[String] = Vector(drastic, valve, inject, almost, what, oven, narrow, brand, perfect, reward, dial, inform, excuse, conduct, phrase, wage, buzz, best, fun, broken, ceiling, belt, into, mutual) // the phrase the user should write down</span>
<span class="hljs-comment">// res0: Vector[String] = Vector(decline, wheat, sudden, tissue, valley, milk, lunar, soap, wine, spider, oxygen, sting, ostrich, flavor, admit, fossil, sun, remove, person, depart, pluck, empty, you, guide) // the phrase the user should write down</span>
<span class="hljs-comment">// the password argument is an optional, extra security</span>
<span class="hljs-comment">// measure. all MnemonicCode instances will give you a</span>
@ -108,7 +108,7 @@ mnemonicCode.words <span class="hljs-comment">// the phrase the user should writ
bip39Seed)
<span class="hljs-comment">// xpriv: ExtPrivateKey = Masked(ExtPrivateKeyImpl)</span>
<span class="hljs-keyword">val</span> xpub = xpriv.extPublicKey
<span class="hljs-comment">// xpub: ExtPublicKey = zpub6jftahH18ngZxJifsUKnjMSWY48ZBqnQiWMpv9H2PfXsdzLSFToC9xhYjtJ5VdEAAgWYfKWDC1UctGDd5f6bJdENomA2LBf6SuiHV1PvqKC</span>
<span class="hljs-comment">// xpub: ExtPublicKey = zpub6jftahH18ngZyEB6QWJtc8LUR3g4bJBC19PhdPTDDiRgtDgvxvH4REFiZWrFBScij2yLen5vbcEHTgxie12e7H6mf9tCHCXxgwPd8UqKBVZ</span>
<span class="hljs-comment">// you can now use the generated xpriv to derive further</span>
<span class="hljs-comment">// private or public keys</span>
@ -154,7 +154,7 @@ spend or steal any of your money.</p>
<span class="hljs-comment">// can generate addresses with it!</span>
accountXpriv.extPublicKey
}
<span class="hljs-comment">// accountXpub: ExtPublicKey = zpub6rJESb7HfreGdSSEBozzV4AbYNv6h1hgo3jQWoaSokLKceeYupAKpxNWifi6JqZZMyNpAC1fpKPTAXFhd9bJK8jgGzyxKgv1MXbCQWywBwn</span>
<span class="hljs-comment">// accountXpub: ExtPublicKey = zpub6rQ6ULsFKtHG6xejeL1GGF5Y2h4VoKbHdAARfragCKWaEQXp1CLzpafGcSz34nvpXp4xBcmhxVAvtFNWbk2LQUNpf5DgeedjJx1DuX1SX3X</span>
<span class="hljs-comment">// address no. 0 ---------------┐</span>
<span class="hljs-comment">// external address ----------┐ |</span>
@ -177,12 +177,12 @@ spend or steal any of your money.</p>
<span class="hljs-keyword">val</span> scriptPubKey = <span class="hljs-type">P2WPKHWitnessSPKV0</span>(pubkey)
<span class="hljs-type">Bech32Address</span>(scriptPubKey, <span class="hljs-type">TestNet3</span>)
}
<span class="hljs-comment">// firstAccountAddress: Bech32Address = tb1qaftjve8hn92ne768sv3xhn3ta960d029rs5f3w</span>
<span class="hljs-comment">// firstAccountAddress: Bech32Address = tb1qkp2rhv003f5eca380dck64x0nrs2a0hcufhqfu</span>
<span class="hljs-comment">// tada! We just generated an address you can send money to,</span>
<span class="hljs-comment">// without having access to the private key!</span>
firstAccountAddress.value
<span class="hljs-comment">// res2: String = tb1qaftjve8hn92ne768sv3xhn3ta960d029rs5f3w</span>
<span class="hljs-comment">// res2: String = tb1qkp2rhv003f5eca380dck64x0nrs2a0hcufhqfu</span>
<span class="hljs-comment">// you can now continue deriving addresses from the same public</span>
<span class="hljs-comment">// key, by imitating what we did above. To get the next</span>

12
docs/next/core/hd-keys/index.html
View file

@ -86,13 +86,13 @@ use that to generate further private and public keys:</p>
<span class="hljs-comment">// how long our phrase ends up being</span>
<span class="hljs-comment">// 256 bits of entropy results in 24 words</span>
<span class="hljs-keyword">val</span> entropy: <span class="hljs-type">BitVector</span> = <span class="hljs-type">MnemonicCode</span>.getEntropy256Bits
<span class="hljs-comment">// entropy: BitVector = BitVector(256 bits, 0x425e21d0036f9d3ba4c0d8a31714f439c4f05da8f7b11f82a9780e424e29dd74)</span>
<span class="hljs-comment">// entropy: BitVector = BitVector(256 bits, 0x38ff3f62716f0f1921466dfb9a36796af9ceb140eadfd956be8d1d6a6a927fcb)</span>
<span class="hljs-keyword">val</span> mnemonicCode = <span class="hljs-type">MnemonicCode</span>.fromEntropy(entropy)
<span class="hljs-comment">// mnemonicCode: MnemonicCode = Masked(MnemonicCodeImpl)</span>
mnemonicCode.words <span class="hljs-comment">// the phrase the user should write down</span>
<span class="hljs-comment">// res0: Vector[String] = Vector(drastic, valve, inject, almost, what, oven, narrow, brand, perfect, reward, dial, inform, excuse, conduct, phrase, wage, buzz, best, fun, broken, ceiling, belt, into, mutual) // the phrase the user should write down</span>
<span class="hljs-comment">// res0: Vector[String] = Vector(decline, wheat, sudden, tissue, valley, milk, lunar, soap, wine, spider, oxygen, sting, ostrich, flavor, admit, fossil, sun, remove, person, depart, pluck, empty, you, guide) // the phrase the user should write down</span>
<span class="hljs-comment">// the password argument is an optional, extra security</span>
<span class="hljs-comment">// measure. all MnemonicCode instances will give you a</span>
@ -108,7 +108,7 @@ mnemonicCode.words <span class="hljs-comment">// the phrase the user should writ
bip39Seed)
<span class="hljs-comment">// xpriv: ExtPrivateKey = Masked(ExtPrivateKeyImpl)</span>
<span class="hljs-keyword">val</span> xpub = xpriv.extPublicKey
<span class="hljs-comment">// xpub: ExtPublicKey = zpub6jftahH18ngZxJifsUKnjMSWY48ZBqnQiWMpv9H2PfXsdzLSFToC9xhYjtJ5VdEAAgWYfKWDC1UctGDd5f6bJdENomA2LBf6SuiHV1PvqKC</span>
<span class="hljs-comment">// xpub: ExtPublicKey = zpub6jftahH18ngZyEB6QWJtc8LUR3g4bJBC19PhdPTDDiRgtDgvxvH4REFiZWrFBScij2yLen5vbcEHTgxie12e7H6mf9tCHCXxgwPd8UqKBVZ</span>
<span class="hljs-comment">// you can now use the generated xpriv to derive further</span>
<span class="hljs-comment">// private or public keys</span>
@ -154,7 +154,7 @@ spend or steal any of your money.</p>
<span class="hljs-comment">// can generate addresses with it!</span>
accountXpriv.extPublicKey
}
<span class="hljs-comment">// accountXpub: ExtPublicKey = zpub6rJESb7HfreGdSSEBozzV4AbYNv6h1hgo3jQWoaSokLKceeYupAKpxNWifi6JqZZMyNpAC1fpKPTAXFhd9bJK8jgGzyxKgv1MXbCQWywBwn</span>
<span class="hljs-comment">// accountXpub: ExtPublicKey = zpub6rQ6ULsFKtHG6xejeL1GGF5Y2h4VoKbHdAARfragCKWaEQXp1CLzpafGcSz34nvpXp4xBcmhxVAvtFNWbk2LQUNpf5DgeedjJx1DuX1SX3X</span>
<span class="hljs-comment">// address no. 0 ---------------┐</span>
<span class="hljs-comment">// external address ----------┐ |</span>
@ -177,12 +177,12 @@ spend or steal any of your money.</p>
<span class="hljs-keyword">val</span> scriptPubKey = <span class="hljs-type">P2WPKHWitnessSPKV0</span>(pubkey)
<span class="hljs-type">Bech32Address</span>(scriptPubKey, <span class="hljs-type">TestNet3</span>)
}
<span class="hljs-comment">// firstAccountAddress: Bech32Address = tb1qaftjve8hn92ne768sv3xhn3ta960d029rs5f3w</span>
<span class="hljs-comment">// firstAccountAddress: Bech32Address = tb1qkp2rhv003f5eca380dck64x0nrs2a0hcufhqfu</span>
<span class="hljs-comment">// tada! We just generated an address you can send money to,</span>
<span class="hljs-comment">// without having access to the private key!</span>
firstAccountAddress.value
<span class="hljs-comment">// res2: String = tb1qaftjve8hn92ne768sv3xhn3ta960d029rs5f3w</span>
<span class="hljs-comment">// res2: String = tb1qkp2rhv003f5eca380dck64x0nrs2a0hcufhqfu</span>
<span class="hljs-comment">// you can now continue deriving addresses from the same public</span>
<span class="hljs-comment">// key, by imitating what we did above. To get the next</span>

36
docs/next/core/txbuilder.html
View file

@ -64,7 +64,7 @@
});
</script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/bitcoin-s/bitcoin-s/blob/master/docs/core/txbuilder.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">TxBuilder Example</h1></header><article><div><span><p>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</p>
<pre><code class="hljs css language-scala"><span class="hljs-keyword">implicit</span> <span class="hljs-keyword">val</span> ec: <span class="hljs-type">ExecutionContext</span> = <span class="hljs-type">ExecutionContext</span>.<span class="hljs-type">Implicits</span>.global
<span class="hljs-comment">// ec: ExecutionContext = scala.concurrent.impl.ExecutionContextImpl$$anon$3@292aa6d4[Running, parallelism = 2, size = 2, active = 0, running = 0, steals = 33, tasks = 0, submissions = 0]</span>
<span class="hljs-comment">// ec: ExecutionContext = scala.concurrent.impl.ExecutionContextImpl$$anon$3@265e2dfb[Running, parallelism = 2, size = 2, active = 0, running = 0, steals = 37, tasks = 0, submissions = 0]</span>
<span class="hljs-comment">// Initialize a transaction builder</span>
<span class="hljs-keyword">val</span> builder = <span class="hljs-type">RawTxBuilder</span>()
@ -74,19 +74,19 @@
<span class="hljs-keyword">val</span> privKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey
<span class="hljs-comment">// privKey: ECPrivateKey = Masked(ECPrivateKeyImpl)</span>
<span class="hljs-keyword">val</span> pubKey = privKey.publicKey
<span class="hljs-comment">// pubKey: ECPublicKey = ECPublicKey(0307500cd6e4b98efc87519d5067d6fcb17c14dc4322b5bb34f8c467ff43d41c2b)</span>
<span class="hljs-comment">// pubKey: ECPublicKey = ECPublicKey(029b31fd9c67b7f5bd1d05e4c877951182e9756963f04775236c5e4dc807224c16)</span>
<span class="hljs-comment">// this is the script that the TxBuilder is going to create a</span>
<span class="hljs-comment">// script signature that validly spends this scriptPubKey</span>
<span class="hljs-keyword">val</span> creditingSpk = <span class="hljs-type">P2PKHScriptPubKey</span>(pubKey = privKey.publicKey)
<span class="hljs-comment">// creditingSpk: P2PKHScriptPubKey = pkh(9faae24eb0bc1f2d4bd7ee462181f114db68d64c)</span>
<span class="hljs-comment">// creditingSpk: P2PKHScriptPubKey = pkh(70dfa78fcbe359c70d08914355a51b2d45d5a732)</span>
<span class="hljs-keyword">val</span> amount = <span class="hljs-number">10000.</span>satoshis
<span class="hljs-comment">// amount: Satoshis = 10000 sats</span>
<span class="hljs-comment">// this is the UTXO we are going to be spending</span>
<span class="hljs-keyword">val</span> utxo =
<span class="hljs-type">TransactionOutput</span>(value = amount, scriptPubKey = creditingSpk)
<span class="hljs-comment">// utxo: TransactionOutput = TransactionOutput(10000 sats,pkh(9faae24eb0bc1f2d4bd7ee462181f114db68d64c))</span>
<span class="hljs-comment">// utxo: TransactionOutput = TransactionOutput(10000 sats,pkh(70dfa78fcbe359c70d08914355a51b2d45d5a732))</span>
<span class="hljs-comment">// the private key that locks the funds for the script we are spending too</span>
<span class="hljs-keyword">val</span> destinationPrivKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey
@ -99,7 +99,7 @@
<span class="hljs-comment">// the script that corresponds to destination private key, this is what is receiving the money</span>
<span class="hljs-keyword">val</span> destinationSPK =
<span class="hljs-type">P2PKHScriptPubKey</span>(pubKey = destinationPrivKey.publicKey)
<span class="hljs-comment">// destinationSPK: P2PKHScriptPubKey = pkh(1f12450862cb1da220116b44a6f54b8831fcf7c6)</span>
<span class="hljs-comment">// destinationSPK: P2PKHScriptPubKey = pkh(bf7a2289ca4478e42dc3876e842f9ec903b7035c)</span>
<span class="hljs-comment">// this is where we are sending money too</span>
<span class="hljs-comment">// we could add more destinations here if we</span>
@ -110,7 +110,7 @@
<span class="hljs-type">Vector</span>(destination0)
}
<span class="hljs-comment">// destinations: Vector[TransactionOutput] = Vector(TransactionOutput(5000 sats,pkh(1f12450862cb1da220116b44a6f54b8831fcf7c6)))</span>
<span class="hljs-comment">// destinations: Vector[TransactionOutput] = Vector(TransactionOutput(5000 sats,pkh(bf7a2289ca4478e42dc3876e842f9ec903b7035c)))</span>
<span class="hljs-comment">// Add the destinations to the tx builder</span>
builder ++= destinations
@ -123,17 +123,17 @@ builder ++= destinations
inputs = <span class="hljs-type">Vector</span>.empty,
outputs = <span class="hljs-type">Vector</span>(utxo),
lockTime = <span class="hljs-type">UInt32</span>.zero)
<span class="hljs-comment">// creditingTx: BaseTransaction = BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(9faae24eb0bc1f2d4bd7ee462181f114db68d64c))),UInt32Impl(0))</span>
<span class="hljs-comment">// creditingTx: BaseTransaction = BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(70dfa78fcbe359c70d08914355a51b2d45d5a732))),UInt32Impl(0))</span>
<span class="hljs-comment">// this is the information we need from the crediting TX</span>
<span class="hljs-comment">// to properly &quot;link&quot; it in the transaction we are creating</span>
<span class="hljs-keyword">val</span> outPoint = <span class="hljs-type">TransactionOutPoint</span>(creditingTx.txId, <span class="hljs-type">UInt32</span>.zero)
<span class="hljs-comment">// outPoint: TransactionOutPoint = TransactionOutPoint(690f4b882f26014f9b01d7ab3e89da0ae3202c4c7d9e4086efb850cee9e9918c:0)</span>
<span class="hljs-comment">// outPoint: TransactionOutPoint = TransactionOutPoint(72c3e06329923b1cf3d6700631818daf1eee7b445e8493a8086e1446094dec7c:0)</span>
<span class="hljs-keyword">val</span> input = <span class="hljs-type">TransactionInput</span>(
outPoint,
<span class="hljs-type">EmptyScriptSignature</span>,
sequenceNumber = <span class="hljs-type">UInt32</span>.zero)
<span class="hljs-comment">// input: TransactionInput = TransactionInputImpl(TransactionOutPoint(690f4b882f26014f9b01d7ab3e89da0ae3202c4c7d9e4086efb850cee9e9918c:0),EmptyScriptSignature,UInt32Impl(0))</span>
<span class="hljs-comment">// input: TransactionInput = TransactionInputImpl(TransactionOutPoint(72c3e06329923b1cf3d6700631818daf1eee7b445e8493a8086e1446094dec7c:0),EmptyScriptSignature,UInt32Impl(0))</span>
<span class="hljs-comment">// Add a new input to our builder</span>
builder += input
@ -141,11 +141,11 @@ builder += input
<span class="hljs-comment">// We can now generate a RawTxBuilderResult ready to be finalized</span>
<span class="hljs-keyword">val</span> builderResult = builder.result()
<span class="hljs-comment">// builderResult: RawTxBuilderResult = RawTxBuilderResult(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(690f4b882f26014f9b01d7ab3e89da0ae3202c4c7d9e4086efb850cee9e9918c:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(1f12450862cb1da220116b44a6f54b8831fcf7c6))),UInt32Impl(0))</span>
<span class="hljs-comment">// builderResult: RawTxBuilderResult = RawTxBuilderResult(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(72c3e06329923b1cf3d6700631818daf1eee7b445e8493a8086e1446094dec7c:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(bf7a2289ca4478e42dc3876e842f9ec903b7035c))),UInt32Impl(0))</span>
<span class="hljs-comment">// this contains the information needed to analyze our input during finalization</span>
<span class="hljs-keyword">val</span> inputInfo = <span class="hljs-type">P2PKHInputInfo</span>(outPoint, amount, privKey.publicKey)
<span class="hljs-comment">// inputInfo: P2PKHInputInfo = P2PKHInputInfo(TransactionOutPoint(690f4b882f26014f9b01d7ab3e89da0ae3202c4c7d9e4086efb850cee9e9918c:0),10000 sats,ECPublicKey(0307500cd6e4b98efc87519d5067d6fcb17c14dc4322b5bb34f8c467ff43d41c2b))</span>
<span class="hljs-comment">// inputInfo: P2PKHInputInfo = P2PKHInputInfo(TransactionOutPoint(72c3e06329923b1cf3d6700631818daf1eee7b445e8493a8086e1446094dec7c:0),10000 sats,ECPublicKey(029b31fd9c67b7f5bd1d05e4c877951182e9756963f04775236c5e4dc807224c16))</span>
<span class="hljs-comment">// this is how much we are going to pay as a fee to the network</span>
<span class="hljs-comment">// for this example, we are going to pay 1 satoshi per byte</span>
@ -155,18 +155,18 @@ builder += input
<span class="hljs-keyword">val</span> changePrivKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey
<span class="hljs-comment">// changePrivKey: ECPrivateKey = Masked(ECPrivateKeyImpl)</span>
<span class="hljs-keyword">val</span> changeSPK = <span class="hljs-type">P2PKHScriptPubKey</span>(pubKey = changePrivKey.publicKey)
<span class="hljs-comment">// changeSPK: P2PKHScriptPubKey = pkh(7cda083da67087edd7de2f1437973ad2f168e994)</span>
<span class="hljs-comment">// changeSPK: P2PKHScriptPubKey = pkh(96f51bc363aecf04785f8923eb31082331bce04e)</span>
<span class="hljs-comment">// We chose a finalizer that adds a change output to our tx based on a fee rate</span>
<span class="hljs-keyword">val</span> finalizer = <span class="hljs-type">StandardNonInteractiveFinalizer</span>(
<span class="hljs-type">Vector</span>(inputInfo),
feeRate,
changeSPK)
<span class="hljs-comment">// finalizer: StandardNonInteractiveFinalizer = StandardNonInteractiveFinalizer(Vector(P2PKHInputInfo(TransactionOutPoint(690f4b882f26014f9b01d7ab3e89da0ae3202c4c7d9e4086efb850cee9e9918c:0),10000 sats,ECPublicKey(0307500cd6e4b98efc87519d5067d6fcb17c14dc4322b5bb34f8c467ff43d41c2b))),1 sats/byte,pkh(7cda083da67087edd7de2f1437973ad2f168e994))</span>
<span class="hljs-comment">// finalizer: StandardNonInteractiveFinalizer = StandardNonInteractiveFinalizer(Vector(P2PKHInputInfo(TransactionOutPoint(72c3e06329923b1cf3d6700631818daf1eee7b445e8493a8086e1446094dec7c:0),10000 sats,ECPublicKey(029b31fd9c67b7f5bd1d05e4c877951182e9756963f04775236c5e4dc807224c16))),1 sats/byte,pkh(96f51bc363aecf04785f8923eb31082331bce04e))</span>
<span class="hljs-comment">// We can now finalize the tx builder result from earlier with this finalizer</span>
<span class="hljs-keyword">val</span> unsignedTxF: <span class="hljs-type">Future</span>[<span class="hljs-type">Transaction</span>] = finalizer.buildTx(builderResult)
<span class="hljs-comment">// 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))))</span>
<span class="hljs-comment">// 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))))</span>
<span class="hljs-comment">// We now turn to signing the unsigned transaction</span>
<span class="hljs-comment">// this contains all the information we need to</span>
@ -176,12 +176,12 @@ builder += input
signers = <span class="hljs-type">Vector</span>(privKey),
hashType =
<span class="hljs-type">HashType</span>.sigHashAll)
<span class="hljs-comment">// 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)))</span>
<span class="hljs-comment">// 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)))</span>
<span class="hljs-comment">// all of the UTXO spending information, since we only have</span>
<span class="hljs-comment">// one input, this is just one element</span>
<span class="hljs-keyword">val</span> utxoInfos: <span class="hljs-type">Vector</span>[<span class="hljs-type">ScriptSignatureParams</span>[<span class="hljs-type">InputInfo</span>]] = <span class="hljs-type">Vector</span>(utxoInfo)
<span class="hljs-comment">// 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))))</span>
<span class="hljs-comment">// 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))))</span>
<span class="hljs-comment">// Yay! Now we use the RawTxSigner object to sign the tx.</span>
<span class="hljs-comment">// The &#x27;sign&#x27; method is going produce a validly signed transaction</span>
@ -201,7 +201,7 @@ builder += input
}
<span class="hljs-type">Await</span>.result(signedTxF, <span class="hljs-number">30.</span>seconds)
}
<span class="hljs-comment">// 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))</span>
<span class="hljs-comment">// 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))</span>
</code></pre>
<pre><code class="hljs css language-scala">signedTx.inputs.length
<span class="hljs-comment">// res2: Int = 1</span>
@ -211,7 +211,7 @@ signedTx.outputs.length
<span class="hljs-comment">//remember, you can call .hex on any bitcoin-s data structure to get the hex representation!</span>
signedTx.hex
<span class="hljs-comment">// res4: String = 02000000018c91e9e9ce50b8ef86409e7d4c2c20e30ada893eabd7019b4f01262f884b0f69000000006a4730440220231f86db9d3728e6e2ad719f84b9708f45f4b492174f6c141f13fd1458df6b12022078f3c73e205d45e8a4dcdc3d77266427c5901243a7d1149c513b9c4f55a083fb01210307500cd6e4b98efc87519d5067d6fcb17c14dc4322b5bb34f8c467ff43d41c2b000000000288130000000000001976a9141f12450862cb1da220116b44a6f54b8831fcf7c688aca7120000000000001976a9147cda083da67087edd7de2f1437973ad2f168e99488ac00000000</span>
<span class="hljs-comment">// res4: String = 02000000017cec4d0946146e08a893845e447bee1eaf8d81310670d6f31c3b922963e0c372000000006a47304402202019d6e21648a0eae337ac8c4246913a66d86aed97b1c51c7ad1789f26d2ccc20220077b1ff1793b51b40525562df4b801e7626232b27a89bbf811252bb80c5e83590121029b31fd9c67b7f5bd1d05e4c877951182e9756963f04775236c5e4dc807224c16000000000288130000000000001976a914bf7a2289ca4478e42dc3876e842f9ec903b7035c88aca7120000000000001976a91496f51bc363aecf04785f8923eb31082331bce04e88ac00000000</span>
</code></pre>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/next/core/psbts"><span class="arrow-prev">← </span><span>Partially Signed Bitcoin Transactions</span></a><a class="docs-next button" href="/docs/next/core/lightning-network"><span>Lightning Network Data Types</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/favicon.ico" alt="bitcoin-s" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/getting-started">Getting Started</a><a href="/docs/en/core/core-intro">Guides</a><a href="/api/org/bitcoins">API Reference</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="https://join.slack.com/t/suredbits/shared_invite/zt-eavycu0x-WQL7XOakzQo8tAy7jHHZUw" target="_blank" rel="noreferrer noopener">Slack</a><a href="https://gitter.im/bitcoin-s-core/">Gitter chat</a></div><div><h5>More</h5><a href="https://github.com/bitcoin-s/bitcoin-s">GitHub</a><a class="github-button" href="https://github.com/bitcoin-s/bitcoin-s" data-icon="octicon-star" data-count-href="/bitcoin-s/bitcoin-s-core/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2021 Suredbits &amp; the bitcoin-s developers</section></footer></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script><script>
document.addEventListener('keyup', function(e) {

36
docs/next/core/txbuilder/index.html
View file

@ -64,7 +64,7 @@
});
</script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/bitcoin-s/bitcoin-s/blob/master/docs/core/txbuilder.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">TxBuilder Example</h1></header><article><div><span><p>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</p>
<pre><code class="hljs css language-scala"><span class="hljs-keyword">implicit</span> <span class="hljs-keyword">val</span> ec: <span class="hljs-type">ExecutionContext</span> = <span class="hljs-type">ExecutionContext</span>.<span class="hljs-type">Implicits</span>.global
<span class="hljs-comment">// ec: ExecutionContext = scala.concurrent.impl.ExecutionContextImpl$$anon$3@292aa6d4[Running, parallelism = 2, size = 2, active = 0, running = 0, steals = 33, tasks = 0, submissions = 0]</span>
<span class="hljs-comment">// ec: ExecutionContext = scala.concurrent.impl.ExecutionContextImpl$$anon$3@265e2dfb[Running, parallelism = 2, size = 2, active = 0, running = 0, steals = 37, tasks = 0, submissions = 0]</span>
<span class="hljs-comment">// Initialize a transaction builder</span>
<span class="hljs-keyword">val</span> builder = <span class="hljs-type">RawTxBuilder</span>()
@ -74,19 +74,19 @@
<span class="hljs-keyword">val</span> privKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey
<span class="hljs-comment">// privKey: ECPrivateKey = Masked(ECPrivateKeyImpl)</span>
<span class="hljs-keyword">val</span> pubKey = privKey.publicKey
<span class="hljs-comment">// pubKey: ECPublicKey = ECPublicKey(0307500cd6e4b98efc87519d5067d6fcb17c14dc4322b5bb34f8c467ff43d41c2b)</span>
<span class="hljs-comment">// pubKey: ECPublicKey = ECPublicKey(029b31fd9c67b7f5bd1d05e4c877951182e9756963f04775236c5e4dc807224c16)</span>
<span class="hljs-comment">// this is the script that the TxBuilder is going to create a</span>
<span class="hljs-comment">// script signature that validly spends this scriptPubKey</span>
<span class="hljs-keyword">val</span> creditingSpk = <span class="hljs-type">P2PKHScriptPubKey</span>(pubKey = privKey.publicKey)
<span class="hljs-comment">// creditingSpk: P2PKHScriptPubKey = pkh(9faae24eb0bc1f2d4bd7ee462181f114db68d64c)</span>
<span class="hljs-comment">// creditingSpk: P2PKHScriptPubKey = pkh(70dfa78fcbe359c70d08914355a51b2d45d5a732)</span>
<span class="hljs-keyword">val</span> amount = <span class="hljs-number">10000.</span>satoshis
<span class="hljs-comment">// amount: Satoshis = 10000 sats</span>
<span class="hljs-comment">// this is the UTXO we are going to be spending</span>
<span class="hljs-keyword">val</span> utxo =
<span class="hljs-type">TransactionOutput</span>(value = amount, scriptPubKey = creditingSpk)
<span class="hljs-comment">// utxo: TransactionOutput = TransactionOutput(10000 sats,pkh(9faae24eb0bc1f2d4bd7ee462181f114db68d64c))</span>
<span class="hljs-comment">// utxo: TransactionOutput = TransactionOutput(10000 sats,pkh(70dfa78fcbe359c70d08914355a51b2d45d5a732))</span>
<span class="hljs-comment">// the private key that locks the funds for the script we are spending too</span>
<span class="hljs-keyword">val</span> destinationPrivKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey
@ -99,7 +99,7 @@
<span class="hljs-comment">// the script that corresponds to destination private key, this is what is receiving the money</span>
<span class="hljs-keyword">val</span> destinationSPK =
<span class="hljs-type">P2PKHScriptPubKey</span>(pubKey = destinationPrivKey.publicKey)
<span class="hljs-comment">// destinationSPK: P2PKHScriptPubKey = pkh(1f12450862cb1da220116b44a6f54b8831fcf7c6)</span>
<span class="hljs-comment">// destinationSPK: P2PKHScriptPubKey = pkh(bf7a2289ca4478e42dc3876e842f9ec903b7035c)</span>
<span class="hljs-comment">// this is where we are sending money too</span>
<span class="hljs-comment">// we could add more destinations here if we</span>
@ -110,7 +110,7 @@
<span class="hljs-type">Vector</span>(destination0)
}
<span class="hljs-comment">// destinations: Vector[TransactionOutput] = Vector(TransactionOutput(5000 sats,pkh(1f12450862cb1da220116b44a6f54b8831fcf7c6)))</span>
<span class="hljs-comment">// destinations: Vector[TransactionOutput] = Vector(TransactionOutput(5000 sats,pkh(bf7a2289ca4478e42dc3876e842f9ec903b7035c)))</span>
<span class="hljs-comment">// Add the destinations to the tx builder</span>
builder ++= destinations
@ -123,17 +123,17 @@ builder ++= destinations
inputs = <span class="hljs-type">Vector</span>.empty,
outputs = <span class="hljs-type">Vector</span>(utxo),
lockTime = <span class="hljs-type">UInt32</span>.zero)
<span class="hljs-comment">// creditingTx: BaseTransaction = BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(9faae24eb0bc1f2d4bd7ee462181f114db68d64c))),UInt32Impl(0))</span>
<span class="hljs-comment">// creditingTx: BaseTransaction = BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(70dfa78fcbe359c70d08914355a51b2d45d5a732))),UInt32Impl(0))</span>
<span class="hljs-comment">// this is the information we need from the crediting TX</span>
<span class="hljs-comment">// to properly &quot;link&quot; it in the transaction we are creating</span>
<span class="hljs-keyword">val</span> outPoint = <span class="hljs-type">TransactionOutPoint</span>(creditingTx.txId, <span class="hljs-type">UInt32</span>.zero)
<span class="hljs-comment">// outPoint: TransactionOutPoint = TransactionOutPoint(690f4b882f26014f9b01d7ab3e89da0ae3202c4c7d9e4086efb850cee9e9918c:0)</span>
<span class="hljs-comment">// outPoint: TransactionOutPoint = TransactionOutPoint(72c3e06329923b1cf3d6700631818daf1eee7b445e8493a8086e1446094dec7c:0)</span>
<span class="hljs-keyword">val</span> input = <span class="hljs-type">TransactionInput</span>(
outPoint,
<span class="hljs-type">EmptyScriptSignature</span>,
sequenceNumber = <span class="hljs-type">UInt32</span>.zero)
<span class="hljs-comment">// input: TransactionInput = TransactionInputImpl(TransactionOutPoint(690f4b882f26014f9b01d7ab3e89da0ae3202c4c7d9e4086efb850cee9e9918c:0),EmptyScriptSignature,UInt32Impl(0))</span>
<span class="hljs-comment">// input: TransactionInput = TransactionInputImpl(TransactionOutPoint(72c3e06329923b1cf3d6700631818daf1eee7b445e8493a8086e1446094dec7c:0),EmptyScriptSignature,UInt32Impl(0))</span>
<span class="hljs-comment">// Add a new input to our builder</span>
builder += input
@ -141,11 +141,11 @@ builder += input
<span class="hljs-comment">// We can now generate a RawTxBuilderResult ready to be finalized</span>
<span class="hljs-keyword">val</span> builderResult = builder.result()
<span class="hljs-comment">// builderResult: RawTxBuilderResult = RawTxBuilderResult(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(690f4b882f26014f9b01d7ab3e89da0ae3202c4c7d9e4086efb850cee9e9918c:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(1f12450862cb1da220116b44a6f54b8831fcf7c6))),UInt32Impl(0))</span>
<span class="hljs-comment">// builderResult: RawTxBuilderResult = RawTxBuilderResult(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(72c3e06329923b1cf3d6700631818daf1eee7b445e8493a8086e1446094dec7c:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(bf7a2289ca4478e42dc3876e842f9ec903b7035c))),UInt32Impl(0))</span>
<span class="hljs-comment">// this contains the information needed to analyze our input during finalization</span>
<span class="hljs-keyword">val</span> inputInfo = <span class="hljs-type">P2PKHInputInfo</span>(outPoint, amount, privKey.publicKey)
<span class="hljs-comment">// inputInfo: P2PKHInputInfo = P2PKHInputInfo(TransactionOutPoint(690f4b882f26014f9b01d7ab3e89da0ae3202c4c7d9e4086efb850cee9e9918c:0),10000 sats,ECPublicKey(0307500cd6e4b98efc87519d5067d6fcb17c14dc4322b5bb34f8c467ff43d41c2b))</span>
<span class="hljs-comment">// inputInfo: P2PKHInputInfo = P2PKHInputInfo(TransactionOutPoint(72c3e06329923b1cf3d6700631818daf1eee7b445e8493a8086e1446094dec7c:0),10000 sats,ECPublicKey(029b31fd9c67b7f5bd1d05e4c877951182e9756963f04775236c5e4dc807224c16))</span>
<span class="hljs-comment">// this is how much we are going to pay as a fee to the network</span>
<span class="hljs-comment">// for this example, we are going to pay 1 satoshi per byte</span>
@ -155,18 +155,18 @@ builder += input
<span class="hljs-keyword">val</span> changePrivKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey
<span class="hljs-comment">// changePrivKey: ECPrivateKey = Masked(ECPrivateKeyImpl)</span>
<span class="hljs-keyword">val</span> changeSPK = <span class="hljs-type">P2PKHScriptPubKey</span>(pubKey = changePrivKey.publicKey)
<span class="hljs-comment">// changeSPK: P2PKHScriptPubKey = pkh(7cda083da67087edd7de2f1437973ad2f168e994)</span>
<span class="hljs-comment">// changeSPK: P2PKHScriptPubKey = pkh(96f51bc363aecf04785f8923eb31082331bce04e)</span>
<span class="hljs-comment">// We chose a finalizer that adds a change output to our tx based on a fee rate</span>
<span class="hljs-keyword">val</span> finalizer = <span class="hljs-type">StandardNonInteractiveFinalizer</span>(
<span class="hljs-type">Vector</span>(inputInfo),
feeRate,
changeSPK)
<span class="hljs-comment">// finalizer: StandardNonInteractiveFinalizer = StandardNonInteractiveFinalizer(Vector(P2PKHInputInfo(TransactionOutPoint(690f4b882f26014f9b01d7ab3e89da0ae3202c4c7d9e4086efb850cee9e9918c:0),10000 sats,ECPublicKey(0307500cd6e4b98efc87519d5067d6fcb17c14dc4322b5bb34f8c467ff43d41c2b))),1 sats/byte,pkh(7cda083da67087edd7de2f1437973ad2f168e994))</span>
<span class="hljs-comment">// finalizer: StandardNonInteractiveFinalizer = StandardNonInteractiveFinalizer(Vector(P2PKHInputInfo(TransactionOutPoint(72c3e06329923b1cf3d6700631818daf1eee7b445e8493a8086e1446094dec7c:0),10000 sats,ECPublicKey(029b31fd9c67b7f5bd1d05e4c877951182e9756963f04775236c5e4dc807224c16))),1 sats/byte,pkh(96f51bc363aecf04785f8923eb31082331bce04e))</span>
<span class="hljs-comment">// We can now finalize the tx builder result from earlier with this finalizer</span>
<span class="hljs-keyword">val</span> unsignedTxF: <span class="hljs-type">Future</span>[<span class="hljs-type">Transaction</span>] = finalizer.buildTx(builderResult)
<span class="hljs-comment">// 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))))</span>
<span class="hljs-comment">// 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))))</span>
<span class="hljs-comment">// We now turn to signing the unsigned transaction</span>
<span class="hljs-comment">// this contains all the information we need to</span>
@ -176,12 +176,12 @@ builder += input
signers = <span class="hljs-type">Vector</span>(privKey),
hashType =
<span class="hljs-type">HashType</span>.sigHashAll)
<span class="hljs-comment">// 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)))</span>
<span class="hljs-comment">// 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)))</span>
<span class="hljs-comment">// all of the UTXO spending information, since we only have</span>
<span class="hljs-comment">// one input, this is just one element</span>
<span class="hljs-keyword">val</span> utxoInfos: <span class="hljs-type">Vector</span>[<span class="hljs-type">ScriptSignatureParams</span>[<span class="hljs-type">InputInfo</span>]] = <span class="hljs-type">Vector</span>(utxoInfo)
<span class="hljs-comment">// 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))))</span>
<span class="hljs-comment">// 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))))</span>
<span class="hljs-comment">// Yay! Now we use the RawTxSigner object to sign the tx.</span>
<span class="hljs-comment">// The &#x27;sign&#x27; method is going produce a validly signed transaction</span>
@ -201,7 +201,7 @@ builder += input
}
<span class="hljs-type">Await</span>.result(signedTxF, <span class="hljs-number">30.</span>seconds)
}
<span class="hljs-comment">// 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))</span>
<span class="hljs-comment">// 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))</span>
</code></pre>
<pre><code class="hljs css language-scala">signedTx.inputs.length
<span class="hljs-comment">// res2: Int = 1</span>
@ -211,7 +211,7 @@ signedTx.outputs.length
<span class="hljs-comment">//remember, you can call .hex on any bitcoin-s data structure to get the hex representation!</span>
signedTx.hex
<span class="hljs-comment">// res4: String = 02000000018c91e9e9ce50b8ef86409e7d4c2c20e30ada893eabd7019b4f01262f884b0f69000000006a4730440220231f86db9d3728e6e2ad719f84b9708f45f4b492174f6c141f13fd1458df6b12022078f3c73e205d45e8a4dcdc3d77266427c5901243a7d1149c513b9c4f55a083fb01210307500cd6e4b98efc87519d5067d6fcb17c14dc4322b5bb34f8c467ff43d41c2b000000000288130000000000001976a9141f12450862cb1da220116b44a6f54b8831fcf7c688aca7120000000000001976a9147cda083da67087edd7de2f1437973ad2f168e99488ac00000000</span>
<span class="hljs-comment">// res4: String = 02000000017cec4d0946146e08a893845e447bee1eaf8d81310670d6f31c3b922963e0c372000000006a47304402202019d6e21648a0eae337ac8c4246913a66d86aed97b1c51c7ad1789f26d2ccc20220077b1ff1793b51b40525562df4b801e7626232b27a89bbf811252bb80c5e83590121029b31fd9c67b7f5bd1d05e4c877951182e9756963f04775236c5e4dc807224c16000000000288130000000000001976a914bf7a2289ca4478e42dc3876e842f9ec903b7035c88aca7120000000000001976a91496f51bc363aecf04785f8923eb31082331bce04e88ac00000000</span>
</code></pre>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/next/core/psbts"><span class="arrow-prev">← </span><span>Partially Signed Bitcoin Transactions</span></a><a class="docs-next button" href="/docs/next/core/lightning-network"><span>Lightning Network Data Types</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/favicon.ico" alt="bitcoin-s" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/getting-started">Getting Started</a><a href="/docs/en/core/core-intro">Guides</a><a href="/api/org/bitcoins">API Reference</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="https://join.slack.com/t/suredbits/shared_invite/zt-eavycu0x-WQL7XOakzQo8tAy7jHHZUw" target="_blank" rel="noreferrer noopener">Slack</a><a href="https://gitter.im/bitcoin-s-core/">Gitter chat</a></div><div><h5>More</h5><a href="https://github.com/bitcoin-s/bitcoin-s">GitHub</a><a class="github-button" href="https://github.com/bitcoin-s/bitcoin-s" data-icon="octicon-star" data-count-href="/bitcoin-s/bitcoin-s-core/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2021 Suredbits &amp; the bitcoin-s developers</section></footer></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script><script>
document.addEventListener('keyup', function(e) {

4
docs/next/crypto/sign.html
View file

@ -96,13 +96,13 @@
<span class="hljs-comment">// extPrivKey: ExtPrivateKey = Masked(ExtPrivateKeyImpl)</span>
extPrivKey.sign(<span class="hljs-type">DoubleSha256Digest</span>.empty.bytes)
<span class="hljs-comment">// res0: ECDigitalSignature = ECDigitalSignature(3044022033603cf288ed1d220419b574ae429581733af5ba36d1eb5ef77d37e8971ac5d002204fdf6aff6f1a52694569cdbed95c3d6262662bffb2210ead242d66b219f79ab1)</span>
<span class="hljs-comment">// res0: ECDigitalSignature = ECDigitalSignature(30440220572ec8e045a5db64db895cbf585866c2c9f903c1b36a4df2cc432225de7b505802205ee5e5415f06f66fa0b347a15ce02836f5b78707ff8577c0ddc6727fb188d268)</span>
<span class="hljs-keyword">val</span> path = <span class="hljs-type">BIP32Path</span>(<span class="hljs-type">Vector</span>(<span class="hljs-type">BIP32Node</span>(<span class="hljs-number">0</span>,<span class="hljs-literal">false</span>)))
<span class="hljs-comment">// path: BIP32Path = m/0</span>
extPrivKey.sign(<span class="hljs-type">DoubleSha256Digest</span>.empty.bytes,path)
<span class="hljs-comment">// res1: ECDigitalSignature = ECDigitalSignature(3044022054ddadce370268c8ba7fcb8984116ad964f3b7178de108b27938270184cbada4022066e9dafb49ba189a4c64e6366e1d9cc947fc22a5ac1f7dcda0e45013715cadc5)</span>
<span class="hljs-comment">// res1: ECDigitalSignature = ECDigitalSignature(3044022018dce8434b5aa02a65d8ed8476f74a30fbbeb55dc665e00a45b395858cb18dea0220161e29ef1b028a5fdeb1a22be2e347340563621e13c11386e65bea2bbc2453f7)</span>
</code></pre>
<p>With <code>ExtSign</code>, you can use <code>ExtPrivateKey</code> to sign transactions inside of <code>TxBuilder</code> since <code>UTXOSpendingInfo</code> takes in <code>Sign</code> as a parameter.</p>
<p>You can also provide a <code>path</code> to use to derive a child <code>ExtPrivateKey</code>, and then sign with that child private key</p>

4
docs/next/crypto/sign/index.html
View file

@ -96,13 +96,13 @@
<span class="hljs-comment">// extPrivKey: ExtPrivateKey = Masked(ExtPrivateKeyImpl)</span>
extPrivKey.sign(<span class="hljs-type">DoubleSha256Digest</span>.empty.bytes)
<span class="hljs-comment">// res0: ECDigitalSignature = ECDigitalSignature(3044022033603cf288ed1d220419b574ae429581733af5ba36d1eb5ef77d37e8971ac5d002204fdf6aff6f1a52694569cdbed95c3d6262662bffb2210ead242d66b219f79ab1)</span>
<span class="hljs-comment">// res0: ECDigitalSignature = ECDigitalSignature(30440220572ec8e045a5db64db895cbf585866c2c9f903c1b36a4df2cc432225de7b505802205ee5e5415f06f66fa0b347a15ce02836f5b78707ff8577c0ddc6727fb188d268)</span>
<span class="hljs-keyword">val</span> path = <span class="hljs-type">BIP32Path</span>(<span class="hljs-type">Vector</span>(<span class="hljs-type">BIP32Node</span>(<span class="hljs-number">0</span>,<span class="hljs-literal">false</span>)))
<span class="hljs-comment">// path: BIP32Path = m/0</span>
extPrivKey.sign(<span class="hljs-type">DoubleSha256Digest</span>.empty.bytes,path)
<span class="hljs-comment">// res1: ECDigitalSignature = ECDigitalSignature(3044022054ddadce370268c8ba7fcb8984116ad964f3b7178de108b27938270184cbada4022066e9dafb49ba189a4c64e6366e1d9cc947fc22a5ac1f7dcda0e45013715cadc5)</span>
<span class="hljs-comment">// res1: ECDigitalSignature = ECDigitalSignature(3044022018dce8434b5aa02a65d8ed8476f74a30fbbeb55dc665e00a45b395858cb18dea0220161e29ef1b028a5fdeb1a22be2e347340563621e13c11386e65bea2bbc2453f7)</span>
</code></pre>
<p>With <code>ExtSign</code>, you can use <code>ExtPrivateKey</code> to sign transactions inside of <code>TxBuilder</code> since <code>UTXOSpendingInfo</code> takes in <code>Sign</code> as a parameter.</p>
<p>You can also provide a <code>path</code> to use to derive a child <code>ExtPrivateKey</code>, and then sign with that child private key</p>

2
docs/next/getting-started.html
View file

@ -120,7 +120,7 @@ libraryDependencies += <span class="hljs-string">&quot;org.bitcoin-s&quot;</span
<h3><a class="anchor" aria-hidden="true" id="nightly-builds"></a><a href="#nightly-builds" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Nightly builds</h3>
<p>You can also run on the bleeding edge of Bitcoin-S, by
adding a snapshot build to your <code>build.sbt</code>. The most
recent snapshot published is <code>0.4.0+256-827f0f3b-SNAPSHOT</code>.</p>
recent snapshot published is <code>0.4.0+259-36b5fc14-SNAPSHOT</code>.</p>
<p>To fetch snapshots, you will need to add the correct
resolver in your <code>build.sbt</code>:</p>
<pre><code class="hljs css language-sbt">resolvers += Resolver.sonatypeRepo(<span class="hljs-string">&quot;snapshots&quot;</span>)

2
docs/next/getting-started/index.html
View file

@ -120,7 +120,7 @@ libraryDependencies += <span class="hljs-string">&quot;org.bitcoin-s&quot;</span
<h3><a class="anchor" aria-hidden="true" id="nightly-builds"></a><a href="#nightly-builds" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Nightly builds</h3>
<p>You can also run on the bleeding edge of Bitcoin-S, by
adding a snapshot build to your <code>build.sbt</code>. The most
recent snapshot published is <code>0.4.0+256-827f0f3b-SNAPSHOT</code>.</p>
recent snapshot published is <code>0.4.0+259-36b5fc14-SNAPSHOT</code>.</p>
<p>To fetch snapshots, you will need to add the correct
resolver in your <code>build.sbt</code>:</p>
<pre><code class="hljs css language-sbt">resolvers += Resolver.sonatypeRepo(<span class="hljs-string">&quot;snapshots&quot;</span>)

22
docs/next/key-manager/key-manager.html
View file

@ -77,14 +77,14 @@
<span class="hljs-comment">//get 256 bits of random entropy</span>
<span class="hljs-keyword">val</span> entropy = <span class="hljs-type">MnemonicCode</span>.getEntropy256Bits
<span class="hljs-comment">// entropy: scodec.bits.BitVector = BitVector(256 bits, 0xd8f07d175581c69a710d0e565d5c6610d41f0ad78e9ab5e89a7d803e40743b6a)</span>
<span class="hljs-comment">// entropy: scodec.bits.BitVector = BitVector(256 bits, 0x2b3fd382cc71c275461610dd0e2481659eb7c4e954ea916103089eb1c6c65d06)</span>
<span class="hljs-keyword">val</span> mnemonic = <span class="hljs-type">MnemonicCode</span>.fromEntropy(entropy)
<span class="hljs-comment">// mnemonic: MnemonicCode = Masked(MnemonicCodeImpl)</span>
<span class="hljs-comment">//you can print that mnemonic seed with this</span>
println(mnemonic.words)
<span class="hljs-comment">// Vector(suggest, loop, easy, prison, broccoli, essay, service, peace, film, turtle, book, canvas, draft, lyrics, funny, spy, remove, dynamic, panda, about, tomato, deliver, unit, elegant)</span>
<span class="hljs-comment">// Vector(clinic, write, thing, ocean, bring, deny, blue, search, tackle, illness, cake, sleep, twin, tiny, pipe, outer, multiply, amount, season, dice, broccoli, glimpse, inject, spend)</span>
</code></pre>
<p>Now that we have a <code>MnemonicCode</code> that was securely generated, we need to now create <code>KeyManagerParams</code> which tells us how to generate
generate specific kinds of addresses for wallets.</p>
@ -99,7 +99,7 @@ generate specific kinds of addresses for wallets.</p>
<pre><code class="hljs css language-scala"><span class="hljs-comment">//this will create a temp directory with the prefix &#x27;key-manager-example` that will</span>
<span class="hljs-comment">//have a file in it called &quot;encrypted-bitcoin-s-seed.json&quot;</span>
<span class="hljs-keyword">val</span> seedPath = <span class="hljs-type">Files</span>.createTempDirectory(<span class="hljs-string">&quot;key-manager-example&quot;</span>).resolve(<span class="hljs-type">WalletStorage</span>.<span class="hljs-type">ENCRYPTED_SEED_FILE_NAME</span>)
<span class="hljs-comment">// seedPath: Path = /tmp/key-manager-example578437178971179166/encrypted-bitcoin-s-seed.json</span>
<span class="hljs-comment">// seedPath: Path = /tmp/key-manager-example5044004744055868046/encrypted-bitcoin-s-seed.json</span>
<span class="hljs-comment">//let&#x27;s create a native segwit key manager</span>
<span class="hljs-keyword">val</span> purpose = <span class="hljs-type">HDPurposes</span>.<span class="hljs-type">SegWit</span>
@ -110,19 +110,19 @@ generate specific kinds of addresses for wallets.</p>
<span class="hljs-comment">// network: RegTest.type = RegTest</span>
<span class="hljs-keyword">val</span> kmParams = <span class="hljs-type">KeyManagerParams</span>(seedPath, purpose, network)
<span class="hljs-comment">// kmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example578437178971179166/encrypted-bitcoin-s-seed.json,m/84&#x27;,RegTest)</span>
<span class="hljs-comment">// kmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example5044004744055868046/encrypted-bitcoin-s-seed.json,m/84&#x27;,RegTest)</span>
<span class="hljs-keyword">val</span> aesPasswordOpt = <span class="hljs-type">Some</span>(<span class="hljs-type">AesPassword</span>.fromString(<span class="hljs-string">&quot;password&quot;</span>))
<span class="hljs-comment">// aesPasswordOpt: Some[AesPassword] = Some(Masked(AesPassword))</span>
<span class="hljs-keyword">val</span> km = <span class="hljs-type">BIP39KeyManager</span>.initializeWithMnemonic(aesPasswordOpt, mnemonic, <span class="hljs-type">None</span>, kmParams)
<span class="hljs-comment">// km: Either[KeyManagerInitializeError, BIP39KeyManager] = Right(org.bitcoins.keymanager.bip39.BIP39KeyManager@3415885a)</span>
<span class="hljs-comment">// km: Either[KeyManagerInitializeError, BIP39KeyManager] = Right(org.bitcoins.keymanager.bip39.BIP39KeyManager@2a685bfa)</span>
<span class="hljs-keyword">val</span> rootXPub = km.right.get.getRootXPub
<span class="hljs-comment">// rootXPub: ExtPublicKey = vpub5SLqN2bLY4WeYxrtP8E31evEBKihKc9NXr2rPRfJ9AKBX89aR6FFq2P2GHmkRHyAfQYpuHLZw9tFqpS8DXYBMMeeYmZ8sHHVXGX67DztDqQ</span>
<span class="hljs-comment">// rootXPub: ExtPublicKey = vpub5SLqN2bLY4WeaEzYatyXKcTCMvEfCkoRfAohwc2Exwj3HE3A4ZrcexKCiMqJ1av56vzYJ2HTGu9kysUr6yEzfU4UPxYy93SkLWYnQVGNUUs</span>
println(rootXPub)
<span class="hljs-comment">// vpub5SLqN2bLY4WeYxrtP8E31evEBKihKc9NXr2rPRfJ9AKBX89aR6FFq2P2GHmkRHyAfQYpuHLZw9tFqpS8DXYBMMeeYmZ8sHHVXGX67DztDqQ</span>
<span class="hljs-comment">// vpub5SLqN2bLY4WeaEzYatyXKcTCMvEfCkoRfAohwc2Exwj3HE3A4ZrcexKCiMqJ1av56vzYJ2HTGu9kysUr6yEzfU4UPxYy93SkLWYnQVGNUUs</span>
</code></pre>
<p>Which should print something that looks like this</p>
<p><code>vpub5SLqN2bLY4WeXxMqwJHJFBEwxSscGB2uDUnsTS3edVjZEwTrQDFDNqoR2xLqARQPabGaXsHSTenTRcqm2EnB9MpuC4vSk3LqSgNmGGZtuq7</code></p>
@ -131,17 +131,17 @@ println(rootXPub)
again after initializing it once. You can use the same <code>mnemonic</code> for different networks, which you control <code>KeyManagerParams</code>.</p>
<pre><code class="hljs css language-scala"><span class="hljs-comment">//let&#x27;s create a nested segwit key manager for mainnet</span>
<span class="hljs-keyword">val</span> mainnetKmParams = <span class="hljs-type">KeyManagerParams</span>(seedPath, <span class="hljs-type">HDPurposes</span>.<span class="hljs-type">SegWit</span>, <span class="hljs-type">MainNet</span>)
<span class="hljs-comment">// mainnetKmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example578437178971179166/encrypted-bitcoin-s-seed.json,m/84&#x27;,MainNet)</span>
<span class="hljs-comment">// mainnetKmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example5044004744055868046/encrypted-bitcoin-s-seed.json,m/84&#x27;,MainNet)</span>
<span class="hljs-comment">//we do not need to all `initializeWithMnemonic()` again as we have saved the seed to dis</span>
<span class="hljs-keyword">val</span> mainnetKeyManager = <span class="hljs-type">BIP39KeyManager</span>.fromMnemonic(mnemonic, mainnetKmParams, <span class="hljs-type">None</span>, <span class="hljs-type">Instant</span>.now)
<span class="hljs-comment">// mainnetKeyManager: BIP39KeyManager = org.bitcoins.keymanager.bip39.BIP39KeyManager@598e2339</span>
<span class="hljs-comment">// mainnetKeyManager: BIP39KeyManager = org.bitcoins.keymanager.bip39.BIP39KeyManager@1ff9cefe</span>
<span class="hljs-keyword">val</span> mainnetXpub = mainnetKeyManager.getRootXPub
<span class="hljs-comment">// mainnetXpub: ExtPublicKey = zpub6jftahH18ngZx9dMiZNXr1JEsCJV667NCJ7jX1EqfBphjXQVRiuWKH1aM7c6QvarHy23uBiomoJTNxtP6KCEYJP428LqCvZScAmffc6nFkf</span>
<span class="hljs-comment">// mainnetXpub: ExtPublicKey = zpub6jftahH18ngZyRm1vL829xqD3npSyEmRKctb5BbnUyEZVdJ55CWs9CwkoBfe1DXkjVTmHvfh7YZxX1w6yku3rQnssKLfUgihRQoMxn4jzf7</span>
println(mainnetXpub)
<span class="hljs-comment">// zpub6jftahH18ngZx9dMiZNXr1JEsCJV667NCJ7jX1EqfBphjXQVRiuWKH1aM7c6QvarHy23uBiomoJTNxtP6KCEYJP428LqCvZScAmffc6nFkf</span>
<span class="hljs-comment">// zpub6jftahH18ngZyRm1vL829xqD3npSyEmRKctb5BbnUyEZVdJ55CWs9CwkoBfe1DXkjVTmHvfh7YZxX1w6yku3rQnssKLfUgihRQoMxn4jzf7</span>
</code></pre>
<p>Which gives us something that looks like this</p>
<p><code>zpub6jftahH18ngZw98KGjRo5XcxeKTQ2eztsvskb1dC9XF5TLimQquTs6Ry7nBBA425D9joXmfgJJCexmJ1u2SELJZJfRi95gcnXadLpZzYb5c</code></p>

22
docs/next/key-manager/key-manager/index.html
View file

@ -77,14 +77,14 @@
<span class="hljs-comment">//get 256 bits of random entropy</span>
<span class="hljs-keyword">val</span> entropy = <span class="hljs-type">MnemonicCode</span>.getEntropy256Bits
<span class="hljs-comment">// entropy: scodec.bits.BitVector = BitVector(256 bits, 0xd8f07d175581c69a710d0e565d5c6610d41f0ad78e9ab5e89a7d803e40743b6a)</span>
<span class="hljs-comment">// entropy: scodec.bits.BitVector = BitVector(256 bits, 0x2b3fd382cc71c275461610dd0e2481659eb7c4e954ea916103089eb1c6c65d06)</span>
<span class="hljs-keyword">val</span> mnemonic = <span class="hljs-type">MnemonicCode</span>.fromEntropy(entropy)
<span class="hljs-comment">// mnemonic: MnemonicCode = Masked(MnemonicCodeImpl)</span>
<span class="hljs-comment">//you can print that mnemonic seed with this</span>
println(mnemonic.words)
<span class="hljs-comment">// Vector(suggest, loop, easy, prison, broccoli, essay, service, peace, film, turtle, book, canvas, draft, lyrics, funny, spy, remove, dynamic, panda, about, tomato, deliver, unit, elegant)</span>
<span class="hljs-comment">// Vector(clinic, write, thing, ocean, bring, deny, blue, search, tackle, illness, cake, sleep, twin, tiny, pipe, outer, multiply, amount, season, dice, broccoli, glimpse, inject, spend)</span>
</code></pre>
<p>Now that we have a <code>MnemonicCode</code> that was securely generated, we need to now create <code>KeyManagerParams</code> which tells us how to generate
generate specific kinds of addresses for wallets.</p>
@ -99,7 +99,7 @@ generate specific kinds of addresses for wallets.</p>
<pre><code class="hljs css language-scala"><span class="hljs-comment">//this will create a temp directory with the prefix &#x27;key-manager-example` that will</span>
<span class="hljs-comment">//have a file in it called &quot;encrypted-bitcoin-s-seed.json&quot;</span>
<span class="hljs-keyword">val</span> seedPath = <span class="hljs-type">Files</span>.createTempDirectory(<span class="hljs-string">&quot;key-manager-example&quot;</span>).resolve(<span class="hljs-type">WalletStorage</span>.<span class="hljs-type">ENCRYPTED_SEED_FILE_NAME</span>)
<span class="hljs-comment">// seedPath: Path = /tmp/key-manager-example578437178971179166/encrypted-bitcoin-s-seed.json</span>
<span class="hljs-comment">// seedPath: Path = /tmp/key-manager-example5044004744055868046/encrypted-bitcoin-s-seed.json</span>
<span class="hljs-comment">//let&#x27;s create a native segwit key manager</span>
<span class="hljs-keyword">val</span> purpose = <span class="hljs-type">HDPurposes</span>.<span class="hljs-type">SegWit</span>
@ -110,19 +110,19 @@ generate specific kinds of addresses for wallets.</p>
<span class="hljs-comment">// network: RegTest.type = RegTest</span>
<span class="hljs-keyword">val</span> kmParams = <span class="hljs-type">KeyManagerParams</span>(seedPath, purpose, network)
<span class="hljs-comment">// kmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example578437178971179166/encrypted-bitcoin-s-seed.json,m/84&#x27;,RegTest)</span>
<span class="hljs-comment">// kmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example5044004744055868046/encrypted-bitcoin-s-seed.json,m/84&#x27;,RegTest)</span>
<span class="hljs-keyword">val</span> aesPasswordOpt = <span class="hljs-type">Some</span>(<span class="hljs-type">AesPassword</span>.fromString(<span class="hljs-string">&quot;password&quot;</span>))
<span class="hljs-comment">// aesPasswordOpt: Some[AesPassword] = Some(Masked(AesPassword))</span>
<span class="hljs-keyword">val</span> km = <span class="hljs-type">BIP39KeyManager</span>.initializeWithMnemonic(aesPasswordOpt, mnemonic, <span class="hljs-type">None</span>, kmParams)
<span class="hljs-comment">// km: Either[KeyManagerInitializeError, BIP39KeyManager] = Right(org.bitcoins.keymanager.bip39.BIP39KeyManager@3415885a)</span>
<span class="hljs-comment">// km: Either[KeyManagerInitializeError, BIP39KeyManager] = Right(org.bitcoins.keymanager.bip39.BIP39KeyManager@2a685bfa)</span>
<span class="hljs-keyword">val</span> rootXPub = km.right.get.getRootXPub
<span class="hljs-comment">// rootXPub: ExtPublicKey = vpub5SLqN2bLY4WeYxrtP8E31evEBKihKc9NXr2rPRfJ9AKBX89aR6FFq2P2GHmkRHyAfQYpuHLZw9tFqpS8DXYBMMeeYmZ8sHHVXGX67DztDqQ</span>
<span class="hljs-comment">// rootXPub: ExtPublicKey = vpub5SLqN2bLY4WeaEzYatyXKcTCMvEfCkoRfAohwc2Exwj3HE3A4ZrcexKCiMqJ1av56vzYJ2HTGu9kysUr6yEzfU4UPxYy93SkLWYnQVGNUUs</span>
println(rootXPub)
<span class="hljs-comment">// vpub5SLqN2bLY4WeYxrtP8E31evEBKihKc9NXr2rPRfJ9AKBX89aR6FFq2P2GHmkRHyAfQYpuHLZw9tFqpS8DXYBMMeeYmZ8sHHVXGX67DztDqQ</span>
<span class="hljs-comment">// vpub5SLqN2bLY4WeaEzYatyXKcTCMvEfCkoRfAohwc2Exwj3HE3A4ZrcexKCiMqJ1av56vzYJ2HTGu9kysUr6yEzfU4UPxYy93SkLWYnQVGNUUs</span>
</code></pre>
<p>Which should print something that looks like this</p>
<p><code>vpub5SLqN2bLY4WeXxMqwJHJFBEwxSscGB2uDUnsTS3edVjZEwTrQDFDNqoR2xLqARQPabGaXsHSTenTRcqm2EnB9MpuC4vSk3LqSgNmGGZtuq7</code></p>
@ -131,17 +131,17 @@ println(rootXPub)
again after initializing it once. You can use the same <code>mnemonic</code> for different networks, which you control <code>KeyManagerParams</code>.</p>
<pre><code class="hljs css language-scala"><span class="hljs-comment">//let&#x27;s create a nested segwit key manager for mainnet</span>
<span class="hljs-keyword">val</span> mainnetKmParams = <span class="hljs-type">KeyManagerParams</span>(seedPath, <span class="hljs-type">HDPurposes</span>.<span class="hljs-type">SegWit</span>, <span class="hljs-type">MainNet</span>)
<span class="hljs-comment">// mainnetKmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example578437178971179166/encrypted-bitcoin-s-seed.json,m/84&#x27;,MainNet)</span>
<span class="hljs-comment">// mainnetKmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example5044004744055868046/encrypted-bitcoin-s-seed.json,m/84&#x27;,MainNet)</span>
<span class="hljs-comment">//we do not need to all `initializeWithMnemonic()` again as we have saved the seed to dis</span>
<span class="hljs-keyword">val</span> mainnetKeyManager = <span class="hljs-type">BIP39KeyManager</span>.fromMnemonic(mnemonic, mainnetKmParams, <span class="hljs-type">None</span>, <span class="hljs-type">Instant</span>.now)
<span class="hljs-comment">// mainnetKeyManager: BIP39KeyManager = org.bitcoins.keymanager.bip39.BIP39KeyManager@598e2339</span>
<span class="hljs-comment">// mainnetKeyManager: BIP39KeyManager = org.bitcoins.keymanager.bip39.BIP39KeyManager@1ff9cefe</span>
<span class="hljs-keyword">val</span> mainnetXpub = mainnetKeyManager.getRootXPub
<span class="hljs-comment">// mainnetXpub: ExtPublicKey = zpub6jftahH18ngZx9dMiZNXr1JEsCJV667NCJ7jX1EqfBphjXQVRiuWKH1aM7c6QvarHy23uBiomoJTNxtP6KCEYJP428LqCvZScAmffc6nFkf</span>
<span class="hljs-comment">// mainnetXpub: ExtPublicKey = zpub6jftahH18ngZyRm1vL829xqD3npSyEmRKctb5BbnUyEZVdJ55CWs9CwkoBfe1DXkjVTmHvfh7YZxX1w6yku3rQnssKLfUgihRQoMxn4jzf7</span>
println(mainnetXpub)
<span class="hljs-comment">// zpub6jftahH18ngZx9dMiZNXr1JEsCJV667NCJ7jX1EqfBphjXQVRiuWKH1aM7c6QvarHy23uBiomoJTNxtP6KCEYJP428LqCvZScAmffc6nFkf</span>
<span class="hljs-comment">// zpub6jftahH18ngZyRm1vL829xqD3npSyEmRKctb5BbnUyEZVdJ55CWs9CwkoBfe1DXkjVTmHvfh7YZxX1w6yku3rQnssKLfUgihRQoMxn4jzf7</span>
</code></pre>
<p>Which gives us something that looks like this</p>
<p><code>zpub6jftahH18ngZw98KGjRo5XcxeKTQ2eztsvskb1dC9XF5TLimQquTs6Ry7nBBA425D9joXmfgJJCexmJ1u2SELJZJfRi95gcnXadLpZzYb5c</code></p>

3
docs/next/key-manager/server-key-manager.html
View file

@ -113,6 +113,9 @@ It takes in the base58 encoded xprv, wallet name, and an optional passphrase to
To do this, you will need the seed file name to be <code>walletName-encrypted-bitcoin-s-seed.json</code> or <code>encrypted-bitcoin-s-seed.json</code>
if you want it to be the default wallet.
To load it, just set the <code>bitcoin-s.wallet.walletName</code> config option to the appropriate wallet name.</p>
<p>When restoring from a backup you should not replace an existing seed file as this can result in a loss of funds.
If you have a seed file that would replace an existing seed its file name should be prefixed with a different wallet name.
If you do replace a seed file you will need to delete the old wallet database associated with that wallet.</p>
<p>You may need to run a wallet rescan to restore funds, this can be done by using the <code>rescan</code> RPC command.</p>
<p>For example, if you wanted to restore your <code>rickRollWallet</code>, you would place your backup at <code>~/.bitcoin-s/seeds/rickRollWallet-encrypted-bitcoin-s-seed.json</code>
and then load the wallet using a config with <code>bitcoin-s.wallet.walletName = rickRollWallet</code></p>

3
docs/next/key-manager/server-key-manager/index.html
View file

@ -113,6 +113,9 @@ It takes in the base58 encoded xprv, wallet name, and an optional passphrase to
To do this, you will need the seed file name to be <code>walletName-encrypted-bitcoin-s-seed.json</code> or <code>encrypted-bitcoin-s-seed.json</code>
if you want it to be the default wallet.
To load it, just set the <code>bitcoin-s.wallet.walletName</code> config option to the appropriate wallet name.</p>
<p>When restoring from a backup you should not replace an existing seed file as this can result in a loss of funds.
If you have a seed file that would replace an existing seed its file name should be prefixed with a different wallet name.
If you do replace a seed file you will need to delete the old wallet database associated with that wallet.</p>
<p>You may need to run a wallet rescan to restore funds, this can be done by using the <code>rescan</code> RPC command.</p>
<p>For example, if you wanted to restore your <code>rickRollWallet</code>, you would place your backup at <code>~/.bitcoin-s/seeds/rickRollWallet-encrypted-bitcoin-s-seed.json</code>
and then load the wallet using a config with <code>bitcoin-s.wallet.walletName = rickRollWallet</code></p>

4
docs/next/secp256k1/secp256k1.html
View file

@ -114,12 +114,12 @@ println(<span class="hljs-string">s&quot;Verified with NativeSecp256k1 again=<sp
<pre><code class="hljs css language-scala"><span class="hljs-keyword">val</span> privKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey
<span class="hljs-comment">// privKey: ECPrivateKey = Masked(ECPrivateKeyImpl)</span>
<span class="hljs-keyword">val</span> publicKey = privKey.publicKeyWithBouncyCastle
<span class="hljs-comment">// publicKey: ECPublicKey = ECPublicKey(034bcdfef1a783f0bba44e689e1b0668a8bc9f4f09488a190ae1cd8b2014399856)</span>
<span class="hljs-comment">// publicKey: ECPublicKey = ECPublicKey(0376d60968ec2c06a64447fa591115f6ff689417cc771bbec6d46cec6a9e3fbc13)</span>
<span class="hljs-keyword">val</span> dataToSign = <span class="hljs-type">DoubleSha256Digest</span>.empty
<span class="hljs-comment">// dataToSign: DoubleSha256Digest = DoubleSha256Digest(0000000000000000000000000000000000000000000000000000000000000000)</span>
<span class="hljs-keyword">val</span> signature = privKey.signWithBouncyCastle(dataToSign.bytes)
<span class="hljs-comment">// signature: ECDigitalSignature = ECDigitalSignature(3045022100a9e327cb0fa3e1f9ea2dc15a2208fd12bb483e02c186f67c1ed22c8606f0057b0220731a12ac2f288193e95deb7e2709b27f28112375a94d4f56afcd6566da2e8170)</span>
<span class="hljs-comment">// signature: ECDigitalSignature = ECDigitalSignature(3045022100dce46e6ac3eb204c42586645ecafefe20eddbc740b486211e5fd9312c40fccc902202b164e8a47effc6424e3fbaba4405b93644c2a752089b763321c989121e7b749)</span>
<span class="hljs-keyword">val</span> verified = publicKey.verifyWithBouncyCastle(dataToSign.bytes, signature)
<span class="hljs-comment">// verified: Boolean = true</span>

4
docs/next/secp256k1/secp256k1/index.html
View file

@ -114,12 +114,12 @@ println(<span class="hljs-string">s&quot;Verified with NativeSecp256k1 again=<sp
<pre><code class="hljs css language-scala"><span class="hljs-keyword">val</span> privKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey
<span class="hljs-comment">// privKey: ECPrivateKey = Masked(ECPrivateKeyImpl)</span>
<span class="hljs-keyword">val</span> publicKey = privKey.publicKeyWithBouncyCastle
<span class="hljs-comment">// publicKey: ECPublicKey = ECPublicKey(034bcdfef1a783f0bba44e689e1b0668a8bc9f4f09488a190ae1cd8b2014399856)</span>
<span class="hljs-comment">// publicKey: ECPublicKey = ECPublicKey(0376d60968ec2c06a64447fa591115f6ff689417cc771bbec6d46cec6a9e3fbc13)</span>
<span class="hljs-keyword">val</span> dataToSign = <span class="hljs-type">DoubleSha256Digest</span>.empty
<span class="hljs-comment">// dataToSign: DoubleSha256Digest = DoubleSha256Digest(0000000000000000000000000000000000000000000000000000000000000000)</span>
<span class="hljs-keyword">val</span> signature = privKey.signWithBouncyCastle(dataToSign.bytes)
<span class="hljs-comment">// signature: ECDigitalSignature = ECDigitalSignature(3045022100a9e327cb0fa3e1f9ea2dc15a2208fd12bb483e02c186f67c1ed22c8606f0057b0220731a12ac2f288193e95deb7e2709b27f28112375a94d4f56afcd6566da2e8170)</span>
<span class="hljs-comment">// signature: ECDigitalSignature = ECDigitalSignature(3045022100dce46e6ac3eb204c42586645ecafefe20eddbc740b486211e5fd9312c40fccc902202b164e8a47effc6424e3fbaba4405b93644c2a752089b763321c989121e7b749)</span>
<span class="hljs-keyword">val</span> verified = publicKey.verifyWithBouncyCastle(dataToSign.bytes, signature)
<span class="hljs-comment">// verified: Boolean = true</span>

23
docs/next/wallet/wallet-rescan.html
View file

@ -63,12 +63,27 @@
}
});
</script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/bitcoin-s/bitcoin-s/blob/master/docs/wallet/wallet-rescan.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">Wallet Rescans</h1></header><article><div><span><p>With <a href="https://github.com/bitcoin/bips/blob/master/bip-0157.mediawiki">BIP157</a> you can cache block filters locally to use
later for rescans in the case you need to restore your wallets. Our <a href="../applications/chain.md">chain</a> project gives us
later for rescans in the case you need to restore your wallets. Our <a href="/docs/next/chain/chain">chain</a> project gives us
an API with the ability to query for filters.</p>
<h3><a class="anchor" aria-hidden="true" id="rescan-from-cli"></a><a href="#rescan-from-cli" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Rescan from CLI</h3>
<p>To execute a rescan from the cli because you are restoring a wallet or it has gotten out of sync is fairly simple.</p>
<p>If you have an empty wallet it can be done by simply calling rescan</p>
<pre><code class="hljs css language-bash">./bitcoin-s-cli rescan
</code></pre>
<p>If your wallet is not empty then you will need to call it with the force command</p>
<pre><code class="hljs css language-bash">./bitcoin-s-cli rescan --force
</code></pre>
<p>You can also specify start and stop heights</p>
<pre><code class="hljs css language-bash">./bitcoin-s-cli rescan --start &lt;start height&gt; --stop &lt;stop height&gt;
</code></pre>
<p>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 <code>ignorecreationtime</code> flag</p>
<pre><code class="hljs css language-bash">./bitcoin-s-cli rescan --ignorecreationtime
</code></pre>
<h3><a class="anchor" aria-hidden="true" id="code-example"></a><a href="#code-example" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Code Example</h3>
<p>You can rescan your wallet with filters with <a href="https://github.com/bitcoin-s/bitcoin-s/blob/master/core/src/main/scala/org/bitcoins/core/api/wallet/NeutrinoWalletApi.scala#L77"><code>WalletApi.rescanNeutrinoWallet()</code></a></p>
<h3><a class="anchor" aria-hidden="true" id="example"></a><a href="#example" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Example</h3>
<p>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
<code>sbt downloadBitcoind</code></p>
<p>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 <code>sbt downloadBitcoind</code></p>
<pre><code class="hljs css language-scala"><span class="hljs-comment">//we need an actor system and app config to power this</span>
<span class="hljs-keyword">implicit</span> <span class="hljs-keyword">val</span> system: <span class="hljs-type">ActorSystem</span> = <span class="hljs-type">ActorSystem</span>(<span class="hljs-string">s&quot;wallet-rescan-example&quot;</span>)
<span class="hljs-keyword">implicit</span> <span class="hljs-keyword">val</span> ec: <span class="hljs-type">ExecutionContext</span> = system.dispatcher

23
docs/next/wallet/wallet-rescan/index.html
View file

@ -63,12 +63,27 @@
}
});
</script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/bitcoin-s/bitcoin-s/blob/master/docs/wallet/wallet-rescan.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">Wallet Rescans</h1></header><article><div><span><p>With <a href="https://github.com/bitcoin/bips/blob/master/bip-0157.mediawiki">BIP157</a> you can cache block filters locally to use
later for rescans in the case you need to restore your wallets. Our <a href="../applications/chain.md">chain</a> project gives us
later for rescans in the case you need to restore your wallets. Our <a href="/docs/next/chain/chain">chain</a> project gives us
an API with the ability to query for filters.</p>
<h3><a class="anchor" aria-hidden="true" id="rescan-from-cli"></a><a href="#rescan-from-cli" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Rescan from CLI</h3>
<p>To execute a rescan from the cli because you are restoring a wallet or it has gotten out of sync is fairly simple.</p>
<p>If you have an empty wallet it can be done by simply calling rescan</p>
<pre><code class="hljs css language-bash">./bitcoin-s-cli rescan
</code></pre>
<p>If your wallet is not empty then you will need to call it with the force command</p>
<pre><code class="hljs css language-bash">./bitcoin-s-cli rescan --force
</code></pre>
<p>You can also specify start and stop heights</p>
<pre><code class="hljs css language-bash">./bitcoin-s-cli rescan --start &lt;start height&gt; --stop &lt;stop height&gt;
</code></pre>
<p>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 <code>ignorecreationtime</code> flag</p>
<pre><code class="hljs css language-bash">./bitcoin-s-cli rescan --ignorecreationtime
</code></pre>
<h3><a class="anchor" aria-hidden="true" id="code-example"></a><a href="#code-example" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Code Example</h3>
<p>You can rescan your wallet with filters with <a href="https://github.com/bitcoin-s/bitcoin-s/blob/master/core/src/main/scala/org/bitcoins/core/api/wallet/NeutrinoWalletApi.scala#L77"><code>WalletApi.rescanNeutrinoWallet()</code></a></p>
<h3><a class="anchor" aria-hidden="true" id="example"></a><a href="#example" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Example</h3>
<p>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
<code>sbt downloadBitcoind</code></p>
<p>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 <code>sbt downloadBitcoind</code></p>
<pre><code class="hljs css language-scala"><span class="hljs-comment">//we need an actor system and app config to power this</span>
<span class="hljs-keyword">implicit</span> <span class="hljs-keyword">val</span> system: <span class="hljs-type">ActorSystem</span> = <span class="hljs-type">ActorSystem</span>(<span class="hljs-string">s&quot;wallet-rescan-example&quot;</span>)
<span class="hljs-keyword">implicit</span> <span class="hljs-keyword">val</span> ec: <span class="hljs-type">ExecutionContext</span> = system.dispatcher