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

Deploy website

Browse source 
Deploy website version based on ee852bd310
This commit is contained in:
Docusaurus bot 2020-04-23 14:40:00 +00:00
parent c11d262c91
commit a22d055a68
14 changed files with 82 additions and 82 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-keyword">val</span> privkey = <span class="hljs-type">ECPrivateKey</span>()
<span class="hljs-comment">// privkey: ECPrivateKey = Masked(ECPrivateKeyImpl)</span> <span class="hljs-comment">// privkey: ECPrivateKey = Masked(ECPrivateKeyImpl)</span>
<span class="hljs-keyword">val</span> pubkey = privkey.publicKey <span class="hljs-keyword">val</span> pubkey = privkey.publicKey
<span class="hljs-comment">// pubkey: crypto.ECPublicKey = ECPublicKey(0236668fbaf117c4c53b6df23c70e8bc83d9df0b72fba2e17180afb12eb5361677)</span> <span class="hljs-comment">// pubkey: crypto.ECPublicKey = ECPublicKey(0248ec9043a1fc807592c62a691b032f974e4e8a9569c3f808e862f7a2245a47c1)</span>
<span class="hljs-keyword">val</span> segwitAddress = { <span class="hljs-keyword">val</span> segwitAddress = {
<span class="hljs-comment">// see https://bitcoin.org/en/glossary/pubkey-script</span> <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-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-type">Bech32Address</span>(scriptPubKey, <span class="hljs-type">TestNet3</span>)
} }
<span class="hljs-comment">// segwitAddress: Bech32Address = Bech32Address(tb1qy86y7aw0959zh2e9hhuve3vh7mpaq7qgw65gjz)</span> <span class="hljs-comment">// segwitAddress: Bech32Address = Bech32Address(tb1q25492rae9qqhh0xqjavv546c9hnuqe8jj2k6tf)</span>
println(segwitAddress.toString) println(segwitAddress.toString)
<span class="hljs-comment">// Bech32Address(tb1qy86y7aw0959zh2e9hhuve3vh7mpaq7qgw65gjz)</span> <span class="hljs-comment">// Bech32Address(tb1q25492rae9qqhh0xqjavv546c9hnuqe8jj2k6tf)</span>
</code></pre> </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> <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 <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're reusing the same private/public key pair</span> <pre><code class="hljs css language-scala"><span class="hljs-comment">// we're reusing the same private/public key pair</span>
<span class="hljs-comment">// from before. don't do this in an actual application!</span> <span class="hljs-comment">// from before. don'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-keyword">val</span> legacyAddress = <span class="hljs-type">P2PKHAddress</span>(pubkey, <span class="hljs-type">TestNet3</span>)
<span class="hljs-comment">// legacyAddress: P2PKHAddress = micVGNJEfvRVkg1k3ewN9joaAmcoZg6q6g</span> <span class="hljs-comment">// legacyAddress: P2PKHAddress = moHGSf5eoM6b6NbvujuBeqko6qARg4e63R</span>
println(legacyAddress.toString) println(legacyAddress.toString)
<span class="hljs-comment">// micVGNJEfvRVkg1k3ewN9joaAmcoZg6q6g</span> <span class="hljs-comment">// moHGSf5eoM6b6NbvujuBeqko6qARg4e63R</span>
</code></pre> </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/enQtNDEyMjY3MTg1MTg3LTYyYjkwOGUzMDQ4NDAwZjE1M2I3MmQyNWNlZjNlYjg4OGRjYTRjNWUwNjRjNjg4Y2NjZjAxYjU1N2JjMTU1YWM" 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 © 2020 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> </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/enQtNDEyMjY3MTg1MTg3LTYyYjkwOGUzMDQ4NDAwZjE1M2I3MmQyNWNlZjNlYjg4OGRjYTRjNWUwNjRjNjg4Y2NjZjAxYjU1N2JjMTU1YWM" 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 © 2020 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) { 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-keyword">val</span> privkey = <span class="hljs-type">ECPrivateKey</span>()
<span class="hljs-comment">// privkey: ECPrivateKey = Masked(ECPrivateKeyImpl)</span> <span class="hljs-comment">// privkey: ECPrivateKey = Masked(ECPrivateKeyImpl)</span>
<span class="hljs-keyword">val</span> pubkey = privkey.publicKey <span class="hljs-keyword">val</span> pubkey = privkey.publicKey
<span class="hljs-comment">// pubkey: crypto.ECPublicKey = ECPublicKey(0236668fbaf117c4c53b6df23c70e8bc83d9df0b72fba2e17180afb12eb5361677)</span> <span class="hljs-comment">// pubkey: crypto.ECPublicKey = ECPublicKey(0248ec9043a1fc807592c62a691b032f974e4e8a9569c3f808e862f7a2245a47c1)</span>
<span class="hljs-keyword">val</span> segwitAddress = { <span class="hljs-keyword">val</span> segwitAddress = {
<span class="hljs-comment">// see https://bitcoin.org/en/glossary/pubkey-script</span> <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-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-type">Bech32Address</span>(scriptPubKey, <span class="hljs-type">TestNet3</span>)
} }
<span class="hljs-comment">// segwitAddress: Bech32Address = Bech32Address(tb1qy86y7aw0959zh2e9hhuve3vh7mpaq7qgw65gjz)</span> <span class="hljs-comment">// segwitAddress: Bech32Address = Bech32Address(tb1q25492rae9qqhh0xqjavv546c9hnuqe8jj2k6tf)</span>
println(segwitAddress.toString) println(segwitAddress.toString)
<span class="hljs-comment">// Bech32Address(tb1qy86y7aw0959zh2e9hhuve3vh7mpaq7qgw65gjz)</span> <span class="hljs-comment">// Bech32Address(tb1q25492rae9qqhh0xqjavv546c9hnuqe8jj2k6tf)</span>
</code></pre> </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> <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 <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're reusing the same private/public key pair</span> <pre><code class="hljs css language-scala"><span class="hljs-comment">// we're reusing the same private/public key pair</span>
<span class="hljs-comment">// from before. don't do this in an actual application!</span> <span class="hljs-comment">// from before. don'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-keyword">val</span> legacyAddress = <span class="hljs-type">P2PKHAddress</span>(pubkey, <span class="hljs-type">TestNet3</span>)
<span class="hljs-comment">// legacyAddress: P2PKHAddress = micVGNJEfvRVkg1k3ewN9joaAmcoZg6q6g</span> <span class="hljs-comment">// legacyAddress: P2PKHAddress = moHGSf5eoM6b6NbvujuBeqko6qARg4e63R</span>
println(legacyAddress.toString) println(legacyAddress.toString)
<span class="hljs-comment">// micVGNJEfvRVkg1k3ewN9joaAmcoZg6q6g</span> <span class="hljs-comment">// moHGSf5eoM6b6NbvujuBeqko6qARg4e63R</span>
</code></pre> </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/enQtNDEyMjY3MTg1MTg3LTYyYjkwOGUzMDQ4NDAwZjE1M2I3MmQyNWNlZjNlYjg4OGRjYTRjNWUwNjRjNjg4Y2NjZjAxYjU1N2JjMTU1YWM" 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 © 2020 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> </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/enQtNDEyMjY3MTg1MTg3LTYyYjkwOGUzMDQ4NDAwZjE1M2I3MmQyNWNlZjNlYjg4OGRjYTRjNWUwNjRjNjg4Y2NjZjAxYjU1N2JjMTU1YWM" 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 © 2020 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) { 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">// how long our phrase ends up being</span>
<span class="hljs-comment">// 256 bits of entropy results in 24 words</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-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, 0x3d45f7acac32242914631889ac49fa165ea8d14cfd48b976a283d0ed2e653e47)</span> <span class="hljs-comment">// entropy: BitVector = BitVector(256 bits, 0x3d8f14f2f5f9717166e0bbc39ecf20d4ea0c595f7a1a302830eef67685319e20)</span>
<span class="hljs-keyword">val</span> mnemonicCode = <span class="hljs-type">MnemonicCode</span>.fromEntropy(entropy) <span class="hljs-keyword">val</span> mnemonicCode = <span class="hljs-type">MnemonicCode</span>.fromEntropy(entropy)
<span class="hljs-comment">// mnemonicCode: MnemonicCode = Masked(MnemonicCodeImpl)</span> <span class="hljs-comment">// mnemonicCode: MnemonicCode = Masked(MnemonicCodeImpl)</span>
mnemonicCode.words <span class="hljs-comment">// the phrase the user should write down</span> mnemonicCode.words <span class="hljs-comment">// the phrase the user should write down</span>
<span class="hljs-comment">// res0: Vector[String] = Vector(diary, cook, twenty, flash, car, behind, face, glide, meadow, girl, leader, coach, tunnel, hamster, crop, poverty, ride, relax, path, peace, spray, crater, weekend, usual) // the phrase the user should write down</span> <span class="hljs-comment">// res0: Vector[String] = Vector(diesel, judge, device, typical, novel, reward, oppose, blast, seminar, wait, sight, prefer, patch, coach, law, drive, coral, dose, desert, undo, hair, occur, joy, another) // 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">// the password argument is an optional, extra security</span>
<span class="hljs-comment">// measure. all MnemonicCode instances will give you a</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) bip39Seed)
<span class="hljs-comment">// xpriv: ExtPrivateKey = Masked(ExtPrivateKeyImpl)</span> <span class="hljs-comment">// xpriv: ExtPrivateKey = Masked(ExtPrivateKeyImpl)</span>
<span class="hljs-keyword">val</span> xpub = xpriv.extPublicKey <span class="hljs-keyword">val</span> xpub = xpriv.extPublicKey
<span class="hljs-comment">// xpub: ExtPublicKey = zpub6jftahH18ngZyAMcAcjMEJ6QF1rhdzhjndeXijJGtq2sUqcsEZ861rGvToTGSXiRhPCLMZ23xbv8Nhbgi5ByA56YVfPeLfb9BCnLQNTnCYe</span> <span class="hljs-comment">// xpub: ExtPublicKey = zpub6jftahH18ngZyVDMHu8UwvyskA4bU8gdzaXHJccTbv6knsFEeKf6EctyTQbw8muvFse9jrBsXo8PPgJAwsEMpFrp2Dni8zM9Ez6fzNma5iu</span>
<span class="hljs-comment">// you can now use the generated xpriv to derive further</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> <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> <span class="hljs-comment">// can generate addresses with it!</span>
accountXpriv.extPublicKey accountXpriv.extPublicKey
} }
<span class="hljs-comment">// accountXpub: ExtPublicKey = zpub6rNiU7KM6sYoFySHTcSh662Vy9fiTPAuvyrtxmTHLn37gAJner2vzKnVdEzV1U7RkzhxeGd2FUC6AH7Sc2VdjZFH5PVabodL7rTcQyP5hPN</span> <span class="hljs-comment">// accountXpub: ExtPublicKey = zpub6rVL84QDkNcyNjXguLtTXdGefKFft4To1E3RNaa5uqQxyyHj7MRzEWCugvoTzybb8B4dshgFh46NuH7JdySRxVNDrE2HwnW13rkUGH7G5di</span>
<span class="hljs-comment">// address no. 0 ---------------┐</span> <span class="hljs-comment">// address no. 0 ---------------┐</span>
<span class="hljs-comment">// external address ----------┐ |</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-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-type">Bech32Address</span>(scriptPubKey, <span class="hljs-type">TestNet3</span>)
} }
<span class="hljs-comment">// firstAccountAddress: Bech32Address = Bech32Address(tb1qlhawmxhjf87ne8e3qjldgyfnccw7qdeqacl7yk)</span> <span class="hljs-comment">// firstAccountAddress: Bech32Address = Bech32Address(tb1qfnazafps0ftd0a8uu8xm2hytj7aagtktpaw548)</span>
<span class="hljs-comment">// tada! We just generated an address you can send money to,</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> <span class="hljs-comment">// without having access to the private key!</span>
firstAccountAddress.value firstAccountAddress.value
<span class="hljs-comment">// res2: String = tb1qlhawmxhjf87ne8e3qjldgyfnccw7qdeqacl7yk</span> <span class="hljs-comment">// res2: String = tb1qfnazafps0ftd0a8uu8xm2hytj7aagtktpaw548</span>
<span class="hljs-comment">// you can now continue deriving addresses from the same public</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> <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">// how long our phrase ends up being</span>
<span class="hljs-comment">// 256 bits of entropy results in 24 words</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-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, 0x3d45f7acac32242914631889ac49fa165ea8d14cfd48b976a283d0ed2e653e47)</span> <span class="hljs-comment">// entropy: BitVector = BitVector(256 bits, 0x3d8f14f2f5f9717166e0bbc39ecf20d4ea0c595f7a1a302830eef67685319e20)</span>
<span class="hljs-keyword">val</span> mnemonicCode = <span class="hljs-type">MnemonicCode</span>.fromEntropy(entropy) <span class="hljs-keyword">val</span> mnemonicCode = <span class="hljs-type">MnemonicCode</span>.fromEntropy(entropy)
<span class="hljs-comment">// mnemonicCode: MnemonicCode = Masked(MnemonicCodeImpl)</span> <span class="hljs-comment">// mnemonicCode: MnemonicCode = Masked(MnemonicCodeImpl)</span>
mnemonicCode.words <span class="hljs-comment">// the phrase the user should write down</span> mnemonicCode.words <span class="hljs-comment">// the phrase the user should write down</span>
<span class="hljs-comment">// res0: Vector[String] = Vector(diary, cook, twenty, flash, car, behind, face, glide, meadow, girl, leader, coach, tunnel, hamster, crop, poverty, ride, relax, path, peace, spray, crater, weekend, usual) // the phrase the user should write down</span> <span class="hljs-comment">// res0: Vector[String] = Vector(diesel, judge, device, typical, novel, reward, oppose, blast, seminar, wait, sight, prefer, patch, coach, law, drive, coral, dose, desert, undo, hair, occur, joy, another) // 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">// the password argument is an optional, extra security</span>
<span class="hljs-comment">// measure. all MnemonicCode instances will give you a</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) bip39Seed)
<span class="hljs-comment">// xpriv: ExtPrivateKey = Masked(ExtPrivateKeyImpl)</span> <span class="hljs-comment">// xpriv: ExtPrivateKey = Masked(ExtPrivateKeyImpl)</span>
<span class="hljs-keyword">val</span> xpub = xpriv.extPublicKey <span class="hljs-keyword">val</span> xpub = xpriv.extPublicKey
<span class="hljs-comment">// xpub: ExtPublicKey = zpub6jftahH18ngZyAMcAcjMEJ6QF1rhdzhjndeXijJGtq2sUqcsEZ861rGvToTGSXiRhPCLMZ23xbv8Nhbgi5ByA56YVfPeLfb9BCnLQNTnCYe</span> <span class="hljs-comment">// xpub: ExtPublicKey = zpub6jftahH18ngZyVDMHu8UwvyskA4bU8gdzaXHJccTbv6knsFEeKf6EctyTQbw8muvFse9jrBsXo8PPgJAwsEMpFrp2Dni8zM9Ez6fzNma5iu</span>
<span class="hljs-comment">// you can now use the generated xpriv to derive further</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> <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> <span class="hljs-comment">// can generate addresses with it!</span>
accountXpriv.extPublicKey accountXpriv.extPublicKey
} }
<span class="hljs-comment">// accountXpub: ExtPublicKey = zpub6rNiU7KM6sYoFySHTcSh662Vy9fiTPAuvyrtxmTHLn37gAJner2vzKnVdEzV1U7RkzhxeGd2FUC6AH7Sc2VdjZFH5PVabodL7rTcQyP5hPN</span> <span class="hljs-comment">// accountXpub: ExtPublicKey = zpub6rVL84QDkNcyNjXguLtTXdGefKFft4To1E3RNaa5uqQxyyHj7MRzEWCugvoTzybb8B4dshgFh46NuH7JdySRxVNDrE2HwnW13rkUGH7G5di</span>
<span class="hljs-comment">// address no. 0 ---------------┐</span> <span class="hljs-comment">// address no. 0 ---------------┐</span>
<span class="hljs-comment">// external address ----------┐ |</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-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-type">Bech32Address</span>(scriptPubKey, <span class="hljs-type">TestNet3</span>)
} }
<span class="hljs-comment">// firstAccountAddress: Bech32Address = Bech32Address(tb1qlhawmxhjf87ne8e3qjldgyfnccw7qdeqacl7yk)</span> <span class="hljs-comment">// firstAccountAddress: Bech32Address = Bech32Address(tb1qfnazafps0ftd0a8uu8xm2hytj7aagtktpaw548)</span>
<span class="hljs-comment">// tada! We just generated an address you can send money to,</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> <span class="hljs-comment">// without having access to the private key!</span>
firstAccountAddress.value firstAccountAddress.value
<span class="hljs-comment">// res2: String = tb1qlhawmxhjf87ne8e3qjldgyfnccw7qdeqacl7yk</span> <span class="hljs-comment">// res2: String = tb1qfnazafps0ftd0a8uu8xm2hytj7aagtktpaw548</span>
<span class="hljs-comment">// you can now continue deriving addresses from the same public</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> <span class="hljs-comment">// key, by imitating what we did above. To get the next</span>

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

