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

Deploy website

Browse source 
Deploy website version based on c91f81bdbf
This commit is contained in:
Docusaurus bot 2021-01-22 22:38:45 +00:00
parent 7735fdad86
commit 9ec0075c97
18 changed files with 242 additions and 266 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
docs/next/applications/server.html
View file

@ -162,6 +162,7 @@ WantedBy=multi-user.target
<li><code>--ignorecreationtime</code> - Ignores the wallet creation date and will instead do a full rescan</li>
</ul></li>
<li><code>isempty</code> - Checks if the wallet contains any data</li>
<li><code>walletinfo</code> - Returns data about the current wallet being used</li>
<li><code>getbalance</code> <code>[options]</code> - Get the wallet balance
<ul>
<li><code>--sats</code> - Display balance in satoshis</li>

1
docs/next/applications/server/index.html
View file

@ -162,6 +162,7 @@ WantedBy=multi-user.target
<li><code>--ignorecreationtime</code> - Ignores the wallet creation date and will instead do a full rescan</li>
</ul></li>
<li><code>isempty</code> - Checks if the wallet contains any data</li>
<li><code>walletinfo</code> - Returns data about the current wallet being used</li>
<li><code>getbalance</code> <code>[options]</code> - Get the wallet balance
<ul>
<li><code>--sats</code> - Display balance in satoshis</li>

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

