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

Deploy website

Browse source 
Deploy website version based on 049411ccd6
This commit is contained in:
Docusaurus bot 2022-03-19 17:38:57 +00:00
parent 3eaac1ea11
commit e48ede5e73
20 changed files with 114 additions and 108 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(0398060e18c7b83aad99d5faaf00b67042e12a4975f220a2f6d63e9cb8a7e2ec5f)</span>
<span class="hljs-comment">// pubkey: org.bitcoins.crypto.ECPublicKey = ECPublicKey(03d444038eba3be167ec44607bf08783294dba2281edd0b684a223ee7e55649d37)</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 = tb1qlh5p8nxa3pwwnm5736mxch05yuqga24wzza0r6</span>
<span class="hljs-comment">// segwitAddress: Bech32Address = tb1q6z3zpac0t23kja7seaks0392jv5xry9r2z4nz2</span>
println(segwitAddress.toString)
<span class="hljs-comment">// tb1qlh5p8nxa3pwwnm5736mxch05yuqga24wzza0r6</span>
<span class="hljs-comment">// tb1q6z3zpac0t23kja7seaks0392jv5xry9r2z4nz2</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 = n4fVGbyApyfDNbuGhpcZYe5Y7MWK6fs2U8</span>
<span class="hljs-comment">// legacyAddress: P2PKHAddress = mzY74rnUnJPBd3qDm6FhkXoYPUHK8R8di3</span>
println(legacyAddress.toString)
<span class="hljs-comment">// n4fVGbyApyfDNbuGhpcZYe5Y7MWK6fs2U8</span>
<span class="hljs-comment">// mzY74rnUnJPBd3qDm6FhkXoYPUHK8R8di3</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 © 2022 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(0398060e18c7b83aad99d5faaf00b67042e12a4975f220a2f6d63e9cb8a7e2ec5f)</span>
<span class="hljs-comment">// pubkey: org.bitcoins.crypto.ECPublicKey = ECPublicKey(03d444038eba3be167ec44607bf08783294dba2281edd0b684a223ee7e55649d37)</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 = tb1qlh5p8nxa3pwwnm5736mxch05yuqga24wzza0r6</span>
<span class="hljs-comment">// segwitAddress: Bech32Address = tb1q6z3zpac0t23kja7seaks0392jv5xry9r2z4nz2</span>
println(segwitAddress.toString)
<span class="hljs-comment">// tb1qlh5p8nxa3pwwnm5736mxch05yuqga24wzza0r6</span>
<span class="hljs-comment">// tb1q6z3zpac0t23kja7seaks0392jv5xry9r2z4nz2</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 = n4fVGbyApyfDNbuGhpcZYe5Y7MWK6fs2U8</span>
<span class="hljs-comment">// legacyAddress: P2PKHAddress = mzY74rnUnJPBd3qDm6FhkXoYPUHK8R8di3</span>
println(legacyAddress.toString)
<span class="hljs-comment">// n4fVGbyApyfDNbuGhpcZYe5Y7MWK6fs2U8</span>
<span class="hljs-comment">// mzY74rnUnJPBd3qDm6FhkXoYPUHK8R8di3</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 © 2022 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, 0x72d0130569d06650bf008755d55b86b4a5f7a9289c44d18ad8304247bf0b8101)</span>
<span class="hljs-comment">// entropy: BitVector = BitVector(256 bits, 0x6252409978d9464c865602c9f51bfb1c72b56d88612ab3e6a818ae88027a1007)</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(index, letter, scout, squirrel, all, choose, winter, axis, fiction, print, ticket, harsh, garage, stand, pen, mass, spice, fine, army, loyal, know, magic, advice, develop) // the phrase the user should write down</span>
<span class="hljs-comment">// res0: Vector[String] = Vector(girl, must, chaos, vast, nerve, chaos, bone, scare, size, potato, yard, decline, clip, replace, canoe, census, recycle, crystal, alert, fringe, lens, dial, divorce, truly) // 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 = zpub6jftahH18ngZwpAMjYJ2YyEr5t8DasDWECSYBLv4V12v6Z2fHj8WSQyLZEsavTjsELwYdXRg3X9TDzmtH86t8Cnnn5f2DnkxVkiYo5Jqmok</span>
<span class="hljs-comment">// xpub: ExtPublicKey = zpub6jftahH18ngZybFvNnkaoB4HmkTiqrT5JN8n69KDmKR4UN53LzAiHciAViaHDBjiXF73raDXQMDbdvJuns9myxHRJNXPDKpAFf44s6uU8vJ</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 = zpub6qaMeZpLqz17QcLmf6dsGs47uMyEnfz4cmqwfBbhDcA786hmggAxBGuTotrvU9DVcgPU8RjZFXMMMfjhSaaaCa8YoV3wazeTNifUcY6rF8S</span>
<span class="hljs-comment">// accountXpub: ExtPublicKey = zpub6r4gJa8qq4bcwhUjRiUBF7M8M1qbUDQQtHtaM8FfpzjeTYWjiFWyQuR5EDPcgxYjaqMRJep1h6S68fnJUfy2u4NiN6aprE2amzDUYFy8WV2</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 = tb1qlnjhpr0e3s4sgt4jjpmwzrls2r0s6w7msfy69a</span>
<span class="hljs-comment">// firstAccountAddress: Bech32Address = tb1qa7jpustxwr4apd8smyx2w8e344f8tjql04gejw</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 = tb1qlnjhpr0e3s4sgt4jjpmwzrls2r0s6w7msfy69a</span>
<span class="hljs-comment">// res2: String = tb1qa7jpustxwr4apd8smyx2w8e344f8tjql04gejw</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, 0x72d0130569d06650bf008755d55b86b4a5f7a9289c44d18ad8304247bf0b8101)</span>
<span class="hljs-comment">// entropy: BitVector = BitVector(256 bits, 0x6252409978d9464c865602c9f51bfb1c72b56d88612ab3e6a818ae88027a1007)</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(index, letter, scout, squirrel, all, choose, winter, axis, fiction, print, ticket, harsh, garage, stand, pen, mass, spice, fine, army, loyal, know, magic, advice, develop) // the phrase the user should write down</span>
<span class="hljs-comment">// res0: Vector[String] = Vector(girl, must, chaos, vast, nerve, chaos, bone, scare, size, potato, yard, decline, clip, replace, canoe, census, recycle, crystal, alert, fringe, lens, dial, divorce, truly) // 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 = zpub6jftahH18ngZwpAMjYJ2YyEr5t8DasDWECSYBLv4V12v6Z2fHj8WSQyLZEsavTjsELwYdXRg3X9TDzmtH86t8Cnnn5f2DnkxVkiYo5Jqmok</span>
<span class="hljs-comment">// xpub: ExtPublicKey = zpub6jftahH18ngZybFvNnkaoB4HmkTiqrT5JN8n69KDmKR4UN53LzAiHciAViaHDBjiXF73raDXQMDbdvJuns9myxHRJNXPDKpAFf44s6uU8vJ</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 = zpub6qaMeZpLqz17QcLmf6dsGs47uMyEnfz4cmqwfBbhDcA786hmggAxBGuTotrvU9DVcgPU8RjZFXMMMfjhSaaaCa8YoV3wazeTNifUcY6rF8S</span>
<span class="hljs-comment">// accountXpub: ExtPublicKey = zpub6r4gJa8qq4bcwhUjRiUBF7M8M1qbUDQQtHtaM8FfpzjeTYWjiFWyQuR5EDPcgxYjaqMRJep1h6S68fnJUfy2u4NiN6aprE2amzDUYFy8WV2</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 = tb1qlnjhpr0e3s4sgt4jjpmwzrls2r0s6w7msfy69a</span>
<span class="hljs-comment">// firstAccountAddress: Bech32Address = tb1qa7jpustxwr4apd8smyx2w8e344f8tjql04gejw</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 = tb1qlnjhpr0e3s4sgt4jjpmwzrls2r0s6w7msfy69a</span>
<span class="hljs-comment">// res2: String = tb1qa7jpustxwr4apd8smyx2w8e344f8tjql04gejw</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@35e0d989[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@23f9df2c[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(035c1fa7873e6c43704270e8e89cb3b5ca7be32b356d8f96eae3d97bdc4f5f5d83)</span>
<span class="hljs-comment">// pubKey: ECPublicKey = ECPublicKey(0284f90b1fed90596696ad9572133f48a9e117162c10806beddcde1e264d37c35e)</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(7893de702c357afa915bb42a1d89e51012682fe6)</span>
<span class="hljs-comment">// creditingSpk: P2PKHScriptPubKey = pkh(39408fc14747562d8078930ed6ceca16d79db795)</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(7893de702c357afa915bb42a1d89e51012682fe6))</span>
<span class="hljs-comment">// utxo: TransactionOutput = TransactionOutput(10000 sats,pkh(39408fc14747562d8078930ed6ceca16d79db795))</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(c1e89a0bbb0ac7bb4d0acfd291c908dfd264b835)</span>
<span class="hljs-comment">// destinationSPK: P2PKHScriptPubKey = pkh(84730f03021c2ea8f3ed89e9acc6008e47eaa390)</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(c1e89a0bbb0ac7bb4d0acfd291c908dfd264b835)))</span>
<span class="hljs-comment">// destinations: Vector[TransactionOutput] = Vector(TransactionOutput(5000 sats,pkh(84730f03021c2ea8f3ed89e9acc6008e47eaa390)))</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(7893de702c357afa915bb42a1d89e51012682fe6))),UInt32Impl(0))</span>
<span class="hljs-comment">// creditingTx: BaseTransaction = BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(39408fc14747562d8078930ed6ceca16d79db795))),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(3fba6fe398eb28559a50c0952b69b5493a3b9aeea6c121ee9f3e2be10aaaf3f0:0)</span>
<span class="hljs-comment">// outPoint: TransactionOutPoint = TransactionOutPoint(893c1df16d3d42cabdf40cc662d49ea77280a90edd9ea3b4752a0cc34762d841: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(3fba6fe398eb28559a50c0952b69b5493a3b9aeea6c121ee9f3e2be10aaaf3f0:0),EmptyScriptSignature,UInt32Impl(0))</span>
<span class="hljs-comment">// input: TransactionInput = TransactionInputImpl(TransactionOutPoint(893c1df16d3d42cabdf40cc662d49ea77280a90edd9ea3b4752a0cc34762d841: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(3fba6fe398eb28559a50c0952b69b5493a3b9aeea6c121ee9f3e2be10aaaf3f0:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(c1e89a0bbb0ac7bb4d0acfd291c908dfd264b835))),UInt32Impl(0))</span>
<span class="hljs-comment">// builderResult: RawTxBuilderResult = RawTxBuilderResult(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(893c1df16d3d42cabdf40cc662d49ea77280a90edd9ea3b4752a0cc34762d841:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(84730f03021c2ea8f3ed89e9acc6008e47eaa390))),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(3fba6fe398eb28559a50c0952b69b5493a3b9aeea6c121ee9f3e2be10aaaf3f0:0),10000 sats,ECPublicKey(035c1fa7873e6c43704270e8e89cb3b5ca7be32b356d8f96eae3d97bdc4f5f5d83))</span>
<span class="hljs-comment">// inputInfo: P2PKHInputInfo = P2PKHInputInfo(TransactionOutPoint(893c1df16d3d42cabdf40cc662d49ea77280a90edd9ea3b4752a0cc34762d841:0),10000 sats,ECPublicKey(0284f90b1fed90596696ad9572133f48a9e117162c10806beddcde1e264d37c35e))</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(f9415e115bf0ef28f238f1cda8dcbf57d819aa4f)</span>
<span class="hljs-comment">// changeSPK: P2PKHScriptPubKey = pkh(25867f16132dea245b0f1814b21062e4302c6f8f)</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(3fba6fe398eb28559a50c0952b69b5493a3b9aeea6c121ee9f3e2be10aaaf3f0:0),10000 sats,ECPublicKey(035c1fa7873e6c43704270e8e89cb3b5ca7be32b356d8f96eae3d97bdc4f5f5d83))),1 sats/byte,pkh(f9415e115bf0ef28f238f1cda8dcbf57d819aa4f))</span>
<span class="hljs-comment">// finalizer: StandardNonInteractiveFinalizer = StandardNonInteractiveFinalizer(Vector(P2PKHInputInfo(TransactionOutPoint(893c1df16d3d42cabdf40cc662d49ea77280a90edd9ea3b4752a0cc34762d841:0),10000 sats,ECPublicKey(0284f90b1fed90596696ad9572133f48a9e117162c10806beddcde1e264d37c35e))),1 sats/byte,pkh(25867f16132dea245b0f1814b21062e4302c6f8f))</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(3fba6fe398eb28559a50c0952b69b5493a3b9aeea6c121ee9f3e2be10aaaf3f0:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(c1e89a0bbb0ac7bb4d0acfd291c908dfd264b835)), TransactionOutput(4775 sats,pkh(f9415e115bf0ef28f238f1cda8dcbf57d819aa4f))),UInt32Impl(0))</span>
<span class="hljs-comment">// unsignedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(893c1df16d3d42cabdf40cc662d49ea77280a90edd9ea3b4752a0cc34762d841:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(84730f03021c2ea8f3ed89e9acc6008e47eaa390)), TransactionOutput(4775 sats,pkh(25867f16132dea245b0f1814b21062e4302c6f8f))),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(3fba6fe398eb28559a50c0952b69b5493a3b9aeea6c121ee9f3e2be10aaaf3f0:0),10000 sats,ECPublicKey(035c1fa7873e6c43704270e8e89cb3b5ca7be32b356d8f96eae3d97bdc4f5f5d83)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(7893de702c357afa915bb42a1d89e51012682fe6))),UInt32Impl(0)),Vector(Masked(ECPrivateKey)),SIGHASH_ALL(Int32Impl(1)))</span>
<span class="hljs-comment">// utxoInfo: ScriptSignatureParams[P2PKHInputInfo] = ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(893c1df16d3d42cabdf40cc662d49ea77280a90edd9ea3b4752a0cc34762d841:0),10000 sats,ECPublicKey(0284f90b1fed90596696ad9572133f48a9e117162c10806beddcde1e264d37c35e)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(39408fc14747562d8078930ed6ceca16d79db795))),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(3fba6fe398eb28559a50c0952b69b5493a3b9aeea6c121ee9f3e2be10aaaf3f0:0),10000 sats,ECPublicKey(035c1fa7873e6c43704270e8e89cb3b5ca7be32b356d8f96eae3d97bdc4f5f5d83)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(7893de702c357afa915bb42a1d89e51012682fe6))),UInt32Impl(0)),Vector(Masked(ECPrivateKey)),SIGHASH_ALL(Int32Impl(1))))</span>
<span class="hljs-comment">// utxoInfos: Vector[ScriptSignatureParams[InputInfo]] = Vector(ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(893c1df16d3d42cabdf40cc662d49ea77280a90edd9ea3b4752a0cc34762d841:0),10000 sats,ECPublicKey(0284f90b1fed90596696ad9572133f48a9e117162c10806beddcde1e264d37c35e)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(39408fc14747562d8078930ed6ceca16d79db795))),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(3fba6fe398eb28559a50c0952b69b5493a3b9aeea6c121ee9f3e2be10aaaf3f0:0),P2PKHScriptSignature(ECPublicKeyBytes(ByteVector(33 bytes, 0x035c1fa7873e6c43704270e8e89cb3b5ca7be32b356d8f96eae3d97bdc4f5f5d83)), ECDigitalSignature(3044022059c5f91e1306a478d3e35863c4c676e549806cf049ace6ba87298d767c13588e0220402e488f3a126d74129bdff10c37425425fd30bc169b2ae05e11a88ef77399c601)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(c1e89a0bbb0ac7bb4d0acfd291c908dfd264b835)), TransactionOutput(4775 sats,pkh(f9415e115bf0ef28f238f1cda8dcbf57d819aa4f))),UInt32Impl(0))</span>
<span class="hljs-comment">// signedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(893c1df16d3d42cabdf40cc662d49ea77280a90edd9ea3b4752a0cc34762d841:0),P2PKHScriptSignature(ECPublicKeyBytes(ByteVector(33 bytes, 0x0284f90b1fed90596696ad9572133f48a9e117162c10806beddcde1e264d37c35e)), ECDigitalSignature(304402207f2d92d8627160ed2cb8e568a556939fb26173b4ce740bd33e9e3fd9a5bc622202202b4a86684e7321d88b70520f48629ac5cb7d9586e329f683143882153ad08fad01)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(84730f03021c2ea8f3ed89e9acc6008e47eaa390)), TransactionOutput(4775 sats,pkh(25867f16132dea245b0f1814b21062e4302c6f8f))),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 = 0200000001f0f3aa0ae12b3e9fee21c1a6ee9a3b3a49b5692b95c0509a5528eb98e36fba3f000000006a473044022059c5f91e1306a478d3e35863c4c676e549806cf049ace6ba87298d767c13588e0220402e488f3a126d74129bdff10c37425425fd30bc169b2ae05e11a88ef77399c60121035c1fa7873e6c43704270e8e89cb3b5ca7be32b356d8f96eae3d97bdc4f5f5d83000000000288130000000000001976a914c1e89a0bbb0ac7bb4d0acfd291c908dfd264b83588aca7120000000000001976a914f9415e115bf0ef28f238f1cda8dcbf57d819aa4f88ac00000000</span>
<span class="hljs-comment">// res4: String = 020000000141d86247c30c2a75b4a39edd0ea98072a79ed462c60cf4bdca423d6df11d3c89000000006a47304402207f2d92d8627160ed2cb8e568a556939fb26173b4ce740bd33e9e3fd9a5bc622202202b4a86684e7321d88b70520f48629ac5cb7d9586e329f683143882153ad08fad01210284f90b1fed90596696ad9572133f48a9e117162c10806beddcde1e264d37c35e000000000288130000000000001976a91484730f03021c2ea8f3ed89e9acc6008e47eaa39088aca7120000000000001976a91425867f16132dea245b0f1814b21062e4302c6f8f88ac00000000</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 © 2022 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@35e0d989[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@23f9df2c[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(035c1fa7873e6c43704270e8e89cb3b5ca7be32b356d8f96eae3d97bdc4f5f5d83)</span>
<span class="hljs-comment">// pubKey: ECPublicKey = ECPublicKey(0284f90b1fed90596696ad9572133f48a9e117162c10806beddcde1e264d37c35e)</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(7893de702c357afa915bb42a1d89e51012682fe6)</span>
<span class="hljs-comment">// creditingSpk: P2PKHScriptPubKey = pkh(39408fc14747562d8078930ed6ceca16d79db795)</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(7893de702c357afa915bb42a1d89e51012682fe6))</span>
<span class="hljs-comment">// utxo: TransactionOutput = TransactionOutput(10000 sats,pkh(39408fc14747562d8078930ed6ceca16d79db795))</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(c1e89a0bbb0ac7bb4d0acfd291c908dfd264b835)</span>
<span class="hljs-comment">// destinationSPK: P2PKHScriptPubKey = pkh(84730f03021c2ea8f3ed89e9acc6008e47eaa390)</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(c1e89a0bbb0ac7bb4d0acfd291c908dfd264b835)))</span>
<span class="hljs-comment">// destinations: Vector[TransactionOutput] = Vector(TransactionOutput(5000 sats,pkh(84730f03021c2ea8f3ed89e9acc6008e47eaa390)))</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(7893de702c357afa915bb42a1d89e51012682fe6))),UInt32Impl(0))</span>
<span class="hljs-comment">// creditingTx: BaseTransaction = BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(39408fc14747562d8078930ed6ceca16d79db795))),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(3fba6fe398eb28559a50c0952b69b5493a3b9aeea6c121ee9f3e2be10aaaf3f0:0)</span>
<span class="hljs-comment">// outPoint: TransactionOutPoint = TransactionOutPoint(893c1df16d3d42cabdf40cc662d49ea77280a90edd9ea3b4752a0cc34762d841: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(3fba6fe398eb28559a50c0952b69b5493a3b9aeea6c121ee9f3e2be10aaaf3f0:0),EmptyScriptSignature,UInt32Impl(0))</span>
<span class="hljs-comment">// input: TransactionInput = TransactionInputImpl(TransactionOutPoint(893c1df16d3d42cabdf40cc662d49ea77280a90edd9ea3b4752a0cc34762d841: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(3fba6fe398eb28559a50c0952b69b5493a3b9aeea6c121ee9f3e2be10aaaf3f0:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(c1e89a0bbb0ac7bb4d0acfd291c908dfd264b835))),UInt32Impl(0))</span>
<span class="hljs-comment">// builderResult: RawTxBuilderResult = RawTxBuilderResult(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(893c1df16d3d42cabdf40cc662d49ea77280a90edd9ea3b4752a0cc34762d841:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(84730f03021c2ea8f3ed89e9acc6008e47eaa390))),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(3fba6fe398eb28559a50c0952b69b5493a3b9aeea6c121ee9f3e2be10aaaf3f0:0),10000 sats,ECPublicKey(035c1fa7873e6c43704270e8e89cb3b5ca7be32b356d8f96eae3d97bdc4f5f5d83))</span>
<span class="hljs-comment">// inputInfo: P2PKHInputInfo = P2PKHInputInfo(TransactionOutPoint(893c1df16d3d42cabdf40cc662d49ea77280a90edd9ea3b4752a0cc34762d841:0),10000 sats,ECPublicKey(0284f90b1fed90596696ad9572133f48a9e117162c10806beddcde1e264d37c35e))</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(f9415e115bf0ef28f238f1cda8dcbf57d819aa4f)</span>
<span class="hljs-comment">// changeSPK: P2PKHScriptPubKey = pkh(25867f16132dea245b0f1814b21062e4302c6f8f)</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(3fba6fe398eb28559a50c0952b69b5493a3b9aeea6c121ee9f3e2be10aaaf3f0:0),10000 sats,ECPublicKey(035c1fa7873e6c43704270e8e89cb3b5ca7be32b356d8f96eae3d97bdc4f5f5d83))),1 sats/byte,pkh(f9415e115bf0ef28f238f1cda8dcbf57d819aa4f))</span>
<span class="hljs-comment">// finalizer: StandardNonInteractiveFinalizer = StandardNonInteractiveFinalizer(Vector(P2PKHInputInfo(TransactionOutPoint(893c1df16d3d42cabdf40cc662d49ea77280a90edd9ea3b4752a0cc34762d841:0),10000 sats,ECPublicKey(0284f90b1fed90596696ad9572133f48a9e117162c10806beddcde1e264d37c35e))),1 sats/byte,pkh(25867f16132dea245b0f1814b21062e4302c6f8f))</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(3fba6fe398eb28559a50c0952b69b5493a3b9aeea6c121ee9f3e2be10aaaf3f0:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(c1e89a0bbb0ac7bb4d0acfd291c908dfd264b835)), TransactionOutput(4775 sats,pkh(f9415e115bf0ef28f238f1cda8dcbf57d819aa4f))),UInt32Impl(0))</span>
<span class="hljs-comment">// unsignedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(893c1df16d3d42cabdf40cc662d49ea77280a90edd9ea3b4752a0cc34762d841:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(84730f03021c2ea8f3ed89e9acc6008e47eaa390)), TransactionOutput(4775 sats,pkh(25867f16132dea245b0f1814b21062e4302c6f8f))),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(3fba6fe398eb28559a50c0952b69b5493a3b9aeea6c121ee9f3e2be10aaaf3f0:0),10000 sats,ECPublicKey(035c1fa7873e6c43704270e8e89cb3b5ca7be32b356d8f96eae3d97bdc4f5f5d83)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(7893de702c357afa915bb42a1d89e51012682fe6))),UInt32Impl(0)),Vector(Masked(ECPrivateKey)),SIGHASH_ALL(Int32Impl(1)))</span>
<span class="hljs-comment">// utxoInfo: ScriptSignatureParams[P2PKHInputInfo] = ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(893c1df16d3d42cabdf40cc662d49ea77280a90edd9ea3b4752a0cc34762d841:0),10000 sats,ECPublicKey(0284f90b1fed90596696ad9572133f48a9e117162c10806beddcde1e264d37c35e)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(39408fc14747562d8078930ed6ceca16d79db795))),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(3fba6fe398eb28559a50c0952b69b5493a3b9aeea6c121ee9f3e2be10aaaf3f0:0),10000 sats,ECPublicKey(035c1fa7873e6c43704270e8e89cb3b5ca7be32b356d8f96eae3d97bdc4f5f5d83)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(7893de702c357afa915bb42a1d89e51012682fe6))),UInt32Impl(0)),Vector(Masked(ECPrivateKey)),SIGHASH_ALL(Int32Impl(1))))</span>
<span class="hljs-comment">// utxoInfos: Vector[ScriptSignatureParams[InputInfo]] = Vector(ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(893c1df16d3d42cabdf40cc662d49ea77280a90edd9ea3b4752a0cc34762d841:0),10000 sats,ECPublicKey(0284f90b1fed90596696ad9572133f48a9e117162c10806beddcde1e264d37c35e)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(39408fc14747562d8078930ed6ceca16d79db795))),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(3fba6fe398eb28559a50c0952b69b5493a3b9aeea6c121ee9f3e2be10aaaf3f0:0),P2PKHScriptSignature(ECPublicKeyBytes(ByteVector(33 bytes, 0x035c1fa7873e6c43704270e8e89cb3b5ca7be32b356d8f96eae3d97bdc4f5f5d83)), ECDigitalSignature(3044022059c5f91e1306a478d3e35863c4c676e549806cf049ace6ba87298d767c13588e0220402e488f3a126d74129bdff10c37425425fd30bc169b2ae05e11a88ef77399c601)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(c1e89a0bbb0ac7bb4d0acfd291c908dfd264b835)), TransactionOutput(4775 sats,pkh(f9415e115bf0ef28f238f1cda8dcbf57d819aa4f))),UInt32Impl(0))</span>
<span class="hljs-comment">// signedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(893c1df16d3d42cabdf40cc662d49ea77280a90edd9ea3b4752a0cc34762d841:0),P2PKHScriptSignature(ECPublicKeyBytes(ByteVector(33 bytes, 0x0284f90b1fed90596696ad9572133f48a9e117162c10806beddcde1e264d37c35e)), ECDigitalSignature(304402207f2d92d8627160ed2cb8e568a556939fb26173b4ce740bd33e9e3fd9a5bc622202202b4a86684e7321d88b70520f48629ac5cb7d9586e329f683143882153ad08fad01)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(84730f03021c2ea8f3ed89e9acc6008e47eaa390)), TransactionOutput(4775 sats,pkh(25867f16132dea245b0f1814b21062e4302c6f8f))),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 = 0200000001f0f3aa0ae12b3e9fee21c1a6ee9a3b3a49b5692b95c0509a5528eb98e36fba3f000000006a473044022059c5f91e1306a478d3e35863c4c676e549806cf049ace6ba87298d767c13588e0220402e488f3a126d74129bdff10c37425425fd30bc169b2ae05e11a88ef77399c60121035c1fa7873e6c43704270e8e89cb3b5ca7be32b356d8f96eae3d97bdc4f5f5d83000000000288130000000000001976a914c1e89a0bbb0ac7bb4d0acfd291c908dfd264b83588aca7120000000000001976a914f9415e115bf0ef28f238f1cda8dcbf57d819aa4f88ac00000000</span>
<span class="hljs-comment">// res4: String = 020000000141d86247c30c2a75b4a39edd0ea98072a79ed462c60cf4bdca423d6df11d3c89000000006a47304402207f2d92d8627160ed2cb8e568a556939fb26173b4ce740bd33e9e3fd9a5bc622202202b4a86684e7321d88b70520f48629ac5cb7d9586e329f683143882153ad08fad01210284f90b1fed90596696ad9572133f48a9e117162c10806beddcde1e264d37c35e000000000288130000000000001976a91484730f03021c2ea8f3ed89e9acc6008e47eaa39088aca7120000000000001976a91425867f16132dea245b0f1814b21062e4302c6f8f88ac00000000</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 © 2022 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(3045022100bfd4ddb973106a0e5d88b9e246cf5f67030ebd10b81075b3f43cd94c5f083467022071f56d3c6654e6e11a7a755da395b21b6385da59bf36ab522bc7422b5a872419)</span>
<span class="hljs-comment">// res0: ECDigitalSignature = ECDigitalSignature(304402200eb9cff2a648ca3377fe661586a179b10ef90829afc83cb5348bac9f3377303502201bceecd086a586a2575f36289a5a7f45935b9a54198d729d9422379287e07cb3)</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(30440220766e3dcaf302b812a6e89ab423c3e9212b1cc6b9c05c6548d63b68f135db5feb0220150cb6bc4337685d11d80316479dc3baac75ba49f83b73f3706c439b100f748a)</span>
<span class="hljs-comment">// res1: ECDigitalSignature = ECDigitalSignature(30450221009eaaef099d76f792fe2e4c0579d53e5dfaaa974fedd28b0b3ce2d1a5633a5f09022034606dacab5d766196fc6849b66b4daf7257faeda78355b70e61bcf171c5e3ef)</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(3045022100bfd4ddb973106a0e5d88b9e246cf5f67030ebd10b81075b3f43cd94c5f083467022071f56d3c6654e6e11a7a755da395b21b6385da59bf36ab522bc7422b5a872419)</span>
<span class="hljs-comment">// res0: ECDigitalSignature = ECDigitalSignature(304402200eb9cff2a648ca3377fe661586a179b10ef90829afc83cb5348bac9f3377303502201bceecd086a586a2575f36289a5a7f45935b9a54198d729d9422379287e07cb3)</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(30440220766e3dcaf302b812a6e89ab423c3e9212b1cc6b9c05c6548d63b68f135db5feb0220150cb6bc4337685d11d80316479dc3baac75ba49f83b73f3706c439b100f748a)</span>
<span class="hljs-comment">// res1: ECDigitalSignature = ECDigitalSignature(30450221009eaaef099d76f792fe2e4c0579d53e5dfaaa974fedd28b0b3ce2d1a5633a5f09022034606dacab5d766196fc6849b66b4daf7257faeda78355b70e61bcf171c5e3ef)</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.9.0-66-b0d7bee0-SNAPSHOT</code>.</p>
recent snapshot published is <code>1.9.0-67-049411cc-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.9.0-66-b0d7bee0-SNAPSHOT</code>.</p>
recent snapshot published is <code>1.9.0-67-049411cc-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, 0x4e1a1ca77b8895a864abeea7bfa1116d23ffc40d5c58e99e5dc164ab9d04d6c4)</span>
<span class="hljs-comment">// entropy: scodec.bits.BitVector = BitVector(256 bits, 0x2ca97465536bef2884ce8f317b334f14e41af94f51ed0a45ef209401522ddb87)</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(evoke, special, clap, warfare, matter, stage, naive, lava, police, wonder, dust, surge, divide, tilt, cube, mention, trumpet, very, icon, sing, right, list, force, output)</span>
<span class="hljs-comment">// Vector(coach, entry, bone, plug, same, nephew, basket, spin, cousin, sunset, stable, clap, double, lake, diary, diet, apart, control, sight, chimney, benefit, black, host, word)</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-example2539085936745188024/encrypted-bitcoin-s-seed.json</span>
<span class="hljs-comment">// seedPath: Path = /tmp/key-manager-example11400897514016931674/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-example2539085936745188024/encrypted-bitcoin-s-seed.json,m/84',RegTest)</span>
<span class="hljs-comment">// kmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example11400897514016931674/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@4e23f46d)</span>
<span class="hljs-comment">// km: Either[KeyManagerInitializeError, BIP39KeyManager] = Right(org.bitcoins.keymanager.bip39.BIP39KeyManager@73a1edca)</span>
<span class="hljs-keyword">val</span> rootXPub = km.right.get.getRootXPub
<span class="hljs-comment">// rootXPub: ExtPublicKey = vpub5SLqN2bLY4WeYazbUENPTpsh9oT8P7KU8gy6kHCvKbCRUN3L2yLoKpdpZmYh6oBwXrjp4dKfFLoaJZd8o7RvQZdqzpb2KWw1efCVNAL3KwG</span>
<span class="hljs-comment">// rootXPub: ExtPublicKey = vpub5SLqN2bLY4WeaTUSzMjPADnKAcRsquno5oyyN1s3AhW8TxafcHvaFmn1GGSA2zLrU9mvuFkxJtPpG4EfiUFeuZ8E1p5ztuZrgCD94SbKiiY</span>
println(rootXPub)
<span class="hljs-comment">// vpub5SLqN2bLY4WeYazbUENPTpsh9oT8P7KU8gy6kHCvKbCRUN3L2yLoKpdpZmYh6oBwXrjp4dKfFLoaJZd8o7RvQZdqzpb2KWw1efCVNAL3KwG</span>
<span class="hljs-comment">// vpub5SLqN2bLY4WeaTUSzMjPADnKAcRsquno5oyyN1s3AhW8TxafcHvaFmn1GGSA2zLrU9mvuFkxJtPpG4EfiUFeuZ8E1p5ztuZrgCD94SbKiiY</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-example2539085936745188024/encrypted-bitcoin-s-seed.json,m/84',MainNet)</span>
<span class="hljs-comment">// mainnetKmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example11400897514016931674/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@67dd9fbc</span>
<span class="hljs-comment">// mainnetKeyManager: BIP39KeyManager = org.bitcoins.keymanager.bip39.BIP39KeyManager@3594356f</span>
<span class="hljs-keyword">val</span> mainnetXpub = mainnetKeyManager.getRootXPub
<span class="hljs-comment">// mainnetXpub: ExtPublicKey = zpub6jftahH18ngZwmm4ofWtJBFhqg2v9bHTo93ysrnTqchwgmJF3c13p5GNebP36RodARD34Xhu5zDmqi5Pfu5ybWNFUBNifACxjZT4vYcCMVD</span>
<span class="hljs-comment">// mainnetXpub: ExtPublicKey = zpub6jftahH18ngZyeEvKnsszaAKrV1fcPknkG4rVbSagj1egMqacvapk2QZM6GW2cxY6iF9uA9C9Xp1oCgvbFui6VrdVAshEYqom6TiciU68Z9</span>
println(mainnetXpub)
<span class="hljs-comment">// zpub6jftahH18ngZwmm4ofWtJBFhqg2v9bHTo93ysrnTqchwgmJF3c13p5GNebP36RodARD34Xhu5zDmqi5Pfu5ybWNFUBNifACxjZT4vYcCMVD</span>
<span class="hljs-comment">// zpub6jftahH18ngZyeEvKnsszaAKrV1fcPknkG4rVbSagj1egMqacvapk2QZM6GW2cxY6iF9uA9C9Xp1oCgvbFui6VrdVAshEYqom6TiciU68Z9</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, 0x4e1a1ca77b8895a864abeea7bfa1116d23ffc40d5c58e99e5dc164ab9d04d6c4)</span>
<span class="hljs-comment">// entropy: scodec.bits.BitVector = BitVector(256 bits, 0x2ca97465536bef2884ce8f317b334f14e41af94f51ed0a45ef209401522ddb87)</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(evoke, special, clap, warfare, matter, stage, naive, lava, police, wonder, dust, surge, divide, tilt, cube, mention, trumpet, very, icon, sing, right, list, force, output)</span>
<span class="hljs-comment">// Vector(coach, entry, bone, plug, same, nephew, basket, spin, cousin, sunset, stable, clap, double, lake, diary, diet, apart, control, sight, chimney, benefit, black, host, word)</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-example2539085936745188024/encrypted-bitcoin-s-seed.json</span>
<span class="hljs-comment">// seedPath: Path = /tmp/key-manager-example11400897514016931674/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-example2539085936745188024/encrypted-bitcoin-s-seed.json,m/84',RegTest)</span>
<span class="hljs-comment">// kmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example11400897514016931674/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@4e23f46d)</span>
<span class="hljs-comment">// km: Either[KeyManagerInitializeError, BIP39KeyManager] = Right(org.bitcoins.keymanager.bip39.BIP39KeyManager@73a1edca)</span>
<span class="hljs-keyword">val</span> rootXPub = km.right.get.getRootXPub
<span class="hljs-comment">// rootXPub: ExtPublicKey = vpub5SLqN2bLY4WeYazbUENPTpsh9oT8P7KU8gy6kHCvKbCRUN3L2yLoKpdpZmYh6oBwXrjp4dKfFLoaJZd8o7RvQZdqzpb2KWw1efCVNAL3KwG</span>
<span class="hljs-comment">// rootXPub: ExtPublicKey = vpub5SLqN2bLY4WeaTUSzMjPADnKAcRsquno5oyyN1s3AhW8TxafcHvaFmn1GGSA2zLrU9mvuFkxJtPpG4EfiUFeuZ8E1p5ztuZrgCD94SbKiiY</span>
println(rootXPub)
<span class="hljs-comment">// vpub5SLqN2bLY4WeYazbUENPTpsh9oT8P7KU8gy6kHCvKbCRUN3L2yLoKpdpZmYh6oBwXrjp4dKfFLoaJZd8o7RvQZdqzpb2KWw1efCVNAL3KwG</span>
<span class="hljs-comment">// vpub5SLqN2bLY4WeaTUSzMjPADnKAcRsquno5oyyN1s3AhW8TxafcHvaFmn1GGSA2zLrU9mvuFkxJtPpG4EfiUFeuZ8E1p5ztuZrgCD94SbKiiY</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-example2539085936745188024/encrypted-bitcoin-s-seed.json,m/84',MainNet)</span>
<span class="hljs-comment">// mainnetKmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example11400897514016931674/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@67dd9fbc</span>
<span class="hljs-comment">// mainnetKeyManager: BIP39KeyManager = org.bitcoins.keymanager.bip39.BIP39KeyManager@3594356f</span>
<span class="hljs-keyword">val</span> mainnetXpub = mainnetKeyManager.getRootXPub
<span class="hljs-comment">// mainnetXpub: ExtPublicKey = zpub6jftahH18ngZwmm4ofWtJBFhqg2v9bHTo93ysrnTqchwgmJF3c13p5GNebP36RodARD34Xhu5zDmqi5Pfu5ybWNFUBNifACxjZT4vYcCMVD</span>
<span class="hljs-comment">// mainnetXpub: ExtPublicKey = zpub6jftahH18ngZyeEvKnsszaAKrV1fcPknkG4rVbSagj1egMqacvapk2QZM6GW2cxY6iF9uA9C9Xp1oCgvbFui6VrdVAshEYqom6TiciU68Z9</span>
println(mainnetXpub)
<span class="hljs-comment">// zpub6jftahH18ngZwmm4ofWtJBFhqg2v9bHTo93ysrnTqchwgmJF3c13p5GNebP36RodARD34Xhu5zDmqi5Pfu5ybWNFUBNifACxjZT4vYcCMVD</span>
<span class="hljs-comment">// zpub6jftahH18ngZyeEvKnsszaAKrV1fcPknkG4rVbSagj1egMqacvapk2QZM6GW2cxY6iF9uA9C9Xp1oCgvbFui6VrdVAshEYqom6TiciU68Z9</span>
</code></pre>
<p>Which gives us something that looks like this</p>
<p><code>zpub6jftahH18ngZw98KGjRo5XcxeKTQ2eztsvskb1dC9XF5TLimQquTs6Ry7nBBA425D9joXmfgJJCexmJ1u2SELJZJfRi95gcnXadLpZzYb5c</code></p>

