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 9f36250646
This commit is contained in:
Docusaurus bot 2021-02-02 00:00:50 +00:00
parent 12d4feaa56
commit c7cd2a10b6
16 changed files with 118 additions and 92 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
docs/next/applications/cli.html
View file

@ -82,7 +82,20 @@ Usage: bitcoin<span class="hljs-_">-s</span>-cli [options] [&lt;cmd&gt;]
&lt;cmd&gt; The <span class="hljs-built_in">command</span> and arguments to be executed. Try bitcoin<span class="hljs-_">-s</span>-cli <span class="hljs-built_in">help</span> <span class="hljs-keyword">for</span> a list of all commands
</code></pre>
<p>Now you are are ready to start the server that the cli sends commands to. Take a look at our <a href="/docs/next/applications/server">server</a> documentation on how to build and start the server.</p>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/next/getting-setup"><span class="arrow-prev">← </span><span>Getting Bitcoin-S installed on your machine</span></a><a class="docs-next button" href="/docs/next/applications/server"><span>Application Server</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#bitcoin-s-command-line-interface">Bitcoin-s command line interface</a><ul class="toc-headings"><li><a href="#building-the-command-line-interface">Building the command line interface</a></li><li><a href="#executing-commands">Executing commands</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/favicon.ico" alt="bitcoin-s" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/getting-started">Getting Started</a><a href="/docs/en/core/core-intro">Guides</a><a href="/api/org/bitcoins">API Reference</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="https://join.slack.com/t/suredbits/shared_invite/zt-eavycu0x-WQL7XOakzQo8tAy7jHHZUw" target="_blank" rel="noreferrer noopener">Slack</a><a href="https://gitter.im/bitcoin-s-core/">Gitter chat</a></div><div><h5>More</h5><a href="https://github.com/bitcoin-s/bitcoin-s">GitHub</a><a class="github-button" href="https://github.com/bitcoin-s/bitcoin-s" data-icon="octicon-star" data-count-href="/bitcoin-s/bitcoin-s-core/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2021 Suredbits &amp; the bitcoin-s developers</section></footer></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script><script>
<h3><a class="anchor" aria-hidden="true" id="native-binaries"></a><a href="#native-binaries" 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>Native binaries</h3>
<p>Bitcoin-s also supports building native executables for various platforms supported by the <a href="https://www.graalvm.org/reference-manual/native-image/">graalvm native image</a> tool.</p>
<p>You can build by using the <a href="https://github.com/scalameta/sbt-native-image">native image plugin for sbt</a>. This will download the appropriate graalvm
version and the native image tool, and then build the cli</p>
<pre><code class="hljs css language-bashrc">sbt <span class="hljs-keyword">cli</span>/nativeImage
</code></pre>
<p>After the build is done, you can find the artifact here locally</p>
<pre><code class="hljs css language-bashrc"><span class="hljs-keyword">app</span>/<span class="hljs-keyword">cli</span>/target/native-image/bitcoin-s-<span class="hljs-keyword">cli</span>
</code></pre>
<p>We also publish native image binaries every time we merge a commit to master on github.
As an example, you can <a href="https://github.com/bitcoin-s/bitcoin-s/actions?query=workflow%3A%22Native+Image+bitcoin-s-cli%22">see the artifacts</a>
in the upper right hand corner.</p>
<p>If you don't want to build the <code>bitcoin-s-cli</code> yourself, you can download it for your platform there.</p>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/next/getting-setup"><span class="arrow-prev">← </span><span>Getting Bitcoin-S installed on your machine</span></a><a class="docs-next button" href="/docs/next/applications/server"><span>Application Server</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#bitcoin-s-command-line-interface">Bitcoin-s command line interface</a><ul class="toc-headings"><li><a href="#building-the-command-line-interface">Building the command line interface</a></li><li><a href="#executing-commands">Executing commands</a></li><li><a href="#native-binaries">Native binaries</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/favicon.ico" alt="bitcoin-s" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/getting-started">Getting Started</a><a href="/docs/en/core/core-intro">Guides</a><a href="/api/org/bitcoins">API Reference</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="https://join.slack.com/t/suredbits/shared_invite/zt-eavycu0x-WQL7XOakzQo8tAy7jHHZUw" target="_blank" rel="noreferrer noopener">Slack</a><a href="https://gitter.im/bitcoin-s-core/">Gitter chat</a></div><div><h5>More</h5><a href="https://github.com/bitcoin-s/bitcoin-s">GitHub</a><a class="github-button" href="https://github.com/bitcoin-s/bitcoin-s" data-icon="octicon-star" data-count-href="/bitcoin-s/bitcoin-s-core/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2021 Suredbits &amp; the bitcoin-s developers</section></footer></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script><script>
document.addEventListener('keyup', function(e) {
if (e.target !== document.body) {
return;

15
docs/next/applications/cli/index.html
View file

@ -82,7 +82,20 @@ Usage: bitcoin<span class="hljs-_">-s</span>-cli [options] [&lt;cmd&gt;]
&lt;cmd&gt; The <span class="hljs-built_in">command</span> and arguments to be executed. Try bitcoin<span class="hljs-_">-s</span>-cli <span class="hljs-built_in">help</span> <span class="hljs-keyword">for</span> a list of all commands
</code></pre>
<p>Now you are are ready to start the server that the cli sends commands to. Take a look at our <a href="/docs/next/applications/server">server</a> documentation on how to build and start the server.</p>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/next/getting-setup"><span class="arrow-prev">← </span><span>Getting Bitcoin-S installed on your machine</span></a><a class="docs-next button" href="/docs/next/applications/server"><span>Application Server</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#bitcoin-s-command-line-interface">Bitcoin-s command line interface</a><ul class="toc-headings"><li><a href="#building-the-command-line-interface">Building the command line interface</a></li><li><a href="#executing-commands">Executing commands</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/favicon.ico" alt="bitcoin-s" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/getting-started">Getting Started</a><a href="/docs/en/core/core-intro">Guides</a><a href="/api/org/bitcoins">API Reference</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="https://join.slack.com/t/suredbits/shared_invite/zt-eavycu0x-WQL7XOakzQo8tAy7jHHZUw" target="_blank" rel="noreferrer noopener">Slack</a><a href="https://gitter.im/bitcoin-s-core/">Gitter chat</a></div><div><h5>More</h5><a href="https://github.com/bitcoin-s/bitcoin-s">GitHub</a><a class="github-button" href="https://github.com/bitcoin-s/bitcoin-s" data-icon="octicon-star" data-count-href="/bitcoin-s/bitcoin-s-core/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2021 Suredbits &amp; the bitcoin-s developers</section></footer></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script><script>
<h3><a class="anchor" aria-hidden="true" id="native-binaries"></a><a href="#native-binaries" 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>Native binaries</h3>
<p>Bitcoin-s also supports building native executables for various platforms supported by the <a href="https://www.graalvm.org/reference-manual/native-image/">graalvm native image</a> tool.</p>
<p>You can build by using the <a href="https://github.com/scalameta/sbt-native-image">native image plugin for sbt</a>. This will download the appropriate graalvm
version and the native image tool, and then build the cli</p>
<pre><code class="hljs css language-bashrc">sbt <span class="hljs-keyword">cli</span>/nativeImage
</code></pre>
<p>After the build is done, you can find the artifact here locally</p>
<pre><code class="hljs css language-bashrc"><span class="hljs-keyword">app</span>/<span class="hljs-keyword">cli</span>/target/native-image/bitcoin-s-<span class="hljs-keyword">cli</span>
</code></pre>
<p>We also publish native image binaries every time we merge a commit to master on github.
As an example, you can <a href="https://github.com/bitcoin-s/bitcoin-s/actions?query=workflow%3A%22Native+Image+bitcoin-s-cli%22">see the artifacts</a>
in the upper right hand corner.</p>
<p>If you don't want to build the <code>bitcoin-s-cli</code> yourself, you can download it for your platform there.</p>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/next/getting-setup"><span class="arrow-prev">← </span><span>Getting Bitcoin-S installed on your machine</span></a><a class="docs-next button" href="/docs/next/applications/server"><span>Application Server</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#bitcoin-s-command-line-interface">Bitcoin-s command line interface</a><ul class="toc-headings"><li><a href="#building-the-command-line-interface">Building the command line interface</a></li><li><a href="#executing-commands">Executing commands</a></li><li><a href="#native-binaries">Native binaries</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/favicon.ico" alt="bitcoin-s" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/getting-started">Getting Started</a><a href="/docs/en/core/core-intro">Guides</a><a href="/api/org/bitcoins">API Reference</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="https://join.slack.com/t/suredbits/shared_invite/zt-eavycu0x-WQL7XOakzQo8tAy7jHHZUw" target="_blank" rel="noreferrer noopener">Slack</a><a href="https://gitter.im/bitcoin-s-core/">Gitter chat</a></div><div><h5>More</h5><a href="https://github.com/bitcoin-s/bitcoin-s">GitHub</a><a class="github-button" href="https://github.com/bitcoin-s/bitcoin-s" data-icon="octicon-star" data-count-href="/bitcoin-s/bitcoin-s-core/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2021 Suredbits &amp; the bitcoin-s developers</section></footer></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script><script>
document.addEventListener('keyup', function(e) {
if (e.target !== document.body) {
return;

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

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

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

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

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

@ -86,13 +86,13 @@ use that to generate further private and public keys:</p>
<span class="hljs-comment">// how long our phrase ends up being</span>
<span class="hljs-comment">// 256 bits of entropy results in 24 words</span>
<span class="hljs-keyword">val</span> entropy: <span class="hljs-type">BitVector</span> = <span class="hljs-type">MnemonicCode</span>.getEntropy256Bits
<span class="hljs-comment">// entropy: BitVector = BitVector(256 bits, 0xffacc0b2652fb157b3f99b7a8f97bbfe300fc515beaaabccb17ad7de0e68499c)</span>
<span class="hljs-comment">// entropy: BitVector = BitVector(256 bits, 0xb8452d2e821b4d00664febad2cdc1c650f74b35f0f3ae732456a183cb8613ba1)</span>
<span class="hljs-keyword">val</span> mnemonicCode = <span class="hljs-type">MnemonicCode</span>.fromEntropy(entropy)
<span class="hljs-comment">// mnemonicCode: MnemonicCode = Masked(MnemonicCodeImpl)</span>
mnemonicCode.words <span class="hljs-comment">// the phrase the user should write down</span>
<span class="hljs-comment">// res0: Vector[String] = Vector(zero, gravity, clutch, ski, wild, profit, soup, cricket, kind, lake, upon, wise, abstract, tip, finger, stem, profit, grain, gadget, quick, thought, crouch, chapter, nest) // the phrase the user should write down</span>
<span class="hljs-comment">// res0: Vector[String] = Vector(reunion, city, entry, aerobic, regular, lens, odor, word, pudding, group, alpha, skate, warrior, fluid, label, trap, transfer, mutual, fold, corn, slide, correct, update, chest) // the phrase the user should write down</span>
<span class="hljs-comment">// the password argument is an optional, extra security</span>
<span class="hljs-comment">// measure. all MnemonicCode instances will give you a</span>
@ -108,7 +108,7 @@ mnemonicCode.words <span class="hljs-comment">// the phrase the user should writ
bip39Seed)
<span class="hljs-comment">// xpriv: ExtPrivateKey = Masked(ExtPrivateKeyImpl)</span>
<span class="hljs-keyword">val</span> xpub = xpriv.extPublicKey
<span class="hljs-comment">// xpub: ExtPublicKey = zpub6jftahH18ngZwRjmFaGhejjwumuqABhG48YmU2M1tH478k3pvKr9UztiaVAgiLPqi45PvRg7QsprTmf8vzZNGgmfv1ZJ9LdMytNLjyvRcKJ</span>
<span class="hljs-comment">// xpub: ExtPublicKey = zpub6jftahH18ngZybHMVvUd3gCwqTbNeWZXQwb9XvnUsrMGDPouPptc9p3bo1Qmw4LWGQdqQrEZtaX6Vdt8LV96fV529LELjZ92yo4NsRnArMb</span>
<span class="hljs-comment">// you can now use the generated xpriv to derive further</span>
<span class="hljs-comment">// private or public keys</span>
@ -154,7 +154,7 @@ spend or steal any of your money.</p>
<span class="hljs-comment">// can generate addresses with it!</span>
accountXpriv.extPublicKey
}
<span class="hljs-comment">// accountXpub: ExtPublicKey = zpub6reyyCHwrwxM9y5uEDgK5vhRGNVgQ5kshp41DtFtVipVym9XUnS2yoWAHhDkfyif9Vp9D3JxbnKqUncpMC5CQZQnzmjTLaHtj55v4YTHGPC</span>
<span class="hljs-comment">// accountXpub: ExtPublicKey = zpub6r41KBjkDfUey8caao7izFcDQUNVsfHvnGRWj4FyEHe9neEUahpwDqWdKPau3EVw4E2UuttSgrmHf9RE3qrCSpPyEVNnXpyNaoyNbToy6Wt</span>
<span class="hljs-comment">// address no. 0 ---------------┐</span>
<span class="hljs-comment">// external address ----------┐ |</span>
@ -177,12 +177,12 @@ spend or steal any of your money.</p>
<span class="hljs-keyword">val</span> scriptPubKey = <span class="hljs-type">P2WPKHWitnessSPKV0</span>(pubkey)
<span class="hljs-type">Bech32Address</span>(scriptPubKey, <span class="hljs-type">TestNet3</span>)
}
<span class="hljs-comment">// firstAccountAddress: Bech32Address = tb1qvq9k7p2fy0w6sg4ztnc494kqd8xea92uu7w5xq</span>
<span class="hljs-comment">// firstAccountAddress: Bech32Address = tb1q6h4y56yrn8g0dhddrg4y4k2rjvfr2xl3vzc65w</span>
<span class="hljs-comment">// tada! We just generated an address you can send money to,</span>
<span class="hljs-comment">// without having access to the private key!</span>
firstAccountAddress.value
<span class="hljs-comment">// res2: String = tb1qvq9k7p2fy0w6sg4ztnc494kqd8xea92uu7w5xq</span>
<span class="hljs-comment">// res2: String = tb1q6h4y56yrn8g0dhddrg4y4k2rjvfr2xl3vzc65w</span>
<span class="hljs-comment">// you can now continue deriving addresses from the same public</span>
<span class="hljs-comment">// key, by imitating what we did above. To get the next</span>

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

@ -86,13 +86,13 @@ use that to generate further private and public keys:</p>
<span class="hljs-comment">// how long our phrase ends up being</span>
<span class="hljs-comment">// 256 bits of entropy results in 24 words</span>
<span class="hljs-keyword">val</span> entropy: <span class="hljs-type">BitVector</span> = <span class="hljs-type">MnemonicCode</span>.getEntropy256Bits
<span class="hljs-comment">// entropy: BitVector = BitVector(256 bits, 0xffacc0b2652fb157b3f99b7a8f97bbfe300fc515beaaabccb17ad7de0e68499c)</span>
<span class="hljs-comment">// entropy: BitVector = BitVector(256 bits, 0xb8452d2e821b4d00664febad2cdc1c650f74b35f0f3ae732456a183cb8613ba1)</span>
<span class="hljs-keyword">val</span> mnemonicCode = <span class="hljs-type">MnemonicCode</span>.fromEntropy(entropy)
<span class="hljs-comment">// mnemonicCode: MnemonicCode = Masked(MnemonicCodeImpl)</span>
mnemonicCode.words <span class="hljs-comment">// the phrase the user should write down</span>
<span class="hljs-comment">// res0: Vector[String] = Vector(zero, gravity, clutch, ski, wild, profit, soup, cricket, kind, lake, upon, wise, abstract, tip, finger, stem, profit, grain, gadget, quick, thought, crouch, chapter, nest) // the phrase the user should write down</span>
<span class="hljs-comment">// res0: Vector[String] = Vector(reunion, city, entry, aerobic, regular, lens, odor, word, pudding, group, alpha, skate, warrior, fluid, label, trap, transfer, mutual, fold, corn, slide, correct, update, chest) // the phrase the user should write down</span>
<span class="hljs-comment">// the password argument is an optional, extra security</span>
<span class="hljs-comment">// measure. all MnemonicCode instances will give you a</span>
@ -108,7 +108,7 @@ mnemonicCode.words <span class="hljs-comment">// the phrase the user should writ
bip39Seed)
<span class="hljs-comment">// xpriv: ExtPrivateKey = Masked(ExtPrivateKeyImpl)</span>
<span class="hljs-keyword">val</span> xpub = xpriv.extPublicKey
<span class="hljs-comment">// xpub: ExtPublicKey = zpub6jftahH18ngZwRjmFaGhejjwumuqABhG48YmU2M1tH478k3pvKr9UztiaVAgiLPqi45PvRg7QsprTmf8vzZNGgmfv1ZJ9LdMytNLjyvRcKJ</span>
<span class="hljs-comment">// xpub: ExtPublicKey = zpub6jftahH18ngZybHMVvUd3gCwqTbNeWZXQwb9XvnUsrMGDPouPptc9p3bo1Qmw4LWGQdqQrEZtaX6Vdt8LV96fV529LELjZ92yo4NsRnArMb</span>
<span class="hljs-comment">// you can now use the generated xpriv to derive further</span>
<span class="hljs-comment">// private or public keys</span>
@ -154,7 +154,7 @@ spend or steal any of your money.</p>
<span class="hljs-comment">// can generate addresses with it!</span>
accountXpriv.extPublicKey
}
<span class="hljs-comment">// accountXpub: ExtPublicKey = zpub6reyyCHwrwxM9y5uEDgK5vhRGNVgQ5kshp41DtFtVipVym9XUnS2yoWAHhDkfyif9Vp9D3JxbnKqUncpMC5CQZQnzmjTLaHtj55v4YTHGPC</span>
<span class="hljs-comment">// accountXpub: ExtPublicKey = zpub6r41KBjkDfUey8caao7izFcDQUNVsfHvnGRWj4FyEHe9neEUahpwDqWdKPau3EVw4E2UuttSgrmHf9RE3qrCSpPyEVNnXpyNaoyNbToy6Wt</span>
<span class="hljs-comment">// address no. 0 ---------------┐</span>
<span class="hljs-comment">// external address ----------┐ |</span>
@ -177,12 +177,12 @@ spend or steal any of your money.</p>
<span class="hljs-keyword">val</span> scriptPubKey = <span class="hljs-type">P2WPKHWitnessSPKV0</span>(pubkey)
<span class="hljs-type">Bech32Address</span>(scriptPubKey, <span class="hljs-type">TestNet3</span>)
}
<span class="hljs-comment">// firstAccountAddress: Bech32Address = tb1qvq9k7p2fy0w6sg4ztnc494kqd8xea92uu7w5xq</span>
<span class="hljs-comment">// firstAccountAddress: Bech32Address = tb1q6h4y56yrn8g0dhddrg4y4k2rjvfr2xl3vzc65w</span>
<span class="hljs-comment">// tada! We just generated an address you can send money to,</span>
<span class="hljs-comment">// without having access to the private key!</span>
firstAccountAddress.value
<span class="hljs-comment">// res2: String = tb1qvq9k7p2fy0w6sg4ztnc494kqd8xea92uu7w5xq</span>
<span class="hljs-comment">// res2: String = tb1q6h4y56yrn8g0dhddrg4y4k2rjvfr2xl3vzc65w</span>
<span class="hljs-comment">// you can now continue deriving addresses from the same public</span>
<span class="hljs-comment">// key, by imitating what we did above. To get the next</span>

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

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

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

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

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

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

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

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

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

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

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

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

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

