Releases: ACINQ/eclair
Eclair v0.6.1
Eclair v0.6.1
This release makes major performance improvements, includes a few bug fixes and several new features.
It is fully compatible with 0.6.0 (and all previous versions of eclair).
Major changes
Performance improvements
Sqlite
Eclair now uses write-ahead logging in Sqlite (#1871). WAL is better suited to our DB access patterns, and is both much more performant and safer than the default rollback journal that we were using previously.
- WAL is significantly faster in most scenarios.
- WAL provides more concurrency as readers do not block writers and a writer does not block readers.
- Disk I/O operations tends to be more sequential using WAL.
- WAL uses many fewer fsync() operations.
This small change improves performance by more than 5x.
Payment Handling
Invoice generation (#1878) and handling of incoming payments (#1880) are now processed in parallel, resulting in a higher throughput under load.
Improved Postgres support
This is the continuation of an effort to make PosgreSQL production-ready. The database schema has been reworked (#1866) and is now better organized, with appropriate types for timestamps (#1862). There have been several concurrency-related bug fixes.
We have also added JSONB columns for local channels and for network announcements (#1865). All individual data fields can now be accessed from SQL and indexed, which is very convenient for advanced analysis and tuning of a routing node.
Upfront shutdown script
This release adds support for option_upfront_shutdown_script (feature bits 4/5).
This feature lets you specify a closing address when you open a channel: your peer will ensure that when you close, your funds can only go to that address.
It can be useful to protect against future hacks of your node, because the attacker won't be able to close your channels and send the funds to an address that he controls. However, it doesn't prevent the attacker from exfiltrating funds by paying lightning invoices, so you shouldn't rely on this feature alone to make your node hack-proof.
This option is disabled by default, but can be enabled in your eclair.conf.
Note that if you enable it, the closing address will be automatically generated by your bitcoind node.
Transaction publishing improvements
This release reworks our internal transaction publishing architecture (see #1844 for details).
The new architecture is more flexible, provides better logging and makes it easy to add dynamic fee bumping in the future for anchor output channels.
It will also make it easier to automatically use CPFP to ensure funding transactions confirm before the 2016 blocks timeout is reached.
API changes
This release updates a few APIs:
parseinvoicedisplays Bolt 11 invoices routing hints (#1833)- Plugins can inject their own routes into the API instead of spawning a separate HTTP server (#1805 and #1819)
Miscellaneous improvements and bug fixes
- Eclair now uses Bitcoin Core 0.21.1 by default (#taproot)
- Eclair now supports warning messages
- Eclair uses additional entropy on top of the operating system RNG to mitigate random number generation failures (#1774)
Verifying signatures
You will need gpg and our release signing key 7A73FE77DE2C4027. Note that you can get it:
- from our website: https://acinq.co/pgp/drouinf.asc
- from github user @sstone, a committer on eclair: https://api.github.com/users/sstone/gpg_keys
To import our signing key:
$ gpg --import drouinf.ascTo verify the release file checksums and signatures:
$ gpg -d SHA256SUMS.asc > SHA256SUMS.stripped
$ sha256sum -c SHA256SUMS.strippedBuilding
Eclair builds are deterministic. To reproduce our builds, please use the following environment (*):
- Ubuntu 20.04
- AdoptOpenJDK 11.0.6
- Maven 3.8.1
Use the following command to generate the eclair-node package:
mvn clean install -DskipTestsThat should generate eclair-node/target/eclair-node-0.6.1-XXXXXXX-bin.zip with sha256 checksums that match the one we provide and sign in SHA256SUMS.asc
(*) You may be able to build the exact same artefacts with other operating systems or versions of JDK 11, we have not tried everything.
Upgrading
This release is fully compatible with eclair v0.6.0. You don't need to close your channels, just stop eclair, upgrade and restart.
Changelog
a658fa2 Set version to 0.6.1-SNAPSHOT (#1813)
76894bd Add additional PRNG (#1774)
9a20aad Allow plugins to inject their own routes into API (#1805)
d437ea1 Improve API plugin support (#1819)
98cae45 Rename pending_relay to pending_commands (#1822)
e8c33ba Various improvements and fixes (#1817)
f829a2e Add json type hints on channel data (#1824)
4dc2910 Make result set an iterable (#1823)
6f6c458 Add metrics on channels processing time (#1826)
43a89f8 Add a random delay before processing blocks (#1825)
af618bc Symmetrical HTLC limits (#1828)
dbecb28 Include routing hints in parseinvoice API call response (#1833)
2b6d564 Expose eclair datadir to plugins (#1837)
bd6bad1 Fix eventually statements (#1835)
a7bb2c2 Do not store CannotAffordFees errors (#1834)
d4b25d5 Udpate to Bitcoin Core 0.21.1 (#1841)
e750474 Use bitcoin-lib 0.19 (#1839)
bbfbad5 Validate payment secret when decoding (#1840)
afb1b41 Update bolt 3 spec test vectors (#1669)
d43d06f Rework TxPublisher (#1844)
45204e2 Schedule backup at regular interval (#1845)
85ed433 Reject 0-value trampoline payments (#1851)
f857368 Make trampoline payments use per-channel fee and cltv (#1853)
f52c3dd Decode warning messages (#1854)
516929b Fix default file backup config (#1857)
4ca5c62 Remove println in tests (#1861)
291c128 Reduce some log levels (#1864)
d9a03a5 Use warning messages for connection issues (#1863)
af8394a Add support for dual db backend (#1746)
3a573e2 Improve message for CannotRetrieveFeerates error (#1859)
bd57d41 Add a globalbalance api call (#1737)
08faf3b Add json columns in Postgres (#1865)
f8feb19 Use schemas in Postgres (#1866)
cea3fc0 Use proper data type for timestamps in Postgres 2 (#1862)
95fffe3 Reduce pg transaction isolation (#1860)
547d7e7 Create chain directory (#1872)
e9df4ee Channels data format migration (#1849)
733c6e7 Refactor global balance tests (#1874)
ca51a2d Enable WAL mode on Sqlite (#1871)
3ae9a4a Additional reestablish test (#1875)
d02760d Fail unsigned outgoing htlcs on force-close (#1832)
3bb7ee8 Parallel payment request generation (#1878)
5182402 Fix flaky channel integration tests (#1879)
b4183ed Fetch incoming payments in parallel (#1880)
8c49f77 Fix payment handler tests (#1882)
01b4073 Implement option-upfront-shutdown-script (#1846)
79729c7 Update README (#1881)
c22596b Update dependencies and enable fatal warnings (#1885)
adf36de Fix yet another flaky test (#1886)
3f1c250 Fix watcher flaky test (#1883)
c8c5e76 Update akka-http-json4s dependency (#1889)
5fa8fed Set version to 0.6.1 (#1887)
Eclair v0.6.0
This release makes some core features mandatory, includes a few important bug fixes and several performance improvements.
It is fully compatible with 0.5.1 (and all previous versions of eclair).
Major changes
Mandatory payment secrets
This release makes two important features mandatory:
var_onion_optin(added to the spec in July 2019)payment_secret(added to the spec in December 2019)
These features have been widely deployed and protect against privacy attacks and stealing payments to 0-value invoices (as described here).
You won't be able to connect to nodes that don't support these features nor pay invoices that don't include a payment_secret.
Improved detection of stale blocks
Eclair uses ZMQ to receive blocks and transactions from your bitcoin node.
While ZMQ is usually very reliable, we discovered that its pub/sub model has some limitations.
If a subscriber encounters network failures, it will silently disconnect without notifying the publisher.
This never happens when your bitcoin node is on the same machine as eclair, but may happen when bitcoin is running on a remote machine and a VPN is used between the two machines.
Eclair now sets a TCP keep-alive on the ZMQ socket to work around this limitation and quickly reconnect.
The blockchain watchdogs have also been improved to run at fixed intervals if no blocks are received.
They will poll secondary blockchain sources (bitcoinheaders.net, blockstream.info, mempool.space and blockcypher.com) to detect that your eclair node is missing blocks.
Electrum support removed
This release removes support for using Electrum instead of Bitcoin Core for your bitcoin wallet.
Electrum support was necessary for mobile wallets, but wasn't recommended for server deployments.
Wallets are migrating to our Kotlin lightning stack, so eclair can now target exclusively server deployments.
Eclair depends on many low-level bitcoind RPCs for fee bumping which aren't available yet in Electrum.
Improved Postgres support
We previously introduced beta support for using PostgreSQL as database backend in eclair v0.4.1.
We've fixed some bugs since then and improved the integration, but please note that PostgreSQL support is still in beta.
We're actively working on finalizing this integration and making PostgreSQL production-ready in a future release.
Support for future segwit versions
This release adds support for option_shutdown_anysegwit (spec PR available here).
Current segwit bitcoin addresses (P2WPKH and P2WSH) only use segwit version 0, but this change lets nodes use bitcoin addresses with other version numbers (taproot will use version 1).
API changes
This release updates a few APIs:
- Features are now displayed as a map (feature name -> support) in API responses (#1715)
- Channel internal state tracking force-close scenarios has been enriched (#1728)
- A
--blocking=<bool>option has been added to thepayinvoiceAPI (#1751)
We've also updated our internal API DSL, which paves the way for more plugin integration in a future release.
Head over to our API documentation for more details.
Miscellaneous improvements and bug fixes
- Eclair now defaults to Bech32 addresses (#1717)
- Anchor output commitment feerate is now configurable (#1718)
- All outputs of revoked anchor output commitments are claimed (there is a subtle edge case, see #1738)
- Internal codec packages and database versions have been reworked to improve future backwards-compatibility
- Several improvements have been made to our path-finding algorithms, improving tail latency
- A bug affecting reconnections to peers has been fixed (#1760)
- A bug affecting transaction outputs ordering (which can lead to channel force-close) has been fixed (#1806)
Verifying signatures
You will need gpg and our release signing key 7A73FE77DE2C4027. Note that you can get it:
- from our website: https://acinq.co/pgp/drouinf.asc
- from github user @sstone, a committer on eclair: https://api.github.com/users/sstone/gpg_keys
To import our signing key:
$ gpg --import drouinf.ascTo verify the release file checksums and signatures:
$ gpg -d SHA256SUMS.asc > SHA256SUMS.stripped
$ sha256sum -c SHA256SUMS.strippedBuilding
Eclair builds are deterministic. To reproduce our builds, please use the following environment (*):
- Ubuntu 20.04
- AdoptOpenJDK 11.0.6
- Maven 3.8.1
Use the following command to generate the eclair-node package:
mvn clean install -DskipTestsThat should generate eclair-node/target/eclair-node-0.6.0-XXXXXXX-bin.zip with sha256 checksums that match the one we provide and sign in SHA256SUMS.asc
(*) You may be able to build the exact same artefacts with other operating systems or versions of JDK 11, we have not tried everything.
Upgrading
This release is fully compatible with eclair v0.5.1. You don't need to close your channels, just stop eclair, upgrade and restart.
Changelog
- 163700a Set version to 0.5.2-SNAPSHOT (#1714)
- 844829a Features should be a Map (#1715)
- afa378f Fix Bolt 3 spec change that broke our test suite (#1719)
- c4c0248 Use bech32 addresses by default (#1717)
- 92e53dc Configurable anchor output max commitment feerate (#1718)
- ea8f940 Fix potential race condition in node-relay (#1716)
- 9ff2f83 Refactor and simplify API dsl (#1690)
- 6364ae3 Reject trampoline payments with expired outgoing cltv (#1727)
- 2772138 Better handling of TemporaryChannelFailure (#1726)
- ded5ce0 Add metadata to local_channels table (#1724)
- 8dc64db Fix API regression (#1729)
- 4bc2dec Reorganize internal codecs (master) (#1732)
- 6d28cbc Rework XxxCommitPublished types (#1728)
- 6e72785 fixup! Rework XxxCommitPublished types (#1728) (#1735)
- 7819fae Move protocol codecs to their own package (#1736)
- 3d3766e Clarify some comments and add tests (#1734)
- f39718a Add high-level architecture diagrams (#1733)
- f202587 Clarify commit tx fee anchor cost (#1721)
- c37eb1a Handle aggregated anchor outputs htlc txs (#1738)
- e5429eb Avoid visiting vertices multiple times in Dijkstra's algorithm (#1745)
- c6a76af Introduce actor factories (#1744)
- 75cb777 Prevent loops and improve shortest paths perf (#1747)
- 936f36b Refactor Postgres code (#1743)
- ac2b784 Fix flaky relay-htlc-add test (#1752)
- 5729b28 Add blocking option to payinvoice API (#1751)
- 89d2489 Remove Electrum support (#1750)
- b25e552 Remove Docker test dependency (#1753)
- 1321761 Make signing payment requests faster (#1754)
- 5f68bf9 Database nits (#1755)
- 1e2abae Index database metrics by backend (#1758)
- 6518bb4 Posgres: fix concurrency in channels db (#1762)
- 3da0b80 Add a list of community plugins (#1763)
- 48c0c4c Extract tx publishing from watchers (#1749)
- 357f7f9 Catch all connection failures and reconnect (#1760)
- 205653d Make db errors fatal in channels (#1764)
- ccae92d (Minor) Minimize conflicts with feature branches (#1765)
- eb834e2 Do not explicitly provide address for ServerSocket in tests (#1766)
- d0e79fa Add shorter CI timeout (#1769)
- 15ddc17 Add trampoline info to auditDB (#1767)
- 32a86a4 Ignore tests with ServerSocket (#1776)
- 33d52b6 More database nits (#1773)
- e092677 Rework the db version management (#1775)
- 4a1dfd2 Reenable ServerSocket tests (#1777)
- e14c40d Use proper data type for timestamps in Postgres (#1778)
- 62dd393 Use bouncycastle instead of spongycastle (#1772)
- 3669428 Don't log ClosingType object (#1781)
- 223a14c Remove bintray (#1785)
- 9e4042f Migrate ZmqWatcher to akka-typed (#1759)
- 90fbcd3 Index trampoline payments by hash and secret (#1770)
- 3079cb4 Remove unused class (#1792)
- a8d4e07 Use less strict isolation level for channel meta (#1790)
- 55b50ec ZMQ actors should subscribe to a single topic (#1793)
- c641549 Fix computation of path weight (#1794)
- 340fd29 Update default path-finding weight ratios (#1796)
- 55a629f Update instructions for downloading Tor Bundle (#1784)
- 898c17b Remove ConnectionControlPlugin trait (#1797)
- 0805d51 Do not retry sending if payment gets confirmed on chain (#1799)
- ec276f8 Use satoshi for htlc ordering (#1806)
- 9c3ee59 Check blockchain watchdogs regularly (#1808)
- 9141998 Make payment_secret mandatory (#1810)
- 1fbede7 Add TCP keep-alive on ZMQ socket (#1807)
- 5a92f84 Add support for option_shutdown_anysegwit (#1801)
- e2b3b47 Update Tor doc for Windows (#1811)
- f746ade Set version to 0.6.0 (#1812)
Special thanks to @tompro who reworked our internal API DSL.
Eclair v0.5.1
This release includes many bug fixes and improvements, a new API and monitoring updates.
It is fully compatible with 0.5.0 (and all previous versions of eclair).
Major changes
Improved startup performance
When eclair starts up and restores channels, it makes a lot of calls to bitcoind to check the status of each channel.
We improved our calling pattern to greatly reduce the number of calls made when some channels are closing.
This is particularly noticeable when the mempool is quite full and you have many channels.
See #1699 for details.
Gossip sync improvements
Most of the bandwidth consumed by lightning nodes is due to gossip (syncing the network graph).
When your eclair node has a lot of peers and doesn't use a sync-whitelist, you may end up syncing with many different peers and obtaining redundant information, thus wasting bandwidth.
Eclair now only syncs with peers you have a channel with to reduce bandwidth usage.
Anchor outputs
This release contains a lot of changes for the upcoming anchor outputs commitment format:
- the feerate of the commitment transaction is kept low to improve off-chain channel usage
- transactions with multiple inputs and outputs are now supported
- CPFP and RBF utilities have been added to increase the feerate of commitment and htlc transactions
While you can start experimenting with this commitment format, it is still not safe to activate in production.
Anchor outputs is a complex and subtle change that requires re-architecting most of our transaction broadcasting logic and utxo management.
We are making steady progress towards that, but we're not there yet.
Monitoring changes
Kamon tracing has been removed in this release.
It was too invasive in the codebase, generally unused and was costing some bandwidth.
We've found that metrics and logs are enough to correctly monitor your eclair node.
Additional metrics to monitor transaction signing have been added.
The rate of transaction signatures is a good indicator of how busy your node is.
API changes
This release adds a new path-finding API:
findroutebetweennodeslets you inspect the network graph by looking for routes between two nodes (whereasfindrouteonly allowed finding routes between your node and a remote node)
Head over to our API documentation for more details.
Miscellaneous improvements and bug fixes
- Correctly sort addresses in its
node_announcement(#1693) - Allow 2016 blocks before unconfirmed channels are forgotten (#1692)
- Re-emit private channel updates more frequently, improving payments to mobile wallets (#1671)
- Correctly handle channel failures in private routing hints, fixing an edge case for payments to mobile wallets (#1675)
- Drop support for
initial_routing_sync: this was bandwidth-heavy and now unnecessary (#1683) - Fix an MPP-send edge-case (#1685)
- Fix race condition between outgoing payment and peer disconnection (#1688)
- Fix race condition between
update_feeandshutdown, which could lead to channels stuck inshutdown(#1661) - Ensure transactions we publish always meet bitcoin's
min_relay_fee(#1687) - Fix an edge case where an HTLC failure was not correctly relayed upstream if
revoke_and_ackhad not been received (#1706)
Verifying signatures
You will need gpg and our release signing key 7A73FE77DE2C4027. Note that you can get it:
- from our website: https://acinq.co/pgp/drouinf.asc
- from github user @sstone, a committer on eclair: https://api.github.com/users/sstone/gpg_keys
To import our signing key:
$ gpg --import drouinf.ascTo verify the release file checksums and signatures:
$ gpg -d SHA256SUMS.asc > SHA256SUMS.stripped
$ sha256sum -c SHA256SUMS.strippedBuilding
Eclair builds are deterministic. To reproduce our builds, please use the following environment (*):
- Ubuntu 19.10
- AdoptOpenJDK 11.0.6
- Maven 3.6.3
Use the following command to generate the eclair-node package:
mvn clean install -DskipTestsThat should generate eclair-node/target/eclair-node-0.5.1-XXXXXXX-bin.zip with sha256 checksums that match the one we provide and sign in SHA256SUMS.asc
(*) You may be able to build the exact same artefacts with other operating systems or versions of JDK 11, we have not tried everything.
Upgrading
This release is fully compatible with Eclair v0.5.0. You don't need to close your channels, just stop eclair, upgrade and restart.
Changelog
- 923ca26 Set version to 0.5.1-SNAPSHOT (#1651)
- b75f6c3 Fix duplicate commit id in awseb bundle (#1650)
- 5f9d0d9 Relax cltv-expiry-delta requirement when selecting a channel to relay (#1655)
- dd8975a Make ChannelVersion methods public (#1656)
- 7343283 Add test for duplicate temporary channel id (#1660)
- 629c2e6 Fix rare race conditions in integration tests (#1653)
- b477d17 Update build instructions for front (#1658)
- e369ba9 More aggressively re-emit private channel updates (#1671)
- d40b321 Blockchain watchdogs use unique actor name (#1667)
- 9c4ab7d Fix HTLC fulfill race condition in integration spec (#1666)
- 81f15aa Refactor and improve some channel tests (#1654)
- 54ca292 Remove kamon tracing (#1662)
- 34e901d Clarify default relay fee change (#1673)
- c75d914 Fix failing reconnection tests (#1678)
- 0127ace Remote failure updating routing hint (#1675)
- ac054a2 Only sync with channel peers (#1587)
- d053188 Truncate hex strings in front logs (#1679)
- 4902362 Refactor channel test helpers (#1682)
- f241ef9 Remove support for initial_routing_sync (#1683)
- 63d972b Fix a few typos (#1684)
- 5d3958d Fix MPP path-finding edge case (#1685)
- 15c1837 Add tx signing metrics (#1659)
- 72179de PaymentLifecycle handle disconnected peers (#1688)
- fdeb3ce Correctly set gossip sync_complete (#1668)
- 36e8c05 Shutdown and UpdateFee should not be intertwined (#1661)
- 2a359c6 Publish txs with min-relay-fee met (#1687)
- 82e5b59 Sort addresses in node announcement (#1693)
- 3a94a80 Reject unreasonable remote dust limit (#1694)
- fdb57b4 Find route between nodes (#1695)
- 9618a6a Add a maximum fee threshold for anchor outputs (#1672)
- ab89851 Relax single tx input requirements (#1677)
- 0835150 Update funding timeout fundee (#1692)
- d9c0b86 Refactor bitcoin clients (#1697)
- 5163749 [eclair-cli] Use multiplatform escape sequence
- fa759f1 Fix PaymentLifecycle warning (#1703)
- c1bf9bd Optimize watching for spending txs (#1699)
- d02b900 Fix annoying compiler warning (#1704)
- a3c477e Address all intellij warnings for Channel.scala (#1705)
- bf2a35f Relay partially failed htlcs when closing (#1706)
- 5d662fc Set anchor output feerates when force-closing (#1702)
- 8065d0b Add a serializer for
DoSync(#1708) - 8d4da2f Improve channel state tests (#1709)
- 2646886 fixup! Improve channel state tests (#1709) (#1712)
- 3479669 Disable jdbc instrumentation by default (#1713)
- 98bb7be Set version to 0.5.1 (#1707)
Eclair v0.5.0
Eclair v0.5.0
This release includes many exciting new features, API changes as well as several bug fixes and improvements.
It is fully compatible with 0.4.2 (and all previous versions of eclair).
Major changes
Cluster mode
Eclair now allows you to scale up one logical lightning node across multiple servers.
Front servers take care of routing table related gossip and syncing requests from peers, which is cpu/bandwidth intensive.
The backend server can focus on core channel management.
BOLT 1 and BOLT 7 messages are handled in the frontend, while BOLT 2 messages go through and are processed in the backend.
This new feature is key for robust and scalable enterprise deployments.
Head over to the documentation for more details.
Blockchain watchdogs
Eclair now includes a blockchain watchdog, that fetches bitcoin headers from various sources in order to detect whether we're being eclipsed.
The current blockchain sources we use are:
- blockchainheaders.net (headers over DNS)
- blockstream.info
- mempool.space
Seed segregation
Eclair now splits your seed into two distinct parts: node_seed.dat and channel_seed.dat.
It makes sense to separate the keys that are used for connection handling and gossip (and have no impact on your funds) from the keys that are used for channel operations (and have a direct, critical impact on your funds).
This change paves the way for future security improvements, such as using hardware wallets for channel keys.
Per-node feerate tolerance
On-chain feerate spikes have a subtle but important impact on the security of your channel funds.
Eclair lets you configure the tolerance you have with your peers via the eclair.on-chain-fees.feerate-tolerance configuration parameter.
With this release, you can now override this configuration for specific nodes.
This can be useful when one of your peer is trusted and you know it won't try to cheat you (for example because it's one of your own nodes, a family member's node or a friend).
You can configure a higher feerate tolerance with these nodes than with nodes you don't know or trust.
Plugin improvements
More plugins hooks have been added to eclair, to allow custom connection management and custom commitment formats.
Hats off to @btcontract who was able to implement hosted channels entirely as an eclair plugin!
API changes
This release contains a few improvements to existing APIs:
- The
channelIdfield has been added to thechannel-state-changedwebsocket event - Initial relay fees can be configured when opening a channel with the
openAPI
Head over to our API documentation for more details.
Miscellaneous improvements and bug fixes
- #1617 lets you redirect traffic automatically from a tor node to a normal node
option_static_remotekeyis now optionally activated by default
Verifying signatures
You will need gpg and our release signing key 7A73FE77DE2C4027. Note that you can get it:
- from our website: https://acinq.co/pgp/drouinf.asc
- from github user @sstone, a committer on eclair: https://api.github.com/users/sstone/gpg_keys
To import our signing key:
$ gpg --import drouinf.ascTo verify the release file checksums and signatures:
$ gpg -d SHA256SUMS.asc > SHA256SUMS.stripped
$ sha256sum -c SHA256SUMS.strippedBuilding
Eclair builds are deterministic. To reproduce our builds, please use the following environment (*):
- Ubuntu 19.10
- AdoptOpenJDK 11.0.6
- Maven 3.6.3
Use the following command to generate the eclair-node package:
mvn clean install -DskipTestsThat should generate eclair-node/target/eclair-node-0.5.0-XXXXXXX-bin.zip with sha256 checksums that match the one we provide and sign in SHA256SUMS.asc
(*) You may be able to build the exact same artefacts with other operating systems or versions of JDK 11, we have not tried everything.
Upgrading
This release is fully compatible with Eclair v0.4.2. You don't need to close your channels, just stop eclair, upgrade and restart.
Changelog
- 131b2e0 Add workaround for lnd sync issue (#1563)
- bffb7a3 Fix race condition in integration test (#1564)
- 90bf08e Update akka to 2.6.10 (#1568)
- 9c16bb7 Manual watching of peer-connection actor (#1567)
- b0716ae Make
Commitmentsa trait (#1542) - ad17683 (Minor) Fix
Features.toString(#1573) - 98508f3 Fix empty replyTo in update_relay_fee (#1572)
- e74f345 Clarify crossSign helper functions (#1578)
- 28f72e4 Remote address in ConnectionInfo (#1579)
- baa2269 Rework features compatibility (#1576)
- 1f90e5b Add per-node feerate tolerance (#1575)
- 366f9be Add a case object to get router data (#1581)
- c556654 Add blockchain watchdog (#1545)
- f32e75b Segregate the node seed from the channel seed (#1584)
- 59449bf Increase docker timeouts for electrumx in tests (#1589)
- c0d465c Fix NodeRelayer flaky test (#1588)
- e5db314 Allow plugins to provide broken HTLCs after a restart (#1586)
- c0e3884 Add a test to ensure
NodeParams.nodeIdalways equalsNodeParams.privateKey.publicKey(#1593) - 54b589c Improve MPP-send for direct channels (#1599)
- 407b330 Remove
timedOutOutgoingHtlcsfrom AbstractCommitments (#1604) - 06c95a7 Clarify trampoline to legacy diagram (#1607)
- 6b32fd0 Allow plugins to force reconnect (#1594)
- 8bfb9f0 Clean up bitcoinheaders error logs (#1606)
- 6330e76 [CI] Exclude tests that call external APIs (#1622)
- 848b433 Ack htlc settlement commands after writing state (#1615)
- ed61b57 Improve CustomCommitmentsPlugin methods (#1613)
- ce73ef3 Allow overriding of Tor target (#1617)
- 8cfa3f5 Set the same priority for all routing messages (#1624)
- a2a980c Add channelId to websocket event (#1605)
- 3ebf601 Minor: Less spammy and better logs (#1618)
- 040e6d0 Retrieve bitcoin's mempool-min-fee (#1608)
- a4d1845 Set initial relay fees during channel open (#1610)
- 8d6af35 Add router API for invoice routing hints (#1590)
- 4e56705 Remove old compatibility workaround for eclair mobile (#1625)
- 08c21fa Distribute connection-handling on multiple machines using akka-cluster (#1566)
- c13ae5e Set min-fee-rate to 2 sat/byte (#1626)
- 0e5ec4d Fix bug in enforceMinimumFeerate (#1629)
- e8b47e1 Move fee provider configuration section (#1631)
- 0ce993d fixup! Distribute connection-handling (#1566) (#1634)
- c7cc536 Improve channel exceptions (#1585)
- df7789e Add metrics to track utxos (#1609)
- ade17ec Use a local actorsystem by default (#1636)
- bbbd229 Accept remote's closing fee when we have nothing at stake (#1633)
- 95b34f2 Fix duplicate implicit btc amount conversions (#1637)
- 810323c Settle HTLCs revoked commit (#1630)
- 30735b4 fixup! Settle HTLCs revoked commit (#1630) (#1638)
- 183bdde Activate static_remotekey by default (#1639)
- dae5eee Disable the distibuted pubsub extension by default (#1642)
- 413ee29 Fix htlc origin JSON serialization (#1641)
- 9425fd4 Make PluginParams a simple trait (#1643)
- 370fe41 Measure the distribution of payments across nodes (#1644)
- 5e6c28e ElectrumWatcher: fix for unconfirmed txs (#1647)
- 39d9bfb Add cluster doc, and packaging improvements (#1646)
- d44ff85 (Minor) Improve logs (#1648)
Eclair v0.4.2
This release includes many exciting new features, API changes as well as several bug fixes and improvements.
Its is fully compatible with 0.4.1 (and all previous versions of eclair).
Major changes
Plugins
Third-party plugins are now able to add new feature bits to eclair and handle unknown custom messages.
This lets plugin developers offer services to their customers that are not available in the Lightning specification (e.g. swap-in/swap-out), while staying fully compatible with the network.
See #1528 for more details.
Anchor Outputs
This release adds experimental support for anchor outputs channels.
The main benefit of this type of channels is that it is possible to bump the on-chain fees of commitment transactions and htlc transactions once they are in the mempool to speed up their confirmation.
Eclair is fully compatible with the anchor output specification, but automatic fee bumping has not been implemented yet, hence we do not recommend activating the feature.
Some attacks that are specific to anchor outputs have also been discovered recently and haven't been fully addressed yet, but will be fixed in future releases.
Keysend
This release adds support for spontaneous payments using keysend.
It is fully compatible with lnd and c-lightning and makes it easy for public LN nodes to receive donations.
API changes
This release contains many new APIs and improvements to existing ones:
- Add
signmessage/verifymessageAPIs: this allows signing arbitrary messages with the node's key and is compatible with lnd and c-lightning - We publish new channel events to the websocket (
channel-opened,channel-state-changedandchannel-closed) - The
sendtorouteAPI now lets you choose the channels that must be used, making it easy to rebalance your local channels
Head over to our API documentation for more details.
Miscellaneous improvements and bug fixes
- Many actors have been refactored to use Akka Typed instead of classic actors.
This leads to a cleaner design, better types and more help from the compiler to detect unhandled messages. - We added support for Bitcoin Core 0.20.1.
- We added support for non-default Bitcoin Core wallets (see #1540 for details)
- We fixed the
override-featuresconfiguration parameter, which wasn't overriding features everywhere. This parameter can be very useful for example to sync only from specific nodes, or advertize wumbo support only to nodes that you trust.
Verifying signatures
You will need gpg and our release signing key 7A73FE77DE2C4027. Note that you can get it:
- from our website: https://acinq.co/pgp/drouinf.asc
- from github user @sstone, a committer on eclair: https://api.github.com/users/sstone/gpg_keys
To import our signing key:
$ gpg --import drouinf.ascTo verify the release file checksums and signatures:
$ gpg -d SHA256SUMS.asc > SHA256SUMS.stripped
$ sha256sum -c SHA256SUMS.strippedBuilding
Eclair builds are deterministic. To reproduce our builds, please use the following environment (*):
- Ubuntu 19.10
- AdoptOpenJDK 11.0.6
- Maven 3.6.3
Use the following command to generate the eclair-node package:
mvn clean install -DskipTestsThat should generate eclair-node/target/eclair-node-0.4.2-XXXXXXX-bin.zip with sha256 checksums that matches the one we provide and sign in SHA256SUMS.asc
(*) You may be able to build the exact same artefacts with other operating systems or versions of JDK 11, we have not tried everything.
Upgrading
This release is fully compatible with Eclair v0.4.1. You don't need to close your channels, just stop eclair, upgrade and restart.
Changelog
- ebfca8c Bitcoin Core Wallet small refactoring (#1482)
- e06325e fixup! Split the
Peerin two (#1347) (#1487) - 65facab Add debug logs to transport handler (#1488)
- ea57bb2 Release 0.4.1 (#1481)
- 92a094c Anchor output transaction format (#1484)
- aca7499 Use github action for scoverage (#1490)
- 625e996 Update MinFinalCltvExpiryDelta default value and activate wumbo (#1483)
- ab4831f Use file filter for scoverage upload (#1492)
- e6909cf Implement the KeySend feature, spontaneous payments (#1485)
- a3dd365 Revive codecov.yml (#1493)
- bc81cd5 Add delay before setting watches at startup (#1489)
- 8cd2644 Do not merge user provided features with defaults (#1435)
- 3d4e00f Activate anchor output in channels (#1491)
- 6f9edec Relax relaying requirement on expiry (#1497)
- 5a5a0b9 Verify feature graph in Init (#1495)
- 01f924a Add API commands to sign & verify arbitrary messages (#1499)
- 1b21e14 Fix typo related to pico-bitcoin conversion (#1503)
- daddfc0 Type fee rates info (#1504)
- 3d168a5 Remove semaphore build (#1517)
- 2c43742 Show reminder of failed tests at the end (#1521)
- 153f82c Refactor integration tests (#1494)
- ef1bf0b Use the
replyTopattern for Register messages (#1514) - e54066b Remove
Status.Failurein register responses (#1516) - 14a69b8 Trampoline relay exhausted liquidity (#1523)
- 77e972b Improve blockchain watchers (#1500)
- ea72023 Set the channel version in the init msg for the fundee (#1518)
- e34b74f Fix flaky integration test (#1524)
- 6b05099 Use the
replyTopattern for Channel messages (#1520) - b954def Update to Bitcoin Core 0.20.1 (#1526)
- d001100 Migrate relayers to akka typed (#1525)
- 2fc118c Do not reply to htlc settlement commands (#1527)
- f264235 Improve relayer logs (#1529)
- 3158c26 More leeway in tests (#1530)
- eed82e2 Update to scala 2.13.3 and akka 2.6.9 (#1532)
- 750b372 Minor improvements to the watcher (#1531)
- 662e0c4 Anchor output: handle unilateral close (#1501)
- 6ef72a0 Set a timefactor for typed actors tests (#1541)
- 3a773c1 Allow plugins to handle custom messages and features (#1528)
- 483cce4 Split IntegrationSpec (#1535)
- 42481c6 Add some channel events to websocket (#1536)
- 36c9b9b Configure bitcoin wallet (#1540)
- 8a27b4c Fixup funder fee buffer (#1364)
- 0ab7ec6 Add DB entry for payment router error (#1513)
- 1274168 Make all commands extend
Has*ReplyToCommand(#1543) - 382868d [ChannelRelay] Prioritize lowest capacity channels (#1539)
- 56d216b Separate configuration for peer-connection (#1548)
- 8885ed7 (minor) Improve logs in channel relayer (#1550)
- 428349a Send to channel route (#1537)
- 20e0b4b Fix override-features implementation (#1549)
- ed61750 Nits (#1553)
- b728520 Prevent disabling
var_onion_optin(#1552) - eea1ba9 Add backward-compatibility tests on some database codecs (#1554)
- 5036356 Fix forceclose API (#1555)
- 135ce6c Use maven plugin to include tests (#1557)
- a76db1c Fix channel CMD_SIGN (#1556)
- 3da76c0 Allow mandatory static-remotekey (#1558)
- 4b55d3e Fix typo in startup script (#1559)
- 3e3397c Fix Docker JAVA_OPTS expansion (#1561)
Eclair v0.4.1
This release includes many exciting new features, API changes as well as several bug fixes and improvements.
Its is fully compatible with 0.4 (and all previous versions of eclair).
Major changes
Static Remote Key
This release adds support for option_static_remotekey.
This removes the key rotation at each update of the commitment, and allows simpler funds recovery in case of backup loss: channel outputs will directly pay to one of your bitcoin wallet addresses.
This option is disabled by default, and will only be available for new channels when both peers activate the feature.
To enable it, add the following lines to your eclair.conf:
eclair.features {
option_static_remotekey = optional
}
You can verify that this is activated with the getinfo API, which now returns the list of features:
"features": {
"activated": [
{
"name": "basic_mpp",
"support": "optional"
},
{
"name": "initial_routing_sync",
"support": "optional"
},
{
"name": "option_data_loss_protect",
"support": "optional"
},
{
"name": "gossip_queries_ex",
"support": "optional"
},
{
"name": "payment_secret",
"support": "optional"
},
{
"name": "var_onion_optin",
"support": "optional"
},
{
"name": "gossip_queries",
"support": "optional"
}
],
"unknown": []
}Improvements to path-finding and MPP
We've made several improvements to the path-finding algorithm. It now takes into account your channel's current balance more accurately when selecting a route.
The MPP split algorithm has been rewritten from the ground up, inspired by flow algorithms (see #1427 for details). MPP is now enabled by default (it was introduced in eclair v0.3.3 but was opt-in) for all eclair nodes and will soon be available on eclair-mobile (note that Phoenix has had MPP support since its first release).
MPP synergizes well with trampoline: trampoline nodes aggregate incoming MPP and re-split them more efficiently on outgoing channels.
PostgreSQL beta support
Thanks to @rorp, eclair now supports PostgreSQL as a database backend!
By default eclair still uses SQLite, but you can follow the instructions here to use PostgreSQL instead.
We're looking for feedback on how well this is working for you, so don't hesitate to try it out and let us know!
Human-readable features
Say goodbye to hex-encoded features: we've changed the format to be human-readable.
Here is how they are configured by default:
eclair.features {
initial_routing_sync = optional
option_data_loss_protect = optional
gossip_queries = optional
gossip_queries_ex = optional
var_onion_optin = optional
payment_secret = optional
basic_mpp = optional
}
Note that if you want to disable features, there is a trick. You need to first set the features to null and then provide your set of chosen features, for example (in your eclair.conf):
eclair.features : null
eclair.features {
option_data_loss_protect = optional
var_onion_optin = optional
payment_secret = optional
basic_mpp = optional
option_static_remotekey = optional
}
You can verify what features have been set with the getinfo API:
eclair-cli getinfo
{
"version": "0.4.1-SNAPSHOT-xxxxxxx",
"nodeId": "...",
"alias": "...",
"color": "...",
"features": {
"activated": [
{
"name": "basic_mpp",
"support": "optional"
},
{
"name": "initial_routing_sync",
"support": "optional"
},
{
"name": "option_data_loss_protect",
"support": "optional"
},
{
"name": "gossip_queries_ex",
"support": "optional"
},
{
"name": "payment_secret",
"support": "optional"
},
{
"name": "var_onion_optin",
"support": "optional"
},
{
"name": "gossip_queries",
"support": "optional"
}
],
"unknown": []
},
"chainHash": "...",
"network": "...",
"blockHeight": 1,
"publicAddresses": [],
"instanceId": "..."
}Feerate mismatch
When you disagree with your peer about on-chain fee rates, your funds may be at risk if your peer is malicious.
For this reason, eclair has always been closing channels on your behalf before the situation gets too dangerous.
Your tolerance to fee rate mismatch was previously configured via eclair.on-chain-fees.max-feerate-mismatch.
You can now independently configure your tolerance to either lower or higher fee rates:
eclair.on-chain-fees.feerate-tolerance {
ratio-low = 0.5 // will allow remote fee rates as low as half our local feerate
ratio-high = 10.0 // will allow remote fee rates as high as 10 times our local feerate
}
It's less dangerous if your peer overestimates the fees than if she underestimates it, hence the different default values.
We've also made changes to reduce the number of unnecessary close, by only closing channels when there are funds at risk in pending HTLCs. If your channel doesn't have pending HTLCs, eclair will safely ignore the remote fee rate and won't close the channel.
API changes
This release is packed with new APIs and improvements to existing ones:
- batch channel updates (
updaterelayfee,close,forceclose) nodesto lookup node announcements- better
channelstats onchainbalance,sendonchainandonchaintransactionsto interact with layer-1- more data returned in most API responses
Head over to our API documentation for more details.
Miscellaneous improvements and bug fixes
- More metrics for an even better monitoring experience with Kamon.
- Various improvements to connection handling and reconnection logic.
- Updates to security parameters default values.
- Various improvements on fee estimation.
- Better errors for trampoline payments.
- Logging improvements.
Verifying signatures
You will need gpg and our release signing key 7A73FE77DE2C4027. Note that you can get it:
- from our website: https://acinq.co/pgp/drouinf.asc
- from github user @sstone, a committer on eclair: https://api.github.com/users/sstone/gpg_keys
To import our signing key:
$ gpg --import drouinf.ascTo verify the release file checksums and signatures:
$ gpg -d SHA256SUMS.asc > SHA256SUMS.stripped
$ sha256sum -c SHA256SUMS.strippedBuilding
Eclair builds are deterministic. To reproduce our builds, please use the following environment (*):
- Ubuntu 19.10
- AdoptOpenJDK 11.0.6
- Maven 3.6.3
Use the following command to generate the eclair-node package:
mvn clean install -DskipTestsThat should generate eclair-node/target/eclair-node-0.4.1-XXXXXXX-bin.zip with sha256 checksums that matches the one we provide and sign in SHA256SUMS.asc
(*) You may be able to build the exact same artefacts with other operating systems or versions of JDK 11, we have not tried everything.
Upgrading
This release is fully compatible with Eclair v0.4. You don't need to close your channels, just stop eclair, upgrade and restart.
Changelog
- 3f127fb Update kamon (#1411)
- 430f04a BUILD: document mvn clean command (#1413)
- ba4cca2 Use channel balance in path-finding (#1395)
- c4d0604 Payment lifecycle refactor (#1414)
- f22ec21 Feerate provider improvements (#1415)
- 8629d20 Skip executing some plugins when skipping tests (#1418)
- ff5362e Fix eclair-node.sh for OSX (#1424)
- bfd25fa Atomically switch to new connection (#1419)
- 4e4c7c9 Put shebang in first line of launcher scripts (#1423)
- 24b43e9 Use actor system as conf container (#1420)
- 9faaf24 Reduce log level of backup handler (#1429)
- c010317 Fix race condition on early connection failure (#1430)
- 029cafe Use human readable features in configuration (#1385)
- ad44ab3 Path finding standard collections (#1428)
- ce3629c Compute max fee before route calculation (#1417)
- e0320da Electrum: stop spamming logs (#1433)
- 2e79cca Correctly set new channel balance (#1431)
- c04a4ce Accept multiple channels for some API (#1440)
- dc364a1 Implement option_static_remotekey (#1141)
- 4cfb7d9 Fix edges with empty capacity in the routing graph (#1446)
- 2461e3a Fix channelstats API (#1451)
- 50290d9 Monitor on-chain feerate mismatch (#1453)
- 59ea4cd Put back DATA_CLOSING constraints (#1462)
- 570fe57 Add friendly network name to GetInfo response (#1456)
- 676a45c Add on-chain APIs (#1461)
- c52508d Find multi part route (#1427)
- e07a8ec Static key refactoring (#1463)
- d5ec6a5 Increase fulfill safety window (#1466)
- 6c81f95 Use length-delimited byte-aligned codecs (#1442)
- 928d47c Add a fee provider saving feerates to database (#1450)
- d9f257a Multipart FSM v2 (#1439)
- 4199128 MPP preimage received event (#1445)
- 365d091 More aggressive channel exclusion (#1441)
- 88cb24d Routing hints balance (#1443)
- 0563d6d Update allnodes API (#1468)
- 0619b20 Clarify trampoline route not found error (#1455)
- 6d9dbb8 Onion payload and HTLC in-flight metrics (#1464)
- 85163cb Add context logging to route request (#1469)
- 5a83d2f Fix transaction fee test (#1454)
- 7ec3ba8 Fix channelstats (for real?) (#1470)
- 68dfc6c Rework feerate mismatch (#1473)
- b63c4aa Postgresql support (#1249)
- ae3d396 Remove the command buffer (#1476)
- 26fdc62 Update backup handler and add DB metrics (#1475)
- 23b5fb9 Fix commitments fuzz test (#1479)...
Eclair v0.4
This release includes major upgrades to our core libraries (Scala and Akka), as well as several bug fixes and improvements.
Its is fully compatible with 0.3.4 (and all previous versions of eclair).
Major changes
Scala 2.13, Akka 2.6
Update from Scala 2.11 and Akka 2.4 to Scala 2.13 and Akka 2.6.
Scala 2.13 brings a lot of improvements, among which:
- better performance
- tons of improvements for standard collections
- faster compile times
- better support for deterministic builds
Akka 2.6 contains a couple years of steady improvements over Akka 2.4:
- better performance
- better APIs and the introduction of typed actors
- production-ready akka-cluster
Eclair will incrementally take advantage of the new features these updates have to offer.
Bitcoin 0.19.1
Add support for Bitcoin Core 0.19.1.
The most notable change impacting eclair is that fundrawtransaction does not fail when providing a too low feerate, but instead bitcoin will fail when broadcasting the transaction with sendrawtransaction. This is correctly handled by eclair v0.4.
GUI deprecation
eclair-node-gui is being deprecated and will is not published with this release. Source code will still remain available for some time, and building the GUI is very easy (check BUILD.md for more details, but basically mvn install -DskipTests is enough to build eclair-node and eclair-node-gui).
We strongly encourage people to use the API instead, see here for more information (it works on Windows too). We also added instructions on how to setup a monitoring endpoint, where you can create your own graphs and alerts.
Our GUI was built for demonstration and testing purposes, typically with a few nodes on single machine and in regtest mode. Using it as a Lightning wallet or to run routing nodes on mainnet is a very bad fit:
- if you're looking for a Lightning wallet, consider using Phoenix or Eclair Mobile instead.
- if you want to run a routing node, then it should be running on a machine that is reliable, secure, maintained, reachable from the internet and online most of the time, i.e probably not your desktop PC.
- having a "bitcoin-like" GUI is misleading: if your Bitcoin node is offline it has a minimal impact on the Bitcoin network and you can still "receive" funds. When you start it again it catches up on the blocks and transactions that it has missed, so having a Bitcoin wallet or node that is often offline is fine. But when your Lightning node is offline it cannot send, receive or relay transactions. Your channels will be tagged as disabled and other nodes will have to route around you and will likely avoid you in the future because of your unreliability.
Miscellaneous improvements and bug fixes
- More metrics for an even better monitoring experience with Kamon.
- Improvements to our p2p handling of incoming and outgoing connections.
- Fixed some race conditions in tests that were leading to random build failures.
- Added more tests around mempool introspection to extract preimages early.
- UTXOs weren't always correctly unlocked in the Bitcoin Core wallet in case funding failed (fixed in #1404)
Verifying signatures
You will need gpg and our release signing key 7A73FE77DE2C4027. Note that you can get it:
- from our website: https://acinq.co/pgp/drouinf.asc
- from github user @sstone, a committer on eclair: https://api.github.com/users/sstone/gpg_keys
To import our signing key:
$ gpg --import drouinf.ascTo verify the release file checksums and signatures:
$ gpg -d SHA256SUMS.asc > SHA256SUMS.stripped
$ sha256sum -c SHA256SUMS.strippedBuilding
Eclair builds are deterministic. To reproduce our builds, please use the following environment (*):
- Ubuntu 19.10
- AdoptOpenJDK 11.0.6
- Maven 3.6.3
Use the following command to generate the eclair-node package:
mvn clean install -DskipTestsThat should generate eclair-node/target/eclair-node-0.4-XXXXXXX-bin.zip with sha256 checksums that matches the one we provide and sign in SHA256SUMS.asc
(*) You may be able to build the exact same artefacts with other operating systems or versions of JDK 11, we have not tried everything.
Upgrading
This release is fully compatible with Eclair v0.3.4. You don't need to close your channels, just stop eclair, upgrade and restart.
Changelog
- Use correct type for parameters in ExtendedBitcoinClient (#1248)
- Support additional TLV records in SendPayentRequest (#1367)
- Move router handlers to separate files (#1352)
- Do not reconnect immediately if we keep getting disconnected (#1371)
- Better tracking of channels count metric (#1369)
- Revert Electrum Tor disabling SSL check (#1376)
- Add logback config for eclair-node tests (#1377)
- Gossip metrics (#1372)
- Add a rejection for update when channel is pruned (#1378)
- Use sender instead of providing actor refs (#1379)
- Send
update_feeon reconnection (#1383) - Refactor transaction generation errors (#1366)
- fixup! Use sender instead of providing actor refs (#1379) (#1386)
- Router channel balance (#1382)
- Prepare upgrade to scala 2.13 and akka 2.6 (#1389)
- Revert "Use sender instead of providing actor refs (#1379)" (#1391)
- Fix race condition in router tests (#1392)
- Update to scala 2.13 and akka 2.6 (incremental) (#1390)
- Downgrade to scala 2.13.1 (#1394)
- Support bitcoin-0.19.1 (#1380)
- Test preimage extraction from mempool (#1387)
- Remove unused attribute in
Peer(#1397) - Disable backup handler in tests (#1399)
- Fix BitcoinCoreWalletSpec (#1401)
Platform.currentTime->System.currentTimeMillis(#1403)- Delegate client creation to a specialized actor (#1400)
- Monitoring documentation (#1402)
- Validate
channel_announcementsigs early (#1406) - Unlock transaction inputs if tx cannot be published (#1404)
- Update README (#1405)
- Minor: catch harmless unhandled events (#1407)
Eclair v0.3.4
This release includes many improvements, as well as a few bug fixes. Its is fully compatible with 0.3.3 (and all previous versions of eclair).
Major changes
Wumbo channels
Eclair now supports wumbo channels (see lightning/bolts#596).
To activate it, update your eclair.conf and set eclair.features = 080a8a (note that if you chose to enable/disable a different set of features from the recommended ones, that value will be slightly different).
You also need to set an upper limit on channels size in eclair.max-funding-satoshis.
Once that's configured, you can open channels above the previous 0.167 BTC limit (if your peer accepts it).
Be cautious though; bigger channels may attract more attackers towards your node.
Make sure your node deployment is secure before you start opening many large channels.
Packaging rework
Eclair is now packaged as a zip folder (see #1307).
This new packaging allows us to provide verifiable builds for eclair-node and eclair-node-gui.
It also brings us one step closer to verifiable builds for eclair-mobile and phoenix.
Note that you won't find a capsule jar as before.
To start eclair you should now use one of the scripts provided in the package.
GUI deprecation
eclair-node-gui is being deprecated and will not be published with future releases. Source code will still remain available for some time, and building the GUI is very easy (check BUILD.md for more details, but basically mvn install -DskipTests is enough to build eclair-node and eclair-node-gui).
We strongly encourage people to use the API instead, see https://github.com/ACINQ/eclair/wiki/Usage#command-line-with-eclair-cli for more information (it works on Windows too).
Our GUI was built for demonstration and testing purposes, typically with a few nodes on single machine and in regtest mode. Using it as a Lightning wallet or to run routing nodes on mainnet is a very bad fit:
- if you're looking for a Lightning wallet, consider using Phoenix or Eclair Mobile instead.
- if you want to run a routing node, then it should be running on a machine that is reliable, secure, maintained, reachable from the internet and online most of the time, i.e probably not your desktop PC.
- having a "bitcoin-like" GUI is misleading: If your Bitcoin node is offline it has a minimal impact on the Bitcoin network and you can still "receive" funds. When you start it again it catches up on the blocks and transactions that it has missed, so having a Bitcoin wallet or node that is often offline is fine. But when your Lightning nodes is offline it cannot send, receive or relay transactions. Your channels will be tagged as disabled and other nodes will have to route around you.
Miscellaneous improvements and bug fixes
We've done a lot of work on our metrics and logs; make sure to leverage those to improve your node's monitoring.
We've added support for multiple Bitcoin wallets (see #1334).
We've found and fixed a few more gossip bugs; if you previously had issues getting your node's information on explorers, this release should fix it.
We've also fixed many small bugs and heavily refactored parts of the codebase, which paves the way for more scalability and performance improvements.
Verifying signatures
You will need gpg and our release signing key 7A73FE77DE2C4027. Note that you can get it:
- from our website: https://acinq.co/pgp/drouinf.asc
- from github user @sstone, a committer on eclair: https://api.github.com/users/sstone/gpg_keys
To import our signing key:
$ gpg --import drouinf.ascTo verify the release file checksums and signatures:
$ gpg -d SHA256SUMS.asc > SHA256SUMS.stripped
$ sha256sum -c SHA256SUMS.strippedBuilding
Eclair builds are deterministic. To reproduce our builds, please use the following environment (*):
- Ubuntu 19.10
- AdoptOpenJDK 11.0.6
- Maven 3.6.3
Use the following command to generate the eclair-node package:
mvn clean install -DskipTestsThat should generate eclair-node/target/eclair-node-0.3.4-24aa710-bin.zip and eclair-node-gui/target/eclair-node-gui-0.3.4-24aa710-bin.zip with sha256 checksums that matches the one we provide and sign in SHA256SUMS.asc
(*) You may be able to build the exact same artefacts with other operating systems or versions of JDK 11, we have not tried everything.
Upgrading
This release is fully compatible with Eclair v0.3.3. You don't need to close your channels, just stop eclair, upgrade and restart.
Changelog
- Electrum: allow watcher to watch for mempool transactions (#1298)
- Notify change in balance when updating network fee (#1301)
- Fix AuditDb flaky test (#1304)
- Better logging for transport handler (#1303)
- Fix networkstats API call (#1309)
- Payment request: ignore fields with invalid length (#1308)
- Node relayer faster fulfill (#1306)
- Electrum: add support for socks5 proxies (#1315)
- Re-send ChannelUpdate to private channels (#1317)
- Fix random trampoline test failure (#1318)
- SendToRoute with routing hints (#1325)
- Allow receiving non-standard payments (#1326)
- Add log for normal application shutdown. (#1329)
- Rework packaging (#1307)
- Make Commitments method return Try[] (#1311)
- Channel sends typed responses (#1321)
- Refactor MultiPartPaymentFSM (#1324)
- Make UpfrontShutdownScript a TLV record (#1333)
- Wumbo support (#1323)
- Avoid illegal reflective operation during startup (#1313)
- fixup! Use correct assembly descriptors and use bash explicitly. (#1337)
- Send ping if no message received from peer for 30s (#1340)
- Payment metrics (#1312)
- Update kanela-agent 1.0.1->1.0.5 (#1341)
- Allow users to have multiple wallets in bitcoind (#1334)
- Add more information to GetInfoResponse (#1344)
- Re-send ChannelUpdate on reconnection (fixes 8afc00d) (#1342)
- Funder reserve for future fee increase (#1319)
- Minor: Reduced some log levels (#1348)
- Harden requirements on htlc-minimum-msat (#1339)
- Centralize metrics per package (#1350)
- Improve AddHtlcFailed (#1349)
- Split the
Peerin two (#1347) - Minor: removed unused code (#1353)
- fixup! Support for Tor onion services (#736) (#1356)
- BUILD: mention that Docker is needed for tests (#1358)
- fixup! Split the
Peerin two (#1347) (#1357) - Use CLTV as tie-breaker for offered htlc output sorting (#790)
- Add wallet balance metric (#1355)
- fixup! Use CLTV as tie-breaker for offered htlc output sorting (#790) (#1360)
- PostRestartHtlcCleaner handle channel closing (#1338)
- fixup! Harden requirements on htlc-minimum-msat (#1339) (#1362)
- fixup! Harden requirements on htlc-minimum-msat (#1339) (#1363)
- fixup! Split the
Peerin two (#1347) (#1365)
Eclair v0.3.3
This release includes many improvements, as well as a few bug fixes. Its is fully compatible with 0.3.2 (and all previous versions of eclair).
Major changes
Multipart payments
Eclair now supports Multipart Payments (see lightning/bolts#643): payments can now be split into smaller sub-payments sent on different channels, the whole process being "atomic" (they will all succeed, or they will all fail). This is a huge UX improvement for the capacity issue that you encounter when you want to send "large" payments over LN and cannot find a single route with enough capacity along all hops.
MPP is disabled by default for this release, but you can easily enable it by changing eclair.features in your eclair.conf file. If enabled, Eclair will support both sending and receiving MPP. A first splitting algorithm has been implemented to automatically split payments based on your channels and network information. You can also use the CLI to decide on how to split yourself.
More details on our wiki on how to use MPP.
Deterministic builds
The core eclair library (used in our server, desktop and mobile nodes) can now be built deterministically from source. This is the first step towards deterministic builds for our Eclair Mobile and Phoenix applications.
Trampoline Routing Preview
Eclair now supports Trampoline Routing (see lightning/bolts#654), which allows Lightning Nodes to send payments without having to compute a complete route to the destination, by delegating route computation to some of the "trampoline" nodes that relay payments.
Trampoline is still a proposal that has not been merged in the Lightning BOLTs, and is not activated in Eclair's default configuration.
API changes
The sendtoroute API has changed to accommodate MPP and Trampoline.
The format of the payment events has also slightly changed to include more information.
Head over to our API documentation for more details.
Miscellaneous improvements and bug fixes
A few interop bugs with lnd and c-lightning related to channel range queries have been fixed (see #1292 and #1279).
We've also fixed issues related to the broadcast of public node information where local changes to a node configuration (IP address, fee policy, ...) were not broadcast correctly (and would not be found on Lightning explorers for example).
We've done the groundwork to extend any Lightning message with TLV extensions, which allows easy backwards-compatible experimentation on mainnet. See lightning/bolts#714 for more details.
Verifying signatures
You will need gpg and our release signing key 7A73FE77DE2C4027. Note that you can get it:
- from our website: https://acinq.co/pgp/drouinf.asc
- from github user @sstone, a committer on eclair: https://api.github.com/users/sstone/gpg_keys
To import our signing key:
$ gpg --import drouinf.asc
To verify the release file checksums and signatures:
$ gpg -d SHA256SUMS.asc > SHA256SUMS.stripped
$ sha256sum -c SHA256SUMS.stripped
Building
Eclair builds are deterministic. To reproduce our builds, please use the following environment (*):
- Ubuntu 19.10
- AdoptOpenJDK 11.0.6
- Maven 3.6.3
You should then be able to generate an eclair-core.jar with a sha256 checksum that matches the one we provide and sign in SHA256SUMS.asc
(*) You may be able to build the exact same artefacts with other operating systems or versions of JDK 11, we have not tried everything.
Upgrading
This release is fully compatible with Eclair v0.3.2. You don't need to close your channels, just stop eclair, upgrade and restart.
However, if your eclair.conf file contained a non-default value for eclair.local-features or eclair.global-features, you will need to update your configuration. Those two fields have been merged into a single eclair.features. See Flat features (#1253) for more details.
Changelog
- Fix force-close next commit then fulfill (#1299)
- Trampoline/MPP API changes (#1297)
- Support deterministic build of eclair-core artifact on ubuntu (#1295)
- Fix ChannelUpdate rebroadcast (#1294)
- UpfrontShutdownScript field (#1290)
- Clarify ChannelsDb htlc info method (#1291)
- Trampoline/MPP DB changes (#1287)
- Turn off SSL when custom Electrum server address is a hidden service (#1278)
- Fix availableForSend/Receive (#1293)
- Channel queries: Encode empty arrays as UNCOMPRESSED (#1292)
- Allow deactivating MPP (#1289)
- Read fee provider timeout from config correctly (#1288)
- Improve NodeRelayer errors (#1261)
- Peer: use a minimum reconnection delay of 200 ms (#1285)
- Add networks to init message (#1254)
- Better Non-segwit UTXOs assert message. (#1258)
- Provide solution to "non-segwit UTXO found." (#1256)
- Make sure that ids chunks strictly cover the requested range, without gaps (#1279)
- Broadcast gossip regardless of timestamp filters (#1284)
- MPP: allow using unannounced channels (#1283)
- Improve error message when invalid funding tx (#1282)
- Find htlc by id method (#1266)
- Fix Sphinx privacy leak (#1247)
- Dependencies: use bitcoin-lib 0.17 (#1277)
- Electrum improvements (#1164)
- Add contributing instructions (#1252)
- Fix how we split channel ids in channel queries (#1274)
- Always encode empty list of scids as uncompressed (#1276)
- Avoid sending PaymentSecret/MPP in Init (#1273)
- Restore missing 'db.close()' methods (#1272)
- Flat features (#1253)
- Disable Trampoline-MPP to non-Phoenix recipients (#1271)
- Remove mockito from switchboard tests (#1267)
- More consistency in sending messages during sync (#1268)
- Remove repeated code (#1265)
- Added some instructions for TOR auth (#1262)
- Improve CommandSend type (#1260)
- Relay Trampoline payments (#1220)
- Update Maven (3.6.3) (#1259)
- Add synchronization when locking database connection (#1200)
- Add HasHtlcIdCommand trait (#1245)
- Better randomization of reconnection delay (#1250)
- Minor: missing log category in peer (#1241)
- MPP: don't retry if failure comes from final recipient (#1246)
- Minor: ignore "disconnecting" message in Channel (#1231)
- Add a configurable time-out to onchain fee provider requests (#1244)
- Fix MPP flaky test (#1243)
- added blank lines to minimize conflicts (#1236)
- Set
akka.logleveltoDEBUG(#1235) - Fix outgoing payments order in payments overview (#1232)
- Added a 'category' in logs (#1227)
- Handle chain re-org in balance computation (#1228)
- Fix onion codec test (#1229)
- High level payments overview method (#1225)
- Rework truncated integers codecs (#1212)
- Extended doHandle to other messages in MultiPartHandler (#1226)
- Avoid incoherent payment request features. (#1222)
- Fix MPP post-restart HTLC clean-up (#1224)
- (waiting-since-in-blocks) Improved tracing of single/multi-part payments (#1218)
- Add networkstats API call to allow display of network stats (#1221)
- MPP routing improvements (#1219)
- PaymentLifecycle should tell the router to ignore route prefix (#1217)
- Fallback ElectrumClient to TLS 1.2 if 1.3 is not supported (#1216)
- Fix /allupdates API (#1187)
- Refactor: move channel relaying to a ChannelRelayer actor. (#1215)
- Update invoice test vectors. (#1213)
- Add trampoline onion support (#1209)
- Payment Request: speed up node id computation (#1203)
- Ignore NPE in tests (#1211)
- Fixed race condition on payment handler init (#1208)
- Fixed composition of receive handlers (#1207)
- Multi part payments (#1153)
- Minor: fixed format in exception message (#1199)
- (tag: btcpay) More metrics (#1196)
- Add 'getnewaddress' API (#1190)
- Fix codecov unknown tag (#1181)
- Refactor Upstream/Origin (#1176)
- Fix ignored duplicate amounts in htlc-value-in-flight (#1180)
Thank you @btcontract @CandleHater !
Eclair v0.3.2
This release includes many improvements, as well as a few bug fixes.
This release is fully compatible with 0.3.1 (and all previous versions of eclair), but some configuration options have been moved to a new section. This is checked automatically and Eclair will tell you what to do if you use these options, see the Upgrading section below for more details.
Major changes
Backupless Backups :)
Channel keys are now derived from channel's funding public keys, which can be retrieved from the Bitcoin blockchain when a channel is closed. What this means is that even if you don't have any backups, as long as you still have your seed and can find the ids of the nodes you were connected to, you can recover your funds using Lightning's Data Loss Protection feature.
So how does it work ? Just reconnect to the same nodes, they will publish their commit transactions and give you their channel data, watch for it on the Bitcoin blockchain, extract public keys, recompute your channel keys and combine them with the data they gave you to spend your output. Of course we'll release a tool to automate this process, but all new channels created with v0.3.2 will benefit from this feature.
Extended Channel Queries
We implemented an extension to channel queries which makes retrieving and syncing routing information more efficient, which is really good for mobile Lightning nodes which can now sync their routing data faster and using less bandwidth. It is also a first step toward even more efficient strategies (inventory-based gossip, similar to how bitcoin nodes relay blocks and transactions, and potentially more advanced reconciliation algorithms).
Payment API improvements
We've changed the payment API to return more information about received and sent payments (fees, status, route, etc). If you were relying on the format of the previous responses, you may need to slightly update your code. See the API documentation for details.
Configurable transaction confirmation targets (see #1083)
You can now configure the number of confirmations that your node will target for funding, commitment and claim transactions (i.e transactions that spend a commitment transaction, when a channel is closed for example), which has an impact on the fee rate that will be selected in each case. We still provide good default values, and would recommend that you read the description of PR #1083 carefully before you set custom values.
Miscellaneous improvements and bug fixes
We've implemented several new BOLT changes which pave the way for new Lightning features, such as AMP and trampoline payments:
We now run our unit and integration tests against Bitcoin Core 0.18.1, which is our recommended version. Eclair will still work with Bitcoin Core 0.17 but support may be dropped when 0.19 is released.
We've fixed a bug in our Electrum coin selection algorithm, this fix will be included in the next eclair-mobile release (see #1146).
We now allow you to restrict peers you want to sync from (see sync-whitelist #954).
Verifying signatures
You will need gpg and our release signing key 7A73FE77DE2C4027. Note that you can get it:
- from our website: https://acinq.co/pgp/drouinf.asc
- from github user @sstone, a committer on eclair: https://api.github.com/users/sstone/gpg_keys
To import our signing key:
$ gpg --import drouinf.asc
To verify the release file checksums and signatures:
$ gpg -d SHA256SUMS.asc > SHA256SUMS.stripped
$ sha256sum -c SHA256SUMS.stripped
Upgrading
This release is fully compatible with Eclair v0.3.1. You don't need to close your channels, just stop eclair, upgrade and restart. There are 2 changes you need to pay attention to though:
- our target JDK is JDK11 and we don't support JDK8 anymore
- our Bitcoin Core target is 0.18.1
If you're still running JDK8 or Bitcoin Core 0.17 we strongly suggest that you upgrade.
The following configuration keys have changed and have been moved to an on-chain-fees section:
| Old name | new name |
|---|---|
default-feerates |
on-chain-fees.default-feerates |
max-feerate-mismatch |
on-chain-fees.max-feerate-mismatch |
update-fee_min-diff-ratio |
on-chain-fees.update-fee-min-diff-ratio |
update-fee-min-diff-ratio to be consistent with other configuration keys.
If you have overridden default values for these keys and have not updated your configuration file, Eclair will not start but instead display a message and tell you which key to update.
For example, if you had overridden max-feerate-mismatch, this is what what you had with 0.3.1:
eclair.max-feerate-mismatch = 10
You must update your configuration file like this:
eclair.on-chain-fees.max-feerate-mismatch = 10
Changelog
- Check configuration for obsolete keys on startup (#1175)
- Update assisted channels (#1172)
- Sqlite: use TEXT type for strings (#1159)
- Use guava to compute CRC32C checksums (#1166)
- Activate extended channel range queries (#1165)
- Add execution time limit (#1161)
- Update netty dependency to 4.1.32 (#1160)
- Upgrade new unit tests to bitcoin 0.18.1 API (#1157)
- Use bitcoin 0.18.1 in the test (#1148)
- Extend funding key path to 256 bits (#1154)
- Electrum: improve coin selection (fixes #1146) (#1149)
- HTTP API: add type hints for payment status (#1150)
- Commitments: take HTLC fee into account (#1152)
- Fix and expand channel keypath (#1147)
- Check if remote funder can handle an updated commit fee when sending HTLC (#1084)
- Derive channel keys from the channel funding pubkey (#1097)
- Handle fees increases when channel is OFFLINE (#1080)
- Improve error handling when we couldn't find all the channels for a supplied route in /sendtoroute API (#1142)
- Payment lifecycle refactoring (#1130)
- Update string to match on bitcoind while it's indexing (#1138)
- Sphinx: accept invalid downstream errors (#1137)
- Drop support for Java 8 (#1135)
- Add codecov integration to semaphore CI (#1134)
- Make tests run in parallel (#1112)
- Removed Globals class (#1127)
- Don't hardcode the channel version (#1129)
- Check funds in millisatoshi when sending/receiving an HTLC (#1128)
- Add monitoring with Kamon (disabled by default) (#1126)
- Router computes network stats (#1116)
- Add Semaphore CI (#1125)
- Activate support for variable-length onion (#1087)
- Made sync params configurable (#1124)
- Reject expired invoices before payment flow starts (#1117)
- Update docker build (#1123)
- Implement Bolt 11 invoice feature bits (#1121)
- Use Long to back the UInt64 type (#1109)
- Fix maven mirror (#1120)
- Fix build (#1115)
- Bolt4: remove final expiry too soon error message (#1106)
- Fix regression in
Commitments.availableForSend(#1107) - Move http APIs to subproject eclair-node (#1102)
- Add a sync whitelist (#954)
- Use unsigned comparison for 'maxHtlcValueInFlightMsat' (#1105)
- Add more numeric utilities to MilliSatoshi (#1103)
- Rework router data structures (#902)
- Extended queries optional (#899)
- Typed cltv expiry (#1104)
- Publish transactions during transitions (#1089)
- Route computation: fix fee check (#1101)
- Typed amounts (#1088)
- Documentation update (#1092)
- Update list of commands in eclair-cli help (#1091)
- Use correct cost comparison when evaluating candidate channels (#1090)
- Configurable transaction confirmation target (#1083)
- Made using/storing/sending consistent (#1082)
- Variable-length onion payloads (#976)
- Handle fulfill not acked upstream (#1079)
- Replace traits by bitfield for ChannelVersion (#1073)
- Switch varint codec to big-endian. (#1075)
- Added a channel version to
Commitmentsobject (#1059) - TLV improvements and full spec compatibility (#1069)
- Wrap all routes in toStrictEntity (#1032)
- Electrum: update checkpoints (#1067)
- Handle unknown fields in network announcements (#1047)
- Add a few improvements to tlv. (#1065)
- Add eclair-cli to eclair's docker image (#1063)
- Use a
RelayResultclass instead of anEither(#1064)
Thank you @btcontract !