3
docs/next/oracle/oracle-server.html
View file

@ -67,6 +67,9 @@ You can interact with the oracle server with <code>bitcoin-s-cli</code> or <code
<p>The following a guide is for interacting with the oracle
If you are looking for the documentation on how to build the oracle server,
checkout <a href="/docs/next/oracle/build-oracle-server">this page</a>.</p>
<p>Note: It is safe to back up the <code>oracle.sqlite</code> file to a public place. The seed file contains
the cryptographic seed information. You need both the database and the seed file to restore the oracle.
Make sure you don't back the seed file to a place that is not safe.</p>
<h2><a class="anchor" aria-hidden="true" id="server-endpoints"></a><a href="#server-endpoints" 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>Server Endpoints</h2>
<ul>
<li><code>getpublickey</code> - Get oracle's public key</li>

3
docs/next/oracle/oracle-server/index.html
View file

@ -67,6 +67,9 @@ You can interact with the oracle server with <code>bitcoin-s-cli</code> or <code
<p>The following a guide is for interacting with the oracle
If you are looking for the documentation on how to build the oracle server,
checkout <a href="/docs/next/oracle/build-oracle-server">this page</a>.</p>
<p>Note: It is safe to back up the <code>oracle.sqlite</code> file to a public place. The seed file contains
the cryptographic seed information. You need both the database and the seed file to restore the oracle.
Make sure you don't back the seed file to a place that is not safe.</p>
<h2><a class="anchor" aria-hidden="true" id="server-endpoints"></a><a href="#server-endpoints" 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>Server Endpoints</h2>
<ul>
<li><code>getpublickey</code> - Get oracle's public key</li>

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(03e10faffb792b50ad9fe2c958e2b004087f7de397188c1ed08640b4a97d21e993)</span>
<span class="hljs-comment">// publicKey: ECPublicKey = ECPublicKey(0293a696583f3f09ad807475dca8cc94b31cbae6de09d66d0a477f07e8999f8e3c)</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(3045022100e29ed114c12c218d82d126ab474b275170d0164bfeec4b46f4d53b96eae32c3402205371a3e025a61c5ee938a1fdc3b95ac45d03f23eb3d387a84eb7ebc329439665)</span>
<span class="hljs-comment">// signature: ECDigitalSignature = ECDigitalSignature(3045022100bc5072b1e33b56df5593fd3912c37d54bbfcff8d6afb0b5eead3a42cd74d1b8b02204d2132c74e6ce9e88dd4ae58f9185d6a5cea365829504f2140aa74c5b3bea319)</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(03e10faffb792b50ad9fe2c958e2b004087f7de397188c1ed08640b4a97d21e993)</span>
<span class="hljs-comment">// publicKey: ECPublicKey = ECPublicKey(0293a696583f3f09ad807475dca8cc94b31cbae6de09d66d0a477f07e8999f8e3c)</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(3045022100e29ed114c12c218d82d126ab474b275170d0164bfeec4b46f4d53b96eae32c3402205371a3e025a61c5ee938a1fdc3b95ac45d03f23eb3d387a84eb7ebc329439665)</span>
<span class="hljs-comment">// signature: ECDigitalSignature = ECDigitalSignature(3045022100bc5072b1e33b56df5593fd3912c37d54bbfcff8d6afb0b5eead3a42cd74d1b8b02204d2132c74e6ce9e88dd4ae58f9185d6a5cea365829504f2140aa74c5b3bea319)</span>
<span class="hljs-comment">// calls bouncy castle indirectly via CryptoContext</span>
<span class="hljs-keyword">val</span> verified = publicKey.verify(dataToSign.bytes, signature)