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

Deploy website

Browse source 
Deploy website version based on 64a6b6bbc5
This commit is contained in:
Docusaurus bot 2020-12-20 14:06:07 +00:00
parent 5c18951576
commit 77d8dc2905
14 changed files with 90 additions and 90 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: org.bitcoins.crypto.ECPublicKey = ECPublicKey(020ec95a5e14d66fbaa5aa0a4912f35ffbee8502535d314297e49b780dd3e9cf68)</span> <span class="hljs-comment">// pubkey: org.bitcoins.crypto.ECPublicKey = ECPublicKey(03250371c552aae7af82325dcf6b4247f3c38c966b3b4403c4df21ef97d78da912)</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 = tb1qekm6qsvsdlpp9mxvdva685ss4ajld490c0tump</span> <span class="hljs-comment">// segwitAddress: Bech32Address = tb1q2uazvdj2p6fr3e0jrts957tsjfnq289x0r72jl</span>
println(segwitAddress.toString) println(segwitAddress.toString)
<span class="hljs-comment">// tb1qekm6qsvsdlpp9mxvdva685ss4ajld490c0tump</span> <span class="hljs-comment">// tb1q2uazvdj2p6fr3e0jrts957tsjfnq289x0r72jl</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&#x27;re reusing the same private/public key pair</span> <pre><code class="hljs css language-scala"><span class="hljs-comment">// we&#x27;re reusing the same private/public key pair</span>
<span class="hljs-comment">// from before. don&#x27;t do this in an actual application!</span> <span class="hljs-comment">// from before. don&#x27;t do this in an actual application!</span>
<span class="hljs-keyword">val</span> legacyAddress = <span class="hljs-type">P2PKHAddress</span>(pubkey, <span class="hljs-type">TestNet3</span>) <span class="hljs-keyword">val</span> legacyAddress = <span class="hljs-type">P2PKHAddress</span>(pubkey, <span class="hljs-type">TestNet3</span>)
<span class="hljs-comment">// legacyAddress: P2PKHAddress = mzGgnwKoMhPcTxHZeuCCM1Fr1TW8Q6PqHr</span> <span class="hljs-comment">// legacyAddress: P2PKHAddress = moUAk2QfV9dzsWCAxn8pe6KiqAPyaCtcpk</span>
println(legacyAddress.toString) println(legacyAddress.toString)
<span class="hljs-comment">// mzGgnwKoMhPcTxHZeuCCM1Fr1TW8Q6PqHr</span> <span class="hljs-comment">// moUAk2QfV9dzsWCAxn8pe6KiqAPyaCtcpk</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/zt-eavycu0x-WQL7XOakzQo8tAy7jHHZUw" target="_blank" rel="noreferrer noopener">Slack</a><a href="https://gitter.im/bitcoin-s-core/">Gitter chat</a></div><div><h5>More</h5><a href="https://github.com/bitcoin-s/bitcoin-s">GitHub</a><a class="github-button" href="https://github.com/bitcoin-s/bitcoin-s" data-icon="octicon-star" data-count-href="/bitcoin-s/bitcoin-s-core/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 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/zt-eavycu0x-WQL7XOakzQo8tAy7jHHZUw" target="_blank" rel="noreferrer noopener">Slack</a><a href="https://gitter.im/bitcoin-s-core/">Gitter chat</a></div><div><h5>More</h5><a href="https://github.com/bitcoin-s/bitcoin-s">GitHub</a><a class="github-button" href="https://github.com/bitcoin-s/bitcoin-s" data-icon="octicon-star" data-count-href="/bitcoin-s/bitcoin-s-core/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 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: org.bitcoins.crypto.ECPublicKey = ECPublicKey(020ec95a5e14d66fbaa5aa0a4912f35ffbee8502535d314297e49b780dd3e9cf68)</span> <span class="hljs-comment">// pubkey: org.bitcoins.crypto.ECPublicKey = ECPublicKey(03250371c552aae7af82325dcf6b4247f3c38c966b3b4403c4df21ef97d78da912)</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 = tb1qekm6qsvsdlpp9mxvdva685ss4ajld490c0tump</span> <span class="hljs-comment">// segwitAddress: Bech32Address = tb1q2uazvdj2p6fr3e0jrts957tsjfnq289x0r72jl</span>
println(segwitAddress.toString) println(segwitAddress.toString)
<span class="hljs-comment">// tb1qekm6qsvsdlpp9mxvdva685ss4ajld490c0tump</span> <span class="hljs-comment">// tb1q2uazvdj2p6fr3e0jrts957tsjfnq289x0r72jl</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&#x27;re reusing the same private/public key pair</span> <pre><code class="hljs css language-scala"><span class="hljs-comment">// we&#x27;re reusing the same private/public key pair</span>
<span class="hljs-comment">// from before. don&#x27;t do this in an actual application!</span> <span class="hljs-comment">// from before. don&#x27;t do this in an actual application!</span>
<span class="hljs-keyword">val</span> legacyAddress = <span class="hljs-type">P2PKHAddress</span>(pubkey, <span class="hljs-type">TestNet3</span>) <span class="hljs-keyword">val</span> legacyAddress = <span class="hljs-type">P2PKHAddress</span>(pubkey, <span class="hljs-type">TestNet3</span>)
<span class="hljs-comment">// legacyAddress: P2PKHAddress = mzGgnwKoMhPcTxHZeuCCM1Fr1TW8Q6PqHr</span> <span class="hljs-comment">// legacyAddress: P2PKHAddress = moUAk2QfV9dzsWCAxn8pe6KiqAPyaCtcpk</span>
println(legacyAddress.toString) println(legacyAddress.toString)
<span class="hljs-comment">// mzGgnwKoMhPcTxHZeuCCM1Fr1TW8Q6PqHr</span> <span class="hljs-comment">// moUAk2QfV9dzsWCAxn8pe6KiqAPyaCtcpk</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/zt-eavycu0x-WQL7XOakzQo8tAy7jHHZUw" target="_blank" rel="noreferrer noopener">Slack</a><a href="https://gitter.im/bitcoin-s-core/">Gitter chat</a></div><div><h5>More</h5><a href="https://github.com/bitcoin-s/bitcoin-s">GitHub</a><a class="github-button" href="https://github.com/bitcoin-s/bitcoin-s" data-icon="octicon-star" data-count-href="/bitcoin-s/bitcoin-s-core/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 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/zt-eavycu0x-WQL7XOakzQo8tAy7jHHZUw" target="_blank" rel="noreferrer noopener">Slack</a><a href="https://gitter.im/bitcoin-s-core/">Gitter chat</a></div><div><h5>More</h5><a href="https://github.com/bitcoin-s/bitcoin-s">GitHub</a><a class="github-button" href="https://github.com/bitcoin-s/bitcoin-s" data-icon="octicon-star" data-count-href="/bitcoin-s/bitcoin-s-core/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 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, 0xcb513b898692b71669940506de684f163071a2bd743e5f264c3f34e079a05be5)</span> <span class="hljs-comment">// entropy: BitVector = BitVector(256 bits, 0xf2db6a489dfc9916c5788680b2e827a159854586e1ecfd1d10e1e87299563ffc)</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(slender, mean, tiny, artwork, clock, menu, play, level, almost, viable, because, cluster, alpha, spend, volume, march, game, crash, average, hawk, always, south, hurdle, plug) // the phrase the user should write down</span> <span class="hljs-comment">// res0: Vector[String] = Vector(version, swap, mutual, desk, sister, merge, bicycle, awkward, level, nuclear, antique, dress, obscure, people, breeze, diesel, wonder, trigger, debris, special, civil, prison, zoo, nasty) // 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 = zpub6jftahH18ngZwqPmGQrX14HLW5sJmrWwtqKJ5z4Xoy3HDgjWcEHJ8SvocLbCSdf1RfYAfvKUbLbyQW933asbjuBtZVpcNSwdwbabMTYGFgV</span> <span class="hljs-comment">// xpub: ExtPublicKey = zpub6jftahH18ngZwyKW8hAhwaxSh82QHhUBDcXpsvhnFXnqrBmWHfxWAZkowrNL3GtrEG7YwKAKpiJD47umyKudSPyxeRR8qeno5AhoGMnAFu7</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 = zpub6rqzeU44jyQizFhsFQvG1TsDgRzkY4hJDTCPZoNnrQQdMfPMsKqQLkDN2FRV6K9p7Qf3eUBrCpxExRKabVnfaSP6MiWpnhGQ8HyTuNZdT7M</span> <span class="hljs-comment">// accountXpub: ExtPublicKey = zpub6qkKNPaM8BeYDju1hE5z5VbNXLqJzECeFRPYJGJXGCaMiAJcCYVuawDptV4KKyzFWaA1b83g6nv7257c54W1Pg68aq4vC1UuzmpHJLC99Fu</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 = tb1qdcjckefdjqr0pme7aluhyalad8j2cm2x8wd5ns</span> <span class="hljs-comment">// firstAccountAddress: Bech32Address = tb1q4zrcquv8kjmer6gp3gs50rspre4fkacgqggqw9</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 = tb1qdcjckefdjqr0pme7aluhyalad8j2cm2x8wd5ns</span> <span class="hljs-comment">// res2: String = tb1q4zrcquv8kjmer6gp3gs50rspre4fkacgqggqw9</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, 0xcb513b898692b71669940506de684f163071a2bd743e5f264c3f34e079a05be5)</span> <span class="hljs-comment">// entropy: BitVector = BitVector(256 bits, 0xf2db6a489dfc9916c5788680b2e827a159854586e1ecfd1d10e1e87299563ffc)</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(slender, mean, tiny, artwork, clock, menu, play, level, almost, viable, because, cluster, alpha, spend, volume, march, game, crash, average, hawk, always, south, hurdle, plug) // the phrase the user should write down</span> <span class="hljs-comment">// res0: Vector[String] = Vector(version, swap, mutual, desk, sister, merge, bicycle, awkward, level, nuclear, antique, dress, obscure, people, breeze, diesel, wonder, trigger, debris, special, civil, prison, zoo, nasty) // 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 = zpub6jftahH18ngZwqPmGQrX14HLW5sJmrWwtqKJ5z4Xoy3HDgjWcEHJ8SvocLbCSdf1RfYAfvKUbLbyQW933asbjuBtZVpcNSwdwbabMTYGFgV</span> <span class="hljs-comment">// xpub: ExtPublicKey = zpub6jftahH18ngZwyKW8hAhwaxSh82QHhUBDcXpsvhnFXnqrBmWHfxWAZkowrNL3GtrEG7YwKAKpiJD47umyKudSPyxeRR8qeno5AhoGMnAFu7</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 = zpub6rqzeU44jyQizFhsFQvG1TsDgRzkY4hJDTCPZoNnrQQdMfPMsKqQLkDN2FRV6K9p7Qf3eUBrCpxExRKabVnfaSP6MiWpnhGQ8HyTuNZdT7M</span> <span class="hljs-comment">// accountXpub: ExtPublicKey = zpub6qkKNPaM8BeYDju1hE5z5VbNXLqJzECeFRPYJGJXGCaMiAJcCYVuawDptV4KKyzFWaA1b83g6nv7257c54W1Pg68aq4vC1UuzmpHJLC99Fu</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 = tb1qdcjckefdjqr0pme7aluhyalad8j2cm2x8wd5ns</span> <span class="hljs-comment">// firstAccountAddress: Bech32Address = tb1q4zrcquv8kjmer6gp3gs50rspre4fkacgqggqw9</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 = tb1qdcjckefdjqr0pme7aluhyalad8j2cm2x8wd5ns</span> <span class="hljs-comment">// res2: String = tb1q4zrcquv8kjmer6gp3gs50rspre4fkacgqggqw9</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>

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

