From 99a96a80aecd8b3dfb84264f07e1bac016923606 Mon Sep 17 00:00:00 2001 From: carla Date: Thu, 22 Oct 2020 20:47:09 +0200 Subject: [PATCH] release_notes: delete old release notes and add instruction It can be confusing to have multiple sets of release notes tracked in this doc. Remove already released versions and update instructions. --- release_notes.md | 46 ++++------------------------------------------ 1 file changed, 4 insertions(+), 42 deletions(-) diff --git a/release_notes.md b/release_notes.md index ff28d00..0cecee4 100644 --- a/release_notes.md +++ b/release_notes.md @@ -7,7 +7,10 @@ This file tracks release notes for the loop client. ### Release Manager: * All of the items under the "Next Release" heading should be included in the release notes. -* As part of the PR that bumps the client version, the "Next Release" heading should be replaced with the release version including the changes. +* As part of the PR that bumps the client version, cut everything below the 'Next Release' heading. +* These notes can either be pasted in a temporary doc, or you can get them from the PR diff once it is merged. +* The notes are just a guideline as to the changes that have been made since the last release, they can be updated. +* Once the version bump PR is merged and tagged, add the release notes to the tag on GitHub. ## Next release @@ -31,44 +34,3 @@ This file tracks release notes for the loop client. #### Breaking Changes #### Bug Fixes - -## 0.10.0 - -#### New Features - -* Multi-path payment has been enabled for Loop In. This means that it is now possible - to replenish multiple channels via a single Loop In request and a single on-chain htlc. - This has to potential to greatly reduce chain fee costs. Note that it is not yet possible - to select specific peers to loop in through. -* The daemon now sends a user agent string with each swap. This allows - developers to identify their fork or custom implementation of the loop client. - -##### Updated Swap Suggestions -* The swap suggestions endpoint has been updated to be fee-aware. Swaps that - exceed the fee limits set by the liquidity manager will no longer be - suggested (see `getParams` for the current limits, and use `setParams` to - update these values). -* Swap suggestions are now aware of ongoing and previously failed swaps. They - will not suggest swaps for channels that are currently being utilized for - swaps, and will not suggest any swaps if a swap that is not limited to a - specific peer or channel is ongoing. If a channel was part of a failed swap - within the last 24H, it will be excluded from our swap suggestions (this - value is configurable). -* The `debug` logging level is recommended if using this feature. - -#### Breaking Changes - -* Macaroon authentication has been enabled for the `loopd` gRPC and REST - connections. This makes it possible for the loop API to be exposed safely over - the internet as unauthorized access is now prevented. - - The daemon will write a default `loop.macaroon` in its main directory. For - mainnet this file will be picked up automatically by the `loop` CLI tool. For - testnet you need to specify the `--network=testnet` flag. - [More information about TLS and macaroons.](README.md#authentication-and-transport-security) - -* The `setparm` loopcli endpoint is renamed to `setrule` because this endpoint - is only used for setting liqudity rules (parameters can be set using the new - `setparams` endpoint). - -#### Bug Fixes \ No newline at end of file