@ -80,7 +80,7 @@ reason to keep using legacy transaction formats.</p>
<span class="hljs-keyword">val</span> privkey = <span class="hljs-type">ECPrivateKey</span>()
<span class="hljs-comment">// privkey: ECPrivateKey = Masked(ECPrivateKeyImpl)</span>
<span class="hljs-keyword">val</span> pubkey = privkey.publicKey
<span class="hljs-comment">// pubkey: org.bitcoins.crypto.ECPublicKey = ECPublicKey(0276c31ad23b01edac1dcb7faeb5d17e1926cd1a35f1f4d2df6951c458cbf0de2e)</span>
<span class="hljs-comment">// pubkey: org.bitcoins.crypto.ECPublicKey = ECPublicKey(02f48d6c1477b800e61183c4abbfbf8b978108e71a2f087d29bd9a9e74dda00796)</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 = tb1qyc2t6h7jkxrdp960utsu4pp3fwm00qam2z594k</span>
<span class="hljs-comment">// segwitAddress: Bech32Address = tb1qzxl7pxxwg8lvv8z064qkufhd6x3rzgh3nuhwcp</span>
println(segwitAddress.toString)
<span class="hljs-comment">// tb1qyc2t6h7jkxrdp960utsu4pp3fwm00qam2z594k</span>
<span class="hljs-comment">// tb1qzxl7pxxwg8lvv8z064qkufhd6x3rzgh3nuhwcp</span>
</code></pre>
<h2><a class="anchor" aria-hidden="true" id="generating-legacy-base58-addresses"></a><a href="#generating-legacy-base58-addresses" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Generating legacy (base58) addresses</h2>
<p>If you need to generate legacy addresses for backwards
@ -101,10 +101,10 @@ Take a look:</p>
<pre><code class="hljs css language-scala"><span class="hljs-comment">// we&#x27;re reusing the same private/public key pair</span>
<span class="hljs-comment">// from before. don&#x27;t do this in an actual application!</span>
<span class="hljs-keyword">val</span> legacyAddress = <span class="hljs-type">P2PKHAddress</span>(pubkey, <span class="hljs-type">TestNet3</span>)
<span class="hljs-comment">// legacyAddress: P2PKHAddress = mizJpNCBmuTjViQLiEJbDycqR1QxCxBYNe</span>
<span class="hljs-comment">// legacyAddress: P2PKHAddress = mh8oeBjVoRHDPxQyJaZHP1cVwFRFAaHTSw</span>
println(legacyAddress.toString)
<span class="hljs-comment">// mizJpNCBmuTjViQLiEJbDycqR1QxCxBYNe</span>
<span class="hljs-comment">// mh8oeBjVoRHDPxQyJaZHP1cVwFRFAaHTSw</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(ECPrivateKeyImpl)</span>
<span class="hljs-keyword">val</span> pubkey = privkey.publicKey
<span class="hljs-comment">// pubkey: org.bitcoins.crypto.ECPublicKey = ECPublicKey(0276c31ad23b01edac1dcb7faeb5d17e1926cd1a35f1f4d2df6951c458cbf0de2e)</span>
<span class="hljs-comment">// pubkey: org.bitcoins.crypto.ECPublicKey = ECPublicKey(02f48d6c1477b800e61183c4abbfbf8b978108e71a2f087d29bd9a9e74dda00796)</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 = tb1qyc2t6h7jkxrdp960utsu4pp3fwm00qam2z594k</span>
<span class="hljs-comment">// segwitAddress: Bech32Address = tb1qzxl7pxxwg8lvv8z064qkufhd6x3rzgh3nuhwcp</span>
println(segwitAddress.toString)
<span class="hljs-comment">// tb1qyc2t6h7jkxrdp960utsu4pp3fwm00qam2z594k</span>
<span class="hljs-comment">// tb1qzxl7pxxwg8lvv8z064qkufhd6x3rzgh3nuhwcp</span>
</code></pre>
<h2><a class="anchor" aria-hidden="true" id="generating-legacy-base58-addresses"></a><a href="#generating-legacy-base58-addresses" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Generating legacy (base58) addresses</h2>
<p>If you need to generate legacy addresses for backwards
@ -101,10 +101,10 @@ Take a look:</p>
<pre><code class="hljs css language-scala"><span class="hljs-comment">// we&#x27;re reusing the same private/public key pair</span>
<span class="hljs-comment">// from before. don&#x27;t do this in an actual application!</span>
<span class="hljs-keyword">val</span> legacyAddress = <span class="hljs-type">P2PKHAddress</span>(pubkey, <span class="hljs-type">TestNet3</span>)
<span class="hljs-comment">// legacyAddress: P2PKHAddress = mizJpNCBmuTjViQLiEJbDycqR1QxCxBYNe</span>
<span class="hljs-comment">// legacyAddress: P2PKHAddress = mh8oeBjVoRHDPxQyJaZHP1cVwFRFAaHTSw</span>
println(legacyAddress.toString)
<span class="hljs-comment">// mizJpNCBmuTjViQLiEJbDycqR1QxCxBYNe</span>
<span class="hljs-comment">// mh8oeBjVoRHDPxQyJaZHP1cVwFRFAaHTSw</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) {

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, 0x2c2841b786451cd68ed167312027771027ab5ca5cf359527301ce8fa02d16874)</span>
<span class="hljs-comment">// entropy: BitVector = BitVector(256 bits, 0x8afd2ae680ce75da8f276085d56ee882cd598ac7502e775bc9b4d2e8c8336311)</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(club, dragon, hospital, arrive, fade, hero, deputy, coconut, couple, abuse, tape, cake, kingdom, purity, now, trade, news, define, already, spin, parent, hamster, peace, notable) // the phrase the user should write down</span>
<span class="hljs-comment">// res0: Vector[String] = Vector(memory, true, rifle, account, trap, unhappy, develop, ugly, magic, problem, riot, airport, stereo, shell, bubble, alarm, jar, tattoo, honey, place, milk, boost, middle, ceiling) // 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 = zpub6jftahH18ngZxeJozLMVje1jT3iaSa3YBMnNmMT4eVSp4c56ri22Gkxkgcu1GE1XmkH6mDESneYaqnCCommH7cWwJiB2KM4oyWq4y5CUrS8</span>
<span class="hljs-comment">// xpub: ExtPublicKey = zpub6jftahH18ngZyWq5vNFAeSw1Yb7H5VE6kupP9hycj9SLaDMFGC5SNMgiAarfxahPMpm7ExyKyzciaPwGsHL85nFY7fpptnd1X3Nnvj4FW6p</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 = zpub6rWJaNZtTaGzNFKgMTdmQFL6KRnYqEZ9xkkkbUtD67Q47WBDoqsrPyvXLkfG7tCvk4Dhw7oEwcDeQTaC8MLx3Mp9ta6R2yK9rfJdRFxB8uF</span>
<span class="hljs-comment">// accountXpub: ExtPublicKey = zpub6qoGKvnVHsnoj6MnzHXCHrVnYTjTov8KrmSQFyY9YfD35Gqj42gt7ABcwNkGhJZN59RNhq1qw4VBLug7QVd7gp73cg5ZsGxbtt4xL5BFUG2</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 = tb1q0fr2u0k27wzsaln4xysk4jpx9hvp98vgpucq27</span>
<span class="hljs-comment">// firstAccountAddress: Bech32Address = tb1qwjfjcy27n7gsujs9p3wxutmhya26upz7nmmek2</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 = tb1q0fr2u0k27wzsaln4xysk4jpx9hvp98vgpucq27</span>
<span class="hljs-comment">// res2: String = tb1qwjfjcy27n7gsujs9p3wxutmhya26upz7nmmek2</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, 0x2c2841b786451cd68ed167312027771027ab5ca5cf359527301ce8fa02d16874)</span>
<span class="hljs-comment">// entropy: BitVector = BitVector(256 bits, 0x8afd2ae680ce75da8f276085d56ee882cd598ac7502e775bc9b4d2e8c8336311)</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(club, dragon, hospital, arrive, fade, hero, deputy, coconut, couple, abuse, tape, cake, kingdom, purity, now, trade, news, define, already, spin, parent, hamster, peace, notable) // the phrase the user should write down</span>
<span class="hljs-comment">// res0: Vector[String] = Vector(memory, true, rifle, account, trap, unhappy, develop, ugly, magic, problem, riot, airport, stereo, shell, bubble, alarm, jar, tattoo, honey, place, milk, boost, middle, ceiling) // 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 = zpub6jftahH18ngZxeJozLMVje1jT3iaSa3YBMnNmMT4eVSp4c56ri22Gkxkgcu1GE1XmkH6mDESneYaqnCCommH7cWwJiB2KM4oyWq4y5CUrS8</span>
<span class="hljs-comment">// xpub: ExtPublicKey = zpub6jftahH18ngZyWq5vNFAeSw1Yb7H5VE6kupP9hycj9SLaDMFGC5SNMgiAarfxahPMpm7ExyKyzciaPwGsHL85nFY7fpptnd1X3Nnvj4FW6p</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 = zpub6rWJaNZtTaGzNFKgMTdmQFL6KRnYqEZ9xkkkbUtD67Q47WBDoqsrPyvXLkfG7tCvk4Dhw7oEwcDeQTaC8MLx3Mp9ta6R2yK9rfJdRFxB8uF</span>
<span class="hljs-comment">// accountXpub: ExtPublicKey = zpub6qoGKvnVHsnoj6MnzHXCHrVnYTjTov8KrmSQFyY9YfD35Gqj42gt7ABcwNkGhJZN59RNhq1qw4VBLug7QVd7gp73cg5ZsGxbtt4xL5BFUG2</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 = tb1q0fr2u0k27wzsaln4xysk4jpx9hvp98vgpucq27</span>
<span class="hljs-comment">// firstAccountAddress: Bech32Address = tb1qwjfjcy27n7gsujs9p3wxutmhya26upz7nmmek2</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 = tb1q0fr2u0k27wzsaln4xysk4jpx9hvp98vgpucq27</span>
<span class="hljs-comment">// res2: String = tb1qwjfjcy27n7gsujs9p3wxutmhya26upz7nmmek2</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@76f8ef53[Running, parallelism = 2, size = 2, active = 0, running = 0, steals = 33, tasks = 0, submissions = 0]</span>
<span class="hljs-comment">// ec: ExecutionContext = scala.concurrent.impl.ExecutionContextImpl$$anon$3@50b1bcf6[Running, parallelism = 2, size = 2, active = 0, running = 0, steals = 33, tasks = 0, submissions = 0]</span>
<span class="hljs-comment">// Initialize a transaction builder</span>
<span class="hljs-keyword">val</span> builder = <span class="hljs-type">RawTxBuilder</span>()
@ -74,19 +74,19 @@
<span class="hljs-keyword">val</span> privKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey
<span class="hljs-comment">// privKey: ECPrivateKey = Masked(ECPrivateKeyImpl)</span>
<span class="hljs-keyword">val</span> pubKey = privKey.publicKey
<span class="hljs-comment">// pubKey: ECPublicKey = ECPublicKey(02bc5adef2901a23f3e4cd42eb76c05fa2a7e5de4b29c0c61b258a5e91bacf98f0)</span>
<span class="hljs-comment">// pubKey: ECPublicKey = ECPublicKey(03d65032c40d502b4c8d79d1fb618f4cf0ccc595e05c45183551e9766c63e1469b)</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(35c10f69b3aa30bc53f24c01d7a488913f7ec86a)</span>
<span class="hljs-comment">// creditingSpk: P2PKHScriptPubKey = pkh(37a7d3a84b9938051bb346712bc38683f1d30dfe)</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(35c10f69b3aa30bc53f24c01d7a488913f7ec86a))</span>
<span class="hljs-comment">// utxo: TransactionOutput = TransactionOutput(10000 sats,pkh(37a7d3a84b9938051bb346712bc38683f1d30dfe))</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(edbbcc841b0e400198022e7d9e00726cbb47f0f5)</span>
<span class="hljs-comment">// destinationSPK: P2PKHScriptPubKey = pkh(6b8a6a107a3f6fcdba050274cc2b69395b99dad7)</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(edbbcc841b0e400198022e7d9e00726cbb47f0f5)))</span>
<span class="hljs-comment">// destinations: Vector[TransactionOutput] = Vector(TransactionOutput(5000 sats,pkh(6b8a6a107a3f6fcdba050274cc2b69395b99dad7)))</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(35c10f69b3aa30bc53f24c01d7a488913f7ec86a))),UInt32Impl(0))</span>
<span class="hljs-comment">// creditingTx: BaseTransaction = BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(37a7d3a84b9938051bb346712bc38683f1d30dfe))),UInt32Impl(0))</span>
<span class="hljs-comment">// this is the information we need from the crediting TX</span>
<span class="hljs-comment">// to properly &quot;link&quot; it in the transaction we are creating</span>
<span class="hljs-keyword">val</span> outPoint = <span class="hljs-type">TransactionOutPoint</span>(creditingTx.txId, <span class="hljs-type">UInt32</span>.zero)
<span class="hljs-comment">// outPoint: TransactionOutPoint = TransactionOutPoint(656694f6bc37fbd35add04aaec2d236c19f32c2312ac91ce5617eeee168a4f5d:0)</span>
<span class="hljs-comment">// outPoint: TransactionOutPoint = TransactionOutPoint(be0947693ba94f7891257d1eb432ea6433548efebd94f6341965f32afe0f6307: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(656694f6bc37fbd35add04aaec2d236c19f32c2312ac91ce5617eeee168a4f5d:0),EmptyScriptSignature,UInt32Impl(0))</span>
<span class="hljs-comment">// input: TransactionInput = TransactionInputImpl(TransactionOutPoint(be0947693ba94f7891257d1eb432ea6433548efebd94f6341965f32afe0f6307: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(656694f6bc37fbd35add04aaec2d236c19f32c2312ac91ce5617eeee168a4f5d:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(edbbcc841b0e400198022e7d9e00726cbb47f0f5))),UInt32Impl(0))</span>
<span class="hljs-comment">// builderResult: RawTxBuilderResult = RawTxBuilderResult(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(be0947693ba94f7891257d1eb432ea6433548efebd94f6341965f32afe0f6307:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(6b8a6a107a3f6fcdba050274cc2b69395b99dad7))),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(656694f6bc37fbd35add04aaec2d236c19f32c2312ac91ce5617eeee168a4f5d:0),10000 sats,ECPublicKey(02bc5adef2901a23f3e4cd42eb76c05fa2a7e5de4b29c0c61b258a5e91bacf98f0))</span>
<span class="hljs-comment">// inputInfo: P2PKHInputInfo = P2PKHInputInfo(TransactionOutPoint(be0947693ba94f7891257d1eb432ea6433548efebd94f6341965f32afe0f6307:0),10000 sats,ECPublicKey(03d65032c40d502b4c8d79d1fb618f4cf0ccc595e05c45183551e9766c63e1469b))</span>
<span class="hljs-comment">// this is how much we are going to pay as a fee to the network</span>
<span class="hljs-comment">// for this example, we are going to pay 1 satoshi per byte</span>
@ -155,18 +155,18 @@ builder += input
<span class="hljs-keyword">val</span> changePrivKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey
<span class="hljs-comment">// changePrivKey: ECPrivateKey = Masked(ECPrivateKeyImpl)</span>
<span class="hljs-keyword">val</span> changeSPK = <span class="hljs-type">P2PKHScriptPubKey</span>(pubKey = changePrivKey.publicKey)
<span class="hljs-comment">// changeSPK: P2PKHScriptPubKey = pkh(62e8aa06c4cab66e65df63b96ecc9cbb61c80c67)</span>
<span class="hljs-comment">// changeSPK: P2PKHScriptPubKey = pkh(30059ff45079c238787c70fb9e825efaacbdbf91)</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(656694f6bc37fbd35add04aaec2d236c19f32c2312ac91ce5617eeee168a4f5d:0),10000 sats,ECPublicKey(02bc5adef2901a23f3e4cd42eb76c05fa2a7e5de4b29c0c61b258a5e91bacf98f0))),1 sats/byte,pkh(62e8aa06c4cab66e65df63b96ecc9cbb61c80c67))</span>
<span class="hljs-comment">// finalizer: StandardNonInteractiveFinalizer = StandardNonInteractiveFinalizer(Vector(P2PKHInputInfo(TransactionOutPoint(be0947693ba94f7891257d1eb432ea6433548efebd94f6341965f32afe0f6307:0),10000 sats,ECPublicKey(03d65032c40d502b4c8d79d1fb618f4cf0ccc595e05c45183551e9766c63e1469b))),1 sats/byte,pkh(30059ff45079c238787c70fb9e825efaacbdbf91))</span>
<span class="hljs-comment">// We can now finalize the tx builder result from earlier with this finalizer</span>
<span class="hljs-keyword">val</span> unsignedTxF: <span class="hljs-type">Future</span>[<span class="hljs-type">Transaction</span>] = finalizer.buildTx(builderResult)
<span class="hljs-comment">// unsignedTxF: Future[Transaction] = Future(Success(BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(656694f6bc37fbd35add04aaec2d236c19f32c2312ac91ce5617eeee168a4f5d:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(edbbcc841b0e400198022e7d9e00726cbb47f0f5)), TransactionOutput(4775 sats,pkh(62e8aa06c4cab66e65df63b96ecc9cbb61c80c67))),UInt32Impl(0))))</span>
<span class="hljs-comment">// unsignedTxF: Future[Transaction] = Future(Success(BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(be0947693ba94f7891257d1eb432ea6433548efebd94f6341965f32afe0f6307:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(6b8a6a107a3f6fcdba050274cc2b69395b99dad7)), TransactionOutput(4775 sats,pkh(30059ff45079c238787c70fb9e825efaacbdbf91))),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(656694f6bc37fbd35add04aaec2d236c19f32c2312ac91ce5617eeee168a4f5d:0),10000 sats,ECPublicKey(02bc5adef2901a23f3e4cd42eb76c05fa2a7e5de4b29c0c61b258a5e91bacf98f0)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(35c10f69b3aa30bc53f24c01d7a488913f7ec86a))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1)))</span>
<span class="hljs-comment">// utxoInfo: ScriptSignatureParams[P2PKHInputInfo] = ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(be0947693ba94f7891257d1eb432ea6433548efebd94f6341965f32afe0f6307:0),10000 sats,ECPublicKey(03d65032c40d502b4c8d79d1fb618f4cf0ccc595e05c45183551e9766c63e1469b)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(37a7d3a84b9938051bb346712bc38683f1d30dfe))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1)))</span>
<span class="hljs-comment">// all of the UTXO spending information, since we only have</span>
<span class="hljs-comment">// one input, this is just one element</span>
<span class="hljs-keyword">val</span> utxoInfos: <span class="hljs-type">Vector</span>[<span class="hljs-type">ScriptSignatureParams</span>[<span class="hljs-type">InputInfo</span>]] = <span class="hljs-type">Vector</span>(utxoInfo)
<span class="hljs-comment">// utxoInfos: Vector[ScriptSignatureParams[InputInfo]] = Vector(ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(656694f6bc37fbd35add04aaec2d236c19f32c2312ac91ce5617eeee168a4f5d:0),10000 sats,ECPublicKey(02bc5adef2901a23f3e4cd42eb76c05fa2a7e5de4b29c0c61b258a5e91bacf98f0)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(35c10f69b3aa30bc53f24c01d7a488913f7ec86a))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1))))</span>
<span class="hljs-comment">// utxoInfos: Vector[ScriptSignatureParams[InputInfo]] = Vector(ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(be0947693ba94f7891257d1eb432ea6433548efebd94f6341965f32afe0f6307:0),10000 sats,ECPublicKey(03d65032c40d502b4c8d79d1fb618f4cf0ccc595e05c45183551e9766c63e1469b)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(37a7d3a84b9938051bb346712bc38683f1d30dfe))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1))))</span>
<span class="hljs-comment">// Yay! Now we use the RawTxSigner object to sign the tx.</span>
<span class="hljs-comment">// The &#x27;sign&#x27; method is going produce a validly signed transaction</span>
@ -201,7 +201,7 @@ builder += input
}
<span class="hljs-type">Await</span>.result(signedTxF, <span class="hljs-number">30.</span>seconds)
}
<span class="hljs-comment">// signedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(656694f6bc37fbd35add04aaec2d236c19f32c2312ac91ce5617eeee168a4f5d:0),P2PKHScriptSignature(ECPublicKey(02bc5adef2901a23f3e4cd42eb76c05fa2a7e5de4b29c0c61b258a5e91bacf98f0), ECDigitalSignature(304402204f63ada08696341ed57707379a818fa48b89e5d055c05b3203207f0a2e8940dc02206e21e4c9727992be72bc199f2a4e744fb4ab97b6af49bf758fc3d2547e531b8f01)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(edbbcc841b0e400198022e7d9e00726cbb47f0f5)), TransactionOutput(4775 sats,pkh(62e8aa06c4cab66e65df63b96ecc9cbb61c80c67))),UInt32Impl(0))</span>
<span class="hljs-comment">// signedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(be0947693ba94f7891257d1eb432ea6433548efebd94f6341965f32afe0f6307:0),P2PKHScriptSignature(ECPublicKey(03d65032c40d502b4c8d79d1fb618f4cf0ccc595e05c45183551e9766c63e1469b), ECDigitalSignature(304402205d727ac145d4ec937158f76afa65fbe45d5b005947b6dcc0f1ff7f2bf7cb3659022030031c039357534869eaccb016c6796e794e8d25ef2daa42e85a4e9e5342496401)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(6b8a6a107a3f6fcdba050274cc2b69395b99dad7)), TransactionOutput(4775 sats,pkh(30059ff45079c238787c70fb9e825efaacbdbf91))),UInt32Impl(0))</span>
</code></pre>
<pre><code class="hljs css language-scala">signedTx.inputs.length
<span class="hljs-comment">// res2: Int = 1</span>
@ -211,7 +211,7 @@ signedTx.outputs.length
<span class="hljs-comment">//remember, you can call .hex on any bitcoin-s data structure to get the hex representation!</span>
signedTx.hex
<span class="hljs-comment">// res4: String = 02000000015d4f8a16eeee1756ce91ac12232cf3196c232decaa04dd5ad3fb37bcf6946665000000006a47304402204f63ada08696341ed57707379a818fa48b89e5d055c05b3203207f0a2e8940dc02206e21e4c9727992be72bc199f2a4e744fb4ab97b6af49bf758fc3d2547e531b8f012102bc5adef2901a23f3e4cd42eb76c05fa2a7e5de4b29c0c61b258a5e91bacf98f0000000000288130000000000001976a914edbbcc841b0e400198022e7d9e00726cbb47f0f588aca7120000000000001976a91462e8aa06c4cab66e65df63b96ecc9cbb61c80c6788ac00000000</span>
<span class="hljs-comment">// res4: String = 020000000107630ffe2af3651934f694bdfe8e543364ea32b41e7d2591784fa93b694709be000000006a47304402205d727ac145d4ec937158f76afa65fbe45d5b005947b6dcc0f1ff7f2bf7cb3659022030031c039357534869eaccb016c6796e794e8d25ef2daa42e85a4e9e53424964012103d65032c40d502b4c8d79d1fb618f4cf0ccc595e05c45183551e9766c63e1469b000000000288130000000000001976a9146b8a6a107a3f6fcdba050274cc2b69395b99dad788aca7120000000000001976a91430059ff45079c238787c70fb9e825efaacbdbf9188ac00000000</span>
</code></pre>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/next/core/psbts"><span class="arrow-prev">← </span><span>Partially Signed Bitcoin Transactions</span></a><a class="docs-next button" href="/docs/next/core/lightning-network"><span>Lightning Network Data Types</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/favicon.ico" alt="bitcoin-s" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/getting-started">Getting Started</a><a href="/docs/en/core/core-intro">Guides</a><a href="/api/org/bitcoins">API Reference</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="https://join.slack.com/t/suredbits/shared_invite/zt-eavycu0x-WQL7XOakzQo8tAy7jHHZUw" target="_blank" rel="noreferrer noopener">Slack</a><a href="https://gitter.im/bitcoin-s-core/">Gitter chat</a></div><div><h5>More</h5><a href="https://github.com/bitcoin-s/bitcoin-s">GitHub</a><a class="github-button" href="https://github.com/bitcoin-s/bitcoin-s" data-icon="octicon-star" data-count-href="/bitcoin-s/bitcoin-s-core/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 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@76f8ef53[Running, parallelism = 2, size = 2, active = 0, running = 0, steals = 33, tasks = 0, submissions = 0]</span>
<span class="hljs-comment">// ec: ExecutionContext = scala.concurrent.impl.ExecutionContextImpl$$anon$3@50b1bcf6[Running, parallelism = 2, size = 2, active = 0, running = 0, steals = 33, tasks = 0, submissions = 0]</span>
<span class="hljs-comment">// Initialize a transaction builder</span>
<span class="hljs-keyword">val</span> builder = <span class="hljs-type">RawTxBuilder</span>()
@ -74,19 +74,19 @@
<span class="hljs-keyword">val</span> privKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey
<span class="hljs-comment">// privKey: ECPrivateKey = Masked(ECPrivateKeyImpl)</span>
<span class="hljs-keyword">val</span> pubKey = privKey.publicKey
<span class="hljs-comment">// pubKey: ECPublicKey = ECPublicKey(02bc5adef2901a23f3e4cd42eb76c05fa2a7e5de4b29c0c61b258a5e91bacf98f0)</span>
<span class="hljs-comment">// pubKey: ECPublicKey = ECPublicKey(03d65032c40d502b4c8d79d1fb618f4cf0ccc595e05c45183551e9766c63e1469b)</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(35c10f69b3aa30bc53f24c01d7a488913f7ec86a)</span>
<span class="hljs-comment">// creditingSpk: P2PKHScriptPubKey = pkh(37a7d3a84b9938051bb346712bc38683f1d30dfe)</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(35c10f69b3aa30bc53f24c01d7a488913f7ec86a))</span>
<span class="hljs-comment">// utxo: TransactionOutput = TransactionOutput(10000 sats,pkh(37a7d3a84b9938051bb346712bc38683f1d30dfe))</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(edbbcc841b0e400198022e7d9e00726cbb47f0f5)</span>
<span class="hljs-comment">// destinationSPK: P2PKHScriptPubKey = pkh(6b8a6a107a3f6fcdba050274cc2b69395b99dad7)</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(edbbcc841b0e400198022e7d9e00726cbb47f0f5)))</span>
<span class="hljs-comment">// destinations: Vector[TransactionOutput] = Vector(TransactionOutput(5000 sats,pkh(6b8a6a107a3f6fcdba050274cc2b69395b99dad7)))</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(35c10f69b3aa30bc53f24c01d7a488913f7ec86a))),UInt32Impl(0))</span>
<span class="hljs-comment">// creditingTx: BaseTransaction = BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(37a7d3a84b9938051bb346712bc38683f1d30dfe))),UInt32Impl(0))</span>
<span class="hljs-comment">// this is the information we need from the crediting TX</span>
<span class="hljs-comment">// to properly &quot;link&quot; it in the transaction we are creating</span>
<span class="hljs-keyword">val</span> outPoint = <span class="hljs-type">TransactionOutPoint</span>(creditingTx.txId, <span class="hljs-type">UInt32</span>.zero)
<span class="hljs-comment">// outPoint: TransactionOutPoint = TransactionOutPoint(656694f6bc37fbd35add04aaec2d236c19f32c2312ac91ce5617eeee168a4f5d:0)</span>
<span class="hljs-comment">// outPoint: TransactionOutPoint = TransactionOutPoint(be0947693ba94f7891257d1eb432ea6433548efebd94f6341965f32afe0f6307: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(656694f6bc37fbd35add04aaec2d236c19f32c2312ac91ce5617eeee168a4f5d:0),EmptyScriptSignature,UInt32Impl(0))</span>
<span class="hljs-comment">// input: TransactionInput = TransactionInputImpl(TransactionOutPoint(be0947693ba94f7891257d1eb432ea6433548efebd94f6341965f32afe0f6307: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(656694f6bc37fbd35add04aaec2d236c19f32c2312ac91ce5617eeee168a4f5d:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(edbbcc841b0e400198022e7d9e00726cbb47f0f5))),UInt32Impl(0))</span>
<span class="hljs-comment">// builderResult: RawTxBuilderResult = RawTxBuilderResult(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(be0947693ba94f7891257d1eb432ea6433548efebd94f6341965f32afe0f6307:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(6b8a6a107a3f6fcdba050274cc2b69395b99dad7))),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(656694f6bc37fbd35add04aaec2d236c19f32c2312ac91ce5617eeee168a4f5d:0),10000 sats,ECPublicKey(02bc5adef2901a23f3e4cd42eb76c05fa2a7e5de4b29c0c61b258a5e91bacf98f0))</span>
<span class="hljs-comment">// inputInfo: P2PKHInputInfo = P2PKHInputInfo(TransactionOutPoint(be0947693ba94f7891257d1eb432ea6433548efebd94f6341965f32afe0f6307:0),10000 sats,ECPublicKey(03d65032c40d502b4c8d79d1fb618f4cf0ccc595e05c45183551e9766c63e1469b))</span>
<span class="hljs-comment">// this is how much we are going to pay as a fee to the network</span>
<span class="hljs-comment">// for this example, we are going to pay 1 satoshi per byte</span>
@ -155,18 +155,18 @@ builder += input
<span class="hljs-keyword">val</span> changePrivKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey
<span class="hljs-comment">// changePrivKey: ECPrivateKey = Masked(ECPrivateKeyImpl)</span>
<span class="hljs-keyword">val</span> changeSPK = <span class="hljs-type">P2PKHScriptPubKey</span>(pubKey = changePrivKey.publicKey)
<span class="hljs-comment">// changeSPK: P2PKHScriptPubKey = pkh(62e8aa06c4cab66e65df63b96ecc9cbb61c80c67)</span>
<span class="hljs-comment">// changeSPK: P2PKHScriptPubKey = pkh(30059ff45079c238787c70fb9e825efaacbdbf91)</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(656694f6bc37fbd35add04aaec2d236c19f32c2312ac91ce5617eeee168a4f5d:0),10000 sats,ECPublicKey(02bc5adef2901a23f3e4cd42eb76c05fa2a7e5de4b29c0c61b258a5e91bacf98f0))),1 sats/byte,pkh(62e8aa06c4cab66e65df63b96ecc9cbb61c80c67))</span>
<span class="hljs-comment">// finalizer: StandardNonInteractiveFinalizer = StandardNonInteractiveFinalizer(Vector(P2PKHInputInfo(TransactionOutPoint(be0947693ba94f7891257d1eb432ea6433548efebd94f6341965f32afe0f6307:0),10000 sats,ECPublicKey(03d65032c40d502b4c8d79d1fb618f4cf0ccc595e05c45183551e9766c63e1469b))),1 sats/byte,pkh(30059ff45079c238787c70fb9e825efaacbdbf91))</span>
<span class="hljs-comment">// We can now finalize the tx builder result from earlier with this finalizer</span>
<span class="hljs-keyword">val</span> unsignedTxF: <span class="hljs-type">Future</span>[<span class="hljs-type">Transaction</span>] = finalizer.buildTx(builderResult)
<span class="hljs-comment">// unsignedTxF: Future[Transaction] = Future(Success(BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(656694f6bc37fbd35add04aaec2d236c19f32c2312ac91ce5617eeee168a4f5d:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(edbbcc841b0e400198022e7d9e00726cbb47f0f5)), TransactionOutput(4775 sats,pkh(62e8aa06c4cab66e65df63b96ecc9cbb61c80c67))),UInt32Impl(0))))</span>
<span class="hljs-comment">// unsignedTxF: Future[Transaction] = Future(Success(BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(be0947693ba94f7891257d1eb432ea6433548efebd94f6341965f32afe0f6307:0),EmptyScriptSignature,UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(6b8a6a107a3f6fcdba050274cc2b69395b99dad7)), TransactionOutput(4775 sats,pkh(30059ff45079c238787c70fb9e825efaacbdbf91))),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(656694f6bc37fbd35add04aaec2d236c19f32c2312ac91ce5617eeee168a4f5d:0),10000 sats,ECPublicKey(02bc5adef2901a23f3e4cd42eb76c05fa2a7e5de4b29c0c61b258a5e91bacf98f0)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(35c10f69b3aa30bc53f24c01d7a488913f7ec86a))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1)))</span>
<span class="hljs-comment">// utxoInfo: ScriptSignatureParams[P2PKHInputInfo] = ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(be0947693ba94f7891257d1eb432ea6433548efebd94f6341965f32afe0f6307:0),10000 sats,ECPublicKey(03d65032c40d502b4c8d79d1fb618f4cf0ccc595e05c45183551e9766c63e1469b)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(37a7d3a84b9938051bb346712bc38683f1d30dfe))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1)))</span>
<span class="hljs-comment">// all of the UTXO spending information, since we only have</span>
<span class="hljs-comment">// one input, this is just one element</span>
<span class="hljs-keyword">val</span> utxoInfos: <span class="hljs-type">Vector</span>[<span class="hljs-type">ScriptSignatureParams</span>[<span class="hljs-type">InputInfo</span>]] = <span class="hljs-type">Vector</span>(utxoInfo)
<span class="hljs-comment">// utxoInfos: Vector[ScriptSignatureParams[InputInfo]] = Vector(ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(656694f6bc37fbd35add04aaec2d236c19f32c2312ac91ce5617eeee168a4f5d:0),10000 sats,ECPublicKey(02bc5adef2901a23f3e4cd42eb76c05fa2a7e5de4b29c0c61b258a5e91bacf98f0)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(35c10f69b3aa30bc53f24c01d7a488913f7ec86a))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1))))</span>
<span class="hljs-comment">// utxoInfos: Vector[ScriptSignatureParams[InputInfo]] = Vector(ScriptSignatureParams(P2PKHInputInfo(TransactionOutPoint(be0947693ba94f7891257d1eb432ea6433548efebd94f6341965f32afe0f6307:0),10000 sats,ECPublicKey(03d65032c40d502b4c8d79d1fb618f4cf0ccc595e05c45183551e9766c63e1469b)),BaseTransaction(Int32Impl(1),Vector(),Vector(TransactionOutput(10000 sats,pkh(37a7d3a84b9938051bb346712bc38683f1d30dfe))),UInt32Impl(0)),Vector(Masked(ECPrivateKeyImpl)),SIGHASH_ALL(Int32Impl(1))))</span>
<span class="hljs-comment">// Yay! Now we use the RawTxSigner object to sign the tx.</span>
<span class="hljs-comment">// The &#x27;sign&#x27; method is going produce a validly signed transaction</span>
@ -201,7 +201,7 @@ builder += input
}
<span class="hljs-type">Await</span>.result(signedTxF, <span class="hljs-number">30.</span>seconds)
}
<span class="hljs-comment">// signedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(656694f6bc37fbd35add04aaec2d236c19f32c2312ac91ce5617eeee168a4f5d:0),P2PKHScriptSignature(ECPublicKey(02bc5adef2901a23f3e4cd42eb76c05fa2a7e5de4b29c0c61b258a5e91bacf98f0), ECDigitalSignature(304402204f63ada08696341ed57707379a818fa48b89e5d055c05b3203207f0a2e8940dc02206e21e4c9727992be72bc199f2a4e744fb4ab97b6af49bf758fc3d2547e531b8f01)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(edbbcc841b0e400198022e7d9e00726cbb47f0f5)), TransactionOutput(4775 sats,pkh(62e8aa06c4cab66e65df63b96ecc9cbb61c80c67))),UInt32Impl(0))</span>
<span class="hljs-comment">// signedTx: Transaction = BaseTransaction(Int32Impl(2),Vector(TransactionInputImpl(TransactionOutPoint(be0947693ba94f7891257d1eb432ea6433548efebd94f6341965f32afe0f6307:0),P2PKHScriptSignature(ECPublicKey(03d65032c40d502b4c8d79d1fb618f4cf0ccc595e05c45183551e9766c63e1469b), ECDigitalSignature(304402205d727ac145d4ec937158f76afa65fbe45d5b005947b6dcc0f1ff7f2bf7cb3659022030031c039357534869eaccb016c6796e794e8d25ef2daa42e85a4e9e5342496401)),UInt32Impl(0))),Vector(TransactionOutput(5000 sats,pkh(6b8a6a107a3f6fcdba050274cc2b69395b99dad7)), TransactionOutput(4775 sats,pkh(30059ff45079c238787c70fb9e825efaacbdbf91))),UInt32Impl(0))</span>
</code></pre>
<pre><code class="hljs css language-scala">signedTx.inputs.length
<span class="hljs-comment">// res2: Int = 1</span>
@ -211,7 +211,7 @@ signedTx.outputs.length
<span class="hljs-comment">//remember, you can call .hex on any bitcoin-s data structure to get the hex representation!</span>
signedTx.hex
<span class="hljs-comment">// res4: String = 02000000015d4f8a16eeee1756ce91ac12232cf3196c232decaa04dd5ad3fb37bcf6946665000000006a47304402204f63ada08696341ed57707379a818fa48b89e5d055c05b3203207f0a2e8940dc02206e21e4c9727992be72bc199f2a4e744fb4ab97b6af49bf758fc3d2547e531b8f012102bc5adef2901a23f3e4cd42eb76c05fa2a7e5de4b29c0c61b258a5e91bacf98f0000000000288130000000000001976a914edbbcc841b0e400198022e7d9e00726cbb47f0f588aca7120000000000001976a91462e8aa06c4cab66e65df63b96ecc9cbb61c80c6788ac00000000</span>
<span class="hljs-comment">// res4: String = 020000000107630ffe2af3651934f694bdfe8e543364ea32b41e7d2591784fa93b694709be000000006a47304402205d727ac145d4ec937158f76afa65fbe45d5b005947b6dcc0f1ff7f2bf7cb3659022030031c039357534869eaccb016c6796e794e8d25ef2daa42e85a4e9e53424964012103d65032c40d502b4c8d79d1fb618f4cf0ccc595e05c45183551e9766c63e1469b000000000288130000000000001976a9146b8a6a107a3f6fcdba050274cc2b69395b99dad788aca7120000000000001976a91430059ff45079c238787c70fb9e825efaacbdbf9188ac00000000</span>
</code></pre>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/next/core/psbts"><span class="arrow-prev">← </span><span>Partially Signed Bitcoin Transactions</span></a><a class="docs-next button" href="/docs/next/core/lightning-network"><span>Lightning Network Data Types</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/favicon.ico" alt="bitcoin-s" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/getting-started">Getting Started</a><a href="/docs/en/core/core-intro">Guides</a><a href="/api/org/bitcoins">API Reference</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="https://join.slack.com/t/suredbits/shared_invite/zt-eavycu0x-WQL7XOakzQo8tAy7jHHZUw" target="_blank" rel="noreferrer noopener">Slack</a><a href="https://gitter.im/bitcoin-s-core/">Gitter chat</a></div><div><h5>More</h5><a href="https://github.com/bitcoin-s/bitcoin-s">GitHub</a><a class="github-button" href="https://github.com/bitcoin-s/bitcoin-s" data-icon="octicon-star" data-count-href="/bitcoin-s/bitcoin-s-core/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 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(304402203b8e256cc1441455f2f8213ef676635a6ea0fb158a49cef04c8f0dd8b2ce004902205bda2b16b4f990e96cf07a457f03b5e9ca742b847ffab66d8f0059e811613051)</span>
<span class="hljs-comment">// res0: ECDigitalSignature = ECDigitalSignature(304402204b6aec30a552c4eecdfa90e68937370d20e40b605b52160e0d323ca96bfaa68e0220377efbfbfd9878d2704e8eccc490cf4dd7849ebcb741e54a0590832b30f88622)</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(3045022100ab4b465e9781a28f591ff042876c475d9e82951ef6364456698357188d93be4c0220649133c48906de9d794046cfac2f6c4f3bb08add4040817c98277c703fe0a4e7)</span>
<span class="hljs-comment">// res1: ECDigitalSignature = ECDigitalSignature(3045022100abee38d63b7a4a9cff56b8f4a21017cdfcb64bbf6ab1e630569825ac6274aa46022002e2f090976e72ff114b45772cdeb3c2e92715b7c2d41284fa1b048c64f0abc0)</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(304402203b8e256cc1441455f2f8213ef676635a6ea0fb158a49cef04c8f0dd8b2ce004902205bda2b16b4f990e96cf07a457f03b5e9ca742b847ffab66d8f0059e811613051)</span>
<span class="hljs-comment">// res0: ECDigitalSignature = ECDigitalSignature(304402204b6aec30a552c4eecdfa90e68937370d20e40b605b52160e0d323ca96bfaa68e0220377efbfbfd9878d2704e8eccc490cf4dd7849ebcb741e54a0590832b30f88622)</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(3045022100ab4b465e9781a28f591ff042876c475d9e82951ef6364456698357188d93be4c0220649133c48906de9d794046cfac2f6c4f3bb08add4040817c98277c703fe0a4e7)</span>
<span class="hljs-comment">// res1: ECDigitalSignature = ECDigitalSignature(3045022100abee38d63b7a4a9cff56b8f4a21017cdfcb64bbf6ab1e630569825ac6274aa46022002e2f090976e72ff114b45772cdeb3c2e92715b7c2d41284fa1b048c64f0abc0)</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

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

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

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

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, 0xc50908f6b197b77002aafce535d0ef6e2f0e011deef845abe015432ecf6ed866)</span>
<span class="hljs-comment">// entropy: scodec.bits.BitVector = BitVector(256 bits, 0x61a2cdcb53cb7cf12516e92b1a258cb21fa8bedffafc1641cae38daba9b60772)</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(shallow, embark, diet, glimpse, kiwi, retreat, apple, garbage, topple, purse, design, sword, valley, above, jeans, tenant, east, gallery, aim, main, undo, resist, ghost, tell)</span>
<span class="hljs-comment">// Vector(giant, biology, index, pole, result, joy, nephew, tag, climb, spell, glimpse, goddess, whisper, garage, lend, garbage, bind, atom, rib, brave, ritual, swallow, build, fiction)</span>
</code></pre>
<p>Now that we have a <code>MnemonicCode</code> that was securely generated, we need to now create <code>KeyManagerParams</code> which tells us how to generate
generate specific kinds of addresses for wallets.</p>
@ -99,7 +99,7 @@ generate specific kinds of addresses for wallets.</p>
<pre><code class="hljs css language-scala"><span class="hljs-comment">//this will create a temp directory with the prefix &#x27;key-manager-example` that will</span>
<span class="hljs-comment">//have a file in it called &quot;encrypted-bitcoin-s-seed.json&quot;</span>
<span class="hljs-keyword">val</span> seedPath = <span class="hljs-type">Files</span>.createTempDirectory(<span class="hljs-string">&quot;key-manager-example&quot;</span>).resolve(<span class="hljs-type">WalletStorage</span>.<span class="hljs-type">ENCRYPTED_SEED_FILE_NAME</span>)
<span class="hljs-comment">// seedPath: Path = /tmp/key-manager-example5523672644149652361/encrypted-bitcoin-s-seed.json</span>
<span class="hljs-comment">// seedPath: Path = /tmp/key-manager-example7997965906490194400/encrypted-bitcoin-s-seed.json</span>
<span class="hljs-comment">//let&#x27;s create a native segwit key manager</span>
<span class="hljs-keyword">val</span> purpose = <span class="hljs-type">HDPurposes</span>.<span class="hljs-type">SegWit</span>
@ -110,19 +110,19 @@ generate specific kinds of addresses for wallets.</p>
<span class="hljs-comment">// network: RegTest.type = RegTest</span>
<span class="hljs-keyword">val</span> kmParams = <span class="hljs-type">KeyManagerParams</span>(seedPath, purpose, network)
<span class="hljs-comment">// kmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example5523672644149652361/encrypted-bitcoin-s-seed.json,m/84&#x27;,RegTest)</span>
<span class="hljs-comment">// kmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example7997965906490194400/encrypted-bitcoin-s-seed.json,m/84&#x27;,RegTest)</span>
<span class="hljs-keyword">val</span> aesPasswordOpt = <span class="hljs-type">Some</span>(<span class="hljs-type">AesPassword</span>.fromString(<span class="hljs-string">&quot;password&quot;</span>))
<span class="hljs-comment">// aesPasswordOpt: Some[AesPassword] = Some(Masked(AesPassword))</span>
<span class="hljs-keyword">val</span> km = <span class="hljs-type">BIP39KeyManager</span>.initializeWithMnemonic(aesPasswordOpt, mnemonic, <span class="hljs-type">None</span>, kmParams)
<span class="hljs-comment">// km: Either[KeyManagerInitializeError, BIP39KeyManager] = Right(org.bitcoins.keymanager.bip39.BIP39KeyManager@3be776e0)</span>
<span class="hljs-comment">// km: Either[KeyManagerInitializeError, BIP39KeyManager] = Right(org.bitcoins.keymanager.bip39.BIP39KeyManager@1122094)</span>
<span class="hljs-keyword">val</span> rootXPub = km.right.get.getRootXPub
<span class="hljs-comment">// rootXPub: ExtPublicKey = vpub5SLqN2bLY4WeYDFWsVyyYStVfsqyD49gs9mq344p9vbE1SNsT9TmtLAM3LXqJMXLzdHPLWsnyB48dVM2aRnhVuvvZGArwMZix21UxDzhRNz</span>
<span class="hljs-comment">// rootXPub: ExtPublicKey = vpub5SLqN2bLY4Wea1uYg1LgQ5VeYEXTQnSkxTgDAs5YRSAHYcWH5JLSxEda3ZRK2xcwGvpUeLFksKDXtytqTBGEkuxBjNpBau2RMLemAKMk74h</span>
println(rootXPub)
<span class="hljs-comment">// vpub5SLqN2bLY4WeYDFWsVyyYStVfsqyD49gs9mq344p9vbE1SNsT9TmtLAM3LXqJMXLzdHPLWsnyB48dVM2aRnhVuvvZGArwMZix21UxDzhRNz</span>
<span class="hljs-comment">// vpub5SLqN2bLY4Wea1uYg1LgQ5VeYEXTQnSkxTgDAs5YRSAHYcWH5JLSxEda3ZRK2xcwGvpUeLFksKDXtytqTBGEkuxBjNpBau2RMLemAKMk74h</span>
</code></pre>
<p>Which should print something that looks like this</p>
<p><code>vpub5SLqN2bLY4WeXxMqwJHJFBEwxSscGB2uDUnsTS3edVjZEwTrQDFDNqoR2xLqARQPabGaXsHSTenTRcqm2EnB9MpuC4vSk3LqSgNmGGZtuq7</code></p>
@ -131,17 +131,17 @@ println(rootXPub)
again after initializing it once. You can use the same <code>mnemonic</code> for different networks, which you control <code>KeyManagerParams</code>.</p>
<pre><code class="hljs css language-scala"><span class="hljs-comment">//let&#x27;s create a nested segwit key manager for mainnet</span>
<span class="hljs-keyword">val</span> mainnetKmParams = <span class="hljs-type">KeyManagerParams</span>(seedPath, <span class="hljs-type">HDPurposes</span>.<span class="hljs-type">SegWit</span>, <span class="hljs-type">MainNet</span>)
<span class="hljs-comment">// mainnetKmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example5523672644149652361/encrypted-bitcoin-s-seed.json,m/84&#x27;,MainNet)</span>
<span class="hljs-comment">// mainnetKmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example7997965906490194400/encrypted-bitcoin-s-seed.json,m/84&#x27;,MainNet)</span>
<span class="hljs-comment">//we do not need to all `initializeWithMnemonic()` again as we have saved the seed to dis</span>
<span class="hljs-keyword">val</span> mainnetKeyManager = <span class="hljs-type">BIP39KeyManager</span>.fromMnemonic(mnemonic, mainnetKmParams, <span class="hljs-type">None</span>, <span class="hljs-type">Instant</span>.now)
<span class="hljs-comment">// mainnetKeyManager: BIP39KeyManager = org.bitcoins.keymanager.bip39.BIP39KeyManager@2195abc1</span>
<span class="hljs-comment">// mainnetKeyManager: BIP39KeyManager = org.bitcoins.keymanager.bip39.BIP39KeyManager@627dca7b</span>
<span class="hljs-keyword">val</span> mainnetXpub = mainnetKeyManager.getRootXPub
<span class="hljs-comment">// mainnetXpub: ExtPublicKey = zpub6jftahH18ngZwQ1zCw8UNoGWMkRkyY7gXbriAdeMfx6kDqdnTn82Nanu8ANBHz92dBkcLRG2opULAdoHTDSkgrfL2cxZGzqg2vG4WWjQhwa</span>
<span class="hljs-comment">// mainnetXpub: ExtPublicKey = zpub6jftahH18ngZyCg21SVBERsfE77FBGQkcum6JSf5wTfom1mC5vzhSVG88PFf2bEcuVHheEdzhxdjS8M6KxvHwrgbCjbsvYJNSEuLieQiBbE</span>
println(mainnetXpub)
<span class="hljs-comment">// zpub6jftahH18ngZwQ1zCw8UNoGWMkRkyY7gXbriAdeMfx6kDqdnTn82Nanu8ANBHz92dBkcLRG2opULAdoHTDSkgrfL2cxZGzqg2vG4WWjQhwa</span>
<span class="hljs-comment">// zpub6jftahH18ngZyCg21SVBERsfE77FBGQkcum6JSf5wTfom1mC5vzhSVG88PFf2bEcuVHheEdzhxdjS8M6KxvHwrgbCjbsvYJNSEuLieQiBbE</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, 0xc50908f6b197b77002aafce535d0ef6e2f0e011deef845abe015432ecf6ed866)</span>
<span class="hljs-comment">// entropy: scodec.bits.BitVector = BitVector(256 bits, 0x61a2cdcb53cb7cf12516e92b1a258cb21fa8bedffafc1641cae38daba9b60772)</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(shallow, embark, diet, glimpse, kiwi, retreat, apple, garbage, topple, purse, design, sword, valley, above, jeans, tenant, east, gallery, aim, main, undo, resist, ghost, tell)</span>
<span class="hljs-comment">// Vector(giant, biology, index, pole, result, joy, nephew, tag, climb, spell, glimpse, goddess, whisper, garage, lend, garbage, bind, atom, rib, brave, ritual, swallow, build, fiction)</span>
</code></pre>
<p>Now that we have a <code>MnemonicCode</code> that was securely generated, we need to now create <code>KeyManagerParams</code> which tells us how to generate
generate specific kinds of addresses for wallets.</p>
@ -99,7 +99,7 @@ generate specific kinds of addresses for wallets.</p>
<pre><code class="hljs css language-scala"><span class="hljs-comment">//this will create a temp directory with the prefix &#x27;key-manager-example` that will</span>
<span class="hljs-comment">//have a file in it called &quot;encrypted-bitcoin-s-seed.json&quot;</span>
<span class="hljs-keyword">val</span> seedPath = <span class="hljs-type">Files</span>.createTempDirectory(<span class="hljs-string">&quot;key-manager-example&quot;</span>).resolve(<span class="hljs-type">WalletStorage</span>.<span class="hljs-type">ENCRYPTED_SEED_FILE_NAME</span>)
<span class="hljs-comment">// seedPath: Path = /tmp/key-manager-example5523672644149652361/encrypted-bitcoin-s-seed.json</span>
<span class="hljs-comment">// seedPath: Path = /tmp/key-manager-example7997965906490194400/encrypted-bitcoin-s-seed.json</span>
<span class="hljs-comment">//let&#x27;s create a native segwit key manager</span>
<span class="hljs-keyword">val</span> purpose = <span class="hljs-type">HDPurposes</span>.<span class="hljs-type">SegWit</span>
@ -110,19 +110,19 @@ generate specific kinds of addresses for wallets.</p>
<span class="hljs-comment">// network: RegTest.type = RegTest</span>
<span class="hljs-keyword">val</span> kmParams = <span class="hljs-type">KeyManagerParams</span>(seedPath, purpose, network)
<span class="hljs-comment">// kmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example5523672644149652361/encrypted-bitcoin-s-seed.json,m/84&#x27;,RegTest)</span>
<span class="hljs-comment">// kmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example7997965906490194400/encrypted-bitcoin-s-seed.json,m/84&#x27;,RegTest)</span>
<span class="hljs-keyword">val</span> aesPasswordOpt = <span class="hljs-type">Some</span>(<span class="hljs-type">AesPassword</span>.fromString(<span class="hljs-string">&quot;password&quot;</span>))
<span class="hljs-comment">// aesPasswordOpt: Some[AesPassword] = Some(Masked(AesPassword))</span>
<span class="hljs-keyword">val</span> km = <span class="hljs-type">BIP39KeyManager</span>.initializeWithMnemonic(aesPasswordOpt, mnemonic, <span class="hljs-type">None</span>, kmParams)
<span class="hljs-comment">// km: Either[KeyManagerInitializeError, BIP39KeyManager] = Right(org.bitcoins.keymanager.bip39.BIP39KeyManager@3be776e0)</span>
<span class="hljs-comment">// km: Either[KeyManagerInitializeError, BIP39KeyManager] = Right(org.bitcoins.keymanager.bip39.BIP39KeyManager@1122094)</span>
<span class="hljs-keyword">val</span> rootXPub = km.right.get.getRootXPub
<span class="hljs-comment">// rootXPub: ExtPublicKey = vpub5SLqN2bLY4WeYDFWsVyyYStVfsqyD49gs9mq344p9vbE1SNsT9TmtLAM3LXqJMXLzdHPLWsnyB48dVM2aRnhVuvvZGArwMZix21UxDzhRNz</span>
<span class="hljs-comment">// rootXPub: ExtPublicKey = vpub5SLqN2bLY4Wea1uYg1LgQ5VeYEXTQnSkxTgDAs5YRSAHYcWH5JLSxEda3ZRK2xcwGvpUeLFksKDXtytqTBGEkuxBjNpBau2RMLemAKMk74h</span>
println(rootXPub)
<span class="hljs-comment">// vpub5SLqN2bLY4WeYDFWsVyyYStVfsqyD49gs9mq344p9vbE1SNsT9TmtLAM3LXqJMXLzdHPLWsnyB48dVM2aRnhVuvvZGArwMZix21UxDzhRNz</span>
<span class="hljs-comment">// vpub5SLqN2bLY4Wea1uYg1LgQ5VeYEXTQnSkxTgDAs5YRSAHYcWH5JLSxEda3ZRK2xcwGvpUeLFksKDXtytqTBGEkuxBjNpBau2RMLemAKMk74h</span>
</code></pre>
<p>Which should print something that looks like this</p>
<p><code>vpub5SLqN2bLY4WeXxMqwJHJFBEwxSscGB2uDUnsTS3edVjZEwTrQDFDNqoR2xLqARQPabGaXsHSTenTRcqm2EnB9MpuC4vSk3LqSgNmGGZtuq7</code></p>
@ -131,17 +131,17 @@ println(rootXPub)
again after initializing it once. You can use the same <code>mnemonic</code> for different networks, which you control <code>KeyManagerParams</code>.</p>
<pre><code class="hljs css language-scala"><span class="hljs-comment">//let&#x27;s create a nested segwit key manager for mainnet</span>
<span class="hljs-keyword">val</span> mainnetKmParams = <span class="hljs-type">KeyManagerParams</span>(seedPath, <span class="hljs-type">HDPurposes</span>.<span class="hljs-type">SegWit</span>, <span class="hljs-type">MainNet</span>)
<span class="hljs-comment">// mainnetKmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example5523672644149652361/encrypted-bitcoin-s-seed.json,m/84&#x27;,MainNet)</span>
<span class="hljs-comment">// mainnetKmParams: KeyManagerParams = KeyManagerParams(/tmp/key-manager-example7997965906490194400/encrypted-bitcoin-s-seed.json,m/84&#x27;,MainNet)</span>
<span class="hljs-comment">//we do not need to all `initializeWithMnemonic()` again as we have saved the seed to dis</span>
<span class="hljs-keyword">val</span> mainnetKeyManager = <span class="hljs-type">BIP39KeyManager</span>.fromMnemonic(mnemonic, mainnetKmParams, <span class="hljs-type">None</span>, <span class="hljs-type">Instant</span>.now)
<span class="hljs-comment">// mainnetKeyManager: BIP39KeyManager = org.bitcoins.keymanager.bip39.BIP39KeyManager@2195abc1</span>
<span class="hljs-comment">// mainnetKeyManager: BIP39KeyManager = org.bitcoins.keymanager.bip39.BIP39KeyManager@627dca7b</span>
<span class="hljs-keyword">val</span> mainnetXpub = mainnetKeyManager.getRootXPub
<span class="hljs-comment">// mainnetXpub: ExtPublicKey = zpub6jftahH18ngZwQ1zCw8UNoGWMkRkyY7gXbriAdeMfx6kDqdnTn82Nanu8ANBHz92dBkcLRG2opULAdoHTDSkgrfL2cxZGzqg2vG4WWjQhwa</span>
<span class="hljs-comment">// mainnetXpub: ExtPublicKey = zpub6jftahH18ngZyCg21SVBERsfE77FBGQkcum6JSf5wTfom1mC5vzhSVG88PFf2bEcuVHheEdzhxdjS8M6KxvHwrgbCjbsvYJNSEuLieQiBbE</span>
println(mainnetXpub)
<span class="hljs-comment">// zpub6jftahH18ngZwQ1zCw8UNoGWMkRkyY7gXbriAdeMfx6kDqdnTn82Nanu8ANBHz92dBkcLRG2opULAdoHTDSkgrfL2cxZGzqg2vG4WWjQhwa</span>
<span class="hljs-comment">// zpub6jftahH18ngZyCg21SVBERsfE77FBGQkcum6JSf5wTfom1mC5vzhSVG88PFf2bEcuVHheEdzhxdjS8M6KxvHwrgbCjbsvYJNSEuLieQiBbE</span>
</code></pre>
<p>Which gives us something that looks like this</p>
<p><code>zpub6jftahH18ngZw98KGjRo5XcxeKTQ2eztsvskb1dC9XF5TLimQquTs6Ry7nBBA425D9joXmfgJJCexmJ1u2SELJZJfRi95gcnXadLpZzYb5c</code></p>

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

