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

Deploy website

Browse source 
Deploy website version based on 98ceddfc22
This commit is contained in:
Docusaurus bot 2021-10-04 17:39:09 +00:00
parent deb270ebba
commit 4a9e2182ce
20 changed files with 120 additions and 120 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(03cbd75d2272b60c929efc422def03c4285ea68cbb180a038bbef78b418092d0d0)</span>
<span class="hljs-comment">// pubkey: org.bitcoins.crypto.ECPublicKey = ECPublicKey(034e1222269a35d89d7f93fa73092caf32fa6a8e76e87cf2c9ee5dcb72dee7a0a8)</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 = tb1qajg2m8ydgays4wr99dehwddzxl9sxq6gra8e5u</span>
<span class="hljs-comment">// segwitAddress: Bech32Address = tb1qmvjq3qufvvdunppa2jnx4mh9yne0jrjpdfjdph</span>
println(segwitAddress.toString)
<span class="hljs-comment">// tb1qajg2m8ydgays4wr99dehwddzxl9sxq6gra8e5u</span>
<span class="hljs-comment">// tb1qmvjq3qufvvdunppa2jnx4mh9yne0jrjpdfjdph</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 = n35o5jxcLEYnGyNpWVDF4G69M3Je8ehXLh</span>
<span class="hljs-comment">// legacyAddress: P2PKHAddress = n1VfShXJ4UsugMuR7HkHkVeYyZ5wm12w2v</span>
println(legacyAddress.toString)
<span class="hljs-comment">// n35o5jxcLEYnGyNpWVDF4G69M3Je8ehXLh</span>
<span class="hljs-comment">// n1VfShXJ4UsugMuR7HkHkVeYyZ5wm12w2v</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(03cbd75d2272b60c929efc422def03c4285ea68cbb180a038bbef78b418092d0d0)</span>
<span class="hljs-comment">// pubkey: org.bitcoins.crypto.ECPublicKey = ECPublicKey(034e1222269a35d89d7f93fa73092caf32fa6a8e76e87cf2c9ee5dcb72dee7a0a8)</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 = tb1qajg2m8ydgays4wr99dehwddzxl9sxq6gra8e5u</span>
<span class="hljs-comment">// segwitAddress: Bech32Address = tb1qmvjq3qufvvdunppa2jnx4mh9yne0jrjpdfjdph</span>
println(segwitAddress.toString)
<span class="hljs-comment">// tb1qajg2m8ydgays4wr99dehwddzxl9sxq6gra8e5u</span>
<span class="hljs-comment">// tb1qmvjq3qufvvdunppa2jnx4mh9yne0jrjpdfjdph</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 = n35o5jxcLEYnGyNpWVDF4G69M3Je8ehXLh</span>
<span class="hljs-comment">// legacyAddress: P2PKHAddress = n1VfShXJ4UsugMuR7HkHkVeYyZ5wm12w2v</span>
println(legacyAddress.toString)
<span class="hljs-comment">// n35o5jxcLEYnGyNpWVDF4G69M3Je8ehXLh</span>
<span class="hljs-comment">// n1VfShXJ4UsugMuR7HkHkVeYyZ5wm12w2v</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, 0x101b6b0197504fbec49bbf23791faaaf71729e021fcaee9b833165ea9ed79414)</span>
<span class="hljs-comment">// entropy: BitVector = BitVector(256 bits, 0xb7135278e2ee5a3c4727600c06050ce8910ca71f1ea589bfa52e3b210a359d35)</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(avoid, swap, scatter, concert, agent, term, bar, jewel, casino, similar, turkey, galaxy, blame, excuse, anchor, welcome, update, swing, slush, slim, prepare, hint, expect, magic) // the phrase the user should write down</span>
<span class="hljs-comment">// res0: Vector[String] = Vector(require, once, owner, shift, toss, bullet, broken, ugly, army, coral, drip, spell, awkward, fatal, ladder, start, meadow, wood, entire, iron, awful, bracket, inquiry, remember) // 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 = zpub6jftahH18ngZx6xpU1vSC8kTTve4mai93fj398bgtW7vozwQiJ2V7bpaPSLtUFWtiBGFg8U9cvp9eVMmfWSTsXg1hYga7kSTAUm1vFiu6rg</span>
<span class="hljs-comment">// xpub: ExtPublicKey = zpub6jftahH18ngZxJGkdeWSdsybYoeijuHHzT6nFuxoUAvY3CpL4h9JcLMvnptHH1C3i4dgy5Vtsk5bysnb7TPYdQB1AWYNtTFTZabfYAnw1fL</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 = zpub6rzTnAC925wk6jcsEgojxtnAQv32qRdaJd6uMAsWBwwzNz7oMfmzJodc3qKoq7yumbC3yD4zzWepEbDhSVetuB5EUSU356nU5o5hCRiXeMz</span>
<span class="hljs-comment">// accountXpub: ExtPublicKey = zpub6qZ3tQr9BPvMtTZT4i4cNqRvrNVJRyawUAFHFv5qdbm115RtyNcYEUPKbJLN78znrbF7uZAYmvMUbz4nzJhnaZp67mci35o3NbLgqX9Y1ip</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 = tb1qy0h7ddjp994dctuvdyl489yyklc0mnyv7wpt73</span>
<span class="hljs-comment">// firstAccountAddress: Bech32Address = tb1q74gr2mhttytgy49m8l3f37prm39ga2e08fhm7e</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 = tb1qy0h7ddjp994dctuvdyl489yyklc0mnyv7wpt73</span>
<span class="hljs-comment">// res2: String = tb1q74gr2mhttytgy49m8l3f37prm39ga2e08fhm7e</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, 0x101b6b0197504fbec49bbf23791faaaf71729e021fcaee9b833165ea9ed79414)</span>
<span class="hljs-comment">// entropy: BitVector = BitVector(256 bits, 0xb7135278e2ee5a3c4727600c06050ce8910ca71f1ea589bfa52e3b210a359d35)</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(avoid, swap, scatter, concert, agent, term, bar, jewel, casino, similar, turkey, galaxy, blame, excuse, anchor, welcome, update, swing, slush, slim, prepare, hint, expect, magic) // the phrase the user should write down</span>
<span class="hljs-comment">// res0: Vector[String] = Vector(require, once, owner, shift, toss, bullet, broken, ugly, army, coral, drip, spell, awkward, fatal, ladder, start, meadow, wood, entire, iron, awful, bracket, inquiry, remember) // 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 = zpub6jftahH18ngZx6xpU1vSC8kTTve4mai93fj398bgtW7vozwQiJ2V7bpaPSLtUFWtiBGFg8U9cvp9eVMmfWSTsXg1hYga7kSTAUm1vFiu6rg</span>
<span class="hljs-comment">// xpub: ExtPublicKey = zpub6jftahH18ngZxJGkdeWSdsybYoeijuHHzT6nFuxoUAvY3CpL4h9JcLMvnptHH1C3i4dgy5Vtsk5bysnb7TPYdQB1AWYNtTFTZabfYAnw1fL</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 = zpub6rzTnAC925wk6jcsEgojxtnAQv32qRdaJd6uMAsWBwwzNz7oMfmzJodc3qKoq7yumbC3yD4zzWepEbDhSVetuB5EUSU356nU5o5hCRiXeMz</span>
<span class="hljs-comment">// accountXpub: ExtPublicKey = zpub6qZ3tQr9BPvMtTZT4i4cNqRvrNVJRyawUAFHFv5qdbm115RtyNcYEUPKbJLN78znrbF7uZAYmvMUbz4nzJhnaZp67mci35o3NbLgqX9Y1ip</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 = tb1qy0h7ddjp994dctuvdyl489yyklc0mnyv7wpt73</span>
<span class="hljs-comment">// firstAccountAddress: Bech32Address = tb1q74gr2mhttytgy49m8l3f37prm39ga2e08fhm7e</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 = tb1qy0h7ddjp994dctuvdyl489yyklc0mnyv7wpt73</span>
<span class="hljs-comment">// res2: String = tb1q74gr2mhttytgy49m8l3f37prm39ga2e08fhm7e</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@5142b95d[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@28af81ae[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(0209cc8cfe539b27946af45cddfd0bb3eb6ac34df462db16f722086543e51bb82c)</span>
<span class="hljs-comment">// pubKey: ECPublicKey = ECPublicKey(033237a67abf695e7e7ae8aef37280a2095ef60b4b52f2bc4947676fab6f6a6e5a)</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(79b90eb7b1cfb9ec3f6673d88c722f6634ff17bc)</span>
<span class="hljs-comment">// creditingSpk: P2PKHScriptPubKey = pkh(fcbff7d9105b0bd293020849c807962aa19f1b55)</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(79b90eb7b1cfb9ec3f6673d88c722f6634ff17bc))</span>
<span class="hljs-comment">// utxo: TransactionOutput = TransactionOutput(10000 sats,pkh(fcbff7d9105b0bd293020849c807962aa19f1b55))</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(0a6858d1298edef26954228d6dd95c01a408706f)</span>
<span class="hljs-comment">// destinationSPK: P2PKHScriptPubKey = pkh(c9bbbb242822829bbc3efebdc666d004d8f53c94)</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(0a6858d1298edef26954228d6dd95c01a408706f)))</span>
<span class="hljs-comment">// destinations: Vector[TransactionOutput] = Vector(TransactionOutput(5000 sats,pkh(c9bbbb242822829bbc3efebdc666d004d8f53c94)))</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(79b90eb7b1cfb9ec3f6673d88c722f6634ff17bc))),UInt32Impl(0))</span>
<span class="hljs-comment">// creditingTx: BaseTransaction = BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(fcbff7d9105b0bd293020849c807962aa19f1b55))),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(20f5b22dfce8182e8629c3e4debb6af403973fdc4a775b757c2c7005727b7431:0)</span>
<span class="hljs-comment">// outPoint: TransactionOutPoint = TransactionOutPoint(f1a5589bb2c4a3754e7b98f53b2e0510ab7626d7efc1f38b350a9c181d71ea4c: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(20f5b22dfce8182e8629c3e4debb6af403973fdc4a775b757c2c7005727b7431:0),EmptyScriptSignature,UInt32Impl(0))</span>
<span class="hljs-comment">// input: TransactionInput = TransactionInputImpl(TransactionOutPoint(f1a5589bb2c4a3754e7b98f53b2e0510ab7626d7efc1f38b350a9c181d71ea4c: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(20f5b22dfce8182e8629c3e4debb6af403973fdc4a775b757c2c7005727b7431:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(0a6858d1298edef26954228d6dd95c01a408706f))),UInt32Impl(0))</span>
<span class="hljs-comment">// builderResult: RawTxBuilderResult = RawTxBuilderResult(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(f1a5589bb2c4a3754e7b98f53b2e0510ab7626d7efc1f38b350a9c181d71ea4c:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(c9bbbb242822829bbc3efebdc666d004d8f53c94))),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(20f5b22dfce8182e8629c3e4debb6af403973fdc4a775b757c2c7005727b7431:0),10000 sats,ECPublicKey(0209cc8cfe539b27946af45cddfd0bb3eb6ac34df462db16f722086543e51bb82c))</span>
<span class="hljs-comment">// inputInfo: P2PKHInputInfo = P2PKHInputInfo(TransactionOutPoint(f1a5589bb2c4a3754e7b98f53b2e0510ab7626d7efc1f38b350a9c181d71ea4c:0),10000 sats,ECPublicKey(033237a67abf695e7e7ae8aef37280a2095ef60b4b52f2bc4947676fab6f6a6e5a))</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(d55f769cf83b97642d9be4cf2fb7da01b4f4bb75)</span>
<span class="hljs-comment">// changeSPK: P2PKHScriptPubKey = pkh(fd819d52dba5e9468e44d57f0d3494b9fab1c35c)</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(20f5b22dfce8182e8629c3e4debb6af403973fdc4a775b757c2c7005727b7431:0),10000 sats,ECPublicKey(0209cc8cfe539b27946af45cddfd0bb3eb6ac34df462db16f722086543e51bb82c))),1 sats/byte,pkh(d55f769cf83b97642d9be4cf2fb7da01b4f4bb75))</span>
<span class="hljs-comment">// finalizer: StandardNonInteractiveFinalizer = StandardNonInteractiveFinalizer(Vector(P2PKHInputInfo(TransactionOutPoint(f1a5589bb2c4a3754e7b98f53b2e0510ab7626d7efc1f38b350a9c181d71ea4c:0),10000 sats,ECPublicKey(033237a67abf695e7e7ae8aef37280a2095ef60b4b52f2bc4947676fab6f6a6e5a))),1 sats/byte,pkh(fd819d52dba5e9468e44d57f0d3494b9fab1c35c))</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(20f5b22dfce8182e8629c3e4debb6af403973fdc4a775b757c2c7005727b7431:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(0a6858d1298edef26954228d6dd95c01a408706f)), TransactionOutput(4775 sats,pkh(d55f769cf83b97642d9be4cf2fb7da01b4f4bb75))),UInt32Impl(0))</span>
<span class="hljs-comment">// unsignedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(f1a5589bb2c4a3754e7b98f53b2e0510ab7626d7efc1f38b350a9c181d71ea4c:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(c9bbbb242822829bbc3efebdc666d004d8f53c94)), TransactionOutput(4775 sats,pkh(fd819d52dba5e9468e44d57f0d3494b9fab1c35c))),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(20f5b22dfce8182e8629c3e4debb6af403973fdc4a775b757c2c7005727b7431:0),10000 sats,ECPublicKey(0209cc8cfe539b27946af45cddfd0bb3eb6ac34df462db16f722086543e51bb82c)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(79b90eb7b1cfb9ec3f6673d88c722f6634ff17bc))),UInt32Impl(0)),Vector(Masked(ECPrivateKey)),SIGHASH_ALL(Int32Impl(1)))</span>
<span class="hljs-comment">// utxoInfo: ScriptSignatureParams[P2PKHInputInfo] = ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(f1a5589bb2c4a3754e7b98f53b2e0510ab7626d7efc1f38b350a9c181d71ea4c:0),10000 sats,ECPublicKey(033237a67abf695e7e7ae8aef37280a2095ef60b4b52f2bc4947676fab6f6a6e5a)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(fcbff7d9105b0bd293020849c807962aa19f1b55))),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(20f5b22dfce8182e8629c3e4debb6af403973fdc4a775b757c2c7005727b7431:0),10000 sats,ECPublicKey(0209cc8cfe539b27946af45cddfd0bb3eb6ac34df462db16f722086543e51bb82c)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(79b90eb7b1cfb9ec3f6673d88c722f6634ff17bc))),UInt32Impl(0)),Vector(Masked(ECPrivateKey)),SIGHASH_ALL(Int32Impl(1))))</span>
<span class="hljs-comment">// utxoInfos: Vector[ScriptSignatureParams[InputInfo]] = Vector(ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(f1a5589bb2c4a3754e7b98f53b2e0510ab7626d7efc1f38b350a9c181d71ea4c:0),10000 sats,ECPublicKey(033237a67abf695e7e7ae8aef37280a2095ef60b4b52f2bc4947676fab6f6a6e5a)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(fcbff7d9105b0bd293020849c807962aa19f1b55))),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(20f5b22dfce8182e8629c3e4debb6af403973fdc4a775b757c2c7005727b7431:0),P2PKHScriptSignature(ECPublicKeyBytes(ByteVector(33 bytes, 0x0209cc8cfe539b27946af45cddfd0bb3eb6ac34df462db16f722086543e51bb82c)), ECDigitalSignature(3044022059c99f2cfc8d6178c2d6a0e8e9b39b9fae10e2c276efb89e5ba719abc5ee57a6022035198f2a0c846ba6af7f4c10e43d51f7f272be330bf0b73736ee077b9a31a0ed01)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(0a6858d1298edef26954228d6dd95c01a408706f)), TransactionOutput(4775 sats,pkh(d55f769cf83b97642d9be4cf2fb7da01b4f4bb75))),UInt32Impl(0))</span>
<span class="hljs-comment">// signedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(f1a5589bb2c4a3754e7b98f53b2e0510ab7626d7efc1f38b350a9c181d71ea4c:0),P2PKHScriptSignature(ECPublicKeyBytes(ByteVector(33 bytes, 0x033237a67abf695e7e7ae8aef37280a2095ef60b4b52f2bc4947676fab6f6a6e5a)), ECDigitalSignature(304402205ceaf046fab95677843bf75531d7f6b20027144d986ff9377df2cc61b73f537902207548b4259d00bac43aefff3808c761dbe09de3558b634ce191d96e15799d0e7501)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(c9bbbb242822829bbc3efebdc666d004d8f53c94)), TransactionOutput(4775 sats,pkh(fd819d52dba5e9468e44d57f0d3494b9fab1c35c))),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 = 020000000131747b7205702c7c755b774adc3f9703f46abbdee4c329862e18e8fc2db2f520000000006a473044022059c99f2cfc8d6178c2d6a0e8e9b39b9fae10e2c276efb89e5ba719abc5ee57a6022035198f2a0c846ba6af7f4c10e43d51f7f272be330bf0b73736ee077b9a31a0ed01210209cc8cfe539b27946af45cddfd0bb3eb6ac34df462db16f722086543e51bb82c000000000288130000000000001976a9140a6858d1298edef26954228d6dd95c01a408706f88aca7120000000000001976a914d55f769cf83b97642d9be4cf2fb7da01b4f4bb7588ac00000000</span>
<span class="hljs-comment">// res4: String = 02000000014cea711d189c0a358bf3c1efd72676ab10052e3bf5987b4e75a3c4b29b58a5f1000000006a47304402205ceaf046fab95677843bf75531d7f6b20027144d986ff9377df2cc61b73f537902207548b4259d00bac43aefff3808c761dbe09de3558b634ce191d96e15799d0e750121033237a67abf695e7e7ae8aef37280a2095ef60b4b52f2bc4947676fab6f6a6e5a000000000288130000000000001976a914c9bbbb242822829bbc3efebdc666d004d8f53c9488aca7120000000000001976a914fd819d52dba5e9468e44d57f0d3494b9fab1c35c88ac00000000</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@5142b95d[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@28af81ae[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(0209cc8cfe539b27946af45cddfd0bb3eb6ac34df462db16f722086543e51bb82c)</span>
<span class="hljs-comment">// pubKey: ECPublicKey = ECPublicKey(033237a67abf695e7e7ae8aef37280a2095ef60b4b52f2bc4947676fab6f6a6e5a)</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(79b90eb7b1cfb9ec3f6673d88c722f6634ff17bc)</span>
<span class="hljs-comment">// creditingSpk: P2PKHScriptPubKey = pkh(fcbff7d9105b0bd293020849c807962aa19f1b55)</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(79b90eb7b1cfb9ec3f6673d88c722f6634ff17bc))</span>
<span class="hljs-comment">// utxo: TransactionOutput = TransactionOutput(10000 sats,pkh(fcbff7d9105b0bd293020849c807962aa19f1b55))</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(0a6858d1298edef26954228d6dd95c01a408706f)</span>
<span class="hljs-comment">// destinationSPK: P2PKHScriptPubKey = pkh(c9bbbb242822829bbc3efebdc666d004d8f53c94)</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(0a6858d1298edef26954228d6dd95c01a408706f)))</span>
<span class="hljs-comment">// destinations: Vector[TransactionOutput] = Vector(TransactionOutput(5000 sats,pkh(c9bbbb242822829bbc3efebdc666d004d8f53c94)))</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(79b90eb7b1cfb9ec3f6673d88c722f6634ff17bc))),UInt32Impl(0))</span>
<span class="hljs-comment">// creditingTx: BaseTransaction = BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(fcbff7d9105b0bd293020849c807962aa19f1b55))),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(20f5b22dfce8182e8629c3e4debb6af403973fdc4a775b757c2c7005727b7431:0)</span>
<span class="hljs-comment">// outPoint: TransactionOutPoint = TransactionOutPoint(f1a5589bb2c4a3754e7b98f53b2e0510ab7626d7efc1f38b350a9c181d71ea4c: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(20f5b22dfce8182e8629c3e4debb6af403973fdc4a775b757c2c7005727b7431:0),EmptyScriptSignature,UInt32Impl(0))</span>
<span class="hljs-comment">// input: TransactionInput = TransactionInputImpl(TransactionOutPoint(f1a5589bb2c4a3754e7b98f53b2e0510ab7626d7efc1f38b350a9c181d71ea4c: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(20f5b22dfce8182e8629c3e4debb6af403973fdc4a775b757c2c7005727b7431:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(0a6858d1298edef26954228d6dd95c01a408706f))),UInt32Impl(0))</span>
<span class="hljs-comment">// builderResult: RawTxBuilderResult = RawTxBuilderResult(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(f1a5589bb2c4a3754e7b98f53b2e0510ab7626d7efc1f38b350a9c181d71ea4c:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(c9bbbb242822829bbc3efebdc666d004d8f53c94))),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(20f5b22dfce8182e8629c3e4debb6af403973fdc4a775b757c2c7005727b7431:0),10000 sats,ECPublicKey(0209cc8cfe539b27946af45cddfd0bb3eb6ac34df462db16f722086543e51bb82c))</span>
<span class="hljs-comment">// inputInfo: P2PKHInputInfo = P2PKHInputInfo(TransactionOutPoint(f1a5589bb2c4a3754e7b98f53b2e0510ab7626d7efc1f38b350a9c181d71ea4c:0),10000 sats,ECPublicKey(033237a67abf695e7e7ae8aef37280a2095ef60b4b52f2bc4947676fab6f6a6e5a))</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(d55f769cf83b97642d9be4cf2fb7da01b4f4bb75)</span>
<span class="hljs-comment">// changeSPK: P2PKHScriptPubKey = pkh(fd819d52dba5e9468e44d57f0d3494b9fab1c35c)</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(20f5b22dfce8182e8629c3e4debb6af403973fdc4a775b757c2c7005727b7431:0),10000 sats,ECPublicKey(0209cc8cfe539b27946af45cddfd0bb3eb6ac34df462db16f722086543e51bb82c))),1 sats/byte,pkh(d55f769cf83b97642d9be4cf2fb7da01b4f4bb75))</span>
<span class="hljs-comment">// finalizer: StandardNonInteractiveFinalizer = StandardNonInteractiveFinalizer(Vector(P2PKHInputInfo(TransactionOutPoint(f1a5589bb2c4a3754e7b98f53b2e0510ab7626d7efc1f38b350a9c181d71ea4c:0),10000 sats,ECPublicKey(033237a67abf695e7e7ae8aef37280a2095ef60b4b52f2bc4947676fab6f6a6e5a))),1 sats/byte,pkh(fd819d52dba5e9468e44d57f0d3494b9fab1c35c))</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(20f5b22dfce8182e8629c3e4debb6af403973fdc4a775b757c2c7005727b7431:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(0a6858d1298edef26954228d6dd95c01a408706f)), TransactionOutput(4775 sats,pkh(d55f769cf83b97642d9be4cf2fb7da01b4f4bb75))),UInt32Impl(0))</span>
<span class="hljs-comment">// unsignedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(f1a5589bb2c4a3754e7b98f53b2e0510ab7626d7efc1f38b350a9c181d71ea4c:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(c9bbbb242822829bbc3efebdc666d004d8f53c94)), TransactionOutput(4775 sats,pkh(fd819d52dba5e9468e44d57f0d3494b9fab1c35c))),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(20f5b22dfce8182e8629c3e4debb6af403973fdc4a775b757c2c7005727b7431:0),10000 sats,ECPublicKey(0209cc8cfe539b27946af45cddfd0bb3eb6ac34df462db16f722086543e51bb82c)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(79b90eb7b1cfb9ec3f6673d88c722f6634ff17bc))),UInt32Impl(0)),Vector(Masked(ECPrivateKey)),SIGHASH_ALL(Int32Impl(1)))</span>
<span class="hljs-comment">// utxoInfo: ScriptSignatureParams[P2PKHInputInfo] = ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(f1a5589bb2c4a3754e7b98f53b2e0510ab7626d7efc1f38b350a9c181d71ea4c:0),10000 sats,ECPublicKey(033237a67abf695e7e7ae8aef37280a2095ef60b4b52f2bc4947676fab6f6a6e5a)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(fcbff7d9105b0bd293020849c807962aa19f1b55))),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(20f5b22dfce8182e8629c3e4debb6af403973fdc4a775b757c2c7005727b7431:0),10000 sats,ECPublicKey(0209cc8cfe539b27946af45cddfd0bb3eb6ac34df462db16f722086543e51bb82c)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(79b90eb7b1cfb9ec3f6673d88c722f6634ff17bc))),UInt32Impl(0)),Vector(Masked(ECPrivateKey)),SIGHASH_ALL(Int32Impl(1))))</span>
<span class="hljs-comment">// utxoInfos: Vector[ScriptSignatureParams[InputInfo]] = Vector(ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(f1a5589bb2c4a3754e7b98f53b2e0510ab7626d7efc1f38b350a9c181d71ea4c:0),10000 sats,ECPublicKey(033237a67abf695e7e7ae8aef37280a2095ef60b4b52f2bc4947676fab6f6a6e5a)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(fcbff7d9105b0bd293020849c807962aa19f1b55))),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(20f5b22dfce8182e8629c3e4debb6af403973fdc4a775b757c2c7005727b7431:0),P2PKHScriptSignature(ECPublicKeyBytes(ByteVector(33 bytes, 0x0209cc8cfe539b27946af45cddfd0bb3eb6ac34df462db16f722086543e51bb82c)), ECDigitalSignature(3044022059c99f2cfc8d6178c2d6a0e8e9b39b9fae10e2c276efb89e5ba719abc5ee57a6022035198f2a0c846ba6af7f4c10e43d51f7f272be330bf0b73736ee077b9a31a0ed01)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(0a6858d1298edef26954228d6dd95c01a408706f)), TransactionOutput(4775 sats,pkh(d55f769cf83b97642d9be4cf2fb7da01b4f4bb75))),UInt32Impl(0))</span>
<span class="hljs-comment">// signedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(f1a5589bb2c4a3754e7b98f53b2e0510ab7626d7efc1f38b350a9c181d71ea4c:0),P2PKHScriptSignature(ECPublicKeyBytes(ByteVector(33 bytes, 0x033237a67abf695e7e7ae8aef37280a2095ef60b4b52f2bc4947676fab6f6a6e5a)), ECDigitalSignature(304402205ceaf046fab95677843bf75531d7f6b20027144d986ff9377df2cc61b73f537902207548b4259d00bac43aefff3808c761dbe09de3558b634ce191d96e15799d0e7501)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(c9bbbb242822829bbc3efebdc666d004d8f53c94)), TransactionOutput(4775 sats,pkh(fd819d52dba5e9468e44d57f0d3494b9fab1c35c))),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 = 020000000131747b7205702c7c755b774adc3f9703f46abbdee4c329862e18e8fc2db2f520000000006a473044022059c99f2cfc8d6178c2d6a0e8e9b39b9fae10e2c276efb89e5ba719abc5ee57a6022035198f2a0c846ba6af7f4c10e43d51f7f272be330bf0b73736ee077b9a31a0ed01210209cc8cfe539b27946af45cddfd0bb3eb6ac34df462db16f722086543e51bb82c000000000288130000000000001976a9140a6858d1298edef26954228d6dd95c01a408706f88aca7120000000000001976a914d55f769cf83b97642d9be4cf2fb7da01b4f4bb7588ac00000000</span>
<span class="hljs-comment">// res4: String = 02000000014cea711d189c0a358bf3c1efd72676ab10052e3bf5987b4e75a3c4b29b58a5f1000000006a47304402205ceaf046fab95677843bf75531d7f6b20027144d986ff9377df2cc61b73f537902207548b4259d00bac43aefff3808c761dbe09de3558b634ce191d96e15799d0e750121033237a67abf695e7e7ae8aef37280a2095ef60b4b52f2bc4947676fab6f6a6e5a000000000288130000000000001976a914c9bbbb242822829bbc3efebdc666d004d8f53c9488aca7120000000000001976a914fd819d52dba5e9468e44d57f0d3494b9fab1c35c88ac00000000</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(304402200827ffd31c27f1d9d6f000cf83435599a885e46ac8fd6352d7923c03a3b0793b022008ca588fb83559d0d5f57835dbac9f9b42b8e28a40101796122e8e28e565b203)</span>
<span class="hljs-comment">// res0: ECDigitalSignature = ECDigitalSignature(3045022100d10287254e8c30a9a4ac7dba7fd4a979fdfc3be3100aa7a2160d7ad07660ff2d02207639a31631989f6683f005b67e01f1272b4fd576d2d3578d8dcd106ccdbb65fc)</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(3045022100dbd4c8326176b8288efb950160343486d82382f12d47402903232f87053bdb6e02206700ede623ff4738db588371b895cf8ad66ca6d738af85f3807710fa3c34a106)</span>
<span class="hljs-comment">// res1: ECDigitalSignature = ECDigitalSignature(304402203c4e5d8d0902e52e79ada7eac576fd4da77b96a1dd6cbefd6aa7fdeec55df287022040652eca69157e72b6ac4bd1daaa59d0758110b862e3b7b72bf6516766121fd6)</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(304402200827ffd31c27f1d9d6f000cf83435599a885e46ac8fd6352d7923c03a3b0793b022008ca588fb83559d0d5f57835dbac9f9b42b8e28a40101796122e8e28e565b203)</span>
<span class="hljs-comment">// res0: ECDigitalSignature = ECDigitalSignature(3045022100d10287254e8c30a9a4ac7dba7fd4a979fdfc3be3100aa7a2160d7ad07660ff2d02207639a31631989f6683f005b67e01f1272b4fd576d2d3578d8dcd106ccdbb65fc)</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(3045022100dbd4c8326176b8288efb950160343486d82382f12d47402903232f87053bdb6e02206700ede623ff4738db588371b895cf8ad66ca6d738af85f3807710fa3c34a106)</span>
<span class="hljs-comment">// res1: ECDigitalSignature = ECDigitalSignature(304402203c4e5d8d0902e52e79ada7eac576fd4da77b96a1dd6cbefd6aa7fdeec55df287022040652eca69157e72b6ac4bd1daaa59d0758110b862e3b7b72bf6516766121fd6)</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-198-aa50ca8d-SNAPSHOT</code>.</p>
recent snapshot published is <code>1.7.0-199-98ceddfc-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-198-aa50ca8d-SNAPSHOT</code>.</p>
recent snapshot published is <code>1.7.0-199-98ceddfc-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, 0xa267557153e3b3d0c79f18e36c4ed69409d82a8c720eca07d2592f8a6357e28f)</span>
<span class="hljs-comment">// entropy: scodec.bits.BitVector = BitVector(256 bits, 0x3852396bfc6a8c0e001e7c70a241b3ac23d5fd0cca318146d2d7d36bafd3e7d6)</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(pen, deny, fox, pond, depth, trick, bunker, toast, toddler, give, remember, chimney, outside, best, crack, dove, skate, direct, north, gallery, plate, program, mechanic, trumpet)</span>
<span class="hljs-comment">// Vector(debate, mushroom, foot, web, potato, alpha, about, sort, idle, bamboo, hollow, flame, diary, write, creek, economy, life, custom, remove, plug, road, try, palm, silver)</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-example6649164052640572306/encrypted-bitcoin-s-seed.json</span>
<span class="hljs-comment">// seedPath: Path = /tmp/key-manager-example8098198886644735888/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-example6649164052640572306/encrypted-bitcoin-s-seed.json,m/84',RegTest)</span>
<span class="hljs-comment">// kmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example8098198886644735888/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@44ffe307)</span>
<span class="hljs-comment">// km: Either[KeyManagerInitializeError, BIP39KeyManager] = Right(org.bitcoins.keymanager.bip39.BIP39KeyManager@46bdc7d1)</span>
<span class="hljs-keyword">val</span> rootXPub = km.right.get.getRootXPub
<span class="hljs-comment">// rootXPub: ExtPublicKey = vpub5SLqN2bLY4WeZv5pGPi3V1VesP73D7yieivyDg3r9YdADcLZpumPcHCWNXXNvcgYEJLwqAEe2XdaEm1hsLChcF6MFS367hKQAJHzF5ZsMbP</span>
<span class="hljs-comment">// rootXPub: ExtPublicKey = vpub5SLqN2bLY4WeZGCK46PPrwm41dD72bbpZHJ5PLxMrSV7XtXnbBcWL3mKWRc4JozDSMdMFaFiGHKmDRuUEY7tHH89Na9r1k8vNfywAUwNStX</span>
println(rootXPub)
<span class="hljs-comment">// vpub5SLqN2bLY4WeZv5pGPi3V1VesP73D7yieivyDg3r9YdADcLZpumPcHCWNXXNvcgYEJLwqAEe2XdaEm1hsLChcF6MFS367hKQAJHzF5ZsMbP</span>
<span class="hljs-comment">// vpub5SLqN2bLY4WeZGCK46PPrwm41dD72bbpZHJ5PLxMrSV7XtXnbBcWL3mKWRc4JozDSMdMFaFiGHKmDRuUEY7tHH89Na9r1k8vNfywAUwNStX</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-example6649164052640572306/encrypted-bitcoin-s-seed.json,m/84',MainNet)</span>
<span class="hljs-comment">// mainnetKmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example8098198886644735888/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@1aea415a</span>
<span class="hljs-comment">// mainnetKeyManager: BIP39KeyManager = org.bitcoins.keymanager.bip39.BIP39KeyManager@2d5dfca5</span>
<span class="hljs-keyword">val</span> mainnetXpub = mainnetKeyManager.getRootXPub
<span class="hljs-comment">// mainnetXpub: ExtPublicKey = zpub6jftahH18ngZy6rHbprYKMsfZFgpybwiKB1rMFdPfa8gS1bUqYRe6Xq4TMMivFJDrrpAq4cssB3mmuTxk7rkoBpkinpnTLbMFCYZoSJKKKo</span>
<span class="hljs-comment">// mainnetXpub: ExtPublicKey = zpub6jftahH18ngZxSxnPXXthJ94hVnto5ZpDjNxWvXuNTzdkHnhbpGkpJPsbFSQJSbu4v6aFUdx6vjxkaMj7KmwUDrYqvwYMPQsTaEWiiCBZGi</span>
println(mainnetXpub)
<span class="hljs-comment">// zpub6jftahH18ngZy6rHbprYKMsfZFgpybwiKB1rMFdPfa8gS1bUqYRe6Xq4TMMivFJDrrpAq4cssB3mmuTxk7rkoBpkinpnTLbMFCYZoSJKKKo</span>
<span class="hljs-comment">// zpub6jftahH18ngZxSxnPXXthJ94hVnto5ZpDjNxWvXuNTzdkHnhbpGkpJPsbFSQJSbu4v6aFUdx6vjxkaMj7KmwUDrYqvwYMPQsTaEWiiCBZGi</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, 0xa267557153e3b3d0c79f18e36c4ed69409d82a8c720eca07d2592f8a6357e28f)</span>
<span class="hljs-comment">// entropy: scodec.bits.BitVector = BitVector(256 bits, 0x3852396bfc6a8c0e001e7c70a241b3ac23d5fd0cca318146d2d7d36bafd3e7d6)</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(pen, deny, fox, pond, depth, trick, bunker, toast, toddler, give, remember, chimney, outside, best, crack, dove, skate, direct, north, gallery, plate, program, mechanic, trumpet)</span>
<span class="hljs-comment">// Vector(debate, mushroom, foot, web, potato, alpha, about, sort, idle, bamboo, hollow, flame, diary, write, creek, economy, life, custom, remove, plug, road, try, palm, silver)</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-example6649164052640572306/encrypted-bitcoin-s-seed.json</span>
<span class="hljs-comment">// seedPath: Path = /tmp/key-manager-example8098198886644735888/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-example6649164052640572306/encrypted-bitcoin-s-seed.json,m/84',RegTest)</span>
<span class="hljs-comment">// kmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example8098198886644735888/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@44ffe307)</span>
<span class="hljs-comment">// km: Either[KeyManagerInitializeError, BIP39KeyManager] = Right(org.bitcoins.keymanager.bip39.BIP39KeyManager@46bdc7d1)</span>
<span class="hljs-keyword">val</span> rootXPub = km.right.get.getRootXPub
<span class="hljs-comment">// rootXPub: ExtPublicKey = vpub5SLqN2bLY4WeZv5pGPi3V1VesP73D7yieivyDg3r9YdADcLZpumPcHCWNXXNvcgYEJLwqAEe2XdaEm1hsLChcF6MFS367hKQAJHzF5ZsMbP</span>
<span class="hljs-comment">// rootXPub: ExtPublicKey = vpub5SLqN2bLY4WeZGCK46PPrwm41dD72bbpZHJ5PLxMrSV7XtXnbBcWL3mKWRc4JozDSMdMFaFiGHKmDRuUEY7tHH89Na9r1k8vNfywAUwNStX</span>
println(rootXPub)
<span class="hljs-comment">// vpub5SLqN2bLY4WeZv5pGPi3V1VesP73D7yieivyDg3r9YdADcLZpumPcHCWNXXNvcgYEJLwqAEe2XdaEm1hsLChcF6MFS367hKQAJHzF5ZsMbP</span>
<span class="hljs-comment">// vpub5SLqN2bLY4WeZGCK46PPrwm41dD72bbpZHJ5PLxMrSV7XtXnbBcWL3mKWRc4JozDSMdMFaFiGHKmDRuUEY7tHH89Na9r1k8vNfywAUwNStX</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-example6649164052640572306/encrypted-bitcoin-s-seed.json,m/84',MainNet)</span>
<span class="hljs-comment">// mainnetKmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example8098198886644735888/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@1aea415a</span>
<span class="hljs-comment">// mainnetKeyManager: BIP39KeyManager = org.bitcoins.keymanager.bip39.BIP39KeyManager@2d5dfca5</span>
<span class="hljs-keyword">val</span> mainnetXpub = mainnetKeyManager.getRootXPub
<span class="hljs-comment">// mainnetXpub: ExtPublicKey = zpub6jftahH18ngZy6rHbprYKMsfZFgpybwiKB1rMFdPfa8gS1bUqYRe6Xq4TMMivFJDrrpAq4cssB3mmuTxk7rkoBpkinpnTLbMFCYZoSJKKKo</span>
<span class="hljs-comment">// mainnetXpub: ExtPublicKey = zpub6jftahH18ngZxSxnPXXthJ94hVnto5ZpDjNxWvXuNTzdkHnhbpGkpJPsbFSQJSbu4v6aFUdx6vjxkaMj7KmwUDrYqvwYMPQsTaEWiiCBZGi</span>
println(mainnetXpub)
<span class="hljs-comment">// zpub6jftahH18ngZy6rHbprYKMsfZFgpybwiKB1rMFdPfa8gS1bUqYRe6Xq4TMMivFJDrrpAq4cssB3mmuTxk7rkoBpkinpnTLbMFCYZoSJKKKo</span>
<span class="hljs-comment">// zpub6jftahH18ngZxSxnPXXthJ94hVnto5ZpDjNxWvXuNTzdkHnhbpGkpJPsbFSQJSbu4v6aFUdx6vjxkaMj7KmwUDrYqvwYMPQsTaEWiiCBZGi</span>
</code></pre>
<p>Which gives us something that looks like this</p>
<p><code>zpub6jftahH18ngZw98KGjRo5XcxeKTQ2eztsvskb1dC9XF5TLimQquTs6Ry7nBBA425D9joXmfgJJCexmJ1u2SELJZJfRi95gcnXadLpZzYb5c</code></p>