@ -64,7 +64,7 @@
}); });
</script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/bitcoin-s/bitcoin-s/blob/master/docs/core/txbuilder.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">TxBuilder Example</h1></header><article><div><span><p>Bitcoin-S features a transaction building API that allows you to construct and sign Bitcoin transactions. Here's an example of how to use it</p> </script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/bitcoin-s/bitcoin-s/blob/master/docs/core/txbuilder.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">TxBuilder Example</h1></header><article><div><span><p>Bitcoin-S features a transaction building API that allows you to construct and sign Bitcoin transactions. Here's an example of how to use it</p>
<pre><code class="hljs css language-scala"><span class="hljs-keyword">implicit</span> <span class="hljs-keyword">val</span> ec: <span class="hljs-type">ExecutionContext</span> = <span class="hljs-type">ExecutionContext</span>.<span class="hljs-type">Implicits</span>.global <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@77d7e638[Running, parallelism = 2, size = 2, active = 0, running = 0, steals = 33, tasks = 0, submissions = 0]</span> <span class="hljs-comment">// ec: ExecutionContext = scala.concurrent.impl.ExecutionContextImpl$$anon$3@5db04152[Running, parallelism = 2, size = 2, active = 0, running = 0, steals = 41, tasks = 0, submissions = 0]</span>
<span class="hljs-comment">// Initialize a transaction builder</span> <span class="hljs-comment">// Initialize a transaction builder</span>
<span class="hljs-keyword">val</span> builder = <span class="hljs-type">RawTxBuilder</span>() <span class="hljs-keyword">val</span> builder = <span class="hljs-type">RawTxBuilder</span>()
@ -74,19 +74,19 @@
<span class="hljs-keyword">val</span> privKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey <span class="hljs-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(031d77bfbaa985f2ad5af5dd276c363f90950e1680862f4b0b0cfbc32e9b62cda7)</span> <span class="hljs-comment">// pubKey: ECPublicKey = ECPublicKey(031f7db9eb5b68c6b8720eb9a3d00f84c27eab47de761c76aed9b106b9edc66243)</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(b5f366ef623ed44044f053e0353c35fa89b115de)</span> <span class="hljs-comment">// creditingSpk: P2PKHScriptPubKey = pkh(ff3a1f7be2348b5398f1d61215cb4fb2904fe8cd)</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(b5f366ef623ed44044f053e0353c35fa89b115de))</span> <span class="hljs-comment">// utxo: TransactionOutput = TransactionOutput(10000 sats,pkh(ff3a1f7be2348b5398f1d61215cb4fb2904fe8cd))</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
@ -99,7 +99,7 @@
<span class="hljs-comment">// the script that corresponds to destination private key, this is what is receiving the money</span> <span class="hljs-comment">// the script that corresponds to destination private key, this is what is receiving the money</span>
<span class="hljs-keyword">val</span> destinationSPK = <span class="hljs-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(cffbb95b2c51861da3d85d84e60fac4b577819d1)</span> <span class="hljs-comment">// destinationSPK: P2PKHScriptPubKey = pkh(ca3c6939adcd5dbfac9a3cc7951f318d79df8c7a)</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>
@ -110,7 +110,7 @@
<span class="hljs-type">Vector</span>(destination0) <span class="hljs-type">Vector</span>(destination0)
} }
<span class="hljs-comment">// destinations: Vector[TransactionOutput] = Vector(TransactionOutput(5000 sats,pkh(cffbb95b2c51861da3d85d84e60fac4b577819d1)))</span> <span class="hljs-comment">// destinations: Vector[TransactionOutput] = Vector(TransactionOutput(5000 sats,pkh(ca3c6939adcd5dbfac9a3cc7951f318d79df8c7a)))</span>
<span class="hljs-comment">// Add the destinations to the tx builder</span> <span class="hljs-comment">// Add the destinations to the tx builder</span>
builder ++= destinations builder ++= destinations
@ -123,17 +123,17 @@ builder ++= destinations
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 = BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(b5f366ef623ed44044f053e0353c35fa89b115de))),UInt32Impl(0))</span> <span class="hljs-comment">// creditingTx: BaseTransaction = BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(ff3a1f7be2348b5398f1d61215cb4fb2904fe8cd))),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 &quot;link&quot; it in the transaction we are creating</span> <span class="hljs-comment">// to properly &quot;link&quot; it in the transaction we are creating</span>
<span class="hljs-keyword">val</span> outPoint = <span class="hljs-type">TransactionOutPoint</span>(creditingTx.txId, <span class="hljs-type">UInt32</span>.zero) <span class="hljs-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(82245930a990bdf7247dd1b94af7f2556887e83852b061b679c7e38c4688ff48:0)</span> <span class="hljs-comment">// outPoint: TransactionOutPoint = TransactionOutPoint(8f8ab641c336524a192af314671f3f1899ad51187d9a1d2ea6e14269bb796e05:0)</span>
<span class="hljs-keyword">val</span> input = <span class="hljs-type">TransactionInput</span>( <span class="hljs-keyword">val</span> input = <span class="hljs-type">TransactionInput</span>(
outPoint, outPoint,
<span class="hljs-type">EmptyScriptSignature</span>, <span class="hljs-type">EmptyScriptSignature</span>,
sequenceNumber = <span class="hljs-type">UInt32</span>.zero) sequenceNumber = <span class="hljs-type">UInt32</span>.zero)
<span class="hljs-comment">// input: TransactionInput = TransactionInputImpl(TransactionOutPoint(82245930a990bdf7247dd1b94af7f2556887e83852b061b679c7e38c4688ff48:0),EmptyScriptSignature,UInt32Impl(0))</span> <span class="hljs-comment">// input: TransactionInput = TransactionInputImpl(TransactionOutPoint(8f8ab641c336524a192af314671f3f1899ad51187d9a1d2ea6e14269bb796e05:0),EmptyScriptSignature,UInt32Impl(0))</span>
<span class="hljs-comment">// Add a new input to our builder</span> <span class="hljs-comment">// Add a new input to our builder</span>
builder += input builder += input
@ -141,11 +141,11 @@ builder += input
<span class="hljs-comment">// We can now generate a RawTxBuilderResult ready to be finalized</span> <span class="hljs-comment">// We can now generate a RawTxBuilderResult ready to be finalized</span>
<span class="hljs-keyword">val</span> builderResult = builder.result() <span class="hljs-keyword">val</span> builderResult = builder.result()
<span class="hljs-comment">// builderResult: RawTxBuilderResult = RawTxBuilderResult(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(82245930a990bdf7247dd1b94af7f2556887e83852b061b679c7e38c4688ff48:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(cffbb95b2c51861da3d85d84e60fac4b577819d1))),UInt32Impl(0))</span> <span class="hljs-comment">// builderResult: RawTxBuilderResult = RawTxBuilderResult(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(8f8ab641c336524a192af314671f3f1899ad51187d9a1d2ea6e14269bb796e05:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(ca3c6939adcd5dbfac9a3cc7951f318d79df8c7a))),UInt32Impl(0))</span>
<span class="hljs-comment">// this contains the information needed to analyze our input during finalization</span> <span class="hljs-comment">// this contains the information needed to analyze our input during finalization</span>
<span class="hljs-keyword">val</span> inputInfo = <span class="hljs-type">P2PKHInputInfo</span>(outPoint, amount, privKey.publicKey) <span class="hljs-keyword">val</span> inputInfo = <span class="hljs-type">P2PKHInputInfo</span>(outPoint, amount, privKey.publicKey)
<span class="hljs-comment">// inputInfo: P2PKHInputInfo = P2PKHInputInfo(TransactionOutPoint(82245930a990bdf7247dd1b94af7f2556887e83852b061b679c7e38c4688ff48:0),10000 sats,ECPublicKey(031d77bfbaa985f2ad5af5dd276c363f90950e1680862f4b0b0cfbc32e9b62cda7))</span> <span class="hljs-comment">// inputInfo: P2PKHInputInfo = P2PKHInputInfo(TransactionOutPoint(8f8ab641c336524a192af314671f3f1899ad51187d9a1d2ea6e14269bb796e05:0),10000 sats,ECPublicKey(031f7db9eb5b68c6b8720eb9a3d00f84c27eab47de761c76aed9b106b9edc66243))</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>
@ -155,18 +155,18 @@ builder += input
<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(1ab6df0fcec405dc7d07948e32cdcfb69041f1d8)</span> <span class="hljs-comment">// changeSPK: P2PKHScriptPubKey = pkh(939296be2a96011ac8fe428cb413ff01a392a827)</span>
<span class="hljs-comment">// We chose a finalizer that adds a change output to our tx based on a fee rate</span> <span class="hljs-comment">// We chose a finalizer that adds a change output to our tx based on a fee rate</span>
<span class="hljs-keyword">val</span> finalizer = <span class="hljs-type">StandardNonInteractiveFinalizer</span>( <span class="hljs-keyword">val</span> finalizer = <span class="hljs-type">StandardNonInteractiveFinalizer</span>(
<span class="hljs-type">Vector</span>(inputInfo), <span class="hljs-type">Vector</span>(inputInfo),
feeRate, feeRate,
changeSPK) changeSPK)
<span class="hljs-comment">// finalizer: StandardNonInteractiveFinalizer = StandardNonInteractiveFinalizer(Vector(P2PKHInputInfo(TransactionOutPoint(82245930a990bdf7247dd1b94af7f2556887e83852b061b679c7e38c4688ff48:0),10000 sats,ECPublicKey(031d77bfbaa985f2ad5af5dd276c363f90950e1680862f4b0b0cfbc32e9b62cda7))),1 sats/byte,pkh(1ab6df0fcec405dc7d07948e32cdcfb69041f1d8))</span> <span class="hljs-comment">// finalizer: StandardNonInteractiveFinalizer = StandardNonInteractiveFinalizer(Vector(P2PKHInputInfo(TransactionOutPoint(8f8ab641c336524a192af314671f3f1899ad51187d9a1d2ea6e14269bb796e05:0),10000 sats,ECPublicKey(031f7db9eb5b68c6b8720eb9a3d00f84c27eab47de761c76aed9b106b9edc66243))),1 sats/byte,pkh(939296be2a96011ac8fe428cb413ff01a392a827))</span>
<span class="hljs-comment">// We can now finalize the tx builder result from earlier with this finalizer</span> <span class="hljs-comment">// We can now finalize the tx builder result from earlier with this finalizer</span>
<span class="hljs-keyword">val</span> unsignedTxF: <span class="hljs-type">Future</span>[<span class="hljs-type">Transaction</span>] = finalizer.buildTx(builderResult) <span class="hljs-keyword">val</span> unsignedTxF: <span class="hljs-type">Future</span>[<span class="hljs-type">Transaction</span>] = finalizer.buildTx(builderResult)
<span class="hljs-comment">// unsignedTxF: Future[Transaction] = Future(Success(BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(82245930a990bdf7247dd1b94af7f2556887e83852b061b679c7e38c4688ff48:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(cffbb95b2c51861da3d85d84e60fac4b577819d1)), TransactionOutput(4775 sats,pkh(1ab6df0fcec405dc7d07948e32cdcfb69041f1d8))),UInt32Impl(0))))</span> <span class="hljs-comment">// unsignedTxF: Future[Transaction] = Future(Success(BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(8f8ab641c336524a192af314671f3f1899ad51187d9a1d2ea6e14269bb796e05:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(ca3c6939adcd5dbfac9a3cc7951f318d79df8c7a)), TransactionOutput(4775 sats,pkh(939296be2a96011ac8fe428cb413ff01a392a827))),UInt32Impl(0))))</span>
<span class="hljs-comment">// We now turn to signing the unsigned transaction</span> <span class="hljs-comment">// We now turn to signing the unsigned transaction</span>
<span class="hljs-comment">// this contains all the information we need to</span> <span class="hljs-comment">// this contains all the information we need to</span>
@ -176,12 +176,12 @@ builder += input
signers = <span class="hljs-type">Vector</span>(privKey), signers = <span class="hljs-type">Vector</span>(privKey),
hashType = hashType =
<span class="hljs-type">HashType</span>.sigHashAll) <span class="hljs-type">HashType</span>.sigHashAll)
<span class="hljs-comment">// utxoInfo: ScriptSignatureParams[P2PKHInputInfo] = ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(82245930a990bdf7247dd1b94af7f2556887e83852b061b679c7e38c4688ff48:0),10000 sats,ECPublicKey(031d77bfbaa985f2ad5af5dd276c363f90950e1680862f4b0b0cfbc32e9b62cda7)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(b5f366ef623ed44044f053e0353c35fa89b115de))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1)))</span> <span class="hljs-comment">// utxoInfo: ScriptSignatureParams[P2PKHInputInfo] = ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(8f8ab641c336524a192af314671f3f1899ad51187d9a1d2ea6e14269bb796e05:0),10000 sats,ECPublicKey(031f7db9eb5b68c6b8720eb9a3d00f84c27eab47de761c76aed9b106b9edc66243)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(ff3a1f7be2348b5398f1d61215cb4fb2904fe8cd))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1)))</span>
<span class="hljs-comment">// all of the UTXO spending information, since we only have</span> <span class="hljs-comment">// all of the UTXO spending information, since we only have</span>
<span class="hljs-comment">// one input, this is just one element</span> <span class="hljs-comment">// one input, this is just one element</span>
<span class="hljs-keyword">val</span> utxoInfos: <span class="hljs-type">Vector</span>[<span class="hljs-type">ScriptSignatureParams</span>[<span class="hljs-type">InputInfo</span>]] = <span class="hljs-type">Vector</span>(utxoInfo) <span class="hljs-keyword">val</span> utxoInfos: <span class="hljs-type">Vector</span>[<span class="hljs-type">ScriptSignatureParams</span>[<span class="hljs-type">InputInfo</span>]] = <span class="hljs-type">Vector</span>(utxoInfo)
<span class="hljs-comment">// utxoInfos: Vector[ScriptSignatureParams[InputInfo]] = Vector(ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(82245930a990bdf7247dd1b94af7f2556887e83852b061b679c7e38c4688ff48:0),10000 sats,ECPublicKey(031d77bfbaa985f2ad5af5dd276c363f90950e1680862f4b0b0cfbc32e9b62cda7)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(b5f366ef623ed44044f053e0353c35fa89b115de))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1))))</span> <span class="hljs-comment">// utxoInfos: Vector[ScriptSignatureParams[InputInfo]] = Vector(ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(8f8ab641c336524a192af314671f3f1899ad51187d9a1d2ea6e14269bb796e05:0),10000 sats,ECPublicKey(031f7db9eb5b68c6b8720eb9a3d00f84c27eab47de761c76aed9b106b9edc66243)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(ff3a1f7be2348b5398f1d61215cb4fb2904fe8cd))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1))))</span>
<span class="hljs-comment">// Yay! Now we use the RawTxSigner object to sign the tx.</span> <span class="hljs-comment">// Yay! Now we use the RawTxSigner object to sign the tx.</span>
<span class="hljs-comment">// The &#x27;sign&#x27; method is going produce a validly signed transaction</span> <span class="hljs-comment">// The &#x27;sign&#x27; method is going produce a validly signed transaction</span>
@ -201,7 +201,7 @@ builder += input
} }
<span class="hljs-type">Await</span>.result(signedTxF, <span class="hljs-number">30.</span>seconds) <span class="hljs-type">Await</span>.result(signedTxF, <span class="hljs-number">30.</span>seconds)
} }
<span class="hljs-comment">// signedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(82245930a990bdf7247dd1b94af7f2556887e83852b061b679c7e38c4688ff48:0),P2PKHScriptSignature(ECPublicKey(031d77bfbaa985f2ad5af5dd276c363f90950e1680862f4b0b0cfbc32e9b62cda7), ECDigitalSignature(30440220021f8b1f35904cac18cc96b0a137f6ec3c7d885011aa9724a726c3e03089b4d602201d9e4c71f9221dbd3a616fa26832310ffba4b6aa980dc5122147c4eea24f02fa01)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(cffbb95b2c51861da3d85d84e60fac4b577819d1)), TransactionOutput(4775 sats,pkh(1ab6df0fcec405dc7d07948e32cdcfb69041f1d8))),UInt32Impl(0))</span> <span class="hljs-comment">// signedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(8f8ab641c336524a192af314671f3f1899ad51187d9a1d2ea6e14269bb796e05:0),P2PKHScriptSignature(ECPublicKey(031f7db9eb5b68c6b8720eb9a3d00f84c27eab47de761c76aed9b106b9edc66243), ECDigitalSignature(3044022071162120294937563e8eba826fe7a748132a82e1c38aca925b59a66f0df91761022021311965f97c48e2997caa7c9c8561ab2bbdde0e3e1791488f622a7f396468ed01)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(ca3c6939adcd5dbfac9a3cc7951f318d79df8c7a)), TransactionOutput(4775 sats,pkh(939296be2a96011ac8fe428cb413ff01a392a827))),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">// res2: Int = 1</span> <span class="hljs-comment">// res2: Int = 1</span>
@ -211,7 +211,7 @@ signedTx.outputs.length
<span class="hljs-comment">//remember, you can call .hex on any bitcoin-s data structure to get the hex representation!</span> <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">// res4: String = 020000000148ff88468ce3c779b661b05238e8876855f2f74ab9d17d24f7bd90a930592482000000006a4730440220021f8b1f35904cac18cc96b0a137f6ec3c7d885011aa9724a726c3e03089b4d602201d9e4c71f9221dbd3a616fa26832310ffba4b6aa980dc5122147c4eea24f02fa0121031d77bfbaa985f2ad5af5dd276c363f90950e1680862f4b0b0cfbc32e9b62cda7000000000288130000000000001976a914cffbb95b2c51861da3d85d84e60fac4b577819d188aca7120000000000001976a9141ab6df0fcec405dc7d07948e32cdcfb69041f1d888ac00000000</span> <span class="hljs-comment">// res4: String = 0200000001056e79bb6942e1a62e1d9a7d1851ad99183f1f6714f32a194a5236c341b68a8f000000006a473044022071162120294937563e8eba826fe7a748132a82e1c38aca925b59a66f0df91761022021311965f97c48e2997caa7c9c8561ab2bbdde0e3e1791488f622a7f396468ed0121031f7db9eb5b68c6b8720eb9a3d00f84c27eab47de761c76aed9b106b9edc66243000000000288130000000000001976a914ca3c6939adcd5dbfac9a3cc7951f318d79df8c7a88aca7120000000000001976a914939296be2a96011ac8fe428cb413ff01a392a82788ac00000000</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/core/lightning-network"><span>Lightning Network Data Types</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/favicon.ico" alt="bitcoin-s" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/getting-started">Getting Started</a><a href="/docs/en/core/core-intro">Guides</a><a href="/api/org/bitcoins">API Reference</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="https://join.slack.com/t/suredbits/shared_invite/zt-eavycu0x-WQL7XOakzQo8tAy7jHHZUw" target="_blank" rel="noreferrer noopener">Slack</a><a href="https://gitter.im/bitcoin-s-core/">Gitter chat</a></div><div><h5>More</h5><a href="https://github.com/bitcoin-s/bitcoin-s">GitHub</a><a class="github-button" href="https://github.com/bitcoin-s/bitcoin-s" data-icon="octicon-star" data-count-href="/bitcoin-s/bitcoin-s-core/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 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/core/lightning-network"><span>Lightning Network Data Types</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/favicon.ico" alt="bitcoin-s" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/getting-started">Getting Started</a><a href="/docs/en/core/core-intro">Guides</a><a href="/api/org/bitcoins">API Reference</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="https://join.slack.com/t/suredbits/shared_invite/zt-eavycu0x-WQL7XOakzQo8tAy7jHHZUw" target="_blank" rel="noreferrer noopener">Slack</a><a href="https://gitter.im/bitcoin-s-core/">Gitter chat</a></div><div><h5>More</h5><a href="https://github.com/bitcoin-s/bitcoin-s">GitHub</a><a class="github-button" href="https://github.com/bitcoin-s/bitcoin-s" data-icon="octicon-star" data-count-href="/bitcoin-s/bitcoin-s-core/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 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) {

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

