mirrors/eclair
1
0
Fork 0
mirror of https://github.com/ACINQ/eclair.git synced 2024-11-19 09:54:02 +01:00
Code Issues Projects Releases Wiki Activity
ef25e3287a
eclair/docs/release-notes/eclair-v0.6.1.md
Bastien Teinturier 8b29edb58d
Add release notes in the repository (#1951) 
It's useful to have the release notes directly inside the repository
instead of relying on Github: that lets for example users read them offline.

It also lets us fill the release notes every time we add relevant features
on `master` instead of having to do them all at once when we decide to make
a release.
2021-09-20 14:35:00 +02:00

11 KiB
Raw Blame History

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.

  1. WAL is significantly faster in most scenarios.
  2. WAL provides more concurrency as readers do not block writers and a writer does not block readers.
  3. Disk I/O operations tends to be more sequential using WAL.
  4. 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:

  • parseinvoice displays 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:

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 20.04
  • AdoptOpenJDK 11.0.6
  • Maven 3.8.1

Use the following command to generate the eclair-node package:

mvn clean install -DskipTests

That 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

  • a658fa26f Set version to 0.6.1-SNAPSHOT (#1813)
  • 76894bd2e Add additional PRNG (#1774)
  • 9a20aade0 Allow plugins to inject their own routes into API (#1805)
  • d437ea1ed Improve API plugin support (#1819)
  • 98cae455f Rename pending_relay to pending_commands (#1822)
  • e8c33baf5 Various improvements and fixes (#1817)
  • f829a2e8c Add json type hints on channel data (#1824)
  • 4dc2910c4 Make result set an iterable (#1823)
  • 6f6c458a2 Add metrics on channels processing time (#1826)
  • 43a89f865 Add a random delay before processing blocks (#1825)
  • af618bc44 Symmetrical HTLC limits (#1828)
  • dbecb28d9 Include routing hints in parseinvoice API call response (#1833)
  • 2b6d564d2 Expose eclair datadir to plugins (#1837)
  • bd6bad1bf Fix eventually statements (#1835)
  • a7bb2c2b2 Do not store CannotAffordFees errors (#1834)
  • d4b25d565 Udpate to Bitcoin Core 0.21.1 (#1841)
  • e750474c7 Use bitcoin-lib 0.19 (#1839)
  • bbfbad597 Validate payment secret when decoding (#1840)
  • afb1b41ea Update bolt 3 spec test vectors (#1669)
  • d43d06f6e Rework TxPublisher (#1844)
  • 45204e238 Schedule backup at regular interval (#1845)
  • 85ed4338a Reject 0-value trampoline payments (#1851)
  • f857368ea Make trampoline payments use per-channel fee and cltv (#1853)
  • f52c3dd3f Decode warning messages (#1854)
  • 516929b1a Fix default file backup config (#1857)
  • 4ca5c62ab Remove println in tests (#1861)
  • 291c128ca Reduce some log levels (#1864)
  • d9a03a52b Use warning messages for connection issues (#1863)
  • af8394a28 Add support for dual db backend (#1746)
  • 3a573e267 Improve message for CannotRetrieveFeerates error (#1859)
  • bd57d41ef Add a globalbalance api call (#1737)
  • 08faf3b7f Add json columns in Postgres (#1865)
  • f8feb1959 Use schemas in Postgres (#1866)
  • cea3fc026 Use proper data type for timestamps in Postgres 2 (#1862)
  • 95fffe348 Reduce pg transaction isolation (#1860)
  • 547d7e700 Create chain directory (#1872)
  • e9df4eece Channels data format migration (#1849)
  • 733c6e768 Refactor global balance tests (#1874)
  • ca51a2d16 Enable WAL mode on Sqlite (#1871)
  • 3ae9a4ae3 Additional reestablish test (#1875)
  • d02760d96 Fail unsigned outgoing htlcs on force-close (#1832)
  • 3bb7ee8a3 Parallel payment request generation (#1878)
  • 51824028b Fix flaky channel integration tests (#1879)
  • b4183edfa Fetch incoming payments in parallel (#1880)
  • 8c49f779a Fix payment handler tests (#1882)
  • 01b40730f Implement option-upfront-shutdown-script (#1846)
  • 79729c78c Update README (#1881)
  • c22596bb9 Update dependencies and enable fatal warnings (#1885)
  • adf36de0e Fix yet another flaky test (#1886)
  • 3f1c2506a Fix watcher flaky test (#1883)
  • c8c5e76d2 Update akka-http-json4s dependency (#1889)
  • d3ae32326 Set version to 0.6.1 (#1887)