12
docs/next/rpc/lnd-rpc.html
View file

@ -63,14 +63,14 @@
}
});
</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/rpc/lnd.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">LND</h1></header><article><div><span><p>This is an RPC client for <a href="https://github.com/LightningNetwork/lnd">LND</a>. It assumes that a bitcoind instance is running.</p>
<p>Currently, this RPC client is written for <a href="https://github.com/lightningnetwork/lnd/releases/tag/v0.13.1-beta">v0.13.1</a> version of LND.</p>
<p>Currently, this RPC client is written for <a href="https://github.com/lightningnetwork/lnd/releases/tag/v0.13.3-beta">v0.13.3</a> version of LND.</p>
<h2><a class="anchor" aria-hidden="true" id="configuration-of-lnd"></a><a href="#configuration-of-lnd" 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>Configuration of LND</h2>
<p>Please see the <a href="https://github.com/lightningnetwork/lnd/blob/v0.13.1-beta/sample-lnd.conf">sample configuration for LND</a>.</p>
<p>Please see the <a href="https://github.com/lightningnetwork/lnd/blob/v0.13.3-beta/sample-lnd.conf">sample configuration for LND</a>.</p>
<p>You can find the configuration we use for our testing infrastructure for lnd <a href="https://github.com/bitcoin-s/bitcoin-s/blob/656e0928bf1bf4f511f60dec625699b454f29a1f/testkit/src/main/scala/org/bitcoins/testkit/lnd/LndRpcTestUtil.scala#L90">here</a>.</p>
<h2><a class="anchor" aria-hidden="true" id="starting-lnd"></a><a href="#starting-lnd" 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>Starting LND</h2>
<p>You need to download the binaries from the <a href="https://github.com/lightningnetwork/lnd/releases/tag/v0.13.1-beta">LND's github</a>.</p>
<p>To run lnd by unzipping the <code>lnd-linux-amd64-v0.13.1-beta.tar.gz</code> (or whichever platform you are on) and then running</p>
<pre><code class="hljs css language-bash">$ ./lnd-linux-amd64-v0.13.1-beta/lnd
<p>You need to download the binaries from the <a href="https://github.com/lightningnetwork/lnd/releases/tag/v0.13.3-beta">LND's github</a>.</p>
<p>To run lnd by unzipping the <code>lnd-linux-amd64-v0.13.3-beta.tar.gz</code> (or whichever platform you are on) and then running</p>
<pre><code class="hljs css language-bash">$ ./lnd-linux-amd64-v0.13.3-beta/lnd
</code></pre>
<p>If you wish to start lnd from the RPC client, you can construct a <a href="https://github.com/bitcoin-s/bitcoin-s/blob/656e0928bf1bf4f511f60dec625699b454f29a1f/lnd-rpc/src/main/scala/org/bitcoins/lnd/rpc/LndRpcClient.scala#L35"><code>LndRpcClient.binary</code></a> field set</p>
<p>We will default to using the <code>binary</code> field first when trying to start the jar, and the fallback to the default datadir (<code>~/.lnd</code>).</p>
@ -79,7 +79,7 @@
<span class="hljs-keyword">implicit</span> <span class="hljs-keyword">val</span> ec = system.dispatcher
<span class="hljs-keyword">val</span> datadirPath = <span class="hljs-type">Paths</span>.get(<span class="hljs-string">"path"</span>, <span class="hljs-string">"to"</span>, <span class="hljs-string">"datadir"</span>)
<span class="hljs-keyword">val</span> binaryPath = <span class="hljs-type">Paths</span>.get(<span class="hljs-string">"path"</span>, <span class="hljs-string">"to"</span>, <span class="hljs-string">"lnd-linux-amd64-v0.13.1-beta"</span>, <span class="hljs-string">"lnd"</span>)
<span class="hljs-keyword">val</span> binaryPath = <span class="hljs-type">Paths</span>.get(<span class="hljs-string">"path"</span>, <span class="hljs-string">"to"</span>, <span class="hljs-string">"lnd-linux-amd64-v0.13.3-beta"</span>, <span class="hljs-string">"lnd"</span>)
<span class="hljs-keyword">val</span> instance = <span class="hljs-type">LndInstanceLocal</span>.fromDataDir(datadirPath.toFile)
<span class="hljs-keyword">val</span> client = <span class="hljs-keyword">new</span> <span class="hljs-type">LndRpcClient</span>(instance, <span class="hljs-type">Some</span>(binaryPath.toFile))

