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 1ddd7bec1d
This commit is contained in:
Docusaurus bot 2021-01-10 18:44:29 +00:00
parent 12696e1aeb
commit 694d935e94
14 changed files with 90 additions and 90 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

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

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

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

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

@ -86,13 +86,13 @@ use that to generate further private and public keys:</p>
<span class="hljs-comment">// how long our phrase ends up being</span> <span class="hljs-comment">// how long our phrase ends up being</span>
<span class="hljs-comment">// 256 bits of entropy results in 24 words</span> <span class="hljs-comment">// 256 bits of entropy results in 24 words</span>
<span class="hljs-keyword">val</span> entropy: <span class="hljs-type">BitVector</span> = <span class="hljs-type">MnemonicCode</span>.getEntropy256Bits <span class="hljs-keyword">val</span> entropy: <span class="hljs-type">BitVector</span> = <span class="hljs-type">MnemonicCode</span>.getEntropy256Bits
<span class="hljs-comment">// entropy: BitVector = BitVector(256 bits, 0xf8c65087215709eadd38113489b3a105f1e4bbe502c8b15edfa028d762599fbf)</span> <span class="hljs-comment">// entropy: BitVector = BitVector(256 bits, 0x16138b2448d017b7a43b842e0ab5199a355681eb048ef5b4757a39510b06f94c)</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(web, crater, canyon, dress, identify, voice, insane, acquire, cruel, eternal, tribe, armor, bundle, fuel, neglect, flip, rally, want, trend, faculty, involve, coast, leave, unhappy) // the phrase the user should write down</span> <span class="hljs-comment">// res0: Vector[String] = Vector(bid, ordinary, simple, museum, accident, swift, movie, identify, come, fiber, edit, crucial, fever, domain, project, mushroom, volcano, photo, future, increase, awful, lock, topple, modify) // 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 = zpub6jftahH18ngZx3Gj2FUb8A2bBNQddJ2tuGvH488tHdizaDmYWggktNdURESPz6RC5dajifFBqM2Tya7nBsGXJBJA71dTrAmHavCxrjw33nN</span> <span class="hljs-comment">// xpub: ExtPublicKey = zpub6jftahH18ngZxor2RhAhfJWJNNTUJiM5zTAfpduTqvL6UcLN4xmgdurKXQWTFN3kuuA1mhgF28ScfWVoRzwL2woBhjBACATyBv1rfsJzbYB</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 = zpub6qUjnjgeF69cJ1KBChH2smPv5bT9e4ZbUJBVVyMtDwgadKnTzpNqa6wALdoTDwwA1WdNTUPh1PjNxoD58D8apLCiLFNRD2N67PJ6AVLBfze</span> <span class="hljs-comment">// accountXpub: ExtPublicKey = zpub6rYfQGDkQLMPjeho9knPMePTYF1ogNhMnN2gjmtLChPi52cGGQa6t8U53sUCgqpWNwwTnyPyXQFgy3iWDU7DMiboQcnroEf4FpPVhqn9Neu</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 = tb1qqh4ym6h94xytywe6upl27fm8ns27qmlxmycyf6</span> <span class="hljs-comment">// firstAccountAddress: Bech32Address = tb1qcjcafhkphny0pyvqy22edhm63vmfu5mgtsv4tl</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 = tb1qqh4ym6h94xytywe6upl27fm8ns27qmlxmycyf6</span> <span class="hljs-comment">// res2: String = tb1qcjcafhkphny0pyvqy22edhm63vmfu5mgtsv4tl</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, 0xf8c65087215709eadd38113489b3a105f1e4bbe502c8b15edfa028d762599fbf)</span> <span class="hljs-comment">// entropy: BitVector = BitVector(256 bits, 0x16138b2448d017b7a43b842e0ab5199a355681eb048ef5b4757a39510b06f94c)</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(web, crater, canyon, dress, identify, voice, insane, acquire, cruel, eternal, tribe, armor, bundle, fuel, neglect, flip, rally, want, trend, faculty, involve, coast, leave, unhappy) // the phrase the user should write down</span> <span class="hljs-comment">// res0: Vector[String] = Vector(bid, ordinary, simple, museum, accident, swift, movie, identify, come, fiber, edit, crucial, fever, domain, project, mushroom, volcano, photo, future, increase, awful, lock, topple, modify) // 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 = zpub6jftahH18ngZx3Gj2FUb8A2bBNQddJ2tuGvH488tHdizaDmYWggktNdURESPz6RC5dajifFBqM2Tya7nBsGXJBJA71dTrAmHavCxrjw33nN</span> <span class="hljs-comment">// xpub: ExtPublicKey = zpub6jftahH18ngZxor2RhAhfJWJNNTUJiM5zTAfpduTqvL6UcLN4xmgdurKXQWTFN3kuuA1mhgF28ScfWVoRzwL2woBhjBACATyBv1rfsJzbYB</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 = zpub6qUjnjgeF69cJ1KBChH2smPv5bT9e4ZbUJBVVyMtDwgadKnTzpNqa6wALdoTDwwA1WdNTUPh1PjNxoD58D8apLCiLFNRD2N67PJ6AVLBfze</span> <span class="hljs-comment">// accountXpub: ExtPublicKey = zpub6rYfQGDkQLMPjeho9knPMePTYF1ogNhMnN2gjmtLChPi52cGGQa6t8U53sUCgqpWNwwTnyPyXQFgy3iWDU7DMiboQcnroEf4FpPVhqn9Neu</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 = tb1qqh4ym6h94xytywe6upl27fm8ns27qmlxmycyf6</span> <span class="hljs-comment">// firstAccountAddress: Bech32Address = tb1qcjcafhkphny0pyvqy22edhm63vmfu5mgtsv4tl</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 = tb1qqh4ym6h94xytywe6upl27fm8ns27qmlxmycyf6</span> <span class="hljs-comment">// res2: String = tb1qcjcafhkphny0pyvqy22edhm63vmfu5mgtsv4tl</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@3349c998[Running, parallelism = 2, size = 2, active = 0, running = 0, steals = 33, tasks = 0, submissions = 0]</span> <span class="hljs-comment">// ec: ExecutionContext = scala.concurrent.impl.ExecutionContextImpl$$anon$3@1f400dfb[Running, parallelism = 2, size = 2, active = 0, running = 0, steals = 37, tasks = 0, submissions = 0]</span>
<span class="hljs-comment">// Initialize a transaction builder</span> <span class="hljs-comment">// Initialize a transaction builder</span>
<span class="hljs-keyword">val</span> builder = <span class="hljs-type">RawTxBuilder</span>() <span class="hljs-keyword">val</span> builder = <span class="hljs-type">RawTxBuilder</span>()
@ -74,19 +74,19 @@
<span class="hljs-keyword">val</span> privKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey <span class="hljs-keyword">val</span> privKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey
<span class="hljs-comment">// privKey: ECPrivateKey = Masked(ECPrivateKeyImpl)</span> <span class="hljs-comment">// privKey: ECPrivateKey = Masked(ECPrivateKeyImpl)</span>
<span class="hljs-keyword">val</span> pubKey = privKey.publicKey <span class="hljs-keyword">val</span> pubKey = privKey.publicKey
<span class="hljs-comment">// pubKey: ECPublicKey = ECPublicKey(02ff7487cc72bcaa1d59e192d38fc0a3057ae0edcc53ebc94f78f9c5a819606079)</span> <span class="hljs-comment">// pubKey: ECPublicKey = ECPublicKey(036d9b8eabb066861ad0c286b667da370a2532aa82e8ed4cea7399ced8b5e3a0bd)</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(9c0f1b58600355c152426f4c75484342fb7b3f6e)</span> <span class="hljs-comment">// creditingSpk: P2PKHScriptPubKey = pkh(929ea41c96078dcb8a98f5836dbec0dad0c88d46)</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(9c0f1b58600355c152426f4c75484342fb7b3f6e))</span> <span class="hljs-comment">// utxo: TransactionOutput = TransactionOutput(10000 sats,pkh(929ea41c96078dcb8a98f5836dbec0dad0c88d46))</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(cdfa2fd3899c436e5fc73c8539b1cf967cbbd0a1)</span> <span class="hljs-comment">// destinationSPK: P2PKHScriptPubKey = pkh(500ea503ed80ef11b14b99d3c9c2069631d1042d)</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(cdfa2fd3899c436e5fc73c8539b1cf967cbbd0a1)))</span> <span class="hljs-comment">// destinations: Vector[TransactionOutput] = Vector(TransactionOutput(5000 sats,pkh(500ea503ed80ef11b14b99d3c9c2069631d1042d)))</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(9c0f1b58600355c152426f4c75484342fb7b3f6e))),UInt32Impl(0))</span> <span class="hljs-comment">// creditingTx: BaseTransaction = BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(929ea41c96078dcb8a98f5836dbec0dad0c88d46))),UInt32Impl(0))</span>
<span class="hljs-comment">// this is the information we need from the crediting TX</span> <span class="hljs-comment">// this is the information we need from the crediting TX</span>
<span class="hljs-comment">// to properly &quot;link&quot; it in the transaction we are creating</span> <span class="hljs-comment">// to properly &quot;link&quot; it in the transaction we are creating</span>
<span class="hljs-keyword">val</span> outPoint = <span class="hljs-type">TransactionOutPoint</span>(creditingTx.txId, <span class="hljs-type">UInt32</span>.zero) <span class="hljs-keyword">val</span> outPoint = <span class="hljs-type">TransactionOutPoint</span>(creditingTx.txId, <span class="hljs-type">UInt32</span>.zero)
<span class="hljs-comment">// outPoint: TransactionOutPoint = TransactionOutPoint(d12b6fa7335d50ef9ff01739a770d7b6e152ece1e93be16acfcd488317ab4628:0)</span> <span class="hljs-comment">// outPoint: TransactionOutPoint = TransactionOutPoint(0517dcc0d2f143859a526721321d582c6e20d7aa0af7afb9cf893295e0ff01f7: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(d12b6fa7335d50ef9ff01739a770d7b6e152ece1e93be16acfcd488317ab4628:0),EmptyScriptSignature,UInt32Impl(0))</span> <span class="hljs-comment">// input: TransactionInput = TransactionInputImpl(TransactionOutPoint(0517dcc0d2f143859a526721321d582c6e20d7aa0af7afb9cf893295e0ff01f7: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(d12b6fa7335d50ef9ff01739a770d7b6e152ece1e93be16acfcd488317ab4628:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(cdfa2fd3899c436e5fc73c8539b1cf967cbbd0a1))),UInt32Impl(0))</span> <span class="hljs-comment">// builderResult: RawTxBuilderResult = RawTxBuilderResult(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(0517dcc0d2f143859a526721321d582c6e20d7aa0af7afb9cf893295e0ff01f7:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(500ea503ed80ef11b14b99d3c9c2069631d1042d))),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(d12b6fa7335d50ef9ff01739a770d7b6e152ece1e93be16acfcd488317ab4628:0),10000 sats,ECPublicKey(02ff7487cc72bcaa1d59e192d38fc0a3057ae0edcc53ebc94f78f9c5a819606079))</span> <span class="hljs-comment">// inputInfo: P2PKHInputInfo = P2PKHInputInfo(TransactionOutPoint(0517dcc0d2f143859a526721321d582c6e20d7aa0af7afb9cf893295e0ff01f7:0),10000 sats,ECPublicKey(036d9b8eabb066861ad0c286b667da370a2532aa82e8ed4cea7399ced8b5e3a0bd))</span>
<span class="hljs-comment">// this is how much we are going to pay as a fee to the network</span> <span class="hljs-comment">// this is how much we are going to pay as a fee to the network</span>
<span class="hljs-comment">// for this example, we are going to pay 1 satoshi per byte</span> <span class="hljs-comment">// for this example, we are going to pay 1 satoshi per byte</span>
@ -155,18 +155,18 @@ builder += input
<span class="hljs-keyword">val</span> changePrivKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey <span class="hljs-keyword">val</span> changePrivKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey
<span class="hljs-comment">// changePrivKey: ECPrivateKey = Masked(ECPrivateKeyImpl)</span> <span class="hljs-comment">// changePrivKey: ECPrivateKey = Masked(ECPrivateKeyImpl)</span>
<span class="hljs-keyword">val</span> changeSPK = <span class="hljs-type">P2PKHScriptPubKey</span>(pubKey = changePrivKey.publicKey) <span class="hljs-keyword">val</span> changeSPK = <span class="hljs-type">P2PKHScriptPubKey</span>(pubKey = changePrivKey.publicKey)
<span class="hljs-comment">// changeSPK: P2PKHScriptPubKey = pkh(5c62378fce01bbd2cdb4a78f96243336afe8a5a8)</span> <span class="hljs-comment">// changeSPK: P2PKHScriptPubKey = pkh(d330f5177a68534da65b9779a6752c9536f3af38)</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(d12b6fa7335d50ef9ff01739a770d7b6e152ece1e93be16acfcd488317ab4628:0),10000 sats,ECPublicKey(02ff7487cc72bcaa1d59e192d38fc0a3057ae0edcc53ebc94f78f9c5a819606079))),1 sats/byte,pkh(5c62378fce01bbd2cdb4a78f96243336afe8a5a8))</span> <span class="hljs-comment">// finalizer: StandardNonInteractiveFinalizer = StandardNonInteractiveFinalizer(Vector(P2PKHInputInfo(TransactionOutPoint(0517dcc0d2f143859a526721321d582c6e20d7aa0af7afb9cf893295e0ff01f7:0),10000 sats,ECPublicKey(036d9b8eabb066861ad0c286b667da370a2532aa82e8ed4cea7399ced8b5e3a0bd))),1 sats/byte,pkh(d330f5177a68534da65b9779a6752c9536f3af38))</span>
<span class="hljs-comment">// We can now finalize the tx builder result from earlier with this finalizer</span> <span class="hljs-comment">// We can now finalize the tx builder result from earlier with this finalizer</span>
<span class="hljs-keyword">val</span> unsignedTxF: <span class="hljs-type">Future</span>[<span class="hljs-type">Transaction</span>] = finalizer.buildTx(builderResult) <span class="hljs-keyword">val</span> unsignedTxF: <span class="hljs-type">Future</span>[<span class="hljs-type">Transaction</span>] = finalizer.buildTx(builderResult)
<span class="hljs-comment">// unsignedTxF: Future[Transaction] = Future(Success(BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(d12b6fa7335d50ef9ff01739a770d7b6e152ece1e93be16acfcd488317ab4628:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(cdfa2fd3899c436e5fc73c8539b1cf967cbbd0a1)), TransactionOutput(4775 sats,pkh(5c62378fce01bbd2cdb4a78f96243336afe8a5a8))),UInt32Impl(0))))</span> <span class="hljs-comment">// unsignedTxF: Future[Transaction] = Future(Success(BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(0517dcc0d2f143859a526721321d582c6e20d7aa0af7afb9cf893295e0ff01f7:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(500ea503ed80ef11b14b99d3c9c2069631d1042d)), TransactionOutput(4775 sats,pkh(d330f5177a68534da65b9779a6752c9536f3af38))),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(d12b6fa7335d50ef9ff01739a770d7b6e152ece1e93be16acfcd488317ab4628:0),10000 sats,ECPublicKey(02ff7487cc72bcaa1d59e192d38fc0a3057ae0edcc53ebc94f78f9c5a819606079)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(9c0f1b58600355c152426f4c75484342fb7b3f6e))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1)))</span> <span class="hljs-comment">// utxoInfo: ScriptSignatureParams[P2PKHInputInfo] = ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(0517dcc0d2f143859a526721321d582c6e20d7aa0af7afb9cf893295e0ff01f7:0),10000 sats,ECPublicKey(036d9b8eabb066861ad0c286b667da370a2532aa82e8ed4cea7399ced8b5e3a0bd)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(929ea41c96078dcb8a98f5836dbec0dad0c88d46))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1)))</span>
<span class="hljs-comment">// all of the UTXO spending information, since we only have</span> <span class="hljs-comment">// all of the UTXO spending information, since we only have</span>
<span class="hljs-comment">// one input, this is just one element</span> <span class="hljs-comment">// one input, this is just one element</span>
<span class="hljs-keyword">val</span> utxoInfos: <span class="hljs-type">Vector</span>[<span class="hljs-type">ScriptSignatureParams</span>[<span class="hljs-type">InputInfo</span>]] = <span class="hljs-type">Vector</span>(utxoInfo) <span class="hljs-keyword">val</span> utxoInfos: <span class="hljs-type">Vector</span>[<span class="hljs-type">ScriptSignatureParams</span>[<span class="hljs-type">InputInfo</span>]] = <span class="hljs-type">Vector</span>(utxoInfo)
<span class="hljs-comment">// utxoInfos: Vector[ScriptSignatureParams[InputInfo]] = Vector(ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(d12b6fa7335d50ef9ff01739a770d7b6e152ece1e93be16acfcd488317ab4628:0),10000 sats,ECPublicKey(02ff7487cc72bcaa1d59e192d38fc0a3057ae0edcc53ebc94f78f9c5a819606079)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(9c0f1b58600355c152426f4c75484342fb7b3f6e))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1))))</span> <span class="hljs-comment">// utxoInfos: Vector[ScriptSignatureParams[InputInfo]] = Vector(ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(0517dcc0d2f143859a526721321d582c6e20d7aa0af7afb9cf893295e0ff01f7:0),10000 sats,ECPublicKey(036d9b8eabb066861ad0c286b667da370a2532aa82e8ed4cea7399ced8b5e3a0bd)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(929ea41c96078dcb8a98f5836dbec0dad0c88d46))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1))))</span>
<span class="hljs-comment">// Yay! Now we use the RawTxSigner object to sign the tx.</span> <span class="hljs-comment">// Yay! Now we use the RawTxSigner object to sign the tx.</span>
<span class="hljs-comment">// The &#x27;sign&#x27; method is going produce a validly signed transaction</span> <span class="hljs-comment">// The &#x27;sign&#x27; method is going produce a validly signed transaction</span>
@ -201,7 +201,7 @@ builder += input
} }
<span class="hljs-type">Await</span>.result(signedTxF, <span class="hljs-number">30.</span>seconds) <span class="hljs-type">Await</span>.result(signedTxF, <span class="hljs-number">30.</span>seconds)
} }
<span class="hljs-comment">// signedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(d12b6fa7335d50ef9ff01739a770d7b6e152ece1e93be16acfcd488317ab4628:0),P2PKHScriptSignature(ECPublicKey(02ff7487cc72bcaa1d59e192d38fc0a3057ae0edcc53ebc94f78f9c5a819606079), ECDigitalSignature(304402206287d1d9c26da821363cf322fc8c2e761dfb6234d21e40690df352961ca75145022037df680a43b71f99af4810b98c7959ca6754f1e27c774c64ca885eece7971c4601)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(cdfa2fd3899c436e5fc73c8539b1cf967cbbd0a1)), TransactionOutput(4775 sats,pkh(5c62378fce01bbd2cdb4a78f96243336afe8a5a8))),UInt32Impl(0))</span> <span class="hljs-comment">// signedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(0517dcc0d2f143859a526721321d582c6e20d7aa0af7afb9cf893295e0ff01f7:0),P2PKHScriptSignature(ECPublicKey(036d9b8eabb066861ad0c286b667da370a2532aa82e8ed4cea7399ced8b5e3a0bd), ECDigitalSignature(304402201498f80042ae8fd52adbabda826815a7e0d25d7e2dca1167a3a3a9278ac0dcb80220230973cb0c74953f293c785654fa7ab9e4ba177ca236f7548b5d058741d4858301)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(500ea503ed80ef11b14b99d3c9c2069631d1042d)), TransactionOutput(4775 sats,pkh(d330f5177a68534da65b9779a6752c9536f3af38))),UInt32Impl(0))</span>
</code></pre> </code></pre>
<pre><code class="hljs css language-scala">signedTx.inputs.length <pre><code class="hljs css language-scala">signedTx.inputs.length
<span class="hljs-comment">// res2: Int = 1</span> <span class="hljs-comment">// res2: Int = 1</span>
@ -211,7 +211,7 @@ signedTx.outputs.length
<span class="hljs-comment">//remember, you can call .hex on any bitcoin-s data structure to get the hex representation!</span> <span class="hljs-comment">//remember, you can call .hex on any bitcoin-s data structure to get the hex representation!</span>
signedTx.hex signedTx.hex
<span class="hljs-comment">// res4: String = 02000000012846ab178348cdcf6ae13be9e1ec52e1b6d770a73917f09fef505d33a76f2bd1000000006a47304402206287d1d9c26da821363cf322fc8c2e761dfb6234d21e40690df352961ca75145022037df680a43b71f99af4810b98c7959ca6754f1e27c774c64ca885eece7971c46012102ff7487cc72bcaa1d59e192d38fc0a3057ae0edcc53ebc94f78f9c5a819606079000000000288130000000000001976a914cdfa2fd3899c436e5fc73c8539b1cf967cbbd0a188aca7120000000000001976a9145c62378fce01bbd2cdb4a78f96243336afe8a5a888ac00000000</span> <span class="hljs-comment">// res4: String = 0200000001f701ffe0953289cfb9aff70aaad7206e2c581d322167529a8543f1d2c0dc1705000000006a47304402201498f80042ae8fd52adbabda826815a7e0d25d7e2dca1167a3a3a9278ac0dcb80220230973cb0c74953f293c785654fa7ab9e4ba177ca236f7548b5d058741d485830121036d9b8eabb066861ad0c286b667da370a2532aa82e8ed4cea7399ced8b5e3a0bd000000000288130000000000001976a914500ea503ed80ef11b14b99d3c9c2069631d1042d88aca7120000000000001976a914d330f5177a68534da65b9779a6752c9536f3af3888ac00000000</span>
</code></pre> </code></pre>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/next/core/psbts"><span class="arrow-prev">← </span><span>Partially Signed Bitcoin Transactions</span></a><a class="docs-next button" href="/docs/next/core/lightning-network"><span>Lightning Network Data Types</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/favicon.ico" alt="bitcoin-s" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/getting-started">Getting Started</a><a href="/docs/en/core/core-intro">Guides</a><a href="/api/org/bitcoins">API Reference</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="https://join.slack.com/t/suredbits/shared_invite/zt-eavycu0x-WQL7XOakzQo8tAy7jHHZUw" target="_blank" rel="noreferrer noopener">Slack</a><a href="https://gitter.im/bitcoin-s-core/">Gitter chat</a></div><div><h5>More</h5><a href="https://github.com/bitcoin-s/bitcoin-s">GitHub</a><a class="github-button" href="https://github.com/bitcoin-s/bitcoin-s" data-icon="octicon-star" data-count-href="/bitcoin-s/bitcoin-s-core/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2021 Suredbits &amp; the bitcoin-s developers</section></footer></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script><script> </span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/next/core/psbts"><span class="arrow-prev">← </span><span>Partially Signed Bitcoin Transactions</span></a><a class="docs-next button" href="/docs/next/core/lightning-network"><span>Lightning Network Data Types</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/favicon.ico" alt="bitcoin-s" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/getting-started">Getting Started</a><a href="/docs/en/core/core-intro">Guides</a><a href="/api/org/bitcoins">API Reference</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="https://join.slack.com/t/suredbits/shared_invite/zt-eavycu0x-WQL7XOakzQo8tAy7jHHZUw" target="_blank" rel="noreferrer noopener">Slack</a><a href="https://gitter.im/bitcoin-s-core/">Gitter chat</a></div><div><h5>More</h5><a href="https://github.com/bitcoin-s/bitcoin-s">GitHub</a><a class="github-button" href="https://github.com/bitcoin-s/bitcoin-s" data-icon="octicon-star" data-count-href="/bitcoin-s/bitcoin-s-core/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2021 Suredbits &amp; the bitcoin-s developers</section></footer></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script><script>
document.addEventListener('keyup', function(e) { 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@3349c998[Running, parallelism = 2, size = 2, active = 0, running = 0, steals = 33, tasks = 0, submissions = 0]</span> <span class="hljs-comment">// ec: ExecutionContext = scala.concurrent.impl.ExecutionContextImpl$$anon$3@1f400dfb[Running, parallelism = 2, size = 2, active = 0, running = 0, steals = 37, tasks = 0, submissions = 0]</span>
<span class="hljs-comment">// Initialize a transaction builder</span> <span class="hljs-comment">// Initialize a transaction builder</span>
<span class="hljs-keyword">val</span> builder = <span class="hljs-type">RawTxBuilder</span>() <span class="hljs-keyword">val</span> builder = <span class="hljs-type">RawTxBuilder</span>()
@ -74,19 +74,19 @@
<span class="hljs-keyword">val</span> privKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey <span class="hljs-keyword">val</span> privKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey
<span class="hljs-comment">// privKey: ECPrivateKey = Masked(ECPrivateKeyImpl)</span> <span class="hljs-comment">// privKey: ECPrivateKey = Masked(ECPrivateKeyImpl)</span>
<span class="hljs-keyword">val</span> pubKey = privKey.publicKey <span class="hljs-keyword">val</span> pubKey = privKey.publicKey
<span class="hljs-comment">// pubKey: ECPublicKey = ECPublicKey(02ff7487cc72bcaa1d59e192d38fc0a3057ae0edcc53ebc94f78f9c5a819606079)</span> <span class="hljs-comment">// pubKey: ECPublicKey = ECPublicKey(036d9b8eabb066861ad0c286b667da370a2532aa82e8ed4cea7399ced8b5e3a0bd)</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(9c0f1b58600355c152426f4c75484342fb7b3f6e)</span> <span class="hljs-comment">// creditingSpk: P2PKHScriptPubKey = pkh(929ea41c96078dcb8a98f5836dbec0dad0c88d46)</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(9c0f1b58600355c152426f4c75484342fb7b3f6e))</span> <span class="hljs-comment">// utxo: TransactionOutput = TransactionOutput(10000 sats,pkh(929ea41c96078dcb8a98f5836dbec0dad0c88d46))</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(cdfa2fd3899c436e5fc73c8539b1cf967cbbd0a1)</span> <span class="hljs-comment">// destinationSPK: P2PKHScriptPubKey = pkh(500ea503ed80ef11b14b99d3c9c2069631d1042d)</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(cdfa2fd3899c436e5fc73c8539b1cf967cbbd0a1)))</span> <span class="hljs-comment">// destinations: Vector[TransactionOutput] = Vector(TransactionOutput(5000 sats,pkh(500ea503ed80ef11b14b99d3c9c2069631d1042d)))</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(9c0f1b58600355c152426f4c75484342fb7b3f6e))),UInt32Impl(0))</span> <span class="hljs-comment">// creditingTx: BaseTransaction = BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(929ea41c96078dcb8a98f5836dbec0dad0c88d46))),UInt32Impl(0))</span>
<span class="hljs-comment">// this is the information we need from the crediting TX</span> <span class="hljs-comment">// this is the information we need from the crediting TX</span>
<span class="hljs-comment">// to properly &quot;link&quot; it in the transaction we are creating</span> <span class="hljs-comment">// to properly &quot;link&quot; it in the transaction we are creating</span>
<span class="hljs-keyword">val</span> outPoint = <span class="hljs-type">TransactionOutPoint</span>(creditingTx.txId, <span class="hljs-type">UInt32</span>.zero) <span class="hljs-keyword">val</span> outPoint = <span class="hljs-type">TransactionOutPoint</span>(creditingTx.txId, <span class="hljs-type">UInt32</span>.zero)
<span class="hljs-comment">// outPoint: TransactionOutPoint = TransactionOutPoint(d12b6fa7335d50ef9ff01739a770d7b6e152ece1e93be16acfcd488317ab4628:0)</span> <span class="hljs-comment">// outPoint: TransactionOutPoint = TransactionOutPoint(0517dcc0d2f143859a526721321d582c6e20d7aa0af7afb9cf893295e0ff01f7: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(d12b6fa7335d50ef9ff01739a770d7b6e152ece1e93be16acfcd488317ab4628:0),EmptyScriptSignature,UInt32Impl(0))</span> <span class="hljs-comment">// input: TransactionInput = TransactionInputImpl(TransactionOutPoint(0517dcc0d2f143859a526721321d582c6e20d7aa0af7afb9cf893295e0ff01f7: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(d12b6fa7335d50ef9ff01739a770d7b6e152ece1e93be16acfcd488317ab4628:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(cdfa2fd3899c436e5fc73c8539b1cf967cbbd0a1))),UInt32Impl(0))</span> <span class="hljs-comment">// builderResult: RawTxBuilderResult = RawTxBuilderResult(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(0517dcc0d2f143859a526721321d582c6e20d7aa0af7afb9cf893295e0ff01f7:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(500ea503ed80ef11b14b99d3c9c2069631d1042d))),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(d12b6fa7335d50ef9ff01739a770d7b6e152ece1e93be16acfcd488317ab4628:0),10000 sats,ECPublicKey(02ff7487cc72bcaa1d59e192d38fc0a3057ae0edcc53ebc94f78f9c5a819606079))</span> <span class="hljs-comment">// inputInfo: P2PKHInputInfo = P2PKHInputInfo(TransactionOutPoint(0517dcc0d2f143859a526721321d582c6e20d7aa0af7afb9cf893295e0ff01f7:0),10000 sats,ECPublicKey(036d9b8eabb066861ad0c286b667da370a2532aa82e8ed4cea7399ced8b5e3a0bd))</span>
<span class="hljs-comment">// this is how much we are going to pay as a fee to the network</span> <span class="hljs-comment">// this is how much we are going to pay as a fee to the network</span>
<span class="hljs-comment">// for this example, we are going to pay 1 satoshi per byte</span> <span class="hljs-comment">// for this example, we are going to pay 1 satoshi per byte</span>
@ -155,18 +155,18 @@ builder += input
<span class="hljs-keyword">val</span> changePrivKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey <span class="hljs-keyword">val</span> changePrivKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey
<span class="hljs-comment">// changePrivKey: ECPrivateKey = Masked(ECPrivateKeyImpl)</span> <span class="hljs-comment">// changePrivKey: ECPrivateKey = Masked(ECPrivateKeyImpl)</span>
<span class="hljs-keyword">val</span> changeSPK = <span class="hljs-type">P2PKHScriptPubKey</span>(pubKey = changePrivKey.publicKey) <span class="hljs-keyword">val</span> changeSPK = <span class="hljs-type">P2PKHScriptPubKey</span>(pubKey = changePrivKey.publicKey)
<span class="hljs-comment">// changeSPK: P2PKHScriptPubKey = pkh(5c62378fce01bbd2cdb4a78f96243336afe8a5a8)</span> <span class="hljs-comment">// changeSPK: P2PKHScriptPubKey = pkh(d330f5177a68534da65b9779a6752c9536f3af38)</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(d12b6fa7335d50ef9ff01739a770d7b6e152ece1e93be16acfcd488317ab4628:0),10000 sats,ECPublicKey(02ff7487cc72bcaa1d59e192d38fc0a3057ae0edcc53ebc94f78f9c5a819606079))),1 sats/byte,pkh(5c62378fce01bbd2cdb4a78f96243336afe8a5a8))</span> <span class="hljs-comment">// finalizer: StandardNonInteractiveFinalizer = StandardNonInteractiveFinalizer(Vector(P2PKHInputInfo(TransactionOutPoint(0517dcc0d2f143859a526721321d582c6e20d7aa0af7afb9cf893295e0ff01f7:0),10000 sats,ECPublicKey(036d9b8eabb066861ad0c286b667da370a2532aa82e8ed4cea7399ced8b5e3a0bd))),1 sats/byte,pkh(d330f5177a68534da65b9779a6752c9536f3af38))</span>
<span class="hljs-comment">// We can now finalize the tx builder result from earlier with this finalizer</span> <span class="hljs-comment">// We can now finalize the tx builder result from earlier with this finalizer</span>
<span class="hljs-keyword">val</span> unsignedTxF: <span class="hljs-type">Future</span>[<span class="hljs-type">Transaction</span>] = finalizer.buildTx(builderResult) <span class="hljs-keyword">val</span> unsignedTxF: <span class="hljs-type">Future</span>[<span class="hljs-type">Transaction</span>] = finalizer.buildTx(builderResult)
<span class="hljs-comment">// unsignedTxF: Future[Transaction] = Future(Success(BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(d12b6fa7335d50ef9ff01739a770d7b6e152ece1e93be16acfcd488317ab4628:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(cdfa2fd3899c436e5fc73c8539b1cf967cbbd0a1)), TransactionOutput(4775 sats,pkh(5c62378fce01bbd2cdb4a78f96243336afe8a5a8))),UInt32Impl(0))))</span> <span class="hljs-comment">// unsignedTxF: Future[Transaction] = Future(Success(BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(0517dcc0d2f143859a526721321d582c6e20d7aa0af7afb9cf893295e0ff01f7:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(500ea503ed80ef11b14b99d3c9c2069631d1042d)), TransactionOutput(4775 sats,pkh(d330f5177a68534da65b9779a6752c9536f3af38))),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(d12b6fa7335d50ef9ff01739a770d7b6e152ece1e93be16acfcd488317ab4628:0),10000 sats,ECPublicKey(02ff7487cc72bcaa1d59e192d38fc0a3057ae0edcc53ebc94f78f9c5a819606079)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(9c0f1b58600355c152426f4c75484342fb7b3f6e))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1)))</span> <span class="hljs-comment">// utxoInfo: ScriptSignatureParams[P2PKHInputInfo] = ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(0517dcc0d2f143859a526721321d582c6e20d7aa0af7afb9cf893295e0ff01f7:0),10000 sats,ECPublicKey(036d9b8eabb066861ad0c286b667da370a2532aa82e8ed4cea7399ced8b5e3a0bd)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(929ea41c96078dcb8a98f5836dbec0dad0c88d46))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1)))</span>
<span class="hljs-comment">// all of the UTXO spending information, since we only have</span> <span class="hljs-comment">// all of the UTXO spending information, since we only have</span>
<span class="hljs-comment">// one input, this is just one element</span> <span class="hljs-comment">// one input, this is just one element</span>
<span class="hljs-keyword">val</span> utxoInfos: <span class="hljs-type">Vector</span>[<span class="hljs-type">ScriptSignatureParams</span>[<span class="hljs-type">InputInfo</span>]] = <span class="hljs-type">Vector</span>(utxoInfo) <span class="hljs-keyword">val</span> utxoInfos: <span class="hljs-type">Vector</span>[<span class="hljs-type">ScriptSignatureParams</span>[<span class="hljs-type">InputInfo</span>]] = <span class="hljs-type">Vector</span>(utxoInfo)
<span class="hljs-comment">// utxoInfos: Vector[ScriptSignatureParams[InputInfo]] = Vector(ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(d12b6fa7335d50ef9ff01739a770d7b6e152ece1e93be16acfcd488317ab4628:0),10000 sats,ECPublicKey(02ff7487cc72bcaa1d59e192d38fc0a3057ae0edcc53ebc94f78f9c5a819606079)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(9c0f1b58600355c152426f4c75484342fb7b3f6e))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1))))</span> <span class="hljs-comment">// utxoInfos: Vector[ScriptSignatureParams[InputInfo]] = Vector(ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(0517dcc0d2f143859a526721321d582c6e20d7aa0af7afb9cf893295e0ff01f7:0),10000 sats,ECPublicKey(036d9b8eabb066861ad0c286b667da370a2532aa82e8ed4cea7399ced8b5e3a0bd)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(929ea41c96078dcb8a98f5836dbec0dad0c88d46))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1))))</span>
<span class="hljs-comment">// Yay! Now we use the RawTxSigner object to sign the tx.</span> <span class="hljs-comment">// Yay! Now we use the RawTxSigner object to sign the tx.</span>
<span class="hljs-comment">// The &#x27;sign&#x27; method is going produce a validly signed transaction</span> <span class="hljs-comment">// The &#x27;sign&#x27; method is going produce a validly signed transaction</span>
@ -201,7 +201,7 @@ builder += input
} }
<span class="hljs-type">Await</span>.result(signedTxF, <span class="hljs-number">30.</span>seconds) <span class="hljs-type">Await</span>.result(signedTxF, <span class="hljs-number">30.</span>seconds)
} }
<span class="hljs-comment">// signedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(d12b6fa7335d50ef9ff01739a770d7b6e152ece1e93be16acfcd488317ab4628:0),P2PKHScriptSignature(ECPublicKey(02ff7487cc72bcaa1d59e192d38fc0a3057ae0edcc53ebc94f78f9c5a819606079), ECDigitalSignature(304402206287d1d9c26da821363cf322fc8c2e761dfb6234d21e40690df352961ca75145022037df680a43b71f99af4810b98c7959ca6754f1e27c774c64ca885eece7971c4601)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(cdfa2fd3899c436e5fc73c8539b1cf967cbbd0a1)), TransactionOutput(4775 sats,pkh(5c62378fce01bbd2cdb4a78f96243336afe8a5a8))),UInt32Impl(0))</span> <span class="hljs-comment">// signedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(0517dcc0d2f143859a526721321d582c6e20d7aa0af7afb9cf893295e0ff01f7:0),P2PKHScriptSignature(ECPublicKey(036d9b8eabb066861ad0c286b667da370a2532aa82e8ed4cea7399ced8b5e3a0bd), ECDigitalSignature(304402201498f80042ae8fd52adbabda826815a7e0d25d7e2dca1167a3a3a9278ac0dcb80220230973cb0c74953f293c785654fa7ab9e4ba177ca236f7548b5d058741d4858301)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(500ea503ed80ef11b14b99d3c9c2069631d1042d)), TransactionOutput(4775 sats,pkh(d330f5177a68534da65b9779a6752c9536f3af38))),UInt32Impl(0))</span>
</code></pre> </code></pre>
<pre><code class="hljs css language-scala">signedTx.inputs.length <pre><code class="hljs css language-scala">signedTx.inputs.length
<span class="hljs-comment">// res2: Int = 1</span> <span class="hljs-comment">// res2: Int = 1</span>
@ -211,7 +211,7 @@ signedTx.outputs.length
<span class="hljs-comment">//remember, you can call .hex on any bitcoin-s data structure to get the hex representation!</span> <span class="hljs-comment">//remember, you can call .hex on any bitcoin-s data structure to get the hex representation!</span>
signedTx.hex signedTx.hex
<span class="hljs-comment">// res4: String = 02000000012846ab178348cdcf6ae13be9e1ec52e1b6d770a73917f09fef505d33a76f2bd1000000006a47304402206287d1d9c26da821363cf322fc8c2e761dfb6234d21e40690df352961ca75145022037df680a43b71f99af4810b98c7959ca6754f1e27c774c64ca885eece7971c46012102ff7487cc72bcaa1d59e192d38fc0a3057ae0edcc53ebc94f78f9c5a819606079000000000288130000000000001976a914cdfa2fd3899c436e5fc73c8539b1cf967cbbd0a188aca7120000000000001976a9145c62378fce01bbd2cdb4a78f96243336afe8a5a888ac00000000</span> <span class="hljs-comment">// res4: String = 0200000001f701ffe0953289cfb9aff70aaad7206e2c581d322167529a8543f1d2c0dc1705000000006a47304402201498f80042ae8fd52adbabda826815a7e0d25d7e2dca1167a3a3a9278ac0dcb80220230973cb0c74953f293c785654fa7ab9e4ba177ca236f7548b5d058741d485830121036d9b8eabb066861ad0c286b667da370a2532aa82e8ed4cea7399ced8b5e3a0bd000000000288130000000000001976a914500ea503ed80ef11b14b99d3c9c2069631d1042d88aca7120000000000001976a914d330f5177a68534da65b9779a6752c9536f3af3888ac00000000</span>
</code></pre> </code></pre>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/next/core/psbts"><span class="arrow-prev">← </span><span>Partially Signed Bitcoin Transactions</span></a><a class="docs-next button" href="/docs/next/core/lightning-network"><span>Lightning Network Data Types</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/favicon.ico" alt="bitcoin-s" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/getting-started">Getting Started</a><a href="/docs/en/core/core-intro">Guides</a><a href="/api/org/bitcoins">API Reference</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="https://join.slack.com/t/suredbits/shared_invite/zt-eavycu0x-WQL7XOakzQo8tAy7jHHZUw" target="_blank" rel="noreferrer noopener">Slack</a><a href="https://gitter.im/bitcoin-s-core/">Gitter chat</a></div><div><h5>More</h5><a href="https://github.com/bitcoin-s/bitcoin-s">GitHub</a><a class="github-button" href="https://github.com/bitcoin-s/bitcoin-s" data-icon="octicon-star" data-count-href="/bitcoin-s/bitcoin-s-core/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2021 Suredbits &amp; the bitcoin-s developers</section></footer></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script><script> </span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/next/core/psbts"><span class="arrow-prev">← </span><span>Partially Signed Bitcoin Transactions</span></a><a class="docs-next button" href="/docs/next/core/lightning-network"><span>Lightning Network Data Types</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/favicon.ico" alt="bitcoin-s" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/getting-started">Getting Started</a><a href="/docs/en/core/core-intro">Guides</a><a href="/api/org/bitcoins">API Reference</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="https://join.slack.com/t/suredbits/shared_invite/zt-eavycu0x-WQL7XOakzQo8tAy7jHHZUw" target="_blank" rel="noreferrer noopener">Slack</a><a href="https://gitter.im/bitcoin-s-core/">Gitter chat</a></div><div><h5>More</h5><a href="https://github.com/bitcoin-s/bitcoin-s">GitHub</a><a class="github-button" href="https://github.com/bitcoin-s/bitcoin-s" data-icon="octicon-star" data-count-href="/bitcoin-s/bitcoin-s-core/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2021 Suredbits &amp; the bitcoin-s developers</section></footer></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script><script>
document.addEventListener('keyup', function(e) { 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(3044022069733e44742895684e717e93f588398c3a0a34b183a27c4e7552b55d52ad5e9a02205a6a80bbee76a64b05aa4281338c0de4a3212f7b8d4024e157d71e3866eea289)</span> <span class="hljs-comment">// res0: ECDigitalSignature = ECDigitalSignature(304402202775b01294a67ffe122341889c3ceb94072145d39cf19e4b1dd85abde4c3e32d02204ecbe581741381c8b916cf0786d1d488720370a2929a3bb1bb00ced8579dafc3)</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(3045022100fa9fcd5e0c64ab6decd4c4102112a054a1a3be92e49b24c8af88eb22ec88021b022062cecd0b2c92794fc935f95d7c640603901d3a71babe4080dfc450600db804bd)</span> <span class="hljs-comment">// res1: ECDigitalSignature = ECDigitalSignature(3045022100bfb7dfda2935888d027fe4ece5607da6f55802183e5bcd9b7391a1e6b27e354d02206e43ff453e59c35e19bbfb6e52fdb2df4d0d44c7fd31f3febd7c343a22400234)</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(3044022069733e44742895684e717e93f588398c3a0a34b183a27c4e7552b55d52ad5e9a02205a6a80bbee76a64b05aa4281338c0de4a3212f7b8d4024e157d71e3866eea289)</span> <span class="hljs-comment">// res0: ECDigitalSignature = ECDigitalSignature(304402202775b01294a67ffe122341889c3ceb94072145d39cf19e4b1dd85abde4c3e32d02204ecbe581741381c8b916cf0786d1d488720370a2929a3bb1bb00ced8579dafc3)</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(3045022100fa9fcd5e0c64ab6decd4c4102112a054a1a3be92e49b24c8af88eb22ec88021b022062cecd0b2c92794fc935f95d7c640603901d3a71babe4080dfc450600db804bd)</span> <span class="hljs-comment">// res1: ECDigitalSignature = ECDigitalSignature(3045022100bfb7dfda2935888d027fe4ece5607da6f55802183e5bcd9b7391a1e6b27e354d02206e43ff453e59c35e19bbfb6e52fdb2df4d0d44c7fd31f3febd7c343a22400234)</span>
</code></pre> </code></pre>
<p>With <code>ExtSign</code>, you can use <code>ExtPrivateKey</code> to sign transactions inside of <code>TxBuilder</code> since <code>UTXOSpendingInfo</code> takes in <code>Sign</code> as a parameter.</p> <p>With <code>ExtSign</code>, you can use <code>ExtPrivateKey</code> to sign transactions inside of <code>TxBuilder</code> since <code>UTXOSpendingInfo</code> takes in <code>Sign</code> as a parameter.</p>
<p>You can also provide a <code>path</code> to use to derive a child <code>ExtPrivateKey</code>, and then sign with that child private key</p> <p>You can also provide a <code>path</code> to use to derive a child <code>ExtPrivateKey</code>, and then sign with that child private key</p>

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

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

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

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

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

@ -77,14 +77,14 @@
<span class="hljs-comment">//get 256 bits of random entropy</span> <span class="hljs-comment">//get 256 bits of random entropy</span>
<span class="hljs-keyword">val</span> entropy = <span class="hljs-type">MnemonicCode</span>.getEntropy256Bits <span class="hljs-keyword">val</span> entropy = <span class="hljs-type">MnemonicCode</span>.getEntropy256Bits
<span class="hljs-comment">// entropy: scodec.bits.BitVector = BitVector(256 bits, 0x0efd2da69bab3b699252b20700aa070e9660400923527af17762055db3ac7103)</span> <span class="hljs-comment">// entropy: scodec.bits.BitVector = BitVector(256 bits, 0x768bdbc062b7b8bc093058c4311c325cc91339e375e0d73351450cef356f182c)</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(auction, truly, have, dance, recipe, regular, enable, film, alpha, aim, limb, brush, gravity, cactus, cause, heart, kit, merry, sudden, apple, swamp, stomach, series, hen)</span> <span class="hljs-comment">// Vector(isolate, gain, useless, shell, knee, fun, cave, arch, service, material, arrive, ridge, muffin, ostrich, miss, rose, strong, once, eyebrow, border, viable, resource, gaze, paddle)</span>
</code></pre> </code></pre>
<p>Now that we have a <code>MnemonicCode</code> that was securely generated, we need to now create <code>KeyManagerParams</code> which tells us how to generate <p>Now that we have a <code>MnemonicCode</code> that was securely generated, we need to now create <code>KeyManagerParams</code> which tells us how to generate
generate specific kinds of addresses for wallets.</p> generate specific kinds of addresses for wallets.</p>
@ -99,7 +99,7 @@ generate specific kinds of addresses for wallets.</p>
<pre><code class="hljs css language-scala"><span class="hljs-comment">//this will create a temp directory with the prefix &#x27;key-manager-example` that will</span> <pre><code class="hljs css language-scala"><span class="hljs-comment">//this will create a temp directory with the prefix &#x27;key-manager-example` that will</span>
<span class="hljs-comment">//have a file in it called &quot;encrypted-bitcoin-s-seed.json&quot;</span> <span class="hljs-comment">//have a file in it called &quot;encrypted-bitcoin-s-seed.json&quot;</span>
<span class="hljs-keyword">val</span> seedPath = <span class="hljs-type">Files</span>.createTempDirectory(<span class="hljs-string">&quot;key-manager-example&quot;</span>).resolve(<span class="hljs-type">WalletStorage</span>.<span class="hljs-type">ENCRYPTED_SEED_FILE_NAME</span>) <span class="hljs-keyword">val</span> seedPath = <span class="hljs-type">Files</span>.createTempDirectory(<span class="hljs-string">&quot;key-manager-example&quot;</span>).resolve(<span class="hljs-type">WalletStorage</span>.<span class="hljs-type">ENCRYPTED_SEED_FILE_NAME</span>)
<span class="hljs-comment">// seedPath: Path = /tmp/key-manager-example6643020899267846985/encrypted-bitcoin-s-seed.json</span> <span class="hljs-comment">// seedPath: Path = /tmp/key-manager-example7506751604000552319/encrypted-bitcoin-s-seed.json</span>
<span class="hljs-comment">//let&#x27;s create a native segwit key manager</span> <span class="hljs-comment">//let&#x27;s create a native segwit key manager</span>
<span class="hljs-keyword">val</span> purpose = <span class="hljs-type">HDPurposes</span>.<span class="hljs-type">SegWit</span> <span class="hljs-keyword">val</span> purpose = <span class="hljs-type">HDPurposes</span>.<span class="hljs-type">SegWit</span>
@ -110,19 +110,19 @@ generate specific kinds of addresses for wallets.</p>
<span class="hljs-comment">// network: RegTest.type = RegTest</span> <span class="hljs-comment">// network: RegTest.type = RegTest</span>
<span class="hljs-keyword">val</span> kmParams = <span class="hljs-type">KeyManagerParams</span>(seedPath, purpose, network) <span class="hljs-keyword">val</span> kmParams = <span class="hljs-type">KeyManagerParams</span>(seedPath, purpose, network)
<span class="hljs-comment">// kmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example6643020899267846985/encrypted-bitcoin-s-seed.json,m/84&#x27;,RegTest)</span> <span class="hljs-comment">// kmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example7506751604000552319/encrypted-bitcoin-s-seed.json,m/84&#x27;,RegTest)</span>
<span class="hljs-keyword">val</span> aesPasswordOpt = <span class="hljs-type">Some</span>(<span class="hljs-type">AesPassword</span>.fromString(<span class="hljs-string">&quot;password&quot;</span>)) <span class="hljs-keyword">val</span> aesPasswordOpt = <span class="hljs-type">Some</span>(<span class="hljs-type">AesPassword</span>.fromString(<span class="hljs-string">&quot;password&quot;</span>))
<span class="hljs-comment">// aesPasswordOpt: Some[AesPassword] = Some(Masked(AesPassword))</span> <span class="hljs-comment">// aesPasswordOpt: Some[AesPassword] = Some(Masked(AesPassword))</span>
<span class="hljs-keyword">val</span> km = <span class="hljs-type">BIP39KeyManager</span>.initializeWithMnemonic(aesPasswordOpt, mnemonic, <span class="hljs-type">None</span>, kmParams) <span class="hljs-keyword">val</span> km = <span class="hljs-type">BIP39KeyManager</span>.initializeWithMnemonic(aesPasswordOpt, mnemonic, <span class="hljs-type">None</span>, kmParams)
<span class="hljs-comment">// km: Either[KeyManagerInitializeError, BIP39KeyManager] = Right(org.bitcoins.keymanager.bip39.BIP39KeyManager@139d4b68)</span> <span class="hljs-comment">// km: Either[KeyManagerInitializeError, BIP39KeyManager] = Right(org.bitcoins.keymanager.bip39.BIP39KeyManager@48b0ccb)</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 = vpub5SLqN2bLY4WeaMR9w1Rog8b6aavK6qebG7rTVbcNN7dCn24fzYeUN446s9Y39TCr43teTGmkRaDwY8yJyb1YVt9roy2EtErTohdy4845WNQ</span> <span class="hljs-comment">// rootXPub: ExtPublicKey = vpub5SLqN2bLY4WeXyoAWzzaMbnDwhxxzk9i1mBWSoBkT4k3zpukFW3catjBFKFBUSdaBrxP9btfUB4ViasH4Kz2LXcpBVefK37FF8KJrwQq469</span>
println(rootXPub) println(rootXPub)
<span class="hljs-comment">// vpub5SLqN2bLY4WeaMR9w1Rog8b6aavK6qebG7rTVbcNN7dCn24fzYeUN446s9Y39TCr43teTGmkRaDwY8yJyb1YVt9roy2EtErTohdy4845WNQ</span> <span class="hljs-comment">// vpub5SLqN2bLY4WeXyoAWzzaMbnDwhxxzk9i1mBWSoBkT4k3zpukFW3catjBFKFBUSdaBrxP9btfUB4ViasH4Kz2LXcpBVefK37FF8KJrwQq469</span>
</code></pre> </code></pre>
<p>Which should print something that looks like this</p> <p>Which should print something that looks like this</p>
<p><code>vpub5SLqN2bLY4WeXxMqwJHJFBEwxSscGB2uDUnsTS3edVjZEwTrQDFDNqoR2xLqARQPabGaXsHSTenTRcqm2EnB9MpuC4vSk3LqSgNmGGZtuq7</code></p> <p><code>vpub5SLqN2bLY4WeXxMqwJHJFBEwxSscGB2uDUnsTS3edVjZEwTrQDFDNqoR2xLqARQPabGaXsHSTenTRcqm2EnB9MpuC4vSk3LqSgNmGGZtuq7</code></p>
@ -131,17 +131,17 @@ println(rootXPub)
again after initializing it once. You can use the same <code>mnemonic</code> for different networks, which you control <code>KeyManagerParams</code>.</p> again after initializing it once. You can use the same <code>mnemonic</code> for different networks, which you control <code>KeyManagerParams</code>.</p>
<pre><code class="hljs css language-scala"><span class="hljs-comment">//let&#x27;s create a nested segwit key manager for mainnet</span> <pre><code class="hljs css language-scala"><span class="hljs-comment">//let&#x27;s create a nested segwit key manager for mainnet</span>
<span class="hljs-keyword">val</span> mainnetKmParams = <span class="hljs-type">KeyManagerParams</span>(seedPath, <span class="hljs-type">HDPurposes</span>.<span class="hljs-type">SegWit</span>, <span class="hljs-type">MainNet</span>) <span class="hljs-keyword">val</span> mainnetKmParams = <span class="hljs-type">KeyManagerParams</span>(seedPath, <span class="hljs-type">HDPurposes</span>.<span class="hljs-type">SegWit</span>, <span class="hljs-type">MainNet</span>)
<span class="hljs-comment">// mainnetKmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example6643020899267846985/encrypted-bitcoin-s-seed.json,m/84&#x27;,MainNet)</span> <span class="hljs-comment">// mainnetKmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example7506751604000552319/encrypted-bitcoin-s-seed.json,m/84&#x27;,MainNet)</span>
<span class="hljs-comment">//we do not need to all `initializeWithMnemonic()` again as we have saved the seed to dis</span> <span class="hljs-comment">//we do not need to all `initializeWithMnemonic()` again as we have saved the seed to dis</span>
<span class="hljs-keyword">val</span> mainnetKeyManager = <span class="hljs-type">BIP39KeyManager</span>.fromMnemonic(mnemonic, mainnetKmParams, <span class="hljs-type">None</span>, <span class="hljs-type">Instant</span>.now) <span class="hljs-keyword">val</span> mainnetKeyManager = <span class="hljs-type">BIP39KeyManager</span>.fromMnemonic(mnemonic, mainnetKmParams, <span class="hljs-type">None</span>, <span class="hljs-type">Instant</span>.now)
<span class="hljs-comment">// mainnetKeyManager: BIP39KeyManager = org.bitcoins.keymanager.bip39.BIP39KeyManager@7531bb23</span> <span class="hljs-comment">// mainnetKeyManager: BIP39KeyManager = org.bitcoins.keymanager.bip39.BIP39KeyManager@174fc3ac</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 = zpub6jftahH18ngZyYBdGSaJWUy7GTW6sKcavZwLdBBut98izRKb1BJirJgewyNP95pXgcMsTB9zGDe95HRZrNfbgptGHKowDt8QtbtYcR4zVC5</span> <span class="hljs-comment">// mainnetXpub: ExtPublicKey = zpub6jftahH18ngZwAZdrS95BxAEdaYkmE7hgDGPaNmHy6FaDEAfG8hs59MjL95XU5FFpRRc9WGuJpUhFjKXw7e5XUMDerSMegPCL2ZtREkyBro</span>
println(mainnetXpub) println(mainnetXpub)
<span class="hljs-comment">// zpub6jftahH18ngZyYBdGSaJWUy7GTW6sKcavZwLdBBut98izRKb1BJirJgewyNP95pXgcMsTB9zGDe95HRZrNfbgptGHKowDt8QtbtYcR4zVC5</span> <span class="hljs-comment">// zpub6jftahH18ngZwAZdrS95BxAEdaYkmE7hgDGPaNmHy6FaDEAfG8hs59MjL95XU5FFpRRc9WGuJpUhFjKXw7e5XUMDerSMegPCL2ZtREkyBro</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, 0x0efd2da69bab3b699252b20700aa070e9660400923527af17762055db3ac7103)</span> <span class="hljs-comment">// entropy: scodec.bits.BitVector = BitVector(256 bits, 0x768bdbc062b7b8bc093058c4311c325cc91339e375e0d73351450cef356f182c)</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(auction, truly, have, dance, recipe, regular, enable, film, alpha, aim, limb, brush, gravity, cactus, cause, heart, kit, merry, sudden, apple, swamp, stomach, series, hen)</span> <span class="hljs-comment">// Vector(isolate, gain, useless, shell, knee, fun, cave, arch, service, material, arrive, ridge, muffin, ostrich, miss, rose, strong, once, eyebrow, border, viable, resource, gaze, paddle)</span>
</code></pre> </code></pre>
<p>Now that we have a <code>MnemonicCode</code> that was securely generated, we need to now create <code>KeyManagerParams</code> which tells us how to generate <p>Now that we have a <code>MnemonicCode</code> that was securely generated, we need to now create <code>KeyManagerParams</code> which tells us how to generate
generate specific kinds of addresses for wallets.</p> generate specific kinds of addresses for wallets.</p>
@ -99,7 +99,7 @@ generate specific kinds of addresses for wallets.</p>
<pre><code class="hljs css language-scala"><span class="hljs-comment">//this will create a temp directory with the prefix &#x27;key-manager-example` that will</span> <pre><code class="hljs css language-scala"><span class="hljs-comment">//this will create a temp directory with the prefix &#x27;key-manager-example` that will</span>
<span class="hljs-comment">//have a file in it called &quot;encrypted-bitcoin-s-seed.json&quot;</span> <span class="hljs-comment">//have a file in it called &quot;encrypted-bitcoin-s-seed.json&quot;</span>
<span class="hljs-keyword">val</span> seedPath = <span class="hljs-type">Files</span>.createTempDirectory(<span class="hljs-string">&quot;key-manager-example&quot;</span>).resolve(<span class="hljs-type">WalletStorage</span>.<span class="hljs-type">ENCRYPTED_SEED_FILE_NAME</span>) <span class="hljs-keyword">val</span> seedPath = <span class="hljs-type">Files</span>.createTempDirectory(<span class="hljs-string">&quot;key-manager-example&quot;</span>).resolve(<span class="hljs-type">WalletStorage</span>.<span class="hljs-type">ENCRYPTED_SEED_FILE_NAME</span>)
<span class="hljs-comment">// seedPath: Path = /tmp/key-manager-example6643020899267846985/encrypted-bitcoin-s-seed.json</span> <span class="hljs-comment">// seedPath: Path = /tmp/key-manager-example7506751604000552319/encrypted-bitcoin-s-seed.json</span>
<span class="hljs-comment">//let&#x27;s create a native segwit key manager</span> <span class="hljs-comment">//let&#x27;s create a native segwit key manager</span>
<span class="hljs-keyword">val</span> purpose = <span class="hljs-type">HDPurposes</span>.<span class="hljs-type">SegWit</span> <span class="hljs-keyword">val</span> purpose = <span class="hljs-type">HDPurposes</span>.<span class="hljs-type">SegWit</span>
@ -110,19 +110,19 @@ generate specific kinds of addresses for wallets.</p>
<span class="hljs-comment">// network: RegTest.type = RegTest</span> <span class="hljs-comment">// network: RegTest.type = RegTest</span>
<span class="hljs-keyword">val</span> kmParams = <span class="hljs-type">KeyManagerParams</span>(seedPath, purpose, network) <span class="hljs-keyword">val</span> kmParams = <span class="hljs-type">KeyManagerParams</span>(seedPath, purpose, network)
<span class="hljs-comment">// kmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example6643020899267846985/encrypted-bitcoin-s-seed.json,m/84&#x27;,RegTest)</span> <span class="hljs-comment">// kmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example7506751604000552319/encrypted-bitcoin-s-seed.json,m/84&#x27;,RegTest)</span>
<span class="hljs-keyword">val</span> aesPasswordOpt = <span class="hljs-type">Some</span>(<span class="hljs-type">AesPassword</span>.fromString(<span class="hljs-string">&quot;password&quot;</span>)) <span class="hljs-keyword">val</span> aesPasswordOpt = <span class="hljs-type">Some</span>(<span class="hljs-type">AesPassword</span>.fromString(<span class="hljs-string">&quot;password&quot;</span>))
<span class="hljs-comment">// aesPasswordOpt: Some[AesPassword] = Some(Masked(AesPassword))</span> <span class="hljs-comment">// aesPasswordOpt: Some[AesPassword] = Some(Masked(AesPassword))</span>
<span class="hljs-keyword">val</span> km = <span class="hljs-type">BIP39KeyManager</span>.initializeWithMnemonic(aesPasswordOpt, mnemonic, <span class="hljs-type">None</span>, kmParams) <span class="hljs-keyword">val</span> km = <span class="hljs-type">BIP39KeyManager</span>.initializeWithMnemonic(aesPasswordOpt, mnemonic, <span class="hljs-type">None</span>, kmParams)
<span class="hljs-comment">// km: Either[KeyManagerInitializeError, BIP39KeyManager] = Right(org.bitcoins.keymanager.bip39.BIP39KeyManager@139d4b68)</span> <span class="hljs-comment">// km: Either[KeyManagerInitializeError, BIP39KeyManager] = Right(org.bitcoins.keymanager.bip39.BIP39KeyManager@48b0ccb)</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 = vpub5SLqN2bLY4WeaMR9w1Rog8b6aavK6qebG7rTVbcNN7dCn24fzYeUN446s9Y39TCr43teTGmkRaDwY8yJyb1YVt9roy2EtErTohdy4845WNQ</span> <span class="hljs-comment">// rootXPub: ExtPublicKey = vpub5SLqN2bLY4WeXyoAWzzaMbnDwhxxzk9i1mBWSoBkT4k3zpukFW3catjBFKFBUSdaBrxP9btfUB4ViasH4Kz2LXcpBVefK37FF8KJrwQq469</span>
println(rootXPub) println(rootXPub)
<span class="hljs-comment">// vpub5SLqN2bLY4WeaMR9w1Rog8b6aavK6qebG7rTVbcNN7dCn24fzYeUN446s9Y39TCr43teTGmkRaDwY8yJyb1YVt9roy2EtErTohdy4845WNQ</span> <span class="hljs-comment">// vpub5SLqN2bLY4WeXyoAWzzaMbnDwhxxzk9i1mBWSoBkT4k3zpukFW3catjBFKFBUSdaBrxP9btfUB4ViasH4Kz2LXcpBVefK37FF8KJrwQq469</span>
</code></pre> </code></pre>
<p>Which should print something that looks like this</p> <p>Which should print something that looks like this</p>
<p><code>vpub5SLqN2bLY4WeXxMqwJHJFBEwxSscGB2uDUnsTS3edVjZEwTrQDFDNqoR2xLqARQPabGaXsHSTenTRcqm2EnB9MpuC4vSk3LqSgNmGGZtuq7</code></p> <p><code>vpub5SLqN2bLY4WeXxMqwJHJFBEwxSscGB2uDUnsTS3edVjZEwTrQDFDNqoR2xLqARQPabGaXsHSTenTRcqm2EnB9MpuC4vSk3LqSgNmGGZtuq7</code></p>
@ -131,17 +131,17 @@ println(rootXPub)
again after initializing it once. You can use the same <code>mnemonic</code> for different networks, which you control <code>KeyManagerParams</code>.</p> again after initializing it once. You can use the same <code>mnemonic</code> for different networks, which you control <code>KeyManagerParams</code>.</p>
<pre><code class="hljs css language-scala"><span class="hljs-comment">//let&#x27;s create a nested segwit key manager for mainnet</span> <pre><code class="hljs css language-scala"><span class="hljs-comment">//let&#x27;s create a nested segwit key manager for mainnet</span>
<span class="hljs-keyword">val</span> mainnetKmParams = <span class="hljs-type">KeyManagerParams</span>(seedPath, <span class="hljs-type">HDPurposes</span>.<span class="hljs-type">SegWit</span>, <span class="hljs-type">MainNet</span>) <span class="hljs-keyword">val</span> mainnetKmParams = <span class="hljs-type">KeyManagerParams</span>(seedPath, <span class="hljs-type">HDPurposes</span>.<span class="hljs-type">SegWit</span>, <span class="hljs-type">MainNet</span>)
<span class="hljs-comment">// mainnetKmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example6643020899267846985/encrypted-bitcoin-s-seed.json,m/84&#x27;,MainNet)</span> <span class="hljs-comment">// mainnetKmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example7506751604000552319/encrypted-bitcoin-s-seed.json,m/84&#x27;,MainNet)</span>
<span class="hljs-comment">//we do not need to all `initializeWithMnemonic()` again as we have saved the seed to dis</span> <span class="hljs-comment">//we do not need to all `initializeWithMnemonic()` again as we have saved the seed to dis</span>
<span class="hljs-keyword">val</span> mainnetKeyManager = <span class="hljs-type">BIP39KeyManager</span>.fromMnemonic(mnemonic, mainnetKmParams, <span class="hljs-type">None</span>, <span class="hljs-type">Instant</span>.now) <span class="hljs-keyword">val</span> mainnetKeyManager = <span class="hljs-type">BIP39KeyManager</span>.fromMnemonic(mnemonic, mainnetKmParams, <span class="hljs-type">None</span>, <span class="hljs-type">Instant</span>.now)
<span class="hljs-comment">// mainnetKeyManager: BIP39KeyManager = org.bitcoins.keymanager.bip39.BIP39KeyManager@7531bb23</span> <span class="hljs-comment">// mainnetKeyManager: BIP39KeyManager = org.bitcoins.keymanager.bip39.BIP39KeyManager@174fc3ac</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 = zpub6jftahH18ngZyYBdGSaJWUy7GTW6sKcavZwLdBBut98izRKb1BJirJgewyNP95pXgcMsTB9zGDe95HRZrNfbgptGHKowDt8QtbtYcR4zVC5</span> <span class="hljs-comment">// mainnetXpub: ExtPublicKey = zpub6jftahH18ngZwAZdrS95BxAEdaYkmE7hgDGPaNmHy6FaDEAfG8hs59MjL95XU5FFpRRc9WGuJpUhFjKXw7e5XUMDerSMegPCL2ZtREkyBro</span>
println(mainnetXpub) println(mainnetXpub)
<span class="hljs-comment">// zpub6jftahH18ngZyYBdGSaJWUy7GTW6sKcavZwLdBBut98izRKb1BJirJgewyNP95pXgcMsTB9zGDe95HRZrNfbgptGHKowDt8QtbtYcR4zVC5</span> <span class="hljs-comment">// zpub6jftahH18ngZwAZdrS95BxAEdaYkmE7hgDGPaNmHy6FaDEAfG8hs59MjL95XU5FFpRRc9WGuJpUhFjKXw7e5XUMDerSMegPCL2ZtREkyBro</span>
</code></pre> </code></pre>
<p>Which gives us something that looks like this</p> <p>Which gives us something that looks like this</p>
<p><code>zpub6jftahH18ngZw98KGjRo5XcxeKTQ2eztsvskb1dC9XF5TLimQquTs6Ry7nBBA425D9joXmfgJJCexmJ1u2SELJZJfRi95gcnXadLpZzYb5c</code></p> <p><code>zpub6jftahH18ngZw98KGjRo5XcxeKTQ2eztsvskb1dC9XF5TLimQquTs6Ry7nBBA425D9joXmfgJJCexmJ1u2SELJZJfRi95gcnXadLpZzYb5c</code></p>

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

@ -114,12 +114,12 @@ println(<span class="hljs-string">s&quot;Verified with NativeSecp256k1 again=<sp
<pre><code class="hljs css language-scala"><span class="hljs-keyword">val</span> privKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey <pre><code class="hljs css language-scala"><span class="hljs-keyword">val</span> privKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey
<span class="hljs-comment">// privKey: ECPrivateKey = Masked(ECPrivateKeyImpl)</span> <span class="hljs-comment">// privKey: ECPrivateKey = Masked(ECPrivateKeyImpl)</span>
<span class="hljs-keyword">val</span> publicKey = privKey.publicKeyWithBouncyCastle <span class="hljs-keyword">val</span> publicKey = privKey.publicKeyWithBouncyCastle
<span class="hljs-comment">// publicKey: ECPublicKey = ECPublicKey(031d4328eae82ca4dba09cedcd5a52d5adcd4a23e1b7415c0bc1dacae6568433a4)</span> <span class="hljs-comment">// publicKey: ECPublicKey = ECPublicKey(02dd73f79f2beec74713804b02782abb83b8d3e8a12a57ed03cb2ed31b8e6a4328)</span>
<span class="hljs-keyword">val</span> dataToSign = <span class="hljs-type">DoubleSha256Digest</span>.empty <span class="hljs-keyword">val</span> dataToSign = <span class="hljs-type">DoubleSha256Digest</span>.empty
<span class="hljs-comment">// dataToSign: DoubleSha256Digest = DoubleSha256Digest(0000000000000000000000000000000000000000000000000000000000000000)</span> <span class="hljs-comment">// dataToSign: DoubleSha256Digest = DoubleSha256Digest(0000000000000000000000000000000000000000000000000000000000000000)</span>
<span class="hljs-keyword">val</span> signature = privKey.signWithBouncyCastle(dataToSign.bytes) <span class="hljs-keyword">val</span> signature = privKey.signWithBouncyCastle(dataToSign.bytes)
<span class="hljs-comment">// signature: ECDigitalSignature = ECDigitalSignature(3045022100b21719285f3be3592f306604abbc2dc42e8ad7549de539a7aeb73f172fd44f0702201d6a6a52ddf4a5992a1193ca30960bb248e536bac8f27993a94ba71eb7e4b37c)</span> <span class="hljs-comment">// signature: ECDigitalSignature = ECDigitalSignature(30440220767bd8cb96eedf221bab0cd3df96ec6e7144a0b5edf96af4f68fe0787c97019802205cd753e3a986ddb1656bc9c55f1d53b6adc4695a3836f42b489408c8f224cb68)</span>
<span class="hljs-keyword">val</span> verified = publicKey.verifyWithBouncyCastle(dataToSign.bytes, signature) <span class="hljs-keyword">val</span> verified = publicKey.verifyWithBouncyCastle(dataToSign.bytes, signature)
<span class="hljs-comment">// verified: Boolean = true</span> <span class="hljs-comment">// verified: Boolean = true</span>

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

@ -114,12 +114,12 @@ println(<span class="hljs-string">s&quot;Verified with NativeSecp256k1 again=<sp
<pre><code class="hljs css language-scala"><span class="hljs-keyword">val</span> privKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey <pre><code class="hljs css language-scala"><span class="hljs-keyword">val</span> privKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey
<span class="hljs-comment">// privKey: ECPrivateKey = Masked(ECPrivateKeyImpl)</span> <span class="hljs-comment">// privKey: ECPrivateKey = Masked(ECPrivateKeyImpl)</span>
<span class="hljs-keyword">val</span> publicKey = privKey.publicKeyWithBouncyCastle <span class="hljs-keyword">val</span> publicKey = privKey.publicKeyWithBouncyCastle
<span class="hljs-comment">// publicKey: ECPublicKey = ECPublicKey(031d4328eae82ca4dba09cedcd5a52d5adcd4a23e1b7415c0bc1dacae6568433a4)</span> <span class="hljs-comment">// publicKey: ECPublicKey = ECPublicKey(02dd73f79f2beec74713804b02782abb83b8d3e8a12a57ed03cb2ed31b8e6a4328)</span>
<span class="hljs-keyword">val</span> dataToSign = <span class="hljs-type">DoubleSha256Digest</span>.empty <span class="hljs-keyword">val</span> dataToSign = <span class="hljs-type">DoubleSha256Digest</span>.empty
<span class="hljs-comment">// dataToSign: DoubleSha256Digest = DoubleSha256Digest(0000000000000000000000000000000000000000000000000000000000000000)</span> <span class="hljs-comment">// dataToSign: DoubleSha256Digest = DoubleSha256Digest(0000000000000000000000000000000000000000000000000000000000000000)</span>
<span class="hljs-keyword">val</span> signature = privKey.signWithBouncyCastle(dataToSign.bytes) <span class="hljs-keyword">val</span> signature = privKey.signWithBouncyCastle(dataToSign.bytes)
<span class="hljs-comment">// signature: ECDigitalSignature = ECDigitalSignature(3045022100b21719285f3be3592f306604abbc2dc42e8ad7549de539a7aeb73f172fd44f0702201d6a6a52ddf4a5992a1193ca30960bb248e536bac8f27993a94ba71eb7e4b37c)</span> <span class="hljs-comment">// signature: ECDigitalSignature = ECDigitalSignature(30440220767bd8cb96eedf221bab0cd3df96ec6e7144a0b5edf96af4f68fe0787c97019802205cd753e3a986ddb1656bc9c55f1d53b6adc4695a3836f42b489408c8f224cb68)</span>
<span class="hljs-keyword">val</span> verified = publicKey.verifyWithBouncyCastle(dataToSign.bytes, signature) <span class="hljs-keyword">val</span> verified = publicKey.verifyWithBouncyCastle(dataToSign.bytes, signature)
<span class="hljs-comment">// verified: Boolean = true</span> <span class="hljs-comment">// verified: Boolean = true</span>