@ -114,12 +114,12 @@ println(<span class="hljs-string">s&quot;Verified with NativeSecp256k1 again=<sp
<pre><code class="hljs css language-scala"><span class="hljs-keyword">val</span> privKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey
<span class="hljs-comment">// privKey: ECPrivateKey = Masked(ECPrivateKeyImpl)</span>
<span class="hljs-keyword">val</span> publicKey = privKey.publicKeyWithBouncyCastle
<span class="hljs-comment">// publicKey: ECPublicKey = ECPublicKey(029fa553fb8aaf6fa361d7fddc18824976ec8c7846eaecad6021a321e605c3b9b2)</span>
<span class="hljs-comment">// publicKey: ECPublicKey = ECPublicKey(0367ac24dadf6ba5518909ed0a19fc02867d199a653ac9cd72fe7da2b161fbddc6)</span>
<span class="hljs-keyword">val</span> dataToSign = <span class="hljs-type">DoubleSha256Digest</span>.empty
<span class="hljs-comment">// dataToSign: DoubleSha256Digest = DoubleSha256Digest(0000000000000000000000000000000000000000000000000000000000000000)</span>
<span class="hljs-keyword">val</span> signature = privKey.signWithBouncyCastle(dataToSign.bytes)
<span class="hljs-comment">// signature: ECDigitalSignature = ECDigitalSignature(3045022100da4581e8be0bc5423f79c51bcd321513f76a4232fbd90ed0756c0acd4a9d48a002203760f8562c38fe955071aeb0cd2365f8868f0c4f3d12cac14767f030c6960364)</span>
<span class="hljs-comment">// signature: ECDigitalSignature = ECDigitalSignature(30440220124e511ea98cef90eb40e20824ba3e9106e792d962191fb190a6b7532b4aabe7022019368c843a3d99211984eac23f3dd7a258e1f6aa0fa581431c19f61787ccce25)</span>
<span class="hljs-keyword">val</span> verified = publicKey.verifyWithBouncyCastle(dataToSign.bytes, signature)
<span class="hljs-comment">// verified: Boolean = true</span>

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

@ -114,12 +114,12 @@ println(<span class="hljs-string">s&quot;Verified with NativeSecp256k1 again=<sp
<pre><code class="hljs css language-scala"><span class="hljs-keyword">val</span> privKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey
<span class="hljs-comment">// privKey: ECPrivateKey = Masked(ECPrivateKeyImpl)</span>
<span class="hljs-keyword">val</span> publicKey = privKey.publicKeyWithBouncyCastle
<span class="hljs-comment">// publicKey: ECPublicKey = ECPublicKey(029fa553fb8aaf6fa361d7fddc18824976ec8c7846eaecad6021a321e605c3b9b2)</span>
<span class="hljs-comment">// publicKey: ECPublicKey = ECPublicKey(0367ac24dadf6ba5518909ed0a19fc02867d199a653ac9cd72fe7da2b161fbddc6)</span>
<span class="hljs-keyword">val</span> dataToSign = <span class="hljs-type">DoubleSha256Digest</span>.empty
<span class="hljs-comment">// dataToSign: DoubleSha256Digest = DoubleSha256Digest(0000000000000000000000000000000000000000000000000000000000000000)</span>
<span class="hljs-keyword">val</span> signature = privKey.signWithBouncyCastle(dataToSign.bytes)
<span class="hljs-comment">// signature: ECDigitalSignature = ECDigitalSignature(3045022100da4581e8be0bc5423f79c51bcd321513f76a4232fbd90ed0756c0acd4a9d48a002203760f8562c38fe955071aeb0cd2365f8868f0c4f3d12cac14767f030c6960364)</span>
<span class="hljs-comment">// signature: ECDigitalSignature = ECDigitalSignature(30440220124e511ea98cef90eb40e20824ba3e9106e792d962191fb190a6b7532b4aabe7022019368c843a3d99211984eac23f3dd7a258e1f6aa0fa581431c19f61787ccce25)</span>
<span class="hljs-keyword">val</span> verified = publicKey.verifyWithBouncyCastle(dataToSign.bytes, signature)
<span class="hljs-comment">// verified: Boolean = true</span>

163
docs/next/wallet/dlc.html
View file

@ -64,71 +64,42 @@
});
</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/wallet/dlc.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">Executing A DLC with Bitcoin-S</h1></header><article><div><span><h2><a class="anchor" aria-hidden="true" id="executing-a-discreet-log-contract-dlc"></a><a href="#executing-a-discreet-log-contract-dlc" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Executing A Discreet Log Contract (DLC)</h2>
<h2><a class="anchor" aria-hidden="true" id="step-1-get-bitcoin-s-setup"></a><a href="#step-1-get-bitcoin-s-setup" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Step 1: Get Bitcoin-S Setup</h2>
<p>See the <a href="../getting-setup">setup document</a>.</p>
<p>Make sure to follow <a href="../getting-setup#step-4-optional-discreet-log-contract-branch">Step 4</a> to checkout the <code>adaptor-dlc</code> feature branch.</p>
<h2><a class="anchor" aria-hidden="true" id="step-2-agree-on-contract-terms"></a><a href="#step-2-agree-on-contract-terms" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Step 2: Agree On Contract Terms</h2>
<p>Both parties must agree on all fields from the table below:</p>
<table>
<thead>
<tr><th style="text-align:center">Field Name</th><th style="text-align:center">Format</th></tr>
</thead>
<tbody>
<tr><td style="text-align:center">oracleInfo</td><td style="text-align:center">OraclePubKeyHex ++ OracleRValueHex</td></tr>
<tr><td style="text-align:center">contractInfo</td><td style="text-align:center">Hash1Hex ++ 8ByteValue1Hex ++ Hash2Hex ++ 8ByteValue2Hex</td></tr>
<tr><td style="text-align:center">collateral</td><td style="text-align:center">NumInSatoshis</td></tr>
<tr><td style="text-align:center">locktime</td><td style="text-align:center">LockTimeNum</td></tr>
<tr><td style="text-align:center">refundlocktime</td><td style="text-align:center">LockTimeNum</td></tr>
<tr><td style="text-align:center">feerate</td><td style="text-align:center">NumInSatoshisPerVByte</td></tr>
</tbody>
</table>
<p>Here is an example <code>oracleInfo</code> for public key <code>02debeef17d7be7ced0bf346395a5c5c7177491953e91f0af2b098aac5d23cab</code> and R value <code>b1a63752e5a760f47252545b7cda933afeaf06dba3b6c6fd5356781f240c2750</code>:</p>
<pre><code class="hljs css language-bashrc"><span class="hljs-number">02</span>debeef<span class="hljs-number">17</span>d<span class="hljs-number">7</span>be<span class="hljs-number">7</span>ced<span class="hljs-number">0</span>bf<span class="hljs-number">346395</span>a<span class="hljs-number">5</span><span class="hljs-keyword">c</span><span class="hljs-number">5</span><span class="hljs-keyword">c</span><span class="hljs-number">7177491953e91</span>f<span class="hljs-number">0</span>af<span class="hljs-number">2</span>b<span class="hljs-number">098</span>aac<span class="hljs-number">5</span>d<span class="hljs-number">23</span>cabb<span class="hljs-number">1</span>a<span class="hljs-number">63752e5</span>a<span class="hljs-number">760</span>f<span class="hljs-number">47252545</span>b<span class="hljs-number">7</span>cda<span class="hljs-number">933</span>afeaf<span class="hljs-number">06</span>dba<span class="hljs-number">3</span>b<span class="hljs-number">6</span><span class="hljs-keyword">c</span><span class="hljs-number">6</span>fd<span class="hljs-number">5356781</span>f<span class="hljs-number">240</span><span class="hljs-keyword">c</span><span class="hljs-number">2750</span>
</code></pre>
<p>Here is an example <code>contractInfo</code> for hashes <code>c07803e32c12e100905e8d69fe38ae72f2e7a17eb7b8dc1a9bce134b0cbe920f</code> and <code>5c58e41254e7a117ee1db59874f2334facc1576c238c16d18767b47861f93f7c</code> with respective Satoshi denominated outcomes of <code>100000 sats</code> and <code>0 sats</code>:</p>
<pre><code class="hljs css language-bashrc"><span class="hljs-keyword">c</span><span class="hljs-number">07803e32</span><span class="hljs-keyword">c</span><span class="hljs-number">12e100905</span>e<span class="hljs-number">8</span>d<span class="hljs-number">69</span>fe<span class="hljs-number">38</span>ae<span class="hljs-number">72</span>f<span class="hljs-number">2e7</span>a<span class="hljs-number">17</span>eb<span class="hljs-number">7</span>b<span class="hljs-number">8</span>dc<span class="hljs-number">1</span>a<span class="hljs-number">9</span>bce<span class="hljs-number">134</span>b<span class="hljs-number">0</span>cbe<span class="hljs-number">920</span>fa<span class="hljs-number">0860100000000005</span><span class="hljs-keyword">c</span><span class="hljs-number">58e41254</span>e<span class="hljs-number">7</span>a<span class="hljs-number">117</span>ee<span class="hljs-number">1</span>db<span class="hljs-number">59874</span>f<span class="hljs-number">2334</span>facc<span class="hljs-number">1576</span><span class="hljs-keyword">c</span><span class="hljs-number">238</span><span class="hljs-keyword">c</span><span class="hljs-number">16</span>d<span class="hljs-number">18767</span>b<span class="hljs-number">47861</span>f<span class="hljs-number">93</span>f<span class="hljs-number">7</span><span class="hljs-keyword">c</span><span class="hljs-number">0000000000000000</span>
</code></pre>
<p>And finally, here are the oracle signatures for each hash in order in case you want to test with this contract:</p>
<pre><code class="hljs css language-bashrc">f<span class="hljs-number">8758</span>d<span class="hljs-number">7</span>f<span class="hljs-number">03</span>a<span class="hljs-number">65</span>b<span class="hljs-number">67</span>b<span class="hljs-number">90</span>f<span class="hljs-number">62301</span>a<span class="hljs-number">3554849</span>bde<span class="hljs-number">6</span>d<span class="hljs-number">00</span>d<span class="hljs-number">50e965</span>eb<span class="hljs-number">123398</span>de<span class="hljs-number">9</span>fd<span class="hljs-number">6</span>ea<span class="hljs-number">7</span>fbbee<span class="hljs-number">821</span>b<span class="hljs-number">7166028</span>a<span class="hljs-number">6927282830</span><span class="hljs-keyword">c</span><span class="hljs-number">9452</span>cfcf<span class="hljs-number">3</span><span class="hljs-keyword">c</span><span class="hljs-number">5716</span><span class="hljs-keyword">c</span><span class="hljs-number">57e43</span>dd<span class="hljs-number">4069</span>ca<span class="hljs-number">87625010</span>
</code></pre>
<pre><code class="hljs css language-bashrc"><span class="hljs-attribute">f8758d7f03a65b67b90f62301a3554849bde6d00d50e965eb123398de9fd6ea7af05f01f1ca852cf5454a7dc91cdad7903dc2e67ddb2b3bc9d61dabd8856aa6a</span>
</code></pre>
<p>Note: if you wish to setup your own oracle for testing, you can do so by pasting the following into the <code>sbt core/console</code>:</p>
<pre><code class="hljs css language-scala"><span class="hljs-keyword">import</span> org.bitcoins.crypto._
<span class="hljs-keyword">import</span> org.bitcoins.core.currency._
<span class="hljs-keyword">import</span> scodec.bits._
<span class="hljs-keyword">val</span> privKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey
<span class="hljs-keyword">val</span> pubKey = privKey.schnorrPublicKey
<span class="hljs-keyword">val</span> kValue = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey
<span class="hljs-keyword">val</span> rValue = kValue.schnorrNonce
<span class="hljs-comment">//the hash the oracle will sign when the bitcoin price is over $9,000</span>
<span class="hljs-keyword">val</span> winHash = <span class="hljs-type">CryptoUtil</span>.sha256(<span class="hljs-type">ByteVector</span>(<span class="hljs-string">&quot;BTC_OVER_9000&quot;</span>.getBytes))
<span class="hljs-comment">//the hash the oracle with sign when the bitcoin price is under $9,000</span>
<span class="hljs-keyword">val</span> loseHash = <span class="hljs-type">CryptoUtil</span>.sha256(<span class="hljs-type">ByteVector</span>(<span class="hljs-string">&quot;BTC_UNDER_9000&quot;</span>.getBytes))
<span class="hljs-comment">//the amounts received in the case the oracle signs hash of message &quot;BTC_OVER_9000&quot;</span>
<span class="hljs-keyword">val</span> amtReceivedOnWin = <span class="hljs-type">Satoshis</span>(<span class="hljs-number">100000</span>)
<span class="hljs-comment">//the amount received in the case the oracle signs hash of message &quot;BTC_UNDER_9000&quot;</span>
<span class="hljs-keyword">val</span> amtReceivedOnLoss = <span class="hljs-type">Satoshis</span>.zero
(pubKey.bytes ++ rValue.bytes).toHex
(winHash.bytes ++ amtReceivedOnWin.bytes ++ loseHash.bytes ++ amtReceivedOnLoss.bytes).toHex
privKey.schnorrSignWithNonce(winHash.bytes, kValue)
privKey.schnorrSignWithNonce(loseHash.bytes, kValue)
</code></pre>
<p>Where you can replace the messages <code>WIN</code> and <code>LOSE</code> to have the oracle sign any two messages, and replace <code>Satoshis(100000)</code> and <code>Satoshis.zero</code> to change the outcomes.</p>
<h2><a class="anchor" aria-hidden="true" id="using-the-gui"></a><a href="#using-the-gui" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Using the GUI</h2>
<p>See the <a href="/docs/next/getting-setup">setup document</a>.</p>
<p>Make sure to follow <a href="/docs/next/getting-setup#step-4-optional-discreet-log-contract-branch">Step 4</a> to checkout the <code>adaptor-dlc</code> feature branch.</p>
<h3><a class="anchor" aria-hidden="true" id="using-the-gui"></a><a href="#using-the-gui" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Using the GUI</h3>
<p>To first start up the GUI you first need to start your bitcoin-s server and gui with</p>
<pre><code class="hljs css language-bashrc">sbt bundle/<span class="hljs-keyword">run</span><span class="bash">
</span></code></pre>
<p>or if your bitcoin-s server is already running, you can run the standalone gui with</p>
<pre><code class="hljs css language-bashrc">sbt gui/<span class="hljs-keyword">run</span><span class="bash">
</span></code></pre>
<p>or by following the instructions for building and running the GUI <a href="../getting-setup#step-5-setting-up-a-bitcoin-s-server-neutrino-node">here</a></p>
<h3><a class="anchor" aria-hidden="true" id="step-3-setup-the-dlc"></a><a href="#step-3-setup-the-dlc" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Step 3: Setup The DLC</h3>
<p>If you're a visual learner there is a <a href="https://www.youtube.com/watch?v=zy1sL2ndcDg">video demo</a> that explains this process in detail. But do note that this demonstrates the old non-adaptor version of DLCs so that the Offer, Accept, Sign protocol is the same, but the contents will be different.</p>
<p>or by following the instructions for building and running the GUI <a href="/docs/next/getting-setup#step-5-setting-up-a-bitcoin-s-server">here</a></p>
<h2><a class="anchor" aria-hidden="true" id="step-2-agree-on-contract-terms"></a><a href="#step-2-agree-on-contract-terms" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Step 2: Agree On Contract Terms</h2>
<p>Both parties must agree on all fields from the table below:</p>
<table>
<thead>
<tr><th style="text-align:center">Field Name</th><th style="text-align:center">Description</th></tr>
</thead>
<tbody>
<tr><td style="text-align:center">contractInfo</td><td style="text-align:center">Information about payouts and which oracles to use</td></tr>
<tr><td style="text-align:center">collateral</td><td style="text-align:center">Number of sats the initiator is putting up</td></tr>
<tr><td style="text-align:center">locktime</td><td style="text-align:center">Locktime of the CETs</td></tr>
<tr><td style="text-align:center">refundlocktime</td><td style="text-align:center">Locktime of the Refund Transaction</td></tr>
<tr><td style="text-align:center">feerate</td><td style="text-align:center">Fee rate in sats/vbyte</td></tr>
</tbody>
</table>
<blockquote>
<p>Note: if you wish to set up your own oracle for testing, you can do so by checking out our <a href="/docs/next/oracle/oracle-server">oracle rpc server</a> or <a href="https://github.com/benthecarman/krystal-bull">Krystal Bull</a></p>
</blockquote>
<h2><a class="anchor" aria-hidden="true" id="step-3-set-up-the-dlc"></a><a href="#step-3-set-up-the-dlc" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Step 3: Set up The DLC</h2>
<h3><a class="anchor" aria-hidden="true" id="using-the-gui-1"></a><a href="#using-the-gui-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Using the GUI</h3>
<p>If you're a visual learner there is a <a href="https://www.youtube.com/watch?v=zy1sL2ndcDg">video demo</a> that explains this process in detail.
But do note that this demonstrates the old non-adaptor version of DLCs so that the Offer, Accept, Sign protocol is the same, but the contents will be different.</p>
<p>If using a numeric contract and/or multiple oracles, messages can get very large and sometimes even too large to for the application.
To solve this there is an <code>Export to file</code> button located under the text box for the messages your wallet will construct.
This can be used to export a DLC message to a file and then the file can be sent to your counter party.
If you receive a file from a counter-party, there is an <code>Import file</code> button on every dialog you input a DLC message.
This can be used to import the file of the DLC message from your counter-party.</p>
<h4><a class="anchor" aria-hidden="true" id="creating-the-offer"></a><a href="#creating-the-offer" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Creating The Offer</h4>
<p>Once the terms are agreed to, either party can use the <code>Offer</code> button and enter each of the fields from the table above.</p>
<h4><a class="anchor" aria-hidden="true" id="accepting-the-offer"></a><a href="#accepting-the-offer" 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>Accepting The Offer</h4>
@ -138,46 +109,62 @@ privKey.schnorrSignWithNonce(loseHash.bytes, kValue)
<h4><a class="anchor" aria-hidden="true" id="adding-dlc-signatures-to-your-database"></a><a href="#adding-dlc-signatures-to-your-database" 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>Adding DLC Signatures To Your Database</h4>
<p>Upon receiving a DLC Sign message from your counter-party, add their signatures to your database using the <code>Add Sigs</code> button and paste in the message.
After doing so you can get the fully signed funding transaction using the <code>Get Funding Tx</code> button. This will return the fully signed serialized transaction.</p>
<h3><a class="anchor" aria-hidden="true" id="step-4-executing-the-dlc"></a><a href="#step-4-executing-the-dlc" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Step 4: Executing the DLC</h3>
<h3><a class="anchor" aria-hidden="true" id="using-the-cli"></a><a href="#using-the-cli" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Using the CLI</h3>
<p>If using a numeric contract and/or multiple oracles, messages can get very large and sometimes even too large to for the application.
To solve this there are RPC calls where you can give a file instead of the entire DLC message.
To output a file you simply just need to pipe the output of a command into a file.</p>
<p>For example:</p>
<pre><code class="hljs css language-bashrc">.<span class="hljs-regexp">/app/</span>cli<span class="hljs-regexp">/target/u</span>niversal<span class="hljs-regexp">/stage/</span>bitcoin-s-cli acceptdlcoffer [offer] &gt; myDLCAccept.txt
</code></pre>
<h4><a class="anchor" aria-hidden="true" id="creating-the-offer-1"></a><a href="#creating-the-offer-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Creating The Offer</h4>
<p>Once these terms are agreed to, either party can call on <code>createdlcoffer</code> with flags for each of the fields in the table above. For example:</p>
<pre><code class="hljs css language-bashrc">.<span class="hljs-regexp">/app/</span>cli<span class="hljs-regexp">/target/u</span>niversal<span class="hljs-regexp">/stage/</span>bitcoin-s-cli createdlcoffer [contractInfo] [collateral] [feerate] [locktime] [refundlocktime]
</code></pre>
<h4><a class="anchor" aria-hidden="true" id="accepting-the-offer-1"></a><a href="#accepting-the-offer-1" 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>Accepting The Offer</h4>
<p>Upon receiving a DLC Offer from your counter-party, the following command will create the serialized accept message:</p>
<pre><code class="hljs css language-bashrc">.<span class="hljs-regexp">/app/</span>cli<span class="hljs-regexp">/target/u</span>niversal<span class="hljs-regexp">/stage/</span>bitcoin-s-cli acceptdlcoffer [offer]
</code></pre>
<p>or from file:</p>
<pre><code class="hljs css language-bashrc">.<span class="hljs-regexp">/app/</span>cli<span class="hljs-regexp">/target/u</span>niversal<span class="hljs-regexp">/stage/</span>bitcoin-s-cli acceptdlcofferfromfile [filepath]
</code></pre>
<h4><a class="anchor" aria-hidden="true" id="signing-the-dlc-1"></a><a href="#signing-the-dlc-1" 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>Signing The DLC</h4>
<p>Upon receiving a DLC Accept message from your counter-party, the following command will generate all of your signatures for this DLC:</p>
<pre><code class="hljs css language-bashrc">.<span class="hljs-regexp">/app/</span>cli<span class="hljs-regexp">/target/u</span>niversal<span class="hljs-regexp">/stage/</span>bitcoin-s-cli signdlc [accept]
</code></pre>
<p>or from file:</p>
<pre><code class="hljs css language-bashrc">.<span class="hljs-regexp">/app/</span>cli<span class="hljs-regexp">/target/u</span>niversal<span class="hljs-regexp">/stage/</span>bitcoin-s-cli signdlcfromfile [filepath]
</code></pre>
<h4><a class="anchor" aria-hidden="true" id="adding-dlc-signatures-to-your-database-1"></a><a href="#adding-dlc-signatures-to-your-database-1" 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>Adding DLC Signatures To Your Database</h4>
<p>Upon receiving a DLC Sign message from your counter-party, add their signatures to your database by:</p>
<pre><code class="hljs css language-bashrc">.<span class="hljs-regexp">/app/</span>cli<span class="hljs-regexp">/target/u</span>niversal<span class="hljs-regexp">/stage/</span>bitcoin-s-cli adddlcsigs [sign]
</code></pre>
<p>or from file:</p>
<pre><code class="hljs css language-bashrc">.<span class="hljs-regexp">/app/</span>cli<span class="hljs-regexp">/target/u</span>niversal<span class="hljs-regexp">/stage/</span>bitcoin-s-cli adddlcsigsfromfile [filepath]
</code></pre>
<h4><a class="anchor" aria-hidden="true" id="getting-funding-transaction"></a><a href="#getting-funding-transaction" 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>Getting Funding Transaction</h4>
<p>You are now fully setup and can generate the fully signed funding transaction for broadcast using</p>
<pre><code class="hljs css language-bashrc">.<span class="hljs-regexp">/app/</span>cli<span class="hljs-regexp">/target/u</span>niversal<span class="hljs-regexp">/stage/</span>bitcoin-s-cli getdlcfundingtx [contractId]
</code></pre>
<p>where the <code>contractId</code> is in all but the messages other than the DLC Offer message, and is also returned by the <code>adddlcsigs</code> command.</p>
<p>Alternatively, you can use the <code>getdlcs</code> command to list all of your current DLCs saved in your wallet.</p>
<h2><a class="anchor" aria-hidden="true" id="step-4-executing-the-dlc"></a><a href="#step-4-executing-the-dlc" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Step 4: Executing the DLC</h2>
<h3><a class="anchor" aria-hidden="true" id="using-the-gui-2"></a><a href="#using-the-gui-2" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Using the GUI</h3>
<h4><a class="anchor" aria-hidden="true" id="execute"></a><a href="#execute" 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>Execute</h4>
<p>You can execute the DLC unilaterally with the <code>Execute</code> button which will require the oracle signature.
This will return a fully signed Contract Execution Transaction for the event signed by the oracle.</p>
<h4><a class="anchor" aria-hidden="true" id="refund"></a><a href="#refund" 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>Refund</h4>
<p>If the <code>refundlocktime</code> for the DLC has been reached, you can get the fully-signed refund transaction with the <code>Refund</code> button.</p>
<h2><a class="anchor" aria-hidden="true" id="using-the-cli"></a><a href="#using-the-cli" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Using the CLI</h2>
<h3><a class="anchor" aria-hidden="true" id="step-3-setup-the-dlc-1"></a><a href="#step-3-setup-the-dlc-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Step 3: Setup The DLC</h3>
<h4><a class="anchor" aria-hidden="true" id="creating-the-offer-1"></a><a href="#creating-the-offer-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Creating The Offer</h4>
<p>Once these terms are agreed to, either party can call on <code>createdlcoffer</code> with flags for each of the fields in the table above. For example:</p>
<pre><code class="hljs css language-bashrc">./app/cli/<span class="hljs-keyword">target</span>/universal/stage/bitcoin-s-cli createdlcoffer --oracleInfo <span class="hljs-number">02</span>debeef<span class="hljs-number">17</span>d<span class="hljs-number">7</span>be<span class="hljs-number">7</span>ced<span class="hljs-number">0</span>bf<span class="hljs-number">346395</span>a<span class="hljs-number">5</span><span class="hljs-keyword">c</span><span class="hljs-number">5</span><span class="hljs-keyword">c</span><span class="hljs-number">7177491953e91</span>f<span class="hljs-number">0</span>af<span class="hljs-number">2</span>b<span class="hljs-number">098</span>aac<span class="hljs-number">5</span>d<span class="hljs-number">23</span>cabb<span class="hljs-number">1</span>a<span class="hljs-number">63752e5</span>a<span class="hljs-number">760</span>f<span class="hljs-number">47252545</span>b<span class="hljs-number">7</span>cda<span class="hljs-number">933</span>afeaf<span class="hljs-number">06</span>dba<span class="hljs-number">3</span>b<span class="hljs-number">6</span><span class="hljs-keyword">c</span><span class="hljs-number">6</span>fd<span class="hljs-number">5356781</span>f<span class="hljs-number">240</span><span class="hljs-keyword">c</span><span class="hljs-number">2750</span> --contractInfo <span class="hljs-keyword">c</span><span class="hljs-number">07803e32</span><span class="hljs-keyword">c</span><span class="hljs-number">12e100905</span>e<span class="hljs-number">8</span>d<span class="hljs-number">69</span>fe<span class="hljs-number">38</span>ae<span class="hljs-number">72</span>f<span class="hljs-number">2e7</span>a<span class="hljs-number">17</span>eb<span class="hljs-number">7</span>b<span class="hljs-number">8</span>dc<span class="hljs-number">1</span>a<span class="hljs-number">9</span>bce<span class="hljs-number">134</span>b<span class="hljs-number">0</span>cbe<span class="hljs-number">920</span>fa<span class="hljs-number">0860100000000005</span><span class="hljs-keyword">c</span><span class="hljs-number">58e41254</span>e<span class="hljs-number">7</span>a<span class="hljs-number">117</span>ee<span class="hljs-number">1</span>db<span class="hljs-number">59874</span>f<span class="hljs-number">2334</span>facc<span class="hljs-number">1576</span><span class="hljs-keyword">c</span><span class="hljs-number">238</span><span class="hljs-keyword">c</span><span class="hljs-number">16</span>d<span class="hljs-number">18767</span>b<span class="hljs-number">47861</span>f<span class="hljs-number">93</span>f<span class="hljs-number">7</span><span class="hljs-keyword">c</span><span class="hljs-number">0000000000000000</span> --collateral <span class="hljs-number">40000</span> --locktime <span class="hljs-number">1666720</span> --refundlocktime <span class="hljs-number">1666730</span> --feerate <span class="hljs-number">3</span>
</code></pre>
<p>This will return a nice pretty-printed JSON offer. To get an offer that can be sent to the counter-party, add the <code>--escaped</code> flag to the end of this command.</p>
<h4><a class="anchor" aria-hidden="true" id="accepting-the-offer-1"></a><a href="#accepting-the-offer-1" 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>Accepting The Offer</h4>
<p>Upon receiving a DLC Offer from your counter-party, the following command will create the serialized accept message:</p>
<pre><code class="hljs css language-bashrc">.<span class="hljs-regexp">/app/</span>cli<span class="hljs-regexp">/target/u</span>niversal<span class="hljs-regexp">/stage/</span>bitcoin-s-cli acceptdlcoffer --offer [offer] --escaped
</code></pre>
<h4><a class="anchor" aria-hidden="true" id="signing-the-dlc-1"></a><a href="#signing-the-dlc-1" 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>Signing The DLC</h4>
<p>Upon receiving a DLC Accept message from your counter-party, the following command will generate all of your signatures for this DLC:</p>
<pre><code class="hljs css language-bashrc">.<span class="hljs-regexp">/app/</span>cli<span class="hljs-regexp">/target/u</span>niversal<span class="hljs-regexp">/stage/</span>bitcoin-s-cli signdlc --accept [accept] --escaped
</code></pre>
<h4><a class="anchor" aria-hidden="true" id="adding-dlc-signatures-to-your-database-1"></a><a href="#adding-dlc-signatures-to-your-database-1" 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>Adding DLC Signatures To Your Database</h4>
<p>Upon receiving a DLC Sign message from your counter-party, add their signatures to your database by:</p>
<pre><code class="hljs css language-bashrc">.<span class="hljs-regexp">/app/</span>cli<span class="hljs-regexp">/target/u</span>niversal<span class="hljs-regexp">/stage/</span>bitcoin-s-cli adddlcsigs --sigs [sign]
</code></pre>
<p>You are now fully setup and can generate the fully signed funding transaction for broadcast using</p>
<pre><code class="hljs css language-bashrc">.<span class="hljs-regexp">/app/</span>cli<span class="hljs-regexp">/target/u</span>niversal<span class="hljs-regexp">/stage/</span>bitcoin-s-cli getdlcfundingtx --eventid [eventid]
</code></pre>
<p>where the <code>eventid</code> is in all but the messages other than the DLC Offer message, and is also returned by the <code>adddlcsigs</code> command.</p>
<h3><a class="anchor" aria-hidden="true" id="step-4-executing-the-dlc-1"></a><a href="#step-4-executing-the-dlc-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Step 4: Executing the DLC</h3>
<p>If the <code>refundlocktime</code> for the DLC has been reached, you can get the fully-signed refund transaction with the <code>Refund</code> button and entering the <code>contractId</code>.</p>
<h3><a class="anchor" aria-hidden="true" id="using-the-cli-1"></a><a href="#using-the-cli-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Using the CLI</h3>
<h4><a class="anchor" aria-hidden="true" id="execute-1"></a><a href="#execute-1" 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>Execute</h4>
<p>Upon receiving an oracle signature, you can execute the DLC unilaterally with</p>
<pre><code class="hljs css language-bashrc">.<span class="hljs-regexp">/app/</span>cli<span class="hljs-regexp">/target/u</span>niversal<span class="hljs-regexp">/stage/</span>bitcoin-s-cli executedlc --eventid [eventid] --oraclesig [sig]
<pre><code class="hljs css language-bashrc">.<span class="hljs-regexp">/app/</span>cli<span class="hljs-regexp">/target/u</span>niversal<span class="hljs-regexp">/stage/</span>bitcoin-s-cli executedlc [contractId] [signatureTLVs]
</code></pre>
<p>which will return fully signed Contract Execution Transaction for the event signed by the oracle.</p>
<h4><a class="anchor" aria-hidden="true" id="refund-1"></a><a href="#refund-1" 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>Refund</h4>
<p>If the <code>refundlocktime</code> for the DLC has been reached, you can get the fully-signed refund transaction with</p>
<pre><code class="hljs css language-bashrc">.<span class="hljs-regexp">/app/</span>cli<span class="hljs-regexp">/target/u</span>niversal<span class="hljs-regexp">/stage/</span>bitcoin-s-cli executedlcrefund --eventid [eventid]
<pre><code class="hljs css language-bashrc">.<span class="hljs-regexp">/app/</span>cli<span class="hljs-regexp">/target/u</span>niversal<span class="hljs-regexp">/stage/</span>bitcoin-s-cli executedlcrefund [contractId]
</code></pre>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/next/wallet/address-tagging"><span class="arrow-prev">← </span><span>Address and UTXO tagging</span></a><a class="docs-next button" href="/docs/next/wallet/wallet-rescan"><span>Wallet Rescans</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#executing-a-discreet-log-contract-dlc">Executing A Discreet Log Contract (DLC)</a></li><li><a href="#step-1-get-bitcoin-s-setup">Step 1: Get Bitcoin-S Setup</a></li><li><a href="#step-2-agree-on-contract-terms">Step 2: Agree On Contract Terms</a></li><li><a href="#using-the-gui">Using the GUI</a><ul class="toc-headings"><li><a href="#step-3-setup-the-dlc">Step 3: Setup The DLC</a></li><li><a href="#step-4-executing-the-dlc">Step 4: Executing the DLC</a></li></ul></li><li><a href="#using-the-cli">Using the CLI</a><ul class="toc-headings"><li><a href="#step-3-setup-the-dlc-1">Step 3: Setup The DLC</a></li><li><a href="#step-4-executing-the-dlc-1">Step 4: Executing the DLC</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/favicon.ico" alt="bitcoin-s" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/getting-started">Getting Started</a><a href="/docs/en/core/core-intro">Guides</a><a href="/api/org/bitcoins">API Reference</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="https://join.slack.com/t/suredbits/shared_invite/zt-eavycu0x-WQL7XOakzQo8tAy7jHHZUw" target="_blank" rel="noreferrer noopener">Slack</a><a href="https://gitter.im/bitcoin-s-core/">Gitter chat</a></div><div><h5>More</h5><a href="https://github.com/bitcoin-s/bitcoin-s">GitHub</a><a class="github-button" href="https://github.com/bitcoin-s/bitcoin-s" data-icon="octicon-star" data-count-href="/bitcoin-s/bitcoin-s-core/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2021 Suredbits &amp; the bitcoin-s developers</section></footer></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script><script>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/next/wallet/address-tagging"><span class="arrow-prev">← </span><span>Address and UTXO tagging</span></a><a class="docs-next button" href="/docs/next/wallet/wallet-rescan"><span>Wallet Rescans</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#executing-a-discreet-log-contract-dlc">Executing A Discreet Log Contract (DLC)</a></li><li><a href="#step-1-get-bitcoin-s-setup">Step 1: Get Bitcoin-S Setup</a><ul class="toc-headings"><li><a href="#using-the-gui">Using the GUI</a></li></ul></li><li><a href="#step-2-agree-on-contract-terms">Step 2: Agree On Contract Terms</a></li><li><a href="#step-3-set-up-the-dlc">Step 3: Set up The DLC</a><ul class="toc-headings"><li><a href="#using-the-gui-1">Using the GUI</a></li><li><a href="#using-the-cli">Using the CLI</a></li></ul></li><li><a href="#step-4-executing-the-dlc">Step 4: Executing the DLC</a><ul class="toc-headings"><li><a href="#using-the-gui-2">Using the GUI</a></li><li><a href="#using-the-cli-1">Using the CLI</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/favicon.ico" alt="bitcoin-s" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/getting-started">Getting Started</a><a href="/docs/en/core/core-intro">Guides</a><a href="/api/org/bitcoins">API Reference</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="https://join.slack.com/t/suredbits/shared_invite/zt-eavycu0x-WQL7XOakzQo8tAy7jHHZUw" target="_blank" rel="noreferrer noopener">Slack</a><a href="https://gitter.im/bitcoin-s-core/">Gitter chat</a></div><div><h5>More</h5><a href="https://github.com/bitcoin-s/bitcoin-s">GitHub</a><a class="github-button" href="https://github.com/bitcoin-s/bitcoin-s" data-icon="octicon-star" data-count-href="/bitcoin-s/bitcoin-s-core/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2021 Suredbits &amp; the bitcoin-s developers</section></footer></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script><script>
document.addEventListener('keyup', function(e) {
if (e.target !== document.body) {
return;

163
docs/next/wallet/dlc/index.html
View file

@ -64,71 +64,42 @@
});
</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/wallet/dlc.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">Executing A DLC with Bitcoin-S</h1></header><article><div><span><h2><a class="anchor" aria-hidden="true" id="executing-a-discreet-log-contract-dlc"></a><a href="#executing-a-discreet-log-contract-dlc" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Executing A Discreet Log Contract (DLC)</h2>
<h2><a class="anchor" aria-hidden="true" id="step-1-get-bitcoin-s-setup"></a><a href="#step-1-get-bitcoin-s-setup" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Step 1: Get Bitcoin-S Setup</h2>
<p>See the <a href="../getting-setup">setup document</a>.</p>
<p>Make sure to follow <a href="../getting-setup#step-4-optional-discreet-log-contract-branch">Step 4</a> to checkout the <code>adaptor-dlc</code> feature branch.</p>
<h2><a class="anchor" aria-hidden="true" id="step-2-agree-on-contract-terms"></a><a href="#step-2-agree-on-contract-terms" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Step 2: Agree On Contract Terms</h2>
<p>Both parties must agree on all fields from the table below:</p>
<table>
<thead>
<tr><th style="text-align:center">Field Name</th><th style="text-align:center">Format</th></tr>
</thead>
<tbody>
<tr><td style="text-align:center">oracleInfo</td><td style="text-align:center">OraclePubKeyHex ++ OracleRValueHex</td></tr>
<tr><td style="text-align:center">contractInfo</td><td style="text-align:center">Hash1Hex ++ 8ByteValue1Hex ++ Hash2Hex ++ 8ByteValue2Hex</td></tr>
<tr><td style="text-align:center">collateral</td><td style="text-align:center">NumInSatoshis</td></tr>
<tr><td style="text-align:center">locktime</td><td style="text-align:center">LockTimeNum</td></tr>
<tr><td style="text-align:center">refundlocktime</td><td style="text-align:center">LockTimeNum</td></tr>
<tr><td style="text-align:center">feerate</td><td style="text-align:center">NumInSatoshisPerVByte</td></tr>
</tbody>
</table>
<p>Here is an example <code>oracleInfo</code> for public key <code>02debeef17d7be7ced0bf346395a5c5c7177491953e91f0af2b098aac5d23cab</code> and R value <code>b1a63752e5a760f47252545b7cda933afeaf06dba3b6c6fd5356781f240c2750</code>:</p>
<pre><code class="hljs css language-bashrc"><span class="hljs-number">02</span>debeef<span class="hljs-number">17</span>d<span class="hljs-number">7</span>be<span class="hljs-number">7</span>ced<span class="hljs-number">0</span>bf<span class="hljs-number">346395</span>a<span class="hljs-number">5</span><span class="hljs-keyword">c</span><span class="hljs-number">5</span><span class="hljs-keyword">c</span><span class="hljs-number">7177491953e91</span>f<span class="hljs-number">0</span>af<span class="hljs-number">2</span>b<span class="hljs-number">098</span>aac<span class="hljs-number">5</span>d<span class="hljs-number">23</span>cabb<span class="hljs-number">1</span>a<span class="hljs-number">63752e5</span>a<span class="hljs-number">760</span>f<span class="hljs-number">47252545</span>b<span class="hljs-number">7</span>cda<span class="hljs-number">933</span>afeaf<span class="hljs-number">06</span>dba<span class="hljs-number">3</span>b<span class="hljs-number">6</span><span class="hljs-keyword">c</span><span class="hljs-number">6</span>fd<span class="hljs-number">5356781</span>f<span class="hljs-number">240</span><span class="hljs-keyword">c</span><span class="hljs-number">2750</span>
</code></pre>
<p>Here is an example <code>contractInfo</code> for hashes <code>c07803e32c12e100905e8d69fe38ae72f2e7a17eb7b8dc1a9bce134b0cbe920f</code> and <code>5c58e41254e7a117ee1db59874f2334facc1576c238c16d18767b47861f93f7c</code> with respective Satoshi denominated outcomes of <code>100000 sats</code> and <code>0 sats</code>:</p>
<pre><code class="hljs css language-bashrc"><span class="hljs-keyword">c</span><span class="hljs-number">07803e32</span><span class="hljs-keyword">c</span><span class="hljs-number">12e100905</span>e<span class="hljs-number">8</span>d<span class="hljs-number">69</span>fe<span class="hljs-number">38</span>ae<span class="hljs-number">72</span>f<span class="hljs-number">2e7</span>a<span class="hljs-number">17</span>eb<span class="hljs-number">7</span>b<span class="hljs-number">8</span>dc<span class="hljs-number">1</span>a<span class="hljs-number">9</span>bce<span class="hljs-number">134</span>b<span class="hljs-number">0</span>cbe<span class="hljs-number">920</span>fa<span class="hljs-number">0860100000000005</span><span class="hljs-keyword">c</span><span class="hljs-number">58e41254</span>e<span class="hljs-number">7</span>a<span class="hljs-number">117</span>ee<span class="hljs-number">1</span>db<span class="hljs-number">59874</span>f<span class="hljs-number">2334</span>facc<span class="hljs-number">1576</span><span class="hljs-keyword">c</span><span class="hljs-number">238</span><span class="hljs-keyword">c</span><span class="hljs-number">16</span>d<span class="hljs-number">18767</span>b<span class="hljs-number">47861</span>f<span class="hljs-number">93</span>f<span class="hljs-number">7</span><span class="hljs-keyword">c</span><span class="hljs-number">0000000000000000</span>
</code></pre>
<p>And finally, here are the oracle signatures for each hash in order in case you want to test with this contract:</p>
<pre><code class="hljs css language-bashrc">f<span class="hljs-number">8758</span>d<span class="hljs-number">7</span>f<span class="hljs-number">03</span>a<span class="hljs-number">65</span>b<span class="hljs-number">67</span>b<span class="hljs-number">90</span>f<span class="hljs-number">62301</span>a<span class="hljs-number">3554849</span>bde<span class="hljs-number">6</span>d<span class="hljs-number">00</span>d<span class="hljs-number">50e965</span>eb<span class="hljs-number">123398</span>de<span class="hljs-number">9</span>fd<span class="hljs-number">6</span>ea<span class="hljs-number">7</span>fbbee<span class="hljs-number">821</span>b<span class="hljs-number">7166028</span>a<span class="hljs-number">6927282830</span><span class="hljs-keyword">c</span><span class="hljs-number">9452</span>cfcf<span class="hljs-number">3</span><span class="hljs-keyword">c</span><span class="hljs-number">5716</span><span class="hljs-keyword">c</span><span class="hljs-number">57e43</span>dd<span class="hljs-number">4069</span>ca<span class="hljs-number">87625010</span>
</code></pre>
<pre><code class="hljs css language-bashrc"><span class="hljs-attribute">f8758d7f03a65b67b90f62301a3554849bde6d00d50e965eb123398de9fd6ea7af05f01f1ca852cf5454a7dc91cdad7903dc2e67ddb2b3bc9d61dabd8856aa6a</span>
</code></pre>
<p>Note: if you wish to setup your own oracle for testing, you can do so by pasting the following into the <code>sbt core/console</code>:</p>
<pre><code class="hljs css language-scala"><span class="hljs-keyword">import</span> org.bitcoins.crypto._
<span class="hljs-keyword">import</span> org.bitcoins.core.currency._
<span class="hljs-keyword">import</span> scodec.bits._
<span class="hljs-keyword">val</span> privKey = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey
<span class="hljs-keyword">val</span> pubKey = privKey.schnorrPublicKey
<span class="hljs-keyword">val</span> kValue = <span class="hljs-type">ECPrivateKey</span>.freshPrivateKey
<span class="hljs-keyword">val</span> rValue = kValue.schnorrNonce
<span class="hljs-comment">//the hash the oracle will sign when the bitcoin price is over $9,000</span>
<span class="hljs-keyword">val</span> winHash = <span class="hljs-type">CryptoUtil</span>.sha256(<span class="hljs-type">ByteVector</span>(<span class="hljs-string">&quot;BTC_OVER_9000&quot;</span>.getBytes))
<span class="hljs-comment">//the hash the oracle with sign when the bitcoin price is under $9,000</span>
<span class="hljs-keyword">val</span> loseHash = <span class="hljs-type">CryptoUtil</span>.sha256(<span class="hljs-type">ByteVector</span>(<span class="hljs-string">&quot;BTC_UNDER_9000&quot;</span>.getBytes))
<span class="hljs-comment">//the amounts received in the case the oracle signs hash of message &quot;BTC_OVER_9000&quot;</span>
<span class="hljs-keyword">val</span> amtReceivedOnWin = <span class="hljs-type">Satoshis</span>(<span class="hljs-number">100000</span>)
<span class="hljs-comment">//the amount received in the case the oracle signs hash of message &quot;BTC_UNDER_9000&quot;</span>
<span class="hljs-keyword">val</span> amtReceivedOnLoss = <span class="hljs-type">Satoshis</span>.zero
(pubKey.bytes ++ rValue.bytes).toHex
(winHash.bytes ++ amtReceivedOnWin.bytes ++ loseHash.bytes ++ amtReceivedOnLoss.bytes).toHex
privKey.schnorrSignWithNonce(winHash.bytes, kValue)
privKey.schnorrSignWithNonce(loseHash.bytes, kValue)
</code></pre>
<p>Where you can replace the messages <code>WIN</code> and <code>LOSE</code> to have the oracle sign any two messages, and replace <code>Satoshis(100000)</code> and <code>Satoshis.zero</code> to change the outcomes.</p>
<h2><a class="anchor" aria-hidden="true" id="using-the-gui"></a><a href="#using-the-gui" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Using the GUI</h2>
<p>See the <a href="/docs/next/getting-setup">setup document</a>.</p>
<p>Make sure to follow <a href="/docs/next/getting-setup#step-4-optional-discreet-log-contract-branch">Step 4</a> to checkout the <code>adaptor-dlc</code> feature branch.</p>
<h3><a class="anchor" aria-hidden="true" id="using-the-gui"></a><a href="#using-the-gui" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Using the GUI</h3>
<p>To first start up the GUI you first need to start your bitcoin-s server and gui with</p>
<pre><code class="hljs css language-bashrc">sbt bundle/<span class="hljs-keyword">run</span><span class="bash">
</span></code></pre>
<p>or if your bitcoin-s server is already running, you can run the standalone gui with</p>
<pre><code class="hljs css language-bashrc">sbt gui/<span class="hljs-keyword">run</span><span class="bash">
</span></code></pre>
<p>or by following the instructions for building and running the GUI <a href="../getting-setup#step-5-setting-up-a-bitcoin-s-server-neutrino-node">here</a></p>
<h3><a class="anchor" aria-hidden="true" id="step-3-setup-the-dlc"></a><a href="#step-3-setup-the-dlc" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Step 3: Setup The DLC</h3>
<p>If you're a visual learner there is a <a href="https://www.youtube.com/watch?v=zy1sL2ndcDg">video demo</a> that explains this process in detail. But do note that this demonstrates the old non-adaptor version of DLCs so that the Offer, Accept, Sign protocol is the same, but the contents will be different.</p>
<p>or by following the instructions for building and running the GUI <a href="/docs/next/getting-setup#step-5-setting-up-a-bitcoin-s-server">here</a></p>
<h2><a class="anchor" aria-hidden="true" id="step-2-agree-on-contract-terms"></a><a href="#step-2-agree-on-contract-terms" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Step 2: Agree On Contract Terms</h2>
<p>Both parties must agree on all fields from the table below:</p>
<table>
<thead>
<tr><th style="text-align:center">Field Name</th><th style="text-align:center">Description</th></tr>
</thead>
<tbody>
<tr><td style="text-align:center">contractInfo</td><td style="text-align:center">Information about payouts and which oracles to use</td></tr>
<tr><td style="text-align:center">collateral</td><td style="text-align:center">Number of sats the initiator is putting up</td></tr>
<tr><td style="text-align:center">locktime</td><td style="text-align:center">Locktime of the CETs</td></tr>
<tr><td style="text-align:center">refundlocktime</td><td style="text-align:center">Locktime of the Refund Transaction</td></tr>
<tr><td style="text-align:center">feerate</td><td style="text-align:center">Fee rate in sats/vbyte</td></tr>
</tbody>
</table>
<blockquote>
<p>Note: if you wish to set up your own oracle for testing, you can do so by checking out our <a href="/docs/next/oracle/oracle-server">oracle rpc server</a> or <a href="https://github.com/benthecarman/krystal-bull">Krystal Bull</a></p>
</blockquote>
<h2><a class="anchor" aria-hidden="true" id="step-3-set-up-the-dlc"></a><a href="#step-3-set-up-the-dlc" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Step 3: Set up The DLC</h2>
<h3><a class="anchor" aria-hidden="true" id="using-the-gui-1"></a><a href="#using-the-gui-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Using the GUI</h3>
<p>If you're a visual learner there is a <a href="https://www.youtube.com/watch?v=zy1sL2ndcDg">video demo</a> that explains this process in detail.
But do note that this demonstrates the old non-adaptor version of DLCs so that the Offer, Accept, Sign protocol is the same, but the contents will be different.</p>
<p>If using a numeric contract and/or multiple oracles, messages can get very large and sometimes even too large to for the application.
To solve this there is an <code>Export to file</code> button located under the text box for the messages your wallet will construct.
This can be used to export a DLC message to a file and then the file can be sent to your counter party.
If you receive a file from a counter-party, there is an <code>Import file</code> button on every dialog you input a DLC message.
This can be used to import the file of the DLC message from your counter-party.</p>
<h4><a class="anchor" aria-hidden="true" id="creating-the-offer"></a><a href="#creating-the-offer" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Creating The Offer</h4>
<p>Once the terms are agreed to, either party can use the <code>Offer</code> button and enter each of the fields from the table above.</p>
<h4><a class="anchor" aria-hidden="true" id="accepting-the-offer"></a><a href="#accepting-the-offer" 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>Accepting The Offer</h4>
@ -138,46 +109,62 @@ privKey.schnorrSignWithNonce(loseHash.bytes, kValue)
<h4><a class="anchor" aria-hidden="true" id="adding-dlc-signatures-to-your-database"></a><a href="#adding-dlc-signatures-to-your-database" 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>Adding DLC Signatures To Your Database</h4>
<p>Upon receiving a DLC Sign message from your counter-party, add their signatures to your database using the <code>Add Sigs</code> button and paste in the message.
After doing so you can get the fully signed funding transaction using the <code>Get Funding Tx</code> button. This will return the fully signed serialized transaction.</p>
<h3><a class="anchor" aria-hidden="true" id="step-4-executing-the-dlc"></a><a href="#step-4-executing-the-dlc" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Step 4: Executing the DLC</h3>
<h3><a class="anchor" aria-hidden="true" id="using-the-cli"></a><a href="#using-the-cli" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Using the CLI</h3>
<p>If using a numeric contract and/or multiple oracles, messages can get very large and sometimes even too large to for the application.
To solve this there are RPC calls where you can give a file instead of the entire DLC message.
To output a file you simply just need to pipe the output of a command into a file.</p>
<p>For example:</p>
<pre><code class="hljs css language-bashrc">.<span class="hljs-regexp">/app/</span>cli<span class="hljs-regexp">/target/u</span>niversal<span class="hljs-regexp">/stage/</span>bitcoin-s-cli acceptdlcoffer [offer] &gt; myDLCAccept.txt
</code></pre>
<h4><a class="anchor" aria-hidden="true" id="creating-the-offer-1"></a><a href="#creating-the-offer-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Creating The Offer</h4>
<p>Once these terms are agreed to, either party can call on <code>createdlcoffer</code> with flags for each of the fields in the table above. For example:</p>
<pre><code class="hljs css language-bashrc">.<span class="hljs-regexp">/app/</span>cli<span class="hljs-regexp">/target/u</span>niversal<span class="hljs-regexp">/stage/</span>bitcoin-s-cli createdlcoffer [contractInfo] [collateral] [feerate] [locktime] [refundlocktime]
</code></pre>
<h4><a class="anchor" aria-hidden="true" id="accepting-the-offer-1"></a><a href="#accepting-the-offer-1" 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>Accepting The Offer</h4>
<p>Upon receiving a DLC Offer from your counter-party, the following command will create the serialized accept message:</p>
<pre><code class="hljs css language-bashrc">.<span class="hljs-regexp">/app/</span>cli<span class="hljs-regexp">/target/u</span>niversal<span class="hljs-regexp">/stage/</span>bitcoin-s-cli acceptdlcoffer [offer]
</code></pre>
<p>or from file:</p>
<pre><code class="hljs css language-bashrc">.<span class="hljs-regexp">/app/</span>cli<span class="hljs-regexp">/target/u</span>niversal<span class="hljs-regexp">/stage/</span>bitcoin-s-cli acceptdlcofferfromfile [filepath]
</code></pre>
<h4><a class="anchor" aria-hidden="true" id="signing-the-dlc-1"></a><a href="#signing-the-dlc-1" 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>Signing The DLC</h4>
<p>Upon receiving a DLC Accept message from your counter-party, the following command will generate all of your signatures for this DLC:</p>
<pre><code class="hljs css language-bashrc">.<span class="hljs-regexp">/app/</span>cli<span class="hljs-regexp">/target/u</span>niversal<span class="hljs-regexp">/stage/</span>bitcoin-s-cli signdlc [accept]
</code></pre>
<p>or from file:</p>
<pre><code class="hljs css language-bashrc">.<span class="hljs-regexp">/app/</span>cli<span class="hljs-regexp">/target/u</span>niversal<span class="hljs-regexp">/stage/</span>bitcoin-s-cli signdlcfromfile [filepath]
</code></pre>
<h4><a class="anchor" aria-hidden="true" id="adding-dlc-signatures-to-your-database-1"></a><a href="#adding-dlc-signatures-to-your-database-1" 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>Adding DLC Signatures To Your Database</h4>
<p>Upon receiving a DLC Sign message from your counter-party, add their signatures to your database by:</p>
<pre><code class="hljs css language-bashrc">.<span class="hljs-regexp">/app/</span>cli<span class="hljs-regexp">/target/u</span>niversal<span class="hljs-regexp">/stage/</span>bitcoin-s-cli adddlcsigs [sign]
</code></pre>
<p>or from file:</p>
<pre><code class="hljs css language-bashrc">.<span class="hljs-regexp">/app/</span>cli<span class="hljs-regexp">/target/u</span>niversal<span class="hljs-regexp">/stage/</span>bitcoin-s-cli adddlcsigsfromfile [filepath]
</code></pre>
<h4><a class="anchor" aria-hidden="true" id="getting-funding-transaction"></a><a href="#getting-funding-transaction" 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>Getting Funding Transaction</h4>
<p>You are now fully setup and can generate the fully signed funding transaction for broadcast using</p>
<pre><code class="hljs css language-bashrc">.<span class="hljs-regexp">/app/</span>cli<span class="hljs-regexp">/target/u</span>niversal<span class="hljs-regexp">/stage/</span>bitcoin-s-cli getdlcfundingtx [contractId]
</code></pre>
<p>where the <code>contractId</code> is in all but the messages other than the DLC Offer message, and is also returned by the <code>adddlcsigs</code> command.</p>
<p>Alternatively, you can use the <code>getdlcs</code> command to list all of your current DLCs saved in your wallet.</p>
<h2><a class="anchor" aria-hidden="true" id="step-4-executing-the-dlc"></a><a href="#step-4-executing-the-dlc" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Step 4: Executing the DLC</h2>
<h3><a class="anchor" aria-hidden="true" id="using-the-gui-2"></a><a href="#using-the-gui-2" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Using the GUI</h3>
<h4><a class="anchor" aria-hidden="true" id="execute"></a><a href="#execute" 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>Execute</h4>
<p>You can execute the DLC unilaterally with the <code>Execute</code> button which will require the oracle signature.
This will return a fully signed Contract Execution Transaction for the event signed by the oracle.</p>
<h4><a class="anchor" aria-hidden="true" id="refund"></a><a href="#refund" 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>Refund</h4>
<p>If the <code>refundlocktime</code> for the DLC has been reached, you can get the fully-signed refund transaction with the <code>Refund</code> button.</p>
<h2><a class="anchor" aria-hidden="true" id="using-the-cli"></a><a href="#using-the-cli" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Using the CLI</h2>
<h3><a class="anchor" aria-hidden="true" id="step-3-setup-the-dlc-1"></a><a href="#step-3-setup-the-dlc-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Step 3: Setup The DLC</h3>
<h4><a class="anchor" aria-hidden="true" id="creating-the-offer-1"></a><a href="#creating-the-offer-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Creating The Offer</h4>
<p>Once these terms are agreed to, either party can call on <code>createdlcoffer</code> with flags for each of the fields in the table above. For example:</p>
<pre><code class="hljs css language-bashrc">./app/cli/<span class="hljs-keyword">target</span>/universal/stage/bitcoin-s-cli createdlcoffer --oracleInfo <span class="hljs-number">02</span>debeef<span class="hljs-number">17</span>d<span class="hljs-number">7</span>be<span class="hljs-number">7</span>ced<span class="hljs-number">0</span>bf<span class="hljs-number">346395</span>a<span class="hljs-number">5</span><span class="hljs-keyword">c</span><span class="hljs-number">5</span><span class="hljs-keyword">c</span><span class="hljs-number">7177491953e91</span>f<span class="hljs-number">0</span>af<span class="hljs-number">2</span>b<span class="hljs-number">098</span>aac<span class="hljs-number">5</span>d<span class="hljs-number">23</span>cabb<span class="hljs-number">1</span>a<span class="hljs-number">63752e5</span>a<span class="hljs-number">760</span>f<span class="hljs-number">47252545</span>b<span class="hljs-number">7</span>cda<span class="hljs-number">933</span>afeaf<span class="hljs-number">06</span>dba<span class="hljs-number">3</span>b<span class="hljs-number">6</span><span class="hljs-keyword">c</span><span class="hljs-number">6</span>fd<span class="hljs-number">5356781</span>f<span class="hljs-number">240</span><span class="hljs-keyword">c</span><span class="hljs-number">2750</span> --contractInfo <span class="hljs-keyword">c</span><span class="hljs-number">07803e32</span><span class="hljs-keyword">c</span><span class="hljs-number">12e100905</span>e<span class="hljs-number">8</span>d<span class="hljs-number">69</span>fe<span class="hljs-number">38</span>ae<span class="hljs-number">72</span>f<span class="hljs-number">2e7</span>a<span class="hljs-number">17</span>eb<span class="hljs-number">7</span>b<span class="hljs-number">8</span>dc<span class="hljs-number">1</span>a<span class="hljs-number">9</span>bce<span class="hljs-number">134</span>b<span class="hljs-number">0</span>cbe<span class="hljs-number">920</span>fa<span class="hljs-number">0860100000000005</span><span class="hljs-keyword">c</span><span class="hljs-number">58e41254</span>e<span class="hljs-number">7</span>a<span class="hljs-number">117</span>ee<span class="hljs-number">1</span>db<span class="hljs-number">59874</span>f<span class="hljs-number">2334</span>facc<span class="hljs-number">1576</span><span class="hljs-keyword">c</span><span class="hljs-number">238</span><span class="hljs-keyword">c</span><span class="hljs-number">16</span>d<span class="hljs-number">18767</span>b<span class="hljs-number">47861</span>f<span class="hljs-number">93</span>f<span class="hljs-number">7</span><span class="hljs-keyword">c</span><span class="hljs-number">0000000000000000</span> --collateral <span class="hljs-number">40000</span> --locktime <span class="hljs-number">1666720</span> --refundlocktime <span class="hljs-number">1666730</span> --feerate <span class="hljs-number">3</span>
</code></pre>
<p>This will return a nice pretty-printed JSON offer. To get an offer that can be sent to the counter-party, add the <code>--escaped</code> flag to the end of this command.</p>
<h4><a class="anchor" aria-hidden="true" id="accepting-the-offer-1"></a><a href="#accepting-the-offer-1" 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>Accepting The Offer</h4>
<p>Upon receiving a DLC Offer from your counter-party, the following command will create the serialized accept message:</p>
<pre><code class="hljs css language-bashrc">.<span class="hljs-regexp">/app/</span>cli<span class="hljs-regexp">/target/u</span>niversal<span class="hljs-regexp">/stage/</span>bitcoin-s-cli acceptdlcoffer --offer [offer] --escaped
</code></pre>
<h4><a class="anchor" aria-hidden="true" id="signing-the-dlc-1"></a><a href="#signing-the-dlc-1" 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>Signing The DLC</h4>
<p>Upon receiving a DLC Accept message from your counter-party, the following command will generate all of your signatures for this DLC:</p>
<pre><code class="hljs css language-bashrc">.<span class="hljs-regexp">/app/</span>cli<span class="hljs-regexp">/target/u</span>niversal<span class="hljs-regexp">/stage/</span>bitcoin-s-cli signdlc --accept [accept] --escaped
</code></pre>
<h4><a class="anchor" aria-hidden="true" id="adding-dlc-signatures-to-your-database-1"></a><a href="#adding-dlc-signatures-to-your-database-1" 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>Adding DLC Signatures To Your Database</h4>
<p>Upon receiving a DLC Sign message from your counter-party, add their signatures to your database by:</p>
<pre><code class="hljs css language-bashrc">.<span class="hljs-regexp">/app/</span>cli<span class="hljs-regexp">/target/u</span>niversal<span class="hljs-regexp">/stage/</span>bitcoin-s-cli adddlcsigs --sigs [sign]
</code></pre>
<p>You are now fully setup and can generate the fully signed funding transaction for broadcast using</p>
<pre><code class="hljs css language-bashrc">.<span class="hljs-regexp">/app/</span>cli<span class="hljs-regexp">/target/u</span>niversal<span class="hljs-regexp">/stage/</span>bitcoin-s-cli getdlcfundingtx --eventid [eventid]
</code></pre>
<p>where the <code>eventid</code> is in all but the messages other than the DLC Offer message, and is also returned by the <code>adddlcsigs</code> command.</p>
<h3><a class="anchor" aria-hidden="true" id="step-4-executing-the-dlc-1"></a><a href="#step-4-executing-the-dlc-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Step 4: Executing the DLC</h3>
<p>If the <code>refundlocktime</code> for the DLC has been reached, you can get the fully-signed refund transaction with the <code>Refund</code> button and entering the <code>contractId</code>.</p>
<h3><a class="anchor" aria-hidden="true" id="using-the-cli-1"></a><a href="#using-the-cli-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Using the CLI</h3>
<h4><a class="anchor" aria-hidden="true" id="execute-1"></a><a href="#execute-1" 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>Execute</h4>
<p>Upon receiving an oracle signature, you can execute the DLC unilaterally with</p>
<pre><code class="hljs css language-bashrc">.<span class="hljs-regexp">/app/</span>cli<span class="hljs-regexp">/target/u</span>niversal<span class="hljs-regexp">/stage/</span>bitcoin-s-cli executedlc --eventid [eventid] --oraclesig [sig]
<pre><code class="hljs css language-bashrc">.<span class="hljs-regexp">/app/</span>cli<span class="hljs-regexp">/target/u</span>niversal<span class="hljs-regexp">/stage/</span>bitcoin-s-cli executedlc [contractId] [signatureTLVs]
</code></pre>
<p>which will return fully signed Contract Execution Transaction for the event signed by the oracle.</p>
<h4><a class="anchor" aria-hidden="true" id="refund-1"></a><a href="#refund-1" 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>Refund</h4>
<p>If the <code>refundlocktime</code> for the DLC has been reached, you can get the fully-signed refund transaction with</p>
<pre><code class="hljs css language-bashrc">.<span class="hljs-regexp">/app/</span>cli<span class="hljs-regexp">/target/u</span>niversal<span class="hljs-regexp">/stage/</span>bitcoin-s-cli executedlcrefund --eventid [eventid]
<pre><code class="hljs css language-bashrc">.<span class="hljs-regexp">/app/</span>cli<span class="hljs-regexp">/target/u</span>niversal<span class="hljs-regexp">/stage/</span>bitcoin-s-cli executedlcrefund [contractId]
</code></pre>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/next/wallet/address-tagging"><span class="arrow-prev">← </span><span>Address and UTXO tagging</span></a><a class="docs-next button" href="/docs/next/wallet/wallet-rescan"><span>Wallet Rescans</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#executing-a-discreet-log-contract-dlc">Executing A Discreet Log Contract (DLC)</a></li><li><a href="#step-1-get-bitcoin-s-setup">Step 1: Get Bitcoin-S Setup</a></li><li><a href="#step-2-agree-on-contract-terms">Step 2: Agree On Contract Terms</a></li><li><a href="#using-the-gui">Using the GUI</a><ul class="toc-headings"><li><a href="#step-3-setup-the-dlc">Step 3: Setup The DLC</a></li><li><a href="#step-4-executing-the-dlc">Step 4: Executing the DLC</a></li></ul></li><li><a href="#using-the-cli">Using the CLI</a><ul class="toc-headings"><li><a href="#step-3-setup-the-dlc-1">Step 3: Setup The DLC</a></li><li><a href="#step-4-executing-the-dlc-1">Step 4: Executing the DLC</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/favicon.ico" alt="bitcoin-s" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/getting-started">Getting Started</a><a href="/docs/en/core/core-intro">Guides</a><a href="/api/org/bitcoins">API Reference</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="https://join.slack.com/t/suredbits/shared_invite/zt-eavycu0x-WQL7XOakzQo8tAy7jHHZUw" target="_blank" rel="noreferrer noopener">Slack</a><a href="https://gitter.im/bitcoin-s-core/">Gitter chat</a></div><div><h5>More</h5><a href="https://github.com/bitcoin-s/bitcoin-s">GitHub</a><a class="github-button" href="https://github.com/bitcoin-s/bitcoin-s" data-icon="octicon-star" data-count-href="/bitcoin-s/bitcoin-s-core/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2021 Suredbits &amp; the bitcoin-s developers</section></footer></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script><script>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/next/wallet/address-tagging"><span class="arrow-prev">← </span><span>Address and UTXO tagging</span></a><a class="docs-next button" href="/docs/next/wallet/wallet-rescan"><span>Wallet Rescans</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#executing-a-discreet-log-contract-dlc">Executing A Discreet Log Contract (DLC)</a></li><li><a href="#step-1-get-bitcoin-s-setup">Step 1: Get Bitcoin-S Setup</a><ul class="toc-headings"><li><a href="#using-the-gui">Using the GUI</a></li></ul></li><li><a href="#step-2-agree-on-contract-terms">Step 2: Agree On Contract Terms</a></li><li><a href="#step-3-set-up-the-dlc">Step 3: Set up The DLC</a><ul class="toc-headings"><li><a href="#using-the-gui-1">Using the GUI</a></li><li><a href="#using-the-cli">Using the CLI</a></li></ul></li><li><a href="#step-4-executing-the-dlc">Step 4: Executing the DLC</a><ul class="toc-headings"><li><a href="#using-the-gui-2">Using the GUI</a></li><li><a href="#using-the-cli-1">Using the CLI</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/favicon.ico" alt="bitcoin-s" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/getting-started">Getting Started</a><a href="/docs/en/core/core-intro">Guides</a><a href="/api/org/bitcoins">API Reference</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="https://join.slack.com/t/suredbits/shared_invite/zt-eavycu0x-WQL7XOakzQo8tAy7jHHZUw" target="_blank" rel="noreferrer noopener">Slack</a><a href="https://gitter.im/bitcoin-s-core/">Gitter chat</a></div><div><h5>More</h5><a href="https://github.com/bitcoin-s/bitcoin-s">GitHub</a><a class="github-button" href="https://github.com/bitcoin-s/bitcoin-s" data-icon="octicon-star" data-count-href="/bitcoin-s/bitcoin-s-core/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2021 Suredbits &amp; the bitcoin-s developers</section></footer></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script><script>
document.addEventListener('keyup', function(e) {
if (e.target !== document.body) {
return;