12
docs/next/rpc/lnd-rpc/index.html
View file

@ -63,14 +63,14 @@
}
});
</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/rpc/lnd.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">LND</h1></header><article><div><span><p>This is an RPC client for <a href="https://github.com/LightningNetwork/lnd">LND</a>. It assumes that a bitcoind instance is running.</p>
<p>Currently, this RPC client is written for <a href="https://github.com/lightningnetwork/lnd/releases/tag/v0.13.1-beta">v0.13.1</a> version of LND.</p>
<p>Currently, this RPC client is written for <a href="https://github.com/lightningnetwork/lnd/releases/tag/v0.13.3-beta">v0.13.3</a> version of LND.</p>
<h2><a class="anchor" aria-hidden="true" id="configuration-of-lnd"></a><a href="#configuration-of-lnd" 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>Configuration of LND</h2>
<p>Please see the <a href="https://github.com/lightningnetwork/lnd/blob/v0.13.1-beta/sample-lnd.conf">sample configuration for LND</a>.</p>
<p>Please see the <a href="https://github.com/lightningnetwork/lnd/blob/v0.13.3-beta/sample-lnd.conf">sample configuration for LND</a>.</p>
<p>You can find the configuration we use for our testing infrastructure for lnd <a href="https://github.com/bitcoin-s/bitcoin-s/blob/656e0928bf1bf4f511f60dec625699b454f29a1f/testkit/src/main/scala/org/bitcoins/testkit/lnd/LndRpcTestUtil.scala#L90">here</a>.</p>
<h2><a class="anchor" aria-hidden="true" id="starting-lnd"></a><a href="#starting-lnd" 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>Starting LND</h2>
<p>You need to download the binaries from the <a href="https://github.com/lightningnetwork/lnd/releases/tag/v0.13.1-beta">LND's github</a>.</p>
<p>To run lnd by unzipping the <code>lnd-linux-amd64-v0.13.1-beta.tar.gz</code> (or whichever platform you are on) and then running</p>
<pre><code class="hljs css language-bash">$ ./lnd-linux-amd64-v0.13.1-beta/lnd
<p>You need to download the binaries from the <a href="https://github.com/lightningnetwork/lnd/releases/tag/v0.13.3-beta">LND's github</a>.</p>
<p>To run lnd by unzipping the <code>lnd-linux-amd64-v0.13.3-beta.tar.gz</code> (or whichever platform you are on) and then running</p>
<pre><code class="hljs css language-bash">$ ./lnd-linux-amd64-v0.13.3-beta/lnd
</code></pre>
<p>If you wish to start lnd from the RPC client, you can construct a <a href="https://github.com/bitcoin-s/bitcoin-s/blob/656e0928bf1bf4f511f60dec625699b454f29a1f/lnd-rpc/src/main/scala/org/bitcoins/lnd/rpc/LndRpcClient.scala#L35"><code>LndRpcClient.binary</code></a> field set</p>
<p>We will default to using the <code>binary</code> field first when trying to start the jar, and the fallback to the default datadir (<code>~/.lnd</code>).</p>
@ -79,7 +79,7 @@
<span class="hljs-keyword">implicit</span> <span class="hljs-keyword">val</span> ec = system.dispatcher
<span class="hljs-keyword">val</span> datadirPath = <span class="hljs-type">Paths</span>.get(<span class="hljs-string">"path"</span>, <span class="hljs-string">"to"</span>, <span class="hljs-string">"datadir"</span>)
<span class="hljs-keyword">val</span> binaryPath = <span class="hljs-type">Paths</span>.get(<span class="hljs-string">"path"</span>, <span class="hljs-string">"to"</span>, <span class="hljs-string">"lnd-linux-amd64-v0.13.1-beta"</span>, <span class="hljs-string">"lnd"</span>)
<span class="hljs-keyword">val</span> binaryPath = <span class="hljs-type">Paths</span>.get(<span class="hljs-string">"path"</span>, <span class="hljs-string">"to"</span>, <span class="hljs-string">"lnd-linux-amd64-v0.13.3-beta"</span>, <span class="hljs-string">"lnd"</span>)
<span class="hljs-keyword">val</span> instance = <span class="hljs-type">LndInstanceLocal</span>.fromDataDir(datadirPath.toFile)
<span class="hljs-keyword">val</span> client = <span class="hljs-keyword">new</span> <span class="hljs-type">LndRpcClient</span>(instance, <span class="hljs-type">Some</span>(binaryPath.toFile))

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(02c997cdfbdf8b8a1f2e7e123fc9841a4f0996caf25d9e1c9d063d5642b82a634c)</span>
<span class="hljs-comment">// publicKey: ECPublicKey = ECPublicKey(038585afe6ac1622047a95f9f66b0b2072955ffbf597b15cfa1933864d296f2ed2)</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(304402200f2f757f599e2f5c3928c36448331d16c18112b2a9046457b877b815a32406c5022046d9d0e8d21b1b7361d529b2ed4283b8faab60ab8b2ad13a42bf2839876fdd94)</span>
<span class="hljs-comment">// signature: ECDigitalSignature = ECDigitalSignature(3045022100a985bd1c0b9a7a732dcb22fc6dd34b10ee474c25080026cdd271933c1bdd0abe022013219951df74e411ae35eef52cd4e2cfb2da514bb6d4b663eefe9a99f0fd0ae5)</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(02c997cdfbdf8b8a1f2e7e123fc9841a4f0996caf25d9e1c9d063d5642b82a634c)</span>
<span class="hljs-comment">// publicKey: ECPublicKey = ECPublicKey(038585afe6ac1622047a95f9f66b0b2072955ffbf597b15cfa1933864d296f2ed2)</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(304402200f2f757f599e2f5c3928c36448331d16c18112b2a9046457b877b815a32406c5022046d9d0e8d21b1b7361d529b2ed4283b8faab60ab8b2ad13a42bf2839876fdd94)</span>
<span class="hljs-comment">// signature: ECDigitalSignature = ECDigitalSignature(3045022100a985bd1c0b9a7a732dcb22fc6dd34b10ee474c25080026cdd271933c1bdd0abe022013219951df74e411ae35eef52cd4e2cfb2da514bb6d4b663eefe9a99f0fd0ae5)</span>
<span class="hljs-comment">// calls bouncy castle indirectly via CryptoContext</span>
<span class="hljs-keyword">val</span> verified = publicKey.verify(dataToSign.bytes, signature)