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

Deploy website

Browse source 
Deploy website version based on 4e862b7297
This commit is contained in:
Docusaurus bot 2020-12-29 21:22:55 +00:00
parent 2c27c06879
commit 43541e04d3
23 changed files with 265 additions and 97 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(03be4b2391480088f2357ef674fa895c16918184db4422b83ae9c253e687d9a8ae)</span>
<span class="hljs-comment">// pubkey: org.bitcoins.crypto.ECPublicKey = ECPublicKey(02625e0916de24f5b1eec4e50e23cb6aad62179db6a1b42e1b7363c16d3344f352)</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 = tb1quyygm352uwtjq3j2k3cvak34vydv6e39uxjn3n</span>
<span class="hljs-comment">// segwitAddress: Bech32Address = tb1qdw9wr8lehjfn2uu9rr4cc2e06rpphrvr6eehll</span>
println(segwitAddress.toString)
<span class="hljs-comment">// tb1quyygm352uwtjq3j2k3cvak34vydv6e39uxjn3n</span>
<span class="hljs-comment">// tb1qdw9wr8lehjfn2uu9rr4cc2e06rpphrvr6eehll</span>
</code></pre>
<h2><a class="anchor" aria-hidden="true" id="generating-legacy-base58-addresses"></a><a href="#generating-legacy-base58-addresses" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Generating legacy (base58) addresses</h2>
<p>If you need to generate legacy addresses for backwards
@ -101,10 +101,10 @@ Take a look:</p>
<pre><code class="hljs css language-scala"><span class="hljs-comment">// we&#x27;re reusing the same private/public key pair</span>
<span class="hljs-comment">// from before. don&#x27;t do this in an actual application!</span>
<span class="hljs-keyword">val</span> legacyAddress = <span class="hljs-type">P2PKHAddress</span>(pubkey, <span class="hljs-type">TestNet3</span>)
<span class="hljs-comment">// legacyAddress: P2PKHAddress = n22paYZpozvtjdFZfSkgqFraiaBtuvgsK7</span>
<span class="hljs-comment">// legacyAddress: P2PKHAddress = mqKayE1LYutHPFNCXHAZPHt7KHmQS6CyMY</span>
println(legacyAddress.toString)
<span class="hljs-comment">// n22paYZpozvtjdFZfSkgqFraiaBtuvgsK7</span>
<span class="hljs-comment">// mqKayE1LYutHPFNCXHAZPHt7KHmQS6CyMY</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(03be4b2391480088f2357ef674fa895c16918184db4422b83ae9c253e687d9a8ae)</span>
<span class="hljs-comment">// pubkey: org.bitcoins.crypto.ECPublicKey = ECPublicKey(02625e0916de24f5b1eec4e50e23cb6aad62179db6a1b42e1b7363c16d3344f352)</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 = tb1quyygm352uwtjq3j2k3cvak34vydv6e39uxjn3n</span>
<span class="hljs-comment">// segwitAddress: Bech32Address = tb1qdw9wr8lehjfn2uu9rr4cc2e06rpphrvr6eehll</span>
println(segwitAddress.toString)
<span class="hljs-comment">// tb1quyygm352uwtjq3j2k3cvak34vydv6e39uxjn3n</span>
<span class="hljs-comment">// tb1qdw9wr8lehjfn2uu9rr4cc2e06rpphrvr6eehll</span>
</code></pre>
<h2><a class="anchor" aria-hidden="true" id="generating-legacy-base58-addresses"></a><a href="#generating-legacy-base58-addresses" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Generating legacy (base58) addresses</h2>
<p>If you need to generate legacy addresses for backwards
@ -101,10 +101,10 @@ Take a look:</p>
<pre><code class="hljs css language-scala"><span class="hljs-comment">// we&#x27;re reusing the same private/public key pair</span>
<span class="hljs-comment">// from before. don&#x27;t do this in an actual application!</span>
<span class="hljs-keyword">val</span> legacyAddress = <span class="hljs-type">P2PKHAddress</span>(pubkey, <span class="hljs-type">TestNet3</span>)
<span class="hljs-comment">// legacyAddress: P2PKHAddress = n22paYZpozvtjdFZfSkgqFraiaBtuvgsK7</span>
<span class="hljs-comment">// legacyAddress: P2PKHAddress = mqKayE1LYutHPFNCXHAZPHt7KHmQS6CyMY</span>
println(legacyAddress.toString)
<span class="hljs-comment">// n22paYZpozvtjdFZfSkgqFraiaBtuvgsK7</span>
<span class="hljs-comment">// mqKayE1LYutHPFNCXHAZPHt7KHmQS6CyMY</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, 0x6812baf1ef6712b300a4f9e5a3179a658f6e18f9f669e4b686d87de8b12a4b83)</span>
<span class="hljs-comment">// entropy: BitVector = BitVector(256 bits, 0xaece1278b8d311a9b87b615c4bd7c935082a88de3551d7088cef0eb67898d0ba)</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(gym, noise, round, tell, illness, flower, action, palace, toss, board, track, slam, want, arrest, treat, snake, tool, reflect, render, wink, mention, news, come, gossip) // the phrase the user should write down</span>
<span class="hljs-comment">// res0: Vector[String] = Vector(put, identify, owner, immune, country, state, tiger, history, fox, gadget, venture, head, live, dutch, juice, pretty, strike, dutch, design, buddy, guide, erase, drill, domain) // 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 = zpub6jftahH18ngZxNsEtX27RJBjU1WwGqgNfk2PkywLYxiYLJZaE2T4tK9SYtzhj7ay8JKCX4j9mRDmTEJoYa9K8BDSzCjSCEZT1v7br8WGMun</span>
<span class="hljs-comment">// xpub: ExtPublicKey = zpub6jftahH18ngZx6UhJV4bnEnPTQzoia82MJJeNUvnRAeNckbgykEYxP7bw855mGqq5WgWc6jBX7c5Bpi8jVX2MQcdtrCAqr9YFbK6h6WoHF4</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 = zpub6qNPvK51sp27zsvXwtTmYF6xifnvMAWuUiipKywXWpJmMqY5qJyqMVhDmpANQgchZbCnEQhJjftiMapcP44ecnHfJuaKvciNJj1biVoMFEL</span>
<span class="hljs-comment">// accountXpub: ExtPublicKey = zpub6s6ADbfPgP2K6NgHzadYNLsasHWBhFHKSDnJq8zvr45LDC3rHcB5U1k2z27Zom2FQPiTfcZbUQ6eKnuieeXHN4BwtoFdNyomde1uD838VZC</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 = tb1q3uxe9nzjwzj4nkzss68g7t6peexy7yw3gaujpc</span>
<span class="hljs-comment">// firstAccountAddress: Bech32Address = tb1qez439ks6rsgx9v2a8ec4p0c0dgrey025v0yjs8</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 = tb1q3uxe9nzjwzj4nkzss68g7t6peexy7yw3gaujpc</span>
<span class="hljs-comment">// res2: String = tb1qez439ks6rsgx9v2a8ec4p0c0dgrey025v0yjs8</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, 0x6812baf1ef6712b300a4f9e5a3179a658f6e18f9f669e4b686d87de8b12a4b83)</span>
<span class="hljs-comment">// entropy: BitVector = BitVector(256 bits, 0xaece1278b8d311a9b87b615c4bd7c935082a88de3551d7088cef0eb67898d0ba)</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(gym, noise, round, tell, illness, flower, action, palace, toss, board, track, slam, want, arrest, treat, snake, tool, reflect, render, wink, mention, news, come, gossip) // the phrase the user should write down</span>
<span class="hljs-comment">// res0: Vector[String] = Vector(put, identify, owner, immune, country, state, tiger, history, fox, gadget, venture, head, live, dutch, juice, pretty, strike, dutch, design, buddy, guide, erase, drill, domain) // 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 = zpub6jftahH18ngZxNsEtX27RJBjU1WwGqgNfk2PkywLYxiYLJZaE2T4tK9SYtzhj7ay8JKCX4j9mRDmTEJoYa9K8BDSzCjSCEZT1v7br8WGMun</span>
<span class="hljs-comment">// xpub: ExtPublicKey = zpub6jftahH18ngZx6UhJV4bnEnPTQzoia82MJJeNUvnRAeNckbgykEYxP7bw855mGqq5WgWc6jBX7c5Bpi8jVX2MQcdtrCAqr9YFbK6h6WoHF4</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 = zpub6qNPvK51sp27zsvXwtTmYF6xifnvMAWuUiipKywXWpJmMqY5qJyqMVhDmpANQgchZbCnEQhJjftiMapcP44ecnHfJuaKvciNJj1biVoMFEL</span>
<span class="hljs-comment">// accountXpub: ExtPublicKey = zpub6s6ADbfPgP2K6NgHzadYNLsasHWBhFHKSDnJq8zvr45LDC3rHcB5U1k2z27Zom2FQPiTfcZbUQ6eKnuieeXHN4BwtoFdNyomde1uD838VZC</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 = tb1q3uxe9nzjwzj4nkzss68g7t6peexy7yw3gaujpc</span>
<span class="hljs-comment">// firstAccountAddress: Bech32Address = tb1qez439ks6rsgx9v2a8ec4p0c0dgrey025v0yjs8</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 = tb1q3uxe9nzjwzj4nkzss68g7t6peexy7yw3gaujpc</span>
<span class="hljs-comment">// res2: String = tb1qez439ks6rsgx9v2a8ec4p0c0dgrey025v0yjs8</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@3fcd0a8c[Running, parallelism = 2, size = 2, active = 0, running = 0, steals = 33, tasks = 0, submissions = 0]</span>
<span class="hljs-comment">// ec: ExecutionContext = scala.concurrent.impl.ExecutionContextImpl$$anon$3@13a6357c[Running, parallelism = 2, size = 2, active = 0, running = 0, steals = 33, tasks = 0, submissions = 0]</span>
<span class="hljs-comment">// Initialize a transaction builder</span>
<span class="hljs-keyword">val</span> builder = <span class="hljs-type">RawTxBuilder</span>()
@ -74,19 +74,19 @@
<span class="hljs-keyword">val</span> privKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey
<span class="hljs-comment">// privKey: ECPrivateKey = Masked(ECPrivateKeyImpl)</span>
<span class="hljs-keyword">val</span> pubKey = privKey.publicKey
<span class="hljs-comment">// pubKey: ECPublicKey = ECPublicKey(032c9f596867fba33a0a4bc0b74e701dea5c678740ed3b0a9b3e33bf025743ffdf)</span>
<span class="hljs-comment">// pubKey: ECPublicKey = ECPublicKey(02af3e17f2fd73718b63bcbcc740e4f3dffb5731e64d4fccf10043c37ce0ee0073)</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(519528d184c6466cd6c4d62d1d7eceff9dfc4163)</span>
<span class="hljs-comment">// creditingSpk: P2PKHScriptPubKey = pkh(ac1aade05633d5bf25b7f2a68db4518a4c44d0c7)</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(519528d184c6466cd6c4d62d1d7eceff9dfc4163))</span>
<span class="hljs-comment">// utxo: TransactionOutput = TransactionOutput(10000 sats,pkh(ac1aade05633d5bf25b7f2a68db4518a4c44d0c7))</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(a7c9351e1dbd6f90ed9f035216d6e48f85b5fa26)</span>
<span class="hljs-comment">// destinationSPK: P2PKHScriptPubKey = pkh(3004a2ba707c15ec9188f18d973bed8a7ef27bc0)</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(a7c9351e1dbd6f90ed9f035216d6e48f85b5fa26)))</span>
<span class="hljs-comment">// destinations: Vector[TransactionOutput] = Vector(TransactionOutput(5000 sats,pkh(3004a2ba707c15ec9188f18d973bed8a7ef27bc0)))</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(519528d184c6466cd6c4d62d1d7eceff9dfc4163))),UInt32Impl(0))</span>
<span class="hljs-comment">// creditingTx: BaseTransaction = BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(ac1aade05633d5bf25b7f2a68db4518a4c44d0c7))),UInt32Impl(0))</span>
<span class="hljs-comment">// this is the information we need from the crediting TX</span>
<span class="hljs-comment">// to properly &quot;link&quot; it in the transaction we are creating</span>
<span class="hljs-keyword">val</span> outPoint = <span class="hljs-type">TransactionOutPoint</span>(creditingTx.txId, <span class="hljs-type">UInt32</span>.zero)
<span class="hljs-comment">// outPoint: TransactionOutPoint = TransactionOutPoint(61b34cfce2645aa18dc83bb54fa53da5a11754b0197afa1bbc21b9ff7b807174:0)</span>
<span class="hljs-comment">// outPoint: TransactionOutPoint = TransactionOutPoint(aec8528b5808ef3b87974cda7c3f20f1df9edd7b3fe6681ee637b97698202af6: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(61b34cfce2645aa18dc83bb54fa53da5a11754b0197afa1bbc21b9ff7b807174:0),EmptyScriptSignature,UInt32Impl(0))</span>
<span class="hljs-comment">// input: TransactionInput = TransactionInputImpl(TransactionOutPoint(aec8528b5808ef3b87974cda7c3f20f1df9edd7b3fe6681ee637b97698202af6: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(61b34cfce2645aa18dc83bb54fa53da5a11754b0197afa1bbc21b9ff7b807174:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(a7c9351e1dbd6f90ed9f035216d6e48f85b5fa26))),UInt32Impl(0))</span>
<span class="hljs-comment">// builderResult: RawTxBuilderResult = RawTxBuilderResult(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(aec8528b5808ef3b87974cda7c3f20f1df9edd7b3fe6681ee637b97698202af6:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(3004a2ba707c15ec9188f18d973bed8a7ef27bc0))),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(61b34cfce2645aa18dc83bb54fa53da5a11754b0197afa1bbc21b9ff7b807174:0),10000 sats,ECPublicKey(032c9f596867fba33a0a4bc0b74e701dea5c678740ed3b0a9b3e33bf025743ffdf))</span>
<span class="hljs-comment">// inputInfo: P2PKHInputInfo = P2PKHInputInfo(TransactionOutPoint(aec8528b5808ef3b87974cda7c3f20f1df9edd7b3fe6681ee637b97698202af6:0),10000 sats,ECPublicKey(02af3e17f2fd73718b63bcbcc740e4f3dffb5731e64d4fccf10043c37ce0ee0073))</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(65cbac3f9e8bebff88860097cda85603ac90506e)</span>
<span class="hljs-comment">// changeSPK: P2PKHScriptPubKey = pkh(cbb9f7f4438f80ee9560287200db6be1bd041a0e)</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(61b34cfce2645aa18dc83bb54fa53da5a11754b0197afa1bbc21b9ff7b807174:0),10000 sats,ECPublicKey(032c9f596867fba33a0a4bc0b74e701dea5c678740ed3b0a9b3e33bf025743ffdf))),1 sats/byte,pkh(65cbac3f9e8bebff88860097cda85603ac90506e))</span>
<span class="hljs-comment">// finalizer: StandardNonInteractiveFinalizer = StandardNonInteractiveFinalizer(Vector(P2PKHInputInfo(TransactionOutPoint(aec8528b5808ef3b87974cda7c3f20f1df9edd7b3fe6681ee637b97698202af6:0),10000 sats,ECPublicKey(02af3e17f2fd73718b63bcbcc740e4f3dffb5731e64d4fccf10043c37ce0ee0073))),1 sats/byte,pkh(cbb9f7f4438f80ee9560287200db6be1bd041a0e))</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(61b34cfce2645aa18dc83bb54fa53da5a11754b0197afa1bbc21b9ff7b807174:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(a7c9351e1dbd6f90ed9f035216d6e48f85b5fa26)), TransactionOutput(4775 sats,pkh(65cbac3f9e8bebff88860097cda85603ac90506e))),UInt32Impl(0))))</span>
<span class="hljs-comment">// unsignedTxF: Future[Transaction] = Future(Success(BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(aec8528b5808ef3b87974cda7c3f20f1df9edd7b3fe6681ee637b97698202af6:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(3004a2ba707c15ec9188f18d973bed8a7ef27bc0)), TransactionOutput(4775 sats,pkh(cbb9f7f4438f80ee9560287200db6be1bd041a0e))),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(61b34cfce2645aa18dc83bb54fa53da5a11754b0197afa1bbc21b9ff7b807174:0),10000 sats,ECPublicKey(032c9f596867fba33a0a4bc0b74e701dea5c678740ed3b0a9b3e33bf025743ffdf)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(519528d184c6466cd6c4d62d1d7eceff9dfc4163))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1)))</span>
<span class="hljs-comment">// utxoInfo: ScriptSignatureParams[P2PKHInputInfo] = ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(aec8528b5808ef3b87974cda7c3f20f1df9edd7b3fe6681ee637b97698202af6:0),10000 sats,ECPublicKey(02af3e17f2fd73718b63bcbcc740e4f3dffb5731e64d4fccf10043c37ce0ee0073)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(ac1aade05633d5bf25b7f2a68db4518a4c44d0c7))),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(61b34cfce2645aa18dc83bb54fa53da5a11754b0197afa1bbc21b9ff7b807174:0),10000 sats,ECPublicKey(032c9f596867fba33a0a4bc0b74e701dea5c678740ed3b0a9b3e33bf025743ffdf)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(519528d184c6466cd6c4d62d1d7eceff9dfc4163))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1))))</span>
<span class="hljs-comment">// utxoInfos: Vector[ScriptSignatureParams[InputInfo]] = Vector(ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(aec8528b5808ef3b87974cda7c3f20f1df9edd7b3fe6681ee637b97698202af6:0),10000 sats,ECPublicKey(02af3e17f2fd73718b63bcbcc740e4f3dffb5731e64d4fccf10043c37ce0ee0073)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(ac1aade05633d5bf25b7f2a68db4518a4c44d0c7))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1))))</span>
<span class="hljs-comment">// Yay! Now we use the RawTxSigner object to sign the tx.</span>
<span class="hljs-comment">// The &#x27;sign&#x27; method is going produce a validly signed transaction</span>
@ -201,7 +201,7 @@ builder += input
}
<span class="hljs-type">Await</span>.result(signedTxF, <span class="hljs-number">30.</span>seconds)
}
<span class="hljs-comment">// signedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(61b34cfce2645aa18dc83bb54fa53da5a11754b0197afa1bbc21b9ff7b807174:0),P2PKHScriptSignature(ECPublicKey(032c9f596867fba33a0a4bc0b74e701dea5c678740ed3b0a9b3e33bf025743ffdf), ECDigitalSignature(304402204d4108a23b7136c1cf4a325b02ee55ff20280670a8238e9d6973f511be1f7484022030acdb56c05f71502572bb893a09cf7b7fee03c141fecf197c91caac66af8e2901)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(a7c9351e1dbd6f90ed9f035216d6e48f85b5fa26)), TransactionOutput(4775 sats,pkh(65cbac3f9e8bebff88860097cda85603ac90506e))),UInt32Impl(0))</span>
<span class="hljs-comment">// signedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(aec8528b5808ef3b87974cda7c3f20f1df9edd7b3fe6681ee637b97698202af6:0),P2PKHScriptSignature(ECPublicKey(02af3e17f2fd73718b63bcbcc740e4f3dffb5731e64d4fccf10043c37ce0ee0073), ECDigitalSignature(304402205ae60f0e468500067787d8332ed6610aa1e95861bd404104adc1e3e25e9df581022038d5ff08a01c4cfc23dd320e91b32507258697f7a803506fd4dc6b67da730e2501)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(3004a2ba707c15ec9188f18d973bed8a7ef27bc0)), TransactionOutput(4775 sats,pkh(cbb9f7f4438f80ee9560287200db6be1bd041a0e))),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 = 02000000017471807bffb921bc1bfa7a19b05417a1a53da54fb53bc88da15a64e2fc4cb361000000006a47304402204d4108a23b7136c1cf4a325b02ee55ff20280670a8238e9d6973f511be1f7484022030acdb56c05f71502572bb893a09cf7b7fee03c141fecf197c91caac66af8e290121032c9f596867fba33a0a4bc0b74e701dea5c678740ed3b0a9b3e33bf025743ffdf000000000288130000000000001976a914a7c9351e1dbd6f90ed9f035216d6e48f85b5fa2688aca7120000000000001976a91465cbac3f9e8bebff88860097cda85603ac90506e88ac00000000</span>
<span class="hljs-comment">// res4: String = 0200000001f62a209876b937e61e68e63f7bdd9edff1203f7cda4c97873bef08588b52c8ae000000006a47304402205ae60f0e468500067787d8332ed6610aa1e95861bd404104adc1e3e25e9df581022038d5ff08a01c4cfc23dd320e91b32507258697f7a803506fd4dc6b67da730e25012102af3e17f2fd73718b63bcbcc740e4f3dffb5731e64d4fccf10043c37ce0ee0073000000000288130000000000001976a9143004a2ba707c15ec9188f18d973bed8a7ef27bc088aca7120000000000001976a914cbb9f7f4438f80ee9560287200db6be1bd041a0e88ac00000000</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@3fcd0a8c[Running, parallelism = 2, size = 2, active = 0, running = 0, steals = 33, tasks = 0, submissions = 0]</span>
<span class="hljs-comment">// ec: ExecutionContext = scala.concurrent.impl.ExecutionContextImpl$$anon$3@13a6357c[Running, parallelism = 2, size = 2, active = 0, running = 0, steals = 33, tasks = 0, submissions = 0]</span>
<span class="hljs-comment">// Initialize a transaction builder</span>
<span class="hljs-keyword">val</span> builder = <span class="hljs-type">RawTxBuilder</span>()
@ -74,19 +74,19 @@
<span class="hljs-keyword">val</span> privKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey
<span class="hljs-comment">// privKey: ECPrivateKey = Masked(ECPrivateKeyImpl)</span>
<span class="hljs-keyword">val</span> pubKey = privKey.publicKey
<span class="hljs-comment">// pubKey: ECPublicKey = ECPublicKey(032c9f596867fba33a0a4bc0b74e701dea5c678740ed3b0a9b3e33bf025743ffdf)</span>
<span class="hljs-comment">// pubKey: ECPublicKey = ECPublicKey(02af3e17f2fd73718b63bcbcc740e4f3dffb5731e64d4fccf10043c37ce0ee0073)</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(519528d184c6466cd6c4d62d1d7eceff9dfc4163)</span>
<span class="hljs-comment">// creditingSpk: P2PKHScriptPubKey = pkh(ac1aade05633d5bf25b7f2a68db4518a4c44d0c7)</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(519528d184c6466cd6c4d62d1d7eceff9dfc4163))</span>
<span class="hljs-comment">// utxo: TransactionOutput = TransactionOutput(10000 sats,pkh(ac1aade05633d5bf25b7f2a68db4518a4c44d0c7))</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(a7c9351e1dbd6f90ed9f035216d6e48f85b5fa26)</span>
<span class="hljs-comment">// destinationSPK: P2PKHScriptPubKey = pkh(3004a2ba707c15ec9188f18d973bed8a7ef27bc0)</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(a7c9351e1dbd6f90ed9f035216d6e48f85b5fa26)))</span>
<span class="hljs-comment">// destinations: Vector[TransactionOutput] = Vector(TransactionOutput(5000 sats,pkh(3004a2ba707c15ec9188f18d973bed8a7ef27bc0)))</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(519528d184c6466cd6c4d62d1d7eceff9dfc4163))),UInt32Impl(0))</span>
<span class="hljs-comment">// creditingTx: BaseTransaction = BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(ac1aade05633d5bf25b7f2a68db4518a4c44d0c7))),UInt32Impl(0))</span>
<span class="hljs-comment">// this is the information we need from the crediting TX</span>
<span class="hljs-comment">// to properly &quot;link&quot; it in the transaction we are creating</span>
<span class="hljs-keyword">val</span> outPoint = <span class="hljs-type">TransactionOutPoint</span>(creditingTx.txId, <span class="hljs-type">UInt32</span>.zero)
<span class="hljs-comment">// outPoint: TransactionOutPoint = TransactionOutPoint(61b34cfce2645aa18dc83bb54fa53da5a11754b0197afa1bbc21b9ff7b807174:0)</span>
<span class="hljs-comment">// outPoint: TransactionOutPoint = TransactionOutPoint(aec8528b5808ef3b87974cda7c3f20f1df9edd7b3fe6681ee637b97698202af6: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(61b34cfce2645aa18dc83bb54fa53da5a11754b0197afa1bbc21b9ff7b807174:0),EmptyScriptSignature,UInt32Impl(0))</span>
<span class="hljs-comment">// input: TransactionInput = TransactionInputImpl(TransactionOutPoint(aec8528b5808ef3b87974cda7c3f20f1df9edd7b3fe6681ee637b97698202af6: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(61b34cfce2645aa18dc83bb54fa53da5a11754b0197afa1bbc21b9ff7b807174:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(a7c9351e1dbd6f90ed9f035216d6e48f85b5fa26))),UInt32Impl(0))</span>
<span class="hljs-comment">// builderResult: RawTxBuilderResult = RawTxBuilderResult(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(aec8528b5808ef3b87974cda7c3f20f1df9edd7b3fe6681ee637b97698202af6:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(3004a2ba707c15ec9188f18d973bed8a7ef27bc0))),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(61b34cfce2645aa18dc83bb54fa53da5a11754b0197afa1bbc21b9ff7b807174:0),10000 sats,ECPublicKey(032c9f596867fba33a0a4bc0b74e701dea5c678740ed3b0a9b3e33bf025743ffdf))</span>
<span class="hljs-comment">// inputInfo: P2PKHInputInfo = P2PKHInputInfo(TransactionOutPoint(aec8528b5808ef3b87974cda7c3f20f1df9edd7b3fe6681ee637b97698202af6:0),10000 sats,ECPublicKey(02af3e17f2fd73718b63bcbcc740e4f3dffb5731e64d4fccf10043c37ce0ee0073))</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(65cbac3f9e8bebff88860097cda85603ac90506e)</span>
<span class="hljs-comment">// changeSPK: P2PKHScriptPubKey = pkh(cbb9f7f4438f80ee9560287200db6be1bd041a0e)</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(61b34cfce2645aa18dc83bb54fa53da5a11754b0197afa1bbc21b9ff7b807174:0),10000 sats,ECPublicKey(032c9f596867fba33a0a4bc0b74e701dea5c678740ed3b0a9b3e33bf025743ffdf))),1 sats/byte,pkh(65cbac3f9e8bebff88860097cda85603ac90506e))</span>
<span class="hljs-comment">// finalizer: StandardNonInteractiveFinalizer = StandardNonInteractiveFinalizer(Vector(P2PKHInputInfo(TransactionOutPoint(aec8528b5808ef3b87974cda7c3f20f1df9edd7b3fe6681ee637b97698202af6:0),10000 sats,ECPublicKey(02af3e17f2fd73718b63bcbcc740e4f3dffb5731e64d4fccf10043c37ce0ee0073))),1 sats/byte,pkh(cbb9f7f4438f80ee9560287200db6be1bd041a0e))</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(61b34cfce2645aa18dc83bb54fa53da5a11754b0197afa1bbc21b9ff7b807174:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(a7c9351e1dbd6f90ed9f035216d6e48f85b5fa26)), TransactionOutput(4775 sats,pkh(65cbac3f9e8bebff88860097cda85603ac90506e))),UInt32Impl(0))))</span>
<span class="hljs-comment">// unsignedTxF: Future[Transaction] = Future(Success(BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(aec8528b5808ef3b87974cda7c3f20f1df9edd7b3fe6681ee637b97698202af6:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(3004a2ba707c15ec9188f18d973bed8a7ef27bc0)), TransactionOutput(4775 sats,pkh(cbb9f7f4438f80ee9560287200db6be1bd041a0e))),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(61b34cfce2645aa18dc83bb54fa53da5a11754b0197afa1bbc21b9ff7b807174:0),10000 sats,ECPublicKey(032c9f596867fba33a0a4bc0b74e701dea5c678740ed3b0a9b3e33bf025743ffdf)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(519528d184c6466cd6c4d62d1d7eceff9dfc4163))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1)))</span>
<span class="hljs-comment">// utxoInfo: ScriptSignatureParams[P2PKHInputInfo] = ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(aec8528b5808ef3b87974cda7c3f20f1df9edd7b3fe6681ee637b97698202af6:0),10000 sats,ECPublicKey(02af3e17f2fd73718b63bcbcc740e4f3dffb5731e64d4fccf10043c37ce0ee0073)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(ac1aade05633d5bf25b7f2a68db4518a4c44d0c7))),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(61b34cfce2645aa18dc83bb54fa53da5a11754b0197afa1bbc21b9ff7b807174:0),10000 sats,ECPublicKey(032c9f596867fba33a0a4bc0b74e701dea5c678740ed3b0a9b3e33bf025743ffdf)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(519528d184c6466cd6c4d62d1d7eceff9dfc4163))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1))))</span>
<span class="hljs-comment">// utxoInfos: Vector[ScriptSignatureParams[InputInfo]] = Vector(ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(aec8528b5808ef3b87974cda7c3f20f1df9edd7b3fe6681ee637b97698202af6:0),10000 sats,ECPublicKey(02af3e17f2fd73718b63bcbcc740e4f3dffb5731e64d4fccf10043c37ce0ee0073)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(ac1aade05633d5bf25b7f2a68db4518a4c44d0c7))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1))))</span>
<span class="hljs-comment">// Yay! Now we use the RawTxSigner object to sign the tx.</span>
<span class="hljs-comment">// The &#x27;sign&#x27; method is going produce a validly signed transaction</span>
@ -201,7 +201,7 @@ builder += input
}
<span class="hljs-type">Await</span>.result(signedTxF, <span class="hljs-number">30.</span>seconds)
}
<span class="hljs-comment">// signedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(61b34cfce2645aa18dc83bb54fa53da5a11754b0197afa1bbc21b9ff7b807174:0),P2PKHScriptSignature(ECPublicKey(032c9f596867fba33a0a4bc0b74e701dea5c678740ed3b0a9b3e33bf025743ffdf), ECDigitalSignature(304402204d4108a23b7136c1cf4a325b02ee55ff20280670a8238e9d6973f511be1f7484022030acdb56c05f71502572bb893a09cf7b7fee03c141fecf197c91caac66af8e2901)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(a7c9351e1dbd6f90ed9f035216d6e48f85b5fa26)), TransactionOutput(4775 sats,pkh(65cbac3f9e8bebff88860097cda85603ac90506e))),UInt32Impl(0))</span>
<span class="hljs-comment">// signedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(aec8528b5808ef3b87974cda7c3f20f1df9edd7b3fe6681ee637b97698202af6:0),P2PKHScriptSignature(ECPublicKey(02af3e17f2fd73718b63bcbcc740e4f3dffb5731e64d4fccf10043c37ce0ee0073), ECDigitalSignature(304402205ae60f0e468500067787d8332ed6610aa1e95861bd404104adc1e3e25e9df581022038d5ff08a01c4cfc23dd320e91b32507258697f7a803506fd4dc6b67da730e2501)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(3004a2ba707c15ec9188f18d973bed8a7ef27bc0)), TransactionOutput(4775 sats,pkh(cbb9f7f4438f80ee9560287200db6be1bd041a0e))),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 = 02000000017471807bffb921bc1bfa7a19b05417a1a53da54fb53bc88da15a64e2fc4cb361000000006a47304402204d4108a23b7136c1cf4a325b02ee55ff20280670a8238e9d6973f511be1f7484022030acdb56c05f71502572bb893a09cf7b7fee03c141fecf197c91caac66af8e290121032c9f596867fba33a0a4bc0b74e701dea5c678740ed3b0a9b3e33bf025743ffdf000000000288130000000000001976a914a7c9351e1dbd6f90ed9f035216d6e48f85b5fa2688aca7120000000000001976a91465cbac3f9e8bebff88860097cda85603ac90506e88ac00000000</span>
<span class="hljs-comment">// res4: String = 0200000001f62a209876b937e61e68e63f7bdd9edff1203f7cda4c97873bef08588b52c8ae000000006a47304402205ae60f0e468500067787d8332ed6610aa1e95861bd404104adc1e3e25e9df581022038d5ff08a01c4cfc23dd320e91b32507258697f7a803506fd4dc6b67da730e25012102af3e17f2fd73718b63bcbcc740e4f3dffb5731e64d4fccf10043c37ce0ee0073000000000288130000000000001976a9143004a2ba707c15ec9188f18d973bed8a7ef27bc088aca7120000000000001976a914cbb9f7f4438f80ee9560287200db6be1bd041a0e88ac00000000</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(304402203e5e4ce795795dbfd2dda19c096894dd5d3424ba7d4df21e0a76787a1268f9c402206cdf7e0ba90fb97e0f7e385e34b543c7f2f9696bf7f2c2a5cc45075855076518)</span>
<span class="hljs-comment">// res0: ECDigitalSignature = ECDigitalSignature(3045022100a602b010efcca713869d065eab58dd1d527539d3bb842f759a274589479fa17e022028fe247c91d4806884e7614622b46ad5d4b115d16c798547d633d3d8cc9813a9)</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(3045022100827868ab8c30cdce5c11e0d593203274c9f432309ca877f905efc63acf024b5402205d762029ac28835a86b252c871d3b60089319f4966cd7891ab7d035adcb10644)</span>
<span class="hljs-comment">// res1: ECDigitalSignature = ECDigitalSignature(3045022100ce89cb44da7239a01637994ddfaf69f7fc5a4cde8957513abc7ce3a4d494f9ba022079d3c1fee1a74510a7a41a9fe4b8ead6eb34fc09507899eae2e5d0aa7db53e93)</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(304402203e5e4ce795795dbfd2dda19c096894dd5d3424ba7d4df21e0a76787a1268f9c402206cdf7e0ba90fb97e0f7e385e34b543c7f2f9696bf7f2c2a5cc45075855076518)</span>
<span class="hljs-comment">// res0: ECDigitalSignature = ECDigitalSignature(3045022100a602b010efcca713869d065eab58dd1d527539d3bb842f759a274589479fa17e022028fe247c91d4806884e7614622b46ad5d4b115d16c798547d633d3d8cc9813a9)</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(3045022100827868ab8c30cdce5c11e0d593203274c9f432309ca877f905efc63acf024b5402205d762029ac28835a86b252c871d3b60089319f4966cd7891ab7d035adcb10644)</span>
<span class="hljs-comment">// res1: ECDigitalSignature = ECDigitalSignature(3045022100ce89cb44da7239a01637994ddfaf69f7fc5a4cde8957513abc7ce3a4d494f9ba022079d3c1fee1a74510a7a41a9fe4b8ead6eb34fc09507899eae2e5d0aa7db53e93)</span>
</code></pre>
<p>With <code>ExtSign</code>, you can use <code>ExtPrivateKey</code> to sign transactions inside of <code>TxBuilder</code> since <code>UTXOSpendingInfo</code> takes in <code>Sign</code> as a parameter.</p>
<p>You can also provide a <code>path</code> to use to derive a child <code>ExtPrivateKey</code>, and then sign with that child private key</p>

