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 260f52fe27
This commit is contained in:
Docusaurus bot 2020-04-24 15:20:08 +00:00
parent b9db138272
commit 5e40328f4b
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(020851d71be8a1a7795ae3d7e49b83c088ebf7c2f5e0b738bbbbf224fded89dbdf)</span> <span class="hljs-comment">// pubkey: crypto.ECPublicKey = ECPublicKey(0309e0c6546ade413e985468f89e89e38b2b2e077f92709da240921c01f9f0d682)</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(tb1qyypfj39809vnwr0093n43uvp79jfhwp2tn9g2l)</span> <span class="hljs-comment">// segwitAddress: Bech32Address = Bech32Address(tb1qh4xwt39chy7xajc3w0zr8s96aknvk424djrveq)</span>
println(segwitAddress.toString) println(segwitAddress.toString)
<span class="hljs-comment">// Bech32Address(tb1qyypfj39809vnwr0093n43uvp79jfhwp2tn9g2l)</span> <span class="hljs-comment">// Bech32Address(tb1qh4xwt39chy7xajc3w0zr8s96aknvk424djrveq)</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 = miXVhwo2PBnkdm54Vyb2v1WYmbphFjB85b</span> <span class="hljs-comment">// legacyAddress: P2PKHAddress = mxmt8F7qrJpfxq1iSXMXDFgc6AAQaJdtaM</span>
println(legacyAddress.toString) println(legacyAddress.toString)
<span class="hljs-comment">// miXVhwo2PBnkdm54Vyb2v1WYmbphFjB85b</span> <span class="hljs-comment">// mxmt8F7qrJpfxq1iSXMXDFgc6AAQaJdtaM</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(020851d71be8a1a7795ae3d7e49b83c088ebf7c2f5e0b738bbbbf224fded89dbdf)</span> <span class="hljs-comment">// pubkey: crypto.ECPublicKey = ECPublicKey(0309e0c6546ade413e985468f89e89e38b2b2e077f92709da240921c01f9f0d682)</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(tb1qyypfj39809vnwr0093n43uvp79jfhwp2tn9g2l)</span> <span class="hljs-comment">// segwitAddress: Bech32Address = Bech32Address(tb1qh4xwt39chy7xajc3w0zr8s96aknvk424djrveq)</span>
println(segwitAddress.toString) println(segwitAddress.toString)
<span class="hljs-comment">// Bech32Address(tb1qyypfj39809vnwr0093n43uvp79jfhwp2tn9g2l)</span> <span class="hljs-comment">// Bech32Address(tb1qh4xwt39chy7xajc3w0zr8s96aknvk424djrveq)</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 = miXVhwo2PBnkdm54Vyb2v1WYmbphFjB85b</span> <span class="hljs-comment">// legacyAddress: P2PKHAddress = mxmt8F7qrJpfxq1iSXMXDFgc6AAQaJdtaM</span>
println(legacyAddress.toString) println(legacyAddress.toString)
<span class="hljs-comment">// miXVhwo2PBnkdm54Vyb2v1WYmbphFjB85b</span> <span class="hljs-comment">// mxmt8F7qrJpfxq1iSXMXDFgc6AAQaJdtaM</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, 0x5b1a81f2cba6bcb1179a3ca4b70ebd4acb5a39b07d59d024a82e6b95e48e4e79)</span> <span class="hljs-comment">// entropy: BitVector = BitVector(256 bits, 0xaa8f090376810e47bb5bd70d7a4ebf1c69dcc042203cb26202576719095ad3c2)</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(force, staff, lake, nuclear, hint, flat, fury, elegant, pigeon, reveal, quantum, night, remember, broom, sea, private, south, census, argue, strong, furnace, elbow, delay, depend) // the phrase the user should write down</span> <span class="hljs-comment">// res0: Vector[String] = Vector(pride, joke, dolphin, unfair, axis, cat, uniform, kit, aspect, sponsor, quit, decide, oven, gasp, ancient, always, raven, avoid, noise, soda, mountain, pulp, excuse, garlic) // 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 = zpub6jftahH18ngZwgqLzXpanoQXChP89EAeBW65fSNerZTxAyeggDu47ySV7UMRj7qiMrZSu6sgwHMMK7xxXTJsGXgX3PWxeFfgCduzTkCyLgc</span> <span class="hljs-comment">// xpub: ExtPublicKey = zpub6jftahH18ngZwkH2d6W6ymfsDmJLjgvhackvq835rt13nd9aEgSfYVnoRR93pf7gc6sMcPLs3gdzmyjcQ2F2Jpk7Gr1rwKRz1G4Wk5VQ2Wg</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 = zpub6rjRJDBoUvFZs8CjDcFPaZMxeYqwXYcwKqNGvUgFfLwA9kMkTs6j12fRDhtvgJJLDR6bGURkCnvUvSAo39P7NzK9RWpCCBbWqftxsep2Eyq</span> <span class="hljs-comment">// accountXpub: ExtPublicKey = zpub6qYt2oNfSf7LaVtSyH2ccPFPiusvsXSNbsfeBw7Yjric36dg9dGFGrzCu7EsjSAPC5DJe93sX1216buFoQZ2NWXrPjSDTquhQRx7koanMFY</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(tb1qky9d9240ftw5ks5qk4dh0uw8wrkm8w5j8gldjc)</span> <span class="hljs-comment">// firstAccountAddress: Bech32Address = Bech32Address(tb1qchj03qnzltedzc4sfgml3yul0h4aesw7haytdl)</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 = tb1qky9d9240ftw5ks5qk4dh0uw8wrkm8w5j8gldjc</span> <span class="hljs-comment">// res2: String = tb1qchj03qnzltedzc4sfgml3yul0h4aesw7haytdl</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, 0x5b1a81f2cba6bcb1179a3ca4b70ebd4acb5a39b07d59d024a82e6b95e48e4e79)</span> <span class="hljs-comment">// entropy: BitVector = BitVector(256 bits, 0xaa8f090376810e47bb5bd70d7a4ebf1c69dcc042203cb26202576719095ad3c2)</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(force, staff, lake, nuclear, hint, flat, fury, elegant, pigeon, reveal, quantum, night, remember, broom, sea, private, south, census, argue, strong, furnace, elbow, delay, depend) // the phrase the user should write down</span> <span class="hljs-comment">// res0: Vector[String] = Vector(pride, joke, dolphin, unfair, axis, cat, uniform, kit, aspect, sponsor, quit, decide, oven, gasp, ancient, always, raven, avoid, noise, soda, mountain, pulp, excuse, garlic) // 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 = zpub6jftahH18ngZwgqLzXpanoQXChP89EAeBW65fSNerZTxAyeggDu47ySV7UMRj7qiMrZSu6sgwHMMK7xxXTJsGXgX3PWxeFfgCduzTkCyLgc</span> <span class="hljs-comment">// xpub: ExtPublicKey = zpub6jftahH18ngZwkH2d6W6ymfsDmJLjgvhackvq835rt13nd9aEgSfYVnoRR93pf7gc6sMcPLs3gdzmyjcQ2F2Jpk7Gr1rwKRz1G4Wk5VQ2Wg</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 = zpub6rjRJDBoUvFZs8CjDcFPaZMxeYqwXYcwKqNGvUgFfLwA9kMkTs6j12fRDhtvgJJLDR6bGURkCnvUvSAo39P7NzK9RWpCCBbWqftxsep2Eyq</span> <span class="hljs-comment">// accountXpub: ExtPublicKey = zpub6qYt2oNfSf7LaVtSyH2ccPFPiusvsXSNbsfeBw7Yjric36dg9dGFGrzCu7EsjSAPC5DJe93sX1216buFoQZ2NWXrPjSDTquhQRx7koanMFY</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(tb1qky9d9240ftw5ks5qk4dh0uw8wrkm8w5j8gldjc)</span> <span class="hljs-comment">// firstAccountAddress: Bech32Address = Bech32Address(tb1qchj03qnzltedzc4sfgml3yul0h4aesw7haytdl)</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 = tb1qky9d9240ftw5ks5qk4dh0uw8wrkm8w5j8gldjc</span> <span class="hljs-comment">// res2: String = tb1qchj03qnzltedzc4sfgml3yul0h4aesw7haytdl</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(3045022100a41d00286385745e330883bc83f032172f12cfb0d47bd656f8c3af4f3ab8e1b502205447aea236413b999d7fa648f7df2775571c5b8ebe9d87891b1de78b533ed9bf)</span> <span class="hljs-comment">// res0: ECDigitalSignature = ECDigitalSignature(3045022100d564ce9a86cd68d92222ed775e95e972addb49162983e8f9db07473105c380a402203907a1dbd90e3f51592d4adb0260be0f2c2cb9090448d746070722bce7caef2b)</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(3045022100c1ededaca28d1d572ca234b78fb107e8a94fedc22cb2692854d13160ba6e6bcc0220608fb5b396231f27a6e8ffb09df90a15e86b536e6f465a66802ad1ad41e15af7)</span> <span class="hljs-comment">// res1: ECDigitalSignature = ECDigitalSignature(3045022100d1c5ca65ea724edec84d1380fce7a0b331b3731285a506ca766de0a1f311b1b6022054c90ab92c1f6e561527508c43a453030f38e8b0d2502ba6b2698ff8c677d567)</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(3045022100a41d00286385745e330883bc83f032172f12cfb0d47bd656f8c3af4f3ab8e1b502205447aea236413b999d7fa648f7df2775571c5b8ebe9d87891b1de78b533ed9bf)</span> <span class="hljs-comment">// res0: ECDigitalSignature = ECDigitalSignature(3045022100d564ce9a86cd68d92222ed775e95e972addb49162983e8f9db07473105c380a402203907a1dbd90e3f51592d4adb0260be0f2c2cb9090448d746070722bce7caef2b)</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(3045022100c1ededaca28d1d572ca234b78fb107e8a94fedc22cb2692854d13160ba6e6bcc0220608fb5b396231f27a6e8ffb09df90a15e86b536e6f465a66802ad1ad41e15af7)</span> <span class="hljs-comment">// res1: ECDigitalSignature = ECDigitalSignature(3045022100d1c5ca65ea724edec84d1380fce7a0b331b3731285a506ca766de0a1f311b1b6022054c90ab92c1f6e561527508c43a453030f38e8b0d2502ba6b2698ff8c677d567)</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@1f5aa277[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@694108ec[Running, parallelism = 2, size = 1, active = 0, running = 0, steals = 8, 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(0203add5a55a462ea0bf39e36997c34b7cd3b53c885a640ad579976a0994278824)</span> <span class="hljs-comment">// pubKey: ECPublicKey = ECPublicKey(03c56166349342a9fdd3482482293901ebe8db9e648650c8160d10d52b977ffdd2)</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(c08509e1279b009c02de88a1a6a1e8d1e20c97f1)</span> <span class="hljs-comment">// creditingSpk: P2PKHScriptPubKey = pkh(adda6b4da67029bdf0f12e82d6dc38eec98392f1)</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(c08509e1279b009c02de88a1a6a1e8d1e20c97f1))</span> <span class="hljs-comment">// utxo: TransactionOutput = TransactionOutput(10000 sats,pkh(adda6b4da67029bdf0f12e82d6dc38eec98392f1))</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(e975cad237d2fd5612353d4a76b84d1a097da1b3)</span> <span class="hljs-comment">// destinationSPK: P2PKHScriptPubKey = pkh(aff4f9d308c0a8a4d14fe5f4eec2cca0acdd59a2)</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(e975cad237d2fd5612353d4a76b84d1a097da1b3)))</span> <span class="hljs-comment">// destinations: Vector[TransactionOutput] = Vector(TransactionOutput(5000 sats,pkh(aff4f9d308c0a8a4d14fe5f4eec2cca0acdd59a2)))</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(c08509e1279b009c02de88a1a6a1e8d1e20c97f1))),UInt32Impl(0))</span> <span class="hljs-comment">// creditingTx: BaseTransaction = BaseTransactionImpl(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(adda6b4da67029bdf0f12e82d6dc38eec98392f1))),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(aeea86acb54cacc3ad74eb2cc3a22efdb307b6a6517d41b911ae9826259416d7:0)</span> <span class="hljs-comment">// outPoint: TransactionOutPoint = TransactionOutPoint(4662fb9f72417a438722b26e4bcd818b2cfd43a8a398f24a82246493c81afbde: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(aeea86acb54cacc3ad74eb2cc3a22efdb307b6a6517d41b911ae9826259416d7:0),10000 sats,pkh(c08509e1279b009c02de88a1a6a1e8d1e20c97f1),Masked(ECPrivateKeyImpl),SIGHASH_ALL(Int32Impl(1)))</span> <span class="hljs-comment">// utxoSpendingInfo: BitcoinUTXOSpendingInfoFull = P2PKHSpendingInfo(TransactionOutPoint(4662fb9f72417a438722b26e4bcd818b2cfd43a8a398f24a82246493c81afbde:0),10000 sats,pkh(adda6b4da67029bdf0f12e82d6dc38eec98392f1),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(aeea86acb54cacc3ad74eb2cc3a22efdb307b6a6517d41b911ae9826259416d7:0),10000 sats,pkh(c08509e1279b009c02de88a1a6a1e8d1e20c97f1),Masked(ECPrivateKeyImpl),SIGHASH_ALL(Int32Impl(1))))</span> <span class="hljs-comment">// utxos: Vector[BitcoinUTXOSpendingInfoFull] = Vector(P2PKHSpendingInfo(TransactionOutPoint(4662fb9f72417a438722b26e4bcd818b2cfd43a8a398f24a82246493c81afbde:0),10000 sats,pkh(adda6b4da67029bdf0f12e82d6dc38eec98392f1),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(c2f42931a423a80247117213e5af53c6d7a06e63)</span> <span class="hljs-comment">// changeSPK: P2PKHScriptPubKey = pkh(a05c8abb98bbecc70b95b2fba9e471a1233b48ac)</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(e975cad237d2fd5612353d4a76b84d1a097da1b3))),Map(TransactionOutPoint(aeea86acb54cacc3ad74eb2cc3a22efdb307b6a6517d41b911ae9826259416d7:0) -&gt; P2PKHSpendingInfo(TransactionOutPoint(aeea86acb54cacc3ad74eb2cc3a22efdb307b6a6517d41b911ae9826259416d7:0),10000 sats,pkh(c08509e1279b009c02de88a1a6a1e8d1e20c97f1),Masked(ECPrivateKeyImpl),SIGHASH_ALL(Int32Impl(1)))),SatoshisPerByte(1 sat),pkh(c2f42931a423a80247117213e5af53c6d7a06e63),RegTest)</span> <span class="hljs-comment">// txBuilder: BitcoinTxBuilder = BitcoinTxBuilderImpl(Vector(TransactionOutput(5000 sats,pkh(aff4f9d308c0a8a4d14fe5f4eec2cca0acdd59a2))),Map(TransactionOutPoint(4662fb9f72417a438722b26e4bcd818b2cfd43a8a398f24a82246493c81afbde:0) -&gt; P2PKHSpendingInfo(TransactionOutPoint(4662fb9f72417a438722b26e4bcd818b2cfd43a8a398f24a82246493c81afbde:0),10000 sats,pkh(adda6b4da67029bdf0f12e82d6dc38eec98392f1),Masked(ECPrivateKeyImpl),SIGHASH_ALL(Int32Impl(1)))),SatoshisPerByte(1 sat),pkh(a05c8abb98bbecc70b95b2fba9e471a1233b48ac),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(aeea86acb54cacc3ad74eb2cc3a22efdb307b6a6517d41b911ae9826259416d7:0),P2PKHScriptSignature(ECPublicKey(0203add5a55a462ea0bf39e36997c34b7cd3b53c885a640ad579976a0994278824), ECDigitalSignature(30450221009543d8685d5359a11fe4e899f42eef552bc1109ea522e4946a6815670628611502201ea5c9b138cb6312e7b7728641050b16dccffd7153d64753285775558ace066001)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(e975cad237d2fd5612353d4a76b84d1a097da1b3)), TransactionOutput(4774 sats,pkh(c2f42931a423a80247117213e5af53c6d7a06e63))),UInt32Impl(0))</span> <span class="hljs-comment">// signedTx: Transaction = BaseTransactionImpl(Int32Impl(2),List(TransactionInputImpl(TransactionOutPoint(4662fb9f72417a438722b26e4bcd818b2cfd43a8a398f24a82246493c81afbde:0),P2PKHScriptSignature(ECPublicKey(03c56166349342a9fdd3482482293901ebe8db9e648650c8160d10d52b977ffdd2), ECDigitalSignature(304402204af180fb7ae0e570c3ff015d297924862635a490e31d4b54912ce0d6c74cca0c02204ce1398f6a3fa9aeda242bc6cbaf214774b1c6e2f0a72aecbb8c612c8d6c263c01)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(aff4f9d308c0a8a4d14fe5f4eec2cca0acdd59a2)), TransactionOutput(4774 sats,pkh(a05c8abb98bbecc70b95b2fba9e471a1233b48ac))),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 = 0200000001d71694252698ae11b9417d51a6b607b3fd2ea2c32ceb74adc3ac4cb5ac86eaae000000006b4830450221009543d8685d5359a11fe4e899f42eef552bc1109ea522e4946a6815670628611502201ea5c9b138cb6312e7b7728641050b16dccffd7153d64753285775558ace066001210203add5a55a462ea0bf39e36997c34b7cd3b53c885a640ad579976a0994278824000000000288130000000000001976a914e975cad237d2fd5612353d4a76b84d1a097da1b388aca6120000000000001976a914c2f42931a423a80247117213e5af53c6d7a06e6388ac00000000</span> <span class="hljs-comment">// res2: String = 0200000001defb1ac8936424824af298a3a843fd2c8b81cd4b6eb22287437a41729ffb6246000000006a47304402204af180fb7ae0e570c3ff015d297924862635a490e31d4b54912ce0d6c74cca0c02204ce1398f6a3fa9aeda242bc6cbaf214774b1c6e2f0a72aecbb8c612c8d6c263c012103c56166349342a9fdd3482482293901ebe8db9e648650c8160d10d52b977ffdd2000000000288130000000000001976a914aff4f9d308c0a8a4d14fe5f4eec2cca0acdd59a288aca6120000000000001976a914a05c8abb98bbecc70b95b2fba9e471a1233b48ac88ac00000000</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@1f5aa277[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@694108ec[Running, parallelism = 2, size = 1, active = 0, running = 0, steals = 8, 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(0203add5a55a462ea0bf39e36997c34b7cd3b53c885a640ad579976a0994278824)</span> <span class="hljs-comment">// pubKey: ECPublicKey = ECPublicKey(03c56166349342a9fdd3482482293901ebe8db9e648650c8160d10d52b977ffdd2)</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(c08509e1279b009c02de88a1a6a1e8d1e20c97f1)</span> <span class="hljs-comment">// creditingSpk: P2PKHScriptPubKey = pkh(adda6b4da67029bdf0f12e82d6dc38eec98392f1)</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(c08509e1279b009c02de88a1a6a1e8d1e20c97f1))</span> <span class="hljs-comment">// utxo: TransactionOutput = TransactionOutput(10000 sats,pkh(adda6b4da67029bdf0f12e82d6dc38eec98392f1))</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(e975cad237d2fd5612353d4a76b84d1a097da1b3)</span> <span class="hljs-comment">// destinationSPK: P2PKHScriptPubKey = pkh(aff4f9d308c0a8a4d14fe5f4eec2cca0acdd59a2)</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(e975cad237d2fd5612353d4a76b84d1a097da1b3)))</span> <span class="hljs-comment">// destinations: Vector[TransactionOutput] = Vector(TransactionOutput(5000 sats,pkh(aff4f9d308c0a8a4d14fe5f4eec2cca0acdd59a2)))</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(c08509e1279b009c02de88a1a6a1e8d1e20c97f1))),UInt32Impl(0))</span> <span class="hljs-comment">// creditingTx: BaseTransaction = BaseTransactionImpl(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(adda6b4da67029bdf0f12e82d6dc38eec98392f1))),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(aeea86acb54cacc3ad74eb2cc3a22efdb307b6a6517d41b911ae9826259416d7:0)</span> <span class="hljs-comment">// outPoint: TransactionOutPoint = TransactionOutPoint(4662fb9f72417a438722b26e4bcd818b2cfd43a8a398f24a82246493c81afbde: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(aeea86acb54cacc3ad74eb2cc3a22efdb307b6a6517d41b911ae9826259416d7:0),10000 sats,pkh(c08509e1279b009c02de88a1a6a1e8d1e20c97f1),Masked(ECPrivateKeyImpl),SIGHASH_ALL(Int32Impl(1)))</span> <span class="hljs-comment">// utxoSpendingInfo: BitcoinUTXOSpendingInfoFull = P2PKHSpendingInfo(TransactionOutPoint(4662fb9f72417a438722b26e4bcd818b2cfd43a8a398f24a82246493c81afbde:0),10000 sats,pkh(adda6b4da67029bdf0f12e82d6dc38eec98392f1),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(aeea86acb54cacc3ad74eb2cc3a22efdb307b6a6517d41b911ae9826259416d7:0),10000 sats,pkh(c08509e1279b009c02de88a1a6a1e8d1e20c97f1),Masked(ECPrivateKeyImpl),SIGHASH_ALL(Int32Impl(1))))</span> <span class="hljs-comment">// utxos: Vector[BitcoinUTXOSpendingInfoFull] = Vector(P2PKHSpendingInfo(TransactionOutPoint(4662fb9f72417a438722b26e4bcd818b2cfd43a8a398f24a82246493c81afbde:0),10000 sats,pkh(adda6b4da67029bdf0f12e82d6dc38eec98392f1),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(c2f42931a423a80247117213e5af53c6d7a06e63)</span> <span class="hljs-comment">// changeSPK: P2PKHScriptPubKey = pkh(a05c8abb98bbecc70b95b2fba9e471a1233b48ac)</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(e975cad237d2fd5612353d4a76b84d1a097da1b3))),Map(TransactionOutPoint(aeea86acb54cacc3ad74eb2cc3a22efdb307b6a6517d41b911ae9826259416d7:0) -&gt; P2PKHSpendingInfo(TransactionOutPoint(aeea86acb54cacc3ad74eb2cc3a22efdb307b6a6517d41b911ae9826259416d7:0),10000 sats,pkh(c08509e1279b009c02de88a1a6a1e8d1e20c97f1),Masked(ECPrivateKeyImpl),SIGHASH_ALL(Int32Impl(1)))),SatoshisPerByte(1 sat),pkh(c2f42931a423a80247117213e5af53c6d7a06e63),RegTest)</span> <span class="hljs-comment">// txBuilder: BitcoinTxBuilder = BitcoinTxBuilderImpl(Vector(TransactionOutput(5000 sats,pkh(aff4f9d308c0a8a4d14fe5f4eec2cca0acdd59a2))),Map(TransactionOutPoint(4662fb9f72417a438722b26e4bcd818b2cfd43a8a398f24a82246493c81afbde:0) -&gt; P2PKHSpendingInfo(TransactionOutPoint(4662fb9f72417a438722b26e4bcd818b2cfd43a8a398f24a82246493c81afbde:0),10000 sats,pkh(adda6b4da67029bdf0f12e82d6dc38eec98392f1),Masked(ECPrivateKeyImpl),SIGHASH_ALL(Int32Impl(1)))),SatoshisPerByte(1 sat),pkh(a05c8abb98bbecc70b95b2fba9e471a1233b48ac),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(aeea86acb54cacc3ad74eb2cc3a22efdb307b6a6517d41b911ae9826259416d7:0),P2PKHScriptSignature(ECPublicKey(0203add5a55a462ea0bf39e36997c34b7cd3b53c885a640ad579976a0994278824), ECDigitalSignature(30450221009543d8685d5359a11fe4e899f42eef552bc1109ea522e4946a6815670628611502201ea5c9b138cb6312e7b7728641050b16dccffd7153d64753285775558ace066001)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(e975cad237d2fd5612353d4a76b84d1a097da1b3)), TransactionOutput(4774 sats,pkh(c2f42931a423a80247117213e5af53c6d7a06e63))),UInt32Impl(0))</span> <span class="hljs-comment">// signedTx: Transaction = BaseTransactionImpl(Int32Impl(2),List(TransactionInputImpl(TransactionOutPoint(4662fb9f72417a438722b26e4bcd818b2cfd43a8a398f24a82246493c81afbde:0),P2PKHScriptSignature(ECPublicKey(03c56166349342a9fdd3482482293901ebe8db9e648650c8160d10d52b977ffdd2), ECDigitalSignature(304402204af180fb7ae0e570c3ff015d297924862635a490e31d4b54912ce0d6c74cca0c02204ce1398f6a3fa9aeda242bc6cbaf214774b1c6e2f0a72aecbb8c612c8d6c263c01)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(aff4f9d308c0a8a4d14fe5f4eec2cca0acdd59a2)), TransactionOutput(4774 sats,pkh(a05c8abb98bbecc70b95b2fba9e471a1233b48ac))),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 = 0200000001d71694252698ae11b9417d51a6b607b3fd2ea2c32ceb74adc3ac4cb5ac86eaae000000006b4830450221009543d8685d5359a11fe4e899f42eef552bc1109ea522e4946a6815670628611502201ea5c9b138cb6312e7b7728641050b16dccffd7153d64753285775558ace066001210203add5a55a462ea0bf39e36997c34b7cd3b53c885a640ad579976a0994278824000000000288130000000000001976a914e975cad237d2fd5612353d4a76b84d1a097da1b388aca6120000000000001976a914c2f42931a423a80247117213e5af53c6d7a06e6388ac00000000</span> <span class="hljs-comment">// res2: String = 0200000001defb1ac8936424824af298a3a843fd2c8b81cd4b6eb22287437a41729ffb6246000000006a47304402204af180fb7ae0e570c3ff015d297924862635a490e31d4b54912ce0d6c74cca0c02204ce1398f6a3fa9aeda242bc6cbaf214774b1c6e2f0a72aecbb8c612c8d6c263c012103c56166349342a9fdd3482482293901ebe8db9e648650c8160d10d52b977ffdd2000000000288130000000000001976a914aff4f9d308c0a8a4d14fe5f4eec2cca0acdd59a288aca6120000000000001976a914a05c8abb98bbecc70b95b2fba9e471a1233b48ac88ac00000000</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.0.0+77-8514d361-SNAPSHOT</code>.</p> recent snapshot published is <code>0.0.0+78-260f52fe-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.0.0+77-8514d361-SNAPSHOT</code>.</p> recent snapshot published is <code>0.0.0+78-260f52fe-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, 0xa713417f911ef8dd7be1e75d0fd7b8b99b48f71a8e5863eeb73340d064e592a8)</span> <span class="hljs-comment">// entropy: scodec.bits.BitVector = BitVector(256 bits, 0x51d24c404eab45cf1a66b4e7f925c12bc64fd6fb8bc4af2d87a18de25362a36d)</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(poem, old, garment, captain, usage, huge, usage, diagram, fringe, leaf, until, industry, region, knee, health, slam, glue, interest, smoke, like, alien, index, enjoy, antique)</span> <span class="hljs-comment">// Vector(fade, mystery, avoid, outer, reform, travel, hat, story, tree, since, icon, fiscal, gossip, twin, until, joy, quality, history, trick, bridge, cement, rally, misery, punch)</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-example7015000098610560199/encrypted-bitcoin-s-seed.json</span> <span class="hljs-comment">// seedPath: Path = /tmp/key-manager-example662249807697557763/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-example7015000098610560199/encrypted-bitcoin-s-seed.json,m/84',RegTest)</span> <span class="hljs-comment">// kmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example662249807697557763/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-example7015000098610560199/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-example662249807697557763/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 = vpub5SLqN2bLY4WeYMkcC4HY7hJLZgHx2rgaXTQ4BhepTY3SNM1udv2A6ekzfsbaNZ7HNvfxcj5HANNu184RgPjsgawuLknNiLksyCtJjNgGZkD</span> <span class="hljs-comment">// rootXPub: ExtPublicKey = vpub5SLqN2bLY4WeZAc9cULsL9xqYSzasJCv6oNEYaKYAmspFaEXGmoGKTG3A7iY328YEKdsRVFnqbSJvUDk7PF3WcHM86qPqh1eJDvCaegDtbR</span>
println(rootXPub) println(rootXPub)
<span class="hljs-comment">// vpub5SLqN2bLY4WeYMkcC4HY7hJLZgHx2rgaXTQ4BhepTY3SNM1udv2A6ekzfsbaNZ7HNvfxcj5HANNu184RgPjsgawuLknNiLksyCtJjNgGZkD</span> <span class="hljs-comment">// vpub5SLqN2bLY4WeZAc9cULsL9xqYSzasJCv6oNEYaKYAmspFaEXGmoGKTG3A7iY328YEKdsRVFnqbSJvUDk7PF3WcHM86qPqh1eJDvCaegDtbR</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-example7015000098610560199/encrypted-bitcoin-s-seed.json,m/84',MainNet)</span> <span class="hljs-comment">// mainnetKmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example662249807697557763/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-example7015000098610560199/encrypted-bitcoin-s-seed.json,m/84',MainNet),None)</span> <span class="hljs-comment">// mainnetKeyManager: BIP39KeyManager = BIP39KeyManager(Masked(MnemonicCodeImpl),KeyManagerParams(/tmp/key-manager-example662249807697557763/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 = zpub6jftahH18ngZwYX5XVS2x3gMFYsjoLeaBuUwKHEMyZYxakGpeYgQauPYkhRvNBiy1V9BcdTX11o6YGWgZBPvsXgJp7a53z2q478tHgt2VTR</span> <span class="hljs-comment">// mainnetXpub: ExtPublicKey = zpub6jftahH18ngZxMNcwuVNAWLrEKaNdnAumFT7g9u5goPLTyVSHQTWohtbEwYt2ekDrt76RPe2gErWTcfzzAu6hZ1kbTd6BLHbP8An8xxZGPW</span>
println(mainnetXpub) println(mainnetXpub)
<span class="hljs-comment">// zpub6jftahH18ngZwYX5XVS2x3gMFYsjoLeaBuUwKHEMyZYxakGpeYgQauPYkhRvNBiy1V9BcdTX11o6YGWgZBPvsXgJp7a53z2q478tHgt2VTR</span> <span class="hljs-comment">// zpub6jftahH18ngZxMNcwuVNAWLrEKaNdnAumFT7g9u5goPLTyVSHQTWohtbEwYt2ekDrt76RPe2gErWTcfzzAu6hZ1kbTd6BLHbP8An8xxZGPW</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, 0xa713417f911ef8dd7be1e75d0fd7b8b99b48f71a8e5863eeb73340d064e592a8)</span> <span class="hljs-comment">// entropy: scodec.bits.BitVector = BitVector(256 bits, 0x51d24c404eab45cf1a66b4e7f925c12bc64fd6fb8bc4af2d87a18de25362a36d)</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(poem, old, garment, captain, usage, huge, usage, diagram, fringe, leaf, until, industry, region, knee, health, slam, glue, interest, smoke, like, alien, index, enjoy, antique)</span> <span class="hljs-comment">// Vector(fade, mystery, avoid, outer, reform, travel, hat, story, tree, since, icon, fiscal, gossip, twin, until, joy, quality, history, trick, bridge, cement, rally, misery, punch)</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-example7015000098610560199/encrypted-bitcoin-s-seed.json</span> <span class="hljs-comment">// seedPath: Path = /tmp/key-manager-example662249807697557763/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-example7015000098610560199/encrypted-bitcoin-s-seed.json,m/84',RegTest)</span> <span class="hljs-comment">// kmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example662249807697557763/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-example7015000098610560199/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-example662249807697557763/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 = vpub5SLqN2bLY4WeYMkcC4HY7hJLZgHx2rgaXTQ4BhepTY3SNM1udv2A6ekzfsbaNZ7HNvfxcj5HANNu184RgPjsgawuLknNiLksyCtJjNgGZkD</span> <span class="hljs-comment">// rootXPub: ExtPublicKey = vpub5SLqN2bLY4WeZAc9cULsL9xqYSzasJCv6oNEYaKYAmspFaEXGmoGKTG3A7iY328YEKdsRVFnqbSJvUDk7PF3WcHM86qPqh1eJDvCaegDtbR</span>
println(rootXPub) println(rootXPub)
<span class="hljs-comment">// vpub5SLqN2bLY4WeYMkcC4HY7hJLZgHx2rgaXTQ4BhepTY3SNM1udv2A6ekzfsbaNZ7HNvfxcj5HANNu184RgPjsgawuLknNiLksyCtJjNgGZkD</span> <span class="hljs-comment">// vpub5SLqN2bLY4WeZAc9cULsL9xqYSzasJCv6oNEYaKYAmspFaEXGmoGKTG3A7iY328YEKdsRVFnqbSJvUDk7PF3WcHM86qPqh1eJDvCaegDtbR</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-example7015000098610560199/encrypted-bitcoin-s-seed.json,m/84',MainNet)</span> <span class="hljs-comment">// mainnetKmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example662249807697557763/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-example7015000098610560199/encrypted-bitcoin-s-seed.json,m/84',MainNet),None)</span> <span class="hljs-comment">// mainnetKeyManager: BIP39KeyManager = BIP39KeyManager(Masked(MnemonicCodeImpl),KeyManagerParams(/tmp/key-manager-example662249807697557763/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 = zpub6jftahH18ngZwYX5XVS2x3gMFYsjoLeaBuUwKHEMyZYxakGpeYgQauPYkhRvNBiy1V9BcdTX11o6YGWgZBPvsXgJp7a53z2q478tHgt2VTR</span> <span class="hljs-comment">// mainnetXpub: ExtPublicKey = zpub6jftahH18ngZxMNcwuVNAWLrEKaNdnAumFT7g9u5goPLTyVSHQTWohtbEwYt2ekDrt76RPe2gErWTcfzzAu6hZ1kbTd6BLHbP8An8xxZGPW</span>
println(mainnetXpub) println(mainnetXpub)
<span class="hljs-comment">// zpub6jftahH18ngZwYX5XVS2x3gMFYsjoLeaBuUwKHEMyZYxakGpeYgQauPYkhRvNBiy1V9BcdTX11o6YGWgZBPvsXgJp7a53z2q478tHgt2VTR</span> <span class="hljs-comment">// zpub6jftahH18ngZxMNcwuVNAWLrEKaNdnAumFT7g9u5goPLTyVSHQTWohtbEwYt2ekDrt76RPe2gErWTcfzzAu6hZ1kbTd6BLHbP8An8xxZGPW</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(03fb83888f10c5ea05f5e8a7ccf99d05fb9e5d89f99035777b3dc0fc40f59aff4f)</span> <span class="hljs-comment">// publicKey: ECPublicKey = ECPublicKey(022cd68fb40d8cf1a73d0ad09ea2b495d06b69c60816083a49ad16477a4a436f2c)</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(304402203601c68f78dbb73f480736e916de646083705aace59fa3d900c40eda1780f44902204cf5a4b24c5d8832774006e83dd8ce86adb10ced58cab9334dfca965e1c1df30)</span> <span class="hljs-comment">// signature: ECDigitalSignature = ECDigitalSignature(304402206458ea27ed7c696f4485bde71513a47a46ba1ad0a721ef50e08b98c837305297022050ac7bf0b250050b08cd500d61e5ce6bef2bd6313b6baf7afc041c456fdd9d9d)</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(03fb83888f10c5ea05f5e8a7ccf99d05fb9e5d89f99035777b3dc0fc40f59aff4f)</span> <span class="hljs-comment">// publicKey: ECPublicKey = ECPublicKey(022cd68fb40d8cf1a73d0ad09ea2b495d06b69c60816083a49ad16477a4a436f2c)</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(304402203601c68f78dbb73f480736e916de646083705aace59fa3d900c40eda1780f44902204cf5a4b24c5d8832774006e83dd8ce86adb10ced58cab9334dfca965e1c1df30)</span> <span class="hljs-comment">// signature: ECDigitalSignature = ECDigitalSignature(304402206458ea27ed7c696f4485bde71513a47a46ba1ad0a721ef50e08b98c837305297022050ac7bf0b250050b08cd500d61e5ce6bef2bd6313b6baf7afc041c456fdd9d9d)</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>