eclair/docs/release-notes/eclair-v0.6.2.md

Eclair v0.6.2

This releases fixes a known vulnerability, makes several performance improvements, includes a few bug fixes and many new features. It is fully compatible with 0.6.1 (and all previous versions of eclair).

This release requires a few actions from node operators when upgrading: make sure you read the release notes carefully!

Major changes

ZMQ changes

Eclair previously used ZMQ to receive full blocks from Bitcoin Core. In this release, we instead switch to receive only block hashes over ZMQ. This will save bandwidth and improve support for deployments with a remote Bitcoin Core node.

⚠️ When updating eclair, you need to update your bitcoin.conf to have your Bitcoin Core node send block hashes via ZMQ.

The previous configuration was:

zmqpubrawblock=tcp://127.0.0.1:29000

You must remove that line from your bitcoin.conf and replace it with:

zmqpubhashblock=tcp://127.0.0.1:29000

Per node relay fees

Relay fees are now set per node instead of per channel:

• If you set the relay fees for a node with the updaterelayfee API, all new channels with this node will use these fees.
• Otherwise the default relay fees set in eclair.conf will be used: this means that changing eclair.conf will update the fees for all channels where the fee was not manually set.

Note that you can use the updaterelayfee API before opening a channel to ensure that the channel doesn't use the default relay fees from eclair.conf.

The config for default fees has also be changed to allow different default fees for announced/unannounced channels: fee-base-msat/fee-proportional-millionths are now nested inside relay.fees.public-channels/relay.fees.private-channels.

⚠️ When updating eclair, the relay fees for your existing channels will be reset to the value from your eclair.conf. You should use the updaterelayfee API to reconfigure relay fees if you don't want to use the default fees for every node you're connected to.

Beta support for anchor outputs

Anchor outputs is still disabled by default, but users willing to try it can activate it by adding the following line to eclair.conf:

eclair.features.option_anchors_zero_fee_htlc_tx = optional

Once activated, eclair will keep the commitment feerate below 10 sat/byte regardless of the current on-chain feerate and will not close channels when there is a feerate mismatch between you and your peer.

You can modify that threshold by setting eclair.on-chain-fees.feerate-tolerance.anchor-output-max-commit-feerate in your eclair.conf. Head over to reference.conf for more details.

In case the channel is unilaterally closed, eclair will use CPFP and RBF to ensure that transactions confirm in a timely manner. You MUST ensure you have some utxos available in your Bitcoin Core wallet for fee bumping, otherwise there is a risk that an attacker steals some of your funds.

Do note that anchor outputs may still be unsafe in high-fee environments until the Bitcoin network provides support for package relay.

Configurable dust tolerance

Dust HTLCs are converted to miner fees when a channel is force-closed and these HTLCs are still pending. This can be used as a griefing attack by malicious peers, as described in CVE-2021-41591.

Node operators can now configure the maximum amount of dust HTLCs that can be pending in a channel by setting eclair.on-chain-fees.feerate-tolerance.dust-tolerance.max-exposure-satoshis in their eclair.conf.

Choosing the right value for your node involves trade-offs. The lower you set it, the more protection it will offer against malicious peers. But if it's too low, your node may reject some dust HTLCs that it would have otherwise relayed, which lowers the amount of relay fees you will be able to collect.

Another related parameter has been added: eclair.on-chain-fees.feerate-tolerance.dust-tolerance.close-on-update-fee-overflow. When this parameter is set to true, your node will automatically close channels when the amount of dust HTLCs overflows your configured limits. This gives you a better protection against malicious peers, but may end up closing channels with honest peers as well. This parameter is deactivated by default and unnecessary when using option_anchors_zero_fee_htlc_tx.

Note that you can override these values for specific peers, thanks to the eclair.on-chain-fees.override-feerate-tolerance mechanism. You can for example set a high eclair.on-chain-fees.feerate-tolerance.dust-tolerance.max-exposure-satoshis with peers that you trust.

Note that if you were previously running eclair with the default configuration, your exposure to this issue was quite low because the default max-accepted-htlc is set to 30. With an on-chain feerate of 10 sat/byte, your maximum exposure would be ~70 000 satoshis per channel. With an on-chain feerate of 5 sat/byte, your maximum exposure would be ~40 000 satoshis per channel.

Path-finding improvements

This release contains many improvements to path-finding and paves the way for future experimentation.