@ -64,7 +64,7 @@
}); });
</script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/bitcoin-s/bitcoin-s/blob/master/docs/core/txbuilder.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">TxBuilder Example</h1></header><article><div><span><p>Bitcoin-S features a transaction building API that allows you to construct and sign Bitcoin transactions. Here's an example of how to use it</p> </script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/bitcoin-s/bitcoin-s/blob/master/docs/core/txbuilder.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">TxBuilder Example</h1></header><article><div><span><p>Bitcoin-S features a transaction building API that allows you to construct and sign Bitcoin transactions. Here's an example of how to use it</p>
<pre><code class="hljs css language-scala"><span class="hljs-keyword">implicit</span> <span class="hljs-keyword">val</span> ec: <span class="hljs-type">ExecutionContext</span> = <span class="hljs-type">ExecutionContext</span>.<span class="hljs-type">Implicits</span>.global <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@77d7e638[Running, parallelism = 2, size = 2, active = 0, running = 0, steals = 33, tasks = 0, submissions = 0]</span> <span class="hljs-comment">// ec: ExecutionContext = scala.concurrent.impl.ExecutionContextImpl$$anon$3@5db04152[Running, parallelism = 2, size = 2, active = 0, running = 0, steals = 41, tasks = 0, submissions = 0]</span>
<span class="hljs-comment">// Initialize a transaction builder</span> <span class="hljs-comment">// Initialize a transaction builder</span>
<span class="hljs-keyword">val</span> builder = <span class="hljs-type">RawTxBuilder</span>() <span class="hljs-keyword">val</span> builder = <span class="hljs-type">RawTxBuilder</span>()
@ -74,19 +74,19 @@
<span class="hljs-keyword">val</span> privKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey <span class="hljs-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(031d77bfbaa985f2ad5af5dd276c363f90950e1680862f4b0b0cfbc32e9b62cda7)</span> <span class="hljs-comment">// pubKey: ECPublicKey = ECPublicKey(031f7db9eb5b68c6b8720eb9a3d00f84c27eab47de761c76aed9b106b9edc66243)</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(b5f366ef623ed44044f053e0353c35fa89b115de)</span> <span class="hljs-comment">// creditingSpk: P2PKHScriptPubKey = pkh(ff3a1f7be2348b5398f1d61215cb4fb2904fe8cd)</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(b5f366ef623ed44044f053e0353c35fa89b115de))</span> <span class="hljs-comment">// utxo: TransactionOutput = TransactionOutput(10000 sats,pkh(ff3a1f7be2348b5398f1d61215cb4fb2904fe8cd))</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
@ -99,7 +99,7 @@
<span class="hljs-comment">// the script that corresponds to destination private key, this is what is receiving the money</span> <span class="hljs-comment">// the script that corresponds to destination private key, this is what is receiving the money</span>
<span class="hljs-keyword">val</span> destinationSPK = <span class="hljs-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(cffbb95b2c51861da3d85d84e60fac4b577819d1)</span> <span class="hljs-comment">// destinationSPK: P2PKHScriptPubKey = pkh(ca3c6939adcd5dbfac9a3cc7951f318d79df8c7a)</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>
@ -110,7 +110,7 @@
<span class="hljs-type">Vector</span>(destination0) <span class="hljs-type">Vector</span>(destination0)
} }
<span class="hljs-comment">// destinations: Vector[TransactionOutput] = Vector(TransactionOutput(5000 sats,pkh(cffbb95b2c51861da3d85d84e60fac4b577819d1)))</span> <span class="hljs-comment">// destinations: Vector[TransactionOutput] = Vector(TransactionOutput(5000 sats,pkh(ca3c6939adcd5dbfac9a3cc7951f318d79df8c7a)))</span>
<span class="hljs-comment">// Add the destinations to the tx builder</span> <span class="hljs-comment">// Add the destinations to the tx builder</span>
builder ++= destinations builder ++= destinations
@ -123,17 +123,17 @@ builder ++= destinations
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 = BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(b5f366ef623ed44044f053e0353c35fa89b115de))),UInt32Impl(0))</span> <span class="hljs-comment">// creditingTx: BaseTransaction = BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(ff3a1f7be2348b5398f1d61215cb4fb2904fe8cd))),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 &quot;link&quot; it in the transaction we are creating</span> <span class="hljs-comment">// to properly &quot;link&quot; it in the transaction we are creating</span>
<span class="hljs-keyword">val</span> outPoint = <span class="hljs-type">TransactionOutPoint</span>(creditingTx.txId, <span class="hljs-type">UInt32</span>.zero) <span class="hljs-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(82245930a990bdf7247dd1b94af7f2556887e83852b061b679c7e38c4688ff48:0)</span> <span class="hljs-comment">// outPoint: TransactionOutPoint = TransactionOutPoint(8f8ab641c336524a192af314671f3f1899ad51187d9a1d2ea6e14269bb796e05:0)</span>
<span class="hljs-keyword">val</span> input = <span class="hljs-type">TransactionInput</span>( <span class="hljs-keyword">val</span> input = <span class="hljs-type">TransactionInput</span>(
outPoint, outPoint,
<span class="hljs-type">EmptyScriptSignature</span>, <span class="hljs-type">EmptyScriptSignature</span>,
sequenceNumber = <span class="hljs-type">UInt32</span>.zero) sequenceNumber = <span class="hljs-type">UInt32</span>.zero)
<span class="hljs-comment">// input: TransactionInput = TransactionInputImpl(TransactionOutPoint(82245930a990bdf7247dd1b94af7f2556887e83852b061b679c7e38c4688ff48:0),EmptyScriptSignature,UInt32Impl(0))</span> <span class="hljs-comment">// input: TransactionInput = TransactionInputImpl(TransactionOutPoint(8f8ab641c336524a192af314671f3f1899ad51187d9a1d2ea6e14269bb796e05:0),EmptyScriptSignature,UInt32Impl(0))</span>
<span class="hljs-comment">// Add a new input to our builder</span> <span class="hljs-comment">// Add a new input to our builder</span>
builder += input builder += input
@ -141,11 +141,11 @@ builder += input
<span class="hljs-comment">// We can now generate a RawTxBuilderResult ready to be finalized</span> <span class="hljs-comment">// We can now generate a RawTxBuilderResult ready to be finalized</span>
<span class="hljs-keyword">val</span> builderResult = builder.result() <span class="hljs-keyword">val</span> builderResult = builder.result()
<span class="hljs-comment">// builderResult: RawTxBuilderResult = RawTxBuilderResult(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(82245930a990bdf7247dd1b94af7f2556887e83852b061b679c7e38c4688ff48:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(cffbb95b2c51861da3d85d84e60fac4b577819d1))),UInt32Impl(0))</span> <span class="hljs-comment">// builderResult: RawTxBuilderResult = RawTxBuilderResult(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(8f8ab641c336524a192af314671f3f1899ad51187d9a1d2ea6e14269bb796e05:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(ca3c6939adcd5dbfac9a3cc7951f318d79df8c7a))),UInt32Impl(0))</span>
<span class="hljs-comment">// this contains the information needed to analyze our input during finalization</span> <span class="hljs-comment">// this contains the information needed to analyze our input during finalization</span>
<span class="hljs-keyword">val</span> inputInfo = <span class="hljs-type">P2PKHInputInfo</span>(outPoint, amount, privKey.publicKey) <span class="hljs-keyword">val</span> inputInfo = <span class="hljs-type">P2PKHInputInfo</span>(outPoint, amount, privKey.publicKey)
<span class="hljs-comment">// inputInfo: P2PKHInputInfo = P2PKHInputInfo(TransactionOutPoint(82245930a990bdf7247dd1b94af7f2556887e83852b061b679c7e38c4688ff48:0),10000 sats,ECPublicKey(031d77bfbaa985f2ad5af5dd276c363f90950e1680862f4b0b0cfbc32e9b62cda7))</span> <span class="hljs-comment">// inputInfo: P2PKHInputInfo = P2PKHInputInfo(TransactionOutPoint(8f8ab641c336524a192af314671f3f1899ad51187d9a1d2ea6e14269bb796e05:0),10000 sats,ECPublicKey(031f7db9eb5b68c6b8720eb9a3d00f84c27eab47de761c76aed9b106b9edc66243))</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>
@ -155,18 +155,18 @@ builder += input
<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(1ab6df0fcec405dc7d07948e32cdcfb69041f1d8)</span> <span class="hljs-comment">// changeSPK: P2PKHScriptPubKey = pkh(939296be2a96011ac8fe428cb413ff01a392a827)</span>
<span class="hljs-comment">// We chose a finalizer that adds a change output to our tx based on a fee rate</span> <span class="hljs-comment">// We chose a finalizer that adds a change output to our tx based on a fee rate</span>
<span class="hljs-keyword">val</span> finalizer = <span class="hljs-type">StandardNonInteractiveFinalizer</span>( <span class="hljs-keyword">val</span> finalizer = <span class="hljs-type">StandardNonInteractiveFinalizer</span>(
<span class="hljs-type">Vector</span>(inputInfo), <span class="hljs-type">Vector</span>(inputInfo),
feeRate, feeRate,
changeSPK) changeSPK)
<span class="hljs-comment">// finalizer: StandardNonInteractiveFinalizer = StandardNonInteractiveFinalizer(Vector(P2PKHInputInfo(TransactionOutPoint(82245930a990bdf7247dd1b94af7f2556887e83852b061b679c7e38c4688ff48:0),10000 sats,ECPublicKey(031d77bfbaa985f2ad5af5dd276c363f90950e1680862f4b0b0cfbc32e9b62cda7))),1 sats/byte,pkh(1ab6df0fcec405dc7d07948e32cdcfb69041f1d8))</span> <span class="hljs-comment">// finalizer: StandardNonInteractiveFinalizer = StandardNonInteractiveFinalizer(Vector(P2PKHInputInfo(TransactionOutPoint(8f8ab641c336524a192af314671f3f1899ad51187d9a1d2ea6e14269bb796e05:0),10000 sats,ECPublicKey(031f7db9eb5b68c6b8720eb9a3d00f84c27eab47de761c76aed9b106b9edc66243))),1 sats/byte,pkh(939296be2a96011ac8fe428cb413ff01a392a827))</span>
<span class="hljs-comment">// We can now finalize the tx builder result from earlier with this finalizer</span> <span class="hljs-comment">// We can now finalize the tx builder result from earlier with this finalizer</span>
<span class="hljs-keyword">val</span> unsignedTxF: <span class="hljs-type">Future</span>[<span class="hljs-type">Transaction</span>] = finalizer.buildTx(builderResult) <span class="hljs-keyword">val</span> unsignedTxF: <span class="hljs-type">Future</span>[<span class="hljs-type">Transaction</span>] = finalizer.buildTx(builderResult)
<span class="hljs-comment">// unsignedTxF: Future[Transaction] = Future(Success(BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(82245930a990bdf7247dd1b94af7f2556887e83852b061b679c7e38c4688ff48:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(cffbb95b2c51861da3d85d84e60fac4b577819d1)), TransactionOutput(4775 sats,pkh(1ab6df0fcec405dc7d07948e32cdcfb69041f1d8))),UInt32Impl(0))))</span> <span class="hljs-comment">// unsignedTxF: Future[Transaction] = Future(Success(BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(8f8ab641c336524a192af314671f3f1899ad51187d9a1d2ea6e14269bb796e05:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(ca3c6939adcd5dbfac9a3cc7951f318d79df8c7a)), TransactionOutput(4775 sats,pkh(939296be2a96011ac8fe428cb413ff01a392a827))),UInt32Impl(0))))</span>
<span class="hljs-comment">// We now turn to signing the unsigned transaction</span> <span class="hljs-comment">// We now turn to signing the unsigned transaction</span>
<span class="hljs-comment">// this contains all the information we need to</span> <span class="hljs-comment">// this contains all the information we need to</span>
@ -176,12 +176,12 @@ builder += input
signers = <span class="hljs-type">Vector</span>(privKey), signers = <span class="hljs-type">Vector</span>(privKey),
hashType = hashType =
<span class="hljs-type">HashType</span>.sigHashAll) <span class="hljs-type">HashType</span>.sigHashAll)
<span class="hljs-comment">// utxoInfo: ScriptSignatureParams[P2PKHInputInfo] = ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(82245930a990bdf7247dd1b94af7f2556887e83852b061b679c7e38c4688ff48:0),10000 sats,ECPublicKey(031d77bfbaa985f2ad5af5dd276c363f90950e1680862f4b0b0cfbc32e9b62cda7)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(b5f366ef623ed44044f053e0353c35fa89b115de))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1)))</span> <span class="hljs-comment">// utxoInfo: ScriptSignatureParams[P2PKHInputInfo] = ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(8f8ab641c336524a192af314671f3f1899ad51187d9a1d2ea6e14269bb796e05:0),10000 sats,ECPublicKey(031f7db9eb5b68c6b8720eb9a3d00f84c27eab47de761c76aed9b106b9edc66243)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(ff3a1f7be2348b5398f1d61215cb4fb2904fe8cd))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1)))</span>
<span class="hljs-comment">// all of the UTXO spending information, since we only have</span> <span class="hljs-comment">// all of the UTXO spending information, since we only have</span>
<span class="hljs-comment">// one input, this is just one element</span> <span class="hljs-comment">// one input, this is just one element</span>
<span class="hljs-keyword">val</span> utxoInfos: <span class="hljs-type">Vector</span>[<span class="hljs-type">ScriptSignatureParams</span>[<span class="hljs-type">InputInfo</span>]] = <span class="hljs-type">Vector</span>(utxoInfo) <span class="hljs-keyword">val</span> utxoInfos: <span class="hljs-type">Vector</span>[<span class="hljs-type">ScriptSignatureParams</span>[<span class="hljs-type">InputInfo</span>]] = <span class="hljs-type">Vector</span>(utxoInfo)
<span class="hljs-comment">// utxoInfos: Vector[ScriptSignatureParams[InputInfo]] = Vector(ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(82245930a990bdf7247dd1b94af7f2556887e83852b061b679c7e38c4688ff48:0),10000 sats,ECPublicKey(031d77bfbaa985f2ad5af5dd276c363f90950e1680862f4b0b0cfbc32e9b62cda7)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(b5f366ef623ed44044f053e0353c35fa89b115de))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1))))</span> <span class="hljs-comment">// utxoInfos: Vector[ScriptSignatureParams[InputInfo]] = Vector(ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(8f8ab641c336524a192af314671f3f1899ad51187d9a1d2ea6e14269bb796e05:0),10000 sats,ECPublicKey(031f7db9eb5b68c6b8720eb9a3d00f84c27eab47de761c76aed9b106b9edc66243)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(ff3a1f7be2348b5398f1d61215cb4fb2904fe8cd))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1))))</span>
<span class="hljs-comment">// Yay! Now we use the RawTxSigner object to sign the tx.</span> <span class="hljs-comment">// Yay! Now we use the RawTxSigner object to sign the tx.</span>
<span class="hljs-comment">// The &#x27;sign&#x27; method is going produce a validly signed transaction</span> <span class="hljs-comment">// The &#x27;sign&#x27; method is going produce a validly signed transaction</span>
@ -201,7 +201,7 @@ builder += input
} }
<span class="hljs-type">Await</span>.result(signedTxF, <span class="hljs-number">30.</span>seconds) <span class="hljs-type">Await</span>.result(signedTxF, <span class="hljs-number">30.</span>seconds)
} }
<span class="hljs-comment">// signedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(82245930a990bdf7247dd1b94af7f2556887e83852b061b679c7e38c4688ff48:0),P2PKHScriptSignature(ECPublicKey(031d77bfbaa985f2ad5af5dd276c363f90950e1680862f4b0b0cfbc32e9b62cda7), ECDigitalSignature(30440220021f8b1f35904cac18cc96b0a137f6ec3c7d885011aa9724a726c3e03089b4d602201d9e4c71f9221dbd3a616fa26832310ffba4b6aa980dc5122147c4eea24f02fa01)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(cffbb95b2c51861da3d85d84e60fac4b577819d1)), TransactionOutput(4775 sats,pkh(1ab6df0fcec405dc7d07948e32cdcfb69041f1d8))),UInt32Impl(0))</span> <span class="hljs-comment">// signedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(8f8ab641c336524a192af314671f3f1899ad51187d9a1d2ea6e14269bb796e05:0),P2PKHScriptSignature(ECPublicKey(031f7db9eb5b68c6b8720eb9a3d00f84c27eab47de761c76aed9b106b9edc66243), ECDigitalSignature(3044022071162120294937563e8eba826fe7a748132a82e1c38aca925b59a66f0df91761022021311965f97c48e2997caa7c9c8561ab2bbdde0e3e1791488f622a7f396468ed01)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(ca3c6939adcd5dbfac9a3cc7951f318d79df8c7a)), TransactionOutput(4775 sats,pkh(939296be2a96011ac8fe428cb413ff01a392a827))),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">// res2: Int = 1</span> <span class="hljs-comment">// res2: Int = 1</span>
@ -211,7 +211,7 @@ signedTx.outputs.length
<span class="hljs-comment">//remember, you can call .hex on any bitcoin-s data structure to get the hex representation!</span> <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">// res4: String = 020000000148ff88468ce3c779b661b05238e8876855f2f74ab9d17d24f7bd90a930592482000000006a4730440220021f8b1f35904cac18cc96b0a137f6ec3c7d885011aa9724a726c3e03089b4d602201d9e4c71f9221dbd3a616fa26832310ffba4b6aa980dc5122147c4eea24f02fa0121031d77bfbaa985f2ad5af5dd276c363f90950e1680862f4b0b0cfbc32e9b62cda7000000000288130000000000001976a914cffbb95b2c51861da3d85d84e60fac4b577819d188aca7120000000000001976a9141ab6df0fcec405dc7d07948e32cdcfb69041f1d888ac00000000</span> <span class="hljs-comment">// res4: String = 0200000001056e79bb6942e1a62e1d9a7d1851ad99183f1f6714f32a194a5236c341b68a8f000000006a473044022071162120294937563e8eba826fe7a748132a82e1c38aca925b59a66f0df91761022021311965f97c48e2997caa7c9c8561ab2bbdde0e3e1791488f622a7f396468ed0121031f7db9eb5b68c6b8720eb9a3d00f84c27eab47de761c76aed9b106b9edc66243000000000288130000000000001976a914ca3c6939adcd5dbfac9a3cc7951f318d79df8c7a88aca7120000000000001976a914939296be2a96011ac8fe428cb413ff01a392a82788ac00000000</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/core/lightning-network"><span>Lightning Network Data Types</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/favicon.ico" alt="bitcoin-s" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/getting-started">Getting Started</a><a href="/docs/en/core/core-intro">Guides</a><a href="/api/org/bitcoins">API Reference</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="https://join.slack.com/t/suredbits/shared_invite/zt-eavycu0x-WQL7XOakzQo8tAy7jHHZUw" target="_blank" rel="noreferrer noopener">Slack</a><a href="https://gitter.im/bitcoin-s-core/">Gitter chat</a></div><div><h5>More</h5><a href="https://github.com/bitcoin-s/bitcoin-s">GitHub</a><a class="github-button" href="https://github.com/bitcoin-s/bitcoin-s" data-icon="octicon-star" data-count-href="/bitcoin-s/bitcoin-s-core/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 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/core/lightning-network"><span>Lightning Network Data Types</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/favicon.ico" alt="bitcoin-s" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/getting-started">Getting Started</a><a href="/docs/en/core/core-intro">Guides</a><a href="/api/org/bitcoins">API Reference</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="https://join.slack.com/t/suredbits/shared_invite/zt-eavycu0x-WQL7XOakzQo8tAy7jHHZUw" target="_blank" rel="noreferrer noopener">Slack</a><a href="https://gitter.im/bitcoin-s-core/">Gitter chat</a></div><div><h5>More</h5><a href="https://github.com/bitcoin-s/bitcoin-s">GitHub</a><a class="github-button" href="https://github.com/bitcoin-s/bitcoin-s" data-icon="octicon-star" data-count-href="/bitcoin-s/bitcoin-s-core/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 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) {