2
docs/next/fee-provider/fee-provider.html
View file

@ -72,7 +72,7 @@ Another uses <a href="https://bitcoiner.live/">bitcoiner.live's api</a> to get a
These can be hooked up to any website's API as long as you can provide a <code>URI</code> and a function to convert the response to a <code>FeeUnit</code>.</p>
<p>There also exists <code>CachedHttpFeeRateProvider</code>, which will cache the response for the <code>cacheDuration</code> as to prevent hitting request limits and save on api calls.</p>
<p>Checkout <a href="https://github.com/bitcoin-s/bitcoin-s/blob/master/fee-provider/src/main/scala/org/bitcoins/feeprovider/BitcoinerLiveFeeRateProvider.scala"><code>BitcoinerLiveFeeRateProvider</code>'s implementation</a> for an example.</p>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/next/crypto/sign"><span class="arrow-prev">← </span><span>Sign API</span></a><a class="docs-next button" href="/docs/next/key-manager/key-manager"><span>Key Manager</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#httpfeerateprovider">HttpFeeRateProvider</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/crypto/sign"><span class="arrow-prev">← </span><span>Sign API</span></a><a class="docs-next button" href="/docs/next/key-manager/server-key-manager"><span>Next</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#httpfeerateprovider">HttpFeeRateProvider</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/fee-provider/fee-provider/index.html
View file

