release-notes-0.15.0.md

Release Notes

Payments

Support according to the spec has been added for payment metadata in invoices. If metadata is present in the invoice, it is encoded as a tlv record for the receiver.

This functionality unlocks future features such as stateless invoices.

Security

• Misconfigured ZMQ setup now logs a warning.

Taproot

The internal on-chain wallet of lnd is now able to create and spend from Taproot (SegWit v1) addresses. Using lncli newaddress p2tr will create a new BIP-0086 keyspend only address and then watch it on chain. Taproot script spends are also supported through the signrpc.SignOutputRaw RPC (/v2/signer/signraw in REST).

The walletrpc.SignPsbt RPC now also supports Taproot PSBT signing to fully support remote signing with Taproot outputs.

The internal version of the aezeed was bumped to 1 to mark new seeds that were created after introducing the Taproot key derivation to simplify detecting Taproot compatibility of a seed.

NOTE for users running a remote signing setup: A manual account import is necessary when upgrading from lnd v0.14.x-beta to lnd v0.15.x-beta, see the remote signing documentation for more details. Please upgrade to lnd v0.15.3-beta or later directly!

MuSig2

The signrpc.Signer RPC service now supports EXPERIMENTAL MuSig2 signing.

More information can be found in the MuSig2 documentation. Note that the MuSig2 BIP is not final yet and therefore the MuSig2 API must be considered to be HIGHLY EXPERIMENTAL and subject to change in upcoming releases. Backward compatibility is not guaranteed!

lncli

• Add auto-generated command-line completions for Fish shell.

• Add chan_point flag to closechannel command.

• Add private status to pendingchannels response.

• Update description for state command.

• Add update node announcement for updating and propagating node information.

• Add --socksproxy to allow for RPC calls via Tor.

• Hop hints are now opt in when using lncli addinvoice. Users now need to explicitly specify the --private flag.

• A new constrainmacaroon command was added that allows caveats/restrictions to be added to an existing macaroon (instead of needing to bake a new one).

Neutrino

Neutrino now suports BIP 155, allowing it to connect to Bitcoin nodes that advertise a Tor v3 onion service address.

A new neutrino sub-server capable of status checks, adding, disconnecting and listing peers, fetching compact filters and block/block headers.

Btcwallet

• Add option to configure the block and transaction subscription notifications from bitcoind to be obtained through polling of the RPC interface instead of using ZMQ

Bug Fixes

• Pipelining an UpdateFulfillHTLC message now only happens when the related UpdateAddHTLC is locked-in.

• Fixed an inactive invoice subscription not removed from invoice registry. When an invoice subscription is created and canceled immediately, it could be left uncleaned due to the cancel signal is processed before the creation. It is now properly handled by moving creation before deletion.

• When the block height+delta specified by a network message is greater than the gossiper's best height, it will be considered as premature and ignored. These premature messages are now saved into a cache and processed once the height has reached.

• Fixed failure to limit our number of hop hints in private invoices. When a private invoice is created, and the node had > 20 (our hop hint limit) private channels with inbound > invoice amount, hop hint selection would add too many hop hints. When a node had many channels meeting this criteria, it could result in an "invoice too large" error when creating invoices. Hints are now properly limited to our maximum of 20.

• Fixed an edge case where the lnd might be stuck at starting due to channel arbitrator relying on htlcswitch to be started first.

• Fixed an issue where invoice notifications could be missed when using the SubscribeSingleInvoice or SubscribeNotifications rpcs.

• Fixed crash in MuSig2Combine

• Fixed an issue where lnd would end up sending an Error and triggering a force close.

• Fixed deadlock in the invoice registry

• Added signature length validation when calling NewSigFromRawSignature.

• Fixed deadlock in invoice registry.

• Fixed an issue that would cause wallet UTXO state to be incorrect if a 3rd party sweeps our anchor output.

• Fixed node shutdown in forward interceptor itests.

• Fixed a bug that would cause lnd to be unable to parse certain PSBT blobs.

• Use normal TCP resolution, instead of Tor DNS resolution, for addresses using the all-interfaces IP.

• Fixed a bug in the btcwallet that caused an error to be shown for lncli walletbalance in existing wallets after upgrading to Taproot.