4
docs/next/crypto/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(304402207b9bf5356b779da1c378c96f50154009dc659916615875b2a248391433cea86002206d60b76ad6e5c08054ece006dab2e6c30e0c6d34fce6a5464ba4facef4e58c91)</span> <span class="hljs-comment">// res0: ECDigitalSignature = ECDigitalSignature(3044022003d875a1cab8a240d37e497c47b2274600b67a97552186ae2afe9baf07fe356d02201b95eeea88e55f0548bde390d1bd5da0470c974ca8260dbe137d3edd2ebd682c)</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(3045022100e7cce873d3bc05ec2b0ed2845d0badb4479d8b0efea88a6cb38f32abe88aa91f0220784b61acb871053a72f4e0dcf26d562a5f49604af25570b5aacd7ab3d3e4a394)</span> <span class="hljs-comment">// res1: ECDigitalSignature = ECDigitalSignature(3045022100d12cf73d8289f1b1c15a5381e90d8ed41355a4f3413b0abfa08ccf42aca2857c022061a595351eff5eb3e3d790bdccba12cd40eb6de12f00fa1ecc524caba47cd5fa)</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/crypto/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(304402207b9bf5356b779da1c378c96f50154009dc659916615875b2a248391433cea86002206d60b76ad6e5c08054ece006dab2e6c30e0c6d34fce6a5464ba4facef4e58c91)</span> <span class="hljs-comment">// res0: ECDigitalSignature = ECDigitalSignature(3044022003d875a1cab8a240d37e497c47b2274600b67a97552186ae2afe9baf07fe356d02201b95eeea88e55f0548bde390d1bd5da0470c974ca8260dbe137d3edd2ebd682c)</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(3045022100e7cce873d3bc05ec2b0ed2845d0badb4479d8b0efea88a6cb38f32abe88aa91f0220784b61acb871053a72f4e0dcf26d562a5f49604af25570b5aacd7ab3d3e4a394)</span> <span class="hljs-comment">// res1: ECDigitalSignature = ECDigitalSignature(3045022100d12cf73d8289f1b1c15a5381e90d8ed41355a4f3413b0abfa08ccf42aca2857c022061a595351eff5eb3e3d790bdccba12cd40eb6de12f00fa1ecc524caba47cd5fa)</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>

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

