Eclair v0.3 Release Notes

Release Date: 2019-05-09 // almost 5 years ago
  • ๐Ÿš€ This is a major release which includes many improvements and bug fixes, and we recommend that users upgrade.

    โฌ†๏ธ It is compatible with eclair v0.2-beta9 (i.e you don't have to close your channels) but upgrading may be not as seamless as for previous versions, please check the Upgrading section.

    Major changes

    0๏ธโƒฃ Eclair runs on mainnet by default

    ๐Ÿ”ง Default configuration now targets mainnet, but you can still easily run Eclair on testnet or regtest.

    ๐Ÿ†• New RPC API

    ๐Ÿ“š Our RPC API has been upgraded and improved and now include calls to retrieve payment information, see our API documentation. You can still choose to use the old API with a configuration option that will be removed in a future release.

    Easy channels backup

    โšก๏ธ Making backups of your channels is now simpler: we create an update an eclair.sqlite.bak backup file that is always consistent and safe to use even when your node is running.

    โช Please note that an old backup can be used as a "static" backup: if you restore an old backup, channels open to peers that support Data Loss Protect will be recovered.

    ๐Ÿ”Œ Simple Plugin Support

    ๐Ÿš€ You can now easily write and deploy your own plugins, written in any JVM-compatible language. See the readme for more details.

    Bitcoin Core v0.17 or newer is now required

    โฌ†๏ธ We now require Bitcoin Core v0.17 or newer, meaning that eclair now works with Bitcoin Core v0.18. Eclair will not work anymore with older versions, you will have to upgrade.

    ๐Ÿ‘Œ Support for Tor Services

    You can now run Eclair as a Tor hidden service for increased privacy.

    Note that Tor also offers out-of-the-box NAT traversal, which solve the issue of changing ips.

    Target JDK is now OpenJDK 11

    We switched our target JDK from Oracle JDK8 to OpenJDK 11, and we recommend that you use it to run eclair. You can still use Oracle JDK8 (but it's up to you to check your licensing options).

    ๐ŸŽ Performance improvements

    ๐Ÿง Eclair now embeds native JNI bindings for libsecp256k1 for Linux 64 bits, Windows 64 bits and Osx 64 bits, which makes eclair much faster. You can still use your own version of libsecp256k1 if you use a different OS.

    Many internal structures and workflows have been optimised and eclair is now even faster (not that it was ever slow to begin with, eclair is used on some of the biggest nodes on LN).

    ๐Ÿ‘Œ Verifying signatures

    ๐Ÿš€ You will need gpg and our release signing key 7A73FE77DE2C4027. Note that you can get it:

    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 compatible with Eclair v0.2-beta9. You don't need to close your channels, just stop eclair, upgrade and restart. However, there are 2 major runtime changes that you need to take into account:

    If you're using Bitcoin Core v0.16.3, you must upgrade to v0.17 (latest release is 0.17.1). Since we require indexing, you tx index database will be migrated the first time you start your Bitcoin Core, which may take up to a few hours. Please stop eclair, migrate your Bitcoin node, and wait until its index database has been migrated before you start eclair again !

    ๐Ÿ‘€ Our target JDK is now OpenJDK 11, and we suggest that you use it to run Eclair. You can still use Oracle JDK8 (but it's up to you to check your licensing options). See #846 for more details.

    ๐Ÿ .exe Windows installer has been removed

    ๐Ÿš€ Starting with this version, we do not release a Windows installer. Windows users must instead run the eclair jar file manually. If you're not sure how to do that, follow the instructions below:

    • Download and install Java with OpenJDK
    • Download the eclair-node-gui-0.3-a5debcd.jar file from this page and put it somewhere on your disk
    • Create a run-eclair-0.3.bat file somewhere on your disk, with the following content:

      start /B javaw -Declair.datadir=C:\path\to\node\datadir -jar C:\path\to\eclair-node-gui-0.3-2a89cf7.jar

    0๏ธโƒฃ Replace the C:\path\to\... section with the actual values on your system. Note if you use the default datadir (which is C:\Users\name\.eclair) you can omit the -Declair.datadir=... section.

    ๐Ÿ’ป You can now run eclair by executing this bat file. Alternatively, you can use command line.

    ๐Ÿ”„ Changelog

    • ๐Ÿ‘‰ Use bitcoind fee estimator first (#987)
    • Ignore subprojects eclair-node/eclair-node-gui in the codecov report (#991)
    • Accept commit_sig without changes (#988)
    • โž• Add bot support for code coverage (codecov) (#982)
    • โฑ Set tcp client timeout to 20s (#990)
    • 0๏ธโƒฃ Set default chain to "mainnet" (#989)
    • Replace UnknownPaymentHash and IncorrectPaymentAmount with IncorrectOrUnknownPaymentDetails (#984)
    • โšก๏ธ Update bash autocompletion for eclair-cli (#983)
    • ๐Ÿ‘ API: Support query by channelId or shortChannelId everywhere (#969)
    • ๐Ÿ‘ Better handling of closed channels (#944)
    • ๐Ÿ”Š Electrum: make debug logs shorter (#964)
    • ๐Ÿ”€ ElectrumWallet should not send ready if syncing (#963)
    • ๐Ÿ–จ Print stack trace when crashing during boot sequence (#949)
    • Live channel database backup (#951)
    • โž• Added simple plugin support (#927)
    • โž• Add channel errors in audit db (#955)
    • โž• Added a timeout for channel open request (#928)
    • Electrum: do not persist transaction locks (#953)
    • โž• Add a proper payments database (#885)
    • ๐Ÿ”ง Set max payment attempts from configuration (#931)
    • ๐Ÿ”ฆ Expose the websocket over HTTP GET to work properly with basic auth (#934)
    • Send events when HTLCs settle on-chain (#884)
    • โšก๏ธ Electrum: update client name (#930)
    • โž• Add random delay to rebroadcast (#925)
    • Rollback tx if disconnected in WAIT_FOR_FUNDING_SIGNED (#923)
    • โœ… Separate cases for bech32 testnet and regtest for BOLT11 fallback address
    • API: use form data instead of JSON-RPC (#894)
    • Deal with channels with fees=0 when computing a route (#905)
    • Check WatchSpent in constant time (#916)
    • Rework database initialization (#911)
    • ๐Ÿ‘‰ Use bitcoin-lib 0.11 which embeds libsecp256k1 (#907)
    • โšก๏ธ Don't send updates if no filter has been set (#912)
    • โฌ†๏ธ Upgrade to bitcoin 0.17.1 (#826)
    • ๐Ÿ‘ Better logic for sending channel_updates (#888)
    • Replace BinaryData by scodec.bits.ByteVector (#896)
    • ๐Ÿ‘ Better error logs for socks5 proxy (#893)
    • ๐Ÿšš NetworkDb: remove stale channels in batch (#886)
    • Clean channels with unexisting funding tx (#714)
    • 0๏ธโƒฃ Set default to-remote-delay-blocks to 720 (#879)
    • Routing heuristics (#821)
    • ๐Ÿ‘‰ Use ypub prefix for Electrum xpub (#875)
    • โšก๏ธ Update jeromq dependency (#852)
    • 0๏ธโƒฃ Use OpenJDK 11 as default JDK (#846)
    • ๐Ÿ›  Electrum fixes and improvements (#873)
    • ๐Ÿ›  Fixed computation of available balance (#868)
    • Faster gui startup (#863)
    • ๐Ÿ‘Œ Support all-uppercase payment requests (#862)
    • Reimplemented BOLT 11 with scodec (#856)
    • Parametric route search (#844)
    • Increased max-to-local-delay-blocks to 2016 (#853)
    • Stop disconnected peer when it has no channels (#840)
    • ๐Ÿ‘Œ Improve Electrum start-up time (#848)
    • โž• Add balance and channel lifecycle events to the audit db (#827)
    • ๐Ÿ‘Œ Support for Tor onion services (#736)
    • (Router) Always select direct channel if there is one to the target (#850)
    • Proper handling of gossiped channels being spent (#838)
    • Ignore reconnections requests to the same peer with the same address (#835)
    • Replace initialization futures Future[Boolean] by Future[Done] (#836)
    • Set timestamp filter lower bound to current time (#837)
    • ChannelSelectionSpec: use akka.event.NoLogging (#834)
    • Relay to channel with lowest possible balance (#784)
    • ๐Ÿ”Š Complete commit logs

    Thank you @btcontract @rorp @n1bor @Kukks !