@ -96,13 +96,13 @@
<span class="hljs-comment">// extPrivKey: ExtPrivateKey = Masked(ExtPrivateKeyImpl)</span> <span class="hljs-comment">// extPrivKey: ExtPrivateKey = Masked(ExtPrivateKeyImpl)</span>
extPrivKey.sign(<span class="hljs-type">DoubleSha256Digest</span>.empty.bytes) extPrivKey.sign(<span class="hljs-type">DoubleSha256Digest</span>.empty.bytes)
<span class="hljs-comment">// res0: ECDigitalSignature = ECDigitalSignature(3045022100f880d0c75982f6d2d086d2d63aaa018714f291d08ff367f899a4aaf4488df8d6022044448eb4c253cc1cfc8fc2fd682c29be337453a8c5125bbb8131e5a5be5b5d2c)</span> <span class="hljs-comment">// res0: ECDigitalSignature = ECDigitalSignature(3045022100c8a27b524d727e150cf6eaae4b542953d1461e156a0fe2c3a3033769b2e1e4ee0220493fea21a25673fa01368b3d04afda46a7fc3ce1f6a6a07d06e5647181040e4e)</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-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> <span class="hljs-comment">// path: BIP32Path = m/0</span>
extPrivKey.sign(<span class="hljs-type">DoubleSha256Digest</span>.empty.bytes,path) extPrivKey.sign(<span class="hljs-type">DoubleSha256Digest</span>.empty.bytes,path)
<span class="hljs-comment">// res1: ECDigitalSignature = ECDigitalSignature(30450221009b2155fa8034db4406e79a03deec98ad48b91540d01202c4223f1a766fae37a6022039ca1b531c1567fa44ca2854f274d3dfd1c9ad7322afd7fb887d76176984cc04)</span> <span class="hljs-comment">// res1: ECDigitalSignature = ECDigitalSignature(3045022100e05c37e47061b99fd0a2426ffec9a55260e5f99affb9149733832f1009fd58a6022002e5de0f72a9ed2bbb29df60245fe8f3a27f2890d2bb2aac0e6472cfe5f69488)</span>
</code></pre> </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>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> <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/core/sign/index.html
View file

@ -96,13 +96,13 @@
<span class="hljs-comment">// extPrivKey: ExtPrivateKey = Masked(ExtPrivateKeyImpl)</span> <span class="hljs-comment">// extPrivKey: ExtPrivateKey = Masked(ExtPrivateKeyImpl)</span>
extPrivKey.sign(<span class="hljs-type">DoubleSha256Digest</span>.empty.bytes) extPrivKey.sign(<span class="hljs-type">DoubleSha256Digest</span>.empty.bytes)
<span class="hljs-comment">// res0: ECDigitalSignature = ECDigitalSignature(3045022100f880d0c75982f6d2d086d2d63aaa018714f291d08ff367f899a4aaf4488df8d6022044448eb4c253cc1cfc8fc2fd682c29be337453a8c5125bbb8131e5a5be5b5d2c)</span> <span class="hljs-comment">// res0: ECDigitalSignature = ECDigitalSignature(3045022100c8a27b524d727e150cf6eaae4b542953d1461e156a0fe2c3a3033769b2e1e4ee0220493fea21a25673fa01368b3d04afda46a7fc3ce1f6a6a07d06e5647181040e4e)</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-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> <span class="hljs-comment">// path: BIP32Path = m/0</span>
extPrivKey.sign(<span class="hljs-type">DoubleSha256Digest</span>.empty.bytes,path) extPrivKey.sign(<span class="hljs-type">DoubleSha256Digest</span>.empty.bytes,path)
<span class="hljs-comment">// res1: ECDigitalSignature = ECDigitalSignature(30450221009b2155fa8034db4406e79a03deec98ad48b91540d01202c4223f1a766fae37a6022039ca1b531c1567fa44ca2854f274d3dfd1c9ad7322afd7fb887d76176984cc04)</span> <span class="hljs-comment">// res1: ECDigitalSignature = ECDigitalSignature(3045022100e05c37e47061b99fd0a2426ffec9a55260e5f99affb9149733832f1009fd58a6022002e5de0f72a9ed2bbb29df60245fe8f3a27f2890d2bb2aac0e6472cfe5f69488)</span>
</code></pre> </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>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> <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>

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

