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

Deploy website

Browse source 
Deploy website version based on 23f15dffc7
This commit is contained in:
Docusaurus bot 2021-01-24 03:21:09 +00:00
parent 9ec0075c97
commit 53dce4c75b
14 changed files with 90 additions and 90 deletions

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

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

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

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

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

@ -86,13 +86,13 @@ use that to generate further private and public keys:</p>
<span class="hljs-comment">// how long our phrase ends up being</span>
<span class="hljs-comment">// 256 bits of entropy results in 24 words</span>
<span class="hljs-keyword">val</span> entropy: <span class="hljs-type">BitVector</span> = <span class="hljs-type">MnemonicCode</span>.getEntropy256Bits
<span class="hljs-comment">// entropy: BitVector = BitVector(256 bits, 0x8afd2ae680ce75da8f276085d56ee882cd598ac7502e775bc9b4d2e8c8336311)</span>
<span class="hljs-comment">// entropy: BitVector = BitVector(256 bits, 0x22831e149a850bb3f8dfac235b2371224be30462bd645e9f0cc4c1a2fc8fb346)</span>
<span class="hljs-keyword">val</span> mnemonicCode = <span class="hljs-type">MnemonicCode</span>.fromEntropy(entropy)
<span class="hljs-comment">// mnemonicCode: MnemonicCode = Masked(MnemonicCodeImpl)</span>
mnemonicCode.words <span class="hljs-comment">// the phrase the user should write down</span>
<span class="hljs-comment">// res0: Vector[String] = Vector(memory, true, rifle, account, trap, unhappy, develop, ugly, magic, problem, riot, airport, stereo, shell, bubble, alarm, jar, tattoo, honey, place, milk, boost, middle, ceiling) // the phrase the user should write down</span>
<span class="hljs-comment">// res0: Vector[String] = Vector(card, body, lunch, crush, expose, supreme, toddler, void, cash, suit, sword, duty, sail, lion, memory, prosper, future, wear, couple, local, cool, elephant, snack, soup) // the phrase the user should write down</span>
<span class="hljs-comment">// the password argument is an optional, extra security</span>
<span class="hljs-comment">// measure. all MnemonicCode instances will give you a</span>
@ -108,7 +108,7 @@ mnemonicCode.words <span class="hljs-comment">// the phrase the user should writ
bip39Seed)
<span class="hljs-comment">// xpriv: ExtPrivateKey = Masked(ExtPrivateKeyImpl)</span>
<span class="hljs-keyword">val</span> xpub = xpriv.extPublicKey
<span class="hljs-comment">// xpub: ExtPublicKey = zpub6jftahH18ngZyWq5vNFAeSw1Yb7H5VE6kupP9hycj9SLaDMFGC5SNMgiAarfxahPMpm7ExyKyzciaPwGsHL85nFY7fpptnd1X3Nnvj4FW6p</span>
<span class="hljs-comment">// xpub: ExtPublicKey = zpub6jftahH18ngZxXPvEB4GPpLzPjuz4hD53StTv9wjiuSsCZknUCwQPnfvusFGDRL8ZfShmC2YeRzPZWfejR4XHNa4bBBibFytgFvq6cavmsm</span>
<span class="hljs-comment">// you can now use the generated xpriv to derive further</span>
<span class="hljs-comment">// private or public keys</span>
@ -154,7 +154,7 @@ spend or steal any of your money.</p>
<span class="hljs-comment">// can generate addresses with it!</span>
accountXpriv.extPublicKey
}
<span class="hljs-comment">// accountXpub: ExtPublicKey = zpub6qoGKvnVHsnoj6MnzHXCHrVnYTjTov8KrmSQFyY9YfD35Gqj42gt7ABcwNkGhJZN59RNhq1qw4VBLug7QVd7gp73cg5ZsGxbtt4xL5BFUG2</span>
<span class="hljs-comment">// accountXpub: ExtPublicKey = zpub6rEXYcU4tob5nnjjoA3hiNdzHwqfLJqgpoTt34gtbaDYzXQd8etM5M8GQp8DNhhovKPGco8iWmtPF8qt2G3xfFbDmGD7r95JrisMsDZbQtj</span>
<span class="hljs-comment">// address no. 0 ---------------┐</span>
<span class="hljs-comment">// external address ----------┐ |</span>
@ -177,12 +177,12 @@ spend or steal any of your money.</p>
<span class="hljs-keyword">val</span> scriptPubKey = <span class="hljs-type">P2WPKHWitnessSPKV0</span>(pubkey)
<span class="hljs-type">Bech32Address</span>(scriptPubKey, <span class="hljs-type">TestNet3</span>)
}
<span class="hljs-comment">// firstAccountAddress: Bech32Address = tb1qwjfjcy27n7gsujs9p3wxutmhya26upz7nmmek2</span>
<span class="hljs-comment">// firstAccountAddress: Bech32Address = tb1qtj79xg0cvxj6agtxp3c40ppaqz0h8nlkqzg989</span>
<span class="hljs-comment">// tada! We just generated an address you can send money to,</span>
<span class="hljs-comment">// without having access to the private key!</span>
firstAccountAddress.value
<span class="hljs-comment">// res2: String = tb1qwjfjcy27n7gsujs9p3wxutmhya26upz7nmmek2</span>
<span class="hljs-comment">// res2: String = tb1qtj79xg0cvxj6agtxp3c40ppaqz0h8nlkqzg989</span>
<span class="hljs-comment">// you can now continue deriving addresses from the same public</span>
<span class="hljs-comment">// key, by imitating what we did above. To get the next</span>

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