@ -77,14 +77,14 @@
<span class="hljs-comment">//get 256 bits of random entropy</span>
<span class="hljs-keyword">val</span> entropy = <span class="hljs-type">MnemonicCode</span>.getEntropy256Bits
<span class="hljs-comment">// entropy: scodec.bits.BitVector = BitVector(256 bits, 0x6a933d6d2cd19a83f94ae77abbbfd044970a37947d89729ace1742de1dcc351f)</span>
<span class="hljs-comment">// entropy: scodec.bits.BitVector = BitVector(256 bits, 0x92ff60c2e958e057637eb2ab3de16e9957d0a9bceba7ec80835b7dcecb243695)</span>
<span class="hljs-keyword">val</span> mnemonic = <span class="hljs-type">MnemonicCode</span>.fromEntropy(entropy)
<span class="hljs-comment">// mnemonic: MnemonicCode = Masked(MnemonicCodeImpl)</span>
<span class="hljs-comment">//you can print that mnemonic seed with this</span>
println(mnemonic.words)
<span class="hljs-comment">// Vector(hedgehog, okay, forget, fluid, boost, draft, topple, friend, kingdom, target, village, matrix, idle, bridge, faint, raise, income, stool, magic, mad, tide, toward, stamp, tomorrow)</span>
<span class="hljs-comment">// Vector(napkin, wild, cost, sport, mix, close, mistake, stone, private, upper, forum, crawl, laptop, feel, victory, insane, uncle, advice, strategy, wine, uncover, must, surge, program)</span>
</code></pre>
<p>Now that we have a <code>MnemonicCode</code> that was securely generated, we need to now create <code>KeyManagerParams</code> which tells us how to generate
generate specific kinds of addresses for wallets.</p>
@ -99,7 +99,7 @@ generate specific kinds of addresses for wallets.</p>
<pre><code class="hljs css language-scala"><span class="hljs-comment">//this will create a temp directory with the prefix 'key-manager-example` that will</span>
<span class="hljs-comment">//have a file in it called "encrypted-bitcoin-s-seed.json"</span>
<span class="hljs-keyword">val</span> seedPath = <span class="hljs-type">Files</span>.createTempDirectory(<span class="hljs-string">"key-manager-example"</span>).resolve(<span class="hljs-type">WalletStorage</span>.<span class="hljs-type">ENCRYPTED_SEED_FILE_NAME</span>)
<span class="hljs-comment">// seedPath: Path = /tmp/key-manager-example321573224636757994/encrypted-bitcoin-s-seed.json</span>
<span class="hljs-comment">// seedPath: Path = /tmp/key-manager-example2156363164874848031/encrypted-bitcoin-s-seed.json</span>
<span class="hljs-comment">//let's create a native segwit key manager</span>
<span class="hljs-keyword">val</span> purpose = <span class="hljs-type">HDPurposes</span>.<span class="hljs-type">SegWit</span>
@ -110,19 +110,19 @@ generate specific kinds of addresses for wallets.</p>
<span class="hljs-comment">// network: RegTest.type = RegTest</span>
<span class="hljs-keyword">val</span> kmParams = <span class="hljs-type">KeyManagerParams</span>(seedPath, purpose, network)
<span class="hljs-comment">// kmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example321573224636757994/encrypted-bitcoin-s-seed.json,m/84',RegTest)</span>
<span class="hljs-comment">// kmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example2156363164874848031/encrypted-bitcoin-s-seed.json,m/84',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">"password"</span>))
<span class="hljs-comment">// aesPasswordOpt: Some[AesPassword] = Some(Masked(AesPassword))</span>
<span class="hljs-keyword">val</span> km = <span class="hljs-type">BIP39KeyManager</span>.initializeWithMnemonic(aesPasswordOpt, mnemonic, <span class="hljs-type">None</span>, kmParams)
<span class="hljs-comment">// km: Either[KeyManagerInitializeError, BIP39KeyManager] = Right(org.bitcoins.keymanager.bip39.BIP39KeyManager@658a69c9)</span>
<span class="hljs-comment">// km: Either[KeyManagerInitializeError, BIP39KeyManager] = Right(org.bitcoins.keymanager.bip39.BIP39KeyManager@e485328)</span>
<span class="hljs-keyword">val</span> rootXPub = km.right.get.getRootXPub
<span class="hljs-comment">// rootXPub: ExtPublicKey = vpub5SLqN2bLY4WeaNBXGfrZvmBkYZVWS3rc2UKoKschcUHoaXMqwmj7f9xbJiX73BgoCCBAnxU4y7ZMkM5kmqTSkPyzeR7kYifTT5f29GRMmvj</span>
<span class="hljs-comment">// rootXPub: ExtPublicKey = vpub5SLqN2bLY4WeY4BLkr5fKQbfojehGfmkhBPT1UsH2jSFQx3bjPdAurjqf9QozvgV6ULgUDsxxzwk83GoeHxUfKX7CD1EM8bcFWqG5p25Jgq</span>
println(rootXPub)
<span class="hljs-comment">// vpub5SLqN2bLY4WeaNBXGfrZvmBkYZVWS3rc2UKoKschcUHoaXMqwmj7f9xbJiX73BgoCCBAnxU4y7ZMkM5kmqTSkPyzeR7kYifTT5f29GRMmvj</span>
<span class="hljs-comment">// vpub5SLqN2bLY4WeY4BLkr5fKQbfojehGfmkhBPT1UsH2jSFQx3bjPdAurjqf9QozvgV6ULgUDsxxzwk83GoeHxUfKX7CD1EM8bcFWqG5p25Jgq</span>
</code></pre>
<p>Which should print something that looks like this</p>
<p><code>vpub5SLqN2bLY4WeXxMqwJHJFBEwxSscGB2uDUnsTS3edVjZEwTrQDFDNqoR2xLqARQPabGaXsHSTenTRcqm2EnB9MpuC4vSk3LqSgNmGGZtuq7</code></p>
@ -131,17 +131,17 @@ println(rootXPub)
again after initializing it once. You can use the same <code>mnemonic</code> for different networks, which you control <code>KeyManagerParams</code>.</p>
<pre><code class="hljs css language-scala"><span class="hljs-comment">//let's create a nested segwit key manager for mainnet</span>
<span class="hljs-keyword">val</span> mainnetKmParams = <span class="hljs-type">KeyManagerParams</span>(seedPath, <span class="hljs-type">HDPurposes</span>.<span class="hljs-type">SegWit</span>, <span class="hljs-type">MainNet</span>)
<span class="hljs-comment">// mainnetKmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example321573224636757994/encrypted-bitcoin-s-seed.json,m/84',MainNet)</span>
<span class="hljs-comment">// mainnetKmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example2156363164874848031/encrypted-bitcoin-s-seed.json,m/84',MainNet)</span>
<span class="hljs-comment">//we do not need to all `initializeWithMnemonic()` again as we have saved the seed to dis</span>
<span class="hljs-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@600ac967</span>
<span class="hljs-comment">// mainnetKeyManager: BIP39KeyManager = org.bitcoins.keymanager.bip39.BIP39KeyManager@6e434455</span>
<span class="hljs-keyword">val</span> mainnetXpub = mainnetKeyManager.getRootXPub
<span class="hljs-comment">// mainnetXpub: ExtPublicKey = zpub6jftahH18ngZyYwzc714m7ZmES5JCXpbgvQgTTCF8VoKnvckxQPN9Qb9PYMT2pJUpkePnrrJokyZHVY1ed7VwLiQ7muStMwQXyubhbL11Kw</span>
<span class="hljs-comment">// mainnetXpub: ExtPublicKey = zpub6jftahH18ngZwEwp6HEA9kygVcEV39jkMdUL94SpYkwmdMJWk2HRQ7NPjyF9zZJAj2ouU8GCoeMwfBj4X5cXrGFWfZnvgmsZLR5qeAyGipE</span>
println(mainnetXpub)
<span class="hljs-comment">// zpub6jftahH18ngZyYwzc714m7ZmES5JCXpbgvQgTTCF8VoKnvckxQPN9Qb9PYMT2pJUpkePnrrJokyZHVY1ed7VwLiQ7muStMwQXyubhbL11Kw</span>
<span class="hljs-comment">// zpub6jftahH18ngZwEwp6HEA9kygVcEV39jkMdUL94SpYkwmdMJWk2HRQ7NPjyF9zZJAj2ouU8GCoeMwfBj4X5cXrGFWfZnvgmsZLR5qeAyGipE</span>
</code></pre>
<p>Which gives us something that looks like this</p>
<p><code>zpub6jftahH18ngZw98KGjRo5XcxeKTQ2eztsvskb1dC9XF5TLimQquTs6Ry7nBBA425D9joXmfgJJCexmJ1u2SELJZJfRi95gcnXadLpZzYb5c</code></p>

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