@ -65,25 +65,25 @@
</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 builder that constructs and signs Bitcoin </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 builder that constructs and signs Bitcoin
transactions. Here's an example of how to use it</p> 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 <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@535f1182[Running, parallelism = 2, size = 1, active = 0, running = 0, steals = 9, tasks = 0, submissions = 0]</span> <span class="hljs-comment">// ec: ExecutionContext = scala.concurrent.impl.ExecutionContextImpl$$anon$3@2f73a246[Running, parallelism = 2, size = 1, active = 0, running = 0, steals = 9, tasks = 0, submissions = 0]</span>
<span class="hljs-comment">// generate a fresh private key that we are going to use in the scriptpubkey</span> <span class="hljs-comment">// generate a fresh private key that we are going to use in the scriptpubkey</span>
<span class="hljs-keyword">val</span> privKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey <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-comment">// privKey: ECPrivateKey = Masked(ECPrivateKeyImpl)</span>
<span class="hljs-keyword">val</span> pubKey = privKey.publicKey <span class="hljs-keyword">val</span> pubKey = privKey.publicKey
<span class="hljs-comment">// pubKey: ECPublicKey = ECPublicKey(02d19ff7e158122eb30d05b8630087819cfa2ce78691c5d0179666c7bcbc1cd51f)</span> <span class="hljs-comment">// pubKey: ECPublicKey = ECPublicKey(032ba05e56199eb0ba7ec0a3f98ec826e88a28f1964fb514f7187540a8bdc5f5a5)</span>
<span class="hljs-comment">// this is the script that the TxBuilder is going to create a</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-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-keyword">val</span> creditingSpk = <span class="hljs-type">P2PKHScriptPubKey</span>(pubKey = privKey.publicKey)
<span class="hljs-comment">// creditingSpk: P2PKHScriptPubKey = pkh(c55521e7f6770b17c98bb3c59cec1451cae8689c)</span> <span class="hljs-comment">// creditingSpk: P2PKHScriptPubKey = pkh(dbc3ec8fa69321aa8ed4b8c1fb715d5d646839d5)</span>
<span class="hljs-keyword">val</span> amount = <span class="hljs-number">10000.</span>satoshis <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">// amount: Satoshis = 10000 sats</span>
<span class="hljs-comment">// this is the UTXO we are going to be spending</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-keyword">val</span> utxo =
<span class="hljs-type">TransactionOutput</span>(value = amount, scriptPubKey = creditingSpk) <span class="hljs-type">TransactionOutput</span>(value = amount, scriptPubKey = creditingSpk)
<span class="hljs-comment">// utxo: TransactionOutput = TransactionOutput(10000 sats,pkh(c55521e7f6770b17c98bb3c59cec1451cae8689c))</span> <span class="hljs-comment">// utxo: TransactionOutput = TransactionOutput(10000 sats,pkh(dbc3ec8fa69321aa8ed4b8c1fb715d5d646839d5))</span>
<span class="hljs-comment">// the private key that locks the funds for the script we are spending too</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 <span class="hljs-keyword">val</span> destinationPrivKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey
@ -96,7 +96,7 @@ transactions. Here's an example of how to use it</p>
<span class="hljs-comment">// the script that corresponds to destination private key, this is what is protecting the money</span> <span class="hljs-comment">// the script that corresponds to destination private key, this is what is protecting the money</span>
<span class="hljs-keyword">val</span> destinationSPK = <span class="hljs-keyword">val</span> destinationSPK =
<span class="hljs-type">P2PKHScriptPubKey</span>(pubKey = destinationPrivKey.publicKey) <span class="hljs-type">P2PKHScriptPubKey</span>(pubKey = destinationPrivKey.publicKey)
<span class="hljs-comment">// destinationSPK: P2PKHScriptPubKey = pkh(23d4309ccf4d9ad7c231cf27e9b87f08687d53ff)</span> <span class="hljs-comment">// destinationSPK: P2PKHScriptPubKey = pkh(8696214d35b9f60566117d016a8b23fd0ed0306a)</span>
<span class="hljs-comment">// this is where we are sending money too</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> <span class="hljs-comment">// we could add more destinations here if we</span>
@ -107,7 +107,7 @@ transactions. Here's an example of how to use it</p>
<span class="hljs-type">Vector</span>(destination1) <span class="hljs-type">Vector</span>(destination1)
} }
<span class="hljs-comment">// destinations: Vector[TransactionOutput] = Vector(TransactionOutput(5000 sats,pkh(23d4309ccf4d9ad7c231cf27e9b87f08687d53ff)))</span> <span class="hljs-comment">// destinations: Vector[TransactionOutput] = Vector(TransactionOutput(5000 sats,pkh(8696214d35b9f60566117d016a8b23fd0ed0306a)))</span>
<span class="hljs-comment">// we have to fabricate a transaction that contains the</span> <span class="hljs-comment">// we have to fabricate a transaction that contains the</span>
<span class="hljs-comment">// UTXO we are trying to spend. If this were a real blockchain</span> <span class="hljs-comment">// UTXO we are trying to spend. If this were a real blockchain</span>
@ -116,12 +116,12 @@ transactions. Here's an example of how to use it</p>
inputs = <span class="hljs-type">Vector</span>.empty, inputs = <span class="hljs-type">Vector</span>.empty,
outputs = <span class="hljs-type">Vector</span>(utxo), outputs = <span class="hljs-type">Vector</span>(utxo),
lockTime = <span class="hljs-type">UInt32</span>.zero) lockTime = <span class="hljs-type">UInt32</span>.zero)
<span class="hljs-comment">// creditingTx: BaseTransaction = BaseTransactionImpl(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(c55521e7f6770b17c98bb3c59cec1451cae8689c))),UInt32Impl(0))</span> <span class="hljs-comment">// creditingTx: BaseTransaction = BaseTransactionImpl(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(dbc3ec8fa69321aa8ed4b8c1fb715d5d646839d5))),UInt32Impl(0))</span>
<span class="hljs-comment">// this is the information we need from the crediting TX</span> <span class="hljs-comment">// this is the information we need from the crediting TX</span>
<span class="hljs-comment">// to properly "link" it in the transaction we are creating</span> <span class="hljs-comment">// to properly "link" 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-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(be47f6cb75dc01e2a992dd08a35c86828adaa7df608e4f163d0bb1e6cb005152:0)</span> <span class="hljs-comment">// outPoint: TransactionOutPoint = TransactionOutPoint(6e792d0a05d1ac855ca75eddfde1fc6a598afc565552228c473eae10ad5c7188:0)</span>
<span class="hljs-comment">// this contains all the information we need to</span> <span class="hljs-comment">// this contains all the information we need to</span>
<span class="hljs-comment">// validly sign the UTXO above</span> <span class="hljs-comment">// validly sign the UTXO above</span>
@ -134,12 +134,12 @@ transactions. Here's an example of how to use it</p>
<span class="hljs-type">HashType</span>.sigHashAll, <span class="hljs-type">HashType</span>.sigHashAll,
conditionalPath = conditionalPath =
<span class="hljs-type">ConditionalPath</span>.<span class="hljs-type">NoConditionsLeft</span>) <span class="hljs-type">ConditionalPath</span>.<span class="hljs-type">NoConditionsLeft</span>)
<span class="hljs-comment">// utxoSpendingInfo: BitcoinUTXOSpendingInfoFull = P2PKHSpendingInfo(TransactionOutPoint(be47f6cb75dc01e2a992dd08a35c86828adaa7df608e4f163d0bb1e6cb005152:0),10000 sats,pkh(c55521e7f6770b17c98bb3c59cec1451cae8689c),Masked(ECPrivateKeyImpl),SIGHASH_ALL(Int32Impl(1)))</span> <span class="hljs-comment">// utxoSpendingInfo: BitcoinUTXOSpendingInfoFull = P2PKHSpendingInfo(TransactionOutPoint(6e792d0a05d1ac855ca75eddfde1fc6a598afc565552228c473eae10ad5c7188:0),10000 sats,pkh(dbc3ec8fa69321aa8ed4b8c1fb715d5d646839d5),Masked(ECPrivateKeyImpl),SIGHASH_ALL(Int32Impl(1)))</span>
<span class="hljs-comment">// all of the UTXO spending information, since we are only</span> <span class="hljs-comment">// all of the UTXO spending information, since we are only</span>
<span class="hljs-comment">//spending one UTXO, this is just one element</span> <span class="hljs-comment">//spending one UTXO, this is just one element</span>
<span class="hljs-keyword">val</span> utxos: <span class="hljs-type">Vector</span>[<span class="hljs-type">BitcoinUTXOSpendingInfoFull</span>] = <span class="hljs-type">Vector</span>(utxoSpendingInfo) <span class="hljs-keyword">val</span> utxos: <span class="hljs-type">Vector</span>[<span class="hljs-type">BitcoinUTXOSpendingInfoFull</span>] = <span class="hljs-type">Vector</span>(utxoSpendingInfo)
<span class="hljs-comment">// utxos: Vector[BitcoinUTXOSpendingInfoFull] = Vector(P2PKHSpendingInfo(TransactionOutPoint(be47f6cb75dc01e2a992dd08a35c86828adaa7df608e4f163d0bb1e6cb005152:0),10000 sats,pkh(c55521e7f6770b17c98bb3c59cec1451cae8689c),Masked(ECPrivateKeyImpl),SIGHASH_ALL(Int32Impl(1))))</span> <span class="hljs-comment">// utxos: Vector[BitcoinUTXOSpendingInfoFull] = Vector(P2PKHSpendingInfo(TransactionOutPoint(6e792d0a05d1ac855ca75eddfde1fc6a598afc565552228c473eae10ad5c7188:0),10000 sats,pkh(dbc3ec8fa69321aa8ed4b8c1fb715d5d646839d5),Masked(ECPrivateKeyImpl),SIGHASH_ALL(Int32Impl(1))))</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">// 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> <span class="hljs-comment">// for this example, we are going to pay 1 satoshi per byte</span>
@ -149,7 +149,7 @@ transactions. Here's an example of how to use it</p>
<span class="hljs-keyword">val</span> changePrivKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey <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-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-keyword">val</span> changeSPK = <span class="hljs-type">P2PKHScriptPubKey</span>(pubKey = changePrivKey.publicKey)
<span class="hljs-comment">// changeSPK: P2PKHScriptPubKey = pkh(1cce31151541298a78a27171eb7b43519bf43f1e)</span> <span class="hljs-comment">// changeSPK: P2PKHScriptPubKey = pkh(1f73ab6b7e03f52c265433e6b3d22d847b584420)</span>
<span class="hljs-comment">// the network we are on, for this example we are using</span> <span class="hljs-comment">// the network we are on, for this example we are using</span>
<span class="hljs-comment">// the regression test network. This is a network you control</span> <span class="hljs-comment">// the regression test network. This is a network you control</span>
@ -168,7 +168,7 @@ transactions. Here's an example of how to use it</p>
network = networkParams) network = networkParams)
<span class="hljs-type">Await</span>.result(builderF, <span class="hljs-number">30.</span>seconds) <span class="hljs-type">Await</span>.result(builderF, <span class="hljs-number">30.</span>seconds)
} }
<span class="hljs-comment">// txBuilder: BitcoinTxBuilder = BitcoinTxBuilderImpl(Vector(TransactionOutput(5000 sats,pkh(23d4309ccf4d9ad7c231cf27e9b87f08687d53ff))),Map(TransactionOutPoint(be47f6cb75dc01e2a992dd08a35c86828adaa7df608e4f163d0bb1e6cb005152:0) -&gt; P2PKHSpendingInfo(TransactionOutPoint(be47f6cb75dc01e2a992dd08a35c86828adaa7df608e4f163d0bb1e6cb005152:0),10000 sats,pkh(c55521e7f6770b17c98bb3c59cec1451cae8689c),Masked(ECPrivateKeyImpl),SIGHASH_ALL(Int32Impl(1)))),SatoshisPerByte(1 sat),pkh(1cce31151541298a78a27171eb7b43519bf43f1e),RegTest)</span> <span class="hljs-comment">// txBuilder: BitcoinTxBuilder = BitcoinTxBuilderImpl(Vector(TransactionOutput(5000 sats,pkh(8696214d35b9f60566117d016a8b23fd0ed0306a))),Map(TransactionOutPoint(6e792d0a05d1ac855ca75eddfde1fc6a598afc565552228c473eae10ad5c7188:0) -&gt; P2PKHSpendingInfo(TransactionOutPoint(6e792d0a05d1ac855ca75eddfde1fc6a598afc565552228c473eae10ad5c7188:0),10000 sats,pkh(dbc3ec8fa69321aa8ed4b8c1fb715d5d646839d5),Masked(ECPrivateKeyImpl),SIGHASH_ALL(Int32Impl(1)))),SatoshisPerByte(1 sat),pkh(1f73ab6b7e03f52c265433e6b3d22d847b584420),RegTest)</span>
<span class="hljs-comment">// Let's finally produce a validly signed tx!</span> <span class="hljs-comment">// Let's finally produce a validly signed tx!</span>
<span class="hljs-comment">// The 'sign' method is going produce a validly signed transaction</span> <span class="hljs-comment">// The 'sign' method is going produce a validly signed transaction</span>
@ -182,7 +182,7 @@ transactions. Here's an example of how to use it</p>
<span class="hljs-keyword">val</span> signF = txBuilder.sign <span class="hljs-keyword">val</span> signF = txBuilder.sign
<span class="hljs-type">Await</span>.result(signF, <span class="hljs-number">30.</span>seconds) <span class="hljs-type">Await</span>.result(signF, <span class="hljs-number">30.</span>seconds)
} }
<span class="hljs-comment">// signedTx: Transaction = BaseTransactionImpl(Int32Impl(2),List(TransactionInputImpl(TransactionOutPoint(be47f6cb75dc01e2a992dd08a35c86828adaa7df608e4f163d0bb1e6cb005152:0),P2PKHScriptSignature(ECPublicKey(02d19ff7e158122eb30d05b8630087819cfa2ce78691c5d0179666c7bcbc1cd51f), ECDigitalSignature(3045022100a4591ea000026bd5385ee95d88dad1f875bcdcea3752ac58b1cefa4e21d209fa022034e13eaf7c182fd502c2de17183a03155b7b58df344658b409e967bb0aa207e701)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(23d4309ccf4d9ad7c231cf27e9b87f08687d53ff)), TransactionOutput(4774 sats,pkh(1cce31151541298a78a27171eb7b43519bf43f1e))),UInt32Impl(0))</span> <span class="hljs-comment">// signedTx: Transaction = BaseTransactionImpl(Int32Impl(2),List(TransactionInputImpl(TransactionOutPoint(6e792d0a05d1ac855ca75eddfde1fc6a598afc565552228c473eae10ad5c7188:0),P2PKHScriptSignature(ECPublicKey(032ba05e56199eb0ba7ec0a3f98ec826e88a28f1964fb514f7187540a8bdc5f5a5), ECDigitalSignature(3045022100f1ca3c0f64fea5307cec9ae3498385068a87a69b4703bb830cf2711fe60cb19b0220646f566829bf77dbb84e9089110f1101647199edc242d0957bdebc3cb5b1242401)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(8696214d35b9f60566117d016a8b23fd0ed0306a)), TransactionOutput(4774 sats,pkh(1f73ab6b7e03f52c265433e6b3d22d847b584420))),UInt32Impl(0))</span>
</code></pre> </code></pre>
<pre><code class="hljs css language-scala">signedTx.inputs.length <pre><code class="hljs css language-scala">signedTx.inputs.length
<span class="hljs-comment">// res0: Int = 1</span> <span class="hljs-comment">// res0: Int = 1</span>
@ -192,7 +192,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> <span class="hljs-comment">//remember, you can call .hex on any bitcoin-s data structure to get the hex representation!</span>
signedTx.hex signedTx.hex
<span class="hljs-comment">// res2: String = 0200000001525100cbe6b10b3d164f8e60dfa7da8a82865ca308dd92a9e201dc75cbf647be000000006b483045022100a4591ea000026bd5385ee95d88dad1f875bcdcea3752ac58b1cefa4e21d209fa022034e13eaf7c182fd502c2de17183a03155b7b58df344658b409e967bb0aa207e7012102d19ff7e158122eb30d05b8630087819cfa2ce78691c5d0179666c7bcbc1cd51f000000000288130000000000001976a91423d4309ccf4d9ad7c231cf27e9b87f08687d53ff88aca6120000000000001976a9141cce31151541298a78a27171eb7b43519bf43f1e88ac00000000</span> <span class="hljs-comment">// res2: String = 020000000188715cad10ae3e478c22525556fc8a596afce1fddd5ea75c85acd1050a2d796e000000006b483045022100f1ca3c0f64fea5307cec9ae3498385068a87a69b4703bb830cf2711fe60cb19b0220646f566829bf77dbb84e9089110f1101647199edc242d0957bdebc3cb5b124240121032ba05e56199eb0ba7ec0a3f98ec826e88a28f1964fb514f7187540a8bdc5f5a5000000000288130000000000001976a9148696214d35b9f60566117d016a8b23fd0ed0306a88aca6120000000000001976a9141f73ab6b7e03f52c265433e6b3d22d847b58442088ac00000000</span>
</code></pre> </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/key-manager/key-manager"><span>Key Manager</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/enQtNDEyMjY3MTg1MTg3LTYyYjkwOGUzMDQ4NDAwZjE1M2I3MmQyNWNlZjNlYjg4OGRjYTRjNWUwNjRjNjg4Y2NjZjAxYjU1N2JjMTU1YWM" 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 © 2020 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> </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/key-manager/key-manager"><span>Key Manager</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/enQtNDEyMjY3MTg1MTg3LTYyYjkwOGUzMDQ4NDAwZjE1M2I3MmQyNWNlZjNlYjg4OGRjYTRjNWUwNjRjNjg4Y2NjZjAxYjU1N2JjMTU1YWM" 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 © 2020 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) { document.addEventListener('keyup', function(e) {

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

@ -65,25 +65,25 @@
</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 builder that constructs and signs Bitcoin </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 builder that constructs and signs Bitcoin
transactions. Here's an example of how to use it</p> 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 <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@535f1182[Running, parallelism = 2, size = 1, active = 0, running = 0, steals = 9, tasks = 0, submissions = 0]</span> <span class="hljs-comment">// ec: ExecutionContext = scala.concurrent.impl.ExecutionContextImpl$$anon$3@2f73a246[Running, parallelism = 2, size = 1, active = 0, running = 0, steals = 9, tasks = 0, submissions = 0]</span>
<span class="hljs-comment">// generate a fresh private key that we are going to use in the scriptpubkey</span> <span class="hljs-comment">// generate a fresh private key that we are going to use in the scriptpubkey</span>
<span class="hljs-keyword">val</span> privKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey <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-comment">// privKey: ECPrivateKey = Masked(ECPrivateKeyImpl)</span>
<span class="hljs-keyword">val</span> pubKey = privKey.publicKey <span class="hljs-keyword">val</span> pubKey = privKey.publicKey
<span class="hljs-comment">// pubKey: ECPublicKey = ECPublicKey(02d19ff7e158122eb30d05b8630087819cfa2ce78691c5d0179666c7bcbc1cd51f)</span> <span class="hljs-comment">// pubKey: ECPublicKey = ECPublicKey(032ba05e56199eb0ba7ec0a3f98ec826e88a28f1964fb514f7187540a8bdc5f5a5)</span>
<span class="hljs-comment">// this is the script that the TxBuilder is going to create a</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-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-keyword">val</span> creditingSpk = <span class="hljs-type">P2PKHScriptPubKey</span>(pubKey = privKey.publicKey)
<span class="hljs-comment">// creditingSpk: P2PKHScriptPubKey = pkh(c55521e7f6770b17c98bb3c59cec1451cae8689c)</span> <span class="hljs-comment">// creditingSpk: P2PKHScriptPubKey = pkh(dbc3ec8fa69321aa8ed4b8c1fb715d5d646839d5)</span>
<span class="hljs-keyword">val</span> amount = <span class="hljs-number">10000.</span>satoshis <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">// amount: Satoshis = 10000 sats</span>
<span class="hljs-comment">// this is the UTXO we are going to be spending</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-keyword">val</span> utxo =
<span class="hljs-type">TransactionOutput</span>(value = amount, scriptPubKey = creditingSpk) <span class="hljs-type">TransactionOutput</span>(value = amount, scriptPubKey = creditingSpk)
<span class="hljs-comment">// utxo: TransactionOutput = TransactionOutput(10000 sats,pkh(c55521e7f6770b17c98bb3c59cec1451cae8689c))</span> <span class="hljs-comment">// utxo: TransactionOutput = TransactionOutput(10000 sats,pkh(dbc3ec8fa69321aa8ed4b8c1fb715d5d646839d5))</span>
<span class="hljs-comment">// the private key that locks the funds for the script we are spending too</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 <span class="hljs-keyword">val</span> destinationPrivKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey
@ -96,7 +96,7 @@ transactions. Here's an example of how to use it</p>
<span class="hljs-comment">// the script that corresponds to destination private key, this is what is protecting the money</span> <span class="hljs-comment">// the script that corresponds to destination private key, this is what is protecting the money</span>
<span class="hljs-keyword">val</span> destinationSPK = <span class="hljs-keyword">val</span> destinationSPK =
<span class="hljs-type">P2PKHScriptPubKey</span>(pubKey = destinationPrivKey.publicKey) <span class="hljs-type">P2PKHScriptPubKey</span>(pubKey = destinationPrivKey.publicKey)
<span class="hljs-comment">// destinationSPK: P2PKHScriptPubKey = pkh(23d4309ccf4d9ad7c231cf27e9b87f08687d53ff)</span> <span class="hljs-comment">// destinationSPK: P2PKHScriptPubKey = pkh(8696214d35b9f60566117d016a8b23fd0ed0306a)</span>
<span class="hljs-comment">// this is where we are sending money too</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> <span class="hljs-comment">// we could add more destinations here if we</span>
@ -107,7 +107,7 @@ transactions. Here's an example of how to use it</p>
<span class="hljs-type">Vector</span>(destination1) <span class="hljs-type">Vector</span>(destination1)
} }
<span class="hljs-comment">// destinations: Vector[TransactionOutput] = Vector(TransactionOutput(5000 sats,pkh(23d4309ccf4d9ad7c231cf27e9b87f08687d53ff)))</span> <span class="hljs-comment">// destinations: Vector[TransactionOutput] = Vector(TransactionOutput(5000 sats,pkh(8696214d35b9f60566117d016a8b23fd0ed0306a)))</span>
<span class="hljs-comment">// we have to fabricate a transaction that contains the</span> <span class="hljs-comment">// we have to fabricate a transaction that contains the</span>
<span class="hljs-comment">// UTXO we are trying to spend. If this were a real blockchain</span> <span class="hljs-comment">// UTXO we are trying to spend. If this were a real blockchain</span>
@ -116,12 +116,12 @@ transactions. Here's an example of how to use it</p>
inputs = <span class="hljs-type">Vector</span>.empty, inputs = <span class="hljs-type">Vector</span>.empty,
outputs = <span class="hljs-type">Vector</span>(utxo), outputs = <span class="hljs-type">Vector</span>(utxo),
lockTime = <span class="hljs-type">UInt32</span>.zero) lockTime = <span class="hljs-type">UInt32</span>.zero)
<span class="hljs-comment">// creditingTx: BaseTransaction = BaseTransactionImpl(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(c55521e7f6770b17c98bb3c59cec1451cae8689c))),UInt32Impl(0))</span> <span class="hljs-comment">// creditingTx: BaseTransaction = BaseTransactionImpl(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(dbc3ec8fa69321aa8ed4b8c1fb715d5d646839d5))),UInt32Impl(0))</span>
<span class="hljs-comment">// this is the information we need from the crediting TX</span> <span class="hljs-comment">// this is the information we need from the crediting TX</span>
<span class="hljs-comment">// to properly "link" it in the transaction we are creating</span> <span class="hljs-comment">// to properly "link" 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-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(be47f6cb75dc01e2a992dd08a35c86828adaa7df608e4f163d0bb1e6cb005152:0)</span> <span class="hljs-comment">// outPoint: TransactionOutPoint = TransactionOutPoint(6e792d0a05d1ac855ca75eddfde1fc6a598afc565552228c473eae10ad5c7188:0)</span>
<span class="hljs-comment">// this contains all the information we need to</span> <span class="hljs-comment">// this contains all the information we need to</span>
<span class="hljs-comment">// validly sign the UTXO above</span> <span class="hljs-comment">// validly sign the UTXO above</span>
@ -134,12 +134,12 @@ transactions. Here's an example of how to use it</p>
<span class="hljs-type">HashType</span>.sigHashAll, <span class="hljs-type">HashType</span>.sigHashAll,
conditionalPath = conditionalPath =
<span class="hljs-type">ConditionalPath</span>.<span class="hljs-type">NoConditionsLeft</span>) <span class="hljs-type">ConditionalPath</span>.<span class="hljs-type">NoConditionsLeft</span>)
<span class="hljs-comment">// utxoSpendingInfo: BitcoinUTXOSpendingInfoFull = P2PKHSpendingInfo(TransactionOutPoint(be47f6cb75dc01e2a992dd08a35c86828adaa7df608e4f163d0bb1e6cb005152:0),10000 sats,pkh(c55521e7f6770b17c98bb3c59cec1451cae8689c),Masked(ECPrivateKeyImpl),SIGHASH_ALL(Int32Impl(1)))</span> <span class="hljs-comment">// utxoSpendingInfo: BitcoinUTXOSpendingInfoFull = P2PKHSpendingInfo(TransactionOutPoint(6e792d0a05d1ac855ca75eddfde1fc6a598afc565552228c473eae10ad5c7188:0),10000 sats,pkh(dbc3ec8fa69321aa8ed4b8c1fb715d5d646839d5),Masked(ECPrivateKeyImpl),SIGHASH_ALL(Int32Impl(1)))</span>
<span class="hljs-comment">// all of the UTXO spending information, since we are only</span> <span class="hljs-comment">// all of the UTXO spending information, since we are only</span>
<span class="hljs-comment">//spending one UTXO, this is just one element</span> <span class="hljs-comment">//spending one UTXO, this is just one element</span>
<span class="hljs-keyword">val</span> utxos: <span class="hljs-type">Vector</span>[<span class="hljs-type">BitcoinUTXOSpendingInfoFull</span>] = <span class="hljs-type">Vector</span>(utxoSpendingInfo) <span class="hljs-keyword">val</span> utxos: <span class="hljs-type">Vector</span>[<span class="hljs-type">BitcoinUTXOSpendingInfoFull</span>] = <span class="hljs-type">Vector</span>(utxoSpendingInfo)
<span class="hljs-comment">// utxos: Vector[BitcoinUTXOSpendingInfoFull] = Vector(P2PKHSpendingInfo(TransactionOutPoint(be47f6cb75dc01e2a992dd08a35c86828adaa7df608e4f163d0bb1e6cb005152:0),10000 sats,pkh(c55521e7f6770b17c98bb3c59cec1451cae8689c),Masked(ECPrivateKeyImpl),SIGHASH_ALL(Int32Impl(1))))</span> <span class="hljs-comment">// utxos: Vector[BitcoinUTXOSpendingInfoFull] = Vector(P2PKHSpendingInfo(TransactionOutPoint(6e792d0a05d1ac855ca75eddfde1fc6a598afc565552228c473eae10ad5c7188:0),10000 sats,pkh(dbc3ec8fa69321aa8ed4b8c1fb715d5d646839d5),Masked(ECPrivateKeyImpl),SIGHASH_ALL(Int32Impl(1))))</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">// 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> <span class="hljs-comment">// for this example, we are going to pay 1 satoshi per byte</span>
@ -149,7 +149,7 @@ transactions. Here's an example of how to use it</p>
<span class="hljs-keyword">val</span> changePrivKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey <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-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-keyword">val</span> changeSPK = <span class="hljs-type">P2PKHScriptPubKey</span>(pubKey = changePrivKey.publicKey)
<span class="hljs-comment">// changeSPK: P2PKHScriptPubKey = pkh(1cce31151541298a78a27171eb7b43519bf43f1e)</span> <span class="hljs-comment">// changeSPK: P2PKHScriptPubKey = pkh(1f73ab6b7e03f52c265433e6b3d22d847b584420)</span>
<span class="hljs-comment">// the network we are on, for this example we are using</span> <span class="hljs-comment">// the network we are on, for this example we are using</span>
<span class="hljs-comment">// the regression test network. This is a network you control</span> <span class="hljs-comment">// the regression test network. This is a network you control</span>
@ -168,7 +168,7 @@ transactions. Here's an example of how to use it</p>
network = networkParams) network = networkParams)
<span class="hljs-type">Await</span>.result(builderF, <span class="hljs-number">30.</span>seconds) <span class="hljs-type">Await</span>.result(builderF, <span class="hljs-number">30.</span>seconds)
} }
<span class="hljs-comment">// txBuilder: BitcoinTxBuilder = BitcoinTxBuilderImpl(Vector(TransactionOutput(5000 sats,pkh(23d4309ccf4d9ad7c231cf27e9b87f08687d53ff))),Map(TransactionOutPoint(be47f6cb75dc01e2a992dd08a35c86828adaa7df608e4f163d0bb1e6cb005152:0) -&gt; P2PKHSpendingInfo(TransactionOutPoint(be47f6cb75dc01e2a992dd08a35c86828adaa7df608e4f163d0bb1e6cb005152:0),10000 sats,pkh(c55521e7f6770b17c98bb3c59cec1451cae8689c),Masked(ECPrivateKeyImpl),SIGHASH_ALL(Int32Impl(1)))),SatoshisPerByte(1 sat),pkh(1cce31151541298a78a27171eb7b43519bf43f1e),RegTest)</span> <span class="hljs-comment">// txBuilder: BitcoinTxBuilder = BitcoinTxBuilderImpl(Vector(TransactionOutput(5000 sats,pkh(8696214d35b9f60566117d016a8b23fd0ed0306a))),Map(TransactionOutPoint(6e792d0a05d1ac855ca75eddfde1fc6a598afc565552228c473eae10ad5c7188:0) -&gt; P2PKHSpendingInfo(TransactionOutPoint(6e792d0a05d1ac855ca75eddfde1fc6a598afc565552228c473eae10ad5c7188:0),10000 sats,pkh(dbc3ec8fa69321aa8ed4b8c1fb715d5d646839d5),Masked(ECPrivateKeyImpl),SIGHASH_ALL(Int32Impl(1)))),SatoshisPerByte(1 sat),pkh(1f73ab6b7e03f52c265433e6b3d22d847b584420),RegTest)</span>
<span class="hljs-comment">// Let's finally produce a validly signed tx!</span> <span class="hljs-comment">// Let's finally produce a validly signed tx!</span>
<span class="hljs-comment">// The 'sign' method is going produce a validly signed transaction</span> <span class="hljs-comment">// The 'sign' method is going produce a validly signed transaction</span>
@ -182,7 +182,7 @@ transactions. Here's an example of how to use it</p>
<span class="hljs-keyword">val</span> signF = txBuilder.sign <span class="hljs-keyword">val</span> signF = txBuilder.sign
<span class="hljs-type">Await</span>.result(signF, <span class="hljs-number">30.</span>seconds) <span class="hljs-type">Await</span>.result(signF, <span class="hljs-number">30.</span>seconds)
} }
<span class="hljs-comment">// signedTx: Transaction = BaseTransactionImpl(Int32Impl(2),List(TransactionInputImpl(TransactionOutPoint(be47f6cb75dc01e2a992dd08a35c86828adaa7df608e4f163d0bb1e6cb005152:0),P2PKHScriptSignature(ECPublicKey(02d19ff7e158122eb30d05b8630087819cfa2ce78691c5d0179666c7bcbc1cd51f), ECDigitalSignature(3045022100a4591ea000026bd5385ee95d88dad1f875bcdcea3752ac58b1cefa4e21d209fa022034e13eaf7c182fd502c2de17183a03155b7b58df344658b409e967bb0aa207e701)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(23d4309ccf4d9ad7c231cf27e9b87f08687d53ff)), TransactionOutput(4774 sats,pkh(1cce31151541298a78a27171eb7b43519bf43f1e))),UInt32Impl(0))</span> <span class="hljs-comment">// signedTx: Transaction = BaseTransactionImpl(Int32Impl(2),List(TransactionInputImpl(TransactionOutPoint(6e792d0a05d1ac855ca75eddfde1fc6a598afc565552228c473eae10ad5c7188:0),P2PKHScriptSignature(ECPublicKey(032ba05e56199eb0ba7ec0a3f98ec826e88a28f1964fb514f7187540a8bdc5f5a5), ECDigitalSignature(3045022100f1ca3c0f64fea5307cec9ae3498385068a87a69b4703bb830cf2711fe60cb19b0220646f566829bf77dbb84e9089110f1101647199edc242d0957bdebc3cb5b1242401)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(8696214d35b9f60566117d016a8b23fd0ed0306a)), TransactionOutput(4774 sats,pkh(1f73ab6b7e03f52c265433e6b3d22d847b584420))),UInt32Impl(0))</span>
</code></pre> </code></pre>
<pre><code class="hljs css language-scala">signedTx.inputs.length <pre><code class="hljs css language-scala">signedTx.inputs.length
<span class="hljs-comment">// res0: Int = 1</span> <span class="hljs-comment">// res0: Int = 1</span>
@ -192,7 +192,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> <span class="hljs-comment">//remember, you can call .hex on any bitcoin-s data structure to get the hex representation!</span>
signedTx.hex signedTx.hex
<span class="hljs-comment">// res2: String = 0200000001525100cbe6b10b3d164f8e60dfa7da8a82865ca308dd92a9e201dc75cbf647be000000006b483045022100a4591ea000026bd5385ee95d88dad1f875bcdcea3752ac58b1cefa4e21d209fa022034e13eaf7c182fd502c2de17183a03155b7b58df344658b409e967bb0aa207e7012102d19ff7e158122eb30d05b8630087819cfa2ce78691c5d0179666c7bcbc1cd51f000000000288130000000000001976a91423d4309ccf4d9ad7c231cf27e9b87f08687d53ff88aca6120000000000001976a9141cce31151541298a78a27171eb7b43519bf43f1e88ac00000000</span> <span class="hljs-comment">// res2: String = 020000000188715cad10ae3e478c22525556fc8a596afce1fddd5ea75c85acd1050a2d796e000000006b483045022100f1ca3c0f64fea5307cec9ae3498385068a87a69b4703bb830cf2711fe60cb19b0220646f566829bf77dbb84e9089110f1101647199edc242d0957bdebc3cb5b124240121032ba05e56199eb0ba7ec0a3f98ec826e88a28f1964fb514f7187540a8bdc5f5a5000000000288130000000000001976a9148696214d35b9f60566117d016a8b23fd0ed0306a88aca6120000000000001976a9141f73ab6b7e03f52c265433e6b3d22d847b58442088ac00000000</span>
</code></pre> </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/key-manager/key-manager"><span>Key Manager</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/enQtNDEyMjY3MTg1MTg3LTYyYjkwOGUzMDQ4NDAwZjE1M2I3MmQyNWNlZjNlYjg4OGRjYTRjNWUwNjRjNjg4Y2NjZjAxYjU1N2JjMTU1YWM" 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 © 2020 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> </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/key-manager/key-manager"><span>Key Manager</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/enQtNDEyMjY3MTg1MTg3LTYyYjkwOGUzMDQ4NDAwZjE1M2I3MmQyNWNlZjNlYjg4OGRjYTRjNWUwNjRjNjg4Y2NjZjAxYjU1N2JjMTU1YWM" 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 © 2020 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) { document.addEventListener('keyup', function(e) {

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

@ -120,7 +120,7 @@ libraryDependencies += <span class="hljs-string">"org.bitcoin-s"</span> %% <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> <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 <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 adding a snapshot build to your <code>build.sbt</code>. The most
recent snapshot published is <code>0.3.0+73-ce33c57e-SNAPSHOT</code>.</p> recent snapshot published is <code>0.3.0+74-ee852bd3-SNAPSHOT</code>.</p>
<p>To fetch snapshots, you will need to add the correct <p>To fetch snapshots, you will need to add the correct
resolver in your <code>build.sbt</code>:</p> resolver in your <code>build.sbt</code>:</p>
<p>​```sbt <p>​```sbt

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

@ -120,7 +120,7 @@ libraryDependencies += <span class="hljs-string">"org.bitcoin-s"</span> %% <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> <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 <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 adding a snapshot build to your <code>build.sbt</code>. The most
recent snapshot published is <code>0.3.0+73-ce33c57e-SNAPSHOT</code>.</p> recent snapshot published is <code>0.3.0+74-ee852bd3-SNAPSHOT</code>.</p>
<p>To fetch snapshots, you will need to add the correct <p>To fetch snapshots, you will need to add the correct
resolver in your <code>build.sbt</code>:</p> resolver in your <code>build.sbt</code>:</p>
<p>​```sbt <p>​```sbt

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

@ -85,14 +85,14 @@ as a logical distinction for further development in subsequent releases.</p>
<span class="hljs-comment">//get 256 bits of random entropy</span> <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-keyword">val</span> entropy = <span class="hljs-type">MnemonicCode</span>.getEntropy256Bits
<span class="hljs-comment">// entropy: scodec.bits.BitVector = BitVector(256 bits, 0xc07cfb0b171f1d5c103f86fe6faeddb94cdbcf8a5126a5fd4ea2128dd1b98372)</span> <span class="hljs-comment">// entropy: scodec.bits.BitVector = BitVector(256 bits, 0x3a8950f2e406d84ef2ec2c00e87673094019419d467ff4d47e405e7937810e2f)</span>
<span class="hljs-keyword">val</span> mnemonic = <span class="hljs-type">MnemonicCode</span>.fromEntropy(entropy) <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">// mnemonic: MnemonicCode = Masked(MnemonicCodeImpl)</span>
<span class="hljs-comment">//you can print that mnemonic seed with this</span> <span class="hljs-comment">//you can print that mnemonic seed with this</span>
println(mnemonic.words) println(mnemonic.words)
<span class="hljs-comment">// Vector(scatter, treat, security, comfort, vault, puppy, domain, valid, wrist, latin, resist, income, soap, treat, citizen, cave, planet, tuna, possible, celery, tackle, system, assist, economy)</span> <span class="hljs-comment">// Vector(dentist, enhance, device, siege, horn, cherry, slight, machine, abstract, dry, orphan, barely, account, patch, insect, soup, visit, physical, mosquito, rude, nature, scene, december, trend)</span>
</code></pre> </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 <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> generate specific kinds of addresses for wallets.</p>
@ -107,7 +107,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 'key-manager-example` that will</span> <pre><code class="hljs css language-scala"><span class="hljs-comment">//this will create a temp directory with the prefix 'key-manager-example` that will</span>
<span class="hljs-comment">//have a file in it called "encrypted-bitcoin-s-seed.json"</span> <span class="hljs-comment">//have a file in it called "encrypted-bitcoin-s-seed.json"</span>
<span class="hljs-keyword">val</span> seedPath = <span class="hljs-type">Files</span>.createTempDirectory(<span class="hljs-string">"key-manager-example"</span>).resolve(<span class="hljs-type">WalletStorage</span>.<span class="hljs-type">ENCRYPTED_SEED_FILE_NAME</span>) <span class="hljs-keyword">val</span> seedPath = <span class="hljs-type">Files</span>.createTempDirectory(<span class="hljs-string">"key-manager-example"</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-example17846083769437395655/encrypted-bitcoin-s-seed.json</span> <span class="hljs-comment">// seedPath: Path = /tmp/key-manager-example8341995915013120438/encrypted-bitcoin-s-seed.json</span>
<span class="hljs-comment">//let's create a native segwit key manager</span> <span class="hljs-comment">//let'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> <span class="hljs-keyword">val</span> purpose = <span class="hljs-type">HDPurposes</span>.<span class="hljs-type">SegWit</span>
@ -118,16 +118,16 @@ generate specific kinds of addresses for wallets.</p>
<span class="hljs-comment">// network: RegTest.type = RegTest</span> <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-keyword">val</span> kmParams = <span class="hljs-type">KeyManagerParams</span>(seedPath, purpose, network)
<span class="hljs-comment">// kmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example17846083769437395655/encrypted-bitcoin-s-seed.json,m/84',RegTest)</span> <span class="hljs-comment">// kmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example8341995915013120438/encrypted-bitcoin-s-seed.json,m/84',RegTest)</span>
<span class="hljs-keyword">val</span> km = <span class="hljs-type">BIP39KeyManager</span>.initializeWithMnemonic(mnemonic, <span class="hljs-type">None</span>, kmParams) <span class="hljs-keyword">val</span> km = <span class="hljs-type">BIP39KeyManager</span>.initializeWithMnemonic(mnemonic, <span class="hljs-type">None</span>, kmParams)
<span class="hljs-comment">// km: Either[KeyManagerInitializeError, BIP39KeyManager] = Right(BIP39KeyManager(Masked(MnemonicCodeImpl),KeyManagerParams(/tmp/key-manager-example17846083769437395655/encrypted-bitcoin-s-seed.json,m/84',RegTest),None))</span> <span class="hljs-comment">// km: Either[KeyManagerInitializeError, BIP39KeyManager] = Right(BIP39KeyManager(Masked(MnemonicCodeImpl),KeyManagerParams(/tmp/key-manager-example8341995915013120438/encrypted-bitcoin-s-seed.json,m/84',RegTest),None))</span>
<span class="hljs-keyword">val</span> rootXPub = km.right.get.getRootXPub <span class="hljs-keyword">val</span> rootXPub = km.right.get.getRootXPub
<span class="hljs-comment">// rootXPub: ExtPublicKey = vpub5SLqN2bLY4WeYvmdtAZU5NbTs5VrJXnHor5wJmHiRJN1mNhFt6N6tYhJPmU2SToGkmTqgDPEYFzXBTES61f57ur317koZ8gh8jNyf577aFX</span> <span class="hljs-comment">// rootXPub: ExtPublicKey = vpub5SLqN2bLY4WeYEDDawQwh7YUBSr1xA33WLYetKLbcZF4QqAetD7CUdEC68RBB9GtkAwaYoUHtPT78HU5rcJoWSUD9DxcZe3vNkoGTBKjQZy</span>
println(rootXPub) println(rootXPub)
<span class="hljs-comment">// vpub5SLqN2bLY4WeYvmdtAZU5NbTs5VrJXnHor5wJmHiRJN1mNhFt6N6tYhJPmU2SToGkmTqgDPEYFzXBTES61f57ur317koZ8gh8jNyf577aFX</span> <span class="hljs-comment">// vpub5SLqN2bLY4WeYEDDawQwh7YUBSr1xA33WLYetKLbcZF4QqAetD7CUdEC68RBB9GtkAwaYoUHtPT78HU5rcJoWSUD9DxcZe3vNkoGTBKjQZy</span>
</code></pre> </code></pre>
<p>Which should print something that looks like this</p> <p>Which should print something that looks like this</p>
<p><code>vpub5SLqN2bLY4WeXxMqwJHJFBEwxSscGB2uDUnsTS3edVjZEwTrQDFDNqoR2xLqARQPabGaXsHSTenTRcqm2EnB9MpuC4vSk3LqSgNmGGZtuq7</code></p> <p><code>vpub5SLqN2bLY4WeXxMqwJHJFBEwxSscGB2uDUnsTS3edVjZEwTrQDFDNqoR2xLqARQPabGaXsHSTenTRcqm2EnB9MpuC4vSk3LqSgNmGGZtuq7</code></p>
@ -136,17 +136,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> 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's create a nested segwit key manager for mainnet</span> <pre><code class="hljs css language-scala"><span class="hljs-comment">//let'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-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-example17846083769437395655/encrypted-bitcoin-s-seed.json,m/84',MainNet)</span> <span class="hljs-comment">// mainnetKmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example8341995915013120438/encrypted-bitcoin-s-seed.json,m/84',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-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>(mnemonic, mainnetKmParams, <span class="hljs-type">None</span>) <span class="hljs-keyword">val</span> mainnetKeyManager = <span class="hljs-type">BIP39KeyManager</span>(mnemonic, mainnetKmParams, <span class="hljs-type">None</span>)
<span class="hljs-comment">// mainnetKeyManager: BIP39KeyManager = BIP39KeyManager(Masked(MnemonicCodeImpl),KeyManagerParams(/tmp/key-manager-example17846083769437395655/encrypted-bitcoin-s-seed.json,m/84',MainNet),None)</span> <span class="hljs-comment">// mainnetKeyManager: BIP39KeyManager = BIP39KeyManager(Masked(MnemonicCodeImpl),KeyManagerParams(/tmp/key-manager-example8341995915013120438/encrypted-bitcoin-s-seed.json,m/84',MainNet),None)</span>
<span class="hljs-keyword">val</span> mainnetXpub = mainnetKeyManager.getRootXPub <span class="hljs-keyword">val</span> mainnetXpub = mainnetKeyManager.getRootXPub
<span class="hljs-comment">// mainnetXpub: ExtPublicKey = zpub6jftahH18ngZx7Y7DbhxuiyUYx5e51kHUJApSLsFwKsXymxAtj2MNoKrUbJNS6QxPKw4g7mUNuQiibggxoK8JraSUUYVtmxeDddZDQCaLvr</span> <span class="hljs-comment">// mainnetXpub: ExtPublicKey = zpub6jftahH18ngZwQygvNZSXTvUsKRoie13AndY1tv98akadERZtqmSxsrkAxFXAmtaNjQoYhrXj2sJfRvLjPxrhPCccakJuHKsTf3r1YGsT8c</span>
println(mainnetXpub) println(mainnetXpub)
<span class="hljs-comment">// zpub6jftahH18ngZx7Y7DbhxuiyUYx5e51kHUJApSLsFwKsXymxAtj2MNoKrUbJNS6QxPKw4g7mUNuQiibggxoK8JraSUUYVtmxeDddZDQCaLvr</span> <span class="hljs-comment">// zpub6jftahH18ngZwQygvNZSXTvUsKRoie13AndY1tv98akadERZtqmSxsrkAxFXAmtaNjQoYhrXj2sJfRvLjPxrhPCccakJuHKsTf3r1YGsT8c</span>
</code></pre> </code></pre>
<p>Which gives us something that looks like this</p> <p>Which gives us something that looks like this</p>
<p><code>zpub6jftahH18ngZw98KGjRo5XcxeKTQ2eztsvskb1dC9XF5TLimQquTs6Ry7nBBA425D9joXmfgJJCexmJ1u2SELJZJfRi95gcnXadLpZzYb5c</code></p> <p><code>zpub6jftahH18ngZw98KGjRo5XcxeKTQ2eztsvskb1dC9XF5TLimQquTs6Ry7nBBA425D9joXmfgJJCexmJ1u2SELJZJfRi95gcnXadLpZzYb5c</code></p>

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

@ -85,14 +85,14 @@ as a logical distinction for further development in subsequent releases.</p>
<span class="hljs-comment">//get 256 bits of random entropy</span> <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-keyword">val</span> entropy = <span class="hljs-type">MnemonicCode</span>.getEntropy256Bits
<span class="hljs-comment">// entropy: scodec.bits.BitVector = BitVector(256 bits, 0xc07cfb0b171f1d5c103f86fe6faeddb94cdbcf8a5126a5fd4ea2128dd1b98372)</span> <span class="hljs-comment">// entropy: scodec.bits.BitVector = BitVector(256 bits, 0x3a8950f2e406d84ef2ec2c00e87673094019419d467ff4d47e405e7937810e2f)</span>
<span class="hljs-keyword">val</span> mnemonic = <span class="hljs-type">MnemonicCode</span>.fromEntropy(entropy) <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">// mnemonic: MnemonicCode = Masked(MnemonicCodeImpl)</span>
<span class="hljs-comment">//you can print that mnemonic seed with this</span> <span class="hljs-comment">//you can print that mnemonic seed with this</span>
println(mnemonic.words) println(mnemonic.words)
<span class="hljs-comment">// Vector(scatter, treat, security, comfort, vault, puppy, domain, valid, wrist, latin, resist, income, soap, treat, citizen, cave, planet, tuna, possible, celery, tackle, system, assist, economy)</span> <span class="hljs-comment">// Vector(dentist, enhance, device, siege, horn, cherry, slight, machine, abstract, dry, orphan, barely, account, patch, insect, soup, visit, physical, mosquito, rude, nature, scene, december, trend)</span>
</code></pre> </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 <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> generate specific kinds of addresses for wallets.</p>
@ -107,7 +107,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 'key-manager-example` that will</span> <pre><code class="hljs css language-scala"><span class="hljs-comment">//this will create a temp directory with the prefix 'key-manager-example` that will</span>
<span class="hljs-comment">//have a file in it called "encrypted-bitcoin-s-seed.json"</span> <span class="hljs-comment">//have a file in it called "encrypted-bitcoin-s-seed.json"</span>
<span class="hljs-keyword">val</span> seedPath = <span class="hljs-type">Files</span>.createTempDirectory(<span class="hljs-string">"key-manager-example"</span>).resolve(<span class="hljs-type">WalletStorage</span>.<span class="hljs-type">ENCRYPTED_SEED_FILE_NAME</span>) <span class="hljs-keyword">val</span> seedPath = <span class="hljs-type">Files</span>.createTempDirectory(<span class="hljs-string">"key-manager-example"</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-example17846083769437395655/encrypted-bitcoin-s-seed.json</span> <span class="hljs-comment">// seedPath: Path = /tmp/key-manager-example8341995915013120438/encrypted-bitcoin-s-seed.json</span>
<span class="hljs-comment">//let's create a native segwit key manager</span> <span class="hljs-comment">//let'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> <span class="hljs-keyword">val</span> purpose = <span class="hljs-type">HDPurposes</span>.<span class="hljs-type">SegWit</span>
@ -118,16 +118,16 @@ generate specific kinds of addresses for wallets.</p>
<span class="hljs-comment">// network: RegTest.type = RegTest</span> <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-keyword">val</span> kmParams = <span class="hljs-type">KeyManagerParams</span>(seedPath, purpose, network)
<span class="hljs-comment">// kmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example17846083769437395655/encrypted-bitcoin-s-seed.json,m/84',RegTest)</span> <span class="hljs-comment">// kmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example8341995915013120438/encrypted-bitcoin-s-seed.json,m/84',RegTest)</span>
<span class="hljs-keyword">val</span> km = <span class="hljs-type">BIP39KeyManager</span>.initializeWithMnemonic(mnemonic, <span class="hljs-type">None</span>, kmParams) <span class="hljs-keyword">val</span> km = <span class="hljs-type">BIP39KeyManager</span>.initializeWithMnemonic(mnemonic, <span class="hljs-type">None</span>, kmParams)
<span class="hljs-comment">// km: Either[KeyManagerInitializeError, BIP39KeyManager] = Right(BIP39KeyManager(Masked(MnemonicCodeImpl),KeyManagerParams(/tmp/key-manager-example17846083769437395655/encrypted-bitcoin-s-seed.json,m/84',RegTest),None))</span> <span class="hljs-comment">// km: Either[KeyManagerInitializeError, BIP39KeyManager] = Right(BIP39KeyManager(Masked(MnemonicCodeImpl),KeyManagerParams(/tmp/key-manager-example8341995915013120438/encrypted-bitcoin-s-seed.json,m/84',RegTest),None))</span>
<span class="hljs-keyword">val</span> rootXPub = km.right.get.getRootXPub <span class="hljs-keyword">val</span> rootXPub = km.right.get.getRootXPub
<span class="hljs-comment">// rootXPub: ExtPublicKey = vpub5SLqN2bLY4WeYvmdtAZU5NbTs5VrJXnHor5wJmHiRJN1mNhFt6N6tYhJPmU2SToGkmTqgDPEYFzXBTES61f57ur317koZ8gh8jNyf577aFX</span> <span class="hljs-comment">// rootXPub: ExtPublicKey = vpub5SLqN2bLY4WeYEDDawQwh7YUBSr1xA33WLYetKLbcZF4QqAetD7CUdEC68RBB9GtkAwaYoUHtPT78HU5rcJoWSUD9DxcZe3vNkoGTBKjQZy</span>
println(rootXPub) println(rootXPub)
<span class="hljs-comment">// vpub5SLqN2bLY4WeYvmdtAZU5NbTs5VrJXnHor5wJmHiRJN1mNhFt6N6tYhJPmU2SToGkmTqgDPEYFzXBTES61f57ur317koZ8gh8jNyf577aFX</span> <span class="hljs-comment">// vpub5SLqN2bLY4WeYEDDawQwh7YUBSr1xA33WLYetKLbcZF4QqAetD7CUdEC68RBB9GtkAwaYoUHtPT78HU5rcJoWSUD9DxcZe3vNkoGTBKjQZy</span>
</code></pre> </code></pre>
<p>Which should print something that looks like this</p> <p>Which should print something that looks like this</p>
<p><code>vpub5SLqN2bLY4WeXxMqwJHJFBEwxSscGB2uDUnsTS3edVjZEwTrQDFDNqoR2xLqARQPabGaXsHSTenTRcqm2EnB9MpuC4vSk3LqSgNmGGZtuq7</code></p> <p><code>vpub5SLqN2bLY4WeXxMqwJHJFBEwxSscGB2uDUnsTS3edVjZEwTrQDFDNqoR2xLqARQPabGaXsHSTenTRcqm2EnB9MpuC4vSk3LqSgNmGGZtuq7</code></p>
@ -136,17 +136,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> 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's create a nested segwit key manager for mainnet</span> <pre><code class="hljs css language-scala"><span class="hljs-comment">//let'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-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-example17846083769437395655/encrypted-bitcoin-s-seed.json,m/84',MainNet)</span> <span class="hljs-comment">// mainnetKmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example8341995915013120438/encrypted-bitcoin-s-seed.json,m/84',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-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>(mnemonic, mainnetKmParams, <span class="hljs-type">None</span>) <span class="hljs-keyword">val</span> mainnetKeyManager = <span class="hljs-type">BIP39KeyManager</span>(mnemonic, mainnetKmParams, <span class="hljs-type">None</span>)
<span class="hljs-comment">// mainnetKeyManager: BIP39KeyManager = BIP39KeyManager(Masked(MnemonicCodeImpl),KeyManagerParams(/tmp/key-manager-example17846083769437395655/encrypted-bitcoin-s-seed.json,m/84',MainNet),None)</span> <span class="hljs-comment">// mainnetKeyManager: BIP39KeyManager = BIP39KeyManager(Masked(MnemonicCodeImpl),KeyManagerParams(/tmp/key-manager-example8341995915013120438/encrypted-bitcoin-s-seed.json,m/84',MainNet),None)</span>
<span class="hljs-keyword">val</span> mainnetXpub = mainnetKeyManager.getRootXPub <span class="hljs-keyword">val</span> mainnetXpub = mainnetKeyManager.getRootXPub
<span class="hljs-comment">// mainnetXpub: ExtPublicKey = zpub6jftahH18ngZx7Y7DbhxuiyUYx5e51kHUJApSLsFwKsXymxAtj2MNoKrUbJNS6QxPKw4g7mUNuQiibggxoK8JraSUUYVtmxeDddZDQCaLvr</span> <span class="hljs-comment">// mainnetXpub: ExtPublicKey = zpub6jftahH18ngZwQygvNZSXTvUsKRoie13AndY1tv98akadERZtqmSxsrkAxFXAmtaNjQoYhrXj2sJfRvLjPxrhPCccakJuHKsTf3r1YGsT8c</span>
println(mainnetXpub) println(mainnetXpub)
<span class="hljs-comment">// zpub6jftahH18ngZx7Y7DbhxuiyUYx5e51kHUJApSLsFwKsXymxAtj2MNoKrUbJNS6QxPKw4g7mUNuQiibggxoK8JraSUUYVtmxeDddZDQCaLvr</span> <span class="hljs-comment">// zpub6jftahH18ngZwQygvNZSXTvUsKRoie13AndY1tv98akadERZtqmSxsrkAxFXAmtaNjQoYhrXj2sJfRvLjPxrhPCccakJuHKsTf3r1YGsT8c</span>
</code></pre> </code></pre>
<p>Which gives us something that looks like this</p> <p>Which gives us something that looks like this</p>
<p><code>zpub6jftahH18ngZw98KGjRo5XcxeKTQ2eztsvskb1dC9XF5TLimQquTs6Ry7nBBA425D9joXmfgJJCexmJ1u2SELJZJfRi95gcnXadLpZzYb5c</code></p> <p><code>zpub6jftahH18ngZw98KGjRo5XcxeKTQ2eztsvskb1dC9XF5TLimQquTs6Ry7nBBA425D9joXmfgJJCexmJ1u2SELJZJfRi95gcnXadLpZzYb5c</code></p>

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

@ -114,12 +114,12 @@ println(<span class="hljs-string">s"Verified with NativeSecp256k1 again=<span cl
<pre><code class="hljs css language-scala"><span class="hljs-keyword">val</span> privKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey <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-comment">// privKey: ECPrivateKey = Masked(ECPrivateKeyImpl)</span>
<span class="hljs-keyword">val</span> publicKey = privKey.publicKeyWithBouncyCastle <span class="hljs-keyword">val</span> publicKey = privKey.publicKeyWithBouncyCastle
<span class="hljs-comment">// publicKey: ECPublicKey = ECPublicKey(036f74e00d97ad73acaaf86a321e87bbb1c77656c19f2d187476467d69905d0efd)</span> <span class="hljs-comment">// publicKey: ECPublicKey = ECPublicKey(021165f3a262bd564629e4681194ce2d256b8a771d93e1e561eb439cb2f1437374)</span>
<span class="hljs-keyword">val</span> dataToSign = <span class="hljs-type">DoubleSha256Digest</span>.empty <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-comment">// dataToSign: DoubleSha256Digest = DoubleSha256Digest(0000000000000000000000000000000000000000000000000000000000000000)</span>
<span class="hljs-keyword">val</span> signature = privKey.signWithBouncyCastle(dataToSign.bytes) <span class="hljs-keyword">val</span> signature = privKey.signWithBouncyCastle(dataToSign.bytes)
<span class="hljs-comment">// signature: ECDigitalSignature = ECDigitalSignature(3045022100b71fb639537aeaf8588c52b25be9489bf0d1ad993070f4881be27c2a36f9f099022075f16a9af4e1bdf2588a6941ee94a3c37f6bcc80fcbc5352eb2477b899ac260d)</span> <span class="hljs-comment">// signature: ECDigitalSignature = ECDigitalSignature(3045022100958cb85a0000e6db1b05473bb6fb3680acdb53794f780da4aaf203088cbdab1202207842fa67e427cc603fd448e98de8902f3559b89ca7d0bff9170b53a91c911e9d)</span>
<span class="hljs-keyword">val</span> verified = publicKey.verifyWithBouncyCastle(dataToSign.bytes, signature) <span class="hljs-keyword">val</span> verified = publicKey.verifyWithBouncyCastle(dataToSign.bytes, signature)
<span class="hljs-comment">// verified: Boolean = true</span> <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"Verified with NativeSecp256k1 again=<span cl
<pre><code class="hljs css language-scala"><span class="hljs-keyword">val</span> privKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey <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-comment">// privKey: ECPrivateKey = Masked(ECPrivateKeyImpl)</span>
<span class="hljs-keyword">val</span> publicKey = privKey.publicKeyWithBouncyCastle <span class="hljs-keyword">val</span> publicKey = privKey.publicKeyWithBouncyCastle
<span class="hljs-comment">// publicKey: ECPublicKey = ECPublicKey(036f74e00d97ad73acaaf86a321e87bbb1c77656c19f2d187476467d69905d0efd)</span> <span class="hljs-comment">// publicKey: ECPublicKey = ECPublicKey(021165f3a262bd564629e4681194ce2d256b8a771d93e1e561eb439cb2f1437374)</span>
<span class="hljs-keyword">val</span> dataToSign = <span class="hljs-type">DoubleSha256Digest</span>.empty <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-comment">// dataToSign: DoubleSha256Digest = DoubleSha256Digest(0000000000000000000000000000000000000000000000000000000000000000)</span>
<span class="hljs-keyword">val</span> signature = privKey.signWithBouncyCastle(dataToSign.bytes) <span class="hljs-keyword">val</span> signature = privKey.signWithBouncyCastle(dataToSign.bytes)
<span class="hljs-comment">// signature: ECDigitalSignature = ECDigitalSignature(3045022100b71fb639537aeaf8588c52b25be9489bf0d1ad993070f4881be27c2a36f9f099022075f16a9af4e1bdf2588a6941ee94a3c37f6bcc80fcbc5352eb2477b899ac260d)</span> <span class="hljs-comment">// signature: ECDigitalSignature = ECDigitalSignature(3045022100958cb85a0000e6db1b05473bb6fb3680acdb53794f780da4aaf203088cbdab1202207842fa67e427cc603fd448e98de8902f3559b89ca7d0bff9170b53a91c911e9d)</span>
<span class="hljs-keyword">val</span> verified = publicKey.verifyWithBouncyCastle(dataToSign.bytes, signature) <span class="hljs-keyword">val</span> verified = publicKey.verifyWithBouncyCastle(dataToSign.bytes, signature)
<span class="hljs-comment">// verified: Boolean = true</span> <span class="hljs-comment">// verified: Boolean = true</span>