@ -86,13 +86,13 @@ use that to generate further private and public keys:</p>
<span class="hljs-comment">// how long our phrase ends up being</span>
<span class="hljs-comment">// 256 bits of entropy results in 24 words</span>
<span class="hljs-keyword">val</span> entropy: <span class="hljs-type">BitVector</span> = <span class="hljs-type">MnemonicCode</span>.getEntropy256Bits
<span class="hljs-comment">// entropy: BitVector = BitVector(256 bits, 0x8afd2ae680ce75da8f276085d56ee882cd598ac7502e775bc9b4d2e8c8336311)</span>
<span class="hljs-comment">// entropy: BitVector = BitVector(256 bits, 0x22831e149a850bb3f8dfac235b2371224be30462bd645e9f0cc4c1a2fc8fb346)</span>
<span class="hljs-keyword">val</span> mnemonicCode = <span class="hljs-type">MnemonicCode</span>.fromEntropy(entropy)
<span class="hljs-comment">// mnemonicCode: MnemonicCode = Masked(MnemonicCodeImpl)</span>
mnemonicCode.words <span class="hljs-comment">// the phrase the user should write down</span>
<span class="hljs-comment">// res0: Vector[String] = Vector(memory, true, rifle, account, trap, unhappy, develop, ugly, magic, problem, riot, airport, stereo, shell, bubble, alarm, jar, tattoo, honey, place, milk, boost, middle, ceiling) // the phrase the user should write down</span>
<span class="hljs-comment">// res0: Vector[String] = Vector(card, body, lunch, crush, expose, supreme, toddler, void, cash, suit, sword, duty, sail, lion, memory, prosper, future, wear, couple, local, cool, elephant, snack, soup) // the phrase the user should write down</span>
<span class="hljs-comment">// the password argument is an optional, extra security</span>
<span class="hljs-comment">// measure. all MnemonicCode instances will give you a</span>
@ -108,7 +108,7 @@ mnemonicCode.words <span class="hljs-comment">// the phrase the user should writ
bip39Seed)
<span class="hljs-comment">// xpriv: ExtPrivateKey = Masked(ExtPrivateKeyImpl)</span>
<span class="hljs-keyword">val</span> xpub = xpriv.extPublicKey
<span class="hljs-comment">// xpub: ExtPublicKey = zpub6jftahH18ngZyWq5vNFAeSw1Yb7H5VE6kupP9hycj9SLaDMFGC5SNMgiAarfxahPMpm7ExyKyzciaPwGsHL85nFY7fpptnd1X3Nnvj4FW6p</span>
<span class="hljs-comment">// xpub: ExtPublicKey = zpub6jftahH18ngZxXPvEB4GPpLzPjuz4hD53StTv9wjiuSsCZknUCwQPnfvusFGDRL8ZfShmC2YeRzPZWfejR4XHNa4bBBibFytgFvq6cavmsm</span>
<span class="hljs-comment">// you can now use the generated xpriv to derive further</span>
<span class="hljs-comment">// private or public keys</span>
@ -154,7 +154,7 @@ spend or steal any of your money.</p>
<span class="hljs-comment">// can generate addresses with it!</span>
accountXpriv.extPublicKey
}
<span class="hljs-comment">// accountXpub: ExtPublicKey = zpub6qoGKvnVHsnoj6MnzHXCHrVnYTjTov8KrmSQFyY9YfD35Gqj42gt7ABcwNkGhJZN59RNhq1qw4VBLug7QVd7gp73cg5ZsGxbtt4xL5BFUG2</span>
<span class="hljs-comment">// accountXpub: ExtPublicKey = zpub6rEXYcU4tob5nnjjoA3hiNdzHwqfLJqgpoTt34gtbaDYzXQd8etM5M8GQp8DNhhovKPGco8iWmtPF8qt2G3xfFbDmGD7r95JrisMsDZbQtj</span>
<span class="hljs-comment">// address no. 0 ---------------┐</span>
<span class="hljs-comment">// external address ----------┐ |</span>
@ -177,12 +177,12 @@ spend or steal any of your money.</p>
<span class="hljs-keyword">val</span> scriptPubKey = <span class="hljs-type">P2WPKHWitnessSPKV0</span>(pubkey)
<span class="hljs-type">Bech32Address</span>(scriptPubKey, <span class="hljs-type">TestNet3</span>)
}
<span class="hljs-comment">// firstAccountAddress: Bech32Address = tb1qwjfjcy27n7gsujs9p3wxutmhya26upz7nmmek2</span>
<span class="hljs-comment">// firstAccountAddress: Bech32Address = tb1qtj79xg0cvxj6agtxp3c40ppaqz0h8nlkqzg989</span>
<span class="hljs-comment">// tada! We just generated an address you can send money to,</span>
<span class="hljs-comment">// without having access to the private key!</span>
firstAccountAddress.value
<span class="hljs-comment">// res2: String = tb1qwjfjcy27n7gsujs9p3wxutmhya26upz7nmmek2</span>
<span class="hljs-comment">// res2: String = tb1qtj79xg0cvxj6agtxp3c40ppaqz0h8nlkqzg989</span>
<span class="hljs-comment">// you can now continue deriving addresses from the same public</span>
<span class="hljs-comment">// key, by imitating what we did above. To get the next</span>

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

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

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

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

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

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

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

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

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

