2021-04-21 12:50:07 +00:00
<!DOCTYPE html> < html lang = "en" > < head > < meta charSet = "utf-8" / > < meta http-equiv = "X-UA-Compatible" content = "IE=edge" / > < title > Executing A DLC with Bitcoin-S · bitcoin-s< / title > < meta name = "viewport" content = "width=device-width, initial-scale=1.0" / > < meta name = "generator" content = "Docusaurus" / > < meta name = "description" content = "## Executing A Discreet Log Contract (DLC)" / > < meta name = "docsearch:version" content = "next" / > < meta name = "docsearch:language" content = "en" / > < meta property = "og:title" content = "Executing A DLC with Bitcoin-S · bitcoin-s" / > < meta property = "og:type" content = "website" / > < meta property = "og:url" content = "https://bitcoin-s.org/" / > < meta property = "og:description" content = "## Executing A Discreet Log Contract (DLC)" / > < meta property = "og:image" content = "https://bitcoin-s.org/img/undraw_online.svg" / > < meta name = "twitter:card" content = "summary" / > < meta name = "twitter:image" content = "https://bitcoin-s.org/img/undraw_tweetstorm.svg" / > < link rel = "shortcut icon" href = "/img/favicon.ico" / > < link rel = "stylesheet" href = "https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css" / > < link rel = "stylesheet" href = "//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css" / > < script >
2020-04-02 12:36:04 +00:00
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-61958686-2', 'auto');
ga('send', 'pageview');
2021-07-06 16:15:27 +00:00
< / script > < link rel = "stylesheet" href = "/css/code-block-buttons.css" / > < script type = "text/javascript" src = "https://buttons.github.io/buttons.js" > < / script > < script type = "text/javascript" src = "https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js" > < / script > < script type = "text/javascript" src = "https://fonts.googleapis.com/css?family=Montserrat:500" > < / script > < script type = "text/javascript" src = "https://www.googletagmanager.com/gtag/js?id=UA-61958686-2" > < / script > < script type = "text/javascript" src = "/js/code-block-buttons.js" > < / script > < script src = "/js/scrollSpy.js" > < / script > < link rel = "stylesheet" href = "/css/main.css" / > < script src = "/js/codetabs.js" > < / script > < / head > < body class = "sideNavVisible separateOnPageNav" > < div class = "fixedHeaderContainer" > < div class = "headerWrapper wrapper" > < header > < a href = "/" > < img class = "logo" src = "/img/favicon.ico" alt = "bitcoin-s" / > < h2 class = "headerTitleWithLogo" > bitcoin-s< / h2 > < / a > < a href = "/versions" > < h3 > next< / h3 > < / a > < div class = "navigationWrapper navigationSlider" > < nav class = "slidingNav" > < ul class = "nav-site nav-site-internal" > < li class = "siteNavGroupActive" > < a href = "/docs/next/core/core-intro" target = "_self" > Docs< / a > < / li > < li class = "" > < a href = "download" target = "_self" > Download< / a > < / li > < li class = "" > < a href = "/api/org/bitcoins" target = "_self" > API< / a > < / li > < li class = "" > < a href = "/help" target = "_self" > Help< / a > < / li > < li class = "navSearchWrapper reactNavSearchWrapper" > < input type = "text" id = "search_input_react" placeholder = "Search" title = "Search" / > < / li > < / ul > < / nav > < / div > < / header > < / div > < / div > < div class = "navPusher" > < div class = "docMainWrapper wrapper" > < div class = "docsNavContainer" id = "docsNav" > < nav class = "toc" > < div class = "toggleNav" > < section class = "navWrapper wrapper" > < div class = "navBreadcrumb wrapper" > < div class = "navToggle" id = "navToggler" > < div class = "hamburger-menu" > < div class = "line1" > < / div > < div class = "line2" > < / div > < div class = "line3" > < / div > < / div > < / div > < h2 > < i > › < / i > < span > Wallet< / span > < / h2 > < div class = "tocToggler" id = "tocToggler" > < i class = "icon-toc" > < / i > < / div > < / div > < div class = "navGroups" > < div class = "navGroup" > < h3 class = "navGroupCategoryTitle" > Getting Started< / h3 > < ul class = "" > < li class = "navListItem" > < a class = "navItem" href = "/docs/next/getting-started" > Intro and Getting Started< / a > < / li > < li class = "navListItem" > < a class = "navItem" href = "/docs/next/bips" > Supported BIPs< / a > < / li > < / ul > < / div > < div class = "navGroup" > < h3 class = "navGroupCategoryTitle" > Getting Setup< / h3 > < ul class = "" > < li class = "navListItem" > < a class = "navItem" href = "/docs/next/getting-setup" > Getting Bitcoin-S installed on your machine< / a > < / li > < / ul > < / div > < div class = "navGroup" > < h3 class = "navGroupCategoryTitle" > Applications< / h3 > < ul class = "" > < li class = "navListItem" > < a class = "navItem" href = "/docs/next/applications/cli" > CLI< / a > < / li > < li class = "navListItem" > < a class = "navItem" href = "/docs/next/applications/server" > Application Server< / a > < / li > < li class = "navListItem" > < a class = "navItem" href = "/docs/next/applications/gui" > GUI< / a > < / li > < li class = "navListItem" > < a class = "navItem" href = "/docs/next/applications/server-systemd" > Systemd installation< / a > < / li > < / ul > < / div > < div class = "navGroup" > < h3 class = "navGroupCategoryTitle" > Chain< / h3 > < ul class = "" > < li class = "navListItem" > < a class = "navItem" href = "/docs/next/chain/chain" > Blockchain Verification< / a > < / li > < li class = "navListItem" > < a class = "navItem" href = "/docs/next/chain/filter-sync" > Syncing Blockfilters< / a > < / li > < li class = "navListItem" > < a class = "navItem" href = "/docs/next/chain/chain-query-api" > Chain Query API< / a > < / li > < / ul > < / div > < div class = "navGroup" > < h3 class = "navGroupCategoryTitle" > Configuration< / h3 > < ul class = "" > < li class = "navListItem" > < a class = "navItem" href = "/docs/next/config/configuration" > Application Configuration< / a > < / li > < / ul > < / div > < div class = "navGroup" > < h3 class = "navGroupCategoryTitle" > Core Module< / h3 > < ul class = "" > < li class = "navListItem" > < a class = "navItem" href = "/docs/next/core/core-intro" > Core Module< / a > < / li > < li class = "navListItem" > < a class = "navItem" href = "/docs/next/core/addresses" > Generating Addresses< / a > < / li > < li class = "navListItem" > < a class = "navItem" href = "/docs/next/core/hd-keys" > HD Key Generation< / a > < / li > < li class
2020-02-26 20:18:39 +00:00
var coll = document.getElementsByClassName('collapsible');
var checkActiveCategory = true;
for (var i = 0; i < coll.length ; i + + ) {
var links = coll[i].nextElementSibling.getElementsByTagName('*');
if (checkActiveCategory){
for (var j = 0; j < links.length ; j + + ) {
if (links[j].classList.contains('navListItemActive')){
coll[i].nextElementSibling.classList.toggle('hide');
coll[i].childNodes[1].classList.toggle('rotate');
checkActiveCategory = false;
break;
}
}
}
coll[i].addEventListener('click', function() {
var arrow = this.childNodes[1];
arrow.classList.toggle('rotate');
var content = this.nextElementSibling;
content.classList.toggle('hide');
});
}
document.addEventListener('DOMContentLoaded', function() {
createToggler('#navToggler', '#docsNav', 'docsSliderActive');
createToggler('#tocToggler', 'body', 'tocActive');
var headings = document.querySelector('.toc-headings');
headings & & headings.addEventListener('click', function(event) {
var el = event.target;
while(el !== headings){
if (el.tagName === 'A') {
document.body.classList.remove('tocActive');
break;
} else{
el = el.parentNode;
}
}
}, false);
function createToggler(togglerSelector, targetSelector, className) {
var toggler = document.querySelector(togglerSelector);
var target = document.querySelector(targetSelector);
if (!toggler) {
return;
}
toggler.onclick = function(event) {
event.preventDefault();
target.classList.toggle(className);
};
}
});
2020-03-13 15:02:35 +00:00
< / 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 >
2020-02-26 20:18:39 +00:00
< 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 >
2021-02-02 13:37:52 +00:00
< p > See the < a href = "/docs/next/getting-setup" > setup document< / a > .< / 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 = "/docs/next/getting-setup#step-5-setting-up-a-bitcoin-s-server" > here< / a > < / p >
2020-02-26 20:18:39 +00:00
< 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 >
2021-02-02 13:37:52 +00:00
< tr > < th style = "text-align:center" > Field Name< / th > < th style = "text-align:center" > Description< / th > < / tr >
2020-02-26 20:18:39 +00:00
< / thead >
< tbody >
2021-02-02 13:37:52 +00:00
< 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 >
2020-02-26 20:18:39 +00:00
< / tbody >
< / table >
2021-02-02 13:37:52 +00:00
< 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 >
2020-05-19 01:11:38 +00:00
< 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 >
< p > Upon receiving a DLC Offer from your counter-party, you can use the < code > Accept< / code > button and paste in the DLC Offer.< / p >
< h4 > < a class = "anchor" aria-hidden = "true" id = "signing-the-dlc" > < / a > < a href = "#signing-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 > Signing The DLC< / h4 >
< p > Upon receiving a DLC Accept message from your counter-party, you can use the < code > Sign< / code > button and paste in the DLC Accept.< / p >
< 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 >
2021-02-02 13:37:52 +00:00
< 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] > myDLCAccept.txt
< / code > < / pre >
2020-05-19 01:11:38 +00:00
< 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 >
2020-02-26 20:18:39 +00:00
< 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 >
2021-02-02 13:37:52 +00:00
< pre > < code class = "hljs css language-bashrc" > ./app/cli/target/universal/stage/bitcoin-s-cli createdlcoffer < span class = "hljs-comment" > [contractInfo]< / span > < span class = "hljs-comment" > [collateral]< / span > < span class = "hljs-comment" > [feerate]< / span > < span class = "hljs-comment" > [locktime]< / span > < span class = "hljs-comment" > [refundlocktime]< / span >
2020-02-26 20:18:39 +00:00
< / code > < / pre >
2020-05-19 01:11:38 +00:00
< 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 >
2020-02-26 20:18:39 +00:00
< p > Upon receiving a DLC Offer from your counter-party, the following command will create the serialized accept message:< / p >
2021-02-02 13:37:52 +00:00
< 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]
2020-02-26 20:18:39 +00:00
< / code > < / pre >
2020-05-19 01:11:38 +00:00
< 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 >
2020-02-26 20:18:39 +00:00
< p > Upon receiving a DLC Accept message from your counter-party, the following command will generate all of your signatures for this DLC:< / p >
2021-02-02 13:37:52 +00:00
< 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]
2020-02-26 20:18:39 +00:00
< / code > < / pre >
2020-05-19 01:11:38 +00:00
< 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 >
2020-02-26 20:18:39 +00:00
< p > Upon receiving a DLC Sign message from your counter-party, add their signatures to your database by:< / p >
2021-02-02 13:37:52 +00:00
< 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]
2020-02-26 20:18:39 +00:00
< / code > < / pre >
2021-02-02 13:37:52 +00:00
< 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 >
2020-02-26 20:18:39 +00:00
< p > You are now fully setup and can generate the fully signed funding transaction for broadcast using< / p >
2021-02-02 13:37:52 +00:00
< 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]
2020-02-26 20:18:39 +00:00
< / code > < / pre >
2021-02-02 13:37:52 +00:00
< 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 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 >
2020-08-25 15:45:27 +00:00
< 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 >
2021-02-02 13:37:52 +00:00
< 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]
2020-02-26 20:18:39 +00:00
< / code > < / pre >
2020-08-25 15:45:27 +00:00
< p > which will return fully signed Contract Execution Transaction for the event signed by the oracle.< / p >
2020-05-19 01:11:38 +00:00
< 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 >
2020-02-26 20:18:39 +00:00
< p > If the < code > refundlocktime< / code > for the DLC has been reached, you can get the fully-signed refund transaction with< / p >
2021-02-02 13:37:52 +00:00
< 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]
2020-02-26 20:18:39 +00:00
< / code > < / pre >
2021-02-02 13:37:52 +00:00
< / 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 & the bitcoin-s developers< / section > < / footer > < / div > < script type = "text/javascript" src = "https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js" > < / script > < script >
2020-02-26 20:18:39 +00:00
document.addEventListener('keyup', function(e) {
if (e.target !== document.body) {
return;
}
// keyCode for '/' (slash)
if (e.keyCode === 191) {
const search = document.getElementById('search_input_react');
search & & search.focus();
}
});
< / script > < script >
var search = docsearch({
apiKey: '0a510688bf8448e19aeb380377d328d3',
indexName: 'bitcoin-s',
inputSelector: '#search_input_react'
});
< / script > < / body > < / html >