@ -72,7 +72,7 @@ Another uses <a href="https://bitcoiner.live/">bitcoiner.live's api</a> to get a
These can be hooked up to any website's API as long as you can provide a <code>URI</code> and a function to convert the response to a <code>FeeUnit</code>.</p>
<p>There also exists <code>CachedHttpFeeRateProvider</code>, which will cache the response for the <code>cacheDuration</code> as to prevent hitting request limits and save on api calls.</p>
<p>Checkout <a href="https://github.com/bitcoin-s/bitcoin-s/blob/master/fee-provider/src/main/scala/org/bitcoins/feeprovider/BitcoinerLiveFeeRateProvider.scala"><code>BitcoinerLiveFeeRateProvider</code>'s implementation</a> for an example.</p>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/next/crypto/sign"><span class="arrow-prev">← </span><span>Sign API</span></a><a class="docs-next button" href="/docs/next/key-manager/key-manager"><span>Key Manager</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#httpfeerateprovider">HttpFeeRateProvider</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/crypto/sign"><span class="arrow-prev">← </span><span>Sign API</span></a><a class="docs-next button" href="/docs/next/key-manager/server-key-manager"><span>Next</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#httpfeerateprovider">HttpFeeRateProvider</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">&quot;org.bitcoin-s&quot;</span
<h3><a class="anchor" aria-hidden="true" id="nightly-builds"></a><a href="#nightly-builds" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Nightly builds</h3>
<p>You can also run on the bleeding edge of Bitcoin-S, by
adding a snapshot build to your <code>build.sbt</code>. The most
recent snapshot published is <code>0.4.0+203-2610a23a-SNAPSHOT</code>.</p>
recent snapshot published is <code>0.4.0+206-4e862b72-SNAPSHOT</code>.</p>
<p>To fetch snapshots, you will need to add the correct
resolver in your <code>build.sbt</code>:</p>
<pre><code class="hljs css language-sbt">resolvers += Resolver.sonatypeRepo(<span class="hljs-string">&quot;snapshots&quot;</span>)

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

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

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

