Skip to content

Commit c07ec04

Browse files
authored
docs/release-notes: update 0.17 release notes to new format (#7907)
Added a table of contents at the top and various sections to navigate to, to make it easy to parse and read the release notes.
1 parent 251bcad commit c07ec04

File tree

1 file changed

+149
-118
lines changed

1 file changed

+149
-118
lines changed

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

+149-118
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,67 @@
11
# Release Notes
2+
- [Bug Fixes](#bug-fixes)
3+
- [New Features](#new-features)
4+
- [Functional Enhancements](#functional-enhancements)
5+
- [RPC Additions](#rpc-additions)
6+
- [lncli Additions](#lncli-additions)
7+
- [Improvements](#improvements)
8+
- [Functional Updates](#functional-updates)
9+
- [RPC Updates](#rpc-updates)
10+
- [lncli Updates](#lncli-updates)
11+
- [Breaking Changes](#breaking-changes)
12+
- [Performance Improvements](#performance-improvements)
13+
- [Technical and Architectural Updates](#technical-and-architectural-updates)
14+
- [BOLT Spec Updates](#bolt-spec-updates)
15+
- [Testing](#testing)
16+
- [Database](#database)
17+
- [Code Health](#code-health)
18+
- [Tooling and Documentation](#tooling-and-documentation)
19+
20+
# Bug Fixes
21+
* Make sure payment stream returns all the events by [subscribing it before
22+
sending](https://github.com/lightningnetwork/lnd/pull/7722).
23+
24+
* Fixed a memory leak found in mempool management handled by
25+
[`btcwallet`](https://github.com/lightningnetwork/lnd/pull/7767).
26+
27+
* Make sure lnd starts up as normal in case a transaction does not meet min
28+
mempool fee requirements. [Handle min mempool fee backend error when a
29+
transaction fails to be broadcasted by the
30+
bitcoind backend](https://github.com/lightningnetwork/lnd/pull/7746).
31+
32+
* [Updated bbolt to v1.3.7](https://github.com/lightningnetwork/lnd/pull/7796)
33+
in order to address mmap issues affecting certain older iPhone devices.
34+
35+
* [Stop rejecting payments that overpay or over-timelock the final
36+
hop](https://github.com/lightningnetwork/lnd/pull/7768).
37+
38+
* [Fix let's encrypt autocert
39+
generation](https://github.com/lightningnetwork/lnd/pull/7739).
40+
41+
* Fix an issue where [IPv6 couldn't be dialed when using
42+
Tor](https://github.com/lightningnetwork/lnd/pull/7783), even when
43+
`tor.skip-proxy-for-clearnet-targets=true` was set.
44+
45+
* Fix a [concurrency issue related to rapid peer teardown and
46+
creation](https://github.com/lightningnetwork/lnd/pull/7856) that can arise
47+
under rare scenarios.
248

3-
## Protocol Features
49+
* A race condition found between `channel_ready` and link updates is [now
50+
fixed](https://github.com/lightningnetwork/lnd/pull/7518).
51+
52+
* [Remove rebroadcasting of
53+
the last sweep-tx](https://github.com/lightningnetwork/lnd/pull/7879). Now at
54+
startup of the sweeper we do not rebroadcast the last sweep-tx anymore.
55+
The "sweeper-last-tx" top level bucket in the channel.db is removed
56+
(new migration version 31 of the db). The main reason is that neutrino
57+
backends do not fail broadcasting invalid transactions because BIP157
58+
supporting bitcoin core nodes do not reply with the reject msg anymore. So we
59+
have to make sure to not broadcast outdated transactions which can lead to
60+
locked up wallet funds indefinitely in the worst case.
461

62+
# New Features
63+
## Functional Enhancements
64+
### Protocol Features
565
* This release marks the first release that includes the new [musig2-based
666
taproot channel type](https://github.com/lightningnetwork/lnd/pull/7904). As
767
new protocol feature hasn't yet been finalized, users must enable taproot
@@ -10,20 +70,15 @@
1070
(pending support by the remote peer). For `lncli openchannel`,
1171
`--channel_type=taproot` should be used.
1272

13-
## DB
73+
## RPC Additions
74+
None
1475

15-
* Split channeldb [`UpdateInvoice`
16-
implementation](https://github.com/lightningnetwork/lnd/pull/7377) logic in
17-
different update types.
18-
19-
* Add [invoice SQL schema and
20-
queries](https://github.com/lightningnetwork/lnd/pull/7354).
21-
22-
* Add new [sqldb
23-
package](https://github.com/lightningnetwork/lnd/pull/7343).
24-
25-
## Watchtowers
76+
## lncli Additions
77+
None
2678

79+
# Improvements
80+
## Functional Updates
81+
### Watchtowers
2782
* Let the task pipeline [only carry
2883
wtdb.BackupIDs](https://github.com/lightningnetwork/lnd/pull/7623) instead of
2984
the entire retribution struct. This reduces the amount of data that needs to
@@ -44,8 +99,48 @@
4499
[removed](https://github.com/lightningnetwork/lnd/pull/7771). This field was
45100
deprecated in v0.8.0-beta.
46101

47-
## RPC
102+
### Neutrino
103+
* The [Neutrino version
104+
is updated](https://github.com/lightningnetwork/lnd/pull/7788) so that LND can
105+
take advantage of the latest filter fetching performance improvements.
48106

107+
### Misc
108+
* [Ensure that both the byte and string form of a TXID is populated in the
109+
lnrpc.Outpoint message](https://github.com/lightningnetwork/lnd/pull/7624).
110+
111+
* [HTLC serialization
112+
updated](https://github.com/lightningnetwork/lnd/pull/7710) to allow storing
113+
extra data transmitted in TLVs.
114+
115+
* [MaxLocalCSVDelay now has a default value of 2016. It is still possible to
116+
override this value with the config option --maxlocaldelay for those who rely
117+
on the old value of 10000](https://github.com/lightningnetwork/lnd/pull/7780).
118+
119+
* [Generate default macaroons
120+
independently](https://github.com/lightningnetwork/lnd/pull/7592) on wallet
121+
unlock or create.
122+
123+
* [Restore support](https://github.com/lightningnetwork/lnd/pull/7678) for
124+
`PKCS8`-encoded cert private keys.
125+
126+
* [Cleanup](https://github.com/lightningnetwork/lnd/pull/7770) of defaults
127+
mentioned in
128+
[sample-lnd.conf](https://github.com/lightningnetwork/lnd/blob/master/sample-lnd.conf).
129+
It is possible to distinguish between defaults and examples now.
130+
A check script has been developed and integrated into the building process to
131+
compare the default values between lnd and sample-lnd.conf.
132+
133+
* [Cancel rebroadcasting of a transaction when abandoning
134+
a channel](https://github.com/lightningnetwork/lnd/pull/7819).
135+
136+
* [Fixed a validation bug](https://github.com/lightningnetwork/lnd/pull/7177) in
137+
`channel_type` negotiation.
138+
139+
* [The `lightning-onion` repo version was
140+
updated](https://github.com/lightningnetwork/lnd/pull/7877) in preparation for
141+
work to be done on route blinding in LND.
142+
143+
## RPC Updates
49144
* [SendOutputs](https://github.com/lightningnetwork/lnd/pull/7631) now adheres
50145
to the anchor channel reserve requirement.
51146

@@ -117,69 +212,41 @@
117212

118213
* The [WalletBalance](https://github.com/lightningnetwork/lnd/pull/7857) RPC
119214
(lncli walletbalance) now supports showing the balance for a specific account.
215+
216+
## lncli Updates
217+
* Added ability to use [environment variables to override `lncli` global
218+
flags](https://github.com/lightningnetwork/lnd/pull/7693). Flags will have
219+
preference over environment variables.
120220

121-
## Misc
122-
123-
* [Ensure that both the byte and string form of a TXID is populated in the
124-
lnrpc.Outpoint message](https://github.com/lightningnetwork/lnd/pull/7624).
125-
126-
* [Fix Benchmark Test (BenchmarkReadMessage/Channel_Ready) in the lnwire
127-
package](https://github.com/lightningnetwork/lnd/pull/7356).
128-
129-
* [Fix unit test flake (TestLightningWallet) in the neutrino package via
130-
version bump of
131-
btcsuite/btcwallet](https://github.com/lightningnetwork/lnd/pull/7049).
132-
133-
* [HTLC serialization
134-
updated](https://github.com/lightningnetwork/lnd/pull/7710) to allow storing
135-
extra data transmitted in TLVs.
136-
137-
* [MaxLocalCSVDelay now has a default value of 2016. It is still possible to
138-
override this value with the config option --maxlocaldelay for those who rely
139-
on the old value of 10000](https://github.com/lightningnetwork/lnd/pull/7780).
140-
141-
* [Generate default macaroons
142-
independently](https://github.com/lightningnetwork/lnd/pull/7592) on wallet
143-
unlock or create.
144-
145-
* [Restore support](https://github.com/lightningnetwork/lnd/pull/7678) for
146-
`PKCS8`-encoded cert private keys.
221+
* The `lncli sendcoins` command now asks for manual confirmation when invoked
222+
on the command line. This can be skipped by adding the `--force` (or `-f`)
223+
flag, similar to how `lncli payinvoice` works. To not break any existing
224+
scripts the confirmation is also skipped if `stdout` is not a terminal/tty
225+
(e.g. when capturing the output in a shell script variable or piping the
226+
output to another program).
147227

148228
* Add [`--unused`](https://github.com/lightningnetwork/lnd/pull/6387) to
149229
`lncli newaddr` command.
150230

151-
* [Cleanup](https://github.com/lightningnetwork/lnd/pull/7770) of defaults
152-
mentioned in
153-
[sample-lnd.conf](https://github.com/lightningnetwork/lnd/blob/master/sample-lnd.conf).
154-
It is possible to distinguish between defaults and examples now.
155-
A check script has been developed and integrated into the building process to
156-
compare the default values between lnd and sample-lnd.conf.
157-
158-
* [Cancel rebroadcasting of a transaction when abandoning
159-
a channel](https://github.com/lightningnetwork/lnd/pull/7819).
160-
161-
* [Fixed a validation bug](https://github.com/lightningnetwork/lnd/pull/7177) in
162-
`channel_type` negotiation.
163-
164-
* [The `lightning-onion` repo version was
165-
updated](https://github.com/lightningnetwork/lnd/pull/7877) in preparation for
166-
work to be done on route blinding in LND.
167-
168231
## Code Health
169-
170232
* Updated [our fork for serializing protobuf as JSON to be based on the
171233
latest version of `google.golang.org/protobuf` instead of the deprecated
172234
`github.com/golang/protobuf/jsonpb`
173235
module](https://github.com/lightningnetwork/lnd/pull/7659).
174236

175237
## Neutrino
176-
177238
* The [Neutrino version
178239
is updated](https://github.com/lightningnetwork/lnd/pull/7788) so that LND can
179240
take advantage of the latest filter fetching performance improvements.
180241

242+
## Breaking Changes
243+
None
244+
## Performance Improvements
245+
None
246+
# Technical and Architectural Updates
247+
## BOLT Spec Updates
248+
None
181249
## Testing
182-
183250
* [Started](https://github.com/lightningnetwork/lnd/pull/7494) running fuzz
184251
tests in CI.
185252

@@ -200,65 +267,32 @@
200267

201268
* [Removed](https://github.com/lightningnetwork/lnd/pull/7854) need for an
202269
active internet connection for the network connection itest.
270+
271+
* [Fix Benchmark Test (BenchmarkReadMessage/Channel_Ready) in the lnwire
272+
package](https://github.com/lightningnetwork/lnd/pull/7356).
203273

204-
## `lncli`
205-
206-
* Added ability to use [environment variables to override `lncli` global
207-
flags](https://github.com/lightningnetwork/lnd/pull/7693). Flags will have
208-
preference over environment variables.
209-
210-
* The `lncli sendcoins` command now asks for manual confirmation when invoked
211-
on the command line. This can be skipped by adding the `--force` (or `-f`)
212-
flag, similar to how `lncli payinvoice` works. To not break any existing
213-
scripts the confirmation is also skipped if `stdout` is not a terminal/tty
214-
(e.g. when capturing the output in a shell script variable or piping the
215-
output to another program).
216-
217-
## Bug Fix
218-
219-
* Make sure payment stream returns all the events by [subscribing it before
220-
sending](https://github.com/lightningnetwork/lnd/pull/7722).
221-
222-
* Fixed a memory leak found in mempool management handled by
223-
[`btcwallet`](https://github.com/lightningnetwork/lnd/pull/7767).
224-
225-
* Make sure lnd starts up as normal in case a transaction does not meet min
226-
mempool fee requirements. [Handle min mempool fee backend error when a
227-
transaction fails to be broadcasted by the
228-
bitcoind backend](https://github.com/lightningnetwork/lnd/pull/7746).
229-
230-
* [Updated bbolt to v1.3.7](https://github.com/lightningnetwork/lnd/pull/7796)
231-
in order to address mmap issues affecting certain older iPhone devices.
232-
233-
* [Stop rejecting payments that overpay or over-timelock the final
234-
hop](https://github.com/lightningnetwork/lnd/pull/7768).
235-
236-
* [Fix let's encrypt autocert
237-
generation](https://github.com/lightningnetwork/lnd/pull/7739).
238-
239-
* Fix an issue where [IPv6 couldn't be dialed when using
240-
Tor](https://github.com/lightningnetwork/lnd/pull/7783), even when
241-
`tor.skip-proxy-for-clearnet-targets=true` was set.
242-
243-
* Fix a [concurrency issue related to rapid peer teardown and
244-
creation](https://github.com/lightningnetwork/lnd/pull/7856) that can arise
245-
under rare scenarios.
274+
* [Fix unit test flake (TestLightningWallet) in the neutrino package via
275+
version bump of
276+
btcsuite/btcwallet](https://github.com/lightningnetwork/lnd/pull/7049).
246277

247-
* A race condition found between `channel_ready` and link updates is [now
248-
fixed](https://github.com/lightningnetwork/lnd/pull/7518).
278+
## Database
279+
* Split channeldb [`UpdateInvoice`
280+
implementation](https://github.com/lightningnetwork/lnd/pull/7377) logic in
281+
different update types.
249282

250-
* [Remove rebroadcasting of
251-
the last sweep-tx](https://github.com/lightningnetwork/lnd/pull/7879). Now at
252-
startup of the sweeper we do not rebroadcast the last sweep-tx anymore.
253-
The "sweeper-last-tx" top level bucket in the channel.db is removed
254-
(new migration version 31 of the db). The main reason is that neutrino
255-
backends do not fail broadcasting invalid transactions because BIP157
256-
supporting bitcoin core nodes do not reply with the reject msg anymore. So we
257-
have to make sure to not broadcast outdated transactions which can lead to
258-
locked up wallet funds indefinitely in the worst case.
283+
* Add [invoice SQL schema and
284+
queries](https://github.com/lightningnetwork/lnd/pull/7354).
259285

260-
### Tooling and documentation
286+
* Add new [sqldb
287+
package](https://github.com/lightningnetwork/lnd/pull/7343).
261288

289+
## Code Health
290+
* Updated [our fork for serializing protobuf as JSON to be based on the
291+
latest version of `google.golang.org/protobuf` instead of the deprecated
292+
`github.com/golang/protobuf/jsonpb`
293+
module](https://github.com/lightningnetwork/lnd/pull/7659).
294+
295+
## Tooling and Documentation
262296
* Add support for [custom `RPCHOST` and
263297
`RPCCRTPATH`](https://github.com/lightningnetwork/lnd/pull/7429) to the
264298
`lnd` Docker image main script (`/start-lnd.sh`).
@@ -295,11 +329,8 @@
295329
* Pierre Beugnet
296330
* Satarupa Deb
297331
* Shaurya Arora
332+
* Suheb
298333
* Torkel Rogstad
299334
* Yong Yu
300335
* ziggie1984
301336
* zx9r
302-
303-
# Contributors (Alphabetical Order)
304-
305-
* Olaoluwa Osuntokun

0 commit comments

Comments
 (0)