• Fixed a data race in the websocket proxy code.

• Fixed race condition resulting in MPP payments sometimes getting stuck in-flight.

• Fixed a panic in the Taproot signing part of the SignOutputRaw RPC that occurred when not all UTXO information was specified.

• Fixed P2TR addresses not correctly being detected as used.

• Fixed incorrect PSBT de-serialization for transactions with no inputs.

• Fixed a spec-compliance issue where lnd was not allowing cooperative close to continue after a peer disconnect.

• A subsystem hand-off between the contractcourt and htlcswitch has been fixed by adding a persistence layer. This avoids a rare edge case from occurring that would result in an erroneous force close.

• Ignore addresses with unknown types in NodeAnnouncements

• Taproot wallet inputs can also be used to fund channels

• Fixed an intermittent panic that would occur due to a violated assumption with our underlying database.

• Fixed a wrong channel status inheritance used in migration26 and migration27.

• Fixes an issue related to HTLCs on lease enforced channels that can lead to itest flakes

• Fixes a bug that would cause SignPsbt to panic w/ an underspecified packet

• Fixes a panic in the graph diameter calculation if the graph is empty.

Routing

• Add a new time_pref parameter to the QueryRoutes and SendPayment APIs that allows the caller to control the trade-off between payment speed and cost in pathfinding.

Misc

• An example systemd service file for running lnd alongside a bitcoind service is now provided in contrib/init/lnd.service.

• Allow disabling migrations if the database backend passed to channeldb was opened in read-only mode.

• Disable compiler optimizations when building lnd-debug and lncli-debug. It helps when stepping through the code with a debugger like Delve.

• A new command lncli leaseoutput was added.

• Consolidated many smaller docs/typo/trivial fixes from PRs that were stuck in review because of unmet contribution guideline requirements.

• A nightly build of the lnd docker image is now created automatically.

• Add default values to walletrpc.ListUnspent RPC call.

• Add .vs/ folder to .gitignore.

• Chain backend healthchecks disabled for --nochainbackend mode

• The tlv package was refactored into its own Golang submodule.

