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

473 lines
21 KiB
Markdown
Raw Normal View History

# Release Notes
- [Release Notes](#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)
- [Tlv](#tlv)
- [Misc](#misc)
- [Logging](#logging)
- [RPC Updates](#rpc-updates)
- [lncli Updates](#lncli-updates)
- [Code Health](#code-health)
- [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-1)
- [Tooling and Documentation](#tooling-and-documentation)
- [Contributors (Alphabetical Order)](#contributors-alphabetical-order)
# Bug Fixes
2023-11-30 00:28:15 +01:00
* [Fix a bug](https://github.com/lightningnetwork/lnd/pull/8097) where
`sendcoins` command with `--sweepall` flag would not show the correct amount.
2023-08-24 18:39:38 +08:00
* [Fixed a potential case](https://github.com/lightningnetwork/lnd/pull/7824)
that when sweeping inputs with locktime, an unexpected lower fee rate is
applied.
* LND will now [enforce pong
responses](https://github.com/lightningnetwork/lnd/pull/7828) from its peers.
2023-10-13 16:53:25 +08:00
* [Fixed a possible unintended RBF
attempt](https://github.com/lightningnetwork/lnd/pull/8091) when sweeping new
inputs with retried ones.
* [Fixed](https://github.com/lightningnetwork/lnd/pull/7811) a case where `lnd`
might panic due to empty witness data found in a transaction. More details
can be found [here](https://github.com/bitcoin/bitcoin/issues/28730).
* [Fixed a case](https://github.com/lightningnetwork/lnd/pull/7503) where it's
possible a failed payment might be stuck in pending.
2023-11-13 12:34:21 +02:00
* [Ensure that a valid SCID](https://github.com/lightningnetwork/lnd/pull/8171)
is used when marking a zombie edge as live.
2023-07-01 23:28:45 +02:00
* [Remove sweep transactions of the
same exclusive group](https://github.com/lightningnetwork/lnd/pull/7800).
When using neutrino as a backend unconfirmed transactions have to be
removed from the wallet when a conflicting tx is confirmed. For other backends
these unconfirmed transactions are already removed. In addition, a new
`walletrpc` endpoint `RemoveTransaction` is introduced which let one easily
2023-07-01 23:28:45 +02:00
remove unconfirmed transaction manually.
2023-11-05 11:34:19 +01:00
* [Fixed](https://github.com/lightningnetwork/lnd/pull/8096) a case where `lnd`
might dip below its channel reserve when HTLCs are added concurrently. A
2023-11-05 11:34:19 +01:00
fee buffer (additional balance) is now always kept on the local side ONLY
if the channel was opened locally. This is in accordance with the BOLT 02
2023-11-05 11:34:19 +01:00
specification and protects against sharp fee changes because there is always
this buffer which can be used to increase the commitment fee, and it also
protects against the case where HTLCs are added asynchronously resulting in
2023-11-05 11:34:19 +01:00
stuck channels.
* [Fixed](https://github.com/lightningnetwork/lnd/pull/8377) a watchtower client
test flake that prevented new tasks from overflowing to disk.
2023-11-28 13:43:42 +02:00
* [Properly handle un-acked updates for exhausted watchtower
sessions](https://github.com/lightningnetwork/lnd/pull/8233).
2023-11-28 13:43:42 +02:00
* [Allow `shutdown`s while HTLCs are
in-flight](https://github.com/lightningnetwork/lnd/pull/8167).
2024-01-08 18:07:52 -08:00
This change fixes an issue where we would force-close channels when receiving
a `shutdown` message if there were currently HTLCs on the channel. After this
change, the shutdown procedure should be compliant with BOLT2 requirements.
2024-01-31 14:01:11 +02:00
* If HTLCs are in-flight at the same time that a `shutdown` is sent and then
a re-connect happens before the coop-close is completed we now [ensure that
we re-init the `shutdown`
exchange](https://github.com/lightningnetwork/lnd/pull/8464).
2024-01-31 14:01:11 +02:00
* The AMP struct in payment hops will [now be
populated](https://github.com/lightningnetwork/lnd/pull/7976) when the AMP TLV
is set.
2024-01-25 21:00:47 +00:00
* [Add Taproot witness types
to rpc](https://github.com/lightningnetwork/lnd/pull/8431).
2023-11-03 10:04:59 +01:00
* [Fixed](https://github.com/lightningnetwork/lnd/pull/7852) the payload size
calculation in our pathfinder because blinded hops introduced new tlv records.
2024-01-25 21:00:47 +00:00
* [Fixed](https://github.com/lightningnetwork/lnd/pull/8432) a timestamp
precision issue when querying payments and invoices using the start and end
date filters.
2024-02-29 15:24:21 -08:00
* [Fixed](https://github.com/lightningnetwork/lnd/pull/8496) an issue where
`locked_balance` is not updated in `WalletBalanceResponse` when outputs are
reserved for `OpenChannel` by using non-volatile leases instead of volatile
locks.
* [Fixed](https://github.com/lightningnetwork/lnd/pull/7805) a case where `lnd`
might propose a low fee rate for the channel (when initiator) due to the
mempool not having enough data yet or the channel might be drained locally
which with the default fee allocation in place will eventually lead to the
downsizing to the fee floor (1 sat/vByte) in the worst case.
2024-02-29 15:24:21 -08:00
2024-03-23 19:02:23 +08:00
* [Removed](https://github.com/lightningnetwork/lnd/pull/8577) some unreachable code
2024-04-01 20:05:28 +01:00
[Fixed](https://github.com/lightningnetwork/lnd/pull/8609) fixed a function
call where arguments were swapped.
# New Features
## Functional Enhancements
* Experimental support for [inbound routing
fees](https://github.com/lightningnetwork/lnd/pull/6703) is added. This allows
node operators to require senders to pay an inbound fee for forwards and
payments. It is recommended to only use negative fees (an inbound "discount")
initially to keep the channels open for senders that do not recognize inbound
fees. [Send support](https://github.com/lightningnetwork/lnd/pull/6934) is
implemented as well.
* A new config value,
[sweeper.maxfeerate](https://github.com/lightningnetwork/lnd/pull/7823), is
added so users can specify the max allowed fee rate when sweeping on-chain
funds. The default value is 1000 sat/vb. Setting this value below 100 sat/vb
is not allowed, as low fee rate can cause transactions not confirming in
time, which could result in fund loss.
Please note that the actual fee rate to be used is determined by the fee
estimator used(for instance `bitcoind`), and this value is a cap on the max
allowed value. So it's expected that this cap is rarely hit unless there's
mempool congestion.
2024-04-03 20:30:00 +02:00
* Support for [pathfinding](https://github.com/lightningnetwork/lnd/pull/7267)
2023-08-28 12:36:25 +02:00
and payment to blinded paths has been added via the `QueryRoutes` (and
`SendToRouteV2`) APIs. This functionality is surfaced in `lncli queryroutes`
2023-10-13 15:31:02 -04:00
where the required flags are tagged with `(blinded paths)`. Updates to mission
control to [handle pathfinding
errors](https://github.com/lightningnetwork/lnd/pull/8095) for blinded paths
are also included.
* A new config value,
2023-08-29 09:22:42 +02:00
[http-header-timeout](https://github.com/lightningnetwork/lnd/pull/7715), is
added so users can specify the amount of time the http server will wait for a
request to complete before closing the connection. The default value is 5
seconds.
* Update [watchtowers to be Taproot
ready](https://github.com/lightningnetwork/lnd/pull/7733).
2023-11-14 20:37:23 +08:00
* [`routerrpc.usestatusinitiated` is
introduced](https://github.com/lightningnetwork/lnd/pull/8177) to signal that
the new payment status `Payment_INITIATED` should be used for payment-related
RPCs. It's recommended to use it to provide granular controls over payments.
2023-11-16 15:07:29 -06:00
* A [helper command (`lncli encryptdebugpackage`) for collecting and encrypting
useful debug information](https://github.com/lightningnetwork/lnd/pull/8188)
was added. This allows a user to collect the most relevant information about
their node with a single command and securely encrypt it to the public key of
a developer or support person. That way the person supporting the user with
their issue has an eas way to get all the information they usually require
without the user needing to publicly give away a lot of privacy-sensitive
data.
* When publishing transactions in `lnd`, all the transactions will now go
through [mempool acceptance
check](https://github.com/lightningnetwork/lnd/pull/8345) before being
broadcast. This means when a transaction has failed the `testmempoolaccept`
check by `bitcoind` or `btcd`, the broadcast won't be attempted. This check
will be performed if the version of the chain backend supports it - for
`bitcoind` it's `v22.0.0` and above, for `btcd` it's `v0.24.1` and above.
Otherwise, the check will be
[skipped](https://github.com/lightningnetwork/lnd/pull/8505).
* The `coin-selection-strategy` config option [now also applies to channel
funding operations and the new `PsbtCoinSelect` option of the `FundPsbt`
RPC](https://github.com/lightningnetwork/lnd/pull/8378).
* [Environment variables can now be used in
`lnd.conf`](https://github.com/lightningnetwork/lnd/pull/8310)
for the `rpcuser` and `rpcpass` fields to better protect the secrets.
2024-03-01 17:33:21 -05:00
* When computing a minimum fee for transaction construction, `lnd` [now takes our
bitcoin peers' feefilter values into account](https://github.com/lightningnetwork/lnd/pull/8418).
* [Preparatory work](https://github.com/lightningnetwork/lnd/pull/8159) for
2024-02-14 09:21:56 -05:00
forwarding of blinded routes was added, along with [support](https://github.com/lightningnetwork/lnd/pull/8160)
for forwarding blinded payments. Forwarding of blinded payments is disabled
by default, and the feature is not yet advertised to the network.
## RPC Additions
* [Deprecated](https://github.com/lightningnetwork/lnd/pull/7175)
`StatusUnknown` from the payment's rpc response in its status and added a new
status, `StatusInitiated`, to explicitly report its current state. Before
running this new version, please make sure to upgrade your client application
to include this new status so it can understand the RPC response properly.
2023-10-30 22:53:45 +01:00
* Adds a new RPC endpoint `GetTransaction` to the `walletrpc` sub-server to
[fetch transaction details](https://github.com/lightningnetwork/lnd/pull/7654).
2023-11-16 15:07:29 -06:00
* [The new `GetDebugInfo` RPC method was added that returns the full runtime
configuration of the node as well as the complete log
file](https://github.com/lightningnetwork/lnd/pull/8188). The corresponding
`lncli getdebuginfo` command was also added.
2024-01-08 18:07:52 -08:00
* Add a [new flag](https://github.com/lightningnetwork/lnd/pull/8167) to the
`CloseChannel` RPC method that instructs the client to not wait for the
closing transaction to be negotiated. This should be used if you don't care
about the TXID and don't want the calling code to block while the channel
2024-01-08 18:07:52 -08:00
drains the active HTLCs.
2023-11-30 12:17:08 +02:00
* [New watchtower client DeactivateTower and
TerminateSession](https://github.com/lightningnetwork/lnd/pull/8239) commands
have been added. The DeactivateTower command can be used to mark a tower as
inactive so that its sessions are not loaded on startup and so that the tower
is not considered for session negotiation. TerminateSession can be used to
mark a specific session as terminal so that that specific is never used again.
* [The `FundPsbt` RPC method now has a third option for specifying a
template](https://github.com/lightningnetwork/lnd/pull/8378) to fund. This
new option will instruct the wallet to perform coin selection even if some
inputs are already specified in the template (which wasn't the case with
the previous options). Also, users have the option to specify whether a new
change output should be added or an existing output should be used for the
change. And the fee estimation is correct even if no change output is
required.
## lncli Additions
* Deprecate `bumpclosefee` for `bumpforceclosefee` to accommodate for the fact
2024-01-07 00:10:29 +01:00
that only force closing transactions can be bumped to avoid confusion.
Moreover allow to specify a max fee rate range when coop closing a channel.
[Deprecate bumpclosefee for bumpforceclosefee and add `max_fee_rate` option
to `closechannel` cmd](https://github.com/lightningnetwork/lnd/pull/8350).
2024-03-06 17:37:25 +01:00
* The [`closeallchannels` command now asks for confirmation before closing
all channels](https://github.com/lightningnetwork/lnd/pull/8526).
2024-03-09 23:52:19 +02:00
* [Man pages](https://github.com/lightningnetwork/lnd/pull/8525) Generate man
pages automatically using `lncli generatemanpage` command for both `lncli`
and `lnd` commands when running `make install` in the Makefile.
# Improvements
## Functional Updates
### Tlv
* [Bool was added](https://github.com/lightningnetwork/lnd/pull/8057) to the
primitive type of the tlv package.
2023-11-08 09:48:36 +01:00
## Misc
2023-12-12 09:47:24 -05:00
* [Added](https://github.com/lightningnetwork/lnd/pull/8142) full validation
for blinded path payloads to allow fuzzing before LND fully supports
blinded payment relay.
* Allow `healthcheck` package users to provide [custom
callbacks](https://github.com/lightningnetwork/lnd/pull/8504) which will
execute whenever a healthcheck succeeds/fails.
2024-03-15 08:17:40 +08:00
* `PublishTransaction` now [returns the error
types](https://github.com/lightningnetwork/lnd/pull/8554) defined in
`btcd/rpcclient`.
* [checkOutboundPeers](https://github.com/lightningnetwork/lnd/pull/8576) is
added to `chainHealthCheck` to make sure chain backend `bitcoind` and `btcd`
maintain a healthy connection to the network by checking the number of
outbound peers if they are below 6.
2023-11-08 09:48:36 +01:00
### Logging
* [Add the htlc amount](https://github.com/lightningnetwork/lnd/pull/8156) to
contract court logs in case of timed-out HTLCs in order to easily spot dust
2023-11-08 09:48:36 +01:00
outputs.
* [Add warning logs](https://github.com/lightningnetwork/lnd/pull/8446) during
startup when deprecated config options are used.
## RPC Updates
* [Deprecated](https://github.com/lightningnetwork/lnd/pull/7175)
`StatusUnknown` from the payment's rpc response in its status and replaced it
with `StatusInitiated` to explicitly report its current state.
2023-10-20 22:43:19 -05:00
* [Add an option to sign/verify a tagged
hash](https://github.com/lightningnetwork/lnd/pull/8106) to the
`signer.SignMessage`/`signer.VerifyMessage` RPCs.
* `sendtoroute` will return an error when it's called using the flag
`--skip_temp_err` on a payment that's not an MPP. This is needed as a temp
error is defined as a routing error found in one of an MPP's HTLC attempts.
If, however, there's only one HTLC attempt, when it's failed, this payment is
considered failed, thus there's no such thing as temp error for a non-MPP.
2023-10-31 17:50:05 +01:00
2023-11-30 00:28:15 +01:00
* Support for
[MinConf](https://github.com/lightningnetwork/lnd/pull/8097)(minimum number
of confirmations) has been added to the `WalletBalance` RPC call.
2023-10-31 17:50:05 +01:00
* [EstimateRouteFee](https://github.com/lightningnetwork/lnd/pull/8136) extends
the graph based estimation by a payment probe approach which can lead to more
accurate estimates. The new estimation method manually incorporates fees of
destinations that lie hidden behind lightning service providers.
2024-01-25 12:35:04 +01:00
* `PendingChannels` now optionally returns the
[raw hex of the closing tx](https://github.com/lightningnetwork/lnd/pull/8426)
in `waiting_close_channels`.
* [Allow callers of `ListSweeps` to specify the start
height](https://github.com/lightningnetwork/lnd/pull/7372).
2023-12-03 22:37:07 +01:00
2024-03-26 19:12:34 +02:00
* [Coin Selection Strategy](https://github.com/lightningnetwork/lnd/pull/8515)
add coin selection strategy option to the following on-chain RPC calls
`EstimateFee`, `SendMany`, `SendCoins`, `BatchOpenChannel`, `SendOutputs`, and `FundPsbt`.
## lncli Updates
2023-11-20 14:51:59 -07:00
* [Documented all available `lncli`
commands](https://github.com/lightningnetwork/lnd/pull/8181).
This change makes all existing `lncli` commands have the appropriate doc tag
in the RPC definition to ensure that the autogenerated API documentation
properly specifies how to use the `lncli` command.
2023-11-20 14:51:59 -07:00
2023-12-08 00:56:31 +01:00
* [Enable multiple outgoing channel ids for the payment
command](https://github.com/lightningnetwork/lnd/pull/8261). This change adds
the ability to specify multiple outgoing channel ids for the `sendpayment`
command.
* [Use the default LND value in the `buildroute` RPC command for the
`final cltv delta`](https://github.com/lightningnetwork/lnd/pull/8387).
2024-01-16 11:49:29 +01:00
2024-01-25 12:35:04 +01:00
* `pendingchannels` now optionally returns the
[raw hex of the closing tx](https://github.com/lightningnetwork/lnd/pull/8426)
in `waiting_close_channels`.
2023-10-31 17:50:05 +01:00
* The [`estimateroutefee`](https://github.com/lightningnetwork/lnd/pull/8136)
2023-10-31 17:50:05 +01:00
subcommand now gives access to graph based and payment probe fee estimation.
2024-01-25 12:35:04 +01:00
## Code Health
2023-08-03 19:13:54 +02:00
* [Remove Litecoin code](https://github.com/lightningnetwork/lnd/pull/7867).
With this change, the `Bitcoin.Active` config option is now deprecated since
Bitcoin is now the only supported chain. The `chain` field in the
`lnrpc.Chain` message has also been deprecated for the same reason.
2023-08-03 19:13:54 +02:00
* The payment lifecycle code has been refactored to improve its maintainability.
In particular, the complexity involved in the lifecycle loop has been
decoupled into logical steps, with each step having its own responsibility,
making it easier to reason about the payment flow.
2023-08-11 15:09:17 +02:00
* [Add a watchtower tower client
multiplexer](https://github.com/lightningnetwork/lnd/pull/7702) to manage
tower clients of different types.
2023-08-29 09:22:42 +02:00
2023-05-31 10:20:29 +02:00
* [Introduce CommitmentType and JusticeKit
interface](https://github.com/lightningnetwork/lnd/pull/7736) to simplify the
code.
2024-02-26 11:41:06 +00:00
* [Correct `fmt.Errorf` error wrapping
instances](https://github.com/lightningnetwork/lnd/pull/8503).
2024-02-26 11:41:06 +00:00
* Bump sqlite version to [fix a data
race](https://github.com/lightningnetwork/lnd/pull/8567).
## Breaking Changes
## Performance Improvements
2023-11-23 16:10:00 +02:00
* Watchtower client DB migration to massively [improve the start-up
performance](https://github.com/lightningnetwork/lnd/pull/8222) of a client.
# Technical and Architectural Updates
## BOLT Spec Updates
2023-10-12 16:56:50 -06:00
* [Add Dynamic Commitment Wire
Types](https://github.com/lightningnetwork/lnd/pull/8026).
2023-10-12 16:56:50 -06:00
This change begins the development of Dynamic Commitments allowing for the
negotiation of new channel parameters and the upgrading of channel types.
2023-11-08 13:32:10 +02:00
* Start using the [timestamps query
option](https://github.com/lightningnetwork/lnd/pull/8030) in the
`query_channel_range` message. This will allow us to know if our peer has a
newer update for a channel that we have marked as a zombie. This addition can
be switched off using the new `protocol.no-timestamp-query-option` config
option.
2023-10-12 16:56:50 -06:00
* [Update `min_final_cltv_expiry_delta`](https://github.com/lightningnetwork/lnd/pull/8308).
This only affects external invoices which do not supply the
`min_final_cltv_expiry` parameter. LND has NOT allowed the creation of
invoices with a lower `min_final_cltv_expiry_delta` value than 18 blocks since
LND v0.11.0.
2023-12-29 19:49:15 +01:00
* [Make Legacy Features
Compulsory](https://github.com/lightningnetwork/lnd/pull/8275).
This change implements changes codified in
[bolts#1092](https://github.com/lightning/bolts/pull/1092)
and makes TLV Onions, Static Remote Keys, Gossip Queries, compulsory features
for LND's peers. Data Loss Protection has been compulsory for years.
2023-12-29 19:49:15 +01:00
2024-04-04 12:28:37 -07:00
* [Don't Require Gossip Queries](https://github.com/lightningnetwork/lnd/pull/8615)
This change undoes a portion of what was introduced in #8275 due to a subsequent
[spec change](https://github.com/lightning/bolts/pull/1092/commits/e0ee59f3c92b7c98be8dfc47b7db358b45baf9de)
that meant we shouldn't require it.
## Testing
2023-10-27 14:54:29 -05:00
* Added fuzz tests for [onion
errors](https://github.com/lightningnetwork/lnd/pull/7669).
2024-03-15 12:54:39 +01:00
* Fixed stability and [compatibility of unit tests with `bitcoind
v26.0`](https://github.com/lightningnetwork/lnd/pull/8273).
## Database
* [Add context to InvoiceDB
methods](https://github.com/lightningnetwork/lnd/pull/8066). This change adds
a context parameter to all `InvoiceDB` methods which is a pre-requisite for
the SQL implementation.
2023-10-11 14:42:15 +02:00
* [Refactor InvoiceDB](https://github.com/lightningnetwork/lnd/pull/8081) to
eliminate the use of `ScanInvoices`.
2024-01-24 20:22:16 +01:00
* [Update](https://github.com/lightningnetwork/lnd/pull/8419) the embedded
Postgres version and raise max connections.
2023-10-26 14:42:20 +02:00
* [Refactor UpdateInvoice](https://github.com/lightningnetwork/lnd/pull/8100) to
make it simpler to adjust code to also support SQL InvoiceDB implementation.
* [InvoiceDB implementation](https://github.com/lightningnetwork/lnd/pull/8052)
for SQL backends enabling new users to optionally use an experimental native
SQL invoices database.
2024-03-19 15:22:02 +01:00
* [Ensure that LND won't
start](https://github.com/lightningnetwork/lnd/pull/8568) if native SQL is
enabled but the channeldb already has any KV invoices stored.
* [Fix a bug](https://github.com/lightningnetwork/lnd/pull/8595) when retrying
SQL InvoiceDB transactions due to database errors.
2024-04-02 10:38:09 +02:00
* [Turn `sqldb` into a separate Go
module](https://github.com/lightningnetwork/lnd/pull/8603).
## Code Health
2023-10-23 15:19:06 +02:00
* [Remove database pointers](https://github.com/lightningnetwork/lnd/pull/8117)
from `channeldb` schema structs.
2023-10-23 15:19:06 +02:00
## Tooling and Documentation
# Contributors (Alphabetical Order)
2024-02-29 15:24:21 -08:00
* Alex Akselrod
* Amin Bashiri
* Andras Banki-Horvath
* BitcoinerCoderBob
2023-08-28 12:36:25 +02:00
* Carla Kirk-Cohen
2023-08-03 19:13:54 +02:00
* Elle Mouton
2023-10-30 22:53:45 +01:00
* ErikEk
2024-01-25 12:35:04 +01:00
* Jesse de Wit
* Joost Jager
* Keagan McClelland
2023-11-30 00:28:15 +01:00
* Marcos Fernandez Perez
2023-10-27 14:54:29 -05:00
* Matt Morehouse
2024-03-09 23:52:19 +02:00
* Mohamed Awnallah
2023-10-31 17:50:05 +01:00
* Ononiwu Maureen Chiamaka
2023-11-08 09:48:36 +01:00
* Slyghtning
* Tee8z
2023-10-20 22:43:19 -05:00
* Turtle
2024-03-23 19:02:23 +08:00
* Hao Wang
* w3irdrobot
* Yong Yu
2023-11-05 11:34:19 +01:00
* Ziggie