@ -77,14 +77,14 @@
<span class="hljs-comment">//get 256 bits of random entropy</span>
<span class="hljs-keyword">val</span> entropy = <span class="hljs-type">MnemonicCode</span>.getEntropy256Bits
<span class="hljs-comment">// entropy: scodec.bits.BitVector = BitVector(256 bits, 0x6a933d6d2cd19a83f94ae77abbbfd044970a37947d89729ace1742de1dcc351f)</span>
<span class="hljs-comment">// entropy: scodec.bits.BitVector = BitVector(256 bits, 0x92ff60c2e958e057637eb2ab3de16e9957d0a9bceba7ec80835b7dcecb243695)</span>
<span class="hljs-keyword">val</span> mnemonic = <span class="hljs-type">MnemonicCode</span>.fromEntropy(entropy)
<span class="hljs-comment">// mnemonic: MnemonicCode = Masked(MnemonicCodeImpl)</span>
<span class="hljs-comment">//you can print that mnemonic seed with this</span>
println(mnemonic.words)
<span class="hljs-comment">// Vector(hedgehog, okay, forget, fluid, boost, draft, topple, friend, kingdom, target, village, matrix, idle, bridge, faint, raise, income, stool, magic, mad, tide, toward, stamp, tomorrow)</span>
<span class="hljs-comment">// Vector(napkin, wild, cost, sport, mix, close, mistake, stone, private, upper, forum, crawl, laptop, feel, victory, insane, uncle, advice, strategy, wine, uncover, must, surge, program)</span>
</code></pre>
<p>Now that we have a <code>MnemonicCode</code> that was securely generated, we need to now create <code>KeyManagerParams</code> which tells us how to generate
generate specific kinds of addresses for wallets.</p>
@ -99,7 +99,7 @@ generate specific kinds of addresses for wallets.</p>
<pre><code class="hljs css language-scala"><span class="hljs-comment">//this will create a temp directory with the prefix 'key-manager-example` that will</span>
<span class="hljs-comment">//have a file in it called "encrypted-bitcoin-s-seed.json"</span>
<span class="hljs-keyword">val</span> seedPath = <span class="hljs-type">Files</span>.createTempDirectory(<span class="hljs-string">"key-manager-example"</span>).resolve(<span class="hljs-type">WalletStorage</span>.<span class="hljs-type">ENCRYPTED_SEED_FILE_NAME</span>)
<span class="hljs-comment">// seedPath: Path = /tmp/key-manager-example321573224636757994/encrypted-bitcoin-s-seed.json</span>
<span class="hljs-comment">// seedPath: Path = /tmp/key-manager-example2156363164874848031/encrypted-bitcoin-s-seed.json</span>
<span class="hljs-comment">//let's create a native segwit key manager</span>
<span class="hljs-keyword">val</span> purpose = <span class="hljs-type">HDPurposes</span>.<span class="hljs-type">SegWit</span>
@ -110,19 +110,19 @@ generate specific kinds of addresses for wallets.</p>
<span class="hljs-comment">// network: RegTest.type = RegTest</span>
<span class="hljs-keyword">val</span> kmParams = <span class="hljs-type">KeyManagerParams</span>(seedPath, purpose, network)
<span class="hljs-comment">// kmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example321573224636757994/encrypted-bitcoin-s-seed.json,m/84',RegTest)</span>
<span class="hljs-comment">// kmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example2156363164874848031/encrypted-bitcoin-s-seed.json,m/84',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">"password"</span>))
<span class="hljs-comment">// aesPasswordOpt: Some[AesPassword] = Some(Masked(AesPassword))</span>
<span class="hljs-keyword">val</span> km = <span class="hljs-type">BIP39KeyManager</span>.initializeWithMnemonic(aesPasswordOpt, mnemonic, <span class="hljs-type">None</span>, kmParams)
<span class="hljs-comment">// km: Either[KeyManagerInitializeError, BIP39KeyManager] = Right(org.bitcoins.keymanager.bip39.BIP39KeyManager@658a69c9)</span>
<span class="hljs-comment">// km: Either[KeyManagerInitializeError, BIP39KeyManager] = Right(org.bitcoins.keymanager.bip39.BIP39KeyManager@e485328)</span>
<span class="hljs-keyword">val</span> rootXPub = km.right.get.getRootXPub
<span class="hljs-comment">// rootXPub: ExtPublicKey = vpub5SLqN2bLY4WeaNBXGfrZvmBkYZVWS3rc2UKoKschcUHoaXMqwmj7f9xbJiX73BgoCCBAnxU4y7ZMkM5kmqTSkPyzeR7kYifTT5f29GRMmvj</span>
<span class="hljs-comment">// rootXPub: ExtPublicKey = vpub5SLqN2bLY4WeY4BLkr5fKQbfojehGfmkhBPT1UsH2jSFQx3bjPdAurjqf9QozvgV6ULgUDsxxzwk83GoeHxUfKX7CD1EM8bcFWqG5p25Jgq</span>
println(rootXPub)
<span class="hljs-comment">// vpub5SLqN2bLY4WeaNBXGfrZvmBkYZVWS3rc2UKoKschcUHoaXMqwmj7f9xbJiX73BgoCCBAnxU4y7ZMkM5kmqTSkPyzeR7kYifTT5f29GRMmvj</span>
<span class="hljs-comment">// vpub5SLqN2bLY4WeY4BLkr5fKQbfojehGfmkhBPT1UsH2jSFQx3bjPdAurjqf9QozvgV6ULgUDsxxzwk83GoeHxUfKX7CD1EM8bcFWqG5p25Jgq</span>
</code></pre>
<p>Which should print something that looks like this</p>
<p><code>vpub5SLqN2bLY4WeXxMqwJHJFBEwxSscGB2uDUnsTS3edVjZEwTrQDFDNqoR2xLqARQPabGaXsHSTenTRcqm2EnB9MpuC4vSk3LqSgNmGGZtuq7</code></p>
@ -131,17 +131,17 @@ println(rootXPub)
again after initializing it once. You can use the same <code>mnemonic</code> for different networks, which you control <code>KeyManagerParams</code>.</p>
<pre><code class="hljs css language-scala"><span class="hljs-comment">//let's create a nested segwit key manager for mainnet</span>
<span class="hljs-keyword">val</span> mainnetKmParams = <span class="hljs-type">KeyManagerParams</span>(seedPath, <span class="hljs-type">HDPurposes</span>.<span class="hljs-type">SegWit</span>, <span class="hljs-type">MainNet</span>)
<span class="hljs-comment">// mainnetKmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example321573224636757994/encrypted-bitcoin-s-seed.json,m/84',MainNet)</span>
<span class="hljs-comment">// mainnetKmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example2156363164874848031/encrypted-bitcoin-s-seed.json,m/84',MainNet)</span>
<span class="hljs-comment">//we do not need to all `initializeWithMnemonic()` again as we have saved the seed to dis</span>
<span class="hljs-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@600ac967</span>
<span class="hljs-comment">// mainnetKeyManager: BIP39KeyManager = org.bitcoins.keymanager.bip39.BIP39KeyManager@6e434455</span>
<span class="hljs-keyword">val</span> mainnetXpub = mainnetKeyManager.getRootXPub
<span class="hljs-comment">// mainnetXpub: ExtPublicKey = zpub6jftahH18ngZyYwzc714m7ZmES5JCXpbgvQgTTCF8VoKnvckxQPN9Qb9PYMT2pJUpkePnrrJokyZHVY1ed7VwLiQ7muStMwQXyubhbL11Kw</span>
<span class="hljs-comment">// mainnetXpub: ExtPublicKey = zpub6jftahH18ngZwEwp6HEA9kygVcEV39jkMdUL94SpYkwmdMJWk2HRQ7NPjyF9zZJAj2ouU8GCoeMwfBj4X5cXrGFWfZnvgmsZLR5qeAyGipE</span>
println(mainnetXpub)
<span class="hljs-comment">// zpub6jftahH18ngZyYwzc714m7ZmES5JCXpbgvQgTTCF8VoKnvckxQPN9Qb9PYMT2pJUpkePnrrJokyZHVY1ed7VwLiQ7muStMwQXyubhbL11Kw</span>
<span class="hljs-comment">// zpub6jftahH18ngZwEwp6HEA9kygVcEV39jkMdUL94SpYkwmdMJWk2HRQ7NPjyF9zZJAj2ouU8GCoeMwfBj4X5cXrGFWfZnvgmsZLR5qeAyGipE</span>
</code></pre>
<p>Which gives us something that looks like this</p>
<p><code>zpub6jftahH18ngZw98KGjRo5XcxeKTQ2eztsvskb1dC9XF5TLimQquTs6Ry7nBBA425D9joXmfgJJCexmJ1u2SELJZJfRi95gcnXadLpZzYb5c</code></p>

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