@ -120,7 +120,7 @@ libraryDependencies += <span class="hljs-string">&quot;org.bitcoin-s&quot;</span
<h3><a class="anchor" aria-hidden="true" id="nightly-builds"></a><a href="#nightly-builds" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Nightly builds</h3> <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.4.0+176-bc656146-SNAPSHOT</code>.</p> recent snapshot published is <code>0.4.0+177-64a6b6bb-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>
<pre><code class="hljs css language-sbt">resolvers += Resolver.sonatypeRepo(<span class="hljs-string">&quot;snapshots&quot;</span>) <pre><code class="hljs css language-sbt">resolvers += Resolver.sonatypeRepo(<span class="hljs-string">&quot;snapshots&quot;</span>)

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

@ -120,7 +120,7 @@ libraryDependencies += <span class="hljs-string">&quot;org.bitcoin-s&quot;</span
<h3><a class="anchor" aria-hidden="true" id="nightly-builds"></a><a href="#nightly-builds" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Nightly builds</h3> <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.4.0+176-bc656146-SNAPSHOT</code>.</p> recent snapshot published is <code>0.4.0+177-64a6b6bb-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>
<pre><code class="hljs css language-sbt">resolvers += Resolver.sonatypeRepo(<span class="hljs-string">&quot;snapshots&quot;</span>) <pre><code class="hljs css language-sbt">resolvers += Resolver.sonatypeRepo(<span class="hljs-string">&quot;snapshots&quot;</span>)

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

