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

Deploy website

Browse source 
Deploy website version based on 4c15eb5268
This commit is contained in:
Docusaurus bot 2021-10-06 00:02:48 +00:00
parent 4811b37160
commit f3f960ba47
20 changed files with 112 additions and 112 deletions

2
api/index.js
View file

File diff suppressed because one or more lines are too long

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

File diff suppressed because one or more lines are too long

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

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

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

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

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

File diff suppressed because one or more lines are too long

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

File diff suppressed because one or more lines are too long

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

@ -86,13 +86,13 @@ use that to generate further private and public keys:</p>
<span class="hljs-comment">// how long our phrase ends up being</span>
<span class="hljs-comment">// 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, 0xffc869604ac1616ac06491d6fbe55c3e5609903bb24663378e093497b7099ffe)</span>
<span class="hljs-comment">// entropy: BitVector = BitVector(256 bits, 0x508f2798f51544dfcf30a3c52e425d27eac62ee9f11fd1d998654614317babea)</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(zone, drive, fix, night, bid, rely, account, mutual, street, tennis, finish, lake, gauge, siege, uphold, emotion, glimpse, round, liquid, hard, kiwi, luggage, lend, stool) // the phrase the user should write down</span>
<span class="hljs-comment">// res0: Vector[String] = Vector(explain, junior, tower, tuition, february, husband, devote, behave, share, improve, nuclear, exist, property, blast, pond, catalog, spike, smoke, bone, method, drink, saddle, quick, duty) // 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 = zpub6jftahH18ngZy7aU72up8wsueF3kKkWy3nVuuP1zhvwmXnyc9Db7G3AMLjmeBAcPi2zqmuRYaybzrKxopn4inbaa6NdTCu37cs5FwUDEoHg</span>
<span class="hljs-comment">// xpub: ExtPublicKey = zpub6jftahH18ngZyct9s8NTEWYL6rL2U46aKKztPB83sVauV1MwqqqgM9Fvmzta5HAR9WcfKhHWh9GVYPJdEW2hhRgfPxGaegH3Pu1zUUy9gCa</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 = zpub6r4eC3A1NTbB9JHYqqPraQfzFH3kmjaX46zXTGpWDwKnDZg9SC7arj7g6prKvczAHZsz2sRa2acccVt8wgGpfyMgdwnbcREGn2m9AQsoVMt</span>
<span class="hljs-comment">// accountXpub: ExtPublicKey = zpub6qQGH84WgozgRHZdoNXUWYNS34ewKsAr9rTF1Ak4AKbBiRDwHhxJ3ZjBNHb4qXzK7bRr7dgso4x7a1eAtiGfc9gYQpQH4bysNo6GimuQUeS</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 = tb1qzac5hzcf4zqzyl8x2r9qmz5eexcm80gph0uryh</span>
<span class="hljs-comment">// firstAccountAddress: Bech32Address = tb1q4g6gcgmc7qfxwsap03lpk00xj4upr2ce4nppav</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 = tb1qzac5hzcf4zqzyl8x2r9qmz5eexcm80gph0uryh</span>
<span class="hljs-comment">// res2: String = tb1q4g6gcgmc7qfxwsap03lpk00xj4upr2ce4nppav</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, 0xffc869604ac1616ac06491d6fbe55c3e5609903bb24663378e093497b7099ffe)</span>
<span class="hljs-comment">// entropy: BitVector = BitVector(256 bits, 0x508f2798f51544dfcf30a3c52e425d27eac62ee9f11fd1d998654614317babea)</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(zone, drive, fix, night, bid, rely, account, mutual, street, tennis, finish, lake, gauge, siege, uphold, emotion, glimpse, round, liquid, hard, kiwi, luggage, lend, stool) // the phrase the user should write down</span>
<span class="hljs-comment">// res0: Vector[String] = Vector(explain, junior, tower, tuition, february, husband, devote, behave, share, improve, nuclear, exist, property, blast, pond, catalog, spike, smoke, bone, method, drink, saddle, quick, duty) // 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 = zpub6jftahH18ngZy7aU72up8wsueF3kKkWy3nVuuP1zhvwmXnyc9Db7G3AMLjmeBAcPi2zqmuRYaybzrKxopn4inbaa6NdTCu37cs5FwUDEoHg</span>
<span class="hljs-comment">// xpub: ExtPublicKey = zpub6jftahH18ngZyct9s8NTEWYL6rL2U46aKKztPB83sVauV1MwqqqgM9Fvmzta5HAR9WcfKhHWh9GVYPJdEW2hhRgfPxGaegH3Pu1zUUy9gCa</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 = zpub6r4eC3A1NTbB9JHYqqPraQfzFH3kmjaX46zXTGpWDwKnDZg9SC7arj7g6prKvczAHZsz2sRa2acccVt8wgGpfyMgdwnbcREGn2m9AQsoVMt</span>
<span class="hljs-comment">// accountXpub: ExtPublicKey = zpub6qQGH84WgozgRHZdoNXUWYNS34ewKsAr9rTF1Ak4AKbBiRDwHhxJ3ZjBNHb4qXzK7bRr7dgso4x7a1eAtiGfc9gYQpQH4bysNo6GimuQUeS</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 = tb1qzac5hzcf4zqzyl8x2r9qmz5eexcm80gph0uryh</span>
<span class="hljs-comment">// firstAccountAddress: Bech32Address = tb1q4g6gcgmc7qfxwsap03lpk00xj4upr2ce4nppav</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 = tb1qzac5hzcf4zqzyl8x2r9qmz5eexcm80gph0uryh</span>
<span class="hljs-comment">// res2: String = tb1q4g6gcgmc7qfxwsap03lpk00xj4upr2ce4nppav</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@27acc0ff[Running, parallelism = 2, size = 0, active = 0, running = 0, steals = 0, tasks = 0, submissions = 0]</span>
<span class="hljs-comment">// ec: ExecutionContext = scala.concurrent.impl.ExecutionContextImpl$$anon$3@261eb091[Running, parallelism = 2, size = 0, active = 0, running = 0, steals = 0, tasks = 0, submissions = 0]</span>
<span class="hljs-comment">// Initialize a transaction builder</span>
<span class="hljs-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(ECPrivateKey)</span>
<span class="hljs-keyword">val</span> pubKey = privKey.publicKey
<span class="hljs-comment">// pubKey: ECPublicKey = ECPublicKey(02751bde121b9c75e2e3bcd7ec8520472554605af20f98e5e1438d11db61135572)</span>
<span class="hljs-comment">// pubKey: ECPublicKey = ECPublicKey(021c7836edf0a81981a4159b9cc141ff765a9be5a9f91587040657ec7e1f982ac6)</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(42ee82f87b391aacf86700c16ac379b54df4b2a9)</span>
<span class="hljs-comment">// creditingSpk: P2PKHScriptPubKey = pkh(836179f10199ef52e8c05c10acc1de3553347d30)</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(42ee82f87b391aacf86700c16ac379b54df4b2a9))</span>
<span class="hljs-comment">// utxo: TransactionOutput = TransactionOutput(10000 sats,pkh(836179f10199ef52e8c05c10acc1de3553347d30))</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(922a18174c8f9ef77b1691fe9ff8035e5ac0db29)</span>
<span class="hljs-comment">// destinationSPK: P2PKHScriptPubKey = pkh(cbdcf3e6150bec3018484f55ccc989c3da658463)</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(922a18174c8f9ef77b1691fe9ff8035e5ac0db29)))</span>
<span class="hljs-comment">// destinations: Vector[TransactionOutput] = Vector(TransactionOutput(5000 sats,pkh(cbdcf3e6150bec3018484f55ccc989c3da658463)))</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(42ee82f87b391aacf86700c16ac379b54df4b2a9))),UInt32Impl(0))</span>
<span class="hljs-comment">// creditingTx: BaseTransaction = BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(836179f10199ef52e8c05c10acc1de3553347d30))),UInt32Impl(0))</span>
<span class="hljs-comment">// this is the information we need from the crediting TX</span>
<span class="hljs-comment">// to properly "link" it in the transaction we are creating</span>
<span class="hljs-keyword">val</span> outPoint = <span class="hljs-type">TransactionOutPoint</span>(creditingTx.txId, <span class="hljs-type">UInt32</span>.zero)
<span class="hljs-comment">// outPoint: TransactionOutPoint = TransactionOutPoint(72abc2769c3cafa3ac70210c4dd9cc70a00c6a4d9fd75b7b2d36356a56e82db2:0)</span>
<span class="hljs-comment">// outPoint: TransactionOutPoint = TransactionOutPoint(d70478be6f987ff4e8381f094e4cd27563eab14ab86991b94f8cee1c0834f369: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(72abc2769c3cafa3ac70210c4dd9cc70a00c6a4d9fd75b7b2d36356a56e82db2:0),EmptyScriptSignature,UInt32Impl(0))</span>
<span class="hljs-comment">// input: TransactionInput = TransactionInputImpl(TransactionOutPoint(d70478be6f987ff4e8381f094e4cd27563eab14ab86991b94f8cee1c0834f369: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(72abc2769c3cafa3ac70210c4dd9cc70a00c6a4d9fd75b7b2d36356a56e82db2:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(922a18174c8f9ef77b1691fe9ff8035e5ac0db29))),UInt32Impl(0))</span>
<span class="hljs-comment">// builderResult: RawTxBuilderResult = RawTxBuilderResult(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(d70478be6f987ff4e8381f094e4cd27563eab14ab86991b94f8cee1c0834f369:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(cbdcf3e6150bec3018484f55ccc989c3da658463))),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(72abc2769c3cafa3ac70210c4dd9cc70a00c6a4d9fd75b7b2d36356a56e82db2:0),10000 sats,ECPublicKey(02751bde121b9c75e2e3bcd7ec8520472554605af20f98e5e1438d11db61135572))</span>
<span class="hljs-comment">// inputInfo: P2PKHInputInfo = P2PKHInputInfo(TransactionOutPoint(d70478be6f987ff4e8381f094e4cd27563eab14ab86991b94f8cee1c0834f369:0),10000 sats,ECPublicKey(021c7836edf0a81981a4159b9cc141ff765a9be5a9f91587040657ec7e1f982ac6))</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(ECPrivateKey)</span>
<span class="hljs-keyword">val</span> changeSPK = <span class="hljs-type">P2PKHScriptPubKey</span>(pubKey = changePrivKey.publicKey)
<span class="hljs-comment">// changeSPK: P2PKHScriptPubKey = pkh(9dc54ebf66d7dad3e48bd93ebd8004690771fc2d)</span>
<span class="hljs-comment">// changeSPK: P2PKHScriptPubKey = pkh(334b79cd2db7d12dd2e99e22f8b7c77cb80f9e48)</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(72abc2769c3cafa3ac70210c4dd9cc70a00c6a4d9fd75b7b2d36356a56e82db2:0),10000 sats,ECPublicKey(02751bde121b9c75e2e3bcd7ec8520472554605af20f98e5e1438d11db61135572))),1 sats/byte,pkh(9dc54ebf66d7dad3e48bd93ebd8004690771fc2d))</span>
<span class="hljs-comment">// finalizer: StandardNonInteractiveFinalizer = StandardNonInteractiveFinalizer(Vector(P2PKHInputInfo(TransactionOutPoint(d70478be6f987ff4e8381f094e4cd27563eab14ab86991b94f8cee1c0834f369:0),10000 sats,ECPublicKey(021c7836edf0a81981a4159b9cc141ff765a9be5a9f91587040657ec7e1f982ac6))),1 sats/byte,pkh(334b79cd2db7d12dd2e99e22f8b7c77cb80f9e48))</span>
<span class="hljs-comment">// We can now finalize the tx builder result from earlier with this finalizer</span>
<span class="hljs-keyword">val</span> unsignedTx: <span class="hljs-type">Transaction</span> = finalizer.buildTx(builderResult)
<span class="hljs-comment">// unsignedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(72abc2769c3cafa3ac70210c4dd9cc70a00c6a4d9fd75b7b2d36356a56e82db2:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(922a18174c8f9ef77b1691fe9ff8035e5ac0db29)), TransactionOutput(4775 sats,pkh(9dc54ebf66d7dad3e48bd93ebd8004690771fc2d))),UInt32Impl(0))</span>
<span class="hljs-comment">// unsignedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(d70478be6f987ff4e8381f094e4cd27563eab14ab86991b94f8cee1c0834f369:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(cbdcf3e6150bec3018484f55ccc989c3da658463)), TransactionOutput(4775 sats,pkh(334b79cd2db7d12dd2e99e22f8b7c77cb80f9e48))),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(72abc2769c3cafa3ac70210c4dd9cc70a00c6a4d9fd75b7b2d36356a56e82db2:0),10000 sats,ECPublicKey(02751bde121b9c75e2e3bcd7ec8520472554605af20f98e5e1438d11db61135572)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(42ee82f87b391aacf86700c16ac379b54df4b2a9))),UInt32Impl(0)),Vector(Masked(ECPrivateKey)),SIGHASH_ALL(Int32Impl(1)))</span>
<span class="hljs-comment">// utxoInfo: ScriptSignatureParams[P2PKHInputInfo] = ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(d70478be6f987ff4e8381f094e4cd27563eab14ab86991b94f8cee1c0834f369:0),10000 sats,ECPublicKey(021c7836edf0a81981a4159b9cc141ff765a9be5a9f91587040657ec7e1f982ac6)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(836179f10199ef52e8c05c10acc1de3553347d30))),UInt32Impl(0)),Vector(Masked(ECPrivateKey)),SIGHASH_ALL(Int32Impl(1)))</span>
<span class="hljs-comment">// all of the UTXO spending information, since we only have</span>
<span class="hljs-comment">// 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(72abc2769c3cafa3ac70210c4dd9cc70a00c6a4d9fd75b7b2d36356a56e82db2:0),10000 sats,ECPublicKey(02751bde121b9c75e2e3bcd7ec8520472554605af20f98e5e1438d11db61135572)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(42ee82f87b391aacf86700c16ac379b54df4b2a9))),UInt32Impl(0)),Vector(Masked(ECPrivateKey)),SIGHASH_ALL(Int32Impl(1))))</span>
<span class="hljs-comment">// utxoInfos: Vector[ScriptSignatureParams[InputInfo]] = Vector(ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(d70478be6f987ff4e8381f094e4cd27563eab14ab86991b94f8cee1c0834f369:0),10000 sats,ECPublicKey(021c7836edf0a81981a4159b9cc141ff765a9be5a9f91587040657ec7e1f982ac6)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(836179f10199ef52e8c05c10acc1de3553347d30))),UInt32Impl(0)),Vector(Masked(ECPrivateKey)),SIGHASH_ALL(Int32Impl(1))))</span>
<span class="hljs-comment">// Yay! Now we use the RawTxSigner object to sign the tx.</span>
<span class="hljs-comment">// The 'sign' method is going produce a validly signed transaction</span>
@ -197,7 +197,7 @@ builder += input
utxoInfos = utxoInfos,
expectedFeeRate = feeRate
)
<span class="hljs-comment">// signedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(72abc2769c3cafa3ac70210c4dd9cc70a00c6a4d9fd75b7b2d36356a56e82db2:0),P2PKHScriptSignature(ECPublicKeyBytes(ByteVector(33 bytes, 0x02751bde121b9c75e2e3bcd7ec8520472554605af20f98e5e1438d11db61135572)), ECDigitalSignature(304402201182e57b0a8b3d3fd3a5b552e2d6c09ef3c99ff3d65ca0867b224fe73c492a51022009e464c5f72f0fdb4d1edf9775fffe65e725c1bc5db430cbd08f978f4f32af4f01)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(922a18174c8f9ef77b1691fe9ff8035e5ac0db29)), TransactionOutput(4775 sats,pkh(9dc54ebf66d7dad3e48bd93ebd8004690771fc2d))),UInt32Impl(0))</span>
<span class="hljs-comment">// signedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(d70478be6f987ff4e8381f094e4cd27563eab14ab86991b94f8cee1c0834f369:0),P2PKHScriptSignature(ECPublicKeyBytes(ByteVector(33 bytes, 0x021c7836edf0a81981a4159b9cc141ff765a9be5a9f91587040657ec7e1f982ac6)), ECDigitalSignature(30440220473cebbc192fc3ec77cb4bd18bdf264724764d9ba6450fe72bd342d83caa4c620220702f7620a299ff816b6e79ec535f9d4d62adc4468cef4756843525330e92a64801)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(cbdcf3e6150bec3018484f55ccc989c3da658463)), TransactionOutput(4775 sats,pkh(334b79cd2db7d12dd2e99e22f8b7c77cb80f9e48))),UInt32Impl(0))</span>
</code></pre>
<pre><code class="hljs css language-scala">signedTx.inputs.length
<span class="hljs-comment">// res2: Int = 1</span>
@ -207,7 +207,7 @@ signedTx.outputs.length
<span class="hljs-comment">//remember, you can call .hex on any bitcoin-s data structure to get the hex representation!</span>
signedTx.hex
<span class="hljs-comment">// res4: String = 0200000001b22de8566a35362d7b5bd79f4d6a0ca070ccd94d0c2170aca3af3c9c76c2ab72000000006a47304402201182e57b0a8b3d3fd3a5b552e2d6c09ef3c99ff3d65ca0867b224fe73c492a51022009e464c5f72f0fdb4d1edf9775fffe65e725c1bc5db430cbd08f978f4f32af4f012102751bde121b9c75e2e3bcd7ec8520472554605af20f98e5e1438d11db61135572000000000288130000000000001976a914922a18174c8f9ef77b1691fe9ff8035e5ac0db2988aca7120000000000001976a9149dc54ebf66d7dad3e48bd93ebd8004690771fc2d88ac00000000</span>
<span class="hljs-comment">// res4: String = 020000000169f334081cee8c4fb99169b84ab1ea6375d24c4e091f38e8f47f986fbe7804d7000000006a4730440220473cebbc192fc3ec77cb4bd18bdf264724764d9ba6450fe72bd342d83caa4c620220702f7620a299ff816b6e79ec535f9d4d62adc4468cef4756843525330e92a6480121021c7836edf0a81981a4159b9cc141ff765a9be5a9f91587040657ec7e1f982ac6000000000288130000000000001976a914cbdcf3e6150bec3018484f55ccc989c3da65846388aca7120000000000001976a914334b79cd2db7d12dd2e99e22f8b7c77cb80f9e4888ac00000000</span>
</code></pre>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/next/core/dlc"><span class="arrow-prev">← </span><span>Discreet Log Contract Data Structures</span></a><a class="docs-next button" href="/docs/next/core/lightning-network"><span>Lightning Network Data Types</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/favicon.ico" alt="bitcoin-s" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/getting-started">Getting Started</a><a href="/docs/en/core/core-intro">Guides</a><a href="/api/org/bitcoins">API Reference</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="https://join.slack.com/t/suredbits/shared_invite/zt-eavycu0x-WQL7XOakzQo8tAy7jHHZUw" target="_blank" rel="noreferrer noopener">Slack</a><a href="https://gitter.im/bitcoin-s-core/">Gitter chat</a></div><div><h5>More</h5><a href="https://github.com/bitcoin-s/bitcoin-s">GitHub</a><a class="github-button" href="https://github.com/bitcoin-s/bitcoin-s" data-icon="octicon-star" data-count-href="/bitcoin-s/bitcoin-s-core/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2021 Suredbits &amp; the bitcoin-s developers</section></footer></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script><script>
document.addEventListener('keyup', function(e) {

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

@ -64,7 +64,7 @@
});
</script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/bitcoin-s/bitcoin-s/blob/master/docs/core/txbuilder.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">TxBuilder Example</h1></header><article><div><span><p>Bitcoin-S features a transaction building API that allows you to construct and sign Bitcoin transactions. Here's an example of how to use it</p>
<pre><code class="hljs css language-scala"><span class="hljs-keyword">implicit</span> <span class="hljs-keyword">val</span> ec: <span class="hljs-type">ExecutionContext</span> = <span class="hljs-type">ExecutionContext</span>.<span class="hljs-type">Implicits</span>.global
<span class="hljs-comment">// ec: ExecutionContext = scala.concurrent.impl.ExecutionContextImpl$$anon$3@27acc0ff[Running, parallelism = 2, size = 0, active = 0, running = 0, steals = 0, tasks = 0, submissions = 0]</span>
<span class="hljs-comment">// ec: ExecutionContext = scala.concurrent.impl.ExecutionContextImpl$$anon$3@261eb091[Running, parallelism = 2, size = 0, active = 0, running = 0, steals = 0, tasks = 0, submissions = 0]</span>
<span class="hljs-comment">// Initialize a transaction builder</span>
<span class="hljs-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(ECPrivateKey)</span>
<span class="hljs-keyword">val</span> pubKey = privKey.publicKey
<span class="hljs-comment">// pubKey: ECPublicKey = ECPublicKey(02751bde121b9c75e2e3bcd7ec8520472554605af20f98e5e1438d11db61135572)</span>
<span class="hljs-comment">// pubKey: ECPublicKey = ECPublicKey(021c7836edf0a81981a4159b9cc141ff765a9be5a9f91587040657ec7e1f982ac6)</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(42ee82f87b391aacf86700c16ac379b54df4b2a9)</span>
<span class="hljs-comment">// creditingSpk: P2PKHScriptPubKey = pkh(836179f10199ef52e8c05c10acc1de3553347d30)</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(42ee82f87b391aacf86700c16ac379b54df4b2a9))</span>
<span class="hljs-comment">// utxo: TransactionOutput = TransactionOutput(10000 sats,pkh(836179f10199ef52e8c05c10acc1de3553347d30))</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(922a18174c8f9ef77b1691fe9ff8035e5ac0db29)</span>
<span class="hljs-comment">// destinationSPK: P2PKHScriptPubKey = pkh(cbdcf3e6150bec3018484f55ccc989c3da658463)</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(922a18174c8f9ef77b1691fe9ff8035e5ac0db29)))</span>
<span class="hljs-comment">// destinations: Vector[TransactionOutput] = Vector(TransactionOutput(5000 sats,pkh(cbdcf3e6150bec3018484f55ccc989c3da658463)))</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(42ee82f87b391aacf86700c16ac379b54df4b2a9))),UInt32Impl(0))</span>
<span class="hljs-comment">// creditingTx: BaseTransaction = BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(836179f10199ef52e8c05c10acc1de3553347d30))),UInt32Impl(0))</span>
<span class="hljs-comment">// this is the information we need from the crediting TX</span>
<span class="hljs-comment">// to properly "link" it in the transaction we are creating</span>
<span class="hljs-keyword">val</span> outPoint = <span class="hljs-type">TransactionOutPoint</span>(creditingTx.txId, <span class="hljs-type">UInt32</span>.zero)
<span class="hljs-comment">// outPoint: TransactionOutPoint = TransactionOutPoint(72abc2769c3cafa3ac70210c4dd9cc70a00c6a4d9fd75b7b2d36356a56e82db2:0)</span>
<span class="hljs-comment">// outPoint: TransactionOutPoint = TransactionOutPoint(d70478be6f987ff4e8381f094e4cd27563eab14ab86991b94f8cee1c0834f369: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(72abc2769c3cafa3ac70210c4dd9cc70a00c6a4d9fd75b7b2d36356a56e82db2:0),EmptyScriptSignature,UInt32Impl(0))</span>
<span class="hljs-comment">// input: TransactionInput = TransactionInputImpl(TransactionOutPoint(d70478be6f987ff4e8381f094e4cd27563eab14ab86991b94f8cee1c0834f369: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(72abc2769c3cafa3ac70210c4dd9cc70a00c6a4d9fd75b7b2d36356a56e82db2:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(922a18174c8f9ef77b1691fe9ff8035e5ac0db29))),UInt32Impl(0))</span>
<span class="hljs-comment">// builderResult: RawTxBuilderResult = RawTxBuilderResult(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(d70478be6f987ff4e8381f094e4cd27563eab14ab86991b94f8cee1c0834f369:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(cbdcf3e6150bec3018484f55ccc989c3da658463))),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(72abc2769c3cafa3ac70210c4dd9cc70a00c6a4d9fd75b7b2d36356a56e82db2:0),10000 sats,ECPublicKey(02751bde121b9c75e2e3bcd7ec8520472554605af20f98e5e1438d11db61135572))</span>
<span class="hljs-comment">// inputInfo: P2PKHInputInfo = P2PKHInputInfo(TransactionOutPoint(d70478be6f987ff4e8381f094e4cd27563eab14ab86991b94f8cee1c0834f369:0),10000 sats,ECPublicKey(021c7836edf0a81981a4159b9cc141ff765a9be5a9f91587040657ec7e1f982ac6))</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(ECPrivateKey)</span>
<span class="hljs-keyword">val</span> changeSPK = <span class="hljs-type">P2PKHScriptPubKey</span>(pubKey = changePrivKey.publicKey)
<span class="hljs-comment">// changeSPK: P2PKHScriptPubKey = pkh(9dc54ebf66d7dad3e48bd93ebd8004690771fc2d)</span>
<span class="hljs-comment">// changeSPK: P2PKHScriptPubKey = pkh(334b79cd2db7d12dd2e99e22f8b7c77cb80f9e48)</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(72abc2769c3cafa3ac70210c4dd9cc70a00c6a4d9fd75b7b2d36356a56e82db2:0),10000 sats,ECPublicKey(02751bde121b9c75e2e3bcd7ec8520472554605af20f98e5e1438d11db61135572))),1 sats/byte,pkh(9dc54ebf66d7dad3e48bd93ebd8004690771fc2d))</span>
<span class="hljs-comment">// finalizer: StandardNonInteractiveFinalizer = StandardNonInteractiveFinalizer(Vector(P2PKHInputInfo(TransactionOutPoint(d70478be6f987ff4e8381f094e4cd27563eab14ab86991b94f8cee1c0834f369:0),10000 sats,ECPublicKey(021c7836edf0a81981a4159b9cc141ff765a9be5a9f91587040657ec7e1f982ac6))),1 sats/byte,pkh(334b79cd2db7d12dd2e99e22f8b7c77cb80f9e48))</span>
<span class="hljs-comment">// We can now finalize the tx builder result from earlier with this finalizer</span>
<span class="hljs-keyword">val</span> unsignedTx: <span class="hljs-type">Transaction</span> = finalizer.buildTx(builderResult)
<span class="hljs-comment">// unsignedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(72abc2769c3cafa3ac70210c4dd9cc70a00c6a4d9fd75b7b2d36356a56e82db2:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(922a18174c8f9ef77b1691fe9ff8035e5ac0db29)), TransactionOutput(4775 sats,pkh(9dc54ebf66d7dad3e48bd93ebd8004690771fc2d))),UInt32Impl(0))</span>
<span class="hljs-comment">// unsignedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(d70478be6f987ff4e8381f094e4cd27563eab14ab86991b94f8cee1c0834f369:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(cbdcf3e6150bec3018484f55ccc989c3da658463)), TransactionOutput(4775 sats,pkh(334b79cd2db7d12dd2e99e22f8b7c77cb80f9e48))),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(72abc2769c3cafa3ac70210c4dd9cc70a00c6a4d9fd75b7b2d36356a56e82db2:0),10000 sats,ECPublicKey(02751bde121b9c75e2e3bcd7ec8520472554605af20f98e5e1438d11db61135572)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(42ee82f87b391aacf86700c16ac379b54df4b2a9))),UInt32Impl(0)),Vector(Masked(ECPrivateKey)),SIGHASH_ALL(Int32Impl(1)))</span>
<span class="hljs-comment">// utxoInfo: ScriptSignatureParams[P2PKHInputInfo] = ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(d70478be6f987ff4e8381f094e4cd27563eab14ab86991b94f8cee1c0834f369:0),10000 sats,ECPublicKey(021c7836edf0a81981a4159b9cc141ff765a9be5a9f91587040657ec7e1f982ac6)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(836179f10199ef52e8c05c10acc1de3553347d30))),UInt32Impl(0)),Vector(Masked(ECPrivateKey)),SIGHASH_ALL(Int32Impl(1)))</span>
<span class="hljs-comment">// all of the UTXO spending information, since we only have</span>
<span class="hljs-comment">// 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(72abc2769c3cafa3ac70210c4dd9cc70a00c6a4d9fd75b7b2d36356a56e82db2:0),10000 sats,ECPublicKey(02751bde121b9c75e2e3bcd7ec8520472554605af20f98e5e1438d11db61135572)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(42ee82f87b391aacf86700c16ac379b54df4b2a9))),UInt32Impl(0)),Vector(Masked(ECPrivateKey)),SIGHASH_ALL(Int32Impl(1))))</span>
<span class="hljs-comment">// utxoInfos: Vector[ScriptSignatureParams[InputInfo]] = Vector(ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(d70478be6f987ff4e8381f094e4cd27563eab14ab86991b94f8cee1c0834f369:0),10000 sats,ECPublicKey(021c7836edf0a81981a4159b9cc141ff765a9be5a9f91587040657ec7e1f982ac6)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(836179f10199ef52e8c05c10acc1de3553347d30))),UInt32Impl(0)),Vector(Masked(ECPrivateKey)),SIGHASH_ALL(Int32Impl(1))))</span>
<span class="hljs-comment">// Yay! Now we use the RawTxSigner object to sign the tx.</span>
<span class="hljs-comment">// The 'sign' method is going produce a validly signed transaction</span>
@ -197,7 +197,7 @@ builder += input
utxoInfos = utxoInfos,
expectedFeeRate = feeRate
)
<span class="hljs-comment">// signedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(72abc2769c3cafa3ac70210c4dd9cc70a00c6a4d9fd75b7b2d36356a56e82db2:0),P2PKHScriptSignature(ECPublicKeyBytes(ByteVector(33 bytes, 0x02751bde121b9c75e2e3bcd7ec8520472554605af20f98e5e1438d11db61135572)), ECDigitalSignature(304402201182e57b0a8b3d3fd3a5b552e2d6c09ef3c99ff3d65ca0867b224fe73c492a51022009e464c5f72f0fdb4d1edf9775fffe65e725c1bc5db430cbd08f978f4f32af4f01)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(922a18174c8f9ef77b1691fe9ff8035e5ac0db29)), TransactionOutput(4775 sats,pkh(9dc54ebf66d7dad3e48bd93ebd8004690771fc2d))),UInt32Impl(0))</span>
<span class="hljs-comment">// signedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(d70478be6f987ff4e8381f094e4cd27563eab14ab86991b94f8cee1c0834f369:0),P2PKHScriptSignature(ECPublicKeyBytes(ByteVector(33 bytes, 0x021c7836edf0a81981a4159b9cc141ff765a9be5a9f91587040657ec7e1f982ac6)), ECDigitalSignature(30440220473cebbc192fc3ec77cb4bd18bdf264724764d9ba6450fe72bd342d83caa4c620220702f7620a299ff816b6e79ec535f9d4d62adc4468cef4756843525330e92a64801)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(cbdcf3e6150bec3018484f55ccc989c3da658463)), TransactionOutput(4775 sats,pkh(334b79cd2db7d12dd2e99e22f8b7c77cb80f9e48))),UInt32Impl(0))</span>
</code></pre>
<pre><code class="hljs css language-scala">signedTx.inputs.length
<span class="hljs-comment">// res2: Int = 1</span>
@ -207,7 +207,7 @@ signedTx.outputs.length
<span class="hljs-comment">//remember, you can call .hex on any bitcoin-s data structure to get the hex representation!</span>
signedTx.hex
<span class="hljs-comment">// res4: String = 0200000001b22de8566a35362d7b5bd79f4d6a0ca070ccd94d0c2170aca3af3c9c76c2ab72000000006a47304402201182e57b0a8b3d3fd3a5b552e2d6c09ef3c99ff3d65ca0867b224fe73c492a51022009e464c5f72f0fdb4d1edf9775fffe65e725c1bc5db430cbd08f978f4f32af4f012102751bde121b9c75e2e3bcd7ec8520472554605af20f98e5e1438d11db61135572000000000288130000000000001976a914922a18174c8f9ef77b1691fe9ff8035e5ac0db2988aca7120000000000001976a9149dc54ebf66d7dad3e48bd93ebd8004690771fc2d88ac00000000</span>
<span class="hljs-comment">// res4: String = 020000000169f334081cee8c4fb99169b84ab1ea6375d24c4e091f38e8f47f986fbe7804d7000000006a4730440220473cebbc192fc3ec77cb4bd18bdf264724764d9ba6450fe72bd342d83caa4c620220702f7620a299ff816b6e79ec535f9d4d62adc4468cef4756843525330e92a6480121021c7836edf0a81981a4159b9cc141ff765a9be5a9f91587040657ec7e1f982ac6000000000288130000000000001976a914cbdcf3e6150bec3018484f55ccc989c3da65846388aca7120000000000001976a914334b79cd2db7d12dd2e99e22f8b7c77cb80f9e4888ac00000000</span>
</code></pre>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/next/core/dlc"><span class="arrow-prev">← </span><span>Discreet Log Contract Data Structures</span></a><a class="docs-next button" href="/docs/next/core/lightning-network"><span>Lightning Network Data Types</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/favicon.ico" alt="bitcoin-s" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/getting-started">Getting Started</a><a href="/docs/en/core/core-intro">Guides</a><a href="/api/org/bitcoins">API Reference</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="https://join.slack.com/t/suredbits/shared_invite/zt-eavycu0x-WQL7XOakzQo8tAy7jHHZUw" target="_blank" rel="noreferrer noopener">Slack</a><a href="https://gitter.im/bitcoin-s-core/">Gitter chat</a></div><div><h5>More</h5><a href="https://github.com/bitcoin-s/bitcoin-s">GitHub</a><a class="github-button" href="https://github.com/bitcoin-s/bitcoin-s" data-icon="octicon-star" data-count-href="/bitcoin-s/bitcoin-s-core/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2021 Suredbits &amp; the bitcoin-s developers</section></footer></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script><script>
document.addEventListener('keyup', function(e) {

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

@ -96,13 +96,13 @@
<span class="hljs-comment">// extPrivKey: ExtPrivateKey = Masked(ExtPrivateKeyImpl)</span>
extPrivKey.sign(<span class="hljs-type">DoubleSha256Digest</span>.empty.bytes)
<span class="hljs-comment">// res0: ECDigitalSignature = ECDigitalSignature(3044022073d12b4467d0e2263db372d0e60352557980da8cbdbf39a885ca195fca774180022014dda7aebcb9b142cf74b996539a037c3710aa890b61248bdc57a9987dc87d3e)</span>
<span class="hljs-comment">// res0: ECDigitalSignature = ECDigitalSignature(3044022007c176d29f36391c4c50ce7494ca1be2a92baa9ab814eec57a600fbc357a52e3022079827b2a6738e4c10df82f7672e517b721fee7fac12662d8ccd8beae342ff621)</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(3045022100c303691c9942d7437b076329316f2bd2d06e4f66534e8a7e3cac93157294a5e902207aa5baf083cba2d9c10f87e8e55219414ba28e37eb1c2c3c60cfd6038fd3c915)</span>
<span class="hljs-comment">// res1: ECDigitalSignature = ECDigitalSignature(30450221009758b50b84a3213b15585f75eb3b49125fe866b107d5f6a631684862837c04a9022020541d94c8d75920e790723dfe45483766901297d7b57268ab3d85826111e85d)</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(3044022073d12b4467d0e2263db372d0e60352557980da8cbdbf39a885ca195fca774180022014dda7aebcb9b142cf74b996539a037c3710aa890b61248bdc57a9987dc87d3e)</span>
<span class="hljs-comment">// res0: ECDigitalSignature = ECDigitalSignature(3044022007c176d29f36391c4c50ce7494ca1be2a92baa9ab814eec57a600fbc357a52e3022079827b2a6738e4c10df82f7672e517b721fee7fac12662d8ccd8beae342ff621)</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(3045022100c303691c9942d7437b076329316f2bd2d06e4f66534e8a7e3cac93157294a5e902207aa5baf083cba2d9c10f87e8e55219414ba28e37eb1c2c3c60cfd6038fd3c915)</span>
<span class="hljs-comment">// res1: ECDigitalSignature = ECDigitalSignature(30450221009758b50b84a3213b15585f75eb3b49125fe866b107d5f6a631684862837c04a9022020541d94c8d75920e790723dfe45483766901297d7b57268ab3d85826111e85d)</span>
</code></pre>
<p>With <code>ExtSign</code>, you can use <code>ExtPrivateKey</code> to sign transactions inside of <code>TxBuilder</code> since <code>UTXOSpendingInfo</code> takes in <code>Sign</code> as a parameter.</p>
<p>You can also provide a <code>path</code> to use to derive a child <code>ExtPrivateKey</code>, and then sign with that child private key</p>

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

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

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

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

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

@ -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, 0xae6512a3ccc8e6a4c9dbc372f0d3bc41c984878694f6d38096ba58ca4ec49702)</span>
<span class="hljs-comment">// entropy: scodec.bits.BitVector = BitVector(256 bits, 0xadd49b4f4ea006f2ed080c79311606acbcef5280458c3c7a5f0a2b10fc838fde)</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(purpose, chuckle, pottery, office, mobile, fame, cherry, journey, indicate, make, upper, logic, obscure, duck, bottom, paddle, squeeze, again, purse, ranch, pilot, girl, foster, expand)</span>
<span class="hljs-comment">// Vector(punch, pill, stable, outer, about, just, reflect, account, junior, master, like, floor, solve, power, absurd, ranch, detect, spray, secret, file, average, dove, disorder, sound)</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 'key-manager-example` that will</span>
<span class="hljs-comment">//have a file in it called "encrypted-bitcoin-s-seed.json"</span>
<span class="hljs-keyword">val</span> seedPath = <span class="hljs-type">Files</span>.createTempDirectory(<span class="hljs-string">"key-manager-example"</span>).resolve(<span class="hljs-type">WalletStorage</span>.<span class="hljs-type">ENCRYPTED_SEED_FILE_NAME</span>)
<span class="hljs-comment">// seedPath: Path = /tmp/key-manager-example13145814433431683594/encrypted-bitcoin-s-seed.json</span>
<span class="hljs-comment">// seedPath: Path = /tmp/key-manager-example15831941522152070073/encrypted-bitcoin-s-seed.json</span>
<span class="hljs-comment">//let's create a native segwit key manager</span>
<span class="hljs-keyword">val</span> purpose = <span class="hljs-type">HDPurposes</span>.<span class="hljs-type">SegWit</span>
@ -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-example13145814433431683594/encrypted-bitcoin-s-seed.json,m/84',RegTest)</span>
<span class="hljs-comment">// kmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example15831941522152070073/encrypted-bitcoin-s-seed.json,m/84',RegTest)</span>
<span class="hljs-keyword">val</span> aesPasswordOpt = <span class="hljs-type">Some</span>(<span class="hljs-type">AesPassword</span>.fromString(<span class="hljs-string">"password"</span>))
<span class="hljs-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@7f4511c8)</span>
<span class="hljs-comment">// km: Either[KeyManagerInitializeError, BIP39KeyManager] = Right(org.bitcoins.keymanager.bip39.BIP39KeyManager@3c25cf60)</span>
<span class="hljs-keyword">val</span> rootXPub = km.right.get.getRootXPub
<span class="hljs-comment">// rootXPub: ExtPublicKey = vpub5SLqN2bLY4WeY4VJnRvYghtrwDNbUG4LnfGB3vBftDrxAxqexXxQGUFrFcBySzSCfga9ALqGLd1hTNyNJBHnD5GvHbT2ZQF3ezjeUs4NDCY</span>
<span class="hljs-comment">// rootXPub: ExtPublicKey = vpub5SLqN2bLY4WeaSChibRWDHVwb8ADNjV9Y6F6eeuBaHPHutZjezLpHWsxwAz2KMpSYnBMTQF4WCPWrz2tbYZQjA43pkYgmJt1ST4TUArAz3u</span>
println(rootXPub)
<span class="hljs-comment">// vpub5SLqN2bLY4WeY4VJnRvYghtrwDNbUG4LnfGB3vBftDrxAxqexXxQGUFrFcBySzSCfga9ALqGLd1hTNyNJBHnD5GvHbT2ZQF3ezjeUs4NDCY</span>
<span class="hljs-comment">// vpub5SLqN2bLY4WeaSChibRWDHVwb8ADNjV9Y6F6eeuBaHPHutZjezLpHWsxwAz2KMpSYnBMTQF4WCPWrz2tbYZQjA43pkYgmJt1ST4TUArAz3u</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'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-example13145814433431683594/encrypted-bitcoin-s-seed.json,m/84',MainNet)</span>
<span class="hljs-comment">// mainnetKmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example15831941522152070073/encrypted-bitcoin-s-seed.json,m/84',MainNet)</span>
<span class="hljs-comment">//we do not need to all `initializeWithMnemonic()` again as we have saved the seed to dis</span>
<span class="hljs-keyword">val</span> mainnetKeyManager = <span class="hljs-type">BIP39KeyManager</span>.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@10500f2e</span>
<span class="hljs-comment">// mainnetKeyManager: BIP39KeyManager = org.bitcoins.keymanager.bip39.BIP39KeyManager@19887edd</span>
<span class="hljs-keyword">val</span> mainnetXpub = mainnetKeyManager.getRootXPub
<span class="hljs-comment">// mainnetXpub: ExtPublicKey = zpub6jftahH18ngZwFFn7s53X4Gsd5xPEk2LT7M4BVmDQFNUPN6ZyAcekitQLS2KSd3tJF3NAFDWBGRtzXRdAxwqQ21KkxEiu3WzjtzE3DjvfSw</span>
<span class="hljs-comment">// mainnetXpub: ExtPublicKey = zpub6jftahH18ngZycyB42a13dsxGzk19DT9CYKynEUj6Jtp8Hpefd14mmWX1zpNJzS8BLeaTJdJLqoiQ8V9ULDTv6nTJ7LP6x9xXMK32TPStN6</span>
println(mainnetXpub)
<span class="hljs-comment">// zpub6jftahH18ngZwFFn7s53X4Gsd5xPEk2LT7M4BVmDQFNUPN6ZyAcekitQLS2KSd3tJF3NAFDWBGRtzXRdAxwqQ21KkxEiu3WzjtzE3DjvfSw</span>
<span class="hljs-comment">// zpub6jftahH18ngZycyB42a13dsxGzk19DT9CYKynEUj6Jtp8Hpefd14mmWX1zpNJzS8BLeaTJdJLqoiQ8V9ULDTv6nTJ7LP6x9xXMK32TPStN6</span>
</code></pre>
<p>Which gives us something that looks like this</p>
<p><code>zpub6jftahH18ngZw98KGjRo5XcxeKTQ2eztsvskb1dC9XF5TLimQquTs6Ry7nBBA425D9joXmfgJJCexmJ1u2SELJZJfRi95gcnXadLpZzYb5c</code></p>

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

@ -77,14 +77,14 @@
<span class="hljs-comment">//get 256 bits of random entropy</span>
<span class="hljs-keyword">val</span> entropy = <span class="hljs-type">MnemonicCode</span>.getEntropy256Bits
<span class="hljs-comment">// entropy: scodec.bits.BitVector = BitVector(256 bits, 0xae6512a3ccc8e6a4c9dbc372f0d3bc41c984878694f6d38096ba58ca4ec49702)</span>
<span class="hljs-comment">// entropy: scodec.bits.BitVector = BitVector(256 bits, 0xadd49b4f4ea006f2ed080c79311606acbcef5280458c3c7a5f0a2b10fc838fde)</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(purpose, chuckle, pottery, office, mobile, fame, cherry, journey, indicate, make, upper, logic, obscure, duck, bottom, paddle, squeeze, again, purse, ranch, pilot, girl, foster, expand)</span>
<span class="hljs-comment">// Vector(punch, pill, stable, outer, about, just, reflect, account, junior, master, like, floor, solve, power, absurd, ranch, detect, spray, secret, file, average, dove, disorder, sound)</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 'key-manager-example` that will</span>
<span class="hljs-comment">//have a file in it called "encrypted-bitcoin-s-seed.json"</span>
<span class="hljs-keyword">val</span> seedPath = <span class="hljs-type">Files</span>.createTempDirectory(<span class="hljs-string">"key-manager-example"</span>).resolve(<span class="hljs-type">WalletStorage</span>.<span class="hljs-type">ENCRYPTED_SEED_FILE_NAME</span>)
<span class="hljs-comment">// seedPath: Path = /tmp/key-manager-example13145814433431683594/encrypted-bitcoin-s-seed.json</span>
<span class="hljs-comment">// seedPath: Path = /tmp/key-manager-example15831941522152070073/encrypted-bitcoin-s-seed.json</span>
<span class="hljs-comment">//let's create a native segwit key manager</span>
<span class="hljs-keyword">val</span> purpose = <span class="hljs-type">HDPurposes</span>.<span class="hljs-type">SegWit</span>
@ -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-example13145814433431683594/encrypted-bitcoin-s-seed.json,m/84',RegTest)</span>
<span class="hljs-comment">// kmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example15831941522152070073/encrypted-bitcoin-s-seed.json,m/84',RegTest)</span>
<span class="hljs-keyword">val</span> aesPasswordOpt = <span class="hljs-type">Some</span>(<span class="hljs-type">AesPassword</span>.fromString(<span class="hljs-string">"password"</span>))
<span class="hljs-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@7f4511c8)</span>
<span class="hljs-comment">// km: Either[KeyManagerInitializeError, BIP39KeyManager] = Right(org.bitcoins.keymanager.bip39.BIP39KeyManager@3c25cf60)</span>
<span class="hljs-keyword">val</span> rootXPub = km.right.get.getRootXPub
<span class="hljs-comment">// rootXPub: ExtPublicKey = vpub5SLqN2bLY4WeY4VJnRvYghtrwDNbUG4LnfGB3vBftDrxAxqexXxQGUFrFcBySzSCfga9ALqGLd1hTNyNJBHnD5GvHbT2ZQF3ezjeUs4NDCY</span>
<span class="hljs-comment">// rootXPub: ExtPublicKey = vpub5SLqN2bLY4WeaSChibRWDHVwb8ADNjV9Y6F6eeuBaHPHutZjezLpHWsxwAz2KMpSYnBMTQF4WCPWrz2tbYZQjA43pkYgmJt1ST4TUArAz3u</span>
println(rootXPub)
<span class="hljs-comment">// vpub5SLqN2bLY4WeY4VJnRvYghtrwDNbUG4LnfGB3vBftDrxAxqexXxQGUFrFcBySzSCfga9ALqGLd1hTNyNJBHnD5GvHbT2ZQF3ezjeUs4NDCY</span>
<span class="hljs-comment">// vpub5SLqN2bLY4WeaSChibRWDHVwb8ADNjV9Y6F6eeuBaHPHutZjezLpHWsxwAz2KMpSYnBMTQF4WCPWrz2tbYZQjA43pkYgmJt1ST4TUArAz3u</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'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-example13145814433431683594/encrypted-bitcoin-s-seed.json,m/84',MainNet)</span>
<span class="hljs-comment">// mainnetKmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example15831941522152070073/encrypted-bitcoin-s-seed.json,m/84',MainNet)</span>
<span class="hljs-comment">//we do not need to all `initializeWithMnemonic()` again as we have saved the seed to dis</span>
<span class="hljs-keyword">val</span> mainnetKeyManager = <span class="hljs-type">BIP39KeyManager</span>.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@10500f2e</span>
<span class="hljs-comment">// mainnetKeyManager: BIP39KeyManager = org.bitcoins.keymanager.bip39.BIP39KeyManager@19887edd</span>
<span class="hljs-keyword">val</span> mainnetXpub = mainnetKeyManager.getRootXPub
<span class="hljs-comment">// mainnetXpub: ExtPublicKey = zpub6jftahH18ngZwFFn7s53X4Gsd5xPEk2LT7M4BVmDQFNUPN6ZyAcekitQLS2KSd3tJF3NAFDWBGRtzXRdAxwqQ21KkxEiu3WzjtzE3DjvfSw</span>
<span class="hljs-comment">// mainnetXpub: ExtPublicKey = zpub6jftahH18ngZycyB42a13dsxGzk19DT9CYKynEUj6Jtp8Hpefd14mmWX1zpNJzS8BLeaTJdJLqoiQ8V9ULDTv6nTJ7LP6x9xXMK32TPStN6</span>
println(mainnetXpub)
<span class="hljs-comment">// zpub6jftahH18ngZwFFn7s53X4Gsd5xPEk2LT7M4BVmDQFNUPN6ZyAcekitQLS2KSd3tJF3NAFDWBGRtzXRdAxwqQ21KkxEiu3WzjtzE3DjvfSw</span>
<span class="hljs-comment">// zpub6jftahH18ngZycyB42a13dsxGzk19DT9CYKynEUj6Jtp8Hpefd14mmWX1zpNJzS8BLeaTJdJLqoiQ8V9ULDTv6nTJ7LP6x9xXMK32TPStN6</span>
</code></pre>
<p>Which gives us something that looks like this</p>
<p><code>zpub6jftahH18ngZw98KGjRo5XcxeKTQ2eztsvskb1dC9XF5TLimQquTs6Ry7nBBA425D9joXmfgJJCexmJ1u2SELJZJfRi95gcnXadLpZzYb5c</code></p>

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

@ -115,13 +115,13 @@ println(<span class="hljs-string">s"Verified with NativeSecp256k1 again=<span cl
<span class="hljs-comment">// privKey: ECPrivateKey = Masked(ECPrivateKey)</span>
<span class="hljs-comment">// calls bouncy castle indirectly via CryptoContext</span>
<span class="hljs-keyword">val</span> publicKey = privKey.publicKey
<span class="hljs-comment">// publicKey: ECPublicKey = ECPublicKey(0266a38ff9c87bdd159d9148061061d7cd744a47eb11ced7a176230e3a79b8e35c)</span>
<span class="hljs-comment">// publicKey: ECPublicKey = ECPublicKey(03a42d793951e1dd19e2f8cb6fe7205e38681a2ad2b8ee5eeb47df01b022f65363)</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-comment">// calls bouncy castle indirectly via CryptoContext</span>
<span class="hljs-keyword">val</span> signature = privKey.sign(dataToSign.bytes)
<span class="hljs-comment">// signature: ECDigitalSignature = ECDigitalSignature(304402201b6cfeb52f8782265c7698c2ba13d0e712d4fb9234214b2b5cc4faee15c7d9ef022033f2ead48e5d5f3d4eaf671e6f14694f33cb91ed53359dc449372faf0b8b32e0)</span>
<span class="hljs-comment">// signature: ECDigitalSignature = ECDigitalSignature(304402205a1bda508da6caf90564e21611673d0b54ae36df0903df9ac4d24460ddd08e980220675837c7ff753f8f4cbcd560188d13efdf8b1c993cfb2501cff5e0dcbe38747b)</span>
<span class="hljs-comment">// calls bouncy castle indirectly via CryptoContext</span>
<span class="hljs-keyword">val</span> verified = publicKey.verify(dataToSign.bytes, signature)

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

@ -115,13 +115,13 @@ println(<span class="hljs-string">s"Verified with NativeSecp256k1 again=<span cl
<span class="hljs-comment">// privKey: ECPrivateKey = Masked(ECPrivateKey)</span>
<span class="hljs-comment">// calls bouncy castle indirectly via CryptoContext</span>
<span class="hljs-keyword">val</span> publicKey = privKey.publicKey
<span class="hljs-comment">// publicKey: ECPublicKey = ECPublicKey(0266a38ff9c87bdd159d9148061061d7cd744a47eb11ced7a176230e3a79b8e35c)</span>
<span class="hljs-comment">// publicKey: ECPublicKey = ECPublicKey(03a42d793951e1dd19e2f8cb6fe7205e38681a2ad2b8ee5eeb47df01b022f65363)</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-comment">// calls bouncy castle indirectly via CryptoContext</span>
<span class="hljs-keyword">val</span> signature = privKey.sign(dataToSign.bytes)
<span class="hljs-comment">// signature: ECDigitalSignature = ECDigitalSignature(304402201b6cfeb52f8782265c7698c2ba13d0e712d4fb9234214b2b5cc4faee15c7d9ef022033f2ead48e5d5f3d4eaf671e6f14694f33cb91ed53359dc449372faf0b8b32e0)</span>
<span class="hljs-comment">// signature: ECDigitalSignature = ECDigitalSignature(304402205a1bda508da6caf90564e21611673d0b54ae36df0903df9ac4d24460ddd08e980220675837c7ff753f8f4cbcd560188d13efdf8b1c993cfb2501cff5e0dcbe38747b)</span>
<span class="hljs-comment">// calls bouncy castle indirectly via CryptoContext</span>
<span class="hljs-keyword">val</span> verified = publicKey.verify(dataToSign.bytes, signature)

4
docs/next/wallet/wallet-election-example.html
View file

@ -300,7 +300,7 @@ You can find logs at <code>~/.bitcoin-s/{mainnet,testnet3,regtest}/bitcoin-s.log
</code></pre>
<p>You can find things like the <code>fundingTxId</code>, <code>state</code>, <code>dlcId</code>, and <code>contractId</code> from this RPC call. Since we just
broadcast the funding transaction, the state of the DLC is <code>Broadcast</code>.</p>
<h4><a class="anchor" aria-hidden="true" id="settling-the-dlc"></a><a href="#settling-the-dlc" 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>Settling the DLC</h4>
<h3><a class="anchor" aria-hidden="true" id="settling-the-dlc"></a><a href="#settling-the-dlc" 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>Settling the DLC</h3>
<p>Once the oracle has broadcast their attestations, a user can close out the DLC.
In this case of this example, you can find the oracle
attestations <a href="https://test.oracle.suredbits.com/announcement/8863cd80e1d37f668e27b84cbfed48541d671b4fed1462b86d547e7f13b5a9e4">on the oracle explorer</a></p>
@ -313,7 +313,7 @@ Our contract id is <code>a995aeca167f1c28c2b936e5bb4d87cba061dd9147217501c3523e3
</code></pre>
<p>The thing returned is the CET's txid.</p>
<p>You've now settled your DLC :tada: :tada:</p>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/next/wallet/backups"><span class="arrow-prev">← </span><span>Wallet Backups</span></a><a class="docs-next button" href="/docs/next/tor/tor"><span>Tor Setup</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#requirements-for-example">Requirements for example</a></li><li><a href="#us-2020-election">US 2020 election</a><ul class="toc-headings"><li><a href="#setting-up-the-election-bet">Setting up the election bet</a></li><li><a href="#building-funding-txdlcs-with-your-counterparty">Building funding tx/dlcs with your counterparty</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/favicon.ico" alt="bitcoin-s" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/getting-started">Getting Started</a><a href="/docs/en/core/core-intro">Guides</a><a href="/api/org/bitcoins">API Reference</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="https://join.slack.com/t/suredbits/shared_invite/zt-eavycu0x-WQL7XOakzQo8tAy7jHHZUw" target="_blank" rel="noreferrer noopener">Slack</a><a href="https://gitter.im/bitcoin-s-core/">Gitter chat</a></div><div><h5>More</h5><a href="https://github.com/bitcoin-s/bitcoin-s">GitHub</a><a class="github-button" href="https://github.com/bitcoin-s/bitcoin-s" data-icon="octicon-star" data-count-href="/bitcoin-s/bitcoin-s-core/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2021 Suredbits &amp; the bitcoin-s developers</section></footer></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script><script>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/next/wallet/backups"><span class="arrow-prev">← </span><span>Wallet Backups</span></a><a class="docs-next button" href="/docs/next/tor/tor"><span>Tor Setup</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#requirements-for-example">Requirements for example</a></li><li><a href="#us-2020-election">US 2020 election</a><ul class="toc-headings"><li><a href="#setting-up-the-election-bet">Setting up the election bet</a></li><li><a href="#building-funding-txdlcs-with-your-counterparty">Building funding tx/dlcs with your counterparty</a></li><li><a href="#settling-the-dlc">Settling the DLC</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/favicon.ico" alt="bitcoin-s" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/getting-started">Getting Started</a><a href="/docs/en/core/core-intro">Guides</a><a href="/api/org/bitcoins">API Reference</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="https://join.slack.com/t/suredbits/shared_invite/zt-eavycu0x-WQL7XOakzQo8tAy7jHHZUw" target="_blank" rel="noreferrer noopener">Slack</a><a href="https://gitter.im/bitcoin-s-core/">Gitter chat</a></div><div><h5>More</h5><a href="https://github.com/bitcoin-s/bitcoin-s">GitHub</a><a class="github-button" href="https://github.com/bitcoin-s/bitcoin-s" data-icon="octicon-star" data-count-href="/bitcoin-s/bitcoin-s-core/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2021 Suredbits &amp; the bitcoin-s developers</section></footer></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script><script>
document.addEventListener('keyup', function(e) {
if (e.target !== document.body) {
return;

4
docs/next/wallet/wallet-election-example/index.html
View file

@ -300,7 +300,7 @@ You can find logs at <code>~/.bitcoin-s/{mainnet,testnet3,regtest}/bitcoin-s.log
</code></pre>
<p>You can find things like the <code>fundingTxId</code>, <code>state</code>, <code>dlcId</code>, and <code>contractId</code> from this RPC call. Since we just
broadcast the funding transaction, the state of the DLC is <code>Broadcast</code>.</p>
<h4><a class="anchor" aria-hidden="true" id="settling-the-dlc"></a><a href="#settling-the-dlc" 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>Settling the DLC</h4>
<h3><a class="anchor" aria-hidden="true" id="settling-the-dlc"></a><a href="#settling-the-dlc" 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>Settling the DLC</h3>
<p>Once the oracle has broadcast their attestations, a user can close out the DLC.
In this case of this example, you can find the oracle
attestations <a href="https://test.oracle.suredbits.com/announcement/8863cd80e1d37f668e27b84cbfed48541d671b4fed1462b86d547e7f13b5a9e4">on the oracle explorer</a></p>
@ -313,7 +313,7 @@ Our contract id is <code>a995aeca167f1c28c2b936e5bb4d87cba061dd9147217501c3523e3
</code></pre>
<p>The thing returned is the CET's txid.</p>
<p>You've now settled your DLC :tada: :tada:</p>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/next/wallet/backups"><span class="arrow-prev">← </span><span>Wallet Backups</span></a><a class="docs-next button" href="/docs/next/tor/tor"><span>Tor Setup</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#requirements-for-example">Requirements for example</a></li><li><a href="#us-2020-election">US 2020 election</a><ul class="toc-headings"><li><a href="#setting-up-the-election-bet">Setting up the election bet</a></li><li><a href="#building-funding-txdlcs-with-your-counterparty">Building funding tx/dlcs with your counterparty</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/favicon.ico" alt="bitcoin-s" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/getting-started">Getting Started</a><a href="/docs/en/core/core-intro">Guides</a><a href="/api/org/bitcoins">API Reference</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="https://join.slack.com/t/suredbits/shared_invite/zt-eavycu0x-WQL7XOakzQo8tAy7jHHZUw" target="_blank" rel="noreferrer noopener">Slack</a><a href="https://gitter.im/bitcoin-s-core/">Gitter chat</a></div><div><h5>More</h5><a href="https://github.com/bitcoin-s/bitcoin-s">GitHub</a><a class="github-button" href="https://github.com/bitcoin-s/bitcoin-s" data-icon="octicon-star" data-count-href="/bitcoin-s/bitcoin-s-core/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2021 Suredbits &amp; the bitcoin-s developers</section></footer></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script><script>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/next/wallet/backups"><span class="arrow-prev">← </span><span>Wallet Backups</span></a><a class="docs-next button" href="/docs/next/tor/tor"><span>Tor Setup</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#requirements-for-example">Requirements for example</a></li><li><a href="#us-2020-election">US 2020 election</a><ul class="toc-headings"><li><a href="#setting-up-the-election-bet">Setting up the election bet</a></li><li><a href="#building-funding-txdlcs-with-your-counterparty">Building funding tx/dlcs with your counterparty</a></li><li><a href="#settling-the-dlc">Settling the DLC</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/favicon.ico" alt="bitcoin-s" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/getting-started">Getting Started</a><a href="/docs/en/core/core-intro">Guides</a><a href="/api/org/bitcoins">API Reference</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="https://join.slack.com/t/suredbits/shared_invite/zt-eavycu0x-WQL7XOakzQo8tAy7jHHZUw" target="_blank" rel="noreferrer noopener">Slack</a><a href="https://gitter.im/bitcoin-s-core/">Gitter chat</a></div><div><h5>More</h5><a href="https://github.com/bitcoin-s/bitcoin-s">GitHub</a><a class="github-button" href="https://github.com/bitcoin-s/bitcoin-s" data-icon="octicon-star" data-count-href="/bitcoin-s/bitcoin-s-core/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2021 Suredbits &amp; the bitcoin-s developers</section></footer></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script><script>
document.addEventListener('keyup', function(e) {
if (e.target !== document.body) {
return;