@ -77,14 +77,14 @@
<span class="hljs-comment">//get 256 bits of random entropy</span>
<span class="hljs-keyword">val</span> entropy = <span class="hljs-type">MnemonicCode</span>.getEntropy256Bits
<span class="hljs-comment">// entropy: scodec.bits.BitVector = BitVector(256 bits, 0x38381db61142e10a66e2f95911cb3aa40ebabc3df2253318d9c37bb4a837e8c5)</span>
<span class="hljs-comment">// entropy: scodec.bits.BitVector = BitVector(256 bits, 0xf3c4e5bf88a2f88d34c66d99f4d528cc2586c4fdb8b2dc374d568d9da30a50a3)</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(deal, science, horn, card, come, lunch, oppose, game, flip, mixture, solid, elite, two, fun, water, dwarf, credit, short, ignore, wash, enhance, brief, perfect, ripple)</span>
<span class="hljs-comment">// Vector(video, cheese, husband, bacon, convince, educate, spread, soap, okay, pluck, enforce, obscure, flash, give, want, bind, switch, risk, fiber, brass, surface, lunch, dream, inject)</span>
</code></pre>
<p>Now that we have a <code>MnemonicCode</code> that was securely generated, we need to now create <code>KeyManagerParams</code> which tells us how to generate
generate specific kinds of addresses for wallets.</p>
@ -99,7 +99,7 @@ generate specific kinds of addresses for wallets.</p>
<pre><code class="hljs css language-scala"><span class="hljs-comment">//this will create a temp directory with the prefix &#x27;key-manager-example` that will</span>
<span class="hljs-comment">//have a file in it called &quot;encrypted-bitcoin-s-seed.json&quot;</span>
<span class="hljs-keyword">val</span> seedPath = <span class="hljs-type">Files</span>.createTempDirectory(<span class="hljs-string">&quot;key-manager-example&quot;</span>).resolve(<span class="hljs-type">WalletStorage</span>.<span class="hljs-type">ENCRYPTED_SEED_FILE_NAME</span>)
<span class="hljs-comment">// seedPath: Path = /tmp/key-manager-example9101623767279202322/encrypted-bitcoin-s-seed.json</span>
<span class="hljs-comment">// seedPath: Path = /tmp/key-manager-example3823264314296215214/encrypted-bitcoin-s-seed.json</span>
<span class="hljs-comment">//let&#x27;s create a native segwit key manager</span>
<span class="hljs-keyword">val</span> purpose = <span class="hljs-type">HDPurposes</span>.<span class="hljs-type">SegWit</span>
@ -110,19 +110,19 @@ generate specific kinds of addresses for wallets.</p>
<span class="hljs-comment">// network: RegTest.type = RegTest</span>
<span class="hljs-keyword">val</span> kmParams = <span class="hljs-type">KeyManagerParams</span>(seedPath, purpose, network)
<span class="hljs-comment">// kmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example9101623767279202322/encrypted-bitcoin-s-seed.json,m/84&#x27;,RegTest)</span>
<span class="hljs-comment">// kmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example3823264314296215214/encrypted-bitcoin-s-seed.json,m/84&#x27;,RegTest)</span>
<span class="hljs-keyword">val</span> aesPasswordOpt = <span class="hljs-type">Some</span>(<span class="hljs-type">AesPassword</span>.fromString(<span class="hljs-string">&quot;password&quot;</span>))
<span class="hljs-comment">// aesPasswordOpt: Some[AesPassword] = Some(Masked(AesPassword))</span>
<span class="hljs-keyword">val</span> km = <span class="hljs-type">BIP39KeyManager</span>.initializeWithMnemonic(aesPasswordOpt, mnemonic, <span class="hljs-type">None</span>, kmParams)
<span class="hljs-comment">// km: Either[KeyManagerInitializeError, BIP39KeyManager] = Right(org.bitcoins.keymanager.bip39.BIP39KeyManager@56f03bc5)</span>
<span class="hljs-comment">// km: Either[KeyManagerInitializeError, BIP39KeyManager] = Right(org.bitcoins.keymanager.bip39.BIP39KeyManager@1ede209)</span>
<span class="hljs-keyword">val</span> rootXPub = km.right.get.getRootXPub
<span class="hljs-comment">// rootXPub: ExtPublicKey = vpub5SLqN2bLY4WeYWEAYM4e5Ar26Kh3SMQMbUKLmENfyc5Bm6HDYWQe4pV6EvPjf5uW3gRdMjvuhUR4rgiHQbmUSASkNxLRjgDXbCRTVynSRxr</span>
<span class="hljs-comment">// rootXPub: ExtPublicKey = vpub5SLqN2bLY4WeZyUXkuckoKVTWNk71NCRbVDXGygLwQYqi6eM1Rh31VbbRQQXGtty4vh5bhMvHuQm1HwtCPwdBfMxpaJSNZT6B6GXgUTesbG</span>
println(rootXPub)
<span class="hljs-comment">// vpub5SLqN2bLY4WeYWEAYM4e5Ar26Kh3SMQMbUKLmENfyc5Bm6HDYWQe4pV6EvPjf5uW3gRdMjvuhUR4rgiHQbmUSASkNxLRjgDXbCRTVynSRxr</span>
<span class="hljs-comment">// vpub5SLqN2bLY4WeZyUXkuckoKVTWNk71NCRbVDXGygLwQYqi6eM1Rh31VbbRQQXGtty4vh5bhMvHuQm1HwtCPwdBfMxpaJSNZT6B6GXgUTesbG</span>
</code></pre>
<p>Which should print something that looks like this</p>
<p><code>vpub5SLqN2bLY4WeXxMqwJHJFBEwxSscGB2uDUnsTS3edVjZEwTrQDFDNqoR2xLqARQPabGaXsHSTenTRcqm2EnB9MpuC4vSk3LqSgNmGGZtuq7</code></p>
@ -131,17 +131,17 @@ println(rootXPub)
again after initializing it once. You can use the same <code>mnemonic</code> for different networks, which you control <code>KeyManagerParams</code>.</p>
<pre><code class="hljs css language-scala"><span class="hljs-comment">//let&#x27;s create a nested segwit key manager for mainnet</span>
<span class="hljs-keyword">val</span> mainnetKmParams = <span class="hljs-type">KeyManagerParams</span>(seedPath, <span class="hljs-type">HDPurposes</span>.<span class="hljs-type">SegWit</span>, <span class="hljs-type">MainNet</span>)
<span class="hljs-comment">// mainnetKmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example9101623767279202322/encrypted-bitcoin-s-seed.json,m/84&#x27;,MainNet)</span>
<span class="hljs-comment">// mainnetKmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example3823264314296215214/encrypted-bitcoin-s-seed.json,m/84&#x27;,MainNet)</span>
<span class="hljs-comment">//we do not need to all `initializeWithMnemonic()` again as we have saved the seed to dis</span>
<span class="hljs-keyword">val</span> mainnetKeyManager = <span class="hljs-type">BIP39KeyManager</span>.fromMnemonic(mnemonic, mainnetKmParams, <span class="hljs-type">None</span>, <span class="hljs-type">Instant</span>.now)
<span class="hljs-comment">// mainnetKeyManager: BIP39KeyManager = org.bitcoins.keymanager.bip39.BIP39KeyManager@4d7c7248</span>
<span class="hljs-comment">// mainnetKeyManager: BIP39KeyManager = org.bitcoins.keymanager.bip39.BIP39KeyManager@7dd90d33</span>
<span class="hljs-keyword">val</span> mainnetXpub = mainnetKeyManager.getRootXPub
<span class="hljs-comment">// mainnetXpub: ExtPublicKey = zpub6jftahH18ngZwgzdsnD8uXE2nCGqCqNMFvQDtoxDVdahyVY8Z94tZ57eKkE5eiXBgEtrMeK9Y7qGPqAYHPRXd7B9rK885KVUg6g34Gq6MmW</span>
<span class="hljs-comment">// mainnetXpub: ExtPublicKey = zpub6jftahH18ngZyAF16LmFdfsUCFKtmrARFwJQQZFtTS4MvVuG24MHVkE9WEEsGXWehVAJbbkA8YpxYSQ95BbgNc6NHw68iCj3FzX7EiKGaw8</span>
println(mainnetXpub)
<span class="hljs-comment">// zpub6jftahH18ngZwgzdsnD8uXE2nCGqCqNMFvQDtoxDVdahyVY8Z94tZ57eKkE5eiXBgEtrMeK9Y7qGPqAYHPRXd7B9rK885KVUg6g34Gq6MmW</span>
<span class="hljs-comment">// zpub6jftahH18ngZyAF16LmFdfsUCFKtmrARFwJQQZFtTS4MvVuG24MHVkE9WEEsGXWehVAJbbkA8YpxYSQ95BbgNc6NHw68iCj3FzX7EiKGaw8</span>
</code></pre>
<p>Which gives us something that looks like this</p>
<p><code>zpub6jftahH18ngZw98KGjRo5XcxeKTQ2eztsvskb1dC9XF5TLimQquTs6Ry7nBBA425D9joXmfgJJCexmJ1u2SELJZJfRi95gcnXadLpZzYb5c</code></p>
@ -149,7 +149,7 @@ println(mainnetXpub)
<h4><a class="anchor" aria-hidden="true" id="creating-a-key-manager-from-existing-mnemonic"></a><a href="#creating-a-key-manager-from-existing-mnemonic" 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>Creating a key manager from existing mnemonic</h4>
<p>To create a <code>KeyManager</code> from existing mnemonic you need to specify the <code>seedPath</code> and then construct the <code>KeyManagerParams</code> that you would like.</p>
<p>Finally you call <code>KeyManager.fromParams()</code> that reads the mnemonic from disk and create's the key manager</p>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/next/fee-provider/fee-provider"><span class="arrow-prev">← </span><span>Fee Provider</span></a><a class="docs-next button" href="/docs/next/node/node"><span>Light Client</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>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/next/key-manager/server-key-manager"><span class="arrow-prev">← </span><span>Previous</span></a><a class="docs-next button" href="/docs/next/node/node"><span>Light Client</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) {
if (e.target !== document.body) {
return;

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

@ -77,14 +77,14 @@
<span class="hljs-comment">//get 256 bits of random entropy</span>
<span class="hljs-keyword">val</span> entropy = <span class="hljs-type">MnemonicCode</span>.getEntropy256Bits
<span class="hljs-comment">// entropy: scodec.bits.BitVector = BitVector(256 bits, 0x38381db61142e10a66e2f95911cb3aa40ebabc3df2253318d9c37bb4a837e8c5)</span>
<span class="hljs-comment">// entropy: scodec.bits.BitVector = BitVector(256 bits, 0xf3c4e5bf88a2f88d34c66d99f4d528cc2586c4fdb8b2dc374d568d9da30a50a3)</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(deal, science, horn, card, come, lunch, oppose, game, flip, mixture, solid, elite, two, fun, water, dwarf, credit, short, ignore, wash, enhance, brief, perfect, ripple)</span>
<span class="hljs-comment">// Vector(video, cheese, husband, bacon, convince, educate, spread, soap, okay, pluck, enforce, obscure, flash, give, want, bind, switch, risk, fiber, brass, surface, lunch, dream, inject)</span>
</code></pre>
<p>Now that we have a <code>MnemonicCode</code> that was securely generated, we need to now create <code>KeyManagerParams</code> which tells us how to generate
generate specific kinds of addresses for wallets.</p>
@ -99,7 +99,7 @@ generate specific kinds of addresses for wallets.</p>
<pre><code class="hljs css language-scala"><span class="hljs-comment">//this will create a temp directory with the prefix &#x27;key-manager-example` that will</span>
<span class="hljs-comment">//have a file in it called &quot;encrypted-bitcoin-s-seed.json&quot;</span>
<span class="hljs-keyword">val</span> seedPath = <span class="hljs-type">Files</span>.createTempDirectory(<span class="hljs-string">&quot;key-manager-example&quot;</span>).resolve(<span class="hljs-type">WalletStorage</span>.<span class="hljs-type">ENCRYPTED_SEED_FILE_NAME</span>)
<span class="hljs-comment">// seedPath: Path = /tmp/key-manager-example9101623767279202322/encrypted-bitcoin-s-seed.json</span>
<span class="hljs-comment">// seedPath: Path = /tmp/key-manager-example3823264314296215214/encrypted-bitcoin-s-seed.json</span>
<span class="hljs-comment">//let&#x27;s create a native segwit key manager</span>
<span class="hljs-keyword">val</span> purpose = <span class="hljs-type">HDPurposes</span>.<span class="hljs-type">SegWit</span>
@ -110,19 +110,19 @@ generate specific kinds of addresses for wallets.</p>
<span class="hljs-comment">// network: RegTest.type = RegTest</span>
<span class="hljs-keyword">val</span> kmParams = <span class="hljs-type">KeyManagerParams</span>(seedPath, purpose, network)
<span class="hljs-comment">// kmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example9101623767279202322/encrypted-bitcoin-s-seed.json,m/84&#x27;,RegTest)</span>
<span class="hljs-comment">// kmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example3823264314296215214/encrypted-bitcoin-s-seed.json,m/84&#x27;,RegTest)</span>
<span class="hljs-keyword">val</span> aesPasswordOpt = <span class="hljs-type">Some</span>(<span class="hljs-type">AesPassword</span>.fromString(<span class="hljs-string">&quot;password&quot;</span>))
<span class="hljs-comment">// aesPasswordOpt: Some[AesPassword] = Some(Masked(AesPassword))</span>
<span class="hljs-keyword">val</span> km = <span class="hljs-type">BIP39KeyManager</span>.initializeWithMnemonic(aesPasswordOpt, mnemonic, <span class="hljs-type">None</span>, kmParams)
<span class="hljs-comment">// km: Either[KeyManagerInitializeError, BIP39KeyManager] = Right(org.bitcoins.keymanager.bip39.BIP39KeyManager@56f03bc5)</span>
<span class="hljs-comment">// km: Either[KeyManagerInitializeError, BIP39KeyManager] = Right(org.bitcoins.keymanager.bip39.BIP39KeyManager@1ede209)</span>
<span class="hljs-keyword">val</span> rootXPub = km.right.get.getRootXPub
<span class="hljs-comment">// rootXPub: ExtPublicKey = vpub5SLqN2bLY4WeYWEAYM4e5Ar26Kh3SMQMbUKLmENfyc5Bm6HDYWQe4pV6EvPjf5uW3gRdMjvuhUR4rgiHQbmUSASkNxLRjgDXbCRTVynSRxr</span>
<span class="hljs-comment">// rootXPub: ExtPublicKey = vpub5SLqN2bLY4WeZyUXkuckoKVTWNk71NCRbVDXGygLwQYqi6eM1Rh31VbbRQQXGtty4vh5bhMvHuQm1HwtCPwdBfMxpaJSNZT6B6GXgUTesbG</span>
println(rootXPub)
<span class="hljs-comment">// vpub5SLqN2bLY4WeYWEAYM4e5Ar26Kh3SMQMbUKLmENfyc5Bm6HDYWQe4pV6EvPjf5uW3gRdMjvuhUR4rgiHQbmUSASkNxLRjgDXbCRTVynSRxr</span>
<span class="hljs-comment">// vpub5SLqN2bLY4WeZyUXkuckoKVTWNk71NCRbVDXGygLwQYqi6eM1Rh31VbbRQQXGtty4vh5bhMvHuQm1HwtCPwdBfMxpaJSNZT6B6GXgUTesbG</span>
</code></pre>
<p>Which should print something that looks like this</p>
<p><code>vpub5SLqN2bLY4WeXxMqwJHJFBEwxSscGB2uDUnsTS3edVjZEwTrQDFDNqoR2xLqARQPabGaXsHSTenTRcqm2EnB9MpuC4vSk3LqSgNmGGZtuq7</code></p>
@ -131,17 +131,17 @@ println(rootXPub)
again after initializing it once. You can use the same <code>mnemonic</code> for different networks, which you control <code>KeyManagerParams</code>.</p>
<pre><code class="hljs css language-scala"><span class="hljs-comment">//let&#x27;s create a nested segwit key manager for mainnet</span>
<span class="hljs-keyword">val</span> mainnetKmParams = <span class="hljs-type">KeyManagerParams</span>(seedPath, <span class="hljs-type">HDPurposes</span>.<span class="hljs-type">SegWit</span>, <span class="hljs-type">MainNet</span>)
<span class="hljs-comment">// mainnetKmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example9101623767279202322/encrypted-bitcoin-s-seed.json,m/84&#x27;,MainNet)</span>
<span class="hljs-comment">// mainnetKmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example3823264314296215214/encrypted-bitcoin-s-seed.json,m/84&#x27;,MainNet)</span>
<span class="hljs-comment">//we do not need to all `initializeWithMnemonic()` again as we have saved the seed to dis</span>
<span class="hljs-keyword">val</span> mainnetKeyManager = <span class="hljs-type">BIP39KeyManager</span>.fromMnemonic(mnemonic, mainnetKmParams, <span class="hljs-type">None</span>, <span class="hljs-type">Instant</span>.now)
<span class="hljs-comment">// mainnetKeyManager: BIP39KeyManager = org.bitcoins.keymanager.bip39.BIP39KeyManager@4d7c7248</span>
<span class="hljs-comment">// mainnetKeyManager: BIP39KeyManager = org.bitcoins.keymanager.bip39.BIP39KeyManager@7dd90d33</span>
<span class="hljs-keyword">val</span> mainnetXpub = mainnetKeyManager.getRootXPub
<span class="hljs-comment">// mainnetXpub: ExtPublicKey = zpub6jftahH18ngZwgzdsnD8uXE2nCGqCqNMFvQDtoxDVdahyVY8Z94tZ57eKkE5eiXBgEtrMeK9Y7qGPqAYHPRXd7B9rK885KVUg6g34Gq6MmW</span>
<span class="hljs-comment">// mainnetXpub: ExtPublicKey = zpub6jftahH18ngZyAF16LmFdfsUCFKtmrARFwJQQZFtTS4MvVuG24MHVkE9WEEsGXWehVAJbbkA8YpxYSQ95BbgNc6NHw68iCj3FzX7EiKGaw8</span>
println(mainnetXpub)
<span class="hljs-comment">// zpub6jftahH18ngZwgzdsnD8uXE2nCGqCqNMFvQDtoxDVdahyVY8Z94tZ57eKkE5eiXBgEtrMeK9Y7qGPqAYHPRXd7B9rK885KVUg6g34Gq6MmW</span>
<span class="hljs-comment">// zpub6jftahH18ngZyAF16LmFdfsUCFKtmrARFwJQQZFtTS4MvVuG24MHVkE9WEEsGXWehVAJbbkA8YpxYSQ95BbgNc6NHw68iCj3FzX7EiKGaw8</span>
</code></pre>
<p>Which gives us something that looks like this</p>
<p><code>zpub6jftahH18ngZw98KGjRo5XcxeKTQ2eztsvskb1dC9XF5TLimQquTs6Ry7nBBA425D9joXmfgJJCexmJ1u2SELJZJfRi95gcnXadLpZzYb5c</code></p>
@ -149,7 +149,7 @@ println(mainnetXpub)
<h4><a class="anchor" aria-hidden="true" id="creating-a-key-manager-from-existing-mnemonic"></a><a href="#creating-a-key-manager-from-existing-mnemonic" 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>Creating a key manager from existing mnemonic</h4>
<p>To create a <code>KeyManager</code> from existing mnemonic you need to specify the <code>seedPath</code> and then construct the <code>KeyManagerParams</code> that you would like.</p>
<p>Finally you call <code>KeyManager.fromParams()</code> that reads the mnemonic from disk and create's the key manager</p>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/next/fee-provider/fee-provider"><span class="arrow-prev">← </span><span>Fee Provider</span></a><a class="docs-next button" href="/docs/next/node/node"><span>Light Client</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>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/next/key-manager/server-key-manager"><span class="arrow-prev">← </span><span>Previous</span></a><a class="docs-next button" href="/docs/next/node/node"><span>Light Client</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) {
if (e.target !== document.body) {
return;

81
docs/next/key-manager/server-key-manager title: Server Key Manager.html Normal file
View file

@ -0,0 +1,81 @@
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>key-manager/server-key-manager title: Server Key Manager · bitcoin-s</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="The [Application Server](/docs/next/applications/server) supports a Neutrino node and wallet. For its wallet, it uses"/><meta name="docsearch:version" content="next"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="key-manager/server-key-manager title: Server Key Manager · bitcoin-s"/><meta property="og:type" content="website"/><meta property="og:url" content="https://bitcoin-s.org/"/><meta property="og:description" content="The [Application Server](/docs/next/applications/server) supports a Neutrino node and wallet. For its wallet, it uses"/><meta property="og:image" content="https://bitcoin-s.org/img/undraw_online.svg"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://bitcoin-s.org/img/undraw_tweetstorm.svg"/><link rel="shortcut icon" href="/img/favicon.ico"/><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-61958686-2', 'auto');
ga('send', 'pageview');
</script><link rel="stylesheet" href="/css/code-block-buttons.css"/><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="https://fonts.googleapis.com/css?family=Montserrat:500"></script><script type="text/javascript" src="https://www.googletagmanager.com/gtag/js?id=UA-61958686-2"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/favicon.ico" alt="bitcoin-s"/><h2 class="headerTitleWithLogo">bitcoin-s</h2></a><a href="/versions"><h3>next</h3></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/next/core/core-intro" target="_self">Docs</a></li><li class=""><a href="/api/org/bitcoins" target="_self">API</a></li><li class=""><a href="/help" target="_self">Help</a></li><li class="navSearchWrapper reactNavSearchWrapper"><input type="text" id="search_input_react" placeholder="Search" title="Search"/></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><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/key-manager/server-key-manager.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">key-manager/server-key-manager title: Server Key Manager</h1></header><article><div><span><p>The <a href="/docs/next/applications/server">Application Server</a> supports a Neutrino node and wallet. For its wallet, it uses
a <code>BIP39KeyManager</code> for handling its underlying keys and doing cryptographic functions like signing transactions.</p>
<h3><a class="anchor" aria-hidden="true" id="backups"></a><a href="#backups" 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>Backups</h3>
<p>All seeds are stored in the <code>seeds</code> folder inside your bitcoin-s directory, the default location is in <code>~/.bitcoin-s</code>.
The easiest way to back up your seeds is to simply copy the <code>seeds</code> folder to your secure back up location.</p>
<p>Do note that if you have a key manager passphrase or a BIP 39 passphrase set for a given seed, you will need these to be
able to recover the seed.</p>
<h3><a class="anchor" aria-hidden="true" id="using-multiple-seeds"></a><a href="#using-multiple-seeds" 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>Using multiple seeds</h3>
<p>You can change which wallet and key manager you are using by setting the <code>bitcoin-s.wallet.walletName</code> config
option. If it is not set, it will use the default wallet. Different seeds are saved in the <code>seeds</code> folder, and the
seed's file name will be prefixed with the wallet name.</p>
<p>For example, if you have a default wallet, and 2 wallets named <code>test-wallet</code> and <code>rickRollWallet</code> your seeds folder will look like:</p>
<pre><code class="hljs">tree ~/.bitcoin-s/seeds
/home/suredbits/.bitcoin-s/seeds
├── <span class="hljs-keyword">encrypted</span>-bitcoin-s-seed.json
├── test-wallet-<span class="hljs-keyword">encrypted</span>-bitcoin-s-seed.json
└── rickRollWallet-<span class="hljs-keyword">encrypted</span>-bitcoin-s-seed.json
</code></pre>
<p>Currently, Bitcoin-S only supports using a single key manger/wallet at a single instance. When switching wallets, you
will need to shut down the server and restart it with your modified config.</p>
<h3><a class="anchor" aria-hidden="true" id="passphrases"></a><a href="#passphrases" 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>Passphrases</h3>
<p>Upon creating a wallet it's passphrase and the BIP 39 passphrase will be set to use what is in
your <a href="/docs/next/config/configuration">configuration file</a>. The key manager's passphrase is set using
the <code>bitcoin-s.keymanager.aespassword</code> option, and the BIP 39 passphrase is set using
the <code>bitcoin-s.keymanager.bip39password</code> option.</p>
<p>If you do not have the set the <code>aespassword</code> config option on the creation of the key manager, then the seed will be
saved unencrypted.</p>
<h4><a class="anchor" aria-hidden="true" id="changing-key-manager-passphrase"></a><a href="#changing-key-manager-passphrase" 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>Changing Key Manager Passphrase</h4>
<p>You can set and change your key mananger's passphrase using the <code>keymanagerpassphraseset</code>
or <code>keymanagerpassphrasechange</code> rpc commands. For more details checkout out
the <a href="/docs/next/applications/server#wallet">server docs</a>.</p>
<p>You cannot change your BIP39 passphrase because this would change the underlying keys. To change this you will need to
create a new wallet and then send all the UTXOs from the previous wallet to the new one.</p>
<h3><a class="anchor" aria-hidden="true" id="restoring-a-seed"></a><a href="#restoring-a-seed" 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>Restoring a Seed</h3>
<h4><a class="anchor" aria-hidden="true" id="restore-from-mnemonic"></a><a href="#restore-from-mnemonic" 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>Restore from Mnemonic</h4>
<p>To restore from a mnemonic seed you can use the <code>importseed</code> cli command.
It takes in the actual mnemonic seed, wallet name, and an optional passphrase to encrypt the seed.</p>
<p><strong>Example:</strong></p>
<pre><code class="hljs">bitcoin-s-cli importseed <span class="hljs-comment">&quot;never gonna give you up never gonna let you down never gonna run around and desert you never gonna make you cry never gonna&quot;</span> <span class="hljs-comment">&quot;rickRollWallet&quot;</span> <span class="hljs-comment">&quot;insecurePassword&quot;</span>
</code></pre>
<h4><a class="anchor" aria-hidden="true" id="restore-from-xprv"></a><a href="#restore-from-xprv" 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>Restore from XPRV</h4>
<p>To restore from a mnemonic seed you can use the <code>importxprv</code> cli command.
It takes in the base58 encoded xprv, wallet name, and an optional passphrase to encrypt the seed.</p>
<p><strong>Example:</strong></p>
<pre><code class="hljs">bitcoin-s-<span class="hljs-keyword">cli</span> importxprv <span class="hljs-string">&quot;xprv9uHRZZhk6KAJC1avXpDAp4MDc3sQKNxDiPvvkX8Br5ngLNv1TxvUxt4cV1rGL5hj6KCesnDYUhd7oWgT11eZG7XnxHrnYeSvkzY7d2bhkJ7&quot;</span> <span class="hljs-string">&quot;xprvWallet&quot;</span> <span class="hljs-string">&quot;insecurePassword&quot;</span>
</code></pre>
<h4><a class="anchor" aria-hidden="true" id="restore-from-backup"></a><a href="#restore-from-backup" 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>Restore from backup</h4>
<p>To restore from a backed up seed, simply put the seed file in the <code>seeds</code> folder and then load the wallet.
To do this, you will need the seed file name to be <code>walletName-encrypted-bitcoin-s-seed.json</code> or <code>encrypted-bitcoin-s-seed.json</code>
if you want it to be the default wallet.
To load it, just set the <code>bitcoin-s.wallet.walletName</code> config option to the appropriate wallet name.</p>
<p>You may need to run a wallet rescan to restore funds, this can be done by using the <code>rescan</code> RPC command.</p>
<p>For example, if you wanted to restore your <code>rickRollWallet</code>, you would place your backup at <code>~/.bitcoin-s/seeds/rickRollWallet-encrypted-bitcoin-s-seed.json</code>
and then load the wallet using a config with <code>bitcoin-s.wallet.walletName = rickRollWallet</code></p>
</span></div></article></div><div class="docs-prevnext"></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) {
if (e.target !== document.body) {
return;
}
// keyCode for '/' (slash)
if (e.keyCode === 191) {
const search = document.getElementById('search_input_react');
search && search.focus();
}
});
</script><script>
var search = docsearch({
apiKey: '0a510688bf8448e19aeb380377d328d3',
indexName: 'bitcoin-s',
inputSelector: '#search_input_react'
});
</script></body></html>