@ -114,12 +114,12 @@ println(<span class="hljs-string">s"Verified with NativeSecp256k1 again=<span cl
<pre><code class="hljs css language-scala"><span class="hljs-keyword">val</span> privKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey
<span class="hljs-comment">// privKey: ECPrivateKey = Masked(ECPrivateKeyImpl)</span>
<span class="hljs-keyword">val</span> publicKey = privKey.publicKeyWithBouncyCastle
<span class="hljs-comment">// publicKey: ECPublicKey = ECPublicKey(022bfbaec7d607efcf54c4ee974e22f28c498408ff02426c133265b00e95fab944)</span>
<span class="hljs-comment">// publicKey: ECPublicKey = ECPublicKey(03cc7f6e654a2448933ab5455756688f3b593fd5b6b9cda99b9fc7364e480276bc)</span>
<span class="hljs-keyword">val</span> dataToSign = <span class="hljs-type">DoubleSha256Digest</span>.empty
<span class="hljs-comment">// dataToSign: DoubleSha256Digest = DoubleSha256Digest(0000000000000000000000000000000000000000000000000000000000000000)</span>
<span class="hljs-keyword">val</span> signature = privKey.signWithBouncyCastle(dataToSign.bytes)
<span class="hljs-comment">// signature: ECDigitalSignature = ECDigitalSignature(3045022100eb5a8576b5098aad25f3c45e0560cb15178df6445331229f186e1d53e09ca6fe0220344788c6c63304b77e17fea9e6c4bb0226239ffb64e6f4d78d5c32f6fb868f9a)</span>
<span class="hljs-comment">// signature: ECDigitalSignature = ECDigitalSignature(304402205d9f98822b650e5b276a61d26da4d5c2bece7a0c7059a1c12bb7a8c7018ffd70022012551313e30d54e840d963c2bcfb64fca4b39cf16a4e78fe47da3b60a0d21ad5)</span>
<span class="hljs-keyword">val</span> verified = publicKey.verifyWithBouncyCastle(dataToSign.bytes, signature)
<span class="hljs-comment">// verified: Boolean = true</span>

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

@ -114,12 +114,12 @@ println(<span class="hljs-string">s"Verified with NativeSecp256k1 again=<span cl
<pre><code class="hljs css language-scala"><span class="hljs-keyword">val</span> privKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey
<span class="hljs-comment">// privKey: ECPrivateKey = Masked(ECPrivateKeyImpl)</span>
<span class="hljs-keyword">val</span> publicKey = privKey.publicKeyWithBouncyCastle
<span class="hljs-comment">// publicKey: ECPublicKey = ECPublicKey(022bfbaec7d607efcf54c4ee974e22f28c498408ff02426c133265b00e95fab944)</span>
<span class="hljs-comment">// publicKey: ECPublicKey = ECPublicKey(03cc7f6e654a2448933ab5455756688f3b593fd5b6b9cda99b9fc7364e480276bc)</span>
<span class="hljs-keyword">val</span> dataToSign = <span class="hljs-type">DoubleSha256Digest</span>.empty
<span class="hljs-comment">// dataToSign: DoubleSha256Digest = DoubleSha256Digest(0000000000000000000000000000000000000000000000000000000000000000)</span>
<span class="hljs-keyword">val</span> signature = privKey.signWithBouncyCastle(dataToSign.bytes)
<span class="hljs-comment">// signature: ECDigitalSignature = ECDigitalSignature(3045022100eb5a8576b5098aad25f3c45e0560cb15178df6445331229f186e1d53e09ca6fe0220344788c6c63304b77e17fea9e6c4bb0226239ffb64e6f4d78d5c32f6fb868f9a)</span>
<span class="hljs-comment">// signature: ECDigitalSignature = ECDigitalSignature(304402205d9f98822b650e5b276a61d26da4d5c2bece7a0c7059a1c12bb7a8c7018ffd70022012551313e30d54e840d963c2bcfb64fca4b39cf16a4e78fe47da3b60a0d21ad5)</span>
<span class="hljs-keyword">val</span> verified = publicKey.verifyWithBouncyCastle(dataToSign.bytes, signature)
<span class="hljs-comment">// verified: Boolean = true</span>