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

Deploy website

Browse source 
Deploy website version based on c5be81d5e2
This commit is contained in:
Docusaurus bot 2020-10-13 12:02:03 +00:00
parent 9928475b0f
commit ae0a1dd961
16 changed files with 100 additions and 100 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-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(028207c1da92e90bf8ebd3fc939696570aa845ae4c6452f9fc091d20ee5fcb6736)</span>
<span class="hljs-comment">// pubkey: org.bitcoins.crypto.ECPublicKey = ECPublicKey(02d41553f24a71b90f28a3725ea3d699157b77a67681b322ac4fd5379377cfe300)</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 = tb1qpgesvc5nzkh9aq3pa8qp30lmrx7ars0d4f8cwt</span>
<span class="hljs-comment">// segwitAddress: Bech32Address = tb1q7k2vfn0jc0jngjnrxpc8hlhga3ewhw70zv6afq</span>
println(segwitAddress.toString)
<span class="hljs-comment">// tb1qpgesvc5nzkh9aq3pa8qp30lmrx7ars0d4f8cwt</span>
<span class="hljs-comment">// tb1q7k2vfn0jc0jngjnrxpc8hlhga3ewhw70zv6afq</span>
</code></pre>
<h2><a class="anchor" aria-hidden="true" id="generating-legacy-base58-addresses"></a><a href="#generating-legacy-base58-addresses" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Generating legacy (base58) addresses</h2>
<p>If you need to generate legacy addresses for backwards
@ -101,10 +101,10 @@ Take a look:</p>
<pre><code class="hljs css language-scala"><span class="hljs-comment">// we're reusing the same private/public key pair</span>
<span class="hljs-comment">// from before. don't do this in an actual application!</span>
<span class="hljs-keyword">val</span> legacyAddress = <span class="hljs-type">P2PKHAddress</span>(pubkey, <span class="hljs-type">TestNet3</span>)
<span class="hljs-comment">// legacyAddress: P2PKHAddress = mgStBFJajv3fWUVdDwkd4BFcFNBEyGdmAY</span>
<span class="hljs-comment">// legacyAddress: P2PKHAddress = n3uU4gqXLBohzmMetm5H44HM4fuzLr6Bf5</span>
println(legacyAddress.toString)
<span class="hljs-comment">// mgStBFJajv3fWUVdDwkd4BFcFNBEyGdmAY</span>
<span class="hljs-comment">// n3uU4gqXLBohzmMetm5H44HM4fuzLr6Bf5</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 © 2020 Suredbits &amp; the bitcoin-s developers</section></footer></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script><script>
document.addEventListener('keyup', function(e) {

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(028207c1da92e90bf8ebd3fc939696570aa845ae4c6452f9fc091d20ee5fcb6736)</span>
<span class="hljs-comment">// pubkey: org.bitcoins.crypto.ECPublicKey = ECPublicKey(02d41553f24a71b90f28a3725ea3d699157b77a67681b322ac4fd5379377cfe300)</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 = tb1qpgesvc5nzkh9aq3pa8qp30lmrx7ars0d4f8cwt</span>
<span class="hljs-comment">// segwitAddress: Bech32Address = tb1q7k2vfn0jc0jngjnrxpc8hlhga3ewhw70zv6afq</span>
println(segwitAddress.toString)
<span class="hljs-comment">// tb1qpgesvc5nzkh9aq3pa8qp30lmrx7ars0d4f8cwt</span>
<span class="hljs-comment">// tb1q7k2vfn0jc0jngjnrxpc8hlhga3ewhw70zv6afq</span>
</code></pre>
<h2><a class="anchor" aria-hidden="true" id="generating-legacy-base58-addresses"></a><a href="#generating-legacy-base58-addresses" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Generating legacy (base58) addresses</h2>
<p>If you need to generate legacy addresses for backwards
@ -101,10 +101,10 @@ Take a look:</p>
<pre><code class="hljs css language-scala"><span class="hljs-comment">// we're reusing the same private/public key pair</span>
<span class="hljs-comment">// from before. don't do this in an actual application!</span>
<span class="hljs-keyword">val</span> legacyAddress = <span class="hljs-type">P2PKHAddress</span>(pubkey, <span class="hljs-type">TestNet3</span>)
<span class="hljs-comment">// legacyAddress: P2PKHAddress = mgStBFJajv3fWUVdDwkd4BFcFNBEyGdmAY</span>
<span class="hljs-comment">// legacyAddress: P2PKHAddress = n3uU4gqXLBohzmMetm5H44HM4fuzLr6Bf5</span>
println(legacyAddress.toString)
<span class="hljs-comment">// mgStBFJajv3fWUVdDwkd4BFcFNBEyGdmAY</span>
<span class="hljs-comment">// n3uU4gqXLBohzmMetm5H44HM4fuzLr6Bf5</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 © 2020 Suredbits &amp; the bitcoin-s developers</section></footer></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script><script>
document.addEventListener('keyup', function(e) {

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, 0xaeb2ee142d6d13ee0409195b74edc60df9fcecf0e1df49b6f3da7479ee3f2aeb)</span>
<span class="hljs-comment">// entropy: BitVector = BitVector(256 bits, 0xc4e1ace3e7c8581259c0de798a6a63767526a6fdb0a100930e26e3bb025b0b1a)</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(push, number, lunar, food, spell, warfare, awake, case, fork, polar, immense, brief, panther, island, seminar, desk, endless, resource, walk, trophy, page, buzz, produce, hurdle) // the phrase the user should write down</span>
<span class="hljs-comment">// res0: Vector[String] = Vector(shaft, aspect, decline, sort, machine, ankle, grow, bridge, kangaroo, fashion, occur, undo, fame, fat, walnut, before, above, observe, meadow, shuffle, rabbit, collect, cluster, fade) // 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 = zpub6jftahH18ngZxBgzJSMHrP6YvrdPLuJ3gjQgh81HU9NwE4yQBoGopnk36E5a2b4oQQfRvfdJLYy1Wyz6Pj5fqPdVTWBsTSoUWvNHX6HjTS6</span>
<span class="hljs-comment">// xpub: ExtPublicKey = zpub6jftahH18ngZx62AtyT4iM4Cu1dfjdwwTBgWstqyAhoMeyUvAJb67XrPWV7pWHNCVNEvSWdMp4QaAUA3NL2CXiGTBNX91vhWehNcorLXX2J</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 = zpub6rd6aQ82FiRVUrn3Ne4pAkskwvrE85iYAsTEPokj7aWXdcMmFNnp4CJLow7muUjmaJjUS3FQF7ZweY9T2YqqCiQWKBJV1C4dLTrDDYPFaFC</span>
<span class="hljs-comment">// accountXpub: ExtPublicKey = zpub6qaAmfRwhAyJ9ULHrk7X5Hw9Qj3CqZQsPhBka1eyCiSkuoiAFzkviggwmQDTt8N6k13dyExjHxn2e7yacwTBG1Wj4R4hwJbauG2dPU6fVNR</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 = tb1q2ym807y3zaefjm8clem6409u62m6c0as0w4j6w</span>
<span class="hljs-comment">// firstAccountAddress: Bech32Address = tb1q5qemu484r8t9nz966sdtusnt75ks2lq556xd0c</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 = tb1q2ym807y3zaefjm8clem6409u62m6c0as0w4j6w</span>
<span class="hljs-comment">// res2: String = tb1q5qemu484r8t9nz966sdtusnt75ks2lq556xd0c</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, 0xaeb2ee142d6d13ee0409195b74edc60df9fcecf0e1df49b6f3da7479ee3f2aeb)</span>
<span class="hljs-comment">// entropy: BitVector = BitVector(256 bits, 0xc4e1ace3e7c8581259c0de798a6a63767526a6fdb0a100930e26e3bb025b0b1a)</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(push, number, lunar, food, spell, warfare, awake, case, fork, polar, immense, brief, panther, island, seminar, desk, endless, resource, walk, trophy, page, buzz, produce, hurdle) // the phrase the user should write down</span>
<span class="hljs-comment">// res0: Vector[String] = Vector(shaft, aspect, decline, sort, machine, ankle, grow, bridge, kangaroo, fashion, occur, undo, fame, fat, walnut, before, above, observe, meadow, shuffle, rabbit, collect, cluster, fade) // 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 = zpub6jftahH18ngZxBgzJSMHrP6YvrdPLuJ3gjQgh81HU9NwE4yQBoGopnk36E5a2b4oQQfRvfdJLYy1Wyz6Pj5fqPdVTWBsTSoUWvNHX6HjTS6</span>
<span class="hljs-comment">// xpub: ExtPublicKey = zpub6jftahH18ngZx62AtyT4iM4Cu1dfjdwwTBgWstqyAhoMeyUvAJb67XrPWV7pWHNCVNEvSWdMp4QaAUA3NL2CXiGTBNX91vhWehNcorLXX2J</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 = zpub6rd6aQ82FiRVUrn3Ne4pAkskwvrE85iYAsTEPokj7aWXdcMmFNnp4CJLow7muUjmaJjUS3FQF7ZweY9T2YqqCiQWKBJV1C4dLTrDDYPFaFC</span>
<span class="hljs-comment">// accountXpub: ExtPublicKey = zpub6qaAmfRwhAyJ9ULHrk7X5Hw9Qj3CqZQsPhBka1eyCiSkuoiAFzkviggwmQDTt8N6k13dyExjHxn2e7yacwTBG1Wj4R4hwJbauG2dPU6fVNR</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 = tb1q2ym807y3zaefjm8clem6409u62m6c0as0w4j6w</span>
<span class="hljs-comment">// firstAccountAddress: Bech32Address = tb1q5qemu484r8t9nz966sdtusnt75ks2lq556xd0c</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 = tb1q2ym807y3zaefjm8clem6409u62m6c0as0w4j6w</span>
<span class="hljs-comment">// res2: String = tb1q5qemu484r8t9nz966sdtusnt75ks2lq556xd0c</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@3e76465f[Running, parallelism = 2, size = 2, active = 0, running = 0, steals = 3, tasks = 0, submissions = 0]</span>
<span class="hljs-comment">// ec: ExecutionContext = scala.concurrent.impl.ExecutionContextImpl$$anon$3@4b35fbe6[Running, parallelism = 2, size = 2, active = 0, running = 0, steals = 3, 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(034e47d7a755ac3a49d9b70f45635301debbeadb8ed8a456718dffe3dc16f86ff0)</span>
<span class="hljs-comment">// pubKey: ECPublicKey = ECPublicKey(023f8e7b0906e988a47af820836ab02ff6400eb42d0d0c648788a7895d94ea4a94)</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(9fcfa09c1aa56b944718e25b8a815ae39b7ca39d)</span>
<span class="hljs-comment">// creditingSpk: P2PKHScriptPubKey = pkh(bcc50664a6e224b49a80029b3368675c884c36d2)</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(9fcfa09c1aa56b944718e25b8a815ae39b7ca39d))</span>
<span class="hljs-comment">// utxo: TransactionOutput = TransactionOutput(10000 sats,pkh(bcc50664a6e224b49a80029b3368675c884c36d2))</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(ebb8fa3f56457860f6eb43ac3d39aab9b9e25926)</span>
<span class="hljs-comment">// destinationSPK: P2PKHScriptPubKey = pkh(e93e5556f862f4f9fdcdc33cb15495df47e0a22b)</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(ebb8fa3f56457860f6eb43ac3d39aab9b9e25926)))</span>
<span class="hljs-comment">// destinations: Vector[TransactionOutput] = Vector(TransactionOutput(5000 sats,pkh(e93e5556f862f4f9fdcdc33cb15495df47e0a22b)))</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(9fcfa09c1aa56b944718e25b8a815ae39b7ca39d))),UInt32Impl(0))</span>
<span class="hljs-comment">// creditingTx: BaseTransaction = BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(bcc50664a6e224b49a80029b3368675c884c36d2))),UInt32Impl(0))</span>
<span class="hljs-comment">// this is the information we need from the crediting TX</span>
<span class="hljs-comment">// to properly "link" it in the transaction we are creating</span>
<span class="hljs-keyword">val</span> outPoint = <span class="hljs-type">TransactionOutPoint</span>(creditingTx.txId, <span class="hljs-type">UInt32</span>.zero)
<span class="hljs-comment">// outPoint: TransactionOutPoint = TransactionOutPoint(6a10b795737194b965ae35afa31d9500a200ef91e61750f972e1fbcbed54e916:0)</span>
<span class="hljs-comment">// outPoint: TransactionOutPoint = TransactionOutPoint(88fc0804ca456d4becc828df8c34c4ab59d25e95b1b1cae732451252e2a482f6: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(6a10b795737194b965ae35afa31d9500a200ef91e61750f972e1fbcbed54e916:0),EmptyScriptSignature,UInt32Impl(0))</span>
<span class="hljs-comment">// input: TransactionInput = TransactionInputImpl(TransactionOutPoint(88fc0804ca456d4becc828df8c34c4ab59d25e95b1b1cae732451252e2a482f6: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(6a10b795737194b965ae35afa31d9500a200ef91e61750f972e1fbcbed54e916:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(ebb8fa3f56457860f6eb43ac3d39aab9b9e25926))),UInt32Impl(0))</span>
<span class="hljs-comment">// builderResult: RawTxBuilderResult = RawTxBuilderResult(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(88fc0804ca456d4becc828df8c34c4ab59d25e95b1b1cae732451252e2a482f6:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(e93e5556f862f4f9fdcdc33cb15495df47e0a22b))),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(6a10b795737194b965ae35afa31d9500a200ef91e61750f972e1fbcbed54e916:0),10000 sats,ECPublicKey(034e47d7a755ac3a49d9b70f45635301debbeadb8ed8a456718dffe3dc16f86ff0))</span>
<span class="hljs-comment">// inputInfo: P2PKHInputInfo = P2PKHInputInfo(TransactionOutPoint(88fc0804ca456d4becc828df8c34c4ab59d25e95b1b1cae732451252e2a482f6:0),10000 sats,ECPublicKey(023f8e7b0906e988a47af820836ab02ff6400eb42d0d0c648788a7895d94ea4a94))</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(59f766c3957e5ce9bd5e384b2f7489590ef31992)</span>
<span class="hljs-comment">// changeSPK: P2PKHScriptPubKey = pkh(6dd5055d17a49a2015a609896a77058912011600)</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(6a10b795737194b965ae35afa31d9500a200ef91e61750f972e1fbcbed54e916:0),10000 sats,ECPublicKey(034e47d7a755ac3a49d9b70f45635301debbeadb8ed8a456718dffe3dc16f86ff0))),SatoshisPerByte(1 sat),pkh(59f766c3957e5ce9bd5e384b2f7489590ef31992))</span>
<span class="hljs-comment">// finalizer: StandardNonInteractiveFinalizer = StandardNonInteractiveFinalizer(Vector(P2PKHInputInfo(TransactionOutPoint(88fc0804ca456d4becc828df8c34c4ab59d25e95b1b1cae732451252e2a482f6:0),10000 sats,ECPublicKey(023f8e7b0906e988a47af820836ab02ff6400eb42d0d0c648788a7895d94ea4a94))),SatoshisPerByte(1 sat),pkh(6dd5055d17a49a2015a609896a77058912011600))</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(6a10b795737194b965ae35afa31d9500a200ef91e61750f972e1fbcbed54e916:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(ebb8fa3f56457860f6eb43ac3d39aab9b9e25926)), TransactionOutput(4775 sats,pkh(59f766c3957e5ce9bd5e384b2f7489590ef31992))),UInt32Impl(0))))</span>
<span class="hljs-comment">// unsignedTxF: Future[Transaction] = Future(Success(BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(88fc0804ca456d4becc828df8c34c4ab59d25e95b1b1cae732451252e2a482f6:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(e93e5556f862f4f9fdcdc33cb15495df47e0a22b)), TransactionOutput(4775 sats,pkh(6dd5055d17a49a2015a609896a77058912011600))),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(6a10b795737194b965ae35afa31d9500a200ef91e61750f972e1fbcbed54e916:0),10000 sats,ECPublicKey(034e47d7a755ac3a49d9b70f45635301debbeadb8ed8a456718dffe3dc16f86ff0)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(9fcfa09c1aa56b944718e25b8a815ae39b7ca39d))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1)))</span>
<span class="hljs-comment">// utxoInfo: ScriptSignatureParams[P2PKHInputInfo] = ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(88fc0804ca456d4becc828df8c34c4ab59d25e95b1b1cae732451252e2a482f6:0),10000 sats,ECPublicKey(023f8e7b0906e988a47af820836ab02ff6400eb42d0d0c648788a7895d94ea4a94)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(bcc50664a6e224b49a80029b3368675c884c36d2))),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(6a10b795737194b965ae35afa31d9500a200ef91e61750f972e1fbcbed54e916:0),10000 sats,ECPublicKey(034e47d7a755ac3a49d9b70f45635301debbeadb8ed8a456718dffe3dc16f86ff0)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(9fcfa09c1aa56b944718e25b8a815ae39b7ca39d))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1))))</span>
<span class="hljs-comment">// utxoInfos: Vector[ScriptSignatureParams[InputInfo]] = Vector(ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(88fc0804ca456d4becc828df8c34c4ab59d25e95b1b1cae732451252e2a482f6:0),10000 sats,ECPublicKey(023f8e7b0906e988a47af820836ab02ff6400eb42d0d0c648788a7895d94ea4a94)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(bcc50664a6e224b49a80029b3368675c884c36d2))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1))))</span>
<span class="hljs-comment">// Yay! Now we use the RawTxSigner object to sign the tx.</span>
<span class="hljs-comment">// The 'sign' method is going produce a validly signed transaction</span>
@ -201,7 +201,7 @@ builder += input
}
<span class="hljs-type">Await</span>.result(signedTxF, <span class="hljs-number">30.</span>seconds)
}
<span class="hljs-comment">// signedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(6a10b795737194b965ae35afa31d9500a200ef91e61750f972e1fbcbed54e916:0),P2PKHScriptSignature(ECPublicKey(034e47d7a755ac3a49d9b70f45635301debbeadb8ed8a456718dffe3dc16f86ff0), ECDigitalSignature(30440220291f38aa3547b2dfb61d66d5655f25a86096df700532c421403d66ad62f499a402202fe0f1cc7643c9105da709faf24d439863a42fb23bcebb65000e3a2d6e857ba601)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(ebb8fa3f56457860f6eb43ac3d39aab9b9e25926)), TransactionOutput(4775 sats,pkh(59f766c3957e5ce9bd5e384b2f7489590ef31992))),UInt32Impl(0))</span>
<span class="hljs-comment">// signedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(88fc0804ca456d4becc828df8c34c4ab59d25e95b1b1cae732451252e2a482f6:0),P2PKHScriptSignature(ECPublicKey(023f8e7b0906e988a47af820836ab02ff6400eb42d0d0c648788a7895d94ea4a94), ECDigitalSignature(30440220134a4493cd552f2b8e4fe1cee516941d8f62340fb0cf4500122dbec71fea01b702206a3e58e5e40c2b734fda87d340be6b5534c06bd31d1400b84cf3f0868303937001)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(e93e5556f862f4f9fdcdc33cb15495df47e0a22b)), TransactionOutput(4775 sats,pkh(6dd5055d17a49a2015a609896a77058912011600))),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 = 020000000116e954edcbfbe172f95017e691ef00a200951da3af35ae65b994717395b7106a000000006a4730440220291f38aa3547b2dfb61d66d5655f25a86096df700532c421403d66ad62f499a402202fe0f1cc7643c9105da709faf24d439863a42fb23bcebb65000e3a2d6e857ba60121034e47d7a755ac3a49d9b70f45635301debbeadb8ed8a456718dffe3dc16f86ff0000000000288130000000000001976a914ebb8fa3f56457860f6eb43ac3d39aab9b9e2592688aca7120000000000001976a91459f766c3957e5ce9bd5e384b2f7489590ef3199288ac00000000</span>
<span class="hljs-comment">// res4: String = 0200000001f682a4e252124532e7cab1b1955ed259abc4348cdf28c8ec4b6d45ca0408fc88000000006a4730440220134a4493cd552f2b8e4fe1cee516941d8f62340fb0cf4500122dbec71fea01b702206a3e58e5e40c2b734fda87d340be6b5534c06bd31d1400b84cf3f086830393700121023f8e7b0906e988a47af820836ab02ff6400eb42d0d0c648788a7895d94ea4a94000000000288130000000000001976a914e93e5556f862f4f9fdcdc33cb15495df47e0a22b88aca7120000000000001976a9146dd5055d17a49a2015a609896a7705891201160088ac00000000</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 © 2020 Suredbits &amp; the bitcoin-s developers</section></footer></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script><script>
document.addEventListener('keyup', function(e) {

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@3e76465f[Running, parallelism = 2, size = 2, active = 0, running = 0, steals = 3, tasks = 0, submissions = 0]</span>
<span class="hljs-comment">// ec: ExecutionContext = scala.concurrent.impl.ExecutionContextImpl$$anon$3@4b35fbe6[Running, parallelism = 2, size = 2, active = 0, running = 0, steals = 3, 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(034e47d7a755ac3a49d9b70f45635301debbeadb8ed8a456718dffe3dc16f86ff0)</span>
<span class="hljs-comment">// pubKey: ECPublicKey = ECPublicKey(023f8e7b0906e988a47af820836ab02ff6400eb42d0d0c648788a7895d94ea4a94)</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(9fcfa09c1aa56b944718e25b8a815ae39b7ca39d)</span>
<span class="hljs-comment">// creditingSpk: P2PKHScriptPubKey = pkh(bcc50664a6e224b49a80029b3368675c884c36d2)</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(9fcfa09c1aa56b944718e25b8a815ae39b7ca39d))</span>
<span class="hljs-comment">// utxo: TransactionOutput = TransactionOutput(10000 sats,pkh(bcc50664a6e224b49a80029b3368675c884c36d2))</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(ebb8fa3f56457860f6eb43ac3d39aab9b9e25926)</span>
<span class="hljs-comment">// destinationSPK: P2PKHScriptPubKey = pkh(e93e5556f862f4f9fdcdc33cb15495df47e0a22b)</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(ebb8fa3f56457860f6eb43ac3d39aab9b9e25926)))</span>
<span class="hljs-comment">// destinations: Vector[TransactionOutput] = Vector(TransactionOutput(5000 sats,pkh(e93e5556f862f4f9fdcdc33cb15495df47e0a22b)))</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(9fcfa09c1aa56b944718e25b8a815ae39b7ca39d))),UInt32Impl(0))</span>
<span class="hljs-comment">// creditingTx: BaseTransaction = BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(bcc50664a6e224b49a80029b3368675c884c36d2))),UInt32Impl(0))</span>
<span class="hljs-comment">// this is the information we need from the crediting TX</span>
<span class="hljs-comment">// to properly "link" it in the transaction we are creating</span>
<span class="hljs-keyword">val</span> outPoint = <span class="hljs-type">TransactionOutPoint</span>(creditingTx.txId, <span class="hljs-type">UInt32</span>.zero)
<span class="hljs-comment">// outPoint: TransactionOutPoint = TransactionOutPoint(6a10b795737194b965ae35afa31d9500a200ef91e61750f972e1fbcbed54e916:0)</span>
<span class="hljs-comment">// outPoint: TransactionOutPoint = TransactionOutPoint(88fc0804ca456d4becc828df8c34c4ab59d25e95b1b1cae732451252e2a482f6: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(6a10b795737194b965ae35afa31d9500a200ef91e61750f972e1fbcbed54e916:0),EmptyScriptSignature,UInt32Impl(0))</span>
<span class="hljs-comment">// input: TransactionInput = TransactionInputImpl(TransactionOutPoint(88fc0804ca456d4becc828df8c34c4ab59d25e95b1b1cae732451252e2a482f6: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(6a10b795737194b965ae35afa31d9500a200ef91e61750f972e1fbcbed54e916:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(ebb8fa3f56457860f6eb43ac3d39aab9b9e25926))),UInt32Impl(0))</span>
<span class="hljs-comment">// builderResult: RawTxBuilderResult = RawTxBuilderResult(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(88fc0804ca456d4becc828df8c34c4ab59d25e95b1b1cae732451252e2a482f6:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(e93e5556f862f4f9fdcdc33cb15495df47e0a22b))),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(6a10b795737194b965ae35afa31d9500a200ef91e61750f972e1fbcbed54e916:0),10000 sats,ECPublicKey(034e47d7a755ac3a49d9b70f45635301debbeadb8ed8a456718dffe3dc16f86ff0))</span>
<span class="hljs-comment">// inputInfo: P2PKHInputInfo = P2PKHInputInfo(TransactionOutPoint(88fc0804ca456d4becc828df8c34c4ab59d25e95b1b1cae732451252e2a482f6:0),10000 sats,ECPublicKey(023f8e7b0906e988a47af820836ab02ff6400eb42d0d0c648788a7895d94ea4a94))</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(59f766c3957e5ce9bd5e384b2f7489590ef31992)</span>
<span class="hljs-comment">// changeSPK: P2PKHScriptPubKey = pkh(6dd5055d17a49a2015a609896a77058912011600)</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(6a10b795737194b965ae35afa31d9500a200ef91e61750f972e1fbcbed54e916:0),10000 sats,ECPublicKey(034e47d7a755ac3a49d9b70f45635301debbeadb8ed8a456718dffe3dc16f86ff0))),SatoshisPerByte(1 sat),pkh(59f766c3957e5ce9bd5e384b2f7489590ef31992))</span>
<span class="hljs-comment">// finalizer: StandardNonInteractiveFinalizer = StandardNonInteractiveFinalizer(Vector(P2PKHInputInfo(TransactionOutPoint(88fc0804ca456d4becc828df8c34c4ab59d25e95b1b1cae732451252e2a482f6:0),10000 sats,ECPublicKey(023f8e7b0906e988a47af820836ab02ff6400eb42d0d0c648788a7895d94ea4a94))),SatoshisPerByte(1 sat),pkh(6dd5055d17a49a2015a609896a77058912011600))</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(6a10b795737194b965ae35afa31d9500a200ef91e61750f972e1fbcbed54e916:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(ebb8fa3f56457860f6eb43ac3d39aab9b9e25926)), TransactionOutput(4775 sats,pkh(59f766c3957e5ce9bd5e384b2f7489590ef31992))),UInt32Impl(0))))</span>
<span class="hljs-comment">// unsignedTxF: Future[Transaction] = Future(Success(BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(88fc0804ca456d4becc828df8c34c4ab59d25e95b1b1cae732451252e2a482f6:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(e93e5556f862f4f9fdcdc33cb15495df47e0a22b)), TransactionOutput(4775 sats,pkh(6dd5055d17a49a2015a609896a77058912011600))),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(6a10b795737194b965ae35afa31d9500a200ef91e61750f972e1fbcbed54e916:0),10000 sats,ECPublicKey(034e47d7a755ac3a49d9b70f45635301debbeadb8ed8a456718dffe3dc16f86ff0)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(9fcfa09c1aa56b944718e25b8a815ae39b7ca39d))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1)))</span>
<span class="hljs-comment">// utxoInfo: ScriptSignatureParams[P2PKHInputInfo] = ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(88fc0804ca456d4becc828df8c34c4ab59d25e95b1b1cae732451252e2a482f6:0),10000 sats,ECPublicKey(023f8e7b0906e988a47af820836ab02ff6400eb42d0d0c648788a7895d94ea4a94)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(bcc50664a6e224b49a80029b3368675c884c36d2))),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(6a10b795737194b965ae35afa31d9500a200ef91e61750f972e1fbcbed54e916:0),10000 sats,ECPublicKey(034e47d7a755ac3a49d9b70f45635301debbeadb8ed8a456718dffe3dc16f86ff0)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(9fcfa09c1aa56b944718e25b8a815ae39b7ca39d))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1))))</span>
<span class="hljs-comment">// utxoInfos: Vector[ScriptSignatureParams[InputInfo]] = Vector(ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(88fc0804ca456d4becc828df8c34c4ab59d25e95b1b1cae732451252e2a482f6:0),10000 sats,ECPublicKey(023f8e7b0906e988a47af820836ab02ff6400eb42d0d0c648788a7895d94ea4a94)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(bcc50664a6e224b49a80029b3368675c884c36d2))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1))))</span>
<span class="hljs-comment">// Yay! Now we use the RawTxSigner object to sign the tx.</span>
<span class="hljs-comment">// The 'sign' method is going produce a validly signed transaction</span>
@ -201,7 +201,7 @@ builder += input
}
<span class="hljs-type">Await</span>.result(signedTxF, <span class="hljs-number">30.</span>seconds)
}
<span class="hljs-comment">// signedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(6a10b795737194b965ae35afa31d9500a200ef91e61750f972e1fbcbed54e916:0),P2PKHScriptSignature(ECPublicKey(034e47d7a755ac3a49d9b70f45635301debbeadb8ed8a456718dffe3dc16f86ff0), ECDigitalSignature(30440220291f38aa3547b2dfb61d66d5655f25a86096df700532c421403d66ad62f499a402202fe0f1cc7643c9105da709faf24d439863a42fb23bcebb65000e3a2d6e857ba601)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(ebb8fa3f56457860f6eb43ac3d39aab9b9e25926)), TransactionOutput(4775 sats,pkh(59f766c3957e5ce9bd5e384b2f7489590ef31992))),UInt32Impl(0))</span>
<span class="hljs-comment">// signedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(88fc0804ca456d4becc828df8c34c4ab59d25e95b1b1cae732451252e2a482f6:0),P2PKHScriptSignature(ECPublicKey(023f8e7b0906e988a47af820836ab02ff6400eb42d0d0c648788a7895d94ea4a94), ECDigitalSignature(30440220134a4493cd552f2b8e4fe1cee516941d8f62340fb0cf4500122dbec71fea01b702206a3e58e5e40c2b734fda87d340be6b5534c06bd31d1400b84cf3f0868303937001)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(e93e5556f862f4f9fdcdc33cb15495df47e0a22b)), TransactionOutput(4775 sats,pkh(6dd5055d17a49a2015a609896a77058912011600))),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 = 020000000116e954edcbfbe172f95017e691ef00a200951da3af35ae65b994717395b7106a000000006a4730440220291f38aa3547b2dfb61d66d5655f25a86096df700532c421403d66ad62f499a402202fe0f1cc7643c9105da709faf24d439863a42fb23bcebb65000e3a2d6e857ba60121034e47d7a755ac3a49d9b70f45635301debbeadb8ed8a456718dffe3dc16f86ff0000000000288130000000000001976a914ebb8fa3f56457860f6eb43ac3d39aab9b9e2592688aca7120000000000001976a91459f766c3957e5ce9bd5e384b2f7489590ef3199288ac00000000</span>
<span class="hljs-comment">// res4: String = 0200000001f682a4e252124532e7cab1b1955ed259abc4348cdf28c8ec4b6d45ca0408fc88000000006a4730440220134a4493cd552f2b8e4fe1cee516941d8f62340fb0cf4500122dbec71fea01b702206a3e58e5e40c2b734fda87d340be6b5534c06bd31d1400b84cf3f086830393700121023f8e7b0906e988a47af820836ab02ff6400eb42d0d0c648788a7895d94ea4a94000000000288130000000000001976a914e93e5556f862f4f9fdcdc33cb15495df47e0a22b88aca7120000000000001976a9146dd5055d17a49a2015a609896a7705891201160088ac00000000</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 © 2020 Suredbits &amp; the bitcoin-s developers</section></footer></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script><script>
document.addEventListener('keyup', function(e) {

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(3045022100bf9d1da7829622d816a9cc2a0a951ba06323ff12b6433a59871c8e7ba7af48eb02207fff22897c4f3d9cb85648dbd99e5b13da4aa3966306ec227f5b6956155cf7c8)</span>
<span class="hljs-comment">// res0: ECDigitalSignature = ECDigitalSignature(3045022100c5e1a57739ac03534f769605b0c65fa00775f345c892c33163b2604dee55926e02207f56d361299575c0ef3e2a8f69065e4c50ad22c2ffeddb216fd9a1a4fc1e1f47)</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(3045022100deec8f7e1e348ea9a189b9cb4d12598bfe05756625d63755c51a371280d8a2b902201a0bf4e20060f97040a180a86d3f1c66a569721fdbb4142998612586888657af)</span>
<span class="hljs-comment">// res1: ECDigitalSignature = ECDigitalSignature(30440220601ce76d59cbd1b47944e01b5003f6806319fb31b95077ca8e85b1115b157b1e022028bc452c07d04394c73ec86549fd3b3b6f2c2cc3d7b57e5b4e95b577ba2ad7bd)</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(3045022100bf9d1da7829622d816a9cc2a0a951ba06323ff12b6433a59871c8e7ba7af48eb02207fff22897c4f3d9cb85648dbd99e5b13da4aa3966306ec227f5b6956155cf7c8)</span>
<span class="hljs-comment">// res0: ECDigitalSignature = ECDigitalSignature(3045022100c5e1a57739ac03534f769605b0c65fa00775f345c892c33163b2604dee55926e02207f56d361299575c0ef3e2a8f69065e4c50ad22c2ffeddb216fd9a1a4fc1e1f47)</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(3045022100deec8f7e1e348ea9a189b9cb4d12598bfe05756625d63755c51a371280d8a2b902201a0bf4e20060f97040a180a86d3f1c66a569721fdbb4142998612586888657af)</span>
<span class="hljs-comment">// res1: ECDigitalSignature = ECDigitalSignature(30440220601ce76d59cbd1b47944e01b5003f6806319fb31b95077ca8e85b1115b157b1e022028bc452c07d04394c73ec86549fd3b3b6f2c2cc3d7b57e5b4e95b577ba2ad7bd)</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>

10
docs/next/getting-setup.html
View file

@ -71,7 +71,7 @@
<li><a href="#step-2-bitcoin-s-repository">Step 2: Bitcoin-S Repository</a></li>
<li><a href="#step-3-configuration">Step 3: Configuration</a></li>
<li><a href="#step-4-optional-discreet-log-contract-branch">Step 4 (Optional): Discreet Log Contract Branch</a></li>
<li><a href="#step-5-setting-up-a-bitcoin-s-server-neutrino-node">Step 5: Setting Up A Bitcoin-S Server (Neutrino Node)</a></li>
<li><a href="#step-5-setting-up-a-bitcoin-s-server">Step 5: Setting Up A Bitcoin-S Server (Neutrino Node)</a></li>
<li><a href="#step-6-optional-moving-to-testnet">Step 6 (Optional): Moving To Testnet</a></li>
</ul>
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
@ -110,7 +110,7 @@ res0: <span class="hljs-type">Boolean</span> = <span class="hljs-literal">true</
<pre><code class="hljs css language-bashrc">sbt <span class="hljs-built_in">test</span>
</code></pre>
<h2><a class="anchor" aria-hidden="true" id="step-3-configuration"></a><a href="#step-3-configuration" 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>Step 3: Configuration</h2>
<p>Now that we have the bitcoin-s repo setup, we want to create our application configurations. This is done by creating a <code>bitcoin-s.conf</code> file at <code>$HOME/.bitcoin-s</code>. <a href="applications/configuration#example-configuration-file">Here is an example configuration file</a>. The only thing that you will <em>need</em> to change is the <code>peers</code> list to which you will want to add <code>&quot;localhost:18444&quot;</code> if you want to run in regtest.</p>
<p>Now that we have the bitcoin-s repo setup, we want to create our application configurations. This is done by creating a <code>bitcoin-s.conf</code> file at <code>$HOME/.bitcoin-s</code>. <a href="/docs/next/config/configuration#example-configuration-file">Here is an example configuration file</a>. The only thing that you will <em>need</em> to change is the <code>peers</code> list to which you will want to add <code>&quot;localhost:18444&quot;</code> if you want to run in regtest.</p>
<p>Once the bitcoin-s configuration is all done, I recommend creating a directory someplace in which to run your <code>bitcoind</code> node. Once you have this directory created, add the following <code>bitcoin.conf</code> file to it</p>
<pre><code class="hljs"><span class="hljs-attr">regtest</span>=<span class="hljs-number">1</span>
<span class="hljs-attr">server</span>=<span class="hljs-number">1</span>
@ -135,7 +135,7 @@ res0: <span class="hljs-type">Boolean</span> = <span class="hljs-literal">true</
<p>We are finally ready to start running some programs! Follow the <a href="/docs/next/applications/server#building-the-server">instructions here</a> to build the server. Then, follow <a href="/docs/next/applications/cli">these instructions</a> to setup the CLI.</p>
<p>There are 2 ways to use the bitcoin-s server. It can either can be as a neutrino node or use bitcoind as a backend.
This can be configured by the configuration option <code>bitcoin-s.node.mode</code> choosing either <code>neutrino</code> or <code>bitcoind</code>.</p>
<h3><a class="anchor" aria-hidden="true" id="neutrino-server"></a><a href="#neutrino-server" 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>Neutrino Server</h3>
<h3><a class="anchor" aria-hidden="true" id="option-a-neutrino-server"></a><a href="#option-a-neutrino-server" 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>Option A: Neutrino Server</h3>
<p>To use a neutrino server you need to be paired with a bitcoin node that can serve compact filters.
<a href="https://suredbits.com/">Suredbits</a> runs a mainnet and testnet node you can connect to them by setting your <code>peers</code> config option to:</p>
<p>Mainnet:</p>
@ -150,7 +150,7 @@ There is no released version of bitcoind that is neutrino compatible so you will
<p>and once this is done, you should be able to communicate with the server using</p>
<pre><code class="hljs css language-bashrc">.<span class="hljs-regexp">/app/</span>cli<span class="hljs-regexp">/target/u</span>niversal<span class="hljs-regexp">/stage/</span>bitcoin-s-cli getnewaddress
</code></pre>
<h3><a class="anchor" aria-hidden="true" id="bitcoind-backend"></a><a href="#bitcoind-backend" 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>Bitcoind Backend</h3>
<h3><a class="anchor" aria-hidden="true" id="option-b-bitcoind-backend"></a><a href="#option-b-bitcoind-backend" 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>Option B: Bitcoind Backend</h3>
<p>If you already have a bitcoind node running and would like to connect your bitcoin-s server to it you can set your node's mode to <code>bitcoind</code>.</p>
<p>You will need to configure bitcoin-s to be able to find your bitcoind.
If you would only like bitcoin-s to connect to bitcoind and start it itself then you only need to properly set the <code>rpcuser</code>, and <code>rpcpassword</code> options.
@ -184,7 +184,7 @@ These options should default to use the latest bitcoind downloaded from <code>sb
<pre><code class="hljs css language-bashrc">cat chaindump.sql <span class="hljs-string">| sqlite3 chaindb.sqlite</span>
</code></pre>
<p>This should take a couple minutes to execute, but once it is done, you will only have a short while left to sync once you start your server.</p>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/next/getting-started"><span class="arrow-prev">← </span><span>Intro and Getting Started</span></a><a class="docs-next button" href="/docs/next/applications/cli"><span>CLI</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#getting-setup-with-bitcoin-s">Getting Setup With Bitcoin-S</a></li><li><a href="#step-1-java-and-scala">Step 1: Java and Scala</a></li><li><a href="#step-2-bitcoin-s-repository">Step 2: Bitcoin-S Repository</a></li><li><a href="#step-3-configuration">Step 3: Configuration</a></li><li><a href="#step-4-optional-discreet-log-contract-branch">Step 4 (Optional): Discreet Log Contract Branch</a></li><li><a href="#step-5-setting-up-a-bitcoin-s-server">Step 5: Setting Up A Bitcoin-S Server</a><ul class="toc-headings"><li><a href="#neutrino-server">Neutrino Server</a></li><li><a href="#bitcoind-backend">Bitcoind Backend</a></li></ul></li><li><a href="#step-6-optional-moving-to-testnet">Step 6 (Optional): Moving To Testnet</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/favicon.ico" alt="bitcoin-s" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/getting-started">Getting Started</a><a href="/docs/en/core/core-intro">Guides</a><a href="/api/org/bitcoins">API Reference</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="https://join.slack.com/t/suredbits/shared_invite/zt-eavycu0x-WQL7XOakzQo8tAy7jHHZUw" target="_blank" rel="noreferrer noopener">Slack</a><a href="https://gitter.im/bitcoin-s-core/">Gitter chat</a></div><div><h5>More</h5><a href="https://github.com/bitcoin-s/bitcoin-s">GitHub</a><a class="github-button" href="https://github.com/bitcoin-s/bitcoin-s" data-icon="octicon-star" data-count-href="/bitcoin-s/bitcoin-s-core/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 Suredbits &amp; the bitcoin-s developers</section></footer></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script><script>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/next/getting-started"><span class="arrow-prev">← </span><span>Intro and Getting Started</span></a><a class="docs-next button" href="/docs/next/applications/cli"><span>CLI</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#getting-setup-with-bitcoin-s">Getting Setup With Bitcoin-S</a></li><li><a href="#step-1-java-and-scala">Step 1: Java and Scala</a></li><li><a href="#step-2-bitcoin-s-repository">Step 2: Bitcoin-S Repository</a></li><li><a href="#step-3-configuration">Step 3: Configuration</a></li><li><a href="#step-4-optional-discreet-log-contract-branch">Step 4 (Optional): Discreet Log Contract Branch</a></li><li><a href="#step-5-setting-up-a-bitcoin-s-server">Step 5: Setting Up A Bitcoin-S Server</a><ul class="toc-headings"><li><a href="#option-a-neutrino-server">Option A: Neutrino Server</a></li><li><a href="#option-b-bitcoind-backend">Option B: Bitcoind Backend</a></li></ul></li><li><a href="#step-6-optional-moving-to-testnet">Step 6 (Optional): Moving To Testnet</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/favicon.ico" alt="bitcoin-s" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/getting-started">Getting Started</a><a href="/docs/en/core/core-intro">Guides</a><a href="/api/org/bitcoins">API Reference</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="https://join.slack.com/t/suredbits/shared_invite/zt-eavycu0x-WQL7XOakzQo8tAy7jHHZUw" target="_blank" rel="noreferrer noopener">Slack</a><a href="https://gitter.im/bitcoin-s-core/">Gitter chat</a></div><div><h5>More</h5><a href="https://github.com/bitcoin-s/bitcoin-s">GitHub</a><a class="github-button" href="https://github.com/bitcoin-s/bitcoin-s" data-icon="octicon-star" data-count-href="/bitcoin-s/bitcoin-s-core/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 Suredbits &amp; the bitcoin-s developers</section></footer></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script><script>
document.addEventListener('keyup', function(e) {
if (e.target !== document.body) {
return;

10
docs/next/getting-setup/index.html
View file

@ -71,7 +71,7 @@
<li><a href="#step-2-bitcoin-s-repository">Step 2: Bitcoin-S Repository</a></li>
<li><a href="#step-3-configuration">Step 3: Configuration</a></li>
<li><a href="#step-4-optional-discreet-log-contract-branch">Step 4 (Optional): Discreet Log Contract Branch</a></li>
<li><a href="#step-5-setting-up-a-bitcoin-s-server-neutrino-node">Step 5: Setting Up A Bitcoin-S Server (Neutrino Node)</a></li>
<li><a href="#step-5-setting-up-a-bitcoin-s-server">Step 5: Setting Up A Bitcoin-S Server (Neutrino Node)</a></li>
<li><a href="#step-6-optional-moving-to-testnet">Step 6 (Optional): Moving To Testnet</a></li>
</ul>
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
@ -110,7 +110,7 @@ res0: <span class="hljs-type">Boolean</span> = <span class="hljs-literal">true</
<pre><code class="hljs css language-bashrc">sbt <span class="hljs-built_in">test</span>
</code></pre>
<h2><a class="anchor" aria-hidden="true" id="step-3-configuration"></a><a href="#step-3-configuration" 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>Step 3: Configuration</h2>
<p>Now that we have the bitcoin-s repo setup, we want to create our application configurations. This is done by creating a <code>bitcoin-s.conf</code> file at <code>$HOME/.bitcoin-s</code>. <a href="applications/configuration#example-configuration-file">Here is an example configuration file</a>. The only thing that you will <em>need</em> to change is the <code>peers</code> list to which you will want to add <code>&quot;localhost:18444&quot;</code> if you want to run in regtest.</p>
<p>Now that we have the bitcoin-s repo setup, we want to create our application configurations. This is done by creating a <code>bitcoin-s.conf</code> file at <code>$HOME/.bitcoin-s</code>. <a href="/docs/next/config/configuration#example-configuration-file">Here is an example configuration file</a>. The only thing that you will <em>need</em> to change is the <code>peers</code> list to which you will want to add <code>&quot;localhost:18444&quot;</code> if you want to run in regtest.</p>
<p>Once the bitcoin-s configuration is all done, I recommend creating a directory someplace in which to run your <code>bitcoind</code> node. Once you have this directory created, add the following <code>bitcoin.conf</code> file to it</p>
<pre><code class="hljs"><span class="hljs-attr">regtest</span>=<span class="hljs-number">1</span>
<span class="hljs-attr">server</span>=<span class="hljs-number">1</span>
@ -135,7 +135,7 @@ res0: <span class="hljs-type">Boolean</span> = <span class="hljs-literal">true</
<p>We are finally ready to start running some programs! Follow the <a href="/docs/next/applications/server#building-the-server">instructions here</a> to build the server. Then, follow <a href="/docs/next/applications/cli">these instructions</a> to setup the CLI.</p>
<p>There are 2 ways to use the bitcoin-s server. It can either can be as a neutrino node or use bitcoind as a backend.
This can be configured by the configuration option <code>bitcoin-s.node.mode</code> choosing either <code>neutrino</code> or <code>bitcoind</code>.</p>
<h3><a class="anchor" aria-hidden="true" id="neutrino-server"></a><a href="#neutrino-server" 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>Neutrino Server</h3>
<h3><a class="anchor" aria-hidden="true" id="option-a-neutrino-server"></a><a href="#option-a-neutrino-server" 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>Option A: Neutrino Server</h3>
<p>To use a neutrino server you need to be paired with a bitcoin node that can serve compact filters.
<a href="https://suredbits.com/">Suredbits</a> runs a mainnet and testnet node you can connect to them by setting your <code>peers</code> config option to:</p>
<p>Mainnet:</p>
@ -150,7 +150,7 @@ There is no released version of bitcoind that is neutrino compatible so you will
<p>and once this is done, you should be able to communicate with the server using</p>
<pre><code class="hljs css language-bashrc">.<span class="hljs-regexp">/app/</span>cli<span class="hljs-regexp">/target/u</span>niversal<span class="hljs-regexp">/stage/</span>bitcoin-s-cli getnewaddress
</code></pre>
<h3><a class="anchor" aria-hidden="true" id="bitcoind-backend"></a><a href="#bitcoind-backend" 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>Bitcoind Backend</h3>
<h3><a class="anchor" aria-hidden="true" id="option-b-bitcoind-backend"></a><a href="#option-b-bitcoind-backend" 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>Option B: Bitcoind Backend</h3>
<p>If you already have a bitcoind node running and would like to connect your bitcoin-s server to it you can set your node's mode to <code>bitcoind</code>.</p>
<p>You will need to configure bitcoin-s to be able to find your bitcoind.
If you would only like bitcoin-s to connect to bitcoind and start it itself then you only need to properly set the <code>rpcuser</code>, and <code>rpcpassword</code> options.
@ -184,7 +184,7 @@ These options should default to use the latest bitcoind downloaded from <code>sb
<pre><code class="hljs css language-bashrc">cat chaindump.sql <span class="hljs-string">| sqlite3 chaindb.sqlite</span>
</code></pre>
<p>This should take a couple minutes to execute, but once it is done, you will only have a short while left to sync once you start your server.</p>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/next/getting-started"><span class="arrow-prev">← </span><span>Intro and Getting Started</span></a><a class="docs-next button" href="/docs/next/applications/cli"><span>CLI</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#getting-setup-with-bitcoin-s">Getting Setup With Bitcoin-S</a></li><li><a href="#step-1-java-and-scala">Step 1: Java and Scala</a></li><li><a href="#step-2-bitcoin-s-repository">Step 2: Bitcoin-S Repository</a></li><li><a href="#step-3-configuration">Step 3: Configuration</a></li><li><a href="#step-4-optional-discreet-log-contract-branch">Step 4 (Optional): Discreet Log Contract Branch</a></li><li><a href="#step-5-setting-up-a-bitcoin-s-server">Step 5: Setting Up A Bitcoin-S Server</a><ul class="toc-headings"><li><a href="#neutrino-server">Neutrino Server</a></li><li><a href="#bitcoind-backend">Bitcoind Backend</a></li></ul></li><li><a href="#step-6-optional-moving-to-testnet">Step 6 (Optional): Moving To Testnet</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/favicon.ico" alt="bitcoin-s" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/getting-started">Getting Started</a><a href="/docs/en/core/core-intro">Guides</a><a href="/api/org/bitcoins">API Reference</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="https://join.slack.com/t/suredbits/shared_invite/zt-eavycu0x-WQL7XOakzQo8tAy7jHHZUw" target="_blank" rel="noreferrer noopener">Slack</a><a href="https://gitter.im/bitcoin-s-core/">Gitter chat</a></div><div><h5>More</h5><a href="https://github.com/bitcoin-s/bitcoin-s">GitHub</a><a class="github-button" href="https://github.com/bitcoin-s/bitcoin-s" data-icon="octicon-star" data-count-href="/bitcoin-s/bitcoin-s-core/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 Suredbits &amp; the bitcoin-s developers</section></footer></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script><script>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/next/getting-started"><span class="arrow-prev">← </span><span>Intro and Getting Started</span></a><a class="docs-next button" href="/docs/next/applications/cli"><span>CLI</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#getting-setup-with-bitcoin-s">Getting Setup With Bitcoin-S</a></li><li><a href="#step-1-java-and-scala">Step 1: Java and Scala</a></li><li><a href="#step-2-bitcoin-s-repository">Step 2: Bitcoin-S Repository</a></li><li><a href="#step-3-configuration">Step 3: Configuration</a></li><li><a href="#step-4-optional-discreet-log-contract-branch">Step 4 (Optional): Discreet Log Contract Branch</a></li><li><a href="#step-5-setting-up-a-bitcoin-s-server">Step 5: Setting Up A Bitcoin-S Server</a><ul class="toc-headings"><li><a href="#option-a-neutrino-server">Option A: Neutrino Server</a></li><li><a href="#option-b-bitcoind-backend">Option B: Bitcoind Backend</a></li></ul></li><li><a href="#step-6-optional-moving-to-testnet">Step 6 (Optional): Moving To Testnet</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/favicon.ico" alt="bitcoin-s" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/getting-started">Getting Started</a><a href="/docs/en/core/core-intro">Guides</a><a href="/api/org/bitcoins">API Reference</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="https://join.slack.com/t/suredbits/shared_invite/zt-eavycu0x-WQL7XOakzQo8tAy7jHHZUw" target="_blank" rel="noreferrer noopener">Slack</a><a href="https://gitter.im/bitcoin-s-core/">Gitter chat</a></div><div><h5>More</h5><a href="https://github.com/bitcoin-s/bitcoin-s">GitHub</a><a class="github-button" href="https://github.com/bitcoin-s/bitcoin-s" data-icon="octicon-star" data-count-href="/bitcoin-s/bitcoin-s-core/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 Suredbits &amp; the bitcoin-s developers</section></footer></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script><script>
document.addEventListener('keyup', function(e) {
if (e.target !== document.body) {
return;

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

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

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

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

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

@ -85,14 +85,14 @@ as a logical distinction for further development in subsequent releases.</p>
<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, 0xac9d961392cf5ff3184f34bff0c540bc5f9f754006095ad0c0635edba4f567ed)</span>
<span class="hljs-comment">// entropy: scodec.bits.BitVector = BitVector(256 bits, 0x71d0f1ca164fca0ed234f77c164725818daa260162e2404de4619563a3722ba2)</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(prosper, uncover, lumber, cereal, vote, wet, gentle, track, say, mail, expand, judge, wheat, rival, abandon, scorpion, food, maid, boat, sad, ripple, kingdom, panic, produce)</span>
<span class="hljs-comment">// Vector(impact, maple, income, clutch, witness, alter, emotion, page, lab, rate, siren, adapt, survey, basic, airport, fox, doctor, hundred, blur, client, demand, ribbon, purse, dose)</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>
@ -107,7 +107,7 @@ generate specific kinds of addresses for wallets.</p>
<pre><code class="hljs css language-scala"><span class="hljs-comment">//this will create a temp directory with the prefix 'key-manager-example` that will</span>
<span class="hljs-comment">//have a file in it called "encrypted-bitcoin-s-seed.json"</span>
<span class="hljs-keyword">val</span> seedPath = <span class="hljs-type">Files</span>.createTempDirectory(<span class="hljs-string">"key-manager-example"</span>).resolve(<span class="hljs-type">WalletStorage</span>.<span class="hljs-type">ENCRYPTED_SEED_FILE_NAME</span>)
<span class="hljs-comment">// seedPath: Path = /tmp/key-manager-example4119697450744253098/encrypted-bitcoin-s-seed.json</span>
<span class="hljs-comment">// seedPath: Path = /tmp/key-manager-example11791961590501509007/encrypted-bitcoin-s-seed.json</span>
<span class="hljs-comment">//let's create a native segwit key manager</span>
<span class="hljs-keyword">val</span> purpose = <span class="hljs-type">HDPurposes</span>.<span class="hljs-type">SegWit</span>
@ -118,16 +118,16 @@ 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-example4119697450744253098/encrypted-bitcoin-s-seed.json,m/84',RegTest)</span>
<span class="hljs-comment">// kmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example11791961590501509007/encrypted-bitcoin-s-seed.json,m/84',RegTest)</span>
<span class="hljs-keyword">val</span> km = <span class="hljs-type">BIP39KeyManager</span>.initializeWithMnemonic(mnemonic, <span class="hljs-type">None</span>, kmParams)
<span class="hljs-comment">// km: Either[KeyManagerInitializeError, BIP39KeyManager] = Right(BIP39KeyManager(Masked(MnemonicCodeImpl),KeyManagerParams(/tmp/key-manager-example4119697450744253098/encrypted-bitcoin-s-seed.json,m/84',RegTest),None,2020-10-13T11:18:24Z))</span>
<span class="hljs-comment">// km: Either[KeyManagerInitializeError, BIP39KeyManager] = Right(BIP39KeyManager(Masked(MnemonicCodeImpl),KeyManagerParams(/tmp/key-manager-example11791961590501509007/encrypted-bitcoin-s-seed.json,m/84',RegTest),None,2020-10-13T11:54:09Z))</span>
<span class="hljs-keyword">val</span> rootXPub = km.right.get.getRootXPub
<span class="hljs-comment">// rootXPub: ExtPublicKey = vpub5SLqN2bLY4Wea9tCtenFSgpkWXSe9vU7rz5QdDJKGsk8cHPhaCqz794SkitznK412cvQiv4ysF97HUcXWbdvAnpgJ3d1NupStVhbmWNbGS5</span>
<span class="hljs-comment">// rootXPub: ExtPublicKey = vpub5SLqN2bLY4WeYNTozs3Tt7BYYyUVxBs8NS14wczsWxS63FufF74jdJ3VEpCzULGGVsYdHYbL5SUrVEbZRzhvphbEeHouXgTAHZyLT7XBLb9</span>
println(rootXPub)
<span class="hljs-comment">// vpub5SLqN2bLY4Wea9tCtenFSgpkWXSe9vU7rz5QdDJKGsk8cHPhaCqz794SkitznK412cvQiv4ysF97HUcXWbdvAnpgJ3d1NupStVhbmWNbGS5</span>
<span class="hljs-comment">// vpub5SLqN2bLY4WeYNTozs3Tt7BYYyUVxBs8NS14wczsWxS63FufF74jdJ3VEpCzULGGVsYdHYbL5SUrVEbZRzhvphbEeHouXgTAHZyLT7XBLb9</span>
</code></pre>
<p>Which should print something that looks like this</p>
<p><code>vpub5SLqN2bLY4WeXxMqwJHJFBEwxSscGB2uDUnsTS3edVjZEwTrQDFDNqoR2xLqARQPabGaXsHSTenTRcqm2EnB9MpuC4vSk3LqSgNmGGZtuq7</code></p>
@ -136,17 +136,17 @@ println(rootXPub)
again after initializing it once. You can use the same <code>mnemonic</code> for different networks, which you control <code>KeyManagerParams</code>.</p>
<pre><code class="hljs css language-scala"><span class="hljs-comment">//let's create a nested segwit key manager for mainnet</span>
<span class="hljs-keyword">val</span> mainnetKmParams = <span class="hljs-type">KeyManagerParams</span>(seedPath, <span class="hljs-type">HDPurposes</span>.<span class="hljs-type">SegWit</span>, <span class="hljs-type">MainNet</span>)
<span class="hljs-comment">// mainnetKmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example4119697450744253098/encrypted-bitcoin-s-seed.json,m/84',MainNet)</span>
<span class="hljs-comment">// mainnetKmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example11791961590501509007/encrypted-bitcoin-s-seed.json,m/84',MainNet)</span>
<span class="hljs-comment">//we do not need to all `initializeWithMnemonic()` again as we have saved the seed to dis</span>
<span class="hljs-keyword">val</span> mainnetKeyManager = <span class="hljs-type">BIP39KeyManager</span>(mnemonic, mainnetKmParams, <span class="hljs-type">None</span>, <span class="hljs-type">Instant</span>.now)
<span class="hljs-comment">// mainnetKeyManager: BIP39KeyManager = BIP39KeyManager(Masked(MnemonicCodeImpl),KeyManagerParams(/tmp/key-manager-example4119697450744253098/encrypted-bitcoin-s-seed.json,m/84',MainNet),None,2020-10-13T11:18:24.919879Z)</span>
<span class="hljs-comment">// mainnetKeyManager: BIP39KeyManager = BIP39KeyManager(Masked(MnemonicCodeImpl),KeyManagerParams(/tmp/key-manager-example11791961590501509007/encrypted-bitcoin-s-seed.json,m/84',MainNet),None,2020-10-13T11:54:10.757585Z)</span>
<span class="hljs-keyword">val</span> mainnetXpub = mainnetKeyManager.getRootXPub
<span class="hljs-comment">// mainnetXpub: ExtPublicKey = zpub6jftahH18ngZyLegE5vkH3CmCQ2RvQS7XSAHknsrnuFepgecaqWEbPgzqYjLmwfgfBPdipTDhtZJpd4nPPHyMjZ5mQQhiZ6PyPxBKoNKLhw</span>
<span class="hljs-comment">// mainnetXpub: ExtPublicKey = zpub6jftahH18ngZwZEHLJBxiTZZEr4Hifq82t5x5CaR2ywcFfAaFjiz7Yg3Ke3LTxsx8S1rHSyZv5u42P3pJnMz1eKe7ebbsKj7NUDv1UYfVza</span>
println(mainnetXpub)
<span class="hljs-comment">// zpub6jftahH18ngZyLegE5vkH3CmCQ2RvQS7XSAHknsrnuFepgecaqWEbPgzqYjLmwfgfBPdipTDhtZJpd4nPPHyMjZ5mQQhiZ6PyPxBKoNKLhw</span>
<span class="hljs-comment">// zpub6jftahH18ngZwZEHLJBxiTZZEr4Hifq82t5x5CaR2ywcFfAaFjiz7Yg3Ke3LTxsx8S1rHSyZv5u42P3pJnMz1eKe7ebbsKj7NUDv1UYfVza</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

@ -85,14 +85,14 @@ as a logical distinction for further development in subsequent releases.</p>
<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, 0xac9d961392cf5ff3184f34bff0c540bc5f9f754006095ad0c0635edba4f567ed)</span>
<span class="hljs-comment">// entropy: scodec.bits.BitVector = BitVector(256 bits, 0x71d0f1ca164fca0ed234f77c164725818daa260162e2404de4619563a3722ba2)</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(prosper, uncover, lumber, cereal, vote, wet, gentle, track, say, mail, expand, judge, wheat, rival, abandon, scorpion, food, maid, boat, sad, ripple, kingdom, panic, produce)</span>
<span class="hljs-comment">// Vector(impact, maple, income, clutch, witness, alter, emotion, page, lab, rate, siren, adapt, survey, basic, airport, fox, doctor, hundred, blur, client, demand, ribbon, purse, dose)</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>
@ -107,7 +107,7 @@ generate specific kinds of addresses for wallets.</p>
<pre><code class="hljs css language-scala"><span class="hljs-comment">//this will create a temp directory with the prefix 'key-manager-example` that will</span>
<span class="hljs-comment">//have a file in it called "encrypted-bitcoin-s-seed.json"</span>
<span class="hljs-keyword">val</span> seedPath = <span class="hljs-type">Files</span>.createTempDirectory(<span class="hljs-string">"key-manager-example"</span>).resolve(<span class="hljs-type">WalletStorage</span>.<span class="hljs-type">ENCRYPTED_SEED_FILE_NAME</span>)
<span class="hljs-comment">// seedPath: Path = /tmp/key-manager-example4119697450744253098/encrypted-bitcoin-s-seed.json</span>
<span class="hljs-comment">// seedPath: Path = /tmp/key-manager-example11791961590501509007/encrypted-bitcoin-s-seed.json</span>
<span class="hljs-comment">//let's create a native segwit key manager</span>
<span class="hljs-keyword">val</span> purpose = <span class="hljs-type">HDPurposes</span>.<span class="hljs-type">SegWit</span>
@ -118,16 +118,16 @@ 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-example4119697450744253098/encrypted-bitcoin-s-seed.json,m/84',RegTest)</span>
<span class="hljs-comment">// kmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example11791961590501509007/encrypted-bitcoin-s-seed.json,m/84',RegTest)</span>
<span class="hljs-keyword">val</span> km = <span class="hljs-type">BIP39KeyManager</span>.initializeWithMnemonic(mnemonic, <span class="hljs-type">None</span>, kmParams)
<span class="hljs-comment">// km: Either[KeyManagerInitializeError, BIP39KeyManager] = Right(BIP39KeyManager(Masked(MnemonicCodeImpl),KeyManagerParams(/tmp/key-manager-example4119697450744253098/encrypted-bitcoin-s-seed.json,m/84',RegTest),None,2020-10-13T11:18:24Z))</span>
<span class="hljs-comment">// km: Either[KeyManagerInitializeError, BIP39KeyManager] = Right(BIP39KeyManager(Masked(MnemonicCodeImpl),KeyManagerParams(/tmp/key-manager-example11791961590501509007/encrypted-bitcoin-s-seed.json,m/84',RegTest),None,2020-10-13T11:54:09Z))</span>
<span class="hljs-keyword">val</span> rootXPub = km.right.get.getRootXPub
<span class="hljs-comment">// rootXPub: ExtPublicKey = vpub5SLqN2bLY4Wea9tCtenFSgpkWXSe9vU7rz5QdDJKGsk8cHPhaCqz794SkitznK412cvQiv4ysF97HUcXWbdvAnpgJ3d1NupStVhbmWNbGS5</span>
<span class="hljs-comment">// rootXPub: ExtPublicKey = vpub5SLqN2bLY4WeYNTozs3Tt7BYYyUVxBs8NS14wczsWxS63FufF74jdJ3VEpCzULGGVsYdHYbL5SUrVEbZRzhvphbEeHouXgTAHZyLT7XBLb9</span>
println(rootXPub)
<span class="hljs-comment">// vpub5SLqN2bLY4Wea9tCtenFSgpkWXSe9vU7rz5QdDJKGsk8cHPhaCqz794SkitznK412cvQiv4ysF97HUcXWbdvAnpgJ3d1NupStVhbmWNbGS5</span>
<span class="hljs-comment">// vpub5SLqN2bLY4WeYNTozs3Tt7BYYyUVxBs8NS14wczsWxS63FufF74jdJ3VEpCzULGGVsYdHYbL5SUrVEbZRzhvphbEeHouXgTAHZyLT7XBLb9</span>
</code></pre>
<p>Which should print something that looks like this</p>
<p><code>vpub5SLqN2bLY4WeXxMqwJHJFBEwxSscGB2uDUnsTS3edVjZEwTrQDFDNqoR2xLqARQPabGaXsHSTenTRcqm2EnB9MpuC4vSk3LqSgNmGGZtuq7</code></p>
@ -136,17 +136,17 @@ println(rootXPub)
again after initializing it once. You can use the same <code>mnemonic</code> for different networks, which you control <code>KeyManagerParams</code>.</p>
<pre><code class="hljs css language-scala"><span class="hljs-comment">//let's create a nested segwit key manager for mainnet</span>
<span class="hljs-keyword">val</span> mainnetKmParams = <span class="hljs-type">KeyManagerParams</span>(seedPath, <span class="hljs-type">HDPurposes</span>.<span class="hljs-type">SegWit</span>, <span class="hljs-type">MainNet</span>)
<span class="hljs-comment">// mainnetKmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example4119697450744253098/encrypted-bitcoin-s-seed.json,m/84',MainNet)</span>
<span class="hljs-comment">// mainnetKmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example11791961590501509007/encrypted-bitcoin-s-seed.json,m/84',MainNet)</span>
<span class="hljs-comment">//we do not need to all `initializeWithMnemonic()` again as we have saved the seed to dis</span>
<span class="hljs-keyword">val</span> mainnetKeyManager = <span class="hljs-type">BIP39KeyManager</span>(mnemonic, mainnetKmParams, <span class="hljs-type">None</span>, <span class="hljs-type">Instant</span>.now)
<span class="hljs-comment">// mainnetKeyManager: BIP39KeyManager = BIP39KeyManager(Masked(MnemonicCodeImpl),KeyManagerParams(/tmp/key-manager-example4119697450744253098/encrypted-bitcoin-s-seed.json,m/84',MainNet),None,2020-10-13T11:18:24.919879Z)</span>
<span class="hljs-comment">// mainnetKeyManager: BIP39KeyManager = BIP39KeyManager(Masked(MnemonicCodeImpl),KeyManagerParams(/tmp/key-manager-example11791961590501509007/encrypted-bitcoin-s-seed.json,m/84',MainNet),None,2020-10-13T11:54:10.757585Z)</span>
<span class="hljs-keyword">val</span> mainnetXpub = mainnetKeyManager.getRootXPub
<span class="hljs-comment">// mainnetXpub: ExtPublicKey = zpub6jftahH18ngZyLegE5vkH3CmCQ2RvQS7XSAHknsrnuFepgecaqWEbPgzqYjLmwfgfBPdipTDhtZJpd4nPPHyMjZ5mQQhiZ6PyPxBKoNKLhw</span>
<span class="hljs-comment">// mainnetXpub: ExtPublicKey = zpub6jftahH18ngZwZEHLJBxiTZZEr4Hifq82t5x5CaR2ywcFfAaFjiz7Yg3Ke3LTxsx8S1rHSyZv5u42P3pJnMz1eKe7ebbsKj7NUDv1UYfVza</span>
println(mainnetXpub)
<span class="hljs-comment">// zpub6jftahH18ngZyLegE5vkH3CmCQ2RvQS7XSAHknsrnuFepgecaqWEbPgzqYjLmwfgfBPdipTDhtZJpd4nPPHyMjZ5mQQhiZ6PyPxBKoNKLhw</span>
<span class="hljs-comment">// zpub6jftahH18ngZwZEHLJBxiTZZEr4Hifq82t5x5CaR2ywcFfAaFjiz7Yg3Ke3LTxsx8S1rHSyZv5u42P3pJnMz1eKe7ebbsKj7NUDv1UYfVza</span>
</code></pre>
<p>Which gives us something that looks like this</p>
<p><code>zpub6jftahH18ngZw98KGjRo5XcxeKTQ2eztsvskb1dC9XF5TLimQquTs6Ry7nBBA425D9joXmfgJJCexmJ1u2SELJZJfRi95gcnXadLpZzYb5c</code></p>

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

@ -114,12 +114,12 @@ println(<span class="hljs-string">s"Verified with NativeSecp256k1 again=<span cl
<pre><code class="hljs css language-scala"><span class="hljs-keyword">val</span> privKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey
<span class="hljs-comment">// privKey: ECPrivateKey = Masked(ECPrivateKeyImpl)</span>
<span class="hljs-keyword">val</span> publicKey = privKey.publicKeyWithBouncyCastle
<span class="hljs-comment">// publicKey: ECPublicKey = ECPublicKey(0307ff53462824624cc551020e6696085afa6137628ef239324069bcb465aa407b)</span>
<span class="hljs-comment">// publicKey: ECPublicKey = ECPublicKey(02f7a5f5c939dfae0b7fc04d27e82346326732ebf201159f1ec2cd39783080323e)</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(304402204d2421e389f4a0a7ed22ec6217662c3db4744dabe07c0c2841454e24d00ec021022007611481ebfdbd3ed4d8189f7e77ca58601ddb8fbfbd1e07c489bf1937fd4c85)</span>
<span class="hljs-comment">// signature: ECDigitalSignature = ECDigitalSignature(30440220451956277a81e6b2e2f147e58c7ae0c0a52f06e17a2ceea20dd67ba9af84e9bf0220202ea956370819878f55b46acfc7174f4e3c078939941db7a5dd45d7b884ba24)</span>
<span class="hljs-keyword">val</span> verified = publicKey.verifyWithBouncyCastle(dataToSign.bytes, signature)
<span class="hljs-comment">// verified: Boolean = true</span>

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

@ -114,12 +114,12 @@ println(<span class="hljs-string">s"Verified with NativeSecp256k1 again=<span cl
<pre><code class="hljs css language-scala"><span class="hljs-keyword">val</span> privKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey
<span class="hljs-comment">// privKey: ECPrivateKey = Masked(ECPrivateKeyImpl)</span>
<span class="hljs-keyword">val</span> publicKey = privKey.publicKeyWithBouncyCastle
<span class="hljs-comment">// publicKey: ECPublicKey = ECPublicKey(0307ff53462824624cc551020e6696085afa6137628ef239324069bcb465aa407b)</span>
<span class="hljs-comment">// publicKey: ECPublicKey = ECPublicKey(02f7a5f5c939dfae0b7fc04d27e82346326732ebf201159f1ec2cd39783080323e)</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(304402204d2421e389f4a0a7ed22ec6217662c3db4744dabe07c0c2841454e24d00ec021022007611481ebfdbd3ed4d8189f7e77ca58601ddb8fbfbd1e07c489bf1937fd4c85)</span>
<span class="hljs-comment">// signature: ECDigitalSignature = ECDigitalSignature(30440220451956277a81e6b2e2f147e58c7ae0c0a52f06e17a2ceea20dd67ba9af84e9bf0220202ea956370819878f55b46acfc7174f4e3c078939941db7a5dd45d7b884ba24)</span>
<span class="hljs-keyword">val</span> verified = publicKey.verifyWithBouncyCastle(dataToSign.bytes, signature)
<span class="hljs-comment">// verified: Boolean = true</span>