@ -120,7 +120,7 @@ libraryDependencies += <span class="hljs-string">&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>
<p>You can also run on the bleeding edge of Bitcoin-S, by
adding a snapshot build to your <code>build.sbt</code>. The most
recent snapshot published is <code>0.4.0+274-c91f81bd-SNAPSHOT</code>.</p>
recent snapshot published is <code>0.4.0+275-23f15dff-SNAPSHOT</code>.</p>
<p>To fetch snapshots, you will need to add the correct
resolver in your <code>build.sbt</code>:</p>
<pre><code class="hljs css language-sbt">resolvers += Resolver.sonatypeRepo(<span class="hljs-string">&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>
<p>You can also run on the bleeding edge of Bitcoin-S, by
adding a snapshot build to your <code>build.sbt</code>. The most
recent snapshot published is <code>0.4.0+274-c91f81bd-SNAPSHOT</code>.</p>
recent snapshot published is <code>0.4.0+275-23f15dff-SNAPSHOT</code>.</p>
<p>To fetch snapshots, you will need to add the correct
resolver in your <code>build.sbt</code>:</p>
<pre><code class="hljs css language-sbt">resolvers += Resolver.sonatypeRepo(<span class="hljs-string">&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-keyword">val</span> entropy = <span class="hljs-type">MnemonicCode</span>.getEntropy256Bits
<span class="hljs-comment">// entropy: scodec.bits.BitVector = BitVector(256 bits, 0x61a2cdcb53cb7cf12516e92b1a258cb21fa8bedffafc1641cae38daba9b60772)</span>
<span class="hljs-comment">// entropy: scodec.bits.BitVector = BitVector(256 bits, 0xf06a5268a88f70cd8172dd8faf92c072eb57ff71e06d894a352e9c3e6b7b60cb)</span>
<span class="hljs-keyword">val</span> mnemonic = <span class="hljs-type">MnemonicCode</span>.fromEntropy(entropy)
<span class="hljs-comment">// mnemonic: MnemonicCode = Masked(MnemonicCodeImpl)</span>
<span class="hljs-comment">//you can print that mnemonic seed with this</span>
println(mnemonic.words)
<span class="hljs-comment">// Vector(giant, biology, index, pole, result, joy, nephew, tag, climb, spell, glimpse, goddess, whisper, garage, lend, garbage, bind, atom, rib, brave, ritual, swallow, build, fiction)</span>
<span class="hljs-comment">// Vector(vacant, family, olive, extra, warfare, grocery, alarm, forum, moral, lady, quote, total, rely, zero, shy, asset, matter, faculty, entry, debris, trade, sad, lobster, income)</span>
</code></pre>
<p>Now that we have a <code>MnemonicCode</code> that was securely generated, we need to now create <code>KeyManagerParams</code> which tells us how to generate
generate specific kinds of addresses for wallets.</p>
@ -99,7 +99,7 @@ generate specific kinds of addresses for wallets.</p>
<pre><code class="hljs css language-scala"><span class="hljs-comment">//this will create a temp directory with the prefix &#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-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-example7997965906490194400/encrypted-bitcoin-s-seed.json</span>
<span class="hljs-comment">// seedPath: Path = /tmp/key-manager-example9193503986677380488/encrypted-bitcoin-s-seed.json</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>
@ -110,19 +110,19 @@ generate specific kinds of addresses for wallets.</p>
<span class="hljs-comment">// network: RegTest.type = RegTest</span>
<span class="hljs-keyword">val</span> kmParams = <span class="hljs-type">KeyManagerParams</span>(seedPath, purpose, network)
<span class="hljs-comment">// kmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example7997965906490194400/encrypted-bitcoin-s-seed.json,m/84&#x27;,RegTest)</span>
<span class="hljs-comment">// kmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example9193503986677380488/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-comment">// aesPasswordOpt: Some[AesPassword] = Some(Masked(AesPassword))</span>
<span class="hljs-keyword">val</span> km = <span class="hljs-type">BIP39KeyManager</span>.initializeWithMnemonic(aesPasswordOpt, mnemonic, <span class="hljs-type">None</span>, kmParams)
<span class="hljs-comment">// km: Either[KeyManagerInitializeError, BIP39KeyManager] = Right(org.bitcoins.keymanager.bip39.BIP39KeyManager@1122094)</span>
<span class="hljs-comment">// km: Either[KeyManagerInitializeError, BIP39KeyManager] = Right(org.bitcoins.keymanager.bip39.BIP39KeyManager@2f8c8454)</span>
<span class="hljs-keyword">val</span> rootXPub = km.right.get.getRootXPub
<span class="hljs-comment">// rootXPub: ExtPublicKey = vpub5SLqN2bLY4Wea1uYg1LgQ5VeYEXTQnSkxTgDAs5YRSAHYcWH5JLSxEda3ZRK2xcwGvpUeLFksKDXtytqTBGEkuxBjNpBau2RMLemAKMk74h</span>
<span class="hljs-comment">// rootXPub: ExtPublicKey = vpub5SLqN2bLY4WeZzM1FVMwZmbkb9z2YVCUnUSemxmK6ahVNDvaHayieGws9K1ncZHr2XwPKjmCzukgjDwE49MqqJXynta2SBeedDj5Hk1t5J6</span>
println(rootXPub)
<span class="hljs-comment">// vpub5SLqN2bLY4Wea1uYg1LgQ5VeYEXTQnSkxTgDAs5YRSAHYcWH5JLSxEda3ZRK2xcwGvpUeLFksKDXtytqTBGEkuxBjNpBau2RMLemAKMk74h</span>
<span class="hljs-comment">// vpub5SLqN2bLY4WeZzM1FVMwZmbkb9z2YVCUnUSemxmK6ahVNDvaHayieGws9K1ncZHr2XwPKjmCzukgjDwE49MqqJXynta2SBeedDj5Hk1t5J6</span>
</code></pre>
<p>Which should print something that looks like this</p>
<p><code>vpub5SLqN2bLY4WeXxMqwJHJFBEwxSscGB2uDUnsTS3edVjZEwTrQDFDNqoR2xLqARQPabGaXsHSTenTRcqm2EnB9MpuC4vSk3LqSgNmGGZtuq7</code></p>
@ -131,17 +131,17 @@ println(rootXPub)
again after initializing it once. You can use the same <code>mnemonic</code> for different networks, which you control <code>KeyManagerParams</code>.</p>
<pre><code class="hljs css language-scala"><span class="hljs-comment">//let&#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-comment">// mainnetKmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example7997965906490194400/encrypted-bitcoin-s-seed.json,m/84&#x27;,MainNet)</span>
<span class="hljs-comment">// mainnetKmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example9193503986677380488/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-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@627dca7b</span>
<span class="hljs-comment">// mainnetKeyManager: BIP39KeyManager = org.bitcoins.keymanager.bip39.BIP39KeyManager@4c5612cc</span>
<span class="hljs-keyword">val</span> mainnetXpub = mainnetKeyManager.getRootXPub
<span class="hljs-comment">// mainnetXpub: ExtPublicKey = zpub6jftahH18ngZyCg21SVBERsfE77FBGQkcum6JSf5wTfom1mC5vzhSVG88PFf2bEcuVHheEdzhxdjS8M6KxvHwrgbCjbsvYJNSEuLieQiBbE</span>
<span class="hljs-comment">// mainnetXpub: ExtPublicKey = zpub6jftahH18ngZyB7UavWSQ7ymH2ZpJyAUSvXXuYLrccD1adBVJDdy8XaRE8r8cBuXf6QcKe9SqZAtGNPUvw1u2FGPGFMimpvbi7yer1hBRLc</span>
println(mainnetXpub)
<span class="hljs-comment">// zpub6jftahH18ngZyCg21SVBERsfE77FBGQkcum6JSf5wTfom1mC5vzhSVG88PFf2bEcuVHheEdzhxdjS8M6KxvHwrgbCjbsvYJNSEuLieQiBbE</span>
<span class="hljs-comment">// zpub6jftahH18ngZyB7UavWSQ7ymH2ZpJyAUSvXXuYLrccD1adBVJDdy8XaRE8r8cBuXf6QcKe9SqZAtGNPUvw1u2FGPGFMimpvbi7yer1hBRLc</span>
</code></pre>
<p>Which gives us something that looks like this</p>
<p><code>zpub6jftahH18ngZw98KGjRo5XcxeKTQ2eztsvskb1dC9XF5TLimQquTs6Ry7nBBA425D9joXmfgJJCexmJ1u2SELJZJfRi95gcnXadLpZzYb5c</code></p>

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

@ -77,14 +77,14 @@
<span class="hljs-comment">//get 256 bits of random entropy</span>
<span class="hljs-keyword">val</span> entropy = <span class="hljs-type">MnemonicCode</span>.getEntropy256Bits
<span class="hljs-comment">// entropy: scodec.bits.BitVector = BitVector(256 bits, 0x61a2cdcb53cb7cf12516e92b1a258cb21fa8bedffafc1641cae38daba9b60772)</span>
<span class="hljs-comment">// entropy: scodec.bits.BitVector = BitVector(256 bits, 0xf06a5268a88f70cd8172dd8faf92c072eb57ff71e06d894a352e9c3e6b7b60cb)</span>
<span class="hljs-keyword">val</span> mnemonic = <span class="hljs-type">MnemonicCode</span>.fromEntropy(entropy)
<span class="hljs-comment">// mnemonic: MnemonicCode = Masked(MnemonicCodeImpl)</span>
<span class="hljs-comment">//you can print that mnemonic seed with this</span>
println(mnemonic.words)
<span class="hljs-comment">// Vector(giant, biology, index, pole, result, joy, nephew, tag, climb, spell, glimpse, goddess, whisper, garage, lend, garbage, bind, atom, rib, brave, ritual, swallow, build, fiction)</span>
<span class="hljs-comment">// Vector(vacant, family, olive, extra, warfare, grocery, alarm, forum, moral, lady, quote, total, rely, zero, shy, asset, matter, faculty, entry, debris, trade, sad, lobster, income)</span>
</code></pre>
<p>Now that we have a <code>MnemonicCode</code> that was securely generated, we need to now create <code>KeyManagerParams</code> which tells us how to generate
generate specific kinds of addresses for wallets.</p>
@ -99,7 +99,7 @@ generate specific kinds of addresses for wallets.</p>
<pre><code class="hljs css language-scala"><span class="hljs-comment">//this will create a temp directory with the prefix &#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-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-example7997965906490194400/encrypted-bitcoin-s-seed.json</span>
<span class="hljs-comment">// seedPath: Path = /tmp/key-manager-example9193503986677380488/encrypted-bitcoin-s-seed.json</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>
@ -110,19 +110,19 @@ generate specific kinds of addresses for wallets.</p>
<span class="hljs-comment">// network: RegTest.type = RegTest</span>
<span class="hljs-keyword">val</span> kmParams = <span class="hljs-type">KeyManagerParams</span>(seedPath, purpose, network)
<span class="hljs-comment">// kmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example7997965906490194400/encrypted-bitcoin-s-seed.json,m/84&#x27;,RegTest)</span>
<span class="hljs-comment">// kmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example9193503986677380488/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-comment">// aesPasswordOpt: Some[AesPassword] = Some(Masked(AesPassword))</span>
<span class="hljs-keyword">val</span> km = <span class="hljs-type">BIP39KeyManager</span>.initializeWithMnemonic(aesPasswordOpt, mnemonic, <span class="hljs-type">None</span>, kmParams)
<span class="hljs-comment">// km: Either[KeyManagerInitializeError, BIP39KeyManager] = Right(org.bitcoins.keymanager.bip39.BIP39KeyManager@1122094)</span>
<span class="hljs-comment">// km: Either[KeyManagerInitializeError, BIP39KeyManager] = Right(org.bitcoins.keymanager.bip39.BIP39KeyManager@2f8c8454)</span>
<span class="hljs-keyword">val</span> rootXPub = km.right.get.getRootXPub
<span class="hljs-comment">// rootXPub: ExtPublicKey = vpub5SLqN2bLY4Wea1uYg1LgQ5VeYEXTQnSkxTgDAs5YRSAHYcWH5JLSxEda3ZRK2xcwGvpUeLFksKDXtytqTBGEkuxBjNpBau2RMLemAKMk74h</span>
<span class="hljs-comment">// rootXPub: ExtPublicKey = vpub5SLqN2bLY4WeZzM1FVMwZmbkb9z2YVCUnUSemxmK6ahVNDvaHayieGws9K1ncZHr2XwPKjmCzukgjDwE49MqqJXynta2SBeedDj5Hk1t5J6</span>
println(rootXPub)
<span class="hljs-comment">// vpub5SLqN2bLY4Wea1uYg1LgQ5VeYEXTQnSkxTgDAs5YRSAHYcWH5JLSxEda3ZRK2xcwGvpUeLFksKDXtytqTBGEkuxBjNpBau2RMLemAKMk74h</span>
<span class="hljs-comment">// vpub5SLqN2bLY4WeZzM1FVMwZmbkb9z2YVCUnUSemxmK6ahVNDvaHayieGws9K1ncZHr2XwPKjmCzukgjDwE49MqqJXynta2SBeedDj5Hk1t5J6</span>
</code></pre>
<p>Which should print something that looks like this</p>
<p><code>vpub5SLqN2bLY4WeXxMqwJHJFBEwxSscGB2uDUnsTS3edVjZEwTrQDFDNqoR2xLqARQPabGaXsHSTenTRcqm2EnB9MpuC4vSk3LqSgNmGGZtuq7</code></p>
@ -131,17 +131,17 @@ println(rootXPub)
again after initializing it once. You can use the same <code>mnemonic</code> for different networks, which you control <code>KeyManagerParams</code>.</p>
<pre><code class="hljs css language-scala"><span class="hljs-comment">//let&#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-comment">// mainnetKmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example7997965906490194400/encrypted-bitcoin-s-seed.json,m/84&#x27;,MainNet)</span>
<span class="hljs-comment">// mainnetKmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example9193503986677380488/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-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@627dca7b</span>
<span class="hljs-comment">// mainnetKeyManager: BIP39KeyManager = org.bitcoins.keymanager.bip39.BIP39KeyManager@4c5612cc</span>
<span class="hljs-keyword">val</span> mainnetXpub = mainnetKeyManager.getRootXPub
<span class="hljs-comment">// mainnetXpub: ExtPublicKey = zpub6jftahH18ngZyCg21SVBERsfE77FBGQkcum6JSf5wTfom1mC5vzhSVG88PFf2bEcuVHheEdzhxdjS8M6KxvHwrgbCjbsvYJNSEuLieQiBbE</span>
<span class="hljs-comment">// mainnetXpub: ExtPublicKey = zpub6jftahH18ngZyB7UavWSQ7ymH2ZpJyAUSvXXuYLrccD1adBVJDdy8XaRE8r8cBuXf6QcKe9SqZAtGNPUvw1u2FGPGFMimpvbi7yer1hBRLc</span>
println(mainnetXpub)
<span class="hljs-comment">// zpub6jftahH18ngZyCg21SVBERsfE77FBGQkcum6JSf5wTfom1mC5vzhSVG88PFf2bEcuVHheEdzhxdjS8M6KxvHwrgbCjbsvYJNSEuLieQiBbE</span>
<span class="hljs-comment">// zpub6jftahH18ngZyB7UavWSQ7ymH2ZpJyAUSvXXuYLrccD1adBVJDdy8XaRE8r8cBuXf6QcKe9SqZAtGNPUvw1u2FGPGFMimpvbi7yer1hBRLc</span>
</code></pre>
<p>Which gives us something that looks like this</p>
<p><code>zpub6jftahH18ngZw98KGjRo5XcxeKTQ2eztsvskb1dC9XF5TLimQquTs6Ry7nBBA425D9joXmfgJJCexmJ1u2SELJZJfRi95gcnXadLpZzYb5c</code></p>

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

@ -114,12 +114,12 @@ println(<span class="hljs-string">s&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
<span class="hljs-comment">// privKey: ECPrivateKey = Masked(ECPrivateKeyImpl)</span>
<span class="hljs-keyword">val</span> publicKey = privKey.publicKeyWithBouncyCastle
<span class="hljs-comment">// publicKey: ECPublicKey = ECPublicKey(0367ac24dadf6ba5518909ed0a19fc02867d199a653ac9cd72fe7da2b161fbddc6)</span>
<span class="hljs-comment">// publicKey: ECPublicKey = ECPublicKey(03574683836b72a587ca8bb36959ab6e1b6347739c3e1b291a92eb05f1272d1f41)</span>
<span class="hljs-keyword">val</span> dataToSign = <span class="hljs-type">DoubleSha256Digest</span>.empty
<span class="hljs-comment">// dataToSign: DoubleSha256Digest = DoubleSha256Digest(0000000000000000000000000000000000000000000000000000000000000000)</span>
<span class="hljs-keyword">val</span> signature = privKey.signWithBouncyCastle(dataToSign.bytes)
<span class="hljs-comment">// signature: ECDigitalSignature = ECDigitalSignature(30440220124e511ea98cef90eb40e20824ba3e9106e792d962191fb190a6b7532b4aabe7022019368c843a3d99211984eac23f3dd7a258e1f6aa0fa581431c19f61787ccce25)</span>
<span class="hljs-comment">// signature: ECDigitalSignature = ECDigitalSignature(3045022100bcf20b6c9e7843ee87ec7009af2e07fb5e5151cf67fd3eb63cefc573776d50d902205ad521555346466b39b9872a59ee86bb5e159e726f93f5f0e65dc0aa1d63cbae)</span>
<span class="hljs-keyword">val</span> verified = publicKey.verifyWithBouncyCastle(dataToSign.bytes, signature)
<span class="hljs-comment">// verified: Boolean = true</span>

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

@ -114,12 +114,12 @@ println(<span class="hljs-string">s&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
<span class="hljs-comment">// privKey: ECPrivateKey = Masked(ECPrivateKeyImpl)</span>
<span class="hljs-keyword">val</span> publicKey = privKey.publicKeyWithBouncyCastle
<span class="hljs-comment">// publicKey: ECPublicKey = ECPublicKey(0367ac24dadf6ba5518909ed0a19fc02867d199a653ac9cd72fe7da2b161fbddc6)</span>
<span class="hljs-comment">// publicKey: ECPublicKey = ECPublicKey(03574683836b72a587ca8bb36959ab6e1b6347739c3e1b291a92eb05f1272d1f41)</span>
<span class="hljs-keyword">val</span> dataToSign = <span class="hljs-type">DoubleSha256Digest</span>.empty
<span class="hljs-comment">// dataToSign: DoubleSha256Digest = DoubleSha256Digest(0000000000000000000000000000000000000000000000000000000000000000)</span>
<span class="hljs-keyword">val</span> signature = privKey.signWithBouncyCastle(dataToSign.bytes)
<span class="hljs-comment">// signature: ECDigitalSignature = ECDigitalSignature(30440220124e511ea98cef90eb40e20824ba3e9106e792d962191fb190a6b7532b4aabe7022019368c843a3d99211984eac23f3dd7a258e1f6aa0fa581431c19f61787ccce25)</span>
<span class="hljs-comment">// signature: ECDigitalSignature = ECDigitalSignature(3045022100bcf20b6c9e7843ee87ec7009af2e07fb5e5151cf67fd3eb63cefc573776d50d902205ad521555346466b39b9872a59ee86bb5e159e726f93f5f0e65dc0aa1d63cbae)</span>
<span class="hljs-keyword">val</span> verified = publicKey.verifyWithBouncyCastle(dataToSign.bytes, signature)
<span class="hljs-comment">// verified: Boolean = true</span>