@ -77,14 +77,14 @@
<span class="hljs-comment">//get 256 bits of random entropy</span> <span class="hljs-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, 0xc72d816635a084e181e90c73f331acb9b7fa91710635f30f60472ca9a3e79bd7)</span> <span class="hljs-comment">// entropy: scodec.bits.BitVector = BitVector(256 bits, 0x2e212eb29e9ceac455849cfa9811e26e260755dfe14d3868d6090a00fe549ab9)</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(shrimp, hire, flower, hero, analyst, ignore, amateur, canoe, initial, office, hen, inflict, leisure, emerge, series, shop, vessel, kitchen, balcony, flock, olive, video, hungry, tone)</span> <span class="hljs-comment">// Vector(comfort, annual, protect, diamond, solid, giraffe, figure, near, whisper, scene, joy, sword, gather, priority, legend, claim, debris, effort, liquid, beef, avocado, clean, helmet, capital)</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>
@ -99,7 +99,7 @@ generate specific kinds of addresses for wallets.</p>
<pre><code class="hljs css language-scala"><span class="hljs-comment">//this will create a temp directory with the prefix &#x27;key-manager-example` that will</span> <pre><code class="hljs css language-scala"><span class="hljs-comment">//this will create a temp directory with the prefix &#x27;key-manager-example` that will</span>
<span class="hljs-comment">//have a file in it called &quot;encrypted-bitcoin-s-seed.json&quot;</span> <span class="hljs-comment">//have a file in it called &quot;encrypted-bitcoin-s-seed.json&quot;</span>
<span class="hljs-keyword">val</span> seedPath = <span class="hljs-type">Files</span>.createTempDirectory(<span class="hljs-string">&quot;key-manager-example&quot;</span>).resolve(<span class="hljs-type">WalletStorage</span>.<span class="hljs-type">ENCRYPTED_SEED_FILE_NAME</span>) <span class="hljs-keyword">val</span> seedPath = <span class="hljs-type">Files</span>.createTempDirectory(<span class="hljs-string">&quot;key-manager-example&quot;</span>).resolve(<span class="hljs-type">WalletStorage</span>.<span class="hljs-type">ENCRYPTED_SEED_FILE_NAME</span>)
<span class="hljs-comment">// seedPath: Path = /tmp/key-manager-example8817023002797417654/encrypted-bitcoin-s-seed.json</span> <span class="hljs-comment">// seedPath: Path = /tmp/key-manager-example8224973967465686222/encrypted-bitcoin-s-seed.json</span>
<span class="hljs-comment">//let&#x27;s create a native segwit key manager</span> <span class="hljs-comment">//let&#x27;s create a native segwit key manager</span>
<span class="hljs-keyword">val</span> purpose = <span class="hljs-type">HDPurposes</span>.<span class="hljs-type">SegWit</span> <span class="hljs-keyword">val</span> purpose = <span class="hljs-type">HDPurposes</span>.<span class="hljs-type">SegWit</span>
@ -110,19 +110,19 @@ generate specific kinds of addresses for wallets.</p>
<span class="hljs-comment">// network: RegTest.type = RegTest</span> <span class="hljs-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-example8817023002797417654/encrypted-bitcoin-s-seed.json,m/84&#x27;,RegTest)</span> <span class="hljs-comment">// kmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example8224973967465686222/encrypted-bitcoin-s-seed.json,m/84&#x27;,RegTest)</span>
<span class="hljs-keyword">val</span> aesPasswordOpt = <span class="hljs-type">Some</span>(<span class="hljs-type">AesPassword</span>.fromString(<span class="hljs-string">&quot;password&quot;</span>)) <span class="hljs-keyword">val</span> aesPasswordOpt = <span class="hljs-type">Some</span>(<span class="hljs-type">AesPassword</span>.fromString(<span class="hljs-string">&quot;password&quot;</span>))
<span class="hljs-comment">// aesPasswordOpt: Some[AesPassword] = Some(Masked(AesPassword))</span> <span class="hljs-comment">// aesPasswordOpt: Some[AesPassword] = Some(Masked(AesPassword))</span>
<span class="hljs-keyword">val</span> km = <span class="hljs-type">BIP39KeyManager</span>.initializeWithMnemonic(aesPasswordOpt, mnemonic, <span class="hljs-type">None</span>, kmParams) <span class="hljs-keyword">val</span> km = <span class="hljs-type">BIP39KeyManager</span>.initializeWithMnemonic(aesPasswordOpt, mnemonic, <span class="hljs-type">None</span>, kmParams)
<span class="hljs-comment">// km: Either[KeyManagerInitializeError, BIP39KeyManager] = Right(org.bitcoins.keymanager.bip39.BIP39KeyManager@67d6df15)</span> <span class="hljs-comment">// km: Either[KeyManagerInitializeError, BIP39KeyManager] = Right(org.bitcoins.keymanager.bip39.BIP39KeyManager@5c4e5c4f)</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 = vpub5SLqN2bLY4WeaAJ1wPzLiB4Ty2wZAuUCednXopGTjQbSwncQge6KxvyyDmintawPhm5DyKgJ2J7Gd2oLHg6qrwqqdbxEgoV3NokKfR1RvUg</span> <span class="hljs-comment">// rootXPub: ExtPublicKey = vpub5SLqN2bLY4WeZDp5KBEJziTF67PLqYfNA8CYL3XHG2aNNcYfgYssDa9Kc798EgfEDA8qEu7p6wZKKm7i6vGrs1hXE6KTXKGyUnm99U9ACPC</span>
println(rootXPub) println(rootXPub)
<span class="hljs-comment">// vpub5SLqN2bLY4WeaAJ1wPzLiB4Ty2wZAuUCednXopGTjQbSwncQge6KxvyyDmintawPhm5DyKgJ2J7Gd2oLHg6qrwqqdbxEgoV3NokKfR1RvUg</span> <span class="hljs-comment">// vpub5SLqN2bLY4WeZDp5KBEJziTF67PLqYfNA8CYL3XHG2aNNcYfgYssDa9Kc798EgfEDA8qEu7p6wZKKm7i6vGrs1hXE6KTXKGyUnm99U9ACPC</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>
@ -131,17 +131,17 @@ println(rootXPub)
again after initializing it once. You can use the same <code>mnemonic</code> for different networks, which you control <code>KeyManagerParams</code>.</p> again after initializing it once. You can use the same <code>mnemonic</code> for different networks, which you control <code>KeyManagerParams</code>.</p>
<pre><code class="hljs css language-scala"><span class="hljs-comment">//let&#x27;s create a nested segwit key manager for mainnet</span> <pre><code class="hljs css language-scala"><span class="hljs-comment">//let&#x27;s create a nested segwit key manager for mainnet</span>
<span class="hljs-keyword">val</span> mainnetKmParams = <span class="hljs-type">KeyManagerParams</span>(seedPath, <span class="hljs-type">HDPurposes</span>.<span class="hljs-type">SegWit</span>, <span class="hljs-type">MainNet</span>) <span class="hljs-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-example8817023002797417654/encrypted-bitcoin-s-seed.json,m/84&#x27;,MainNet)</span> <span class="hljs-comment">// mainnetKmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example8224973967465686222/encrypted-bitcoin-s-seed.json,m/84&#x27;,MainNet)</span>
<span class="hljs-comment">//we do not need to all `initializeWithMnemonic()` again as we have saved the seed to dis</span> <span class="hljs-comment">//we do not need to all `initializeWithMnemonic()` again as we have saved the seed to dis</span>
<span class="hljs-keyword">val</span> mainnetKeyManager = <span class="hljs-type">BIP39KeyManager</span>.fromMnemonic(mnemonic, mainnetKmParams, <span class="hljs-type">None</span>, <span class="hljs-type">Instant</span>.now) <span class="hljs-keyword">val</span> mainnetKeyManager = <span class="hljs-type">BIP39KeyManager</span>.fromMnemonic(mnemonic, mainnetKmParams, <span class="hljs-type">None</span>, <span class="hljs-type">Instant</span>.now)
<span class="hljs-comment">// mainnetKeyManager: BIP39KeyManager = org.bitcoins.keymanager.bip39.BIP39KeyManager@4c0473d9</span> <span class="hljs-comment">// mainnetKeyManager: BIP39KeyManager = org.bitcoins.keymanager.bip39.BIP39KeyManager@75acbcfb</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 = zpub6jftahH18ngZyM4VGq8qYXSUeuXLwPSCK5sQwPr1FS6yABsKhGkaTBcXJbZ8tDZ5LKYSyE4XrwXUABFbATku3taF6xjw2SkzThzuDhpYUp4</span> <span class="hljs-comment">// mainnetXpub: ExtPublicKey = zpub6jftahH18ngZxQaYecNoq4qFmyy8c2dMpaHRTd6pn45tb1oahBY7hpmsgvyUEKGuqic4EoW3wayWruZxyhvv3xRvhT79rxYvZh1ihr2NL69</span>
println(mainnetXpub) println(mainnetXpub)
<span class="hljs-comment">// zpub6jftahH18ngZyM4VGq8qYXSUeuXLwPSCK5sQwPr1FS6yABsKhGkaTBcXJbZ8tDZ5LKYSyE4XrwXUABFbATku3taF6xjw2SkzThzuDhpYUp4</span> <span class="hljs-comment">// zpub6jftahH18ngZxQaYecNoq4qFmyy8c2dMpaHRTd6pn45tb1oahBY7hpmsgvyUEKGuqic4EoW3wayWruZxyhvv3xRvhT79rxYvZh1ihr2NL69</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

