lnd/docs/release-notes/release-notes-0.17.0.md

379 lines
15 KiB
Markdown
Raw Normal View History

2023-02-08 07:36:58 -08:00
# Release Notes
- [Bug Fixes](#bug-fixes)
- [New Features](#new-features)
- [Functional Enhancements](#functional-enhancements)
- [RPC Additions](#rpc-additions)
- [lncli Additions](#lncli-additions)
- [Improvements](#improvements)
- [Functional Updates](#functional-updates)
- [RPC Updates](#rpc-updates)
- [lncli Updates](#lncli-updates)
- [Breaking Changes](#breaking-changes)
- [Performance Improvements](#performance-improvements)
- [Technical and Architectural Updates](#technical-and-architectural-updates)
- [BOLT Spec Updates](#bolt-spec-updates)
- [Testing](#testing)
- [Database](#database)
- [Code Health](#code-health)
- [Tooling and Documentation](#tooling-and-documentation)
# Bug Fixes
* Make sure payment stream returns all the events by [subscribing it before
sending](https://github.com/lightningnetwork/lnd/pull/7722).
* Fixed a memory leak found in mempool management handled by
[`btcwallet`](https://github.com/lightningnetwork/lnd/pull/7767).
* Make sure lnd starts up as normal in case a transaction does not meet min
mempool fee requirements. [Handle min mempool fee backend error when a
transaction fails to be broadcasted by the
bitcoind backend](https://github.com/lightningnetwork/lnd/pull/7746).
* [Updated bbolt to v1.3.7](https://github.com/lightningnetwork/lnd/pull/7796)
in order to address mmap issues affecting certain older iPhone devices.
* [Stop rejecting payments that overpay or over-timelock the final
hop](https://github.com/lightningnetwork/lnd/pull/7768).
* [Fix let's encrypt autocert
generation](https://github.com/lightningnetwork/lnd/pull/7739).
* Fix an issue where [IPv6 couldn't be dialed when using
Tor](https://github.com/lightningnetwork/lnd/pull/7783), even when
`tor.skip-proxy-for-clearnet-targets=true` was set.
* Fix a [concurrency issue related to rapid peer teardown and
creation](https://github.com/lightningnetwork/lnd/pull/7856) that can arise
under rare scenarios.
2023-02-08 07:36:58 -08:00
* A race condition found between `channel_ready` and link updates is [now
fixed](https://github.com/lightningnetwork/lnd/pull/7518).
* [Remove rebroadcasting of
the last sweep-tx](https://github.com/lightningnetwork/lnd/pull/7879). Now at
startup of the sweeper we do not rebroadcast the last sweep-tx anymore.
The "sweeper-last-tx" top level bucket in the channel.db is removed
(new migration version 31 of the db). The main reason is that neutrino
backends do not fail broadcasting invalid transactions because BIP157
supporting bitcoin core nodes do not reply with the reject msg anymore. So we
have to make sure to not broadcast outdated transactions which can lead to
locked up wallet funds indefinitely in the worst case.
multi: ensure link is always torn down due to db failures, add exponential back off for sql-kvdb failures (#7927) * lnwallet: fix log output msg The log message is off by one. * htlcswitch: fail channel when revoking it fails. When the revocation of a channel state fails after receiving a new CommitmentSigned msg we have to fail the channel otherwise we continue with an unclean state. * docs: update release-docs * htlcswitch: tear down connection if revocation processing fails If we couldn't revoke due to a DB error, then we want to also tear down the connection, as we don't want the other party to continue to send updates. That may lead to de-sync'd state an eventual force close. Otherwise, the database might be able to recover come the next reconnection attempt. * kvdb: use sql.LevelSerializable for all backends In this commit, we modify the default isolation level to be `sql.LevelSerializable. This is the strictness isolation type for postgres. For sqlite, there's only ever a single writer, so this doesn't apply directly. * kvdb/sqlbase: add randomized exponential backoff for serialization failures In this commit, we add randomized exponential backoff for serialization failures. For postgres, we''ll his this any time a transaction set fails to be linearized. For sqlite, we'll his this if we have many writers trying to grab the write lock at time same time, manifesting as a `SQLITE_BUSY` error code. As is, we'll retry up to 10 times, waiting a minimum of 50 miliseconds between each attempt, up to 5 seconds without any delay at all. For sqlite, this is also bounded by the busy timeout set, which applies on top of this retry logic (block for busy timeout seconds, then apply this back off logic). * docs/release-notes: add entry for sqlite/postgres tx retry --------- Co-authored-by: ziggie <ziggie1984@protonmail.com>
2023-08-30 16:48:00 -07:00
* [Remove nil value](https://github.com/lightningnetwork/lnd/pull/7922) from
variadic parameter list.
multi: ensure link is always torn down due to db failures, add exponential back off for sql-kvdb failures (#7927) * lnwallet: fix log output msg The log message is off by one. * htlcswitch: fail channel when revoking it fails. When the revocation of a channel state fails after receiving a new CommitmentSigned msg we have to fail the channel otherwise we continue with an unclean state. * docs: update release-docs * htlcswitch: tear down connection if revocation processing fails If we couldn't revoke due to a DB error, then we want to also tear down the connection, as we don't want the other party to continue to send updates. That may lead to de-sync'd state an eventual force close. Otherwise, the database might be able to recover come the next reconnection attempt. * kvdb: use sql.LevelSerializable for all backends In this commit, we modify the default isolation level to be `sql.LevelSerializable. This is the strictness isolation type for postgres. For sqlite, there's only ever a single writer, so this doesn't apply directly. * kvdb/sqlbase: add randomized exponential backoff for serialization failures In this commit, we add randomized exponential backoff for serialization failures. For postgres, we''ll his this any time a transaction set fails to be linearized. For sqlite, we'll his this if we have many writers trying to grab the write lock at time same time, manifesting as a `SQLITE_BUSY` error code. As is, we'll retry up to 10 times, waiting a minimum of 50 miliseconds between each attempt, up to 5 seconds without any delay at all. For sqlite, this is also bounded by the busy timeout set, which applies on top of this retry logic (block for busy timeout seconds, then apply this back off logic). * docs/release-notes: add entry for sqlite/postgres tx retry --------- Co-authored-by: ziggie <ziggie1984@protonmail.com>
2023-08-30 16:48:00 -07:00
* Make sure to [fail a channel if revoking the old channel state
fails](https://github.com/lightningnetwork/lnd/pull/7876).
* Failed `sqlite` or `postgres` transactions due to a serialization error will
now be [automatically
retried](https://github.com/lightningnetwork/lnd/pull/7927) with an
exponential back off.
2023-09-13 14:41:24 +02:00
* In the watchtower client, we [now explicitly
handle](https://github.com/lightningnetwork/lnd/pull/7981) the scenario where
a channel is closed while we still have an in-memory update for it.
* `lnd` [now properly handles a case where an erroneous force close attempt
would impeded start up](https://github.com/lightningnetwork/lnd/pull/7985).
* A bug that could cause the invoice related sub-system to lock up (potentially
the entire daemon) related to [incoming HTLCs going on chain related to a
hodl invoice has been
fixed](https://github.com/lightningnetwork/lnd/pull/8024).
# New Features
## Functional Enhancements
* `lnd` can now optionally generate [blocking and mutex
profiles](https://github.com/lightningnetwork/lnd/pull/7983). These profiles
are useful to attempt to debug high mutex contention, or deadlock scenarios.
### Protocol Features
* This release marks the first release that includes the new [musig2-based
taproot channel type](https://github.com/lightningnetwork/lnd/pull/7904). As
new protocol feature hasn't yet been finalized, users must enable taproot
channels with a new flag: `--protocol.simple-taproot-chans`. Once enabled,
user MUST use the explicit channel type to request the taproot channel type
(pending support by the remote peer). For `lncli openchannel`,
`--channel_type=taproot` should be used.
## RPC Additions
None
2023-02-08 07:36:58 -08:00
## lncli Additions
None
# Improvements
## Functional Updates
### Watchtowers
* Let the task pipeline [only carry
wtdb.BackupIDs](https://github.com/lightningnetwork/lnd/pull/7623) instead of
the entire retribution struct. This reduces the amount of data that needs to
be held in memory.
2023-04-21 10:40:00 +02:00
2023-03-22 14:30:50 +02:00
* [Replace in-mem task pipeline with a disk-overflow
queue](https://github.com/lightningnetwork/lnd/pull/7380).
2023-03-23 10:16:00 +02:00
* [Replay pending and un-acked updates onto the main task pipeline if a tower
is being removed](https://github.com/lightningnetwork/lnd/pull/6895).
* [Add defaults](https://github.com/lightningnetwork/lnd/pull/7771) to the
wtclient and watchtower config structs and use these to populate the defaults
of the main LND config struct so that the defaults appear in the `lnd --help`
command output.
* The deprecated `wtclient.private-tower-uris` option has also been
[removed](https://github.com/lightningnetwork/lnd/pull/7771). This field was
deprecated in v0.8.0-beta.
2023-06-21 11:49:59 +02:00
### Neutrino
* The [Neutrino version
is updated](https://github.com/lightningnetwork/lnd/pull/7788) so that LND can
take advantage of the latest filter fetching performance improvements.
2023-04-23 20:04:57 +02:00
### Misc
* [Ensure that both the byte and string form of a TXID is populated in the
lnrpc.Outpoint message](https://github.com/lightningnetwork/lnd/pull/7624).
* [HTLC serialization
updated](https://github.com/lightningnetwork/lnd/pull/7710) to allow storing
extra data transmitted in TLVs.
* [MaxLocalCSVDelay now has a default value of 2016. It is still possible to
override this value with the config option --maxlocaldelay for those who rely
on the old value of 10000](https://github.com/lightningnetwork/lnd/pull/7780).
* [Generate default macaroons
independently](https://github.com/lightningnetwork/lnd/pull/7592) on wallet
unlock or create.
* [Restore support](https://github.com/lightningnetwork/lnd/pull/7678) for
`PKCS8`-encoded cert private keys.
* [Cleanup](https://github.com/lightningnetwork/lnd/pull/7770) of defaults
mentioned in
[sample-lnd.conf](https://github.com/lightningnetwork/lnd/blob/master/sample-lnd.conf).
It is possible to distinguish between defaults and examples now.
A check script has been developed and integrated into the building process to
compare the default values between lnd and sample-lnd.conf.
* [Cancel rebroadcasting of a transaction when abandoning
a channel](https://github.com/lightningnetwork/lnd/pull/7819).
* [Fixed a validation bug](https://github.com/lightningnetwork/lnd/pull/7177) in
`channel_type` negotiation.
* [The `lightning-onion` repo version was
updated](https://github.com/lightningnetwork/lnd/pull/7877) in preparation for
work to be done on route blinding in LND.
## RPC Updates
2023-04-23 20:04:57 +02:00
* [SendOutputs](https://github.com/lightningnetwork/lnd/pull/7631) now adheres
to the anchor channel reserve requirement.
2023-04-27 19:47:18 -04:00
* Enforce provided [fee rate is no less than the relay or minimum mempool
fee](https://github.com/lightningnetwork/lnd/pull/7645) when calling
`OpenChannel`, `CloseChannel`, `SendCoins`, and `SendMany`.
* The
[UpdateNodeAnnouncement](https://github.com/lightningnetwork/lnd/pull/7568)
API can no longer be used to set/unset protocol features that are defined by
LND.
2023-04-05 10:34:25 +02:00
* The [`neutrinorpc` `GetBlockHash` has been
deprecated](https://github.com/lightningnetwork/lnd/pull/7712). Endpoint
has been moved to the `chainrpc` sub-server.
2023-05-20 13:05:56 +07:00
* Custom node announcement feature bits can also be specified in config using
the `dev` build tag and `--protocol.custom-nodeann`, `--protocol.custom-init`
2023-04-05 10:34:25 +02:00
and `--protocol.custom-invoice` flags to set feature bits for various feature
"sets", as defined in
[BOLT 9](https://github.com/lightning/bolts/blob/master/09-features.md).
2023-04-05 10:34:25 +02:00
2023-05-04 14:10:40 -04:00
* `OpenChannel` now accepts an [optional `memo`
argument](https://github.com/lightningnetwork/lnd/pull/7668) for specifying
a helpful note-to-self containing arbitrary useful information about the
channel.
* `PendingOpenChannel` now has the field
[`funding_expiry_blocks`](https://github.com/lightningnetwork/lnd/pull/7480)
that indicates the number of blocks until the funding transaction is
considered expired.
2023-05-25 14:18:18 +02:00
* [gRPC keepalive parameters can now be set in the
configuration](https://github.com/lightningnetwork/lnd/pull/7730). The `lnd`
configuration settings `grpc.server-ping-time` and `grpc.server-ping-timeout`
configure how often `lnd` pings its clients and how long a pong response is
allowed to take. The default values for there settings are improved over the
gRPC protocol internal default values, so most users won't need to change
those. The `grpc.client-ping-min-wait` setting defines how often a client is
allowed to ping `lnd` to check for connection healthiness. The `lnd` default
value of 5 seconds is much lower than the previously used protocol internal
value, which means clients can now check connection health more often. For
this to be activated on the client side, gRPC clients are encouraged to set
the keepalive setting on their end as well (using the `grpc.keepalive_time_ms`
option in JavaScript or Python, or the equivalent setting in the gRPC library
they are using, might be an environment variable or a different syntax
depending on the programming language used) when creating long open streams
over a network topology that might silently fail connections. A value of
`grpc.keepalive_time_ms=5100` is recommended on the client side (adding 100ms
to account for slightly different clock speeds).
* [Fixed a bug where we didn't check for correct networks when submitting
onchain transactions](https://github.com/lightningnetwork/lnd/pull/6448).
2023-04-20 14:32:11 +02:00
* [Fix non-deterministic behaviour in RPC calls for
custom accounts](https://github.com/lightningnetwork/lnd/pull/7565).
In theory, it should be only one custom account with a given name. However,
due to a lack of check, users could have created custom accounts with various
key scopes. The non-deterministic behaviours linked to this case are fixed,
and users can no longer create two custom accounts with the same name.
2023-06-10 21:30:08 +02:00
* `OpenChannel` adds a new `utxo` flag that allows the specification of multiple
UTXOs [as a basis for funding a channel
opening](https://github.com/lightningnetwork/lnd/pull/7516).
2023-06-10 21:30:08 +02:00
2023-07-22 18:28:28 +02:00
* The [BatchOpenChannel](https://github.com/lightningnetwork/lnd/pull/7820)
message now supports all fields that are present in the `OpenChannel` message,
except for the `funding_shim` and `fundmax` fields.
2023-07-26 17:45:47 +02:00
* The [WalletBalance](https://github.com/lightningnetwork/lnd/pull/7857) RPC
(lncli walletbalance) now supports showing the balance for a specific account.
* The [websockets proxy now uses a larger default max
message](https://github.com/lightningnetwork/lnd/pull/7991) size to support
proxying larger messages.
## lncli Updates
* Added ability to use [environment variables to override `lncli` global
flags](https://github.com/lightningnetwork/lnd/pull/7693). Flags will have
preference over environment variables.
2023-07-26 17:45:47 +02:00
* The `lncli sendcoins` command now asks for manual confirmation when invoked
on the command line. This can be skipped by adding the `--force` (or `-f`)
flag, similar to how `lncli payinvoice` works. To not break any existing
scripts the confirmation is also skipped if `stdout` is not a terminal/tty
(e.g. when capturing the output in a shell script variable or piping the
output to another program).
2023-04-05 10:34:25 +02:00
* Add [`--unused`](https://github.com/lightningnetwork/lnd/pull/6387) to
`lncli newaddr` command.
* [The `MuSig2SessionRequest` proto message now contains a field to allow a
caller to specify a custom signing
nonce](https://github.com/lightningnetwork/lnd/pull/7994). This can be useful
for protocol where an external nonces must be pre-generated before the full
session can be completed.
2023-05-08 14:54:16 +02:00
## Code Health
* Updated [our fork for serializing protobuf as JSON to be based on the
latest version of `google.golang.org/protobuf` instead of the deprecated
`github.com/golang/protobuf/jsonpb`
module](https://github.com/lightningnetwork/lnd/pull/7659).
## Neutrino
* The [Neutrino version
is updated](https://github.com/lightningnetwork/lnd/pull/7788) so that LND can
take advantage of the latest filter fetching performance improvements.
## Breaking Changes
None
## Performance Improvements
None
# Technical and Architectural Updates
## BOLT Spec Updates
None
2023-05-11 16:58:39 -05:00
## Testing
2023-05-19 15:51:19 -05:00
* [Started](https://github.com/lightningnetwork/lnd/pull/7494) running fuzz
tests in CI.
2023-05-23 08:34:36 -05:00
* [Derandomized](https://github.com/lightningnetwork/lnd/pull/7618) the BOLT
8 fuzz tests.
2023-05-24 09:18:02 -05:00
* [Improved](https://github.com/lightningnetwork/lnd/pull/7723) invoice fuzz
tests.
2023-05-11 16:58:39 -05:00
* [Added fuzz tests](https://github.com/lightningnetwork/lnd/pull/7649) for
signature parsing and conversion.
2023-06-01 08:49:42 -05:00
* [Added a fuzz test](https://github.com/lightningnetwork/lnd/pull/7687) for
watchtower address iterators.
2023-05-22 11:00:24 -05:00
* [Simplify fuzz tests](https://github.com/lightningnetwork/lnd/pull/7709)
using the `require` package.
* [Removed](https://github.com/lightningnetwork/lnd/pull/7854) need for an
active internet connection for the network connection itest.
* [Fix Benchmark Test (BenchmarkReadMessage/Channel_Ready) in the lnwire
package](https://github.com/lightningnetwork/lnd/pull/7356).
* [Fix unit test flake (TestLightningWallet) in the neutrino package via
version bump of
btcsuite/btcwallet](https://github.com/lightningnetwork/lnd/pull/7049).
## Database
* Split channeldb [`UpdateInvoice`
implementation](https://github.com/lightningnetwork/lnd/pull/7377) logic in
different update types.
2023-03-16 21:59:15 +08:00
* Add [invoice SQL schema and
queries](https://github.com/lightningnetwork/lnd/pull/7354).
2023-08-09 22:33:30 +02:00
* Add new [sqldb
package](https://github.com/lightningnetwork/lnd/pull/7343).
## Code Health
* Updated [our fork for serializing protobuf as JSON to be based on the
latest version of `google.golang.org/protobuf` instead of the deprecated
`github.com/golang/protobuf/jsonpb`
module](https://github.com/lightningnetwork/lnd/pull/7659).
## Tooling and Documentation
* Add support for [custom `RPCHOST` and
`RPCCRTPATH`](https://github.com/lightningnetwork/lnd/pull/7429) to the
`lnd` Docker image main script (`/start-lnd.sh`).
2023-06-12 09:40:39 +02:00
* Fix bug in `scripts/verify-install.sh` that caused the [release binary
signature verification script to not properly import signing
keys](https://github.com/lightningnetwork/lnd/pull/7758) when being run with
new version of `gpg` (which is the case in the latest Docker image).
2023-02-08 07:36:58 -08:00
# Contributors (Alphabetical Order)
* Aljaz Ceru
* BhhagBoseDK
2023-04-05 10:34:25 +02:00
* Carla Kirk-Cohen
* Daniel McNally
2023-04-21 10:40:00 +02:00
* Elle Mouton
2023-05-08 10:28:34 +02:00
* Erik Arvstedt
2023-05-20 13:05:56 +07:00
* ErikEk
2023-07-19 18:20:21 +02:00
* feelancer21
* gabbyprecious
* Guillermo Caracuel
* Hampus Sjöberg
2023-04-23 20:04:57 +02:00
* hieblmi
2023-02-08 07:36:58 -08:00
* Jordi Montes
2023-06-23 12:29:12 -06:00
* Keagan McClelland
2023-06-14 10:45:55 +02:00
* Konstantin Nick
* Lele Calo
2023-05-11 16:58:39 -05:00
* Matt Morehouse
* Maxwell Sayles
2023-05-11 18:22:59 -04:00
* Michael Street
* MG-ng
* Olaoluwa Osuntokun
2023-05-08 14:54:16 +02:00
* Oliver Gugger
2023-04-20 14:32:11 +02:00
* Pierre Beugnet
* Satarupa Deb
2023-04-27 19:47:18 -04:00
* Shaurya Arora
* Suheb
* Torkel Rogstad
2023-06-15 01:28:15 +08:00
* Yong Yu
2023-05-09 16:53:30 +02:00
* ziggie1984
* zx9r