A noteworthy addition is a new heuristic that can be used to penalize long paths by setting a virtual cost per additional hop in the route (#1815). This can be freely configured by node operators by setting fields in the eclair.router.path-finding.default.hop-cost section.

We also added support for A/B testing to experiment with various configurations of the available heuristics. A/B testing can be activated directly from eclair.conf, by configuring some experiments, for example:

eclair.router.path-finding.experiments {
  control = ${eclair.router.path-finding.default} {
    percentage = 75 // 75% of the traffic will use the default configuration
  }

  use-shorter-paths = ${eclair.router.path-finding.default} {
    percentage = 25 // 25% of the traffic will use this custom configuration
    ratios {
      base = 1
      cltv = 0
      channel-age = 0
      channel-capacity = 0
    }
    hop-cost {
      // High hop cost penalizes strongly longer paths
      fee-base-msat = 10000
      fee-proportional-millionths = 10000
    }
  }
}

Have a look at reference.conf for more examples.

You can also force a specific payment to use an experimental path-finding configuration by specifying the experiment name in the various path-finding APIs:

eclair-cli payinvoice --invoice=<xxx> --pathFindingExperimentName=use-shorter-paths

The results are stored in the audit database, inside the path_finding_metrics table. You can then analyze the results after sending a large enough number of payments to decide what configuration yields the best results for your usage of lightning.

Tor support for blockchain watchdogs

Eclair introduced blockchain watchdogs in v0.5.0, where secondary blockchain sources are regularly queried to detect whether your node is being eclipsed.

Most of these watchdogs were previously queried over HTTPS, which exposes your IP address. This is fixed in this release: when using Tor, the watchdogs will now also be queried through Tor, keeping your IP address private.

You can also now choose to disable some watchdogs by removing them from the eclair.blockchain-watchdog.sources list in eclair.conf. Head over to reference.conf for more details.

Dust limit thresholds

Eclair can now use dust limits as low as 354 satoshis. This value covers all current and future segwit versions, while ensuring that transactions can relay according to default bitcoin network policies.

With this change, we also disallow non-segwit scripts when closing a channel. We still support receiving non-segwit remote scripts, but will force-close if the resulting mutual close transaction would be invalid according to default network policies.

See the spec discussions for more details.

Audit trail for published transactions

Eclair now records every transaction it publishes in the audit database, in a new transactions_published table. It also stores confirmed transactions that have an impact on existing channels (including transactions made by your peer) in a new transactions_confirmed table.

This lets you audit the complete on-chain footprint of your channels and the on-chain fees paid. This information is exposed through the networkfees API (which was already available in previous versions).

We removed the previous network_fees table which achieved the same result but contained less details.

Sample GUI removed

We previously included code for a sample GUI: eclair-node-gui. This GUI was only meant to be used for demo purposes, not for mainnet node administration.

However some users were using it on mainnet, which lead to several issues (e.g. channel closure and potentially loss of funds). We completely removed it from this release to prevent it from happening again.

API changes

This release contains many API updates:

• open lets you specify the channel type through the --channelType parameter, which can be one of standard, static_remotekey, anchor_outputs or anchor_outputs_zero_fee_htlc_tx (#1867)
• open doesn't support the --feeBaseMsat and --feeProportionalMillionths parameters anymore: you should instead set these with the updaterelayfee API, which can now be called before opening a channel (#1890)
• updaterelayfee must now be called with nodeIds instead of channelIds and will update the fees for all channels with the given node(s) at once (#1890)
• close lets you specify a fee range when using quick close through the --preferredFeerateSatByte, --minFeerateSatByte and --maxFeerateSatByte (#1768)
• close now rejects non-segwit scriptPubKey
• createinvoice now lets you provide a --descriptionHash instead of a --description (#1919)
• sendtonode doesn't support providing a paymentHash anymore since it uses keysend to send the payment (#1840)
• payinvoice, sendtonode, findroute, findroutetonode and findroutebetweennodes let you specify --pathFindingExperimentName when using path-finding A/B testing (#1930)
• the --maxFeePct parameter used in payinvoice and sendtonode must now be an integer between 0 and 100: it was previously a value between 0 and 1, which was misleading for a percentage (#1930)
• findroute, findroutetonode and findroutebetweennodes let you choose the format of the route returned with the --routeFormat parameter (supported values are nodeId and shortChannelId) (#1943)
• findroute, findroutetonode and findroutebetweennodes now accept --includeLocalChannelCost to specify if you want to count the fees from your node like trampoline payments do (#1942)

Have a look at our API documentation for more details.

Miscellaneous improvements and bug fixes

• Eclair nodes may now use different relay fees for unannounced channels (#1893)
• Relay fees are now set per node and automatically apply to all channels with that node (#1890)
• Eclair now supports explicit channel type negotiation
• Eclair now supports quick close, which provides more control over what feerate will be used when closing channels

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 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.2-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 previous eclair versions. You don't need to close your channels, just stop eclair, upgrade and restart.

Changelog

• cafaeed Set version to 0.6.2-SNAPSHOT (#1888)
• 6d4da40 Different default relay fees for announced and unannounced channels (#1893)
• 2d68bab Fix API substream materialization issues (#1884)
• 131ae8b Balance: do not deduplicate identical htlcs amounts (#1894)
• 8f5f6ac Set relay fees per node and save them to database (#1890)
• a342717 Retry local channel failures in trampoline payments (#1899)
• 19f4d1f Refactor db migration (#1901)
• 9f2b036 Rename channel type traits (#1909)
• 4cde8c5 Handle shutdown retransmit when negotiating (#1902)
• aab83fd Don't add channel update to auditDb if it hasn't changed (#1906)
• ebed5ad Add cost per hop and base weight ratio (#1815)
• 49e1996 MPP scale min part amount based on total amount (#1911)
• 9a0fc14 Nicer feerate string representation (#1908)
• c504658 Better handling of remote commit confirmation in TxPublisher (#1905)
• 759c87f Add advanced configuration details in README.md (#1915)
• fc36321 Add TlvStream to all lightning messages (#1891)
• 07b022e Split SendPayment in SendPaymentToRoute and SendPaymentToNode (#1921)
• 92091a1 Fix ZmqWatcher flaky test (#1925)
• d53f57f Switch ZMQ to block hash and improve resiliency (#1910)
• 275581d Make route params explicit (#1923)
• 59ccf34 Explicit channel type in channel open (#1867)
• 54fa208 Add validation on the recid in verifymessage (#1928)
• bca2a83 Tor support for blockchain watchdogs (#1907)
• d11765c Add description_hash in createinvoice (#1919)
• 118285f Gracefully release Postgres lock on shutdown (#1912)
• 4f93734 Add warning about GUI deprecation (#1929)
• 9f9f10e Conversion nits (#1937)
• daace53 Dedicated event for channel_update modifications (#1935)
• 663094e More flexible mutual close fees (#1768)
• 632d40c Add AbstractChannelRestored event trait (#1927)
• 88f0dfd Make publising of onion addresses configurable (#1936)
• 6c546f0 Remove messageFlags from ChannelUpdate (#1941)
• 768a745 AB testing (#1930)
• 64f33ba Fix isNode1 in tests (#1944)
• 24dd613 Fix the build (#1945)
• a228bac Implement anchor outputs zero fee htlc txs (#1932)
• 03ac320 Add 'shortChannelId' output format for findroute* API calls (#1943)
• fb0199c Update Bolt 11 official test vectors (#1870)
• 5b7a474 Clean up inconsistency between bitcoin client and wallet (#1939)
• e93110b Use Github discussions instead of Gitter (#1954)
• 8b29edb Add release notes in the repository (#1951)
• 273fae9 Add success probabilities in path finding (#1942)
• c846781 Make Tor optional for blockchain watchdogs (#1958)
• 5686ad0 Minor changes and refactoring (#1965)
• 467a0bc Count local fees in path finding metrics (#1963)
• d5c0c73 Clarify Bitcoin Core supported versions (#1960)
• 5fc980c Lower minimum remote dust limit (#1900)
• 6dc836d Ignore channels without capacity (#1975)
• 97393b1 Fix race condition in 'stream updates to front' test (#1978)
• fd56504 Remove the GUI (#1981)
• 3295881 Json serializers refactoring (#1979)
• 73744ee Move path-finding examples to documentation (#1983)
• d0be2cf Log payment failure summary (#1966)
• c803da6 Store published txs in AuditDb (#1976)
• d6b46ae Update anchor outputs feerate tolerance (#1980)
• 0621ccf Fix ZmqWatcher block timeout (#1989)
• bb5e6df Fix remote upfront script codec (#1991)
• 75eafd0 Configure dust in flight threshold (#1985)