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

Deploy website

Browse source 
Deploy website version based on 48189d5c1d
This commit is contained in:
Docusaurus bot 2022-02-08 00:08:04 +00:00
parent bb8ae31c3c
commit 79a62443a0
17 changed files with 107 additions and 107 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
api/org/bitcoins/docs/BuildInfo$.html
View file

File diff suppressed because one or more lines are too long

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

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

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

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

16
docs/next/core/dlc.html
View file

File diff suppressed because one or more lines are too long

16
docs/next/core/dlc/index.html
View file

File diff suppressed because one or more lines are too long

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

@ -86,13 +86,13 @@ use that to generate further private and public keys:</p>
<span class="hljs-comment">// how long our phrase ends up being</span> <span class="hljs-comment">// how long our phrase ends up being</span>
<span class="hljs-comment">// 256 bits of entropy results in 24 words</span> <span class="hljs-comment">// 256 bits of entropy results in 24 words</span>
<span class="hljs-keyword">val</span> entropy: <span class="hljs-type">BitVector</span> = <span class="hljs-type">MnemonicCode</span>.getEntropy256Bits <span class="hljs-keyword">val</span> entropy: <span class="hljs-type">BitVector</span> = <span class="hljs-type">MnemonicCode</span>.getEntropy256Bits
<span class="hljs-comment">// entropy: BitVector = BitVector(256 bits, 0xb2f112bbcea3b6a9a8e534dfc3ccfbfaf0fcf9e687442012177f48ae62e5e0d6)</span> <span class="hljs-comment">// entropy: BitVector = BitVector(256 bits, 0x583b3c996ed3a93b109c25503856c166d9c9f1999df097dff58d200ad5a5ad2e)</span>
<span class="hljs-keyword">val</span> mnemonicCode = <span class="hljs-type">MnemonicCode</span>.fromEntropy(entropy) <span class="hljs-keyword">val</span> mnemonicCode = <span class="hljs-type">MnemonicCode</span>.fromEntropy(entropy)
<span class="hljs-comment">// mnemonicCode: MnemonicCode = Masked(MnemonicCodeImpl)</span> <span class="hljs-comment">// mnemonicCode: MnemonicCode = Masked(MnemonicCodeImpl)</span>
mnemonicCode.words <span class="hljs-comment">// the phrase the user should write down</span> mnemonicCode.words <span class="hljs-comment">// the phrase the user should write down</span>
<span class="hljs-comment">// res0: Vector[String] = Vector(real, mass, puzzle, outer, derive, feel, phone, pledge, thank, bunker, discover, vote, average, language, old, trigger, cactus, mouse, thank, mule, tower, indicate, local, sing) // the phrase the user should write down</span> <span class="hljs-comment">// res0: Vector[String] = Vector(flag, supreme, chaos, tank, dentist, outside, draw, lucky, expand, section, raccoon, soap, orient, web, grid, safe, oak, zero, globe, divorce, pull, spot, regret, suspect) // the phrase the user should write down</span>
<span class="hljs-comment">// the password argument is an optional, extra security</span> <span class="hljs-comment">// the password argument is an optional, extra security</span>
<span class="hljs-comment">// measure. all MnemonicCode instances will give you a</span> <span class="hljs-comment">// measure. all MnemonicCode instances will give you a</span>
@ -108,7 +108,7 @@ mnemonicCode.words <span class="hljs-comment">// the phrase the user should writ
bip39Seed) bip39Seed)
<span class="hljs-comment">// xpriv: ExtPrivateKey = Masked(ExtPrivateKeyImpl)</span> <span class="hljs-comment">// xpriv: ExtPrivateKey = Masked(ExtPrivateKeyImpl)</span>
<span class="hljs-keyword">val</span> xpub = xpriv.extPublicKey <span class="hljs-keyword">val</span> xpub = xpriv.extPublicKey
<span class="hljs-comment">// xpub: ExtPublicKey = zpub6jftahH18ngZyWQVoPhRqesrNcj3mbvnceBc78SnVpUWJbTSPiDNXzSPAnUdCRG7GQJ1gYRuGgZ6Ywaa8yoKQiuAhLegDczthBT2eEys3ad</span> <span class="hljs-comment">// xpub: ExtPublicKey = zpub6jftahH18ngZxVMmnMqWxKiUJBTRXW2DEEyQy5SopQrZCfEy2FpXD7QDTrrgd1DBMc4BpRBWLKeVH9Dfb2ebE9yJDXgHpEqLV95wWpYiAir</span>
<span class="hljs-comment">// you can now use the generated xpriv to derive further</span> <span class="hljs-comment">// you can now use the generated xpriv to derive further</span>
<span class="hljs-comment">// private or public keys</span> <span class="hljs-comment">// private or public keys</span>
@ -154,7 +154,7 @@ spend or steal any of your money.</p>
<span class="hljs-comment">// can generate addresses with it!</span> <span class="hljs-comment">// can generate addresses with it!</span>
accountXpriv.extPublicKey accountXpriv.extPublicKey
} }
<span class="hljs-comment">// accountXpub: ExtPublicKey = zpub6s7MvWYShEeZXtGj9h9vLju4xUE6rZddEg5y2Cw4J61G2unRKfNKxgEcrgaouZ6oDUoptJkT7h8dTLdLERJnSW4MKTPC51rZWSBhR519wdN</span> <span class="hljs-comment">// accountXpub: ExtPublicKey = zpub6rNM3QF7GgzBajtsutbkWEVtMAUG8YjPJi6Vm9X75UyPwtt9pX6R4d5dkoKQBQwfwcUTu67jH27FR3EWw7vSLZJvx9LqzQ7TCi53yrYtXWF</span>
<span class="hljs-comment">// address no. 0 ---------------┐</span> <span class="hljs-comment">// address no. 0 ---------------┐</span>
<span class="hljs-comment">// external address ----------┐ |</span> <span class="hljs-comment">// external address ----------┐ |</span>
@ -177,12 +177,12 @@ spend or steal any of your money.</p>
<span class="hljs-keyword">val</span> scriptPubKey = <span class="hljs-type">P2WPKHWitnessSPKV0</span>(pubkey) <span class="hljs-keyword">val</span> scriptPubKey = <span class="hljs-type">P2WPKHWitnessSPKV0</span>(pubkey)
<span class="hljs-type">Bech32Address</span>(scriptPubKey, <span class="hljs-type">TestNet3</span>) <span class="hljs-type">Bech32Address</span>(scriptPubKey, <span class="hljs-type">TestNet3</span>)
} }
<span class="hljs-comment">// firstAccountAddress: Bech32Address = tb1q9eytl4z0fw8ww4antlseayksqa3h5ge6e4v57n</span> <span class="hljs-comment">// firstAccountAddress: Bech32Address = tb1q0ugu65gc4v6lglg3x04uhjnv69v7qhntrujurm</span>
<span class="hljs-comment">// tada! We just generated an address you can send money to,</span> <span class="hljs-comment">// tada! We just generated an address you can send money to,</span>
<span class="hljs-comment">// without having access to the private key!</span> <span class="hljs-comment">// without having access to the private key!</span>
firstAccountAddress.value firstAccountAddress.value
<span class="hljs-comment">// res2: String = tb1q9eytl4z0fw8ww4antlseayksqa3h5ge6e4v57n</span> <span class="hljs-comment">// res2: String = tb1q0ugu65gc4v6lglg3x04uhjnv69v7qhntrujurm</span>
<span class="hljs-comment">// you can now continue deriving addresses from the same public</span> <span class="hljs-comment">// you can now continue deriving addresses from the same public</span>
<span class="hljs-comment">// key, by imitating what we did above. To get the next</span> <span class="hljs-comment">// key, by imitating what we did above. To get the next</span>

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

@ -86,13 +86,13 @@ use that to generate further private and public keys:</p>
<span class="hljs-comment">// how long our phrase ends up being</span> <span class="hljs-comment">// how long our phrase ends up being</span>
<span class="hljs-comment">// 256 bits of entropy results in 24 words</span> <span class="hljs-comment">// 256 bits of entropy results in 24 words</span>
<span class="hljs-keyword">val</span> entropy: <span class="hljs-type">BitVector</span> = <span class="hljs-type">MnemonicCode</span>.getEntropy256Bits <span class="hljs-keyword">val</span> entropy: <span class="hljs-type">BitVector</span> = <span class="hljs-type">MnemonicCode</span>.getEntropy256Bits
<span class="hljs-comment">// entropy: BitVector = BitVector(256 bits, 0xb2f112bbcea3b6a9a8e534dfc3ccfbfaf0fcf9e687442012177f48ae62e5e0d6)</span> <span class="hljs-comment">// entropy: BitVector = BitVector(256 bits, 0x583b3c996ed3a93b109c25503856c166d9c9f1999df097dff58d200ad5a5ad2e)</span>
<span class="hljs-keyword">val</span> mnemonicCode = <span class="hljs-type">MnemonicCode</span>.fromEntropy(entropy) <span class="hljs-keyword">val</span> mnemonicCode = <span class="hljs-type">MnemonicCode</span>.fromEntropy(entropy)
<span class="hljs-comment">// mnemonicCode: MnemonicCode = Masked(MnemonicCodeImpl)</span> <span class="hljs-comment">// mnemonicCode: MnemonicCode = Masked(MnemonicCodeImpl)</span>
mnemonicCode.words <span class="hljs-comment">// the phrase the user should write down</span> mnemonicCode.words <span class="hljs-comment">// the phrase the user should write down</span>
<span class="hljs-comment">// res0: Vector[String] = Vector(real, mass, puzzle, outer, derive, feel, phone, pledge, thank, bunker, discover, vote, average, language, old, trigger, cactus, mouse, thank, mule, tower, indicate, local, sing) // the phrase the user should write down</span> <span class="hljs-comment">// res0: Vector[String] = Vector(flag, supreme, chaos, tank, dentist, outside, draw, lucky, expand, section, raccoon, soap, orient, web, grid, safe, oak, zero, globe, divorce, pull, spot, regret, suspect) // the phrase the user should write down</span>
<span class="hljs-comment">// the password argument is an optional, extra security</span> <span class="hljs-comment">// the password argument is an optional, extra security</span>
<span class="hljs-comment">// measure. all MnemonicCode instances will give you a</span> <span class="hljs-comment">// measure. all MnemonicCode instances will give you a</span>
@ -108,7 +108,7 @@ mnemonicCode.words <span class="hljs-comment">// the phrase the user should writ
bip39Seed) bip39Seed)
<span class="hljs-comment">// xpriv: ExtPrivateKey = Masked(ExtPrivateKeyImpl)</span> <span class="hljs-comment">// xpriv: ExtPrivateKey = Masked(ExtPrivateKeyImpl)</span>
<span class="hljs-keyword">val</span> xpub = xpriv.extPublicKey <span class="hljs-keyword">val</span> xpub = xpriv.extPublicKey
<span class="hljs-comment">// xpub: ExtPublicKey = zpub6jftahH18ngZyWQVoPhRqesrNcj3mbvnceBc78SnVpUWJbTSPiDNXzSPAnUdCRG7GQJ1gYRuGgZ6Ywaa8yoKQiuAhLegDczthBT2eEys3ad</span> <span class="hljs-comment">// xpub: ExtPublicKey = zpub6jftahH18ngZxVMmnMqWxKiUJBTRXW2DEEyQy5SopQrZCfEy2FpXD7QDTrrgd1DBMc4BpRBWLKeVH9Dfb2ebE9yJDXgHpEqLV95wWpYiAir</span>
<span class="hljs-comment">// you can now use the generated xpriv to derive further</span> <span class="hljs-comment">// you can now use the generated xpriv to derive further</span>
<span class="hljs-comment">// private or public keys</span> <span class="hljs-comment">// private or public keys</span>
@ -154,7 +154,7 @@ spend or steal any of your money.</p>
<span class="hljs-comment">// can generate addresses with it!</span> <span class="hljs-comment">// can generate addresses with it!</span>
accountXpriv.extPublicKey accountXpriv.extPublicKey
} }
<span class="hljs-comment">// accountXpub: ExtPublicKey = zpub6s7MvWYShEeZXtGj9h9vLju4xUE6rZddEg5y2Cw4J61G2unRKfNKxgEcrgaouZ6oDUoptJkT7h8dTLdLERJnSW4MKTPC51rZWSBhR519wdN</span> <span class="hljs-comment">// accountXpub: ExtPublicKey = zpub6rNM3QF7GgzBajtsutbkWEVtMAUG8YjPJi6Vm9X75UyPwtt9pX6R4d5dkoKQBQwfwcUTu67jH27FR3EWw7vSLZJvx9LqzQ7TCi53yrYtXWF</span>
<span class="hljs-comment">// address no. 0 ---------------┐</span> <span class="hljs-comment">// address no. 0 ---------------┐</span>
<span class="hljs-comment">// external address ----------┐ |</span> <span class="hljs-comment">// external address ----------┐ |</span>
@ -177,12 +177,12 @@ spend or steal any of your money.</p>
<span class="hljs-keyword">val</span> scriptPubKey = <span class="hljs-type">P2WPKHWitnessSPKV0</span>(pubkey) <span class="hljs-keyword">val</span> scriptPubKey = <span class="hljs-type">P2WPKHWitnessSPKV0</span>(pubkey)
<span class="hljs-type">Bech32Address</span>(scriptPubKey, <span class="hljs-type">TestNet3</span>) <span class="hljs-type">Bech32Address</span>(scriptPubKey, <span class="hljs-type">TestNet3</span>)
} }
<span class="hljs-comment">// firstAccountAddress: Bech32Address = tb1q9eytl4z0fw8ww4antlseayksqa3h5ge6e4v57n</span> <span class="hljs-comment">// firstAccountAddress: Bech32Address = tb1q0ugu65gc4v6lglg3x04uhjnv69v7qhntrujurm</span>
<span class="hljs-comment">// tada! We just generated an address you can send money to,</span> <span class="hljs-comment">// tada! We just generated an address you can send money to,</span>
<span class="hljs-comment">// without having access to the private key!</span> <span class="hljs-comment">// without having access to the private key!</span>
firstAccountAddress.value firstAccountAddress.value
<span class="hljs-comment">// res2: String = tb1q9eytl4z0fw8ww4antlseayksqa3h5ge6e4v57n</span> <span class="hljs-comment">// res2: String = tb1q0ugu65gc4v6lglg3x04uhjnv69v7qhntrujurm</span>
<span class="hljs-comment">// you can now continue deriving addresses from the same public</span> <span class="hljs-comment">// you can now continue deriving addresses from the same public</span>
<span class="hljs-comment">// key, by imitating what we did above. To get the next</span> <span class="hljs-comment">// key, by imitating what we did above. To get the next</span>

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