81
docs/next/key-manager/server-key-manager title: Server Key Manager/index.html Normal file
View file

@ -0,0 +1,81 @@
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>key-manager/server-key-manager title: Server Key Manager · bitcoin-s</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="The [Application Server](/docs/next/applications/server) supports a Neutrino node and wallet. For its wallet, it uses"/><meta name="docsearch:version" content="next"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="key-manager/server-key-manager title: Server Key Manager · bitcoin-s"/><meta property="og:type" content="website"/><meta property="og:url" content="https://bitcoin-s.org/"/><meta property="og:description" content="The [Application Server](/docs/next/applications/server) supports a Neutrino node and wallet. For its wallet, it uses"/><meta property="og:image" content="https://bitcoin-s.org/img/undraw_online.svg"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://bitcoin-s.org/img/undraw_tweetstorm.svg"/><link rel="shortcut icon" href="/img/favicon.ico"/><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-61958686-2', 'auto');
ga('send', 'pageview');
</script><link rel="stylesheet" href="/css/code-block-buttons.css"/><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="https://fonts.googleapis.com/css?family=Montserrat:500"></script><script type="text/javascript" src="https://www.googletagmanager.com/gtag/js?id=UA-61958686-2"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/favicon.ico" alt="bitcoin-s"/><h2 class="headerTitleWithLogo">bitcoin-s</h2></a><a href="/versions"><h3>next</h3></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/next/core/core-intro" target="_self">Docs</a></li><li class=""><a href="/api/org/bitcoins" target="_self">API</a></li><li class=""><a href="/help" target="_self">Help</a></li><li class="navSearchWrapper reactNavSearchWrapper"><input type="text" id="search_input_react" placeholder="Search" title="Search"/></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><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/key-manager/server-key-manager.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">key-manager/server-key-manager title: Server Key Manager</h1></header><article><div><span><p>The <a href="/docs/next/applications/server">Application Server</a> supports a Neutrino node and wallet. For its wallet, it uses
a <code>BIP39KeyManager</code> for handling its underlying keys and doing cryptographic functions like signing transactions.</p>
<h3><a class="anchor" aria-hidden="true" id="backups"></a><a href="#backups" 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>Backups</h3>
<p>All seeds are stored in the <code>seeds</code> folder inside your bitcoin-s directory, the default location is in <code>~/.bitcoin-s</code>.
The easiest way to back up your seeds is to simply copy the <code>seeds</code> folder to your secure back up location.</p>
<p>Do note that if you have a key manager passphrase or a BIP 39 passphrase set for a given seed, you will need these to be
able to recover the seed.</p>
<h3><a class="anchor" aria-hidden="true" id="using-multiple-seeds"></a><a href="#using-multiple-seeds" 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>Using multiple seeds</h3>
<p>You can change which wallet and key manager you are using by setting the <code>bitcoin-s.wallet.walletName</code> config
option. If it is not set, it will use the default wallet. Different seeds are saved in the <code>seeds</code> folder, and the
seed's file name will be prefixed with the wallet name.</p>
<p>For example, if you have a default wallet, and 2 wallets named <code>test-wallet</code> and <code>rickRollWallet</code> your seeds folder will look like:</p>
<pre><code class="hljs">tree ~/.bitcoin-s/seeds
/home/suredbits/.bitcoin-s/seeds
├── <span class="hljs-keyword">encrypted</span>-bitcoin-s-seed.json
├── test-wallet-<span class="hljs-keyword">encrypted</span>-bitcoin-s-seed.json
└── rickRollWallet-<span class="hljs-keyword">encrypted</span>-bitcoin-s-seed.json
</code></pre>
<p>Currently, Bitcoin-S only supports using a single key manger/wallet at a single instance. When switching wallets, you
will need to shut down the server and restart it with your modified config.</p>
<h3><a class="anchor" aria-hidden="true" id="passphrases"></a><a href="#passphrases" 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>Passphrases</h3>
<p>Upon creating a wallet it's passphrase and the BIP 39 passphrase will be set to use what is in
your <a href="/docs/next/config/configuration">configuration file</a>. The key manager's passphrase is set using
the <code>bitcoin-s.keymanager.aespassword</code> option, and the BIP 39 passphrase is set using
the <code>bitcoin-s.keymanager.bip39password</code> option.</p>
<p>If you do not have the set the <code>aespassword</code> config option on the creation of the key manager, then the seed will be
saved unencrypted.</p>
<h4><a class="anchor" aria-hidden="true" id="changing-key-manager-passphrase"></a><a href="#changing-key-manager-passphrase" 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>Changing Key Manager Passphrase</h4>
<p>You can set and change your key mananger's passphrase using the <code>keymanagerpassphraseset</code>
or <code>keymanagerpassphrasechange</code> rpc commands. For more details checkout out
the <a href="/docs/next/applications/server#wallet">server docs</a>.</p>
<p>You cannot change your BIP39 passphrase because this would change the underlying keys. To change this you will need to
create a new wallet and then send all the UTXOs from the previous wallet to the new one.</p>
<h3><a class="anchor" aria-hidden="true" id="restoring-a-seed"></a><a href="#restoring-a-seed" 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>Restoring a Seed</h3>
<h4><a class="anchor" aria-hidden="true" id="restore-from-mnemonic"></a><a href="#restore-from-mnemonic" 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>Restore from Mnemonic</h4>
<p>To restore from a mnemonic seed you can use the <code>importseed</code> cli command.
It takes in the actual mnemonic seed, wallet name, and an optional passphrase to encrypt the seed.</p>
<p><strong>Example:</strong></p>
<pre><code class="hljs">bitcoin-s-cli importseed <span class="hljs-comment">&quot;never gonna give you up never gonna let you down never gonna run around and desert you never gonna make you cry never gonna&quot;</span> <span class="hljs-comment">&quot;rickRollWallet&quot;</span> <span class="hljs-comment">&quot;insecurePassword&quot;</span>
</code></pre>
<h4><a class="anchor" aria-hidden="true" id="restore-from-xprv"></a><a href="#restore-from-xprv" 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>Restore from XPRV</h4>
<p>To restore from a mnemonic seed you can use the <code>importxprv</code> cli command.
It takes in the base58 encoded xprv, wallet name, and an optional passphrase to encrypt the seed.</p>
<p><strong>Example:</strong></p>
<pre><code class="hljs">bitcoin-s-<span class="hljs-keyword">cli</span> importxprv <span class="hljs-string">&quot;xprv9uHRZZhk6KAJC1avXpDAp4MDc3sQKNxDiPvvkX8Br5ngLNv1TxvUxt4cV1rGL5hj6KCesnDYUhd7oWgT11eZG7XnxHrnYeSvkzY7d2bhkJ7&quot;</span> <span class="hljs-string">&quot;xprvWallet&quot;</span> <span class="hljs-string">&quot;insecurePassword&quot;</span>
</code></pre>
<h4><a class="anchor" aria-hidden="true" id="restore-from-backup"></a><a href="#restore-from-backup" 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>Restore from backup</h4>
<p>To restore from a backed up seed, simply put the seed file in the <code>seeds</code> folder and then load the wallet.
To do this, you will need the seed file name to be <code>walletName-encrypted-bitcoin-s-seed.json</code> or <code>encrypted-bitcoin-s-seed.json</code>
if you want it to be the default wallet.
To load it, just set the <code>bitcoin-s.wallet.walletName</code> config option to the appropriate wallet name.</p>
<p>You may need to run a wallet rescan to restore funds, this can be done by using the <code>rescan</code> RPC command.</p>
<p>For example, if you wanted to restore your <code>rickRollWallet</code>, you would place your backup at <code>~/.bitcoin-s/seeds/rickRollWallet-encrypted-bitcoin-s-seed.json</code>
and then load the wallet using a config with <code>bitcoin-s.wallet.walletName = rickRollWallet</code></p>
</span></div></article></div><div class="docs-prevnext"></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) {
if (e.target !== document.body) {
return;
}
// keyCode for '/' (slash)
if (e.keyCode === 191) {
const search = document.getElementById('search_input_react');
search && search.focus();
}
});
</script><script>
var search = docsearch({
apiKey: '0a510688bf8448e19aeb380377d328d3',
indexName: 'bitcoin-s',
inputSelector: '#search_input_react'
});
</script></body></html>

