2020-09-29 22:14:01 +00:00
<!DOCTYPE html> < html lang = "en" > < head > < meta charSet = "utf-8" / > < meta http-equiv = "X-UA-Compatible" content = "IE=edge" / > < title > Eclair · bitcoin-s< / title > < meta name = "viewport" content = "width=device-width" / > < meta name = "generator" content = "Docusaurus" / > < meta name = "description" content = "This is a RPC client for [Eclair](https://github.com/acinq/eclair). It assumes that a bitcoind instance is running." / > < meta name = "docsearch:version" content = "v0.4" / > < meta name = "docsearch:language" content = "en" / > < meta property = "og:title" content = "Eclair · bitcoin-s" / > < meta property = "og:type" content = "website" / > < meta property = "og:url" content = "https://bitcoin-s.org/" / > < meta property = "og:description" content = "This is a RPC client for [Eclair](https://github.com/acinq/eclair). It assumes that a bitcoind instance is running." / > < 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');
2020-09-29 22:14:01 +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 > v0.4< / h3 > < / a > < div class = "navigationWrapper navigationSlider" > < nav class = "slidingNav" > < ul class = "nav-site nav-site-internal" > < li class = "siteNavGroupActive" > < a href = "/docs/core/core-intro" target = "_self" > Docs< / 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 > RPC Clients< / 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/getting-started" > Intro and Getting Started< / a > < / li > < / ul > < / div > < div class = "navGroup" > < h3 class = "navGroupCategoryTitle" > Getting Setup< / h3 > < ul class = "" > < li class = "navListItem" > < a class = "navItem" href = "/docs/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/applications/cli" > CLI< / a > < / li > < li class = "navListItem" > < a class = "navItem" href = "/docs/applications/server" > Application Server< / a > < / li > < li class = "navListItem" > < a class = "navItem" href = "/docs/applications/gui" > GUI< / a > < / li > < / ul > < / div > < div class = "navGroup" > < h3 class = "navGroupCategoryTitle" > Chain< / h3 > < ul class = "" > < li class = "navListItem" > < a class = "navItem" href = "/docs/chain/chain" > Blockchain Verification< / a > < / li > < li class = "navListItem" > < a class = "navItem" href = "/docs/chain/filter-sync" > Syncing Blockfilters< / a > < / li > < li class = "navListItem" > < a class = "navItem" href = "/docs/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/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/core/core-intro" > Core Module< / a > < / li > < li class = "navListItem" > < a class = "navItem" href = "/docs/core/addresses" > Generating Addresses< / a > < / li > < li class = "navListItem" > < a class = "navItem" href = "/docs/core/hd-keys" > HD Key Generation< / a > < / li > < li class = "navListItem" > < a class = "navItem" href = "/docs/core/adding-spks" > Adding New Script Types< / a > < / li > < li class = "navListItem" > < a class = "navItem" href = "/docs/core/spending-info" > Signing Transactions< / a > < / li > < li class = "navListItem" > < a class = "navItem" href = "/docs/core/psbts" > Partially Signed Bitcoin Transactions< / a > < / li > < li class = "navList
2019-06-03 09:35:15 +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');
2019-12-13 15:35:21 -06:00
var headings = document.querySelector('.toc-headings');
2019-06-03 09:35:15 +00:00
headings & & headings.addEventListener('click', function(event) {
2019-12-13 15:35:21 -06:00
var el = event.target;
while(el !== headings){
if (el.tagName === 'A') {
document.body.classList.remove('tocActive');
break;
} else{
el = el.parentNode;
}
2019-06-03 09:35:15 +00:00
}
}, 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);
};
}
});
2019-12-18 20:27:16 +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/rpc/eclair.md" target = "_blank" rel = "noreferrer noopener" > Edit< / a > < h1 id = "__docusaurus" class = "postHeaderTitle" > Eclair< / h1 > < / header > < article > < div > < span > < p > This is a RPC client for < a href = "https://github.com/acinq/eclair" > Eclair< / a > . It assumes that a bitcoind instance is running.< / p >
2020-09-29 22:14:01 +00:00
< p > Currently this RPC client is written for < a href = "https://github.com/ACINQ/eclair/releases/tag/v0.4.1" > v0.4.1< / a > version of Eclair.< / p >
2019-06-03 09:35:15 +00:00
< h2 > < a class = "anchor" aria-hidden = "true" id = "configuration-of-eclair" > < / a > < a href = "#configuration-of-eclair" aria-hidden = "true" class = "hash-link" > < svg class = "hash-link-icon" aria-hidden = "true" height = "16" version = "1.1" viewBox = "0 0 16 16" width = "16" > < path fill-rule = "evenodd" d = "M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z" > < / path > < / svg > < / a > Configuration of Eclair< / h2 >
< p > Please see the configuration secion of the
< a href = "https://github.com/acinq/eclair#configuring-eclair" > Eclair README< / a > .< / p >
2020-03-19 12:41:03 +00:00
< p > You can find the configuration we use for our testing infrastrture for eclair < a href = "https://github.com/bitcoin-s/bitcoin-s/blob/a043d3858ef33da51229ee59c478d2a6c9d5a46f/testkit/src/main/scala/org/bitcoins/testkit/eclair/rpc/EclairRpcTestUtil.scala#L98" > here< / a > .< / p >
2020-09-29 22:14:01 +00:00
< h2 > < a class = "anchor" aria-hidden = "true" id = "starting-eclair" > < / a > < a href = "#starting-eclair" aria-hidden = "true" class = "hash-link" > < svg class = "hash-link-icon" aria-hidden = "true" height = "16" version = "1.1" viewBox = "0 0 16 16" width = "16" > < path fill-rule = "evenodd" d = "M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z" > < / path > < / svg > < / a > Starting Eclair< / h2 >
< p > You need to download the jar from the < a href = "https://github.com/ACINQ/eclair/releases/tag/v0.4.1" > eclair's github< / a > .< / p >
< p > To run Eclair by unzipping the < code > eclair-node-0.4.1-e5fb281-bin.zip< / code > and then running< / p >
< pre > < code class = "hljs css language-bash" > $ ./eclair-node-0.4-69c538e/bin/eclair-node.sh
2019-06-03 09:35:15 +00:00
< / code > < / pre >
2019-12-16 12:03:51 +00:00
< p > If you wish to start Eclair from the RPC client, you can do one of the following:< / p >
< ol >
2020-03-19 12:41:03 +00:00
< li > Construct a < a href = "https://github.com/bitcoin-s/bitcoin-s/blob/a043d3858ef33da51229ee59c478d2a6c9d5a46f/eclair-rpc/src/main/scala/org/bitcoins/eclair/rpc/client/EclairRpcClient.scala#L51" > < code > EclairRpcClient.binary< / code > < / a > field set< / li >
< li > Set the < a href = "https://github.com/bitcoin-s/bitcoin-s/blob/a043d3858ef33da51229ee59c478d2a6c9d5a46f/eclair-rpc/src/main/scala/org/bitcoins/eclair/rpc/client/EclairRpcClient.scala#L701" > < code > ECLAIR_PATH< / code > < / a > environment variable to the directory where the Eclair Jar is located.< / li >
2019-12-16 12:03:51 +00:00
< / ol >
2020-03-19 12:41:03 +00:00
< p > We will default to using the < code > binary< / code > field first when trying to start the jar, and the fallback to < code > ECLAIR_PATH< / code > .< / p >
< p > Here is an example of how to start eclair:< / p >
2020-12-11 22:35:47 +00:00
< pre > < code class = "hljs css language-scala" > < span class = "hljs-keyword" > implicit< / span > < span class = "hljs-keyword" > val< / span > system = < span class = "hljs-type" > ActorSystem< / span > (< span class = "hljs-string" > s" eclair-rpc-< span class = "hljs-subst" > ${System.currentTimeMillis}< / span > " < / span > )
2020-03-19 12:41:03 +00:00
< span class = "hljs-keyword" > implicit< / span > < span class = "hljs-keyword" > val< / span > ec = system.dispatcher
2020-12-11 22:35:47 +00:00
< span class = "hljs-keyword" > val< / span > datadirPath = < span class = "hljs-type" > Paths< / span > .get(< span class = "hljs-string" > " path" < / span > , < span class = "hljs-string" > " to" < / span > , < span class = "hljs-string" > " datadir" < / span > )
< span class = "hljs-keyword" > val< / span > binaryPath = < span class = "hljs-type" > Paths< / span > .get(< span class = "hljs-string" > " path" < / span > , < span class = "hljs-string" > " to" < / span > , < span class = "hljs-string" > " eclair-node-0.3.3-12ac145.jar" < / span > )
2020-03-19 12:41:03 +00:00
< span class = "hljs-keyword" > val< / span > instance = < span class = "hljs-type" > EclairInstance< / span > .fromDatadir(datadirPath.toFile,< span class = "hljs-type" > None< / span > )
< span class = "hljs-keyword" > val< / span > client = < span class = "hljs-keyword" > new< / span > < span class = "hljs-type" > EclairRpcClient< / span > (instance, < span class = "hljs-type" > Some< / span > (binaryPath.toFile))
< span class = "hljs-keyword" > val< / span > startedF = client.start()
< span class = "hljs-keyword" > for< / span > {
eclair < - startedF
info < - eclair.getInfo
} < span class = "hljs-keyword" > yield< / span > {
2020-12-11 22:35:47 +00:00
println(< span class = "hljs-string" > s" Eclair info: < span class = "hljs-subst" > $info< / span > " < / span > )
2020-03-19 12:41:03 +00:00
}
< / code > < / pre >
< h3 > < a class = "anchor" aria-hidden = "true" id = "connecting-to-the-websocket" > < / a > < a href = "#connecting-to-the-websocket" 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 > Connecting to the websocket< / h3 >
< p > As of < code > v0.3.3< / code > eclair supports a websocket endpoint. This means you can receive updates of what is happening with eclair
in real time. You can see an example of us testing this < a href = "https://github.com/bitcoin-s/bitcoin-s/blob/a043d3858ef33da51229ee59c478d2a6c9d5a46f/eclair-rpc-test/src/test/scala/org/bitcoins/eclair/rpc/EclairRpcClientTest.scala#L591" > here< / a > < / p >
2020-12-11 22:35:47 +00:00
< / span > < / div > < / article > < / div > < div class = "docLastUpdate" > < em > Last updated on 8/27/2020 by Ben Carman< / em > < / div > < div class = "docs-prevnext" > < a class = "docs-prev button" href = "/docs/rpc/rpc-clients-intro" > < span class = "arrow-prev" > ← < / span > < span > Introduction< / span > < / a > < a class = "docs-next button" href = "/docs/rpc/rpc-bitcoind" > < span > bitcoind/Bitcoin Core< / span > < span class = "arrow-next" > →< / span > < / a > < / div > < / div > < / div > < nav class = "onPageNav" > < ul class = "toc-headings" > < li > < a href = "#configuration-of-eclair" > Configuration of Eclair< / a > < / li > < li > < a href = "#starting-eclair" > Starting Eclair< / a > < ul class = "toc-headings" > < li > < a href = "#connecting-to-the-websocket" > Connecting to the websocket< / 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 © 2020 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 >
2019-06-20 14:53:06 +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 >