@ -77,14 +77,14 @@
<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, 0xc72d816635a084e181e90c73f331acb9b7fa91710635f30f60472ca9a3e79bd7)</span> <span class="hljs-comment">// entropy: scodec.bits.BitVector = BitVector(256 bits, 0x2e212eb29e9ceac455849cfa9811e26e260755dfe14d3868d6090a00fe549ab9)</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(shrimp, hire, flower, hero, analyst, ignore, amateur, canoe, initial, office, hen, inflict, leisure, emerge, series, shop, vessel, kitchen, balcony, flock, olive, video, hungry, tone)</span> <span class="hljs-comment">// Vector(comfort, annual, protect, diamond, solid, giraffe, figure, near, whisper, scene, joy, sword, gather, priority, legend, claim, debris, effort, liquid, beef, avocado, clean, helmet, capital)</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>
@ -99,7 +99,7 @@ generate specific kinds of addresses for wallets.</p>
<pre><code class="hljs css language-scala"><span class="hljs-comment">//this will create a temp directory with the prefix &#x27;key-manager-example` that will</span> <pre><code class="hljs css language-scala"><span class="hljs-comment">//this will create a temp directory with the prefix &#x27;key-manager-example` that will</span>
<span class="hljs-comment">//have a file in it called &quot;encrypted-bitcoin-s-seed.json&quot;</span> <span class="hljs-comment">//have a file in it called &quot;encrypted-bitcoin-s-seed.json&quot;</span>
<span class="hljs-keyword">val</span> seedPath = <span class="hljs-type">Files</span>.createTempDirectory(<span class="hljs-string">&quot;key-manager-example&quot;</span>).resolve(<span class="hljs-type">WalletStorage</span>.<span class="hljs-type">ENCRYPTED_SEED_FILE_NAME</span>) <span class="hljs-keyword">val</span> seedPath = <span class="hljs-type">Files</span>.createTempDirectory(<span class="hljs-string">&quot;key-manager-example&quot;</span>).resolve(<span class="hljs-type">WalletStorage</span>.<span class="hljs-type">ENCRYPTED_SEED_FILE_NAME</span>)
<span class="hljs-comment">// seedPath: Path = /tmp/key-manager-example8817023002797417654/encrypted-bitcoin-s-seed.json</span> <span class="hljs-comment">// seedPath: Path = /tmp/key-manager-example8224973967465686222/encrypted-bitcoin-s-seed.json</span>
<span class="hljs-comment">//let&#x27;s create a native segwit key manager</span> <span class="hljs-comment">//let&#x27;s create a native segwit key manager</span>
<span class="hljs-keyword">val</span> purpose = <span class="hljs-type">HDPurposes</span>.<span class="hljs-type">SegWit</span> <span class="hljs-keyword">val</span> purpose = <span class="hljs-type">HDPurposes</span>.<span class="hljs-type">SegWit</span>
@ -110,19 +110,19 @@ generate specific kinds of addresses for wallets.</p>
<span class="hljs-comment">// network: RegTest.type = RegTest</span> <span class="hljs-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-example8817023002797417654/encrypted-bitcoin-s-seed.json,m/84&#x27;,RegTest)</span> <span class="hljs-comment">// kmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example8224973967465686222/encrypted-bitcoin-s-seed.json,m/84&#x27;,RegTest)</span>
<span class="hljs-keyword">val</span> aesPasswordOpt = <span class="hljs-type">Some</span>(<span class="hljs-type">AesPassword</span>.fromString(<span class="hljs-string">&quot;password&quot;</span>)) <span class="hljs-keyword">val</span> aesPasswordOpt = <span class="hljs-type">Some</span>(<span class="hljs-type">AesPassword</span>.fromString(<span class="hljs-string">&quot;password&quot;</span>))
<span class="hljs-comment">// aesPasswordOpt: Some[AesPassword] = Some(Masked(AesPassword))</span> <span class="hljs-comment">// aesPasswordOpt: Some[AesPassword] = Some(Masked(AesPassword))</span>
<span class="hljs-keyword">val</span> km = <span class="hljs-type">BIP39KeyManager</span>.initializeWithMnemonic(aesPasswordOpt, mnemonic, <span class="hljs-type">None</span>, kmParams) <span class="hljs-keyword">val</span> km = <span class="hljs-type">BIP39KeyManager</span>.initializeWithMnemonic(aesPasswordOpt, mnemonic, <span class="hljs-type">None</span>, kmParams)
<span class="hljs-comment">// km: Either[KeyManagerInitializeError, BIP39KeyManager] = Right(org.bitcoins.keymanager.bip39.BIP39KeyManager@67d6df15)</span> <span class="hljs-comment">// km: Either[KeyManagerInitializeError, BIP39KeyManager] = Right(org.bitcoins.keymanager.bip39.BIP39KeyManager@5c4e5c4f)</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 = vpub5SLqN2bLY4WeaAJ1wPzLiB4Ty2wZAuUCednXopGTjQbSwncQge6KxvyyDmintawPhm5DyKgJ2J7Gd2oLHg6qrwqqdbxEgoV3NokKfR1RvUg</span> <span class="hljs-comment">// rootXPub: ExtPublicKey = vpub5SLqN2bLY4WeZDp5KBEJziTF67PLqYfNA8CYL3XHG2aNNcYfgYssDa9Kc798EgfEDA8qEu7p6wZKKm7i6vGrs1hXE6KTXKGyUnm99U9ACPC</span>
println(rootXPub) println(rootXPub)
<span class="hljs-comment">// vpub5SLqN2bLY4WeaAJ1wPzLiB4Ty2wZAuUCednXopGTjQbSwncQge6KxvyyDmintawPhm5DyKgJ2J7Gd2oLHg6qrwqqdbxEgoV3NokKfR1RvUg</span> <span class="hljs-comment">// vpub5SLqN2bLY4WeZDp5KBEJziTF67PLqYfNA8CYL3XHG2aNNcYfgYssDa9Kc798EgfEDA8qEu7p6wZKKm7i6vGrs1hXE6KTXKGyUnm99U9ACPC</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>
@ -131,17 +131,17 @@ println(rootXPub)
again after initializing it once. You can use the same <code>mnemonic</code> for different networks, which you control <code>KeyManagerParams</code>.</p> again after initializing it once. You can use the same <code>mnemonic</code> for different networks, which you control <code>KeyManagerParams</code>.</p>
<pre><code class="hljs css language-scala"><span class="hljs-comment">//let&#x27;s create a nested segwit key manager for mainnet</span> <pre><code class="hljs css language-scala"><span class="hljs-comment">//let&#x27;s create a nested segwit key manager for mainnet</span>
<span class="hljs-keyword">val</span> mainnetKmParams = <span class="hljs-type">KeyManagerParams</span>(seedPath, <span class="hljs-type">HDPurposes</span>.<span class="hljs-type">SegWit</span>, <span class="hljs-type">MainNet</span>) <span class="hljs-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-example8817023002797417654/encrypted-bitcoin-s-seed.json,m/84&#x27;,MainNet)</span> <span class="hljs-comment">// mainnetKmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example8224973967465686222/encrypted-bitcoin-s-seed.json,m/84&#x27;,MainNet)</span>
<span class="hljs-comment">//we do not need to all `initializeWithMnemonic()` again as we have saved the seed to dis</span> <span class="hljs-comment">//we do not need to all `initializeWithMnemonic()` again as we have saved the seed to dis</span>
<span class="hljs-keyword">val</span> mainnetKeyManager = <span class="hljs-type">BIP39KeyManager</span>.fromMnemonic(mnemonic, mainnetKmParams, <span class="hljs-type">None</span>, <span class="hljs-type">Instant</span>.now) <span class="hljs-keyword">val</span> mainnetKeyManager = <span class="hljs-type">BIP39KeyManager</span>.fromMnemonic(mnemonic, mainnetKmParams, <span class="hljs-type">None</span>, <span class="hljs-type">Instant</span>.now)
<span class="hljs-comment">// mainnetKeyManager: BIP39KeyManager = org.bitcoins.keymanager.bip39.BIP39KeyManager@4c0473d9</span> <span class="hljs-comment">// mainnetKeyManager: BIP39KeyManager = org.bitcoins.keymanager.bip39.BIP39KeyManager@75acbcfb</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 = zpub6jftahH18ngZyM4VGq8qYXSUeuXLwPSCK5sQwPr1FS6yABsKhGkaTBcXJbZ8tDZ5LKYSyE4XrwXUABFbATku3taF6xjw2SkzThzuDhpYUp4</span> <span class="hljs-comment">// mainnetXpub: ExtPublicKey = zpub6jftahH18ngZxQaYecNoq4qFmyy8c2dMpaHRTd6pn45tb1oahBY7hpmsgvyUEKGuqic4EoW3wayWruZxyhvv3xRvhT79rxYvZh1ihr2NL69</span>
println(mainnetXpub) println(mainnetXpub)
<span class="hljs-comment">// zpub6jftahH18ngZyM4VGq8qYXSUeuXLwPSCK5sQwPr1FS6yABsKhGkaTBcXJbZ8tDZ5LKYSyE4XrwXUABFbATku3taF6xjw2SkzThzuDhpYUp4</span> <span class="hljs-comment">// zpub6jftahH18ngZxQaYecNoq4qFmyy8c2dMpaHRTd6pn45tb1oahBY7hpmsgvyUEKGuqic4EoW3wayWruZxyhvv3xRvhT79rxYvZh1ihr2NL69</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&quot;Verified with NativeSecp256k1 again=<sp
<pre><code class="hljs css language-scala"><span class="hljs-keyword">val</span> privKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey <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(030a722eeb70456d04cfa0a0b0360bd23737bcf22273ad0a17b84877226b31b343)</span> <span class="hljs-comment">// publicKey: ECPublicKey = ECPublicKey(034ba93a863832d3a4ff32e7620b24d3d0584deaeec8b02a6f570d11909ae97c0f)</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(304402203ef76203e64d049e6f2718cc105e7eadd854b8773ad7812dc7c358acd3314f4802205bb40462743b72709d977b7874fed494430a084893cfbeb156fbdac9bb067ae9)</span> <span class="hljs-comment">// signature: ECDigitalSignature = ECDigitalSignature(3045022100db26a0b9f01111e46e8fbf58bbe19fd0bd049caf9d0f0dfd4fea69a61fea5b13022019f467e51988ef327c30ac5de864d3ef023148387270b3d2c2869128ce63c13d)</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&quot;Verified with NativeSecp256k1 again=<sp
<pre><code class="hljs css language-scala"><span class="hljs-keyword">val</span> privKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey <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(030a722eeb70456d04cfa0a0b0360bd23737bcf22273ad0a17b84877226b31b343)</span> <span class="hljs-comment">// publicKey: ECPublicKey = ECPublicKey(034ba93a863832d3a4ff32e7620b24d3d0584deaeec8b02a6f570d11909ae97c0f)</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(304402203ef76203e64d049e6f2718cc105e7eadd854b8773ad7812dc7c358acd3314f4802205bb40462743b72709d977b7874fed494430a084893cfbeb156fbdac9bb067ae9)</span> <span class="hljs-comment">// signature: ECDigitalSignature = ECDigitalSignature(3045022100db26a0b9f01111e46e8fbf58bbe19fd0bd049caf9d0f0dfd4fea69a61fea5b13022019f467e51988ef327c30ac5de864d3ef023148387270b3d2c2869128ce63c13d)</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>