• The tor package was refactored into its own Golang submodule and a new process for changing and tagging submodules was introduced in a series of 3 PRs (#6350, #6355 and #6356).

• Source repository can now be specified for Docker image builds

• The new btcsuite/btcd/btcec/v2 and the moved btcsuite/btcd/btcutil modules were integrated into lnd as a preparation for basic Taproot support.

• Make etcd leader election session TTL configurable.

• Fix race condition in the htlc interceptor unit test.

• A new config option, pending-commit-interval is added. This value specifies the maximum duration it allows for a remote peer to respond to a locally initiated commitment update.

• macos and apple Makefile tasks have been added.

  The macos task uses gomobile to build an XCFramework that can be used to embed lnd to macOS apps, similar to how the ios task builds for iOS.

  The apple task uses gomobile to build an XCFramework that can be used to embed lnd to both iOS and macOS apps.

• The CI and build infrastructure for the project has transitioned to using Go 1.18.

• Announce the keysend feature bit in NodeAnnouncement if --accept-keysend is set.

• Fix a flaky unit test in the chainview package.

• Adds a new config option for adding a specific peer at startup.

• Add a new method in tlv to encode an uint64/uint32 field using BigSize format.

• Add new bitcoind.config and bitcoind.rpccookie options to allow specifying non-default paths for the configuration and RPC cookie files.

• Clarify comment on chainnotifier.RegisterConfirmationsNtfn.

• The experimental MuSig2 API now also has a MuSig2Cleanup RPC that allows the in-memory state to be cleaned up early if a session isn't expected to succeed anymore.

• Some of the invoice update logic has been refactored to be less verbose.

• Clarify error msg when bitcoind cookie file is missing.

• Minor fix to how bitcoind.rpccookie and bitocind.config are parsed from config file.

• Fix a data race found when running unit test for revocation log.

• A new version of the internal tor module was tagged and updated for the main module.

• lnd now packages the latest versions of the btcd libraries, btcwallet, and neutrino

• Refactor simple t.Fatalf test assertions to require.NoError .

RPC Server

• Add value to the field remote_balance in pending_force_closing_channels under pendingchannels whereas before was empty(zero).

• The graph's diameter is calculated and added to the getnetworkinfo output.

• Add dev only RPC subserver and the devrpc.ImportGraph call

• Extend the HTLC interceptor API to provide more control over failure messages. With this change, it allows encrypted failure messages to be returned to the sender. Additionally it is possible to signal a malformed htlc.

• Add an always on mode to the HTLC interceptor API. This enables interception applications where every packet must be intercepted.

• Add destination output information to the transaction structure returned from the RPC GetTransactions and when subscribed with SubscribeTransactions.

• Support for making routes with the legacy onion payload format via SendToRoute has been removed.

• Close a gap in the HTLC interceptor API by intercepting htlcs in the on-chain resolution flow too.

• Expose always on mode of the HTLC interceptor API through GetInfo.

• The lnrpc.ListPayments RPC now has an optional count_total_payments parameter that will cause the total_num_payments response field to be set to the total number of payments (complete and incomplete) that are currently in the payment database.

• Remove confirmation_height field from PendingChannel proto

• The walletrpc.ListLeases RPC (lncli wallet listleases) now shows the pkScript and value of a leased output.

Database

• Add ForAll implementation for etcd to speed up graph cache at startup

• Improve validation of a PSBT packet when handling a request to finalize it.

• Add new Peers subserver with a new endpoint for updating the NodeAnnouncement data without having to restart the node.

• Add htlc expiry protection to the htlc interceptor API.

• In order to safely advance commitment state, lnd saves the past states and constructs a justice transaction in case of a remote breach. The states can grow very large on disk given a busy operating channel, which is now changed with a space deduction over (at least) 96 percents.

• Aside from the above database optimization, two new fields, InitialLocalBalance and InitialRemoteBalance have been added to each channel to keep track of the push amount. For open channels, these values are taken from reading its past states. For historical(closed) channels, they are patched with empty values as the channels' past states have been deleted during closing.

• Mobile builds now expose main sub-servers by default. All API methods have prefixed the generated methods with the subserver name. This is required to support subservers with name conflicts.

Documentation

• Improved instructions on how to build lnd for mobile.

• Log force-close related messages on "info" level.

• Add list of build tags to the install instructions.

Monitoring

A new flag (--prometheus.perfhistograms) has been added to enable export of gRPC performance metrics (latency to process GetInfo, etc).

Code Health

Code cleanup, refactor, typo fixes

• Refactored itest to better manage contexts inside integration tests.

• Fix itest not picking up local config file or creating directories in home dir of the user.

• A refactor of SelectHopHints allows code external to lnd to call the function, where previously it would require access to lnd's internals.

• rpc-check fails if it finds any changes including new and deleted files.

• The golangci-lint package was updated and new linters were enabled.

• The linting process now runs inside a docker container to fix versioning issues between projects.

• The whitespace linter was enabled to make sure multi-line if conditions and function/method declarations are followed by an empty line to improve readability. Note to developers: please make sure you delete the old version of golangci-lint in your $GOPATH/bin directory. make lint does not automatically replace it with the new version if the binary already exists!

• ChannelLink in the htlcswitch now performs a 1-way handoff via a temporary map with its ChannelArbitrator.

• The channel-commit-interval is now clamped to a reasonable timeframe of 1h.

• A function in the gossiper processNetworkAnnouncements has been refactored for readability and for future deduplication efforts.

Contributors (Alphabetical Order)

• 3nprob
• Alyssa Hertig
• Andras Banki-Horvath
• Andreas Schjønhaug
• asvdf
• bitromortac
• Bjarne Magnussen
• BTCparadigm
• Carl Dong
• Carla Kirk-Cohen
• Carsten Otto
• Dan Bolser
• Daniel McNally
• Elle Mouton
• ErikEk
• Eugene Siegel
• Evan Kaloudis
• Hampus Sjöberg
• henta
• hieblmi
• Joost Jager
• Jordi Montes
• LightningHelper
• Liviu
• mateuszmp
• Naveen Srinivasan
• Olaoluwa Osuntokun
• randymcmillan
• Rong Ou
• Thebora Kompanioni
• Tommy Volk
• Torkel Rogstad
• Vsevolod Kaganovych
• Yong Yu
• Ziggie