@ -64,7 +64,7 @@
}); });
</script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/bitcoin-s/bitcoin-s/blob/master/docs/core/txbuilder.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">TxBuilder Example</h1></header><article><div><span><p>Bitcoin-S features a transaction building API that allows you to construct and sign Bitcoin transactions. Here's an example of how to use it</p> </script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/bitcoin-s/bitcoin-s/blob/master/docs/core/txbuilder.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">TxBuilder Example</h1></header><article><div><span><p>Bitcoin-S features a transaction building API that allows you to construct and sign Bitcoin transactions. Here's an example of how to use it</p>
<pre><code class="hljs css language-scala"><span class="hljs-keyword">implicit</span> <span class="hljs-keyword">val</span> ec: <span class="hljs-type">ExecutionContext</span> = <span class="hljs-type">ExecutionContext</span>.<span class="hljs-type">Implicits</span>.global <pre><code class="hljs css language-scala"><span class="hljs-keyword">implicit</span> <span class="hljs-keyword">val</span> ec: <span class="hljs-type">ExecutionContext</span> = <span class="hljs-type">ExecutionContext</span>.<span class="hljs-type">Implicits</span>.global
<span class="hljs-comment">// ec: ExecutionContext = scala.concurrent.impl.ExecutionContextImpl$$anon$3@2d8f83ad[Running, parallelism = 2, size = 0, active = 0, running = 0, steals = 0, tasks = 0, submissions = 0]</span> <span class="hljs-comment">// ec: ExecutionContext = scala.concurrent.impl.ExecutionContextImpl$$anon$3@636a6413[Running, parallelism = 2, size = 0, active = 0, running = 0, steals = 0, tasks = 0, submissions = 0]</span>
<span class="hljs-comment">// Initialize a transaction builder</span> <span class="hljs-comment">// Initialize a transaction builder</span>
<span class="hljs-keyword">val</span> builder = <span class="hljs-type">RawTxBuilder</span>() <span class="hljs-keyword">val</span> builder = <span class="hljs-type">RawTxBuilder</span>()
@ -74,19 +74,19 @@
<span class="hljs-keyword">val</span> privKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey <span class="hljs-keyword">val</span> privKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey
<span class="hljs-comment">// privKey: ECPrivateKey = Masked(ECPrivateKey)</span> <span class="hljs-comment">// privKey: ECPrivateKey = Masked(ECPrivateKey)</span>
<span class="hljs-keyword">val</span> pubKey = privKey.publicKey <span class="hljs-keyword">val</span> pubKey = privKey.publicKey
<span class="hljs-comment">// pubKey: ECPublicKey = ECPublicKey(025bbea51ecc766f533b604bf06ddf87c8348f133479f505184c1b2de60502c928)</span> <span class="hljs-comment">// pubKey: ECPublicKey = ECPublicKey(0205b9f1697bd23c32751a8a18e9f4e3d05a685a39974efa80e2fefb560f889809)</span>
<span class="hljs-comment">// this is the script that the TxBuilder is going to create a</span> <span class="hljs-comment">// this is the script that the TxBuilder is going to create a</span>
<span class="hljs-comment">// script signature that validly spends this scriptPubKey</span> <span class="hljs-comment">// script signature that validly spends this scriptPubKey</span>
<span class="hljs-keyword">val</span> creditingSpk = <span class="hljs-type">P2PKHScriptPubKey</span>(pubKey = privKey.publicKey) <span class="hljs-keyword">val</span> creditingSpk = <span class="hljs-type">P2PKHScriptPubKey</span>(pubKey = privKey.publicKey)
<span class="hljs-comment">// creditingSpk: P2PKHScriptPubKey = pkh(66697c1a3cc79e0cd78209a3c97702ade9da3100)</span> <span class="hljs-comment">// creditingSpk: P2PKHScriptPubKey = pkh(058dc9b6fd71234ddef037b12ce3622594ade037)</span>
<span class="hljs-keyword">val</span> amount = <span class="hljs-number">10000.</span>satoshis <span class="hljs-keyword">val</span> amount = <span class="hljs-number">10000.</span>satoshis
<span class="hljs-comment">// amount: Satoshis = 10000 sats</span> <span class="hljs-comment">// amount: Satoshis = 10000 sats</span>
<span class="hljs-comment">// this is the UTXO we are going to be spending</span> <span class="hljs-comment">// this is the UTXO we are going to be spending</span>
<span class="hljs-keyword">val</span> utxo = <span class="hljs-keyword">val</span> utxo =
<span class="hljs-type">TransactionOutput</span>(value = amount, scriptPubKey = creditingSpk) <span class="hljs-type">TransactionOutput</span>(value = amount, scriptPubKey = creditingSpk)
<span class="hljs-comment">// utxo: TransactionOutput = TransactionOutput(10000 sats,pkh(66697c1a3cc79e0cd78209a3c97702ade9da3100))</span> <span class="hljs-comment">// utxo: TransactionOutput = TransactionOutput(10000 sats,pkh(058dc9b6fd71234ddef037b12ce3622594ade037))</span>
<span class="hljs-comment">// the private key that locks the funds for the script we are spending too</span> <span class="hljs-comment">// the private key that locks the funds for the script we are spending too</span>
<span class="hljs-keyword">val</span> destinationPrivKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey <span class="hljs-keyword">val</span> destinationPrivKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey
@ -99,7 +99,7 @@
<span class="hljs-comment">// the script that corresponds to destination private key, this is what is receiving the money</span> <span class="hljs-comment">// the script that corresponds to destination private key, this is what is receiving the money</span>
<span class="hljs-keyword">val</span> destinationSPK = <span class="hljs-keyword">val</span> destinationSPK =
<span class="hljs-type">P2PKHScriptPubKey</span>(pubKey = destinationPrivKey.publicKey) <span class="hljs-type">P2PKHScriptPubKey</span>(pubKey = destinationPrivKey.publicKey)
<span class="hljs-comment">// destinationSPK: P2PKHScriptPubKey = pkh(d9fab7bcaa5a92287a64cbca9dd03a05da992965)</span> <span class="hljs-comment">// destinationSPK: P2PKHScriptPubKey = pkh(930ad3c01af4b0d79733456b15e21560ebde4eb4)</span>
<span class="hljs-comment">// this is where we are sending money too</span> <span class="hljs-comment">// this is where we are sending money too</span>
<span class="hljs-comment">// we could add more destinations here if we</span> <span class="hljs-comment">// we could add more destinations here if we</span>
@ -110,7 +110,7 @@
<span class="hljs-type">Vector</span>(destination0) <span class="hljs-type">Vector</span>(destination0)
} }
<span class="hljs-comment">// destinations: Vector[TransactionOutput] = Vector(TransactionOutput(5000 sats,pkh(d9fab7bcaa5a92287a64cbca9dd03a05da992965)))</span> <span class="hljs-comment">// destinations: Vector[TransactionOutput] = Vector(TransactionOutput(5000 sats,pkh(930ad3c01af4b0d79733456b15e21560ebde4eb4)))</span>
<span class="hljs-comment">// Add the destinations to the tx builder</span> <span class="hljs-comment">// Add the destinations to the tx builder</span>
builder ++= destinations builder ++= destinations
@ -123,17 +123,17 @@ builder ++= destinations
inputs = <span class="hljs-type">Vector</span>.empty, inputs = <span class="hljs-type">Vector</span>.empty,
outputs = <span class="hljs-type">Vector</span>(utxo), outputs = <span class="hljs-type">Vector</span>(utxo),
lockTime = <span class="hljs-type">UInt32</span>.zero) lockTime = <span class="hljs-type">UInt32</span>.zero)
<span class="hljs-comment">// creditingTx: BaseTransaction = BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(66697c1a3cc79e0cd78209a3c97702ade9da3100))),UInt32Impl(0))</span> <span class="hljs-comment">// creditingTx: BaseTransaction = BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(058dc9b6fd71234ddef037b12ce3622594ade037))),UInt32Impl(0))</span>
<span class="hljs-comment">// this is the information we need from the crediting TX</span> <span class="hljs-comment">// this is the information we need from the crediting TX</span>
<span class="hljs-comment">// to properly "link" it in the transaction we are creating</span> <span class="hljs-comment">// to properly "link" it in the transaction we are creating</span>
<span class="hljs-keyword">val</span> outPoint = <span class="hljs-type">TransactionOutPoint</span>(creditingTx.txId, <span class="hljs-type">UInt32</span>.zero) <span class="hljs-keyword">val</span> outPoint = <span class="hljs-type">TransactionOutPoint</span>(creditingTx.txId, <span class="hljs-type">UInt32</span>.zero)
<span class="hljs-comment">// outPoint: TransactionOutPoint = TransactionOutPoint(a40cd0266f9694e927ce917948347fcedc81457f6d4d12497a6146de60bf35d2:0)</span> <span class="hljs-comment">// outPoint: TransactionOutPoint = TransactionOutPoint(3df4441d8d5e424e972d7b291521c011c904b31cb100115622b981be3e9e7fae:0)</span>
<span class="hljs-keyword">val</span> input = <span class="hljs-type">TransactionInput</span>( <span class="hljs-keyword">val</span> input = <span class="hljs-type">TransactionInput</span>(
outPoint, outPoint,
<span class="hljs-type">EmptyScriptSignature</span>, <span class="hljs-type">EmptyScriptSignature</span>,
sequenceNumber = <span class="hljs-type">UInt32</span>.zero) sequenceNumber = <span class="hljs-type">UInt32</span>.zero)
<span class="hljs-comment">// input: TransactionInput = TransactionInputImpl(TransactionOutPoint(a40cd0266f9694e927ce917948347fcedc81457f6d4d12497a6146de60bf35d2:0),EmptyScriptSignature,UInt32Impl(0))</span> <span class="hljs-comment">// input: TransactionInput = TransactionInputImpl(TransactionOutPoint(3df4441d8d5e424e972d7b291521c011c904b31cb100115622b981be3e9e7fae:0),EmptyScriptSignature,UInt32Impl(0))</span>
<span class="hljs-comment">// Add a new input to our builder</span> <span class="hljs-comment">// Add a new input to our builder</span>
builder += input builder += input
@ -141,11 +141,11 @@ builder += input
<span class="hljs-comment">// We can now generate a RawTxBuilderResult ready to be finalized</span> <span class="hljs-comment">// We can now generate a RawTxBuilderResult ready to be finalized</span>
<span class="hljs-keyword">val</span> builderResult = builder.result() <span class="hljs-keyword">val</span> builderResult = builder.result()
<span class="hljs-comment">// builderResult: RawTxBuilderResult = RawTxBuilderResult(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(a40cd0266f9694e927ce917948347fcedc81457f6d4d12497a6146de60bf35d2:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(d9fab7bcaa5a92287a64cbca9dd03a05da992965))),UInt32Impl(0))</span> <span class="hljs-comment">// builderResult: RawTxBuilderResult = RawTxBuilderResult(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(3df4441d8d5e424e972d7b291521c011c904b31cb100115622b981be3e9e7fae:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(930ad3c01af4b0d79733456b15e21560ebde4eb4))),UInt32Impl(0))</span>
<span class="hljs-comment">// this contains the information needed to analyze our input during finalization</span> <span class="hljs-comment">// this contains the information needed to analyze our input during finalization</span>
<span class="hljs-keyword">val</span> inputInfo = <span class="hljs-type">P2PKHInputInfo</span>(outPoint, amount, privKey.publicKey) <span class="hljs-keyword">val</span> inputInfo = <span class="hljs-type">P2PKHInputInfo</span>(outPoint, amount, privKey.publicKey)
<span class="hljs-comment">// inputInfo: P2PKHInputInfo = P2PKHInputInfo(TransactionOutPoint(a40cd0266f9694e927ce917948347fcedc81457f6d4d12497a6146de60bf35d2:0),10000 sats,ECPublicKey(025bbea51ecc766f533b604bf06ddf87c8348f133479f505184c1b2de60502c928))</span> <span class="hljs-comment">// inputInfo: P2PKHInputInfo = P2PKHInputInfo(TransactionOutPoint(3df4441d8d5e424e972d7b291521c011c904b31cb100115622b981be3e9e7fae:0),10000 sats,ECPublicKey(0205b9f1697bd23c32751a8a18e9f4e3d05a685a39974efa80e2fefb560f889809))</span>
<span class="hljs-comment">// this is how much we are going to pay as a fee to the network</span> <span class="hljs-comment">// this is how much we are going to pay as a fee to the network</span>
<span class="hljs-comment">// for this example, we are going to pay 1 satoshi per byte</span> <span class="hljs-comment">// for this example, we are going to pay 1 satoshi per byte</span>
@ -155,18 +155,18 @@ builder += input
<span class="hljs-keyword">val</span> changePrivKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey <span class="hljs-keyword">val</span> changePrivKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey
<span class="hljs-comment">// changePrivKey: ECPrivateKey = Masked(ECPrivateKey)</span> <span class="hljs-comment">// changePrivKey: ECPrivateKey = Masked(ECPrivateKey)</span>
<span class="hljs-keyword">val</span> changeSPK = <span class="hljs-type">P2PKHScriptPubKey</span>(pubKey = changePrivKey.publicKey) <span class="hljs-keyword">val</span> changeSPK = <span class="hljs-type">P2PKHScriptPubKey</span>(pubKey = changePrivKey.publicKey)
<span class="hljs-comment">// changeSPK: P2PKHScriptPubKey = pkh(af4df018f8b8929275ca72998bcb1854072c975d)</span> <span class="hljs-comment">// changeSPK: P2PKHScriptPubKey = pkh(a66ee68b7c84a2e43723993d1b521f22a6009a31)</span>
<span class="hljs-comment">// We chose a finalizer that adds a change output to our tx based on a fee rate</span> <span class="hljs-comment">// We chose a finalizer that adds a change output to our tx based on a fee rate</span>
<span class="hljs-keyword">val</span> finalizer = <span class="hljs-type">StandardNonInteractiveFinalizer</span>( <span class="hljs-keyword">val</span> finalizer = <span class="hljs-type">StandardNonInteractiveFinalizer</span>(
<span class="hljs-type">Vector</span>(inputInfo), <span class="hljs-type">Vector</span>(inputInfo),
feeRate, feeRate,
changeSPK) changeSPK)
<span class="hljs-comment">// finalizer: StandardNonInteractiveFinalizer = StandardNonInteractiveFinalizer(Vector(P2PKHInputInfo(TransactionOutPoint(a40cd0266f9694e927ce917948347fcedc81457f6d4d12497a6146de60bf35d2:0),10000 sats,ECPublicKey(025bbea51ecc766f533b604bf06ddf87c8348f133479f505184c1b2de60502c928))),1 sats/byte,pkh(af4df018f8b8929275ca72998bcb1854072c975d))</span> <span class="hljs-comment">// finalizer: StandardNonInteractiveFinalizer = StandardNonInteractiveFinalizer(Vector(P2PKHInputInfo(TransactionOutPoint(3df4441d8d5e424e972d7b291521c011c904b31cb100115622b981be3e9e7fae:0),10000 sats,ECPublicKey(0205b9f1697bd23c32751a8a18e9f4e3d05a685a39974efa80e2fefb560f889809))),1 sats/byte,pkh(a66ee68b7c84a2e43723993d1b521f22a6009a31))</span>
<span class="hljs-comment">// We can now finalize the tx builder result from earlier with this finalizer</span> <span class="hljs-comment">// We can now finalize the tx builder result from earlier with this finalizer</span>
<span class="hljs-keyword">val</span> unsignedTx: <span class="hljs-type">Transaction</span> = finalizer.buildTx(builderResult) <span class="hljs-keyword">val</span> unsignedTx: <span class="hljs-type">Transaction</span> = finalizer.buildTx(builderResult)
<span class="hljs-comment">// unsignedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(a40cd0266f9694e927ce917948347fcedc81457f6d4d12497a6146de60bf35d2:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(d9fab7bcaa5a92287a64cbca9dd03a05da992965)), TransactionOutput(4775 sats,pkh(af4df018f8b8929275ca72998bcb1854072c975d))),UInt32Impl(0))</span> <span class="hljs-comment">// unsignedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(3df4441d8d5e424e972d7b291521c011c904b31cb100115622b981be3e9e7fae:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(930ad3c01af4b0d79733456b15e21560ebde4eb4)), TransactionOutput(4775 sats,pkh(a66ee68b7c84a2e43723993d1b521f22a6009a31))),UInt32Impl(0))</span>
<span class="hljs-comment">// We now turn to signing the unsigned transaction</span> <span class="hljs-comment">// We now turn to signing the unsigned transaction</span>
<span class="hljs-comment">// this contains all the information we need to</span> <span class="hljs-comment">// this contains all the information we need to</span>
@ -176,12 +176,12 @@ builder += input
signers = <span class="hljs-type">Vector</span>(privKey), signers = <span class="hljs-type">Vector</span>(privKey),
hashType = hashType =
<span class="hljs-type">HashType</span>.sigHashAll) <span class="hljs-type">HashType</span>.sigHashAll)
<span class="hljs-comment">// utxoInfo: ScriptSignatureParams[P2PKHInputInfo] = ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(a40cd0266f9694e927ce917948347fcedc81457f6d4d12497a6146de60bf35d2:0),10000 sats,ECPublicKey(025bbea51ecc766f533b604bf06ddf87c8348f133479f505184c1b2de60502c928)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(66697c1a3cc79e0cd78209a3c97702ade9da3100))),UInt32Impl(0)),Vector(Masked(ECPrivateKey)),SIGHASH_ALL(Int32Impl(1)))</span> <span class="hljs-comment">// utxoInfo: ScriptSignatureParams[P2PKHInputInfo] = ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(3df4441d8d5e424e972d7b291521c011c904b31cb100115622b981be3e9e7fae:0),10000 sats,ECPublicKey(0205b9f1697bd23c32751a8a18e9f4e3d05a685a39974efa80e2fefb560f889809)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(058dc9b6fd71234ddef037b12ce3622594ade037))),UInt32Impl(0)),Vector(Masked(ECPrivateKey)),SIGHASH_ALL(Int32Impl(1)))</span>
<span class="hljs-comment">// all of the UTXO spending information, since we only have</span> <span class="hljs-comment">// all of the UTXO spending information, since we only have</span>
<span class="hljs-comment">// one input, this is just one element</span> <span class="hljs-comment">// one input, this is just one element</span>
<span class="hljs-keyword">val</span> utxoInfos: <span class="hljs-type">Vector</span>[<span class="hljs-type">ScriptSignatureParams</span>[<span class="hljs-type">InputInfo</span>]] = <span class="hljs-type">Vector</span>(utxoInfo) <span class="hljs-keyword">val</span> utxoInfos: <span class="hljs-type">Vector</span>[<span class="hljs-type">ScriptSignatureParams</span>[<span class="hljs-type">InputInfo</span>]] = <span class="hljs-type">Vector</span>(utxoInfo)
<span class="hljs-comment">// utxoInfos: Vector[ScriptSignatureParams[InputInfo]] = Vector(ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(a40cd0266f9694e927ce917948347fcedc81457f6d4d12497a6146de60bf35d2:0),10000 sats,ECPublicKey(025bbea51ecc766f533b604bf06ddf87c8348f133479f505184c1b2de60502c928)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(66697c1a3cc79e0cd78209a3c97702ade9da3100))),UInt32Impl(0)),Vector(Masked(ECPrivateKey)),SIGHASH_ALL(Int32Impl(1))))</span> <span class="hljs-comment">// utxoInfos: Vector[ScriptSignatureParams[InputInfo]] = Vector(ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(3df4441d8d5e424e972d7b291521c011c904b31cb100115622b981be3e9e7fae:0),10000 sats,ECPublicKey(0205b9f1697bd23c32751a8a18e9f4e3d05a685a39974efa80e2fefb560f889809)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(058dc9b6fd71234ddef037b12ce3622594ade037))),UInt32Impl(0)),Vector(Masked(ECPrivateKey)),SIGHASH_ALL(Int32Impl(1))))</span>
<span class="hljs-comment">// Yay! Now we use the RawTxSigner object to sign the tx.</span> <span class="hljs-comment">// Yay! Now we use the RawTxSigner object to sign the tx.</span>
<span class="hljs-comment">// The 'sign' method is going produce a validly signed transaction</span> <span class="hljs-comment">// The 'sign' method is going produce a validly signed transaction</span>
@ -197,7 +197,7 @@ builder += input
utxoInfos = utxoInfos, utxoInfos = utxoInfos,
expectedFeeRate = feeRate expectedFeeRate = feeRate
) )
<span class="hljs-comment">// signedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(a40cd0266f9694e927ce917948347fcedc81457f6d4d12497a6146de60bf35d2:0),P2PKHScriptSignature(ECPublicKeyBytes(ByteVector(33 bytes, 0x025bbea51ecc766f533b604bf06ddf87c8348f133479f505184c1b2de60502c928)), ECDigitalSignature(3044022016287edee5c91ad498ed56e7efa49f1ae4557a27d95c1014bf64265b627e0b54022050795e3b4ad5ad6917b4b93ba96b5a76df7c383e031f6911c2c3bc89547be16b01)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(d9fab7bcaa5a92287a64cbca9dd03a05da992965)), TransactionOutput(4775 sats,pkh(af4df018f8b8929275ca72998bcb1854072c975d))),UInt32Impl(0))</span> <span class="hljs-comment">// signedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(3df4441d8d5e424e972d7b291521c011c904b31cb100115622b981be3e9e7fae:0),P2PKHScriptSignature(ECPublicKeyBytes(ByteVector(33 bytes, 0x0205b9f1697bd23c32751a8a18e9f4e3d05a685a39974efa80e2fefb560f889809)), ECDigitalSignature(304402205a497179c4393edee866d1eac5a4e97c96ee03f5b679875f02ea4f02099a1fb202206de3e0edccb53be7749a54a32f147485d6f69220c03cb0fc36e949701eeb6dbc01)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(930ad3c01af4b0d79733456b15e21560ebde4eb4)), TransactionOutput(4775 sats,pkh(a66ee68b7c84a2e43723993d1b521f22a6009a31))),UInt32Impl(0))</span>
</code></pre> </code></pre>
<pre><code class="hljs css language-scala">signedTx.inputs.length <pre><code class="hljs css language-scala">signedTx.inputs.length
<span class="hljs-comment">// res2: Int = 1</span> <span class="hljs-comment">// res2: Int = 1</span>
@ -207,7 +207,7 @@ signedTx.outputs.length
<span class="hljs-comment">//remember, you can call .hex on any bitcoin-s data structure to get the hex representation!</span> <span class="hljs-comment">//remember, you can call .hex on any bitcoin-s data structure to get the hex representation!</span>
signedTx.hex signedTx.hex
<span class="hljs-comment">// res4: String = 0200000001d235bf60de46617a49124d6d7f4581dcce7f34487991ce27e994966f26d00ca4000000006a473044022016287edee5c91ad498ed56e7efa49f1ae4557a27d95c1014bf64265b627e0b54022050795e3b4ad5ad6917b4b93ba96b5a76df7c383e031f6911c2c3bc89547be16b0121025bbea51ecc766f533b604bf06ddf87c8348f133479f505184c1b2de60502c928000000000288130000000000001976a914d9fab7bcaa5a92287a64cbca9dd03a05da99296588aca7120000000000001976a914af4df018f8b8929275ca72998bcb1854072c975d88ac00000000</span> <span class="hljs-comment">// res4: String = 0200000001ae7f9e3ebe81b922561100b11cb304c911c02115297b2d974e425e8d1d44f43d000000006a47304402205a497179c4393edee866d1eac5a4e97c96ee03f5b679875f02ea4f02099a1fb202206de3e0edccb53be7749a54a32f147485d6f69220c03cb0fc36e949701eeb6dbc01210205b9f1697bd23c32751a8a18e9f4e3d05a685a39974efa80e2fefb560f889809000000000288130000000000001976a914930ad3c01af4b0d79733456b15e21560ebde4eb488aca7120000000000001976a914a66ee68b7c84a2e43723993d1b521f22a6009a3188ac00000000</span>
</code></pre> </code></pre>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/next/core/dlc"><span class="arrow-prev">← </span><span>Discreet Log Contract Data Structures</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 © 2022 Suredbits &amp; the bitcoin-s developers</section></footer></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script><script> </span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/next/core/dlc"><span class="arrow-prev">← </span><span>Discreet Log Contract Data Structures</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 © 2022 Suredbits &amp; the bitcoin-s developers</section></footer></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script><script>
document.addEventListener('keyup', function(e) { document.addEventListener('keyup', function(e) {

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

@ -64,7 +64,7 @@
}); });
</script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/bitcoin-s/bitcoin-s/blob/master/docs/core/txbuilder.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">TxBuilder Example</h1></header><article><div><span><p>Bitcoin-S features a transaction building API that allows you to construct and sign Bitcoin transactions. Here's an example of how to use it</p> </script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/bitcoin-s/bitcoin-s/blob/master/docs/core/txbuilder.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">TxBuilder Example</h1></header><article><div><span><p>Bitcoin-S features a transaction building API that allows you to construct and sign Bitcoin transactions. Here's an example of how to use it</p>
<pre><code class="hljs css language-scala"><span class="hljs-keyword">implicit</span> <span class="hljs-keyword">val</span> ec: <span class="hljs-type">ExecutionContext</span> = <span class="hljs-type">ExecutionContext</span>.<span class="hljs-type">Implicits</span>.global <pre><code class="hljs css language-scala"><span class="hljs-keyword">implicit</span> <span class="hljs-keyword">val</span> ec: <span class="hljs-type">ExecutionContext</span> = <span class="hljs-type">ExecutionContext</span>.<span class="hljs-type">Implicits</span>.global
<span class="hljs-comment">// ec: ExecutionContext = scala.concurrent.impl.ExecutionContextImpl$$anon$3@2d8f83ad[Running, parallelism = 2, size = 0, active = 0, running = 0, steals = 0, tasks = 0, submissions = 0]</span> <span class="hljs-comment">// ec: ExecutionContext = scala.concurrent.impl.ExecutionContextImpl$$anon$3@636a6413[Running, parallelism = 2, size = 0, active = 0, running = 0, steals = 0, tasks = 0, submissions = 0]</span>
<span class="hljs-comment">// Initialize a transaction builder</span> <span class="hljs-comment">// Initialize a transaction builder</span>
<span class="hljs-keyword">val</span> builder = <span class="hljs-type">RawTxBuilder</span>() <span class="hljs-keyword">val</span> builder = <span class="hljs-type">RawTxBuilder</span>()
@ -74,19 +74,19 @@
<span class="hljs-keyword">val</span> privKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey <span class="hljs-keyword">val</span> privKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey
<span class="hljs-comment">// privKey: ECPrivateKey = Masked(ECPrivateKey)</span> <span class="hljs-comment">// privKey: ECPrivateKey = Masked(ECPrivateKey)</span>
<span class="hljs-keyword">val</span> pubKey = privKey.publicKey <span class="hljs-keyword">val</span> pubKey = privKey.publicKey
<span class="hljs-comment">// pubKey: ECPublicKey = ECPublicKey(025bbea51ecc766f533b604bf06ddf87c8348f133479f505184c1b2de60502c928)</span> <span class="hljs-comment">// pubKey: ECPublicKey = ECPublicKey(0205b9f1697bd23c32751a8a18e9f4e3d05a685a39974efa80e2fefb560f889809)</span>
<span class="hljs-comment">// this is the script that the TxBuilder is going to create a</span> <span class="hljs-comment">// this is the script that the TxBuilder is going to create a</span>
<span class="hljs-comment">// script signature that validly spends this scriptPubKey</span> <span class="hljs-comment">// script signature that validly spends this scriptPubKey</span>
<span class="hljs-keyword">val</span> creditingSpk = <span class="hljs-type">P2PKHScriptPubKey</span>(pubKey = privKey.publicKey) <span class="hljs-keyword">val</span> creditingSpk = <span class="hljs-type">P2PKHScriptPubKey</span>(pubKey = privKey.publicKey)
<span class="hljs-comment">// creditingSpk: P2PKHScriptPubKey = pkh(66697c1a3cc79e0cd78209a3c97702ade9da3100)</span> <span class="hljs-comment">// creditingSpk: P2PKHScriptPubKey = pkh(058dc9b6fd71234ddef037b12ce3622594ade037)</span>
<span class="hljs-keyword">val</span> amount = <span class="hljs-number">10000.</span>satoshis <span class="hljs-keyword">val</span> amount = <span class="hljs-number">10000.</span>satoshis
<span class="hljs-comment">// amount: Satoshis = 10000 sats</span> <span class="hljs-comment">// amount: Satoshis = 10000 sats</span>
<span class="hljs-comment">// this is the UTXO we are going to be spending</span> <span class="hljs-comment">// this is the UTXO we are going to be spending</span>
<span class="hljs-keyword">val</span> utxo = <span class="hljs-keyword">val</span> utxo =
<span class="hljs-type">TransactionOutput</span>(value = amount, scriptPubKey = creditingSpk) <span class="hljs-type">TransactionOutput</span>(value = amount, scriptPubKey = creditingSpk)
<span class="hljs-comment">// utxo: TransactionOutput = TransactionOutput(10000 sats,pkh(66697c1a3cc79e0cd78209a3c97702ade9da3100))</span> <span class="hljs-comment">// utxo: TransactionOutput = TransactionOutput(10000 sats,pkh(058dc9b6fd71234ddef037b12ce3622594ade037))</span>
<span class="hljs-comment">// the private key that locks the funds for the script we are spending too</span> <span class="hljs-comment">// the private key that locks the funds for the script we are spending too</span>
<span class="hljs-keyword">val</span> destinationPrivKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey <span class="hljs-keyword">val</span> destinationPrivKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey
@ -99,7 +99,7 @@
<span class="hljs-comment">// the script that corresponds to destination private key, this is what is receiving the money</span> <span class="hljs-comment">// the script that corresponds to destination private key, this is what is receiving the money</span>
<span class="hljs-keyword">val</span> destinationSPK = <span class="hljs-keyword">val</span> destinationSPK =
<span class="hljs-type">P2PKHScriptPubKey</span>(pubKey = destinationPrivKey.publicKey) <span class="hljs-type">P2PKHScriptPubKey</span>(pubKey = destinationPrivKey.publicKey)
<span class="hljs-comment">// destinationSPK: P2PKHScriptPubKey = pkh(d9fab7bcaa5a92287a64cbca9dd03a05da992965)</span> <span class="hljs-comment">// destinationSPK: P2PKHScriptPubKey = pkh(930ad3c01af4b0d79733456b15e21560ebde4eb4)</span>
<span class="hljs-comment">// this is where we are sending money too</span> <span class="hljs-comment">// this is where we are sending money too</span>
<span class="hljs-comment">// we could add more destinations here if we</span> <span class="hljs-comment">// we could add more destinations here if we</span>
@ -110,7 +110,7 @@
<span class="hljs-type">Vector</span>(destination0) <span class="hljs-type">Vector</span>(destination0)
} }
<span class="hljs-comment">// destinations: Vector[TransactionOutput] = Vector(TransactionOutput(5000 sats,pkh(d9fab7bcaa5a92287a64cbca9dd03a05da992965)))</span> <span class="hljs-comment">// destinations: Vector[TransactionOutput] = Vector(TransactionOutput(5000 sats,pkh(930ad3c01af4b0d79733456b15e21560ebde4eb4)))</span>
<span class="hljs-comment">// Add the destinations to the tx builder</span> <span class="hljs-comment">// Add the destinations to the tx builder</span>
builder ++= destinations builder ++= destinations
@ -123,17 +123,17 @@ builder ++= destinations
inputs = <span class="hljs-type">Vector</span>.empty, inputs = <span class="hljs-type">Vector</span>.empty,
outputs = <span class="hljs-type">Vector</span>(utxo), outputs = <span class="hljs-type">Vector</span>(utxo),
lockTime = <span class="hljs-type">UInt32</span>.zero) lockTime = <span class="hljs-type">UInt32</span>.zero)
<span class="hljs-comment">// creditingTx: BaseTransaction = BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(66697c1a3cc79e0cd78209a3c97702ade9da3100))),UInt32Impl(0))</span> <span class="hljs-comment">// creditingTx: BaseTransaction = BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(058dc9b6fd71234ddef037b12ce3622594ade037))),UInt32Impl(0))</span>
<span class="hljs-comment">// this is the information we need from the crediting TX</span> <span class="hljs-comment">// this is the information we need from the crediting TX</span>
<span class="hljs-comment">// to properly "link" it in the transaction we are creating</span> <span class="hljs-comment">// to properly "link" it in the transaction we are creating</span>
<span class="hljs-keyword">val</span> outPoint = <span class="hljs-type">TransactionOutPoint</span>(creditingTx.txId, <span class="hljs-type">UInt32</span>.zero) <span class="hljs-keyword">val</span> outPoint = <span class="hljs-type">TransactionOutPoint</span>(creditingTx.txId, <span class="hljs-type">UInt32</span>.zero)
<span class="hljs-comment">// outPoint: TransactionOutPoint = TransactionOutPoint(a40cd0266f9694e927ce917948347fcedc81457f6d4d12497a6146de60bf35d2:0)</span> <span class="hljs-comment">// outPoint: TransactionOutPoint = TransactionOutPoint(3df4441d8d5e424e972d7b291521c011c904b31cb100115622b981be3e9e7fae:0)</span>
<span class="hljs-keyword">val</span> input = <span class="hljs-type">TransactionInput</span>( <span class="hljs-keyword">val</span> input = <span class="hljs-type">TransactionInput</span>(
outPoint, outPoint,
<span class="hljs-type">EmptyScriptSignature</span>, <span class="hljs-type">EmptyScriptSignature</span>,
sequenceNumber = <span class="hljs-type">UInt32</span>.zero) sequenceNumber = <span class="hljs-type">UInt32</span>.zero)
<span class="hljs-comment">// input: TransactionInput = TransactionInputImpl(TransactionOutPoint(a40cd0266f9694e927ce917948347fcedc81457f6d4d12497a6146de60bf35d2:0),EmptyScriptSignature,UInt32Impl(0))</span> <span class="hljs-comment">// input: TransactionInput = TransactionInputImpl(TransactionOutPoint(3df4441d8d5e424e972d7b291521c011c904b31cb100115622b981be3e9e7fae:0),EmptyScriptSignature,UInt32Impl(0))</span>
<span class="hljs-comment">// Add a new input to our builder</span> <span class="hljs-comment">// Add a new input to our builder</span>
builder += input builder += input
@ -141,11 +141,11 @@ builder += input
<span class="hljs-comment">// We can now generate a RawTxBuilderResult ready to be finalized</span> <span class="hljs-comment">// We can now generate a RawTxBuilderResult ready to be finalized</span>
<span class="hljs-keyword">val</span> builderResult = builder.result() <span class="hljs-keyword">val</span> builderResult = builder.result()
<span class="hljs-comment">// builderResult: RawTxBuilderResult = RawTxBuilderResult(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(a40cd0266f9694e927ce917948347fcedc81457f6d4d12497a6146de60bf35d2:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(d9fab7bcaa5a92287a64cbca9dd03a05da992965))),UInt32Impl(0))</span> <span class="hljs-comment">// builderResult: RawTxBuilderResult = RawTxBuilderResult(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(3df4441d8d5e424e972d7b291521c011c904b31cb100115622b981be3e9e7fae:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(930ad3c01af4b0d79733456b15e21560ebde4eb4))),UInt32Impl(0))</span>
<span class="hljs-comment">// this contains the information needed to analyze our input during finalization</span> <span class="hljs-comment">// this contains the information needed to analyze our input during finalization</span>
<span class="hljs-keyword">val</span> inputInfo = <span class="hljs-type">P2PKHInputInfo</span>(outPoint, amount, privKey.publicKey) <span class="hljs-keyword">val</span> inputInfo = <span class="hljs-type">P2PKHInputInfo</span>(outPoint, amount, privKey.publicKey)
<span class="hljs-comment">// inputInfo: P2PKHInputInfo = P2PKHInputInfo(TransactionOutPoint(a40cd0266f9694e927ce917948347fcedc81457f6d4d12497a6146de60bf35d2:0),10000 sats,ECPublicKey(025bbea51ecc766f533b604bf06ddf87c8348f133479f505184c1b2de60502c928))</span> <span class="hljs-comment">// inputInfo: P2PKHInputInfo = P2PKHInputInfo(TransactionOutPoint(3df4441d8d5e424e972d7b291521c011c904b31cb100115622b981be3e9e7fae:0),10000 sats,ECPublicKey(0205b9f1697bd23c32751a8a18e9f4e3d05a685a39974efa80e2fefb560f889809))</span>
<span class="hljs-comment">// this is how much we are going to pay as a fee to the network</span> <span class="hljs-comment">// this is how much we are going to pay as a fee to the network</span>
<span class="hljs-comment">// for this example, we are going to pay 1 satoshi per byte</span> <span class="hljs-comment">// for this example, we are going to pay 1 satoshi per byte</span>
@ -155,18 +155,18 @@ builder += input
<span class="hljs-keyword">val</span> changePrivKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey <span class="hljs-keyword">val</span> changePrivKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey
<span class="hljs-comment">// changePrivKey: ECPrivateKey = Masked(ECPrivateKey)</span> <span class="hljs-comment">// changePrivKey: ECPrivateKey = Masked(ECPrivateKey)</span>
<span class="hljs-keyword">val</span> changeSPK = <span class="hljs-type">P2PKHScriptPubKey</span>(pubKey = changePrivKey.publicKey) <span class="hljs-keyword">val</span> changeSPK = <span class="hljs-type">P2PKHScriptPubKey</span>(pubKey = changePrivKey.publicKey)
<span class="hljs-comment">// changeSPK: P2PKHScriptPubKey = pkh(af4df018f8b8929275ca72998bcb1854072c975d)</span> <span class="hljs-comment">// changeSPK: P2PKHScriptPubKey = pkh(a66ee68b7c84a2e43723993d1b521f22a6009a31)</span>
<span class="hljs-comment">// We chose a finalizer that adds a change output to our tx based on a fee rate</span> <span class="hljs-comment">// We chose a finalizer that adds a change output to our tx based on a fee rate</span>
<span class="hljs-keyword">val</span> finalizer = <span class="hljs-type">StandardNonInteractiveFinalizer</span>( <span class="hljs-keyword">val</span> finalizer = <span class="hljs-type">StandardNonInteractiveFinalizer</span>(
<span class="hljs-type">Vector</span>(inputInfo), <span class="hljs-type">Vector</span>(inputInfo),
feeRate, feeRate,
changeSPK) changeSPK)
<span class="hljs-comment">// finalizer: StandardNonInteractiveFinalizer = StandardNonInteractiveFinalizer(Vector(P2PKHInputInfo(TransactionOutPoint(a40cd0266f9694e927ce917948347fcedc81457f6d4d12497a6146de60bf35d2:0),10000 sats,ECPublicKey(025bbea51ecc766f533b604bf06ddf87c8348f133479f505184c1b2de60502c928))),1 sats/byte,pkh(af4df018f8b8929275ca72998bcb1854072c975d))</span> <span class="hljs-comment">// finalizer: StandardNonInteractiveFinalizer = StandardNonInteractiveFinalizer(Vector(P2PKHInputInfo(TransactionOutPoint(3df4441d8d5e424e972d7b291521c011c904b31cb100115622b981be3e9e7fae:0),10000 sats,ECPublicKey(0205b9f1697bd23c32751a8a18e9f4e3d05a685a39974efa80e2fefb560f889809))),1 sats/byte,pkh(a66ee68b7c84a2e43723993d1b521f22a6009a31))</span>
<span class="hljs-comment">// We can now finalize the tx builder result from earlier with this finalizer</span> <span class="hljs-comment">// We can now finalize the tx builder result from earlier with this finalizer</span>
<span class="hljs-keyword">val</span> unsignedTx: <span class="hljs-type">Transaction</span> = finalizer.buildTx(builderResult) <span class="hljs-keyword">val</span> unsignedTx: <span class="hljs-type">Transaction</span> = finalizer.buildTx(builderResult)
<span class="hljs-comment">// unsignedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(a40cd0266f9694e927ce917948347fcedc81457f6d4d12497a6146de60bf35d2:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(d9fab7bcaa5a92287a64cbca9dd03a05da992965)), TransactionOutput(4775 sats,pkh(af4df018f8b8929275ca72998bcb1854072c975d))),UInt32Impl(0))</span> <span class="hljs-comment">// unsignedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(3df4441d8d5e424e972d7b291521c011c904b31cb100115622b981be3e9e7fae:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(930ad3c01af4b0d79733456b15e21560ebde4eb4)), TransactionOutput(4775 sats,pkh(a66ee68b7c84a2e43723993d1b521f22a6009a31))),UInt32Impl(0))</span>
<span class="hljs-comment">// We now turn to signing the unsigned transaction</span> <span class="hljs-comment">// We now turn to signing the unsigned transaction</span>
<span class="hljs-comment">// this contains all the information we need to</span> <span class="hljs-comment">// this contains all the information we need to</span>
@ -176,12 +176,12 @@ builder += input
signers = <span class="hljs-type">Vector</span>(privKey), signers = <span class="hljs-type">Vector</span>(privKey),
hashType = hashType =
<span class="hljs-type">HashType</span>.sigHashAll) <span class="hljs-type">HashType</span>.sigHashAll)
<span class="hljs-comment">// utxoInfo: ScriptSignatureParams[P2PKHInputInfo] = ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(a40cd0266f9694e927ce917948347fcedc81457f6d4d12497a6146de60bf35d2:0),10000 sats,ECPublicKey(025bbea51ecc766f533b604bf06ddf87c8348f133479f505184c1b2de60502c928)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(66697c1a3cc79e0cd78209a3c97702ade9da3100))),UInt32Impl(0)),Vector(Masked(ECPrivateKey)),SIGHASH_ALL(Int32Impl(1)))</span> <span class="hljs-comment">// utxoInfo: ScriptSignatureParams[P2PKHInputInfo] = ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(3df4441d8d5e424e972d7b291521c011c904b31cb100115622b981be3e9e7fae:0),10000 sats,ECPublicKey(0205b9f1697bd23c32751a8a18e9f4e3d05a685a39974efa80e2fefb560f889809)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(058dc9b6fd71234ddef037b12ce3622594ade037))),UInt32Impl(0)),Vector(Masked(ECPrivateKey)),SIGHASH_ALL(Int32Impl(1)))</span>
<span class="hljs-comment">// all of the UTXO spending information, since we only have</span> <span class="hljs-comment">// all of the UTXO spending information, since we only have</span>
<span class="hljs-comment">// one input, this is just one element</span> <span class="hljs-comment">// one input, this is just one element</span>
<span class="hljs-keyword">val</span> utxoInfos: <span class="hljs-type">Vector</span>[<span class="hljs-type">ScriptSignatureParams</span>[<span class="hljs-type">InputInfo</span>]] = <span class="hljs-type">Vector</span>(utxoInfo) <span class="hljs-keyword">val</span> utxoInfos: <span class="hljs-type">Vector</span>[<span class="hljs-type">ScriptSignatureParams</span>[<span class="hljs-type">InputInfo</span>]] = <span class="hljs-type">Vector</span>(utxoInfo)
<span class="hljs-comment">// utxoInfos: Vector[ScriptSignatureParams[InputInfo]] = Vector(ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(a40cd0266f9694e927ce917948347fcedc81457f6d4d12497a6146de60bf35d2:0),10000 sats,ECPublicKey(025bbea51ecc766f533b604bf06ddf87c8348f133479f505184c1b2de60502c928)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(66697c1a3cc79e0cd78209a3c97702ade9da3100))),UInt32Impl(0)),Vector(Masked(ECPrivateKey)),SIGHASH_ALL(Int32Impl(1))))</span> <span class="hljs-comment">// utxoInfos: Vector[ScriptSignatureParams[InputInfo]] = Vector(ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(3df4441d8d5e424e972d7b291521c011c904b31cb100115622b981be3e9e7fae:0),10000 sats,ECPublicKey(0205b9f1697bd23c32751a8a18e9f4e3d05a685a39974efa80e2fefb560f889809)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(058dc9b6fd71234ddef037b12ce3622594ade037))),UInt32Impl(0)),Vector(Masked(ECPrivateKey)),SIGHASH_ALL(Int32Impl(1))))</span>
<span class="hljs-comment">// Yay! Now we use the RawTxSigner object to sign the tx.</span> <span class="hljs-comment">// Yay! Now we use the RawTxSigner object to sign the tx.</span>
<span class="hljs-comment">// The 'sign' method is going produce a validly signed transaction</span> <span class="hljs-comment">// The 'sign' method is going produce a validly signed transaction</span>
@ -197,7 +197,7 @@ builder += input
utxoInfos = utxoInfos, utxoInfos = utxoInfos,
expectedFeeRate = feeRate expectedFeeRate = feeRate
) )
<span class="hljs-comment">// signedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(a40cd0266f9694e927ce917948347fcedc81457f6d4d12497a6146de60bf35d2:0),P2PKHScriptSignature(ECPublicKeyBytes(ByteVector(33 bytes, 0x025bbea51ecc766f533b604bf06ddf87c8348f133479f505184c1b2de60502c928)), ECDigitalSignature(3044022016287edee5c91ad498ed56e7efa49f1ae4557a27d95c1014bf64265b627e0b54022050795e3b4ad5ad6917b4b93ba96b5a76df7c383e031f6911c2c3bc89547be16b01)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(d9fab7bcaa5a92287a64cbca9dd03a05da992965)), TransactionOutput(4775 sats,pkh(af4df018f8b8929275ca72998bcb1854072c975d))),UInt32Impl(0))</span> <span class="hljs-comment">// signedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(3df4441d8d5e424e972d7b291521c011c904b31cb100115622b981be3e9e7fae:0),P2PKHScriptSignature(ECPublicKeyBytes(ByteVector(33 bytes, 0x0205b9f1697bd23c32751a8a18e9f4e3d05a685a39974efa80e2fefb560f889809)), ECDigitalSignature(304402205a497179c4393edee866d1eac5a4e97c96ee03f5b679875f02ea4f02099a1fb202206de3e0edccb53be7749a54a32f147485d6f69220c03cb0fc36e949701eeb6dbc01)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(930ad3c01af4b0d79733456b15e21560ebde4eb4)), TransactionOutput(4775 sats,pkh(a66ee68b7c84a2e43723993d1b521f22a6009a31))),UInt32Impl(0))</span>
</code></pre> </code></pre>
<pre><code class="hljs css language-scala">signedTx.inputs.length <pre><code class="hljs css language-scala">signedTx.inputs.length
<span class="hljs-comment">// res2: Int = 1</span> <span class="hljs-comment">// res2: Int = 1</span>
@ -207,7 +207,7 @@ signedTx.outputs.length
<span class="hljs-comment">//remember, you can call .hex on any bitcoin-s data structure to get the hex representation!</span> <span class="hljs-comment">//remember, you can call .hex on any bitcoin-s data structure to get the hex representation!</span>
signedTx.hex signedTx.hex
<span class="hljs-comment">// res4: String = 0200000001d235bf60de46617a49124d6d7f4581dcce7f34487991ce27e994966f26d00ca4000000006a473044022016287edee5c91ad498ed56e7efa49f1ae4557a27d95c1014bf64265b627e0b54022050795e3b4ad5ad6917b4b93ba96b5a76df7c383e031f6911c2c3bc89547be16b0121025bbea51ecc766f533b604bf06ddf87c8348f133479f505184c1b2de60502c928000000000288130000000000001976a914d9fab7bcaa5a92287a64cbca9dd03a05da99296588aca7120000000000001976a914af4df018f8b8929275ca72998bcb1854072c975d88ac00000000</span> <span class="hljs-comment">// res4: String = 0200000001ae7f9e3ebe81b922561100b11cb304c911c02115297b2d974e425e8d1d44f43d000000006a47304402205a497179c4393edee866d1eac5a4e97c96ee03f5b679875f02ea4f02099a1fb202206de3e0edccb53be7749a54a32f147485d6f69220c03cb0fc36e949701eeb6dbc01210205b9f1697bd23c32751a8a18e9f4e3d05a685a39974efa80e2fefb560f889809000000000288130000000000001976a914930ad3c01af4b0d79733456b15e21560ebde4eb488aca7120000000000001976a914a66ee68b7c84a2e43723993d1b521f22a6009a3188ac00000000</span>
</code></pre> </code></pre>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/next/core/dlc"><span class="arrow-prev">← </span><span>Discreet Log Contract Data Structures</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 © 2022 Suredbits &amp; the bitcoin-s developers</section></footer></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script><script> </span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/next/core/dlc"><span class="arrow-prev">← </span><span>Discreet Log Contract Data Structures</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 © 2022 Suredbits &amp; the bitcoin-s developers</section></footer></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script><script>
document.addEventListener('keyup', function(e) { document.addEventListener('keyup', function(e) {

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

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

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

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

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

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

@ -130,7 +130,7 @@ libraryDependencies += <span class="hljs-string">"org.bitcoin-s"</span> %% <span
<h3><a class="anchor" aria-hidden="true" id="nightly-builds"></a><a href="#nightly-builds" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Nightly builds</h3> <h3><a class="anchor" aria-hidden="true" id="nightly-builds"></a><a href="#nightly-builds" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Nightly builds</h3>
<p>You can also run on the bleeding edge of Bitcoin-S, by <p>You can also run on the bleeding edge of Bitcoin-S, by
adding a snapshot build to your <code>build.sbt</code>. The most adding a snapshot build to your <code>build.sbt</code>. The most
recent snapshot published is <code>1.8.0-168-5aeecdb8-SNAPSHOT</code>.</p> recent snapshot published is <code>1.8.0-169-48189d5c-SNAPSHOT</code>.</p>
<p>To fetch snapshots, you will need to add the correct <p>To fetch snapshots, you will need to add the correct
resolver in your <code>build.sbt</code>:</p> resolver in your <code>build.sbt</code>:</p>
<pre><code class="hljs css language-sbt">resolvers += Resolver.sonatypeRepo(<span class="hljs-string">"snapshots"</span>) <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-comment">//get 256 bits of random entropy</span>
<span class="hljs-keyword">val</span> entropy = <span class="hljs-type">MnemonicCode</span>.getEntropy256Bits <span class="hljs-keyword">val</span> entropy = <span class="hljs-type">MnemonicCode</span>.getEntropy256Bits
<span class="hljs-comment">// entropy: scodec.bits.BitVector = BitVector(256 bits, 0xe7ade868d039888725827e7274daa4235a8ab7e16b5263a3631396895171c26b)</span> <span class="hljs-comment">// entropy: scodec.bits.BitVector = BitVector(256 bits, 0xb2f43618fa6ed9f0b34b074f5abd5b367d22e3c169d671e05a97e1ff1ecae807)</span>
<span class="hljs-keyword">val</span> mnemonic = <span class="hljs-type">MnemonicCode</span>.fromEntropy(entropy) <span class="hljs-keyword">val</span> mnemonic = <span class="hljs-type">MnemonicCode</span>.fromEntropy(entropy)
<span class="hljs-comment">// mnemonic: MnemonicCode = Masked(MnemonicCodeImpl)</span> <span class="hljs-comment">// mnemonic: MnemonicCode = Masked(MnemonicCodeImpl)</span>
<span class="hljs-comment">//you can print that mnemonic seed with this</span> <span class="hljs-comment">//you can print that mnemonic seed with this</span>
println(mnemonic.words) println(mnemonic.words)
<span class="hljs-comment">// Vector(tray, hungry, boss, parrot, obtain, drum, noodle, exist, include, plug, poverty, effort, post, fossil, mad, heart, glove, brand, shaft, code, never, rib, answer, grace)</span> <span class="hljs-comment">// Vector(real, payment, mail, visit, unique, weapon, snake, genius, exercise, sting, fine, hollow, split, impose, aisle, depart, impose, actress, planet, sentence, vehicle, grace, parade, wine)</span>
</code></pre> </code></pre>
<p>Now that we have a <code>MnemonicCode</code> that was securely generated, we need to now create <code>KeyManagerParams</code> which tells us how to generate <p>Now that we have a <code>MnemonicCode</code> that was securely generated, we need to now create <code>KeyManagerParams</code> which tells us how to generate
generate specific kinds of addresses for wallets.</p> generate specific kinds of addresses for wallets.</p>
@ -99,7 +99,7 @@ generate specific kinds of addresses for wallets.</p>
<pre><code class="hljs css language-scala"><span class="hljs-comment">//this will create a temp directory with the prefix 'key-manager-example` that will</span> <pre><code class="hljs css language-scala"><span class="hljs-comment">//this will create a temp directory with the prefix 'key-manager-example` that will</span>
<span class="hljs-comment">//have a file in it called "encrypted-bitcoin-s-seed.json"</span> <span class="hljs-comment">//have a file in it called "encrypted-bitcoin-s-seed.json"</span>
<span class="hljs-keyword">val</span> seedPath = <span class="hljs-type">Files</span>.createTempDirectory(<span class="hljs-string">"key-manager-example"</span>).resolve(<span class="hljs-type">WalletStorage</span>.<span class="hljs-type">ENCRYPTED_SEED_FILE_NAME</span>) <span class="hljs-keyword">val</span> seedPath = <span class="hljs-type">Files</span>.createTempDirectory(<span class="hljs-string">"key-manager-example"</span>).resolve(<span class="hljs-type">WalletStorage</span>.<span class="hljs-type">ENCRYPTED_SEED_FILE_NAME</span>)
<span class="hljs-comment">// seedPath: Path = /tmp/key-manager-example17352509363772399931/encrypted-bitcoin-s-seed.json</span> <span class="hljs-comment">// seedPath: Path = /tmp/key-manager-example18210858081195908821/encrypted-bitcoin-s-seed.json</span>
<span class="hljs-comment">//let's create a native segwit key manager</span> <span class="hljs-comment">//let's create a native segwit key manager</span>
<span class="hljs-keyword">val</span> purpose = <span class="hljs-type">HDPurposes</span>.<span class="hljs-type">SegWit</span> <span class="hljs-keyword">val</span> purpose = <span class="hljs-type">HDPurposes</span>.<span class="hljs-type">SegWit</span>
@ -110,19 +110,19 @@ generate specific kinds of addresses for wallets.</p>
<span class="hljs-comment">// network: RegTest.type = RegTest</span> <span class="hljs-comment">// network: RegTest.type = RegTest</span>
<span class="hljs-keyword">val</span> kmParams = <span class="hljs-type">KeyManagerParams</span>(seedPath, purpose, network) <span class="hljs-keyword">val</span> kmParams = <span class="hljs-type">KeyManagerParams</span>(seedPath, purpose, network)
<span class="hljs-comment">// kmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example17352509363772399931/encrypted-bitcoin-s-seed.json,m/84',RegTest)</span> <span class="hljs-comment">// kmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example18210858081195908821/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-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-comment">// aesPasswordOpt: Some[AesPassword] = Some(Masked(AesPassword))</span>
<span class="hljs-keyword">val</span> km = <span class="hljs-type">BIP39KeyManager</span>.initializeWithMnemonic(aesPasswordOpt, mnemonic, <span class="hljs-type">None</span>, kmParams) <span class="hljs-keyword">val</span> km = <span class="hljs-type">BIP39KeyManager</span>.initializeWithMnemonic(aesPasswordOpt, mnemonic, <span class="hljs-type">None</span>, kmParams)
<span class="hljs-comment">// km: Either[KeyManagerInitializeError, BIP39KeyManager] = Right(org.bitcoins.keymanager.bip39.BIP39KeyManager@71532267)</span> <span class="hljs-comment">// km: Either[KeyManagerInitializeError, BIP39KeyManager] = Right(org.bitcoins.keymanager.bip39.BIP39KeyManager@4e80fce6)</span>
<span class="hljs-keyword">val</span> rootXPub = km.right.get.getRootXPub <span class="hljs-keyword">val</span> rootXPub = km.right.get.getRootXPub
<span class="hljs-comment">// rootXPub: ExtPublicKey = vpub5SLqN2bLY4WeYcbNVWLpK4zzLR45AAA8KTW1JpXioeWP62qtVrLJxGCJsH1j4JiedZGV2S2Yc6nMWxQgqz7WTSh5hVx9g9JHVnNMHEKkANG</span> <span class="hljs-comment">// rootXPub: ExtPublicKey = vpub5SLqN2bLY4WeZXK4iD3KRqPARKYiG33saH7nP59TxDGsJ7Ss92D2n3qk1i1VnhpFKgPpTVMMsgRTkqjoCmM3c8j3uk5L5VkGWUNxZwxckXQ</span>
println(rootXPub) println(rootXPub)
<span class="hljs-comment">// vpub5SLqN2bLY4WeYcbNVWLpK4zzLR45AAA8KTW1JpXioeWP62qtVrLJxGCJsH1j4JiedZGV2S2Yc6nMWxQgqz7WTSh5hVx9g9JHVnNMHEKkANG</span> <span class="hljs-comment">// vpub5SLqN2bLY4WeZXK4iD3KRqPARKYiG33saH7nP59TxDGsJ7Ss92D2n3qk1i1VnhpFKgPpTVMMsgRTkqjoCmM3c8j3uk5L5VkGWUNxZwxckXQ</span>
</code></pre> </code></pre>
<p>Which should print something that looks like this</p> <p>Which should print something that looks like this</p>
<p><code>vpub5SLqN2bLY4WeXxMqwJHJFBEwxSscGB2uDUnsTS3edVjZEwTrQDFDNqoR2xLqARQPabGaXsHSTenTRcqm2EnB9MpuC4vSk3LqSgNmGGZtuq7</code></p> <p><code>vpub5SLqN2bLY4WeXxMqwJHJFBEwxSscGB2uDUnsTS3edVjZEwTrQDFDNqoR2xLqARQPabGaXsHSTenTRcqm2EnB9MpuC4vSk3LqSgNmGGZtuq7</code></p>
@ -131,17 +131,17 @@ println(rootXPub)
again after initializing it once. You can use the same <code>mnemonic</code> for different networks, which you control <code>KeyManagerParams</code>.</p> again after initializing it once. You can use the same <code>mnemonic</code> for different networks, which you control <code>KeyManagerParams</code>.</p>
<pre><code class="hljs css language-scala"><span class="hljs-comment">//let's create a nested segwit key manager for mainnet</span> <pre><code class="hljs css language-scala"><span class="hljs-comment">//let's create a nested segwit key manager for mainnet</span>
<span class="hljs-keyword">val</span> mainnetKmParams = <span class="hljs-type">KeyManagerParams</span>(seedPath, <span class="hljs-type">HDPurposes</span>.<span class="hljs-type">SegWit</span>, <span class="hljs-type">MainNet</span>) <span class="hljs-keyword">val</span> mainnetKmParams = <span class="hljs-type">KeyManagerParams</span>(seedPath, <span class="hljs-type">HDPurposes</span>.<span class="hljs-type">SegWit</span>, <span class="hljs-type">MainNet</span>)
<span class="hljs-comment">// mainnetKmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example17352509363772399931/encrypted-bitcoin-s-seed.json,m/84',MainNet)</span> <span class="hljs-comment">// mainnetKmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example18210858081195908821/encrypted-bitcoin-s-seed.json,m/84',MainNet)</span>
<span class="hljs-comment">//we do not need to all `initializeWithMnemonic()` again as we have saved the seed to dis</span> <span class="hljs-comment">//we do not need to all `initializeWithMnemonic()` again as we have saved the seed to dis</span>
<span class="hljs-keyword">val</span> mainnetKeyManager = <span class="hljs-type">BIP39KeyManager</span>.fromMnemonic(mnemonic, mainnetKmParams, <span class="hljs-type">None</span>, <span class="hljs-type">Instant</span>.now) <span class="hljs-keyword">val</span> mainnetKeyManager = <span class="hljs-type">BIP39KeyManager</span>.fromMnemonic(mnemonic, mainnetKmParams, <span class="hljs-type">None</span>, <span class="hljs-type">Instant</span>.now)
<span class="hljs-comment">// mainnetKeyManager: BIP39KeyManager = org.bitcoins.keymanager.bip39.BIP39KeyManager@23e36999</span> <span class="hljs-comment">// mainnetKeyManager: BIP39KeyManager = org.bitcoins.keymanager.bip39.BIP39KeyManager@6af083f8</span>
<span class="hljs-keyword">val</span> mainnetXpub = mainnetKeyManager.getRootXPub <span class="hljs-keyword">val</span> mainnetXpub = mainnetKeyManager.getRootXPub
<span class="hljs-comment">// mainnetXpub: ExtPublicKey = zpub6jftahH18ngZwoMqpwVK9RP12Hdrve87yuatSQ7GKg1uJS6oWUzZSWprx6r53wLLG7ji2LQnSkCZ46rwimmZePRVArjr1naEagcvqd7sVya</span> <span class="hljs-comment">// mainnetXpub: ExtPublicKey = zpub6jftahH18ngZxi5Y3eBpGBmB7C8W2X1sEjCfWej1UEnPWWhn9esHGJUJ6XqqnLRvxEs3TPjbiKqfHzC45Z16o5TTP6s2R92DbNdY8HjoYiM</span>
println(mainnetXpub) println(mainnetXpub)
<span class="hljs-comment">// zpub6jftahH18ngZwoMqpwVK9RP12Hdrve87yuatSQ7GKg1uJS6oWUzZSWprx6r53wLLG7ji2LQnSkCZ46rwimmZePRVArjr1naEagcvqd7sVya</span> <span class="hljs-comment">// zpub6jftahH18ngZxi5Y3eBpGBmB7C8W2X1sEjCfWej1UEnPWWhn9esHGJUJ6XqqnLRvxEs3TPjbiKqfHzC45Z16o5TTP6s2R92DbNdY8HjoYiM</span>
</code></pre> </code></pre>
<p>Which gives us something that looks like this</p> <p>Which gives us something that looks like this</p>
<p><code>zpub6jftahH18ngZw98KGjRo5XcxeKTQ2eztsvskb1dC9XF5TLimQquTs6Ry7nBBA425D9joXmfgJJCexmJ1u2SELJZJfRi95gcnXadLpZzYb5c</code></p> <p><code>zpub6jftahH18ngZw98KGjRo5XcxeKTQ2eztsvskb1dC9XF5TLimQquTs6Ry7nBBA425D9joXmfgJJCexmJ1u2SELJZJfRi95gcnXadLpZzYb5c</code></p>

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

@ -77,14 +77,14 @@
<span class="hljs-comment">//get 256 bits of random entropy</span> <span class="hljs-comment">//get 256 bits of random entropy</span>
<span class="hljs-keyword">val</span> entropy = <span class="hljs-type">MnemonicCode</span>.getEntropy256Bits <span class="hljs-keyword">val</span> entropy = <span class="hljs-type">MnemonicCode</span>.getEntropy256Bits
<span class="hljs-comment">// entropy: scodec.bits.BitVector = BitVector(256 bits, 0xe7ade868d039888725827e7274daa4235a8ab7e16b5263a3631396895171c26b)</span> <span class="hljs-comment">// entropy: scodec.bits.BitVector = BitVector(256 bits, 0xb2f43618fa6ed9f0b34b074f5abd5b367d22e3c169d671e05a97e1ff1ecae807)</span>
<span class="hljs-keyword">val</span> mnemonic = <span class="hljs-type">MnemonicCode</span>.fromEntropy(entropy) <span class="hljs-keyword">val</span> mnemonic = <span class="hljs-type">MnemonicCode</span>.fromEntropy(entropy)
<span class="hljs-comment">// mnemonic: MnemonicCode = Masked(MnemonicCodeImpl)</span> <span class="hljs-comment">// mnemonic: MnemonicCode = Masked(MnemonicCodeImpl)</span>
<span class="hljs-comment">//you can print that mnemonic seed with this</span> <span class="hljs-comment">//you can print that mnemonic seed with this</span>
println(mnemonic.words) println(mnemonic.words)
<span class="hljs-comment">// Vector(tray, hungry, boss, parrot, obtain, drum, noodle, exist, include, plug, poverty, effort, post, fossil, mad, heart, glove, brand, shaft, code, never, rib, answer, grace)</span> <span class="hljs-comment">// Vector(real, payment, mail, visit, unique, weapon, snake, genius, exercise, sting, fine, hollow, split, impose, aisle, depart, impose, actress, planet, sentence, vehicle, grace, parade, wine)</span>
</code></pre> </code></pre>
<p>Now that we have a <code>MnemonicCode</code> that was securely generated, we need to now create <code>KeyManagerParams</code> which tells us how to generate <p>Now that we have a <code>MnemonicCode</code> that was securely generated, we need to now create <code>KeyManagerParams</code> which tells us how to generate
generate specific kinds of addresses for wallets.</p> generate specific kinds of addresses for wallets.</p>
@ -99,7 +99,7 @@ generate specific kinds of addresses for wallets.</p>
<pre><code class="hljs css language-scala"><span class="hljs-comment">//this will create a temp directory with the prefix 'key-manager-example` that will</span> <pre><code class="hljs css language-scala"><span class="hljs-comment">//this will create a temp directory with the prefix 'key-manager-example` that will</span>
<span class="hljs-comment">//have a file in it called "encrypted-bitcoin-s-seed.json"</span> <span class="hljs-comment">//have a file in it called "encrypted-bitcoin-s-seed.json"</span>
<span class="hljs-keyword">val</span> seedPath = <span class="hljs-type">Files</span>.createTempDirectory(<span class="hljs-string">"key-manager-example"</span>).resolve(<span class="hljs-type">WalletStorage</span>.<span class="hljs-type">ENCRYPTED_SEED_FILE_NAME</span>) <span class="hljs-keyword">val</span> seedPath = <span class="hljs-type">Files</span>.createTempDirectory(<span class="hljs-string">"key-manager-example"</span>).resolve(<span class="hljs-type">WalletStorage</span>.<span class="hljs-type">ENCRYPTED_SEED_FILE_NAME</span>)
<span class="hljs-comment">// seedPath: Path = /tmp/key-manager-example17352509363772399931/encrypted-bitcoin-s-seed.json</span> <span class="hljs-comment">// seedPath: Path = /tmp/key-manager-example18210858081195908821/encrypted-bitcoin-s-seed.json</span>
<span class="hljs-comment">//let's create a native segwit key manager</span> <span class="hljs-comment">//let's create a native segwit key manager</span>
<span class="hljs-keyword">val</span> purpose = <span class="hljs-type">HDPurposes</span>.<span class="hljs-type">SegWit</span> <span class="hljs-keyword">val</span> purpose = <span class="hljs-type">HDPurposes</span>.<span class="hljs-type">SegWit</span>
@ -110,19 +110,19 @@ generate specific kinds of addresses for wallets.</p>
<span class="hljs-comment">// network: RegTest.type = RegTest</span> <span class="hljs-comment">// network: RegTest.type = RegTest</span>
<span class="hljs-keyword">val</span> kmParams = <span class="hljs-type">KeyManagerParams</span>(seedPath, purpose, network) <span class="hljs-keyword">val</span> kmParams = <span class="hljs-type">KeyManagerParams</span>(seedPath, purpose, network)
<span class="hljs-comment">// kmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example17352509363772399931/encrypted-bitcoin-s-seed.json,m/84',RegTest)</span> <span class="hljs-comment">// kmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example18210858081195908821/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-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-comment">// aesPasswordOpt: Some[AesPassword] = Some(Masked(AesPassword))</span>
<span class="hljs-keyword">val</span> km = <span class="hljs-type">BIP39KeyManager</span>.initializeWithMnemonic(aesPasswordOpt, mnemonic, <span class="hljs-type">None</span>, kmParams) <span class="hljs-keyword">val</span> km = <span class="hljs-type">BIP39KeyManager</span>.initializeWithMnemonic(aesPasswordOpt, mnemonic, <span class="hljs-type">None</span>, kmParams)
<span class="hljs-comment">// km: Either[KeyManagerInitializeError, BIP39KeyManager] = Right(org.bitcoins.keymanager.bip39.BIP39KeyManager@71532267)</span> <span class="hljs-comment">// km: Either[KeyManagerInitializeError, BIP39KeyManager] = Right(org.bitcoins.keymanager.bip39.BIP39KeyManager@4e80fce6)</span>
<span class="hljs-keyword">val</span> rootXPub = km.right.get.getRootXPub <span class="hljs-keyword">val</span> rootXPub = km.right.get.getRootXPub
<span class="hljs-comment">// rootXPub: ExtPublicKey = vpub5SLqN2bLY4WeYcbNVWLpK4zzLR45AAA8KTW1JpXioeWP62qtVrLJxGCJsH1j4JiedZGV2S2Yc6nMWxQgqz7WTSh5hVx9g9JHVnNMHEKkANG</span> <span class="hljs-comment">// rootXPub: ExtPublicKey = vpub5SLqN2bLY4WeZXK4iD3KRqPARKYiG33saH7nP59TxDGsJ7Ss92D2n3qk1i1VnhpFKgPpTVMMsgRTkqjoCmM3c8j3uk5L5VkGWUNxZwxckXQ</span>
println(rootXPub) println(rootXPub)
<span class="hljs-comment">// vpub5SLqN2bLY4WeYcbNVWLpK4zzLR45AAA8KTW1JpXioeWP62qtVrLJxGCJsH1j4JiedZGV2S2Yc6nMWxQgqz7WTSh5hVx9g9JHVnNMHEKkANG</span> <span class="hljs-comment">// vpub5SLqN2bLY4WeZXK4iD3KRqPARKYiG33saH7nP59TxDGsJ7Ss92D2n3qk1i1VnhpFKgPpTVMMsgRTkqjoCmM3c8j3uk5L5VkGWUNxZwxckXQ</span>
</code></pre> </code></pre>
<p>Which should print something that looks like this</p> <p>Which should print something that looks like this</p>
<p><code>vpub5SLqN2bLY4WeXxMqwJHJFBEwxSscGB2uDUnsTS3edVjZEwTrQDFDNqoR2xLqARQPabGaXsHSTenTRcqm2EnB9MpuC4vSk3LqSgNmGGZtuq7</code></p> <p><code>vpub5SLqN2bLY4WeXxMqwJHJFBEwxSscGB2uDUnsTS3edVjZEwTrQDFDNqoR2xLqARQPabGaXsHSTenTRcqm2EnB9MpuC4vSk3LqSgNmGGZtuq7</code></p>
@ -131,17 +131,17 @@ println(rootXPub)
again after initializing it once. You can use the same <code>mnemonic</code> for different networks, which you control <code>KeyManagerParams</code>.</p> again after initializing it once. You can use the same <code>mnemonic</code> for different networks, which you control <code>KeyManagerParams</code>.</p>
<pre><code class="hljs css language-scala"><span class="hljs-comment">//let's create a nested segwit key manager for mainnet</span> <pre><code class="hljs css language-scala"><span class="hljs-comment">//let's create a nested segwit key manager for mainnet</span>
<span class="hljs-keyword">val</span> mainnetKmParams = <span class="hljs-type">KeyManagerParams</span>(seedPath, <span class="hljs-type">HDPurposes</span>.<span class="hljs-type">SegWit</span>, <span class="hljs-type">MainNet</span>) <span class="hljs-keyword">val</span> mainnetKmParams = <span class="hljs-type">KeyManagerParams</span>(seedPath, <span class="hljs-type">HDPurposes</span>.<span class="hljs-type">SegWit</span>, <span class="hljs-type">MainNet</span>)
<span class="hljs-comment">// mainnetKmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example17352509363772399931/encrypted-bitcoin-s-seed.json,m/84',MainNet)</span> <span class="hljs-comment">// mainnetKmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example18210858081195908821/encrypted-bitcoin-s-seed.json,m/84',MainNet)</span>
<span class="hljs-comment">//we do not need to all `initializeWithMnemonic()` again as we have saved the seed to dis</span> <span class="hljs-comment">//we do not need to all `initializeWithMnemonic()` again as we have saved the seed to dis</span>
<span class="hljs-keyword">val</span> mainnetKeyManager = <span class="hljs-type">BIP39KeyManager</span>.fromMnemonic(mnemonic, mainnetKmParams, <span class="hljs-type">None</span>, <span class="hljs-type">Instant</span>.now) <span class="hljs-keyword">val</span> mainnetKeyManager = <span class="hljs-type">BIP39KeyManager</span>.fromMnemonic(mnemonic, mainnetKmParams, <span class="hljs-type">None</span>, <span class="hljs-type">Instant</span>.now)
<span class="hljs-comment">// mainnetKeyManager: BIP39KeyManager = org.bitcoins.keymanager.bip39.BIP39KeyManager@23e36999</span> <span class="hljs-comment">// mainnetKeyManager: BIP39KeyManager = org.bitcoins.keymanager.bip39.BIP39KeyManager@6af083f8</span>
<span class="hljs-keyword">val</span> mainnetXpub = mainnetKeyManager.getRootXPub <span class="hljs-keyword">val</span> mainnetXpub = mainnetKeyManager.getRootXPub
<span class="hljs-comment">// mainnetXpub: ExtPublicKey = zpub6jftahH18ngZwoMqpwVK9RP12Hdrve87yuatSQ7GKg1uJS6oWUzZSWprx6r53wLLG7ji2LQnSkCZ46rwimmZePRVArjr1naEagcvqd7sVya</span> <span class="hljs-comment">// mainnetXpub: ExtPublicKey = zpub6jftahH18ngZxi5Y3eBpGBmB7C8W2X1sEjCfWej1UEnPWWhn9esHGJUJ6XqqnLRvxEs3TPjbiKqfHzC45Z16o5TTP6s2R92DbNdY8HjoYiM</span>
println(mainnetXpub) println(mainnetXpub)
<span class="hljs-comment">// zpub6jftahH18ngZwoMqpwVK9RP12Hdrve87yuatSQ7GKg1uJS6oWUzZSWprx6r53wLLG7ji2LQnSkCZ46rwimmZePRVArjr1naEagcvqd7sVya</span> <span class="hljs-comment">// zpub6jftahH18ngZxi5Y3eBpGBmB7C8W2X1sEjCfWej1UEnPWWhn9esHGJUJ6XqqnLRvxEs3TPjbiKqfHzC45Z16o5TTP6s2R92DbNdY8HjoYiM</span>
</code></pre> </code></pre>
<p>Which gives us something that looks like this</p> <p>Which gives us something that looks like this</p>
<p><code>zpub6jftahH18ngZw98KGjRo5XcxeKTQ2eztsvskb1dC9XF5TLimQquTs6Ry7nBBA425D9joXmfgJJCexmJ1u2SELJZJfRi95gcnXadLpZzYb5c</code></p> <p><code>zpub6jftahH18ngZw98KGjRo5XcxeKTQ2eztsvskb1dC9XF5TLimQquTs6Ry7nBBA425D9joXmfgJJCexmJ1u2SELJZJfRi95gcnXadLpZzYb5c</code></p>

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

@ -115,13 +115,13 @@ println(<span class="hljs-string">s"Verified with NativeSecp256k1 again=<span cl
<span class="hljs-comment">// privKey: ECPrivateKey = Masked(ECPrivateKey)</span> <span class="hljs-comment">// privKey: ECPrivateKey = Masked(ECPrivateKey)</span>
<span class="hljs-comment">// calls bouncy castle indirectly via CryptoContext</span> <span class="hljs-comment">// calls bouncy castle indirectly via CryptoContext</span>
<span class="hljs-keyword">val</span> publicKey = privKey.publicKey <span class="hljs-keyword">val</span> publicKey = privKey.publicKey
<span class="hljs-comment">// publicKey: ECPublicKey = ECPublicKey(028c41530849cdc8d605d1c7d144b50441de5e76b2ce50939efd10c3648d8fb80d)</span> <span class="hljs-comment">// publicKey: ECPublicKey = ECPublicKey(0333e41559bbf2fd6a7ae70ad85bf431fb98e5e622b473b86739719cb205e75b2e)</span>
<span class="hljs-keyword">val</span> dataToSign = <span class="hljs-type">DoubleSha256Digest</span>.empty <span class="hljs-keyword">val</span> dataToSign = <span class="hljs-type">DoubleSha256Digest</span>.empty
<span class="hljs-comment">// dataToSign: DoubleSha256Digest = DoubleSha256Digest(0000000000000000000000000000000000000000000000000000000000000000)</span> <span class="hljs-comment">// dataToSign: DoubleSha256Digest = DoubleSha256Digest(0000000000000000000000000000000000000000000000000000000000000000)</span>
<span class="hljs-comment">// calls bouncy castle indirectly via CryptoContext</span> <span class="hljs-comment">// calls bouncy castle indirectly via CryptoContext</span>
<span class="hljs-keyword">val</span> signature = privKey.sign(dataToSign.bytes) <span class="hljs-keyword">val</span> signature = privKey.sign(dataToSign.bytes)
<span class="hljs-comment">// signature: ECDigitalSignature = ECDigitalSignature(3044022028583fb0654bc4ed3d9b1ec40a33eaf342d028f99d05997fee3b3668eaa70a5502205882d87b7d0ac2890584990587f87a8b622b808cecdcb71628d8963807f4cfaa)</span> <span class="hljs-comment">// signature: ECDigitalSignature = ECDigitalSignature(3045022100ea96ec5f253a72f1e287789273ffc96dcb7a682eb256f7de72eda45a55dd857002205989643ea0c433c4dfe106625e5c5cafcd259adc57d0fc71518a63dcffa03c19)</span>
<span class="hljs-comment">// calls bouncy castle indirectly via CryptoContext</span> <span class="hljs-comment">// calls bouncy castle indirectly via CryptoContext</span>
<span class="hljs-keyword">val</span> verified = publicKey.verify(dataToSign.bytes, signature) <span class="hljs-keyword">val</span> verified = publicKey.verify(dataToSign.bytes, signature)

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

@ -115,13 +115,13 @@ println(<span class="hljs-string">s"Verified with NativeSecp256k1 again=<span cl
<span class="hljs-comment">// privKey: ECPrivateKey = Masked(ECPrivateKey)</span> <span class="hljs-comment">// privKey: ECPrivateKey = Masked(ECPrivateKey)</span>
<span class="hljs-comment">// calls bouncy castle indirectly via CryptoContext</span> <span class="hljs-comment">// calls bouncy castle indirectly via CryptoContext</span>
<span class="hljs-keyword">val</span> publicKey = privKey.publicKey <span class="hljs-keyword">val</span> publicKey = privKey.publicKey
<span class="hljs-comment">// publicKey: ECPublicKey = ECPublicKey(028c41530849cdc8d605d1c7d144b50441de5e76b2ce50939efd10c3648d8fb80d)</span> <span class="hljs-comment">// publicKey: ECPublicKey = ECPublicKey(0333e41559bbf2fd6a7ae70ad85bf431fb98e5e622b473b86739719cb205e75b2e)</span>
<span class="hljs-keyword">val</span> dataToSign = <span class="hljs-type">DoubleSha256Digest</span>.empty <span class="hljs-keyword">val</span> dataToSign = <span class="hljs-type">DoubleSha256Digest</span>.empty
<span class="hljs-comment">// dataToSign: DoubleSha256Digest = DoubleSha256Digest(0000000000000000000000000000000000000000000000000000000000000000)</span> <span class="hljs-comment">// dataToSign: DoubleSha256Digest = DoubleSha256Digest(0000000000000000000000000000000000000000000000000000000000000000)</span>
<span class="hljs-comment">// calls bouncy castle indirectly via CryptoContext</span> <span class="hljs-comment">// calls bouncy castle indirectly via CryptoContext</span>
<span class="hljs-keyword">val</span> signature = privKey.sign(dataToSign.bytes) <span class="hljs-keyword">val</span> signature = privKey.sign(dataToSign.bytes)
<span class="hljs-comment">// signature: ECDigitalSignature = ECDigitalSignature(3044022028583fb0654bc4ed3d9b1ec40a33eaf342d028f99d05997fee3b3668eaa70a5502205882d87b7d0ac2890584990587f87a8b622b808cecdcb71628d8963807f4cfaa)</span> <span class="hljs-comment">// signature: ECDigitalSignature = ECDigitalSignature(3045022100ea96ec5f253a72f1e287789273ffc96dcb7a682eb256f7de72eda45a55dd857002205989643ea0c433c4dfe106625e5c5cafcd259adc57d0fc71518a63dcffa03c19)</span>
<span class="hljs-comment">// calls bouncy castle indirectly via CryptoContext</span> <span class="hljs-comment">// calls bouncy castle indirectly via CryptoContext</span>
<span class="hljs-keyword">val</span> verified = publicKey.verify(dataToSign.bytes, signature) <span class="hljs-keyword">val</span> verified = publicKey.verify(dataToSign.bytes, signature)