3
docs/next/node/node.html
View file

@ -67,6 +67,9 @@
<p>Bitcoin-s has experimental support for neutrino which is a new lite client proposal on the bitcoin p2p network. You can
read more about how neutrino works <a href="https://suredbits.com/neutrino-what-is-it-and-why-we-need-it/">here</a>. At this time,
bitcoin-s only supports connecting to one trusted peer.</p>
<h4><a class="anchor" aria-hidden="true" id="limitations"></a><a href="#limitations" 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>Limitations</h4>
<p>Currently, the node does not have an active mempool.
It is only aware of transactions it broadcasts and ones confirmed in blocks.</p>
<h4><a class="anchor" aria-hidden="true" id="callbacks"></a><a href="#callbacks" 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>Callbacks</h4>
<p>Bitcoin-S support call backs for the following events that happen on the bitcoin p2p network:</p>
<ol>

3
docs/next/node/node/index.html
View file

@ -67,6 +67,9 @@
<p>Bitcoin-s has experimental support for neutrino which is a new lite client proposal on the bitcoin p2p network. You can
read more about how neutrino works <a href="https://suredbits.com/neutrino-what-is-it-and-why-we-need-it/">here</a>. At this time,
bitcoin-s only supports connecting to one trusted peer.</p>
<h4><a class="anchor" aria-hidden="true" id="limitations"></a><a href="#limitations" 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>Limitations</h4>
<p>Currently, the node does not have an active mempool.
It is only aware of transactions it broadcasts and ones confirmed in blocks.</p>
<h4><a class="anchor" aria-hidden="true" id="callbacks"></a><a href="#callbacks" 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>Callbacks</h4>
<p>Bitcoin-S support call backs for the following events that happen on the bitcoin p2p network:</p>
<ol>

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

@ -114,12 +114,12 @@ println(<span class="hljs-string">s&quot;Verified with NativeSecp256k1 again=<sp
<pre><code class="hljs css language-scala"><span class="hljs-keyword">val</span> privKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey
<span class="hljs-comment">// privKey: ECPrivateKey = Masked(ECPrivateKeyImpl)</span>
<span class="hljs-keyword">val</span> publicKey = privKey.publicKeyWithBouncyCastle
<span class="hljs-comment">// publicKey: ECPublicKey = ECPublicKey(02e157f4aa1a804dfba203397c8456b4e2942a84ba7e4b090041855fe0b99216d5)</span>
<span class="hljs-comment">// publicKey: ECPublicKey = ECPublicKey(033f81a465c7cd6386db274f35ada7106361a269de02e48273acd143d04e4c2bed)</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(3045022100dcbbb51eb3938908076f1d6d165c5a5f1c6f231f0a0b6930c486409585d6330f02205e1aeacd58d39ec81976df0d64a28a300a1cc30f4df8d1c1a20a47449f25bafc)</span>
<span class="hljs-comment">// signature: ECDigitalSignature = ECDigitalSignature(3045022100bc40333f65fbe8e4ddd5f4c73e87e1a6ac1938cd60988c742932b5e93546ed7b0220626440132261b3853ee3065f07c23c83d86715c2a91c395d9bc1be394d22314d)</span>
<span class="hljs-keyword">val</span> verified = publicKey.verifyWithBouncyCastle(dataToSign.bytes, signature)
<span class="hljs-comment">// verified: Boolean = true</span>

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

@ -114,12 +114,12 @@ println(<span class="hljs-string">s&quot;Verified with NativeSecp256k1 again=<sp
<pre><code class="hljs css language-scala"><span class="hljs-keyword">val</span> privKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey
<span class="hljs-comment">// privKey: ECPrivateKey = Masked(ECPrivateKeyImpl)</span>
<span class="hljs-keyword">val</span> publicKey = privKey.publicKeyWithBouncyCastle
<span class="hljs-comment">// publicKey: ECPublicKey = ECPublicKey(02e157f4aa1a804dfba203397c8456b4e2942a84ba7e4b090041855fe0b99216d5)</span>
<span class="hljs-comment">// publicKey: ECPublicKey = ECPublicKey(033f81a465c7cd6386db274f35ada7106361a269de02e48273acd143d04e4c2bed)</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(3045022100dcbbb51eb3938908076f1d6d165c5a5f1c6f231f0a0b6930c486409585d6330f02205e1aeacd58d39ec81976df0d64a28a300a1cc30f4df8d1c1a20a47449f25bafc)</span>
<span class="hljs-comment">// signature: ECDigitalSignature = ECDigitalSignature(3045022100bc40333f65fbe8e4ddd5f4c73e87e1a6ac1938cd60988c742932b5e93546ed7b0220626440132261b3853ee3065f07c23c83d86715c2a91c395d9bc1be394d22314d)</span>
<span class="hljs-keyword">val</span> verified = publicKey.verifyWithBouncyCastle(dataToSign.bytes, signature)
<span class="hljs-comment">// verified: Boolean = true</span>

2
docs/next/wallet/wallet.html
View file

@ -75,7 +75,7 @@ ready. Use at your own risk, and without too much money depending on it.</p>
<p>All key interactions are delegated to the <a href="/docs/next/key-manager/key-manager">key-manager</a> which is a minimal dependency library to store and use key material.</p>
<p>By default, we store the encrypted root key in <code>$HOME/.bitcoin-s/seeds/encrypted-bitcoin-s-seed.json</code>. This is the seed that is used for each of the wallets on each bitcoin network.
Multiple wallet seeds can be saved using the <code>bitcoin-s.wallet.walletName</code> config option.
You can read more in the <a href="../key-manager/server-key-manager.md">key manager docs</a>.</p>
You can read more in the [key manager docs](/docs/next/key-manager/server-key-manager title: Server Key Manager).</p>
<p>The wallet itself is used to manage the utxo life cycle, create transactions, and update wallet balances to show how much money you have the on a bitcoin network.</p>
<p>We use <a href="https://scala-slick.org/doc/3.3.1/">slick</a> as middleware to support different database types. Depending on your use case, you can use something as simple as sqlite, or something much more scalable like postgres.</p>
<h3><a class="anchor" aria-hidden="true" id="example"></a><a href="#example" 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>Example</h3>

2
docs/next/wallet/wallet/index.html
View file

@ -75,7 +75,7 @@ ready. Use at your own risk, and without too much money depending on it.</p>
<p>All key interactions are delegated to the <a href="/docs/next/key-manager/key-manager">key-manager</a> which is a minimal dependency library to store and use key material.</p>
<p>By default, we store the encrypted root key in <code>$HOME/.bitcoin-s/seeds/encrypted-bitcoin-s-seed.json</code>. This is the seed that is used for each of the wallets on each bitcoin network.
Multiple wallet seeds can be saved using the <code>bitcoin-s.wallet.walletName</code> config option.
You can read more in the <a href="../key-manager/server-key-manager.md">key manager docs</a>.</p>
You can read more in the [key manager docs](/docs/next/key-manager/server-key-manager title: Server Key Manager).</p>
<p>The wallet itself is used to manage the utxo life cycle, create transactions, and update wallet balances to show how much money you have the on a bitcoin network.</p>
<p>We use <a href="https://scala-slick.org/doc/3.3.1/">slick</a> as middleware to support different database types. Depending on your use case, you can use something as simple as sqlite, or something much more scalable like postgres.</p>
<h3><a class="anchor" aria-hidden="true" id="example"></a><a href="#example" 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>Example</h3>

2
sitemap.xml
View file

